Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-6c6b863
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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...
 
UINT8 XLALNumDopplerPointsAtDimension (DopplerFullScanState *scan, const size_t dim)
 Compute and return the total number of frequency and spindown points up to and along a certain dimension dim 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...
 
REAL8 XLALGetDopplerLatticeTilingStepSize (DopplerFullScanState *scan, const size_t dim)
 Return the step size of the spindown lattice tiling in a given dimension, or 0 for non-tiled dimensions. 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]initinitialization 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 446 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.

◆ XLALNumDopplerPointsAtDimension()

UINT8 XLALNumDopplerPointsAtDimension ( DopplerFullScanState *  scan,
const size_t  dim 
)

Compute and return the total number of frequency and spindown points up to and along a certain dimension dim of the DopplerScan scan.

Definition at line 416 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 665 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]tilingLattice tiling
[in]freq_dimensionFrequency dimension
[in]f1dot_dimensionFirst spindown dimension
[in]ageSpindown age
[in]min_brakingMinimum braking index
[in]max_brakingMaximum braking index

Definition at line 928 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]tilingLattice tiling
[in]freq_dimensionFrequency dimension
[in]f1dot_dimensionFirst spindown dimension
[in]f2dot_dimensionSecond spindown dimension
[in]min_brakingMinimum braking index
[in]max_brakingMaximum braking index

Definition at line 984 of file DopplerFullScan.c.

◆ XLALGetDopplerLatticeTilingStepSize()

REAL8 XLALGetDopplerLatticeTilingStepSize ( DopplerFullScanState *  scan,
const size_t  dim 
)

Return the step size of the spindown lattice tiling in a given dimension, or 0 for non-tiled dimensions.

Parameters
[in]scanDoppler scan state object
[in]dimDimension of which to return step size

Definition at line 1015 of file DopplerFullScan.c.

◆ InitDopplerFullScan()

void InitDopplerFullScan ( LALStatus status,
DopplerFullScanState **  scan,
const DopplerFullScanInit init 
)
Deprecated:
Use XLALInitDopplerFullScan() instead.
Parameters
statuspointer to LALStatus structure
[out]scaninitialized Doppler scan state
[in]initinitialization parameters

Definition at line 252 of file DopplerFullScan.c.