Detailed Description

This structure stores the parameters for constructing a gravitational waveform with both a Taylor-polynomial intrinsic frequency and phase, and a binary-orbit modulation.

As with the PPNParamStruc type in GeneratePPNInspiral_h, we divide the fields into passed fields (which are supplied to the final PulsarCoherentGW structure but not used in any calculations), input fields (that are used by the waveform generator), and output fields (that are set by the waveform generator).

Definition at line 252 of file GenerateSpinOrbitCW.h.

Data Fields
Passed parameters.
SkyPosition	position
	The location of the source on the sky, normally in equatorial coordinates. More...

REAL4	psi
	The polarization angle of the source, in radians. More...

Input parameters.
LIGOTimeGPS	epoch
	The start time of the output series. More...

LIGOTimeGPS	spinEpoch
	A reference time \( t_\mathrm{ref} \) (in the barycentric frame) at which the rotational properties of the source are specified. More...

LIGOTimeGPS	orbitEpoch
	A time \( t_\mathrm{peri} \) (in the barycentric frame) at which the source passes through periapsis. More...

REAL8	deltaT
	The requested sampling interval of the waveform, in s. More...

UINT4	length
	The number of samples in the generated waveform. More...

REAL4	aPlus

REAL4	aCross
	The polarization amplitudes \( A_+ \) , \( A_\times \) , in dimensionless strain units. More...

REAL8	phi0
	The phase of the wave emitted at time \( t_\mathrm{ref} \) , in radians. More...

REAL8	f0
	The frequency of the wave emitted at time \( t_\mathrm{ref} \) (and incorporating any Doppler shift due to \( \dot{R}_0 \) ), in Hz. More...

REAL8Vector *	f
	The spin-normalized Taylor parameters \( f_k \) , as defined in Eq. More...

REAL8	omega
	The argument of the periapsis, \( \omega \) , in radians. More...

REAL8	rPeriNorm
	The projected, speed-of-light-normalized periapsis separation of the orbit, \( (r_p/c)\sin i \) , in s. More...

REAL8	oneMinusEcc
	The value of \( 1-e \). More...

REAL8	angularSpeed
	The angular speed at periapsis, \( \dot{\upsilon}_p \) , in Hz. More...

Output parameters.
REAL4	dfdt
	The maximum value of \( \Delta f\Delta t \) encountered over any timestep \( \Delta t \) used in generating the waveform. More...

Field Documentation

◆ position

SkyPosition SpinOrbitCWParamStruc::position

The location of the source on the sky, normally in equatorial coordinates.

Definition at line 255 of file GenerateSpinOrbitCW.h.

◆ psi

REAL4 SpinOrbitCWParamStruc::psi

The polarization angle of the source, in radians.

Definition at line 256 of file GenerateSpinOrbitCW.h.

◆ epoch

LIGOTimeGPS SpinOrbitCWParamStruc::epoch

The start time of the output series.

Definition at line 261 of file GenerateSpinOrbitCW.h.

◆ spinEpoch

LIGOTimeGPS SpinOrbitCWParamStruc::spinEpoch

A reference time \( t_\mathrm{ref} \) (in the barycentric frame) at which the rotational properties of the source are specified.

Definition at line 262 of file GenerateSpinOrbitCW.h.

◆ orbitEpoch

LIGOTimeGPS SpinOrbitCWParamStruc::orbitEpoch

A time \( t_\mathrm{peri} \) (in the barycentric frame) at which the source passes through periapsis.

Note that this is the proper or "true" time of passage; the observed periapsis passage occurs at time \( t_\mathrm{peri}+r(t_\mathrm{peri})/c \)

Definition at line 263 of file GenerateSpinOrbitCW.h.

◆ deltaT

REAL8 SpinOrbitCWParamStruc::deltaT

The requested sampling interval of the waveform, in s.

Definition at line 266 of file GenerateSpinOrbitCW.h.

◆ length

UINT4 SpinOrbitCWParamStruc::length

The number of samples in the generated waveform.

Definition at line 267 of file GenerateSpinOrbitCW.h.

◆ aPlus

REAL4 SpinOrbitCWParamStruc::aPlus

Definition at line 268 of file GenerateSpinOrbitCW.h.

◆ aCross

REAL4 SpinOrbitCWParamStruc::aCross

The polarization amplitudes \( A_+ \) , \( A_\times \) , in dimensionless strain units.

Definition at line 268 of file GenerateSpinOrbitCW.h.

◆ phi0

REAL8 SpinOrbitCWParamStruc::phi0

The phase of the wave emitted at time \( t_\mathrm{ref} \) , in radians.

Definition at line 269 of file GenerateSpinOrbitCW.h.

◆ f0

REAL8 SpinOrbitCWParamStruc::f0

The frequency of the wave emitted at time \( t_\mathrm{ref} \) (and incorporating any Doppler shift due to \( \dot{R}_0 \) ), in Hz.

Definition at line 270 of file GenerateSpinOrbitCW.h.

◆ f

REAL8Vector* SpinOrbitCWParamStruc::f

The spin-normalized Taylor parameters \( f_k \) , as defined in Eq.

\eqref{eq_taylorcw-freq} of Header GenerateTaylorCW.h. If f=NULL, the (proper) spin of the source is assumed to be constant

Definition at line 271 of file GenerateSpinOrbitCW.h.

◆ omega

REAL8 SpinOrbitCWParamStruc::omega

The argument of the periapsis, \( \omega \) , in radians.

Definition at line 273 of file GenerateSpinOrbitCW.h.

◆ rPeriNorm

REAL8 SpinOrbitCWParamStruc::rPeriNorm

The projected, speed-of-light-normalized periapsis separation of the orbit, \( (r_p/c)\sin i \) , in s.

Definition at line 274 of file GenerateSpinOrbitCW.h.

◆ oneMinusEcc

REAL8 SpinOrbitCWParamStruc::oneMinusEcc

The value of \( 1-e \).

Definition at line 275 of file GenerateSpinOrbitCW.h.

◆ angularSpeed

REAL8 SpinOrbitCWParamStruc::angularSpeed

The angular speed at periapsis, \( \dot{\upsilon}_p \) , in Hz.

Definition at line 276 of file GenerateSpinOrbitCW.h.

◆ dfdt

REAL4 SpinOrbitCWParamStruc::dfdt

The maximum value of \( \Delta f\Delta t \) encountered over any timestep \( \Delta t \) used in generating the waveform.

Definition at line 281 of file GenerateSpinOrbitCW.h.