In file EasyCalibrate/FDEasyCalibrate.hh:

class FDEasyCalibrate : public FDCalibrate

Class for calibrating ASQ FSpectrum data.

Inheritance:


Public Methods

FDEasyCalibrate (Dacc *access, const char *refcal_file, bool GenerateCalParam, double Fmin, double Fstep, int npoint)
Constructor using reference calibration file.
~FDEasyCalibrate (void)
Destructor
int UpdateResponseFunction (void)
Update response function by estimating calibration parameters from current data
int UpdateResponseFunction (Time t)
[NOT YET IMPLEMENTED

Documentation

The FDEasyCalibrate class is a high-level class to perform frequency-domain calibration of FSpectrum objects. It drives the FDCalibrate class for the typical user, which in turn converts FSpectrum data from units of AS_Q counts to physical displacement in nm.
FDEasyCalibrate(Dacc *access, const char *refcal_file, bool GenerateCalParam, double Fmin, double Fstep, int npoint)
Constructor based on an uber reference-calibration file. The frequency-dependent reference calibration data is linearly interpolated to the specified frequencies. The response function is initialized to its default value (alpha=1, beta=1). [NOT YET FUNCTIONAL: Alpha and beta values stored in the reference file can be used instead of generating new calibrations by setting the bool GenerateCalParam to false.]
Parameters:
access - Data accessor.
refcal_file - File containing reference calibration data.
GenerateCalParam - Generate new alpha, beta parameters from data if true.
Fmin - Minimum frequency at which calibration is to be evaluated.
Fstep - Spacing of frequencies at which calibration is to be evaluated.
npoint - Number of frequencies at which calibration is to be evaluated.

~FDEasyCalibrate(void)
Destructor

int UpdateResponseFunction(void)
Update response function by estimating calibration parameters from current data. Returns zero if new calibration is physically valid. If the new calibration is not physically valid as defined by IsCalibrationGood(), then the response function is reset to its reference value (its value for alpha=1=beta). Once the response function is set, an FSpectrum in units AS_Q^2/Hz can be calibrated to nm^2/Hz by simply calling one of the Apply() methods inherited from FDFilter.

int UpdateResponseFunction(Time t)
[NOT YET IMPLEMENTED.] Update response function using stored calibration parameters. Returns zero if requested calibration is available and physically valid. If the new calibration is not physically valid as defined by IsCalibrationGood(), then the response function is reset to its reference value (its value for alpha=1=beta). Once the response function is set, an FSpectrum in units AS_Q^2/Hz can be calibrated to nm^2/Hz by simply calling one of the Apply() methods inherited from FDFilter.


This class has no child classes.

alphabetic index hierarchy of classes


Please send questions and comments to zweizig_j@ligo.caltech.edu


generated by doc++