Detailed Description

Struct of optional 'advanced level' and (potentially method-specific) arguments to be passed to the \( \mathcal{F} \) -statistic setup function XLALCreateFstatInput().

Definition at line 136 of file ComputeFstat.h.

Data Fields
UINT4	randSeed
	Random-number seed value used in case of fake Gaussian noise generation (`injectSqrtSX`) More...

SSBprecision	SSBprec
	Barycentric transformation precision. More...

UINT4	Dterms
	Number of Dirichlet kernel terms, used by some Demod methods; see `FstatMethodType`. More...

UINT4	runningMedianWindow
	If SFT noise weights are calculated from the SFTs, the running median window length to use. More...

FstatMethodType	FstatMethod
	Method to use for computing the \( \mathcal{F} \) -statistic. More...

PulsarParamsVector *	injectSources
	Vector of parameters of CW signals to simulate and inject. More...

MultiNoiseFloor *	injectSqrtSX
	Single-sided PSD values for fake Gaussian noise to be added to SFT data. More...

MultiNoiseFloor *	assumeSqrtSX
	Single-sided PSD values to be used for computing SFT noise weights instead of from a running median of the SFTs themselves. More...

FstatInput *	prevInput
	An `FstatInput` structure from a previous call to XLALCreateFstatInput(); may contain common workspace data than can be re-used to save memory. More...

BOOLEAN	collectTiming
	a flag to turn on/off the collection of F-stat-method-specific timing-data More...

BOOLEAN	resampFFTPowerOf2
	Resamp: round up FFT lengths to next power of 2; see `FstatMethodType`. More...

REAL8	allowedMismatchFromSFTLength
	Optional override for XLALFstatCheckSFTLengthMismatch(). More...

REAL8	sourceDeltaT
	Optional source-frame sampling period for XLALCWMakeFakeData(); if zero, use the previous internal defaults. More...

Field Documentation

◆ randSeed

UINT4 FstatOptionalArgs::randSeed

Random-number seed value used in case of fake Gaussian noise generation (injectSqrtSX)

Definition at line 137 of file ComputeFstat.h.

◆ SSBprec

SSBprecision FstatOptionalArgs::SSBprec

Barycentric transformation precision.

Definition at line 138 of file ComputeFstat.h.

◆ Dterms

UINT4 FstatOptionalArgs::Dterms

Number of Dirichlet kernel terms, used by some Demod methods; see FstatMethodType.

Definition at line 139 of file ComputeFstat.h.

◆ runningMedianWindow

UINT4 FstatOptionalArgs::runningMedianWindow

If SFT noise weights are calculated from the SFTs, the running median window length to use.

Definition at line 140 of file ComputeFstat.h.

◆ FstatMethod

FstatMethodType FstatOptionalArgs::FstatMethod

Method to use for computing the \( \mathcal{F} \) -statistic.

Definition at line 141 of file ComputeFstat.h.

◆ injectSources

PulsarParamsVector* FstatOptionalArgs::injectSources

Vector of parameters of CW signals to simulate and inject.

Definition at line 142 of file ComputeFstat.h.

◆ injectSqrtSX

MultiNoiseFloor* FstatOptionalArgs::injectSqrtSX

Single-sided PSD values for fake Gaussian noise to be added to SFT data.

Definition at line 143 of file ComputeFstat.h.

◆ assumeSqrtSX

MultiNoiseFloor* FstatOptionalArgs::assumeSqrtSX

Single-sided PSD values to be used for computing SFT noise weights instead of from a running median of the SFTs themselves.

Definition at line 144 of file ComputeFstat.h.

◆ prevInput

FstatInput* FstatOptionalArgs::prevInput

An FstatInput structure from a previous call to XLALCreateFstatInput(); may contain common workspace data than can be re-used to save memory.

Definition at line 145 of file ComputeFstat.h.

◆ collectTiming

BOOLEAN FstatOptionalArgs::collectTiming

a flag to turn on/off the collection of F-stat-method-specific timing-data

Definition at line 146 of file ComputeFstat.h.

◆ resampFFTPowerOf2

BOOLEAN FstatOptionalArgs::resampFFTPowerOf2

Resamp: round up FFT lengths to next power of 2; see FstatMethodType.

Definition at line 147 of file ComputeFstat.h.

◆ allowedMismatchFromSFTLength

REAL8 FstatOptionalArgs::allowedMismatchFromSFTLength

Optional override for XLALFstatCheckSFTLengthMismatch().

Definition at line 148 of file ComputeFstat.h.

◆ sourceDeltaT

REAL8 FstatOptionalArgs::sourceDeltaT

Optional source-frame sampling period for XLALCWMakeFakeData(); if zero, use the previous internal defaults.

Definition at line 149 of file ComputeFstat.h.