Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-5e288d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
ConfigVariables Struct Reference

Detailed Description

Configuration settings required for and defining a coherent pulsar search.

These are 'pre-processed' settings, which have been derived from the user-input.

Definition at line 137 of file pulsar_crosscorr_v2.c.

Data Fields

SFTCatalogcatalog
 catalog of SFTs More...
 
EphemerisDataedat
 ephemeris data More...
 
LALStringVectorlineFiles
 list of line files More...
 
REAL8 refTime
 reference time for pulsar phase definition More...
 
REAL8 orbitPSecMin
 minimum binary orbital period in seconds More...
 
REAL8 orbitPSecMax
 maximum binary orbital period in seconds More...
 
BOOLEAN useTPEllipse
 whether to use elliptical boundary for Tasc-Porb search space More...
 
int norb
 number of orbits to shift prior elliptical boundary for Tasc-Porb search space More...
 
REAL8 orbitTimeAscCenterShifted
 shifted center of prior ellipse for binary time of ascension (GPS seconds) More...
 
REAL8 dPorbdTascShear
 slope of centerline of prior ellipse More...
 
REAL8 unshearedgTT
 metric element gTT in unsheared coordinates More...
 
REAL8 unshearedgTP
 metric element gTP in unsheared coordinates More...
 
REAL8 mismatchMaxP
 maximum mismatch in porb More...
 
REAL8 mismatchMaxThreeD
 mismatch used for 3d lattice More...
 
LIGOTimeGPS startTime
 starting timestamp of SFTs More...
 
REAL8 Tspan
 time spanned by all SFTs More...
 
REAL8 Alpha
 sky position alpha in radians More...
 
REAL8 Delta
 sky position delta in radians More...
 
REAL8 Tsft
 length of one SFT in seconds More...
 
DopplerRegion searchRegion
 parameter-space region to search over More...
 
DopplerFullScanState * scanState
 current state of the Doppler-scan More...
 
PulsarDopplerParams stepSizes
 user-preferences on Doppler-param step-sizes More...
 
EphemerisDataephemeris
 ephemeris data (from XLALInitBarycenter()) More...
 
UINT4 NSFTs
 total number of all SFTs used More...
 
UINT4VectornumSFTsPerDet
 number of SFTs per detector, for log strings, etc. More...
 
LALStringVectordetectorIDs
 detector ID names, for column headings string More...
 
FstatInput * Fstat_in
 Fstat input data struct. More...
 
FstatQuantities Fstat_what
 Fstat quantities to compute. More...
 
toplist_tFstatToplist
 sorted 'toplist' of the NumCandidatesToKeep loudest candidates More...
 
scanlineWindow_tscanlineWindow
 moving window of candidates on scanline to find local maxima More...
 
CHARVCSInfoString
 Git version string. More...
 
CHARlogstring
 log containing max-info on the whole search setup More...
 
transientWindowRange_t transientWindowRange
 search range parameters for transient window More...
 
BSGLSetup * BSGLsetup
 pre-computed setup for line-robust statistic More...
 
RankingStat_t RankingStatistic
 rank candidates according to F or BSGL More...
 
BOOLEAN useResamp
 
UINT4 numFreqBins_FBand
 
REAL8 dFreq
 
PulsarParamsVectorinjectionSources
 Source parameters to inject: comma-separated list of file-patterns and/or direct config-strings ('{...}') More...
 
MultiLIGOTimeGPSVectormultiTimestamps
 a vector of timestamps (only set if provided from dedicated time stamp files) More...
 
MultiLALDetector multiIFO
 detectors to generate data for (if provided by user and not via noise files) More...
 
BOOLEAN runSearch
 whether to actually perform the search, or just generate a grid and/or count templates More...
 
CHARdataSummary
 descriptive string describing the data More...
 
PulsarAmplitudeParams pap
 PulsarAmplitudeParameter {h0, cosi, psi, phi0}. More...
 
AntennaPatternMatrix Mmunu
 antenna-pattern matrix and normalization More...
 
UINT4 numSFTs
 number of SFTs = Tobs/Tsft More...
 
gsl_matrix * M_mu_nu
 antenna-pattern matrix and normalization More...
 
AmpParamsRange_t AmpRange
 signal amplitude-parameter ranges: lower bounds + bands More...
 
gsl_rng * rng
 gsl random-number generator More...
 
AmplitudePrior_t AmpPrior
 amplitude-parameter priors to draw signals from More...
 
SkyPosition skypos
 (Alpha,Delta,system). More...
 
BOOLEAN SignalOnly
 dont generate noise-draws: will result in non-random 'signal only' values of F and B More...
 
