gwdetchar.scattering.core module¶
Utilities for analysing optical scattering
- gwdetchar.scattering.core.get_blrms(series, flow=4.0, fhigh=10.0, stride=1, whiten=True, fftlength=4, overlap=2, **kwargs)[source]¶
Compute the whitened, band-limited RMS of a
TimeSeries
- Parameters:
- series
TimeSeries
the input
TimeSeries
data- flow
float
, optional lower limit (Hz) of the passband, default: 4.0
- fhigh
float
, optional upper limit (Hz) of the passband, default: 10.0
- stride: `float`, optional
RMS integration length (seconds), default: 1
- whiten
bool
, optional boolean switch to enable (
True
) or disable (False
) whitening of the input, default:True
- fftlength
float
, optional FFT integration length (seconds), default: 4
- overlap
float
, optional FFT overlap length (seconds), default: 2
- **kwargs
dict
, optional additional keyword arguments to
TimeSeries.whiten
- series
- Returns:
- wblrms
TimeSeries
whitened, band-limited RMS trends of the input
TimeSeries
- wblrms
See also
gwpy.timeseries.TimeSeries.whiten
for the underlying whitening scheme
gwpy.timeseries.TimeSeries.rms
for the underlying root-mean-square (RMS) estimation method
- gwdetchar.scattering.core.get_fringe_frequency(series, multiplier=2.0)[source]¶
Predict scattering fringe frequency from the derivative of a timeseries
- Parameters:
- series
TimeSeries
timeseries record of relative motion
- multiplier
float
harmonic number of fringe frequency
- series
- Returns:
- fringef
TimeSeries
timeseries record of fringe frequency
- fringef
See also
scipy.signal.savgol_filter
for an implementation of the Savitzky-Golay filter
- gwdetchar.scattering.core.get_segments(series, threshold, name=None, pad=0)[source]¶
Generate data-quality segments by thresholding a
TimeSeries
- Parameters:
- series
TimeSeries
the input
TimeSeries
data- threshold
float
the threshold value for active data-quality segments
- name
str
, optional name of the data-quality flag, defaults to
series.name
- pad
float
, optional length (seconds) by which to pad active segments, default: 0
- series
- Returns:
- threshflag
DataQualityFlag
the populated data-quality flag
- threshflag