detector
Functions:
| Name | Description |
|---|---|
get_CE |
Return a instance for Cosmic Explorer (CE). |
get_ET |
Return a list of three instances for the triangular Einstein Telescope (ET). |
get_ET_2L |
Return the two L-shaped detectors of the Einstein Telescope 2L design. |
get_H1 |
Return a instance for LIGO Hanford (H1). |
get_L1 |
Return a instance for LIGO Livingston (L1). |
get_V1 |
Return a instance for Virgo (V1). |
get_detector_preset |
Return a dictionary of pre-configured detector instances. |
Detector
¤
Bases: _Freezable, ABC
Base class for all detectors.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Name of the detector. |
data |
Data
|
Detector data object. |
psd |
PowerSpectrum
|
Power spectral density object. |
Methods:
| Name | Description |
|---|---|
clear_data_and_psd |
Clear the data and PSD of the detector. |
fd_response |
Modulate the waveform in the sky frame by the detector response in the frequency domain. |
slice_to_frequency_range |
Slice the data and the PSD to the given frequency range. |
td_response |
Modulate the waveform in the sky frame by the detector response in the time domain. |
clear_data_and_psd() -> None
¤
Clear the data and PSD of the detector.
fd_response(frequency: Float[Array, ' n_sample'], h_sky: dict[str, Float[Array, ' n_sample']], params: Mapping[str, FloatLike]) -> Complex[Array, ' n_sample']
abstractmethod
¤
Modulate the waveform in the sky frame by the detector response in the frequency domain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frequency
|
Float[Array, n_sample]
|
Array of frequency samples. |
required |
h_sky
|
dict[str, Float[Array, n_sample]]
|
Dictionary mapping polarization names to frequency-domain waveforms. The keys are polarization names (e.g., 'plus', 'cross') and values are complex strain arrays. |
required |
params
|
dict
|
Dictionary of source parameters including: - ra (Float): Right ascension in radians - dec (Float): Declination in radians - psi (Float): Polarization angle in radians - t_c (Float): The difference between peak time and trigger time in sec |
required |
The trigger and segment start are read from the attached data.
Returns:
| Type | Description |
|---|---|
Complex[Array, ' n_sample']
|
Complex[Array, "n_sample"]: Complex strain measured by the detector in frequency domain. |
slice_to_frequency_range(f_min: float, f_max: float) -> tuple[Float[Array, ' n_freq'], Complex[Array, ' n_freq'], Float[Array, ' n_freq']]
¤
Slice the data and the PSD to the given frequency range.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
f_min
|
float
|
Minimum frequency. |
required |
f_max
|
float
|
Maximum frequency. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
tuple |
tuple[Float[Array, ' n_freq'], Complex[Array, ' n_freq'], Float[Array, ' n_freq']]
|
The frequencies, the frequency-domain data and the PSD in the range. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the detector has no data or no PSD, if the range is wider than the frequency range of the data, if the PSD is not finite and positive in it, or if the range holds fewer than two frequencies. |
td_response(time: Float[Array, ' n_sample'], h_sky: dict[str, Float[Array, ' n_sample']], params: dict) -> Float[Array, ' n_sample']
abstractmethod
¤
Modulate the waveform in the sky frame by the detector response in the time domain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
Float[Array, ' n_sample']
|
Array of time samples. |
required |
h_sky
|
dict[str, Float[Array, ' n_sample']]
|
Dictionary mapping polarization names to time-domain waveforms. |
required |
params
|
dict
|
Dictionary of source parameters. |
required |
Returns:
| Type | Description |
|---|---|
Float[Array, ' n_sample']
|
Array of detector response in time domain. |
GroundBased2G
¤
Bases: Detector
Object representing a ground-based detector.
Contains information about the location and orientation of the detector on Earth, as well as actual strain data and the PSD of the associated noise.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Name of the detector. |
latitude |
Float
|
Latitude of the detector in radians. |
longitude |
Float
|
Longitude of the detector in radians. |
xarm_azimuth |
Float
|
Azimuth of the x-arm in radians. |
yarm_azimuth |
Float
|
Azimuth of the y-arm in radians. |
xarm_tilt |
Float
|
Tilt of the x-arm in radians. |
yarm_tilt |
Float
|
Tilt of the y-arm in radians. |
elevation |
Float
|
Elevation of the detector in meters. |
polarization_mode |
list[Polarization]
|
List of polarization modes ( |
data |
Data
|
Array of frequency-domain strain data. |
psd |
PowerSpectrum
|
Power spectral density object. |
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize a ground-based detector. |
antenna_pattern |
Compute antenna patterns for polarizations at specified sky location. |
delay_from_geocenter |
Calculate time delay between two detectors in geocentric coordinates. |
fd_response |
Modulate the waveform in the sky frame by the detector response in the frequency domain. |
get_whitened_frequency_domain_strain |
Get the whitened frequency-domain strain. |
inject_signal |
Add a signal to the data of the detector. |
load_and_set_psd |
Load power spectral density (PSD) from file or the built-in design |
set_data |
Replace the data of the detector. |
set_psd |
Replace the PSD of the detector. |
set_zero_noise |
Replace the data by a segment of zeros. |
simulate_and_set_noise |
Replace the data by noise drawn from the PSD. |
td_response |
Modulate the waveform in the sky frame by the detector response in the time domain. |
whitened_frequency_to_time_domain_strain |
Get the whitened frequency-domain strain. |
arms: tuple[Float[Array, 3], Float[Array, 3]]
property
¤
Get the detector arm vectors.
Returns:
| Type | Description |
|---|---|
tuple[Float[Array, 3], Float[Array, 3]]
|
tuple[Float[Array, "3"], Float[Array, "3"]]: A tuple containing: - x: X-arm vector in geocentric Cartesian coordinates - y: Y-arm vector in geocentric Cartesian coordinates |
tensor: Float[Array, '3 3']
property
¤
Get the detector tensor defining the strain measurement.
For a 2-arm differential-length detector, this is given by:
for unit vectors \(x\) and \(y\) along the x and y arms.
Returns:
| Type | Description |
|---|---|
Float[Array, '3 3']
|
Float[Array, "3 3"]: The 3x3 detector tensor in geocentric coordinates. |
vertex: Float[Array, 3]
property
¤
Detector vertex coordinates in the reference celestial frame.
Returns:
| Type | Description |
|---|---|
Float[Array, 3]
|
Float[Array, "3"]: Detector vertex coordinates in geocentric Cartesian coordinates. |
whitened_frequency_domain_data: Complex[Array, ' n_sample']
property
¤
Get the whitened frequency-domain data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frequency
|
Float[Array, n_sample]
|
Array of frequency samples. |
required |
Returns:
| Type | Description |
|---|---|
Complex[Array, ' n_sample']
|
Float[Array, "n_sample"]: Whitened frequency-domain data. |
whitened_time_domain_data: Float[Array, ' n_sample']
property
¤
Get the whitened time-domain data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
Float[Array, n_sample]
|
Array of time samples. |
required |
Returns:
| Type | Description |
|---|---|
Float[Array, ' n_sample']
|
Float[Array, "n_sample"]: Whitened time-domain data. |
__init__(name: str, latitude: float = 0, longitude: float = 0, elevation: float = 0, xarm_azimuth: float = 0, yarm_azimuth: float = 0, xarm_tilt: float = 0, yarm_tilt: float = 0, modes: str = 'pc')
¤
Initialize a ground-based detector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of the detector. |
required |
latitude
|
float
|
Latitude of the detector in radians. Defaults to 0. |
0
|
longitude
|
float
|
Longitude of the detector in radians. Defaults to 0. |
0
|
elevation
|
float
|
Elevation of the detector in meters. Defaults to 0. |
0
|
xarm_azimuth
|
float
|
Azimuth of the x-arm in radians. Defaults to 0. |
0
|
yarm_azimuth
|
float
|
Azimuth of the y-arm in radians. Defaults to 0. |
0
|
xarm_tilt
|
float
|
Tilt of the x-arm in radians. Defaults to 0. |
0
|
yarm_tilt
|
float
|
Tilt of the y-arm in radians. Defaults to 0. |
0
|
modes
|
str
|
Polarization modes. Defaults to "pc". |
'pc'
|
antenna_pattern(ra: FloatLike, dec: FloatLike, psi: FloatLike, gmst: FloatLike) -> dict[str, ComplexLike]
¤
Compute antenna patterns for polarizations at specified sky location.
In the long-wavelength approximation, the antenna pattern for a given polarization is the dyadic product between the detector tensor and the corresponding polarization tensor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ra
|
Float
|
Source right ascension in radians. |
required |
dec
|
Float
|
Source declination in radians. |
required |
psi
|
Float
|
Source polarization angle in radians. |
required |
gmst
|
Float
|
Greenwich mean sidereal time (GMST) in radians. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, ComplexLike]
|
dict[str, Complex]: Dictionary mapping polarization names to their antenna pattern values. |
delay_from_geocenter(ra: FloatLike, dec: FloatLike, gmst: FloatLike) -> FloatScalar
¤
Calculate time delay between two detectors in geocentric coordinates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ra
|
Float
|
Right ascension of the source in radians. |
required |
dec
|
Float
|
Declination of the source in radians. |
required |
gmst
|
Float
|
Greenwich mean sidereal time in radians. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Float |
FloatScalar
|
Time delay from Earth center in seconds. |
fd_response(frequency: Float[Array, ' n_sample'], h_sky: dict[str, Float[Array, ' n_sample']], params: Mapping[str, FloatLike]) -> Complex[Array, ' n_sample']
¤
Modulate the waveform in the sky frame by the detector response in the frequency domain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frequency
|
Float[Array, n_sample]
|
Array of frequency samples. |
required |
h_sky
|
dict[str, Float[Array, n_sample]]
|
Dictionary mapping polarization names to frequency-domain waveforms. Keys are polarization names (e.g., 'plus', 'cross') and values are complex strain arrays. |
required |
params
|
dict[str, Float]
|
Dictionary of source parameters containing: - ra (Float): Right ascension in radians - dec (Float): Declination in radians - psi (Float): Polarization angle in radians - t_c (Float): The difference between peak time and trigger time in sec |
required |
The attached data supply the trigger and segment start.
Returns:
| Name | Type | Description |
|---|---|---|
Array |
Complex[Array, ' n_sample']
|
Complex strain measured by the detector in frequency domain, obtained by combining the antenna patterns for each polarization mode. |
get_whitened_frequency_domain_strain(frequency_series: Complex[Array, ' n_freq']) -> Complex[Array, ' n_freq']
¤
Get the whitened frequency-domain strain. Args: frequency_series (Complex[Array, "n_freq"]): Array of frequency domain data/signal. Returns: Complex[Array, "n_freq"]: Whitened frequency-domain strain.
inject_signal(waveform_model, parameters: dict[str, float], allow_wraparound: bool = False) -> tuple[FloatScalar, ComplexScalar]
¤
Add a signal to the data of the detector.
The signal is cut to the frequency range of the data and added in the frequency domain to whatever the detector holds: zero data, noise, real data or earlier signals. Call it again to add more signals.
Note: The detector needs a PSD and data beforehand. set_zero_noise and
simulate_and_set_noise create the data with the frequency range that the
injection needs; for other data, such as real data, set
data.frequency_bounds first. The trigger time is that of the data
(Data.trigger_time), by default 2 s before their end.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
waveform_model
|
The frequency-domain waveform model to be injected. |
required | |
parameters
|
dict
|
Likelihood-space source parameters: those of the
waveform model ( |
required |
allow_wraparound
|
bool
|
The waveform has no time axis, so a signal that
does not fit the segment wraps around in it. By default that is an
error; with True it is a warning. A conservative inspiral-duration
estimate and merger margins check compact-binary signals requiring
|
False
|
Returns:
| Name | Type | Description |
|---|---|---|
tuple |
tuple[FloatScalar, ComplexScalar]
|
The optimal SNR of the signal, and its matched-filter SNR against the data including the signal, noise and earlier signals. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the detector has no PSD or no data, if the PSD is not
finite and positive over the frequency range of the data, if the
range does not start above 0 Hz or holds fewer than two frequencies,
if the trigger time of the data is not inside them, if a parameter is
missing or |
load_and_set_psd(psd_file: str = '', asd_file: str = '') -> PowerSpectrum
¤
Load power spectral density (PSD) from file or the built-in design sensitivity, and set it to the detector.
Supported formats: .npz, .txt, .dat, .csv.
Pass asd_file (or is_asd=True via :meth:PowerSpectrum.from_file)
when the file contains amplitude spectral density values
(\(\mathrm{Hz}^{-1/2}\)); they are squared internally to produce a PSD.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
psd_file
|
str
|
Path to a PSD file (\(\mathrm{Hz}^{-1}\)). If neither file is given,
the design-sensitivity ASD packaged for this detector is used (see |
''
|
asd_file
|
str
|
Path to an ASD file (\(\mathrm{Hz}^{-1/2}\)). Values are squared. |
''
|
Returns:
| Name | Type | Description |
|---|---|---|
PowerSpectrum |
PowerSpectrum
|
The loaded PSD, already set on the detector. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If both |
set_data(data: Data | Array, **kws) -> None
¤
Replace the data of the detector.
The PSD is interpolated onto the frequencies of the new data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
Data | Array
|
The new data, either as a |
required |
**kws
|
dict
|
Additional keyword arguments to pass to |
{}
|
set_psd(psd: PowerSpectrum | Array, **kws) -> None
¤
Replace the PSD of the detector.
It is interpolated onto the frequencies of the data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
psd
|
PowerSpectrum | Array
|
The new PSD, either as a |
required |
**kws
|
dict
|
Additional keyword arguments to pass to |
{}
|
set_zero_noise(*, duration: float, sampling_frequency: float, trigger_time: float, f_min: float, f_max: float, post_trigger_duration: float = DEFAULT_POST_TRIGGER_DURATION) -> None
¤
Replace the data by a segment of zeros.
The segment ends post_trigger_duration seconds after the trigger.
[f_min, f_max] becomes the frequency range of the data: signals injected
later are cut to it. The trigger time is stored in the data, where
inject_signal reads it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
duration
|
float
|
Duration of the data segment in seconds. |
required |
sampling_frequency
|
float
|
Sampling frequency in Hz. |
required |
trigger_time
|
float
|
GPS time of the event trigger. |
required |
f_min
|
float
|
Minimum frequency of the data in Hz. |
required |
f_max
|
float
|
Maximum frequency of the data in Hz. |
required |
post_trigger_duration
|
float
|
Time in seconds from the trigger to the end of the segment. Defaults to 2.0. |
DEFAULT_POST_TRIGGER_DURATION
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
simulate_and_set_noise(*, duration: float, sampling_frequency: float, trigger_time: float, f_min: float, f_max: float, rng_key: Key[Array, ''], post_trigger_duration: float = DEFAULT_POST_TRIGGER_DURATION) -> None
¤
Replace the data by noise drawn from the PSD.
The noise is cut to [f_min, f_max], which becomes the frequency range of
the data. It depends only on rng_key and the name of the detector, so
every detector gets its own noise from one key. The segment ends
post_trigger_duration seconds after the trigger.
Note: The power spectral density must be set beforehand, and it must be
finite and positive over [f_min, f_max].
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
duration
|
float
|
Duration of the data segment in seconds. |
required |
sampling_frequency
|
float
|
Sampling frequency in Hz. |
required |
trigger_time
|
float
|
GPS time of the event trigger. |
required |
f_min
|
float
|
Minimum frequency of the data in Hz. |
required |
f_max
|
float
|
Maximum frequency of the data in Hz. |
required |
rng_key
|
Key
|
PRNG key for the noise, such as |
required |
post_trigger_duration
|
float
|
Time in seconds from the trigger to the end of the segment. Defaults to 2.0. |
DEFAULT_POST_TRIGGER_DURATION
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If no PSD is set, if it is not finite and positive over the
frequency range of the data, or for any reason given at |
td_response(time: Float[Array, ' n_sample'], h_sky: dict[str, Float[Array, ' n_sample']], params: dict) -> Array
¤
Modulate the waveform in the sky frame by the detector response in the time domain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
Float[Array, ' n_sample']
|
Array of time samples. |
required |
h_sky
|
dict[str, Float[Array, ' n_sample']]
|
Dictionary mapping polarization names to time-domain waveforms. |
required |
params
|
dict
|
Dictionary of source parameters. |
required |
Returns:
| Type | Description |
|---|---|
Array
|
Array of detector response in time domain. |
whitened_frequency_to_time_domain_strain(whitened_frequency_series: Complex[Array, ' n_time // 2 + 1']) -> Float[Array, ' n_time']
¤
Get the whitened frequency-domain strain. Args: whitened_frequency_series (Complex[Array, "n_time // 2 + 1"]): Array of whitened frequency domain data/signal. Returns: Float[Array, "n_time"]: Whitened time-domain strain/signal.
GroundBased3G
¤
Bases: GroundBased2G
Ground-based detector with a frequency-dependent response.
With earth_rotation, the response follows the Earth's rotation while the
signal is in band, which matters for signals that stay in band for ten
minutes or longer. It needs M_c, eta, s1_z and s2_z among the
parameters passed to fd_response.
With finite_arm_length, the arms are not assumed to be short compared to
the gravitational wavelength, which matters for loud signals with power at
high frequencies. Its phase convention is given in the technical notes of the documentation.
With both switched off, the response is identical to
GroundBased2G.
Attributes:
| Name | Type | Description |
|---|---|---|
arm_length |
float
|
Arm length in meters, used by the finite-arm-length response. |
earth_rotation |
bool
|
Whether the response follows the Earth's rotation. |
finite_arm_length |
bool
|
Whether the finite-arm-length response is included. |
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize a ground-based detector with an Earth-rotating response. |
fd_response |
Project the sky-frame waveform with a frequency-dependent response. |
from_detector |
Build a detector with the geometry of an existing ground-based detector. |
gmst_at_frequency |
Sidereal angle at the time each frequency is emitted. |
time_to_merger |
Stationary-phase time to merger at 2PN for an aligned-spin binary. |
__init__(name: str, latitude: float = 0, longitude: float = 0, elevation: float = 0, xarm_azimuth: float = 0, yarm_azimuth: float = 0, xarm_tilt: float = 0, yarm_tilt: float = 0, modes: str = 'pc', arm_length: float = 0.0, earth_rotation: bool = True, finite_arm_length: bool = False)
¤
Initialize a ground-based detector with an Earth-rotating response.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of the detector. |
required |
latitude
|
float
|
Latitude of the detector in radians. Defaults to 0. |
0
|
longitude
|
float
|
Longitude of the detector in radians. Defaults to 0. |
0
|
elevation
|
float
|
Elevation of the detector in meters. Defaults to 0. |
0
|
xarm_azimuth
|
float
|
Azimuth of the x-arm in radians. Defaults to 0. |
0
|
yarm_azimuth
|
float
|
Azimuth of the y-arm in radians. Defaults to 0. |
0
|
xarm_tilt
|
float
|
Tilt of the x-arm in radians. Defaults to 0. |
0
|
yarm_tilt
|
float
|
Tilt of the y-arm in radians. Defaults to 0. |
0
|
modes
|
str
|
Polarization modes. Defaults to "pc". |
'pc'
|
arm_length
|
float
|
Arm length in meters. Defaults to 0. |
0.0
|
earth_rotation
|
bool
|
Follow the Earth's rotation across frequencies. Defaults to True. |
True
|
finite_arm_length
|
bool
|
Include the finite-arm-length response. Defaults to False. |
False
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
fd_response(frequency: Float[Array, ' n_sample'], h_sky: dict[str, Float[Array, ' n_sample']], params: Mapping[str, FloatLike]) -> Complex[Array, ' n_sample']
¤
Project the sky-frame waveform with a frequency-dependent response.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frequency
|
Float[Array, n_sample]
|
Array of frequency samples. |
required |
h_sky
|
dict[str, Float[Array, n_sample]]
|
Dictionary mapping polarization names to frequency-domain waveforms. |
required |
params
|
dict[str, Float]
|
Source parameters, as for |
required |
Returns:
| Type | Description |
|---|---|
Complex[Array, ' n_sample']
|
Complex[Array, "n_sample"]: Complex strain measured by the detector in frequency domain. |
from_detector(detector: GroundBased2G, arm_length: float = 0.0, earth_rotation: bool = True, finite_arm_length: bool = False) -> Self
classmethod
¤
Build a detector with the geometry of an existing ground-based detector.
Only the geometry and polarization modes are copied, not the data or PSD.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
detector
|
GroundBased2G
|
Detector whose geometry is copied. |
required |
arm_length
|
float
|
Arm length in meters. Defaults to 0. |
0.0
|
earth_rotation
|
bool
|
Follow the Earth's rotation across frequencies. Defaults to True. |
True
|
finite_arm_length
|
bool
|
Include the finite-arm-length response. Defaults to False. |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
GroundBased3G |
Self
|
The new detector. |
gmst_at_frequency(frequency: Float[Array, ' n_sample'], params: Mapping[str, FloatLike]) -> Float[Array, ' n_sample']
¤
Sidereal angle at the time each frequency is emitted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frequency
|
Float[Array, n_sample]
|
Array of frequency samples. |
required |
params
|
dict[str, Float]
|
Source parameters containing |
required |
Returns:
| Type | Description |
|---|---|
Float[Array, ' n_sample']
|
Float[Array, "n_sample"]: GMST in radians. Non-positive frequencies, which have no emission time, are assigned the merger time. |
time_to_merger(frequency: Float[Array, ' n_sample'], M_c: FloatLike, eta: FloatLike, s1_z: FloatLike = 0.0, s2_z: FloatLike = 0.0, mode: int = 2) -> Float[Array, ' n_sample']
staticmethod
¤
Stationary-phase time to merger at 2PN for an aligned-spin binary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frequency
|
Float[Array, n_sample]
|
Gravitational-wave frequency in Hz. |
required |
M_c
|
Float
|
Detector-frame chirp mass in solar masses. |
required |
eta
|
Float
|
Symmetric mass ratio. |
required |
s1_z
|
Float
|
Aligned spin of the primary. Defaults to 0. |
0.0
|
s2_z
|
Float
|
Aligned spin of the secondary. Defaults to 0. |
0.0
|
mode
|
int
|
Azimuthal mode number that |
2
|
Returns:
| Type | Description |
|---|---|
Float[Array, ' n_sample']
|
Float[Array, "n_sample"]: Time to merger in seconds. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
get_CE(*, earth_rotation: bool = False, finite_arm_length: bool = False) -> GroundBased3G
¤
Return a instance for Cosmic Explorer (CE).
CE shares the LIGO Hanford site geometry and has 40 km arms.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
earth_rotation
|
bool
|
Follow the Earth's rotation. Turn on for signals that stay in band for ten minutes or longer. Defaults to False. |
False
|
finite_arm_length
|
bool
|
Account for the arms' finite length relative to the wavelength. Turn on for loud signals with power at high frequencies. Defaults to False. |
False
|
get_ET(*, earth_rotation: bool = False, finite_arm_length: bool = False) -> list[GroundBased3G]
¤
Return a list of three instances for the triangular Einstein Telescope (ET).
The design is a triangle of three detectors with 10 km arms at the Euregio Meuse-Rhine site, with the arm azimuths of the Virgo arms.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
earth_rotation
|
bool
|
Follow the Earth's rotation. Turn on for signals that stay in band for ten minutes or longer. Defaults to False. |
False
|
finite_arm_length
|
bool
|
Account for the arms' finite length relative to the wavelength. Turn on for loud signals with power at high frequencies. Defaults to False. |
False
|
get_ET_2L(*, alignment_angle: float = 42.5, earth_rotation: bool = False, finite_arm_length: bool = False) -> list[GroundBased3G]
¤
Return the two L-shaped detectors of the Einstein Telescope 2L design.
The design has two L-shaped detectors with 15 km arms, ET_Sar in
Sardinia and ET_EMR in the Euregio Meuse-Rhine. The arms of ET_Sar have
the azimuths of the Virgo arms. The arms of ET_EMR are rotated from those
of ET_Sar by alignment_angle, a difference of azimuths, each measured
against the local axes of its site rather than the great circle between them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
alignment_angle
|
float
|
Rotation of the arms of |
42.5
|
earth_rotation
|
bool
|
Follow the Earth's rotation. Turn on for signals that stay in band for ten minutes or longer. Defaults to False. |
False
|
finite_arm_length
|
bool
|
Account for the arms' finite length relative to the wavelength. Turn on for loud signals with power at high frequencies. Defaults to False. |
False
|
get_H1() -> GroundBased2G
¤
Return a instance for LIGO Hanford (H1).
get_L1() -> GroundBased2G
¤
Return a instance for LIGO Livingston (L1).
get_V1() -> GroundBased2G
¤
Return a instance for Virgo (V1).
get_detector_preset(*, earth_rotation: bool = False, finite_arm_length: bool = False) -> dict[str, GroundBased2G | list[GroundBased3G]]
¤
Return a dictionary of pre-configured detector instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
earth_rotation
|
bool
|
Passed to |
False
|
finite_arm_length
|
bool
|
Passed to |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
dict |
dict[str, GroundBased2G | list[GroundBased3G]]
|
Mapping of detector name to detector object(s).
Keys are |