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) |
Go to the source code of this file.
Data Structures | |
struct | DopplerFullScanInit |
Structure describing a region in paramter-space (a,d,f,f1dot,..). More... | |
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.
[in] | init | initialization parameters |
Definition at line 106 of file DopplerFullScan.c.
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.
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.
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.
int XLALGetDopplerSpinRange | ( | PulsarSpinRange * | spinRange, |
const DopplerFullScanState * | scan | ||
) |
Return the spin-range spanned by the given template bank stored in the opaque DopplerFullScanState.
Definition at line 281 of file DopplerFullScan.c.
void XLALDestroyDopplerFullScan | ( | DopplerFullScanState * | scan | ) |
Destroy the a full DopplerFullScanState structure.
Definition at line 665 of file DopplerFullScan.c.
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.
[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 928 of file DopplerFullScan.c.
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.
[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 984 of file DopplerFullScan.c.
Return the step size of the spindown lattice tiling in a given dimension, or 0 for non-tiled dimensions.
[in] | scan | Doppler scan state object |
[in] | dim | Dimension of which to return step size |
Definition at line 1015 of file DopplerFullScan.c.
void InitDopplerFullScan | ( | LALStatus * | status, |
DopplerFullScanState ** | scan, | ||
const DopplerFullScanInit * | init | ||
) |
status | pointer to LALStatus structure | |
[out] | scan | initialized Doppler scan state |
[in] | init | initialization parameters |
Definition at line 252 of file DopplerFullScan.c.