lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM Class Reference

Detailed Description

Implements a wrapper for SEOBNRv5 in the pyseob package.

Parameters

No parameters required for initialization.

Definition at line 166 of file pyseobnr_model.py.

Inherits lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator.

Public Member Functions
def	__init__ (self, **kwargs)
	Initialize class. More...
def	metadata (self)
def	generate_fd_waveform (self, **parameters)
	Generate frequency domain polarizations given kwargs. More...
def	generate_td_waveform (self, **parameters)
	Generate time domain polarizations given kwargs. More...
def	generate_td_modes (self, **parameters)
	Generate time domain modes given kwargs. 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
	seobnr
	waveform_dict
Data Fields inherited from lalsimulation.gwsignal.core.waveform.CompactBinaryCoalescenceGenerator
	waveform_dict
	lal_dict

Constructor & Destructor Documentation

__init__()

def lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.__init__	(		self,
		**	kwargs
	)

Initialize class.

Parameters

No parameters required for initilazation.

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

Definition at line 170 of file pyseobnr_model.py.

Member Function Documentation

metadata()

def lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.metadata

(

self

)

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

Definition at line 180 of file pyseobnr_model.py.

generate_fd_waveform()

def lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.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 from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 295 of file pyseobnr_model.py.

generate_td_waveform()

def lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.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 from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 298 of file pyseobnr_model.py.

generate_td_modes()

def lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.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 from lalsimulation.gwsignal.core.waveform.GravitationalWaveGenerator.

Definition at line 301 of file pyseobnr_model.py.

Field Documentation

seobnr

lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.seobnr

Definition at line 174 of file pyseobnr_model.py.

waveform_dict

lalsimulation.gwsignal.models.pyseobnr_model.SEOBNRv5HM.waveform_dict

Definition at line 234 of file pyseobnr_model.py.