transientWindowRange_t transientSearchRange
 transient-window range for the search (flat priors) More...
 
transientWindowRange_t transientInjectRange
 transient-window range for injections (flat priors) More...
 
MultiDetectorStateSeriesmultiDetStates
 multi-detector state series covering observation time More...
 
CHARlogString
 logstring for file-output, containing cmdline-options + code VCS version info More...
 
REAL4oLGX
 per-detector line prior odds More...
 
MultiNoiseWeightsmultiNoiseWeights
 per-detector noise weights SX^-1/S^-1, no per-SFT variation (can be NULL for unit weights) More...
 
UINT4 numDetectors
 number of detectors More...
 
UINT4 numTimeStamps
 number of timestamps (SFTs) for all detectors More...
 
UINT4VectornumTimeStampsX
 number of timestamps (SFTs) per detector More...
 
REAL8VectorAlpha
 skyposition Alpha: radians, equatorial coords More...
 
REAL8VectorDelta
 skyposition Delta: radians, equatorial coords More...
 
UINT4 numSkyPoints
 common length of Alpha and Delta vectors More...
 
LALSegList segmentList
 segment list contains start- and end-times of all segments More...
 
PulsarParams signalParams
 GW signal parameters: Amplitudes + doppler. More...
 
MultiNoiseFloor multiNoiseFloor
 ... and corresponding noise-floors to be used as weights More...
 
DopplerCoordinateSystem coordSys
 array of enums describing Doppler-coordinates to compute metric in More...
 
ResultHistory_thistory
 history trail leading up to and including this application More...
 
LIGOTimeGPS timeGPS
 GPS time to compute detector state for (LIGOtimeGPS format) More...
 
const LALDetectordet
 LIGODetector struct holding detector info. More...
 
LIGOTimeGPSVectortimestamps
 timestamps vector holding 1 element: timeGPS More...
 
REAL8 sinzeta
 detector-arm angle correction (needed for GEO) More...
 
const EphemerisDataedat
 ephemeris data (from XLALInitBarycenter()) More...
 
LIGOTimeGPS refTime
 reference time for spin-parameters
More...
 
DopplerPoint dopplerPoint
 sky-position and spins More...
 
MultiAMCoeffsmultiAMcoe
 Amplitude Modulation coefficients a,b(t) More...
 
MultiPhaseDerivsmultidPhi
 Phase-derivatives d_i phi(t) More...
 
REAL8VectorGLweights
 Gauss-Legendre Integration-weights. More...
 
REAL8 Al1
 
REAL8 Al2
 
REAL8 Al3
 amplitude factors alpha1, alpha2, alpha3 More...
 
REAL8 Ad
 
REAL8 Bd
 
REAL8 Cd
 
REAL8 Dd
 
PhaseType_t phaseType
 

Field Documentation

◆ catalog

SFTCatalog* ConfigVariables::catalog

catalog of SFTs

Definition at line 138 of file pulsar_crosscorr_v2.c.

◆ edat [1/2]

EphemerisData * ConfigVariables::edat

ephemeris data

ephemeris data (from XLALInitBarycenter())

Definition at line 139 of file pulsar_crosscorr_v2.c.

◆ lineFiles

LALStringVector* ConfigVariables::lineFiles

list of line files

Definition at line 140 of file pulsar_crosscorr_v2.c.

◆ refTime [1/2]

REAL8 ConfigVariables::refTime

reference time for pulsar phase definition

Definition at line 141 of file pulsar_crosscorr_v2.c.

◆ orbitPSecMin

REAL8 ConfigVariables::orbitPSecMin

minimum binary orbital period in seconds

Definition at line 142 of file pulsar_crosscorr_v2.c.

◆ orbitPSecMax

REAL8 ConfigVariables::orbitPSecMax

maximum binary orbital period in seconds

Definition at line 143 of file pulsar_crosscorr_v2.c.

◆ useTPEllipse

BOOLEAN ConfigVariables::useTPEllipse

whether to use elliptical boundary for Tasc-Porb search space

Definition at line 144 of file pulsar_crosscorr_v2.c.

◆ norb

int ConfigVariables::norb

number of orbits to shift prior elliptical boundary for Tasc-Porb search space

Definition at line 145 of file pulsar_crosscorr_v2.c.

◆ orbitTimeAscCenterShifted

REAL8 ConfigVariables::orbitTimeAscCenterShifted

shifted center of prior ellipse for binary time of ascension (GPS seconds)

Definition at line 146 of file pulsar_crosscorr_v2.c.

◆ dPorbdTascShear

REAL8 ConfigVariables::dPorbdTascShear

