GWForge.ifo.detectors

Classes

IFO
Network

Functions

load_xg_interferometer(filename, power_spectral_density)

Load a GWForge XG .ifo file, attaching power_spectral_density.

Module Contents

GWForge.ifo.detectors.load_xg_interferometer(filename, power_spectral_density)

Load a GWForge XG .ifo file, attaching power_spectral_density.

This mirrors bilby.gw.detector.load_interferometer’s tiny key = value parser but injects a valid PSD before the interferometer is constructed. Two things make this necessary rather than a plain load_interferometer:

• bilby’s TriangularInterferometer indexes power_spectral_density[ii] for each of the three arms, so a .ifo file carrying power_spectral_density = None (as ET does) raises a TypeError at load time.

• even for a single detector the PSD has to reach the interferometer(s), not just the enclosing list, so we set it explicitly on every arm.

Parameters:

• filename (str) – Path to the .ifo file.

• power_spectral_density (bilby.gw.detector.psd.PowerSpectralDensity) – The PSD to attach to the interferometer (all three arms for a triangle).

Return type:

bilby.gw.detector.Interferometer or bilby.gw.detector.networks.TriangularInterferometer

class GWForge.ifo.detectors.IFO(name, psd_file=None, asharp=None)

Examples

>>> ifo = IFO(name='H1', asharp=True)
>>> ifo.initialise_ifo(seed=42)

>>> ifo = IFO(name='ET')
>>> ifo.initialize_ifo()

name

psd_file = None

asharp = None

initialise_ifo(seed=None)

Initialise the interferometer with optional random seed.

Parameters:

seed (int (optional)) – The random seed for initialisation. [Default: None]

Returns:

ifo

Return type:

bilby.gw.detector.Intereferometer

Raises:

ValueError – If the interferometer is not implemented.:

initialize_ifo

class GWForge.ifo.detectors.Network(ifos, psd_files=None)

Bases: IFO

Examples

>>> ifos = Network(ifos = ['ET', 'CE20', 'CE40'])
>>> ifos.initialise_network()

ifos

initialise_network()

Returns:

ifos

Return type:

bilby.gw.detector.InterferometerList

initialize_network

initialise_ifos

initialize_ifos