ComputeFstat.h File Reference

Prototypes
REAL8	XLALFstatMaximumSFTLength (const REAL8 maxFreq, const REAL8 binaryMaxAsini, const REAL8 binaryMinPeriod, const REAL8 mu_SFT)
	Compute the maximum SFT length that can safely be used as input to XLALComputeFstat(), given the desired range limits in search parameters. More...
int	XLALFstatCheckSFTLengthMismatch (const REAL8 Tsft, const REAL8 maxFreq, const REAL8 binaryMaxAsini, const REAL8 binaryMinPeriod, const REAL8 allowedMismatch)
	Check that the SFT length \( T_{\textrm{SFT}} \) does not exceed the result of XLALFstatMaximumSFTLength(), in which case a large unexpected mismatch would be produced. More...
int	XLALFstatMethodIsAvailable (FstatMethodType method)
	Return true if given FstatMethodType corresponds to a valid and available Fstat method, false otherwise. More...
const CHAR *	XLALFstatMethodName (FstatMethodType method)
	Return pointer to a static string giving the name of the FstatMethodType method. More...
const UserChoices *	XLALFstatMethodChoices (void)
	Return pointer to a static array of all (available) FstatMethodType choices. More...
FstatInputVector *	XLALCreateFstatInputVector (const UINT4 length)
	Create a FstatInputVector of the given length, for example for setting up F-stat searches over several segments. More...
void	XLALDestroyFstatInputVector (FstatInputVector *inputs)
	Free all memory associated with a FstatInputVector structure. More...
FstatAtomVector *	XLALCreateFstatAtomVector (const UINT4 length)
	Create a FstatAtomVector of the given length. More...
void	XLALDestroyFstatAtomVector (FstatAtomVector *atoms)
	Free all memory associated with a FstatAtomVector structure. More...
MultiFstatAtomVector *	XLALCreateMultiFstatAtomVector (const UINT4 length)
	Create a MultiFstatAtomVector of the given length. More...
void	XLALDestroyMultiFstatAtomVector (MultiFstatAtomVector *multiAtoms)
	Free all memory associated with a MultiFstatAtomVector structure. More...
FstatInput *	XLALCreateFstatInput (const SFTCatalog *SFTcatalog, const REAL8 minCoverFreq, const REAL8 maxCoverFreq, const REAL8 dFreq, const EphemerisData *ephemerides, const FstatOptionalArgs *optionalArgs)
	Create a fully-setup FstatInput structure for computing the \( \mathcal{F} \) -statistic using XLALComputeFstat(). More...
int	XLALGetFstatInputSFTBand (const FstatInput *input, REAL8 *minFreqFull, REAL8 *maxFreqFull)
	Returns the frequency band loaded from input SFTs. More...
const CHAR *	XLALGetFstatInputMethodName (const FstatInput *input)
	Returns the human-readable name of the \( \mathcal{F} \) -statistic method being used by a FstatInput structure. More...
const MultiLALDetector *	XLALGetFstatInputDetectors (const FstatInput *input)
	Returns the detector information stored in a FstatInput structure. More...
const MultiLIGOTimeGPSVector *	XLALGetFstatInputTimestamps (const FstatInput *input)
	Returns the SFT timestamps stored in a FstatInput structure. More...
MultiNoiseWeights *	XLALGetFstatInputNoiseWeights (const FstatInput *input)
	Returns the multi-detector noise weights stored in a FstatInput structure. More...
const MultiDetectorStateSeries *	XLALGetFstatInputDetectorStates (const FstatInput *input)
	Returns the multi-detector state series stored in a FstatInput structure. More...
int	XLALExtractResampledTimeseries (MultiCOMPLEX8TimeSeries **multiTimeSeries_SRC_a, MultiCOMPLEX8TimeSeries **multiTimeSeries_SRC_b, FstatInput *input)
	Extracts the resampled timeseries from a given FstatInput structure (must have been initialized previously by XLALCreateFstatInput() and a call to XLALComputeFstat()). More...
int	XLALGetFstatTiming (const FstatInput *input, FstatTimingGeneric *timingGeneric, FstatTimingModel *timingModel)
	Return measured values and details about generic F-statistic timing and method-specific timing model,. More...