slope of centerline of prior ellipse

Definition at line 147 of file pulsar_crosscorr_v2.c.

◆ unshearedgTT

REAL8 ConfigVariables::unshearedgTT

metric element gTT in unsheared coordinates

Definition at line 148 of file pulsar_crosscorr_v2.c.

◆ unshearedgTP

REAL8 ConfigVariables::unshearedgTP

metric element gTP in unsheared coordinates

Definition at line 149 of file pulsar_crosscorr_v2.c.

◆ mismatchMaxP

REAL8 ConfigVariables::mismatchMaxP

maximum mismatch in porb

Definition at line 150 of file pulsar_crosscorr_v2.c.

◆ mismatchMaxThreeD

REAL8 ConfigVariables::mismatchMaxThreeD

mismatch used for 3d lattice

Definition at line 151 of file pulsar_crosscorr_v2.c.

◆ startTime

LIGOTimeGPS ConfigVariables::startTime

starting timestamp of SFTs

start time of observation

Definition at line 151 of file ComputeFstatistic_v2.c.

◆ Tspan

REAL8 ConfigVariables::Tspan

time spanned by all SFTs

Definition at line 152 of file ComputeFstatistic_v2.c.

◆ Alpha [1/2]

REAL8 ConfigVariables::Alpha

sky position alpha in radians

Definition at line 153 of file ComputeFstatistic_v2.c.

◆ Delta [1/2]

REAL8 ConfigVariables::Delta

sky position delta in radians

Definition at line 154 of file ComputeFstatistic_v2.c.

◆ Tsft

REAL8 ConfigVariables::Tsft

length of one SFT in seconds

Definition at line 155 of file ComputeFstatistic_v2.c.

◆ searchRegion

DopplerRegion ConfigVariables::searchRegion

parameter-space region to search over

Definition at line 156 of file ComputeFstatistic_v2.c.

◆ scanState

DopplerFullScanState* ConfigVariables::scanState

current state of the Doppler-scan

Definition at line 157 of file ComputeFstatistic_v2.c.

◆ stepSizes

PulsarDopplerParams ConfigVariables::stepSizes

user-preferences on Doppler-param step-sizes

Definition at line 158 of file ComputeFstatistic_v2.c.

◆ ephemeris

EphemerisData* ConfigVariables::ephemeris

ephemeris data (from XLALInitBarycenter())

Definition at line 159 of file ComputeFstatistic_v2.c.

◆ NSFTs

UINT4 ConfigVariables::NSFTs

total number of all SFTs used

Definition at line 160 of file ComputeFstatistic_v2.c.

◆ numSFTsPerDet

UINT4Vector* ConfigVariables::numSFTsPerDet

number of SFTs per detector, for log strings, etc.

Definition at line 161 of file ComputeFstatistic_v2.c.

◆ detectorIDs

LALStringVector* ConfigVariables::detectorIDs

detector ID names, for column headings string

Definition at line 162 of file ComputeFstatistic_v2.c.

◆ Fstat_in

FstatInput* ConfigVariables::Fstat_in

Fstat input data struct.

Definition at line 163 of file ComputeFstatistic_v2.c.

◆ Fstat_what

FstatQuantities ConfigVariables::Fstat_what

Fstat quantities to compute.

Definition at line 164 of file ComputeFstatistic_v2.c.

◆ FstatToplist

toplist_t* ConfigVariables::FstatToplist

sorted 'toplist' of the NumCandidatesToKeep loudest candidates

Definition at line 165 of file ComputeFstatistic_v2.c.

◆ scanlineWindow

scanlineWindow_t* ConfigVariables::scanlineWindow

moving window of candidates on scanline to find local maxima

Definition at line 166 of file ComputeFstatistic_v2.c.

◆ VCSInfoString

CHAR* ConfigVariables::VCSInfoString

Git version string.

Definition at line 167 of file ComputeFstatistic_v2.c.

◆ logstring

CHAR* ConfigVariables::logstring

log containing max-info on the whole search setup

Definition at line 168 of file ComputeFstatistic_v2.c.

◆ transientWindowRange

transientWindowRange_t ConfigVariables::transientWindowRange

search range parameters for transient window

Definition at line 169 of file ComputeFstatistic_v2.c.

◆ BSGLsetup

BSGLSetup* ConfigVariables::BSGLsetup

pre-computed setup for line-robust statistic

Definition at line 170 of file ComputeFstatistic_v2.c.

◆ RankingStatistic

RankingStat_t ConfigVariables::RankingStatistic

rank candidates according to F or BSGL

Definition at line 171 of file ComputeFstatistic_v2.c.

◆ useResamp

