lalsimulation.gwsignal.core.waveform Namespace Reference

Data Structures
class	CompactBinaryCoalescenceGenerator
	This is the parent generator class for compact binary coalescence waveforms (BBH, BNS, NSBH etc.). More...
class	GravitationalWaveGenerator
	This is the Parent class for all gravitational wave generator classes. More...
class	LALCompactBinaryCoalescenceGenerator
	Generator class for all CBC waveforms as implemented in LALSimulation. More...

Functions
def	conditioning_generator (generator)
	Given a generator with contioning as 1, return function that generates conditioned waveforms. More...
def	to_gwpy_Series (h, f0=0., **kwargs)
	Function to convert a lal series to a gwpy series. More...
def	to_gwpy_dict (mode_dict, **kwargs)
	Function to convert a mode dictionary of lal series to a dictionary of gwpy series. More...
def	GenerateTDWaveform (parameter_dict, generator)
	Generate Waveform Polarizations and Modes functions ##################################. More...
def	GenerateFDWaveform (parameter_dict, generator)
	Function to generate frequency domain gravitational wave polarizations. More...
def	GenerateTDModes (parameter_dict, generator)
	Function to generate time domain gravitational wave modes. More...
def	GenerateFDModes (parameter_dict, generator)
	Function to generate frequency domain gravitational wave modes. More...

Function Documentation

conditioning_generator()

def lalsimulation.gwsignal.core.waveform.conditioning_generator

(

generator

)

Given a generator with contioning as 1, return function that generates conditioned waveforms.

Parameters

generator : GravitationalWaveGenerator GravitationalWaveGenerator object

Returns

Conditioning function for the generator

Definition at line 504 of file waveform.py.

to_gwpy_Series()

def lalsimulation.gwsignal.core.waveform.to_gwpy_Series	(		h,
			f0 = 0.,
		**	kwargs
	)

Function to convert a lal series to a gwpy series.

Parameters

h : lal time or frequency series 'lal.REAL8TimeSeries' or 'lal.COMPLEX16FrequencySeries'

f0 : Starting frequency passed to gwpy.FrequencySeries

Returns

h : GWpy Time/Freq series Time/Freq domain waveform

Definition at line 541 of file waveform.py.

to_gwpy_dict()

def lalsimulation.gwsignal.core.waveform.to_gwpy_dict	(		mode_dict,
		**	kwargs
	)

Function to convert a mode dictionary of lal series to a dictionary of gwpy series.

Parameters

mode_dict : python dictionary entries of the form {(l, m): lal-series} and {time/frequency_array : }

Returns

new_dict : python dictionary entries of the form {(l, m): gwpy-series} and {time/frequency_array : }

Definition at line 572 of file waveform.py.

GenerateTDWaveform()

def lalsimulation.gwsignal.core.waveform.GenerateTDWaveform	(		parameter_dict,
			generator
	)

Generate Waveform Polarizations and Modes functions ##################################.

Function to generate time domain gravitational wave polarizations.

Parameters

parameter_dict : dictionary Dictionary of intrinsic / extrinsic gravitational wave parameters generator : Python GW generator class Generator class for the waveform approximant (either LAL or external)

Returns

GravitationalWavePolarizations object: allows to extract the zero noise strain given a detector, sky-position, polarization and time of arrival values.

Definition at line 609 of file waveform.py.

GenerateFDWaveform()

def lalsimulation.gwsignal.core.waveform.GenerateFDWaveform	(		parameter_dict,
			generator
	)

Function to generate frequency domain gravitational wave polarizations.

Parameters

parameter_dict : dictionary Dictionary of intrinsic / extrinsic gravitational wave parameters generator : Python GW generator class Generator class for the waveform approximant (either LAL or external)

Returns

GravitationalWavePolarizations object: allows to extract the zero noise strain given a detector, sky-position, polarization and time of arrival values.

Definition at line 646 of file waveform.py.

GenerateTDModes()

def lalsimulation.gwsignal.core.waveform.GenerateTDModes	(		parameter_dict,
			generator
	)

Function to generate time domain gravitational wave modes.

Parameters

parameter_dict : dictionary Dictionary of intrinsic / extrinsic gravitational wave parameters generator : Python GW generator class Generator class for the waveform approximant (either LAL or external)

Returns

hlm : Python dictionary Time domain modes returned as a dictionary where each mode is a GWpy Time series object

Definition at line 683 of file waveform.py.

GenerateFDModes()

def lalsimulation.gwsignal.core.waveform.GenerateFDModes	(		parameter_dict,
			generator
	)

Function to generate frequency domain gravitational wave modes.

Parameters

parameter_dict : dictionary Dictionary of intrinsic / extrinsic gravitational wave parameters generator : Python GW generator class Generator class for the waveform approximant (either LAL or external)

Returns

hlm : Python dictionary Frequency domain modes returned as a dictionary where each mode is a GWpy Frequency series object

Definition at line 709 of file waveform.py.