gravelamps.waveform.waveform_generator¶

Class definitions for bilby compliant waveform generators that take an unlensed source model and apply the specified model amplification factor.

class gravelamps.waveform.waveform_generator.LensedWaveformGenerator(duration=None, sampling_frequency=None, start_time=0, frequency_domain_source_model=None, time_domain_source_model=None, parameters=None, parameter_conversion=None, waveform_arguments=None)¶

Bases: WaveformGenerator

Base lensed waveform generator object which will use the main amplification factor function for a given lens model.

Attributes:

parameters: The dictionary of parameters for source model.

Methods

`frequency_domain_strain`([parameters])	Wrapper to source_model.
`lens_frequency_array`(model_data_points)	Converts the frequency array to dimensionless frequency if needed.
`time_domain_strain`([parameters])	Wrapper to source_model.

Converts the frequency array to dimensionless frequency if needed.

Parameters:

model_data_points: ArrayLike: Frequency array in Hz.

class gravelamps.waveform.waveform_generator.SingleImageGenerator(duration=None, sampling_frequency=None, start_time=0, frequency_domain_source_model=None, time_domain_source_model=None, parameters=None, parameter_conversion=None, waveform_arguments=None)¶

Bases: LensedWaveformGenerator

Variant of LensedWaveformGenerator that computes only the amplification from a single image of the geometric opticss approximation.

Attributes:

parameters: The dictionary of parameters for source model.

Methods

`frequency_domain_strain`([parameters])	Wrapper to source_model.
`get_image`()	Get the image to be used for the amplification.
`lens_frequency_array`(model_data_points)	Converts the frequency array to dimensionless frequency if needed.
`time_domain_strain`([parameters])	Wrapper to source_model.

get_image() → float¶: Get the image to be used for the amplification.