Module ComputeFstat_Demod.c

Detailed Description

Implements the Demod Dirichlet kernel-based demodulation algorithm for computing the \( \mathcal{F} \) -statistic [36] .

Prototypes
int	XLALSetupFstatDemod (void **method_data, FstatCommon *common, FstatMethodFuncs *funcs, MultiSFTVector *multiSFTs, const FstatOptionalArgs *optArgs)
int	XLALComputeFaFb_Generic (COMPLEX8 *Fa, COMPLEX8 *Fb, FstatAtomVector **FstatAtoms, const SFTVector *sfts, const PulsarSpins fkdot, const SSBtimes *tSSB, const AMCoeffs *amcoe, const UINT4 Dterms)
int	XLALComputeFaFb_OptC (COMPLEX8 *Fa, COMPLEX8 *Fb, FstatAtomVector **FstatAtoms, const SFTVector *sfts, const PulsarSpins fkdot, const SSBtimes *tSSB, const AMCoeffs *amcoe, const UINT4 Dterms)
int	XLALGetFstatTiming_Demod (const void *method_data, FstatTimingGeneric *timingGeneric, FstatTimingModel *timingModel)
void *	XLALFstatInputTimeslice_Demod (const void *method_data, const UINT4 iStart[PULSAR_MAX_DETECTORS], const UINT4 iEnd[PULSAR_MAX_DETECTORS])
void	XLALDestroyFstatInputTimeslice_Demod (void *method_data)
	Free all memory not needed by the orginal FstatInput structure. More...
static int	XLALComputeFstatDemod (FstatResults *Fstats, const FstatCommon *common, void *method_data)
static void	XLALDestroyDemodMethodData (void *method_data)

Data Structures
struct	FstatTimingDemod
struct	DemodMethodData

Files
file	ComputeFstat_DemodHL_Altivec.c
	Akos hotloop Altivec code (Dterms=8)
file	ComputeFstat_DemodHL_Generic.c
	Old (pre-Akos) LALDemod hotloop variant (unrestricted Dterms)
file	ComputeFstat_DemodHL_OptC.c
	Akos generic hotloop code (Dterms <= 20)
file	ComputeFstat_DemodHL_SSE.c
	Akos hotloop precalc SSE code (Dterms=8)

Variables
static const char	FstatTimingDemodHelp []

Function Documentation

XLALSetupFstatDemod()

int XLALSetupFstatDemod	(	void **	method_data,
		FstatCommon *	common,
		FstatMethodFuncs *	funcs,
		MultiSFTVector *	multiSFTs,
		const FstatOptionalArgs *	optArgs
	)

Definition at line 362 of file ComputeFstat_Demod.c.

XLALComputeFaFb_Generic()

int XLALComputeFaFb_Generic	(	COMPLEX8 *	Fa,
		COMPLEX8 *	Fb,
		FstatAtomVector **	FstatAtoms,
		const SFTVector *	sfts,
		const PulsarSpins	fkdot,
		const SSBtimes *	tSSB,
		const AMCoeffs *	amcoe,
		const UINT4	Dterms
	)

XLALComputeFaFb_OptC()

int XLALComputeFaFb_OptC	(	COMPLEX8 *	Fa,
		COMPLEX8 *	Fb,
		FstatAtomVector **	FstatAtoms,
		const SFTVector *	sfts,
		const PulsarSpins	fkdot,
		const SSBtimes *	tSSB,
		const AMCoeffs *	amcoe,
		const UINT4	Dterms
	)

XLALGetFstatTiming_Demod()

int XLALGetFstatTiming_Demod	(	const void *	method_data,
		FstatTimingGeneric *	timingGeneric,
		FstatTimingModel *	timingModel
	)

Definition at line 436 of file ComputeFstat_Demod.c.

XLALFstatInputTimeslice_Demod()

void* XLALFstatInputTimeslice_Demod	(	const void *	method_data,
		const UINT4	iStart[PULSAR_MAX_DETECTORS],
		const UINT4	iEnd[PULSAR_MAX_DETECTORS]
	)

Definition at line 472 of file ComputeFstat_Demod.c.

XLALDestroyFstatInputTimeslice_Demod()

void XLALDestroyFstatInputTimeslice_Demod

(

void *

method_data

)

Free all memory not needed by the orginal FstatInput structure.

Definition at line 530 of file ComputeFstat_Demod.c.

XLALComputeFstatDemod()

static int XLALComputeFstatDemod ( FstatResults *  Fstats, const FstatCommon *  common, void *  method_data  )

static

Definition at line 112 of file ComputeFstat_Demod.c.

XLALDestroyDemodMethodData()

static void XLALDestroyDemodMethodData ( void *  method_data )

static

Definition at line 349 of file ComputeFstat_Demod.c.

Variable Documentation

FstatTimingDemodHelp

const char FstatTimingDemodHelp[]

static

Initial value:

=
  "%%%% ----- Demod-specific F-statistic timing model -----\n"
  "%%%% Nsft:          (average) number of SFTs per detector\n"
  "%%%% tau0_coreLD:    timing coefficient for core Demod F-stat time\n"
  "%%%% tau0_bufferLD:  timing coefficient for computation of buffered quantities\n"
  "%%%%\n"
  "%%%% Demod F-statistic timing model:\n"
  "%%%% tauF_core      =  Nsft * tau0_coreLD\n"
  "%%%% tauF_buffer    =  Nsft * tau0_bufferLD / NFbin\n"
  "%%%%"
  ""

Definition at line 54 of file ComputeFstat_Demod.c.