bilby.gw.detector.networks.InterferometerList

class bilby.gw.detector.networks.InterferometerList(interferometers)

Bases: list

A list of Interferometer objects

__init__(interferometers)

Instantiate a InterferometerList

The InterferometerList is a list of Interferometer objects, each object has the data used in evaluating the likelihood

Parameters:

interferometers: iterable

The list of interferometers

__call__(*args, **kwargs)

Call self as a function.

Methods

__init__(interferometers)	Instantiate a InterferometerList
append(interferometer)	Append object to the end of the list.
clear(/)	Remove all items from list.
copy(/)	Return a shallow copy of the list.
count(value, /)	Return number of occurrences of value.
extend(interferometers)	Extend list by appending elements from the iterable.
from_pickle([filename])
index(value[, start, stop])	Return first index of value.
inject_signal([parameters, ...])	Inject a signal into noise in each of the three detectors.
insert(index, interferometer)	Insert object before index.
plot_data([signal, outdir, label])
pop([index])	Remove and return item at index (default last).
remove(value, /)	Remove first occurrence of value.
reverse(/)	Reverse IN PLACE.
save_data(outdir[, label])	Creates a save file for the data in plain text format
set_strain_data_from_power_spectral_densities(...)	Set the Interferometer.strain_data from the power spectral densities of the detectors
set_strain_data_from_zero_noise(...[, ...])	Set the Interferometer.strain_data from the power spectral densities of the detectors
sort(*[, key, reverse])	Sort the list in ascending order and return None.
to_pickle([outdir, label])	Saves the object to a pickle file

Attributes

duration
frequency_array
meta_data	Dictionary of the per-interferometer meta_data
number_of_interferometers
sampling_frequency
start_time

append(interferometer)

Append object to the end of the list.

clear(/)

Remove all items from list.

copy(/)

Return a shallow copy of the list.

count(value, /)

Return number of occurrences of value.

extend(interferometers)

Extend list by appending elements from the iterable.

index(value, start=0, stop=sys.maxsize, /)

Return first index of value.

Raises ValueError if the value is not present.

inject_signal(parameters=None, injection_polarizations=None, waveform_generator=None, raise_error=True)

Inject a signal into noise in each of the three detectors.

Parameters:

parameters: dict

Parameters of the injection.

injection_polarizations: dict

Polarizations of waveform to inject, output of waveform_generator.frequency_domain_strain(). If waveform_generator is also given, the injection_polarizations will be calculated directly and this argument can be ignored.

waveform_generator: bilby.gw.waveform_generator.WaveformGenerator

A WaveformGenerator instance using the source model to inject. If injection_polarizations is given, this will be ignored.

raise_error: bool

Whether to raise an error if the injected signal does not fit in the segment.

Returns:

injection_polarizations: dict

Notes

if your signal takes a substantial amount of time to generate, or you experience buggy behaviour. It is preferable to provide the injection_polarizations directly.

insert(index, interferometer)

Insert object before index.

property meta_data

Dictionary of the per-interferometer meta_data

pop(index=-1, /)

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value, /)

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse(/)

Reverse IN PLACE.

save_data(outdir, label=None)

Creates a save file for the data in plain text format

Parameters:

outdir: str

The output directory in which the data is supposed to be saved

label: str

The string labelling the data

set_strain_data_from_power_spectral_densities(sampling_frequency, duration, start_time=0)

Set the Interferometer.strain_data from the power spectral densities of the detectors

This uses the interferometer.power_spectral_density object to set the strain_data to a noise realization. See bilby.gw.detector.InterferometerStrainData for further information.

Parameters:

sampling_frequency: float

The sampling frequency (in Hz)

duration: float

The data duration (in s)

start_time: float

The GPS start-time of the data

set_strain_data_from_zero_noise(sampling_frequency, duration, start_time=0)

Set the Interferometer.strain_data from the power spectral densities of the detectors

This uses the interferometer.power_spectral_density object to set the strain_data to zero noise. See bilby.gw.detector.InterferometerStrainData for further information.

Parameters:

sampling_frequency: float

The sampling frequency (in Hz)

duration: float

The data duration (in s)

start_time: float

The GPS start-time of the data

sort(*, key=None, reverse=False)

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

to_pickle(outdir='outdir', label='ifo_list')

Saves the object to a pickle file

Added in version 1.1.0.

Parameters:

outdir: str, optional

Output directory name of the file

label: str, optional

Output file name, is ‘ifo_list’ if not given otherwise. A list of the included interferometers will be appended.