BOOLEAN ConfigVariables::useResamp

Definition at line 172 of file ComputeFstatistic_v2.c.

◆ numFreqBins_FBand

UINT4 ConfigVariables::numFreqBins_FBand

Definition at line 173 of file ComputeFstatistic_v2.c.

◆ dFreq

REAL8 ConfigVariables::dFreq

Definition at line 174 of file ComputeFstatistic_v2.c.

◆ injectionSources

PulsarParamsVector* ConfigVariables::injectionSources

Source parameters to inject: comma-separated list of file-patterns and/or direct config-strings ('{...}')

Definition at line 175 of file ComputeFstatistic_v2.c.

◆ multiTimestamps

MultiLIGOTimeGPSVector * ConfigVariables::multiTimestamps

a vector of timestamps (only set if provided from dedicated time stamp files)

timestamps vector (LIGOtimeGPS format)

Definition at line 176 of file ComputeFstatistic_v2.c.

◆ multiIFO

MultiLALDetector ConfigVariables::multiIFO

detectors to generate data for (if provided by user and not via noise files)

(multi-)detector info

Definition at line 177 of file ComputeFstatistic_v2.c.

◆ runSearch

BOOLEAN ConfigVariables::runSearch

whether to actually perform the search, or just generate a grid and/or count templates

Definition at line 178 of file ComputeFstatistic_v2.c.

◆ dataSummary

CHAR* ConfigVariables::dataSummary

descriptive string describing the data

Definition at line 61 of file PredictFstat.c.

◆ pap

PulsarAmplitudeParams ConfigVariables::pap

PulsarAmplitudeParameter {h0, cosi, psi, phi0}.

Definition at line 62 of file PredictFstat.c.

◆ Mmunu

AntennaPatternMatrix ConfigVariables::Mmunu

antenna-pattern matrix and normalization

Definition at line 63 of file PredictFstat.c.

◆ numSFTs

UINT4 ConfigVariables::numSFTs

number of SFTs = Tobs/Tsft

Definition at line 64 of file PredictFstat.c.

◆ M_mu_nu

gsl_matrix* ConfigVariables::M_mu_nu

antenna-pattern matrix and normalization

Definition at line 85 of file synthesizeBstatMC.c.

◆ AmpRange

AmpParamsRange_t ConfigVariables::AmpRange

signal amplitude-parameter ranges: lower bounds + bands

Definition at line 86 of file synthesizeBstatMC.c.

◆ rng

gsl_rng * ConfigVariables::rng

gsl random-number generator

Definition at line 87 of file synthesizeBstatMC.c.

◆ AmpPrior

AmplitudePrior_t ConfigVariables::AmpPrior

amplitude-parameter priors to draw signals from

Definition at line 137 of file synthesizeLVStats.c.

◆ skypos

SkyPosition ConfigVariables::skypos

(Alpha,Delta,system).

skyposition Alpha,Delta in radians, equatorial coords.

Use Alpha < 0 to signal 'allsky'

Definition at line 139 of file synthesizeLVStats.c.

◆ SignalOnly

BOOLEAN ConfigVariables::SignalOnly

dont generate noise-draws: will result in non-random 'signal only' values of F and B

Definition at line 140 of file synthesizeLVStats.c.

◆ transientSearchRange

transientWindowRange_t ConfigVariables::transientSearchRange

transient-window range for the search (flat priors)

Definition at line 142 of file synthesizeLVStats.c.

◆ transientInjectRange

transientWindowRange_t ConfigVariables::transientInjectRange

transient-window range for injections (flat priors)

Definition at line 143 of file synthesizeLVStats.c.

◆ multiDetStates

MultiDetectorStateSeries * ConfigVariables::multiDetStates

multi-detector state series covering observation time

pos, vel and LMSTs for detector at times t_i

detector state time series

Definition at line 145 of file synthesizeLVStats.c.

◆ logString

CHAR * ConfigVariables::logString

logstring for file-output, containing cmdline-options + code VCS version info

Definition at line 148 of file synthesizeLVStats.c.

◆ oLGX

REAL4* ConfigVariables::oLGX

per-detector line prior odds

Definition at line 150 of file synthesizeLVStats.c.

◆ multiNoiseWeights

MultiNoiseWeights * ConfigVariables::multiNoiseWeights

per-detector noise weights SX^-1/S^-1, no per-SFT variation (can be NULL for unit weights)

noise-weights for the different IFOs

per-detector noise weights

Definition at line 152 of file synthesizeLVStats.c.

◆ numDetectors

UINT4 ConfigVariables::numDetectors

number of detectors

Definition at line 56 of file ComputeAntennaPattern.c.

