bilby.gw.detector.calibration

Functions for adding calibration factors to waveform templates.

The two key quantities are \(d\), the (possible mis-)calibrated strain data used for the analysis, and \(h\), the theoretical strain predicted by the waveform model.

There are two conventions in the literature for how to specify calibration corrections. People who work on gravitational-wave detector calibration typically describe a correction to the data so that the signal matches the theoretical prediction

\[h = \eta d.\]

However, when performing inference, we are interested in the correction that must be applied to the theoretical strain to match the signal contained within the data

\[d = \alpha h.\]

Clearly, these are related via

\[\eta = \frac{1}{\alpha}\]

Internally, in Bilby, the correction is always \(\alpha\). However, when reading in a data product describing calibration uncertainty, e.g., uncertainty envelopes or estimated response curves, the user should specify which method is being used as "data" for \(\eta\) or "template" for \(\alpha\).

Note

In general, data products produced by the LVK calibration groups use the "data" convention.

Functions

build_calibration_lookup(interferometers[, ...])

curves_from_spline_and_prior(parameters, ...)

read_calibration_file(filename, ...[, ...])

Function to read the hdf5 files from the calibration group containing the physical calibration response curves.

write_calibration_file(filename, ...[, ...])

Function to write the generated response curves to file

Classes

CubicSpline(prefix, minimum_frequency, ...)

Precomputed(label, curves, frequency_array)

Recalibrate([prefix])