int	XLALAppendFstatTiming2File (const FstatInput *input, FILE *fp, BOOLEAN printHeader)
int	XLALFstatInputTimeslice (FstatInput **slice, const FstatInput *input, const LIGOTimeGPS *minStartGPS, const LIGOTimeGPS *maxStartGPS)
	Create and return an FstatInput 'timeslice' for given input FstatInput object [must be using LALDemod Fstat method!] which covers only the time interval ['minStartGPS','maxStartGPS'), using conventions of XLALCWGPSinRange(). More...
int	XLALComputeFstat (FstatResults **Fstats, FstatInput *input, const PulsarDopplerParams *doppler, const UINT4 numFreqBins, const FstatQuantities whatToCompute)
	Compute the \( \mathcal{F} \) -statistic over a band of frequencies. More...
void	XLALDestroyFstatInput (FstatInput *input)
	Free all memory associated with a FstatInput structure. More...
void	XLALDestroyFstatResults (FstatResults *Fstats)
	Free all memory associated with a FstatResults structure. More...
REAL4	XLALComputeFstatFromFaFb (COMPLEX8 Fa, COMPLEX8 Fb, REAL4 A, REAL4 B, REAL4 C, REAL4 E, REAL4 Dinv)
	Compute the \( \mathcal{F} \) -statistic from the complex \( F_a \) and \( F_b \) components and the antenna pattern matrix. More...
REAL4	XLALComputeFstatFromAtoms (const MultiFstatAtomVector *multiFstatAtoms, const INT4 X)
	Compute single-or multi-IFO Fstat '2F' from multi-IFO 'atoms'. More...

Go to the source code of this file.

Data Structures
struct	FstatInputVector
	A vector of XLALComputeFstat() input data structures, for e.g. More...
struct	FstatOptionalArgs
	Struct of optional 'advanced level' and (potentially method-specific) arguments to be passed to the \( \mathcal{F} \) -statistic setup function XLALCreateFstatInput(). More...
struct	FstatAtom
	An \( \mathcal{F} \) -statistic 'atom', i.e. More...
struct	FstatAtomVector
	A vector of \( \mathcal{F} \) -statistic 'atoms', i.e. More...
struct	MultiFstatAtomVector
	A multi-detector vector of FstatAtomVector. More...
struct	FstatResults
	XLALComputeFstat() computed results structure. More...
struct	FstatTimingGeneric
	Generic F-stat timing coefficients (times in seconds) [see https://dcc.ligo.org/LIGO-T1600531-v4 for details] tauF_eff = tauF_core + b * tauF_buffer where 'b' denotes the fraction of times per call to XLALComputeFstat() the buffer needed to be recomputed ==> b = NBufferMisses / NCalls ". More...
struct	FstatTimingModel
	Struct to carry the \( \mathcal{F} \) -statistic method-specific timing model in terms of a list of variable names and corresponding REAL4 values, including a help-string documenting the timing model variables. More...

Macros
#define	DEFAULT_MAX_MISMATCH_FROM_SFT_LENGTH   0.05
	default maximum allowed F-stat mismatch from SFTs being too long, to be used in XLALFstatCheckSFTLengthMismatch() More...
#define	TIMING_MODEL_MAX_VARS   10

Enumerations
enum	FstatQuantities {   FSTATQ_NONE = 0x00 , FSTATQ_2F = 0x01 , FSTATQ_FAFB = 0x02 , FSTATQ_2F_PER_DET = 0x04 ,   FSTATQ_FAFB_PER_DET = 0x08 , FSTATQ_ATOMS_PER_DET = 0x10 , FSTATQ_2F_CUDA = 0x20 , FSTATQ_LAST = 0x80 }
	Bit-field of \( \mathcal{F} \) -statistic quantities which can be computed by XLALComputeFstat(). More...
enum	FstatMethodType {   FMETHOD_DEMOD_GENERIC , FMETHOD_DEMOD_OPTC , FMETHOD_DEMOD_ALTIVEC , FMETHOD_DEMOD_SSE ,   FMETHOD_DEMOD_BEST , FMETHOD_RESAMP_GENERIC , FMETHOD_RESAMP_CUDA , FMETHOD_RESAMP_BEST }
	Different methods available to compute the \( \mathcal{F} \) -statistic, falling into two broad classes: More...

Variables
const FstatOptionalArgs	FstatOptionalArgsDefaults
	Global initializer for setting FstatOptionalArgs to default values. More...