◆ numTimeStamps

UINT4 ConfigVariables::numTimeStamps

number of timestamps (SFTs) for all detectors

Definition at line 60 of file ComputeAntennaPattern.c.

◆ numTimeStampsX

UINT4Vector* ConfigVariables::numTimeStampsX

number of timestamps (SFTs) per detector

Definition at line 61 of file ComputeAntennaPattern.c.

◆ Alpha [2/2]

REAL8Vector* ConfigVariables::Alpha

skyposition Alpha: radians, equatorial coords

Definition at line 62 of file ComputeAntennaPattern.c.

◆ Delta [2/2]

REAL8Vector* ConfigVariables::Delta

skyposition Delta: radians, equatorial coords

Definition at line 63 of file ComputeAntennaPattern.c.

◆ numSkyPoints

UINT4 ConfigVariables::numSkyPoints

common length of Alpha and Delta vectors

Definition at line 64 of file ComputeAntennaPattern.c.

◆ segmentList

LALSegList ConfigVariables::segmentList

segment list contains start- and end-times of all segments

Definition at line 117 of file FstatMetric_v2.c.

◆ signalParams

PulsarParams ConfigVariables::signalParams

GW signal parameters: Amplitudes + doppler.

Definition at line 118 of file FstatMetric_v2.c.

◆ multiNoiseFloor

MultiNoiseFloor ConfigVariables::multiNoiseFloor

... and corresponding noise-floors to be used as weights

Definition at line 120 of file FstatMetric_v2.c.

◆ coordSys

DopplerCoordinateSystem ConfigVariables::coordSys

array of enums describing Doppler-coordinates to compute metric in

Definition at line 121 of file FstatMetric_v2.c.

◆ history

ResultHistory_t* ConfigVariables::history

history trail leading up to and including this application

Definition at line 122 of file FstatMetric_v2.c.

◆ timeGPS

LIGOTimeGPS ConfigVariables::timeGPS

GPS time to compute detector state for (LIGOtimeGPS format)

Definition at line 52 of file PrintDetectorState.c.

◆ det

const LALDetector* ConfigVariables::det

LIGODetector struct holding detector info.

Definition at line 55 of file PrintDetectorState.c.

◆ timestamps

LIGOTimeGPSVector* ConfigVariables::timestamps

timestamps vector holding 1 element: timeGPS

Definition at line 56 of file PrintDetectorState.c.

◆ sinzeta

REAL8 ConfigVariables::sinzeta

detector-arm angle correction (needed for GEO)

Definition at line 57 of file PrintDetectorState.c.

◆ edat [2/2]

const EphemerisData* ConfigVariables::edat

ephemeris data (from XLALInitBarycenter())

Definition at line 129 of file old-FstatMetric.c.

◆ refTime [2/2]

LIGOTimeGPS ConfigVariables::refTime

reference time for spin-parameters

Definition at line 131 of file old-FstatMetric.c.

◆ dopplerPoint

DopplerPoint ConfigVariables::dopplerPoint

sky-position and spins

Definition at line 132 of file old-FstatMetric.c.

◆ multiAMcoe

MultiAMCoeffs* ConfigVariables::multiAMcoe

Amplitude Modulation coefficients a,b(t)

Definition at line 134 of file old-FstatMetric.c.

◆ multidPhi

MultiPhaseDerivs* ConfigVariables::multidPhi

Phase-derivatives d_i phi(t)

Definition at line 135 of file old-FstatMetric.c.

◆ GLweights

REAL8Vector* ConfigVariables::GLweights

Gauss-Legendre Integration-weights.

Definition at line 136 of file old-FstatMetric.c.

◆ Al1

REAL8 ConfigVariables::Al1

Definition at line 138 of file old-FstatMetric.c.

◆ Al2

REAL8 ConfigVariables::Al2

Definition at line 138 of file old-FstatMetric.c.

◆ Al3

REAL8 ConfigVariables::Al3

amplitude factors alpha1, alpha2, alpha3

Definition at line 138 of file old-FstatMetric.c.

◆ Ad

REAL8 ConfigVariables::Ad

Definition at line 139 of file old-FstatMetric.c.

◆ Bd

REAL8 ConfigVariables::Bd

Definition at line 139 of file old-FstatMetric.c.

◆ Cd

REAL8 ConfigVariables::Cd

Definition at line 139 of file old-FstatMetric.c.

◆ Dd

REAL8 ConfigVariables::Dd

Definition at line 139 of file old-FstatMetric.c.

◆ phaseType

PhaseType_t ConfigVariables::phaseType

Definition at line 140 of file old-FstatMetric.c.