lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator Class Reference

Detailed Description

Generator class for all CBC waveforms as implemented in LALSimulation.

Definition at line 208 of file waveform.py.

Inherits lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator.

Public Member Functions
def	__init__ (self, approximant, **kwargs)
	Initialize class. More...
def	metadata (self)
def	generate_td_waveform (self, **parameters)
	Perform parameter check, choose lalsimulation generator based on domain and conditioning subroutines. More...
def	generate_fd_waveform (self, **parameters)
	Perform parameter check, choose lalsimulation generator based on domain and conditioning subroutines. More...
def	generate_td_modes (self, **parameters)
	Perform parameter check, choose lalsimulation generator based on domain and attempt to generate the waveform modes. More...
def	generate_fd_modes (self, **parameters)
	Perform parameter check, choose lalsimulation generator based on domain and attempt to generate the waveform modes. More...
Public Member Functions inherited from lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator
def	__init__ (self)
	Initialize class. More...
def	parameter_check (self, units_sys='S.I.', extra_parameters=dict(), **parameters)
	Perform checks on the various parameters and populate the different parameters not passed in the kwargs required for generating waveforms. More...
Public Member Functions inherited from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator
def	__init__ (self)
	Initialize the class and set base domain to time. More...
def	generate_td_modes (self, **kwargs)
	Generate time domain modes given kwargs. More...
def	generate_fd_modes (self, **kwargs)
	Generate frequency domain modes given kwargs. More...
def	generate_td_waveform (self, **kwargs)
	Generate time domain polarizations given kwargs. More...
def	generate_fd_waveform (self, **kwargs)
	Generate frequency domain polarizations given kwargs. More...
def	domain (self)
def	metadata (self)

Data Fields
	approximant
Data Fields inherited from lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator
	waveform_dict
	lal_dict

Constructor & Destructor Documentation

__init__()

def lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.__init__	(		self,
			approximant,
		**	kwargs
	)

Initialize class.

Parent class is the "CompactBinaryCoalescenceGenerator" class

Parameters

approximant : type 'str' Name of the LAL approximant of which waveform to be generated

Returns

generator : Python GW generator class Generator class for LALSimulation waveforms required to generate time and frequency domain polarizations and modes

Reimplemented from lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator.

Definition at line 224 of file waveform.py.

Member Function Documentation

metadata()

def lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.metadata

(

self

)

Reimplemented from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 233 of file waveform.py.

generate_td_waveform()

def lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.generate_td_waveform	(		self,
		**	parameters
	)

Perform parameter check, choose lalsimulation generator based on domain and conditioning subroutines.

Parameters

parameter_dict : dictionary Dictionary of waveform parameters of the form specified in parameter_conventions.py.

Returns

hp, hc : LAL Time Series Plus and cross polarizations of a gravitational waveform (hp,hc) as LAL Data objects.

Raises

ValueError if domain ('time' or 'freq') for approximant is not specified

Reimplemented from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 311 of file waveform.py.

generate_fd_waveform()

def lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.generate_fd_waveform	(		self,
		**	parameters
	)

Perform parameter check, choose lalsimulation generator based on domain and conditioning subroutines.

Parameters

parameter_dict : dictionary Dictionary of waveform parameters of the form specified in parameter_conventions.py.

Returns

hp, hc : LAL Frequency Series Plus and cross polarizations of a gravitational waveform (hp,hc) as LAL Data objects.

Raises

ValueError if domain ('time' or 'freq') for approximant is not specified

Reimplemented from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 352 of file waveform.py.

generate_td_modes()

def lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.generate_td_modes	(		self,
		**	parameters
	)

Perform parameter check, choose lalsimulation generator based on domain and attempt to generate the waveform modes.

Parameters

parameter_dict : dictionary Dictionary of waveform parameters of the form specified in parameter_conventions.py.

Returns

hlm : Python dictionary of modes Modes of a gravitational waveform as python dictionary where each mode is LAL Time series objects.

Reimplemented from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 393 of file waveform.py.

generate_fd_modes()

def lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.generate_fd_modes	(		self,
		**	parameters
	)

Perform parameter check, choose lalsimulation generator based on domain and attempt to generate the waveform modes.

Parameters

parameter_dict : dictionary Dictionary of waveform parameters of the form specified in parameter_conventions.py.

Returns

hlm : Python dictionary of modes Modes of a gravitational waveform as python dictionary where each mode is LAL Frequency series objects.

Reimplemented from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 454 of file waveform.py.

Field Documentation

approximant

lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.approximant

Definition at line 227 of file waveform.py.