XLALComputeFstat() computed results structure.
Definition at line 201 of file ComputeFstat.h.
Data Fields | |
PulsarDopplerParams | doppler |
Doppler parameters, including the starting frequency, at which the \( 2\mathcal{F} \) were computed. More... | |
LIGOTimeGPS | refTimePhase |
For performance reasons the global phase of all returned 'Fa' and 'Fb' quantities (Fa,Fb,FaPerDet,FbPerDet, multiFatoms), refers to this 'phase reference time' instead of the (doppler).refTime. More... | |
REAL8 | dFreq |
Spacing in frequency between each computed \( \mathcal{F} \) -statistic. More... | |
UINT4 | numFreqBins |
Number of frequencies at which the \( 2\mathcal{F} \) were computed. More... | |
UINT4 | numDetectors |
Number of detectors over which the \( 2\mathcal{F} \) were computed. More... | |
CHAR | detectorNames [PULSAR_MAX_DETECTORS][3] |
Names of detectors over which the \( 2\mathcal{F} \) were computed. More... | |
AntennaPatternMatrix | Mmunu |
Antenna pattern matrix \( M_{\mu\nu} \) , used in computing \( 2\mathcal{F} \) . More... | |
AntennaPatternMatrix | MmunuX [PULSAR_MAX_DETECTORS] |
Per detector antenna pattern matrix \( M_{\mu\nu}^X \) , used in computing \( 2\mathcal{F}^X \) . More... | |
FstatQuantities | whatWasComputed |
Bit-field of which \( \mathcal{F} \) -statistic quantities were computed. More... | |
REAL4 * | twoF |
If whatWasComputed & FSTATQ_2F is true, the multi-detector \( 2\mathcal{F} \) values computed at numFreqBins frequencies spaced dFreq apart. More... | |
REAL4 * | twoF_CUDA |
If whatWasComputed & FSTATQ_2F_CUDA is true, the multi-detector \( 2\mathcal{F} \) values as for twoF, but stored in CUDA device memory. More... | |
COMPLEX8 * | Fa |
If whatWasComputed & FSTATQ_PARTS is true, the multi-detector \( F_a \) and \( F_b \) computed at numFreqBins frequencies spaced dFreq apart. More... | |
COMPLEX8 * | Fb |
REAL4 * | twoFPerDet [PULSAR_MAX_DETECTORS] |
If whatWasComputed & FSTATQ_2F_PER_DET is true, the \( 2\mathcal{F} \) values computed at numFreqBins frequencies spaced dFreq apart, and for numDetectors detectors. More... | |
COMPLEX8 * | FaPerDet [PULSAR_MAX_DETECTORS] |
If whatWasComputed & FSTATQ_PARTS_PER_DET is true, the \( F_a \) and \( F_b \) values computed at numFreqBins frequencies spaced dFreq apart, and for numDetectors detectors. More... | |
COMPLEX8 * | FbPerDet [PULSAR_MAX_DETECTORS] |
MultiFstatAtomVector ** | multiFatoms |
If whatWasComputed & FSTATQ_ATOMS_PER_DET is true, the per-SFT \( \mathcal{F} \) -statistic multi-atoms computed at numFreqBins frequencies spaced dFreq apart. More... | |
PulsarDopplerParams FstatResults::doppler |
Doppler parameters, including the starting frequency, at which the \( 2\mathcal{F} \) were computed.
Definition at line 205 of file ComputeFstat.h.
LIGOTimeGPS FstatResults::refTimePhase |
For performance reasons the global phase of all returned 'Fa' and 'Fb' quantities (Fa,Fb,FaPerDet,FbPerDet, multiFatoms), refers to this 'phase reference time' instead of the (doppler).refTime.
Use this to compute initial phase of signals at doppler.refTime, or if you need the correct global Fa,Fb-phase!
Definition at line 210 of file ComputeFstat.h.
REAL8 FstatResults::dFreq |
Spacing in frequency between each computed \( \mathcal{F} \) -statistic.
Definition at line 213 of file ComputeFstat.h.
UINT4 FstatResults::numFreqBins |
Number of frequencies at which the \( 2\mathcal{F} \) were computed.
Definition at line 216 of file ComputeFstat.h.
UINT4 FstatResults::numDetectors |
Number of detectors over which the \( 2\mathcal{F} \) were computed.
Valid range is 1 to PULSAR_MAX_DETECTORS.
Definition at line 220 of file ComputeFstat.h.
CHAR FstatResults::detectorNames[PULSAR_MAX_DETECTORS][3] |
Names of detectors over which the \( 2\mathcal{F} \) were computed.
Valid range is 1 to PULSAR_MAX_DETECTORS.
Definition at line 224 of file ComputeFstat.h.
AntennaPatternMatrix FstatResults::Mmunu |
Antenna pattern matrix \( M_{\mu\nu} \) , used in computing \( 2\mathcal{F} \) .
Definition at line 227 of file ComputeFstat.h.
AntennaPatternMatrix FstatResults::MmunuX[PULSAR_MAX_DETECTORS] |
Per detector antenna pattern matrix \( M_{\mu\nu}^X \) , used in computing \( 2\mathcal{F}^X \) .
Definition at line 230 of file ComputeFstat.h.
FstatQuantities FstatResults::whatWasComputed |
Bit-field of which \( \mathcal{F} \) -statistic quantities were computed.
Definition at line 233 of file ComputeFstat.h.
REAL4* FstatResults::twoF |
If whatWasComputed & FSTATQ_2F is true, the multi-detector \( 2\mathcal{F} \) values computed at numFreqBins frequencies spaced dFreq apart.
This array should not be accessed if whatWasComputed & FSTATQ_2F is false.
Definition at line 241 of file ComputeFstat.h.
REAL4* FstatResults::twoF_CUDA |
If whatWasComputed & FSTATQ_2F_CUDA is true, the multi-detector \( 2\mathcal{F} \) values as for twoF, but stored in CUDA device memory.
This array should not be accessed if whatWasComputed & FSTATQ_2F_CUDA is false.
Definition at line 247 of file ComputeFstat.h.
COMPLEX8* FstatResults::Fa |
If whatWasComputed & FSTATQ_PARTS is true, the multi-detector \( F_a \) and \( F_b \) computed at numFreqBins frequencies spaced dFreq apart.
This array should not be accessed if whatWasComputed & FSTATQ_PARTS is false.
Definition at line 258 of file ComputeFstat.h.
COMPLEX8* FstatResults::Fb |
Definition at line 259 of file ComputeFstat.h.
REAL4* FstatResults::twoFPerDet[PULSAR_MAX_DETECTORS] |
If whatWasComputed & FSTATQ_2F_PER_DET is true, the \( 2\mathcal{F} \) values computed at numFreqBins frequencies spaced dFreq apart, and for numDetectors detectors.
Only the first numDetectors entries will be valid. This array should not be accessed if whatWasComputed & FSTATQ_2F_PER_DET is false.
Definition at line 268 of file ComputeFstat.h.
COMPLEX8* FstatResults::FaPerDet[PULSAR_MAX_DETECTORS] |
If whatWasComputed & FSTATQ_PARTS_PER_DET is true, the \( F_a \) and \( F_b \) values computed at numFreqBins frequencies spaced dFreq apart, and for numDetectors detectors.
This array should not be accessed if whatWasComputed & FSTATQ_PARTS_PER_DET is false.
Definition at line 278 of file ComputeFstat.h.
COMPLEX8* FstatResults::FbPerDet[PULSAR_MAX_DETECTORS] |
Definition at line 279 of file ComputeFstat.h.
MultiFstatAtomVector** FstatResults::multiFatoms |
If whatWasComputed & FSTATQ_ATOMS_PER_DET is true, the per-SFT \( \mathcal{F} \) -statistic multi-atoms computed at numFreqBins frequencies spaced dFreq apart.
This array should not be accessed if whatWasComputed & FSTATQ_ATOMS_PER_DET is false.
Definition at line 288 of file ComputeFstat.h.