computeSParamsFromHists.py

This script fourier transforms (in time) the FieldSlabData histories, and from that computes the frequency-domain Poynting fluxes. Finally, by simple division, it provides the S parameter, the transmission coefficient.

-s <simname>, --simulationName=<simname>

(string, required)

<simname> is the name of the simulation to be analyzed. The file extension should NOT be included in this text field.

-f <first>, --firstStep=<first>

(int, optional)

<first> is the number of the first time step.

-l <last>, --lastStep=<last>

(int, optional)

<last> is the number of the last time step.

-O <offset>, --stepOffset=<offset>

(int, optional, default = 0)

<offset> is the offset between out and in time segments.

-L <maxl>, --maxWavelength=<maxl>

(float, required, default = 1.5)

Replace <maxl> with the largest wavelength (microns).

-S <minl>, --minWavelength=<minl>

(float, required, default = 1.3)

Replace <minl> with the smallest wavelength (microns).

-d <dir>, --inDirection=<dir>

(int, required, default = 0)

<dir> is the normal of the input plane: 0, 1, or 2.

-e <inelec>, --inSlabE=<inelec>

(string, required, default = eSlab0)

<inelec> is the input electric field array history.

-b <inmag>, --inSlabB=<inmag>

(string, required, default = bSlab0)

<inmag> is the input magnetic field array history.

-1, --inSign

(int, optional, default = 1)

Sign of the input Poynting vector.

-D <dir>, --outDirection=<dir>

(int, required, default = 0)

<dir> is the normal of the output plane: 0, 1, or 2.

-E <outelec>, --outSlabE=<outelec>

(string, required, default = eSlab1)

<outelec> is the output electric field array history.

-B <outmag>, --outSlabB=<outmag>

(string, required, default = bSlab1)

<outmag> is the output magnetic field array history.

-2, --outSign

(int, optional, default = 1)

Sign of the Poynting vector to write.

-n <outname>, --outputFileName=<outname>

(string, optional)

<outname> is the name of the file into which to write the output.

-x <outsufx>, --outputSuffix=<outsufx>

(string, optional)

<outsufx> is a comma-delimited array of suffixes for the analyzer histories.

-w, --overwrite

(flag)

Whether a dataset or group should be overwritten if it already exists.

Output

A set of VsHdf5 compatible files with the frequency-domain Poynting fluxes and the S parameter.

If you are running this analyzer from the UI, and the output dataset file already exists, then it will be overwritten each time the analyzer is run, unless you uncheck the Overwrite Existing Files box near the bottom of the Analysis Results pane.

If you are running the analyzer from the command line, the dataset will not be overwritten unless the -w, or --overwrite flag is specified on the command line.

The results of your analyzer may not be written into the output file if you have not specified the overwrite option to be True.