This analyzer script computes
the inverse Q from a time series. For an oscillating
history with amplitude damping rate
\(\omega/2 Q\), calculates the quantity
\(1/Q\), where \(\omega = 2 \pi \times\)
frequency.
-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, --frequency(float, required)
Frequency of the low-pass filter.
-H <histname>, --historyName=<histname>(string, required)
<histname> is the history to analyze.
-O <outname>, --outputFileName=<outname>(string, optional, default = SIMULATIONNAME_inverseQ)
<outname> is the name of the file into which the inverse Q will be written.
-c <comp>, --component=<comp>(int, optional, default = 0)
<comp> is the component to select within a multi-component dataset Default = 0
-w, --overwrite(flag)
Whether a dataset or group should be overwritten if it already exists.
This analyzer script outputs two columns of data with the titles Time(s) and Inverse Q. The script also creates a VizSchema-compliant HDF5 file that contains a new dataset that can be visualized in Composer. The name of the new HDF5 file is SIMULATIONNAME_inverseQ.vsh5. It contains the dataset inverseQ_FREQ, where FREQ is the filter frequency with periods replaced by underscores.
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.