DopplerFullScan.h File Reference

Header file defining the API for DopplerFullScan. More...

Prototypes
DopplerFullScanState *	XLALInitDopplerFullScan (const DopplerFullScanInit *init)
	Set up a full multi-dimensional grid-scan. More...
int	XLALNextDopplerPos (PulsarDopplerParams *pos, DopplerFullScanState *scan)
	Function to step through the full template grid point by point. More...
REAL8	XLALNumDopplerTemplates (DopplerFullScanState *scan)
	Return (and compute if not done so yet) the total number of Doppler templates of the DopplerScan scan. More...
int	XLALGetDopplerSpinRange (PulsarSpinRange *spinRange, const DopplerFullScanState *scan)
	Return the spin-range spanned by the given template bank stored in the opaque DopplerFullScanState. More...
void	XLALDestroyDopplerFullScan (DopplerFullScanState *scan)
	Destroy the a full DopplerFullScanState structure. More...
int	XLALSetLatticeTilingF1DotAgeBrakingBound (LatticeTiling *tiling, const size_t freq_dimension, const size_t f1dot_dimension, const double age, const double min_braking, const double max_braking)
	Set a first spindown bound derived from spindown age and braking indices. More...
int	XLALSetLatticeTilingF2DotBrakingBound (LatticeTiling *tiling, const size_t freq_dimension, const size_t f1dot_dimension, const size_t f2dot_dimension, const double min_braking, const double max_braking)
	Set a second spindown bound derived from braking indices. More...
void	InitDopplerFullScan (LALStatus *, DopplerFullScanState **scanState, const DopplerFullScanInit *init)

Detailed Description

Header file defining the API for DopplerFullScan.

Author

Reinhard Prix, Karl Wette

Date

2006

Definition in file DopplerFullScan.h.

Go to the source code of this file.

Data Structures
struct	DopplerFullScanInit
	Structure describing a region in paramter-space (a,d,f,f1dot,..). More...

Function Documentation

XLALInitDopplerFullScan()

DopplerFullScanState* XLALInitDopplerFullScan

(

const DopplerFullScanInit *

init

)

Set up a full multi-dimensional grid-scan.

Currently this only emulates a 'factored' grid-scan with 'sky x Freq x f1dot ...' , but keeps all details within the DopplerScan module for future extension to real multidimensional grids.

NOTE: Use 'XLALNextDopplerPos()' to step through this template grid.

Parameters

[in]

init

initialization parameters

Definition at line 106 of file DopplerFullScan.c.

XLALNextDopplerPos()

int XLALNextDopplerPos	(	PulsarDopplerParams *	pos,
		DopplerFullScanState *	scan
	)

Function to step through the full template grid point by point.

Normal return = 0, errors return -1, end of scan is signalled by return = 1

Definition at line 417 of file DopplerFullScan.c.

XLALNumDopplerTemplates()

REAL8 XLALNumDopplerTemplates

(

DopplerFullScanState *

scan

)

Return (and compute if not done so yet) the total number of Doppler templates of the DopplerScan scan.

Definition at line 381 of file DopplerFullScan.c.

XLALGetDopplerSpinRange()

int XLALGetDopplerSpinRange	(	PulsarSpinRange *	spinRange,
		const DopplerFullScanState *	scan
	)

Return the spin-range spanned by the given template bank stored in the opaque DopplerFullScanState.

Note

The user cannot directly access any internal fields of that opaque type, which is why we need this API.

Definition at line 281 of file DopplerFullScan.c.

XLALDestroyDopplerFullScan()

void XLALDestroyDopplerFullScan

(

DopplerFullScanState *

scan

)

Destroy the a full DopplerFullScanState structure.

Definition at line 636 of file DopplerFullScan.c.

XLALSetLatticeTilingF1DotAgeBrakingBound()

int XLALSetLatticeTilingF1DotAgeBrakingBound	(	LatticeTiling *	tiling,
		const size_t	freq_dimension,
		const size_t	f1dot_dimension,
		const double	age,
		const double	min_braking,
		const double	max_braking
	)

Set a first spindown bound derived from spindown age and braking indices.

Parameters

[in]	tiling	Lattice tiling
[in]	freq_dimension	Frequency dimension
[in]	f1dot_dimension	First spindown dimension
[in]	age	Spindown age
[in]	min_braking	Minimum braking index
[in]	max_braking	Maximum braking index

Definition at line 897 of file DopplerFullScan.c.

XLALSetLatticeTilingF2DotBrakingBound()

int XLALSetLatticeTilingF2DotBrakingBound	(	LatticeTiling *	tiling,
		const size_t	freq_dimension,
		const size_t	f1dot_dimension,
		const size_t	f2dot_dimension,
		const double	min_braking,
		const double	max_braking
	)

Set a second spindown bound derived from braking indices.

Parameters

[in]	tiling	Lattice tiling
[in]	freq_dimension	Frequency dimension
[in]	f1dot_dimension	First spindown dimension
[in]	f2dot_dimension	Second spindown dimension
[in]	min_braking	Minimum braking index
[in]	max_braking	Maximum braking index

Definition at line 953 of file DopplerFullScan.c.

InitDopplerFullScan()

void InitDopplerFullScan	(	LALStatus *	status,
		DopplerFullScanState **	scan,
		const DopplerFullScanInit *	init
	)

Deprecated:

Use XLALInitDopplerFullScan() instead.

Parameters

	status	pointer to LALStatus structure
[out]	scan	initialized Doppler scan state
[in]	init	initialization parameters

Definition at line 252 of file DopplerFullScan.c.