lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator Class Reference

Detailed Description

This is the Parent class for all gravitational wave generator classes.

This class implements the basic generate modes and polarizations definitions which can then be used by the consequent children classes.

Definition at line 22 of file waveform.py.

Inherits object.

Inherited by lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator.

Public Member Functions
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)

Constructor & Destructor Documentation

__init__()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.__init__

(

self

)

Initialize the class and set base domain to time.

Parameters

No parameters required for initialization.

Reimplemented in lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5EHM, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5PHM, and lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.

Definition at line 32 of file waveform.py.

Member Function Documentation

generate_td_modes()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.generate_td_modes	(		self,
		**	kwargs
	)

Generate time domain modes given kwargs.

The child classes will provide these routines.

Parameters

kwargs required for generation of waveform modes

Returns

Waveform modes as implemented in the child class

Reimplemented in lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5EHM, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM, and lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5PHM.

Definition at line 48 of file waveform.py.

generate_fd_modes()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.generate_fd_modes	(		self,
		**	kwargs
	)

Generate frequency domain modes given kwargs.

The child classes will provide these routines.

Parameters

kwargs required for generation of waveform modes

Returns

Waveform modes as implemented in the child class

Reimplemented in lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator.

Definition at line 65 of file waveform.py.

generate_td_waveform()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.generate_td_waveform	(		self,
		**	kwargs
	)

Generate time domain polarizations given kwargs.

The child classes will provide these routines.

Parameters

kwargs required for generation of waveform polarizations

Returns

Waveform polarizations implemented in the child class

Reimplemented in lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5EHM, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM, and lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5PHM.

Definition at line 82 of file waveform.py.

generate_fd_waveform()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.generate_fd_waveform	(		self,
		**	kwargs
	)

Generate frequency domain polarizations given kwargs.

The child classes will provide these routines.

Parameters

kwargs required for generation of waveform polarizations

Returns

Waveform polarizations as implemented in the child class

Reimplemented in lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5EHM, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM, and lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5PHM.

Definition at line 99 of file waveform.py.

domain()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.domain

(

self

)

Definition at line 103 of file waveform.py.

metadata()

def lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.metadata

(

self

)

Reimplemented in lalsimulation.gwsignal.core.waveform.LALCompactBinaryCoalescenceGenerator, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5EHM, lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM, and lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5PHM.

Definition at line 123 of file waveform.py.