computeSParamsViaOverlapIntegral.py

A python module for calculating the overlap integral between two slabs in your simulation. The script Fourier transforms (in time) the E and B FieldSlabData histories at each slab, and from that computes the overlap integral for each wavelength bin. The slabs must have the same orientation.

-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.

-M <maxlength>, --maxWavelength=<maxlength>

(float, required)

Replace <maxlength> with the maximum vacuum wavelength to analyze. (microns)

-m <minlength>, --minWavelength=<minlength>

(float, required)

Replace <minlength> with the minimum vacuum wavelength to analyze. (microns)

-e <inslabE>, --inSlabE=<inslabE>

(string, required, default = eSlab0)

Replace <inslabE> with the name of the input electric field array history.

-b <inslabB>, --inSlabB=<inslabB>

(string, required, default = bSlab0)

Replace <inslabB> with the name of the input magnetic field array history.

-E <outslabE>, --outSlabE=<outslabE>

(string, required, default = eSlab1)

Replace <outslabE> with the name of the output electric field array history.

-B <outslabB>, --outSlabB=<outslabB>

(string, required, default = bSlab1)

Replace <outslabB> with the name of the output magnetic field array history.

-f <firstin>, --firstStepInSlab=<firstin>

(int, optional)

Replace <firstin> with the time step to begin analyzing the input slab. Default is first step.

-F <firstout>, --firstStepOutSlab=<firstout>

(int, optional)

Replace <firstout> with the time step to begin analyzing the output slab. Default is first step.

-L <steps>, --numSteps=<steps>

(int, optional)

<steps> is the number of time steps to analyze for both slabs. Default is the maximum number of steps.

-D <suffix>, --outputFileSuffix=<suffix>

(string, optional)

<suffix> is the string added to the output file to distinguish it.

-w, --overwrite

(flag)

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

Output

A .vsh5 file with with the overlap integral plotted as a function of wavelength.

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.