Detailed Description

useful variables for each hierarchical stage

Useful stuff for a single stage of the Hierarchical search.

Definition at line 108 of file HierarchSearchGCT.c.

Data Fields
CHAR *	sftbasename
	filename pattern for sfts More...

LIGOTimeGPS	tStartGPS
	start and end time of stack More...

REAL8	tObs
	tEndGPS - tStartGPS More...

REAL8	refTime
	reference time for pulsar params More...

PulsarSpinRange	spinRange_startTime
	freq and fdot range at start-time of observation More...

PulsarSpinRange	spinRange_endTime
	freq and fdot range at end-time of observation More...

PulsarSpinRange	spinRange_refTime
	freq and fdot range at the reference time More...

PulsarSpinRange	spinRange_midTime
	freq and fdot range at mid-time of observation More...

EphemerisData *	edat
	ephemeris data for XLALBarycenter More...

LIGOTimeGPSVector *	midTstack
	timestamps vector for mid time of each stack More...

LIGOTimeGPSVector *	startTstack
	timestamps vector for start time of each stack More...

LIGOTimeGPSVector *	endTstack
	timestamps vector for end time of each stack More...

LIGOTimeGPS	minStartTimeGPS
	all sft data must be after this time More...

LIGOTimeGPS	maxStartTimeGPS
	all sft timestamps must be before this GPS time More...

UINT4	blocksRngMed
	blocksize for running median noise floor estimation More...

UINT4	Dterms
	size of Dirichlet kernel for Fstat calculation More...

UINT4	DtermsRecalc
	Recalc: size of Dirichlet kernel for Fstat calculation. More...

LALStringVector *	assumeSqrtSX
	Assume stationary Gaussian noise with detector noise-floors sqrt{SX}". More...

REAL8	tStack
	duration of stacks More...

UINT4	nStacks
	number of stacks More...

LALSegList *	segmentList
	parsed segment list read from user-specified input file –segmentList More...

BSGLSetup *	BSGLsetup
	pre-computed setup for line-robust statistic BSGL More...

REAL8	dFreqStack
	frequency resolution of Fstat calculation More...

REAL8	df1dot
	coarse grid resolution in spindown More...

REAL8	df2dot
	coarse grid resolution in 2nd spindown More...

REAL8	df3dot
	coarse grid resolution in 3rd spindown More...

UINT4	extraBinsFstat
	Extra Fstat frequency bins required to cover residual spindowns. More...

UINT4	binsFstatSearch
	nominal number of Fstat frequency bins in search band More...

UINT4	nf1dot
	number of 1st spindown Fstat bins More...

UINT4	nf2dot
	number of 2nd spindown Fstat bins More...

UINT4	nf3dot
	number of 3rd spindown Fstat bins More...

int	SSBprec
	SSB transform precision. More...

FstatMethodType	Fmethod
	which Fstat-method/algorithm to use More...

BOOLEAN	recalcToplistStats
	do additional analysis for all toplist candidates, output F, FXvector for postprocessing *‍/ More...

FstatMethodType	FmethodRecalc
	which Fstat-method/algorithm to use for the recalc step More...

REAL8	mismatch1
	'mismatch1' user-input needed here internally ... More...

UINT4	nSFTs
	total number of SFTs More...

LALStringVector *	detectorIDs
	vector of detector IDs More...

REAL4	NSegmentsInvX [PULSAR_MAX_DETECTORS]
	effective inverse number of segments per detector (needed for correct averaging in single-IFO F calculation) More...

FstatInputVector *	Fstat_in_vec
	Original wide-parameter search: vector of Fstat input data structures for XLALComputeFstat(), one per stack. More...

FstatInputVector *	Fstat_in_vec_recalc
	Recalculate the toplist: Vector of Fstat input data structures for XLALComputeFstat(), one per stack. More...

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

BOOLEAN	collectFstatTiming
	flag whether to collect and output F-stat timing info More...

REAL8	dopplerMax
	extra sft wings for doppler motion More...

Field Documentation

◆ sftbasename

CHAR * UsefulStageVariables::sftbasename

filename pattern for sfts

Definition at line 109 of file HierarchSearchGCT.c.

◆ tStartGPS

LIGOTimeGPS UsefulStageVariables::tStartGPS

start and end time of stack

Definition at line 110 of file HierarchSearchGCT.c.

◆ tObs

REAL8 UsefulStageVariables::tObs

tEndGPS - tStartGPS

Definition at line 111 of file HierarchSearchGCT.c.

◆ refTime

REAL8 UsefulStageVariables::refTime

reference time for pulsar params

Definition at line 112 of file HierarchSearchGCT.c.

◆ spinRange_startTime

PulsarSpinRange UsefulStageVariables::spinRange_startTime

freq and fdot range at start-time of observation

Definition at line 113 of file HierarchSearchGCT.c.

◆ spinRange_endTime

PulsarSpinRange UsefulStageVariables::spinRange_endTime

freq and fdot range at end-time of observation

Definition at line 114 of file HierarchSearchGCT.c.

◆ spinRange_refTime

PulsarSpinRange UsefulStageVariables::spinRange_refTime

freq and fdot range at the reference time

Definition at line 115 of file HierarchSearchGCT.c.

◆ spinRange_midTime

PulsarSpinRange UsefulStageVariables::spinRange_midTime

freq and fdot range at mid-time of observation

Definition at line 116 of file HierarchSearchGCT.c.

◆ edat

EphemerisData * UsefulStageVariables::edat

ephemeris data for XLALBarycenter

Definition at line 117 of file HierarchSearchGCT.c.

◆ midTstack

LIGOTimeGPSVector * UsefulStageVariables::midTstack

timestamps vector for mid time of each stack

Definition at line 118 of file HierarchSearchGCT.c.

◆ startTstack

LIGOTimeGPSVector * UsefulStageVariables::startTstack

timestamps vector for start time of each stack

Definition at line 119 of file HierarchSearchGCT.c.

◆ endTstack

LIGOTimeGPSVector* UsefulStageVariables::endTstack

timestamps vector for end time of each stack

Definition at line 120 of file HierarchSearchGCT.c.

◆ minStartTimeGPS

LIGOTimeGPS UsefulStageVariables::minStartTimeGPS

all sft data must be after this time

Only use SFTs with timestamps starting from (including) this GPS time.

Definition at line 121 of file HierarchSearchGCT.c.

◆ maxStartTimeGPS

LIGOTimeGPS UsefulStageVariables::maxStartTimeGPS

all sft timestamps must be before this GPS time

Only use SFTs with timestamps up to (excluding) this GPS time.

Definition at line 122 of file HierarchSearchGCT.c.

◆ blocksRngMed

UINT4 UsefulStageVariables::blocksRngMed

blocksize for running median noise floor estimation

Definition at line 123 of file HierarchSearchGCT.c.

◆ Dterms

UINT4 UsefulStageVariables::Dterms

size of Dirichlet kernel for Fstat calculation

Definition at line 124 of file HierarchSearchGCT.c.

◆ DtermsRecalc

UINT4 UsefulStageVariables::DtermsRecalc

Recalc: size of Dirichlet kernel for Fstat calculation.

Definition at line 125 of file HierarchSearchGCT.c.

◆ assumeSqrtSX

LALStringVector* UsefulStageVariables::assumeSqrtSX

Assume stationary Gaussian noise with detector noise-floors sqrt{SX}".

Definition at line 126 of file HierarchSearchGCT.c.

◆ tStack

REAL8 UsefulStageVariables::tStack

duration of stacks

Definition at line 128 of file HierarchSearchGCT.c.

◆ nStacks

UINT4 UsefulStageVariables::nStacks

number of stacks

Definition at line 129 of file HierarchSearchGCT.c.

◆ segmentList

LALSegList* UsefulStageVariables::segmentList

parsed segment list read from user-specified input file –segmentList

Definition at line 130 of file HierarchSearchGCT.c.

◆ BSGLsetup

BSGLSetup* UsefulStageVariables::BSGLsetup

pre-computed setup for line-robust statistic BSGL

Definition at line 131 of file HierarchSearchGCT.c.

◆ dFreqStack

REAL8 UsefulStageVariables::dFreqStack

frequency resolution of Fstat calculation

Definition at line 132 of file HierarchSearchGCT.c.

◆ df1dot

REAL8 UsefulStageVariables::df1dot

coarse grid resolution in spindown

Definition at line 133 of file HierarchSearchGCT.c.

◆ df2dot

REAL8 UsefulStageVariables::df2dot

coarse grid resolution in 2nd spindown

Definition at line 134 of file HierarchSearchGCT.c.

◆ df3dot

REAL8 UsefulStageVariables::df3dot

coarse grid resolution in 3rd spindown

Definition at line 135 of file HierarchSearchGCT.c.

◆ extraBinsFstat

UINT4 UsefulStageVariables::extraBinsFstat

Extra Fstat frequency bins required to cover residual spindowns.

Definition at line 136 of file HierarchSearchGCT.c.

◆ binsFstatSearch

UINT4 UsefulStageVariables::binsFstatSearch

nominal number of Fstat frequency bins in search band

Definition at line 137 of file HierarchSearchGCT.c.

◆ nf1dot

UINT4 UsefulStageVariables::nf1dot

number of 1st spindown Fstat bins

Definition at line 138 of file HierarchSearchGCT.c.

◆ nf2dot

UINT4 UsefulStageVariables::nf2dot

number of 2nd spindown Fstat bins

Definition at line 139 of file HierarchSearchGCT.c.

◆ nf3dot

UINT4 UsefulStageVariables::nf3dot

number of 3rd spindown Fstat bins

Definition at line 140 of file HierarchSearchGCT.c.

◆ SSBprec

int UsefulStageVariables::SSBprec

SSB transform precision.

Definition at line 141 of file HierarchSearchGCT.c.

◆ Fmethod

FstatMethodType UsefulStageVariables::Fmethod

which Fstat-method/algorithm to use

Definition at line 142 of file HierarchSearchGCT.c.

◆ recalcToplistStats

BOOLEAN UsefulStageVariables::recalcToplistStats

do additional analysis for all toplist candidates, output F, FXvector for postprocessing *‍/

Definition at line 143 of file HierarchSearchGCT.c.

◆ FmethodRecalc

FstatMethodType UsefulStageVariables::FmethodRecalc

which Fstat-method/algorithm to use for the recalc step

Definition at line 144 of file HierarchSearchGCT.c.

◆ mismatch1

REAL8 UsefulStageVariables::mismatch1

'mismatch1' user-input needed here internally ...

Definition at line 145 of file HierarchSearchGCT.c.

◆ nSFTs

UINT4 UsefulStageVariables::nSFTs

total number of SFTs

Definition at line 146 of file HierarchSearchGCT.c.

◆ detectorIDs

LALStringVector* UsefulStageVariables::detectorIDs

vector of detector IDs

Definition at line 147 of file HierarchSearchGCT.c.

◆ NSegmentsInvX

REAL4 UsefulStageVariables::NSegmentsInvX[PULSAR_MAX_DETECTORS]

effective inverse number of segments per detector (needed for correct averaging in single-IFO F calculation)

Definition at line 148 of file HierarchSearchGCT.c.

◆ Fstat_in_vec

FstatInputVector* UsefulStageVariables::Fstat_in_vec

Original wide-parameter search: vector of Fstat input data structures for XLALComputeFstat(), one per stack.

Definition at line 149 of file HierarchSearchGCT.c.

◆ Fstat_in_vec_recalc

FstatInputVector* UsefulStageVariables::Fstat_in_vec_recalc

Recalculate the toplist: Vector of Fstat input data structures for XLALComputeFstat(), one per stack.

Definition at line 150 of file HierarchSearchGCT.c.

◆ injectionSources

PulsarParamsVector* UsefulStageVariables::injectionSources

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

Definition at line 151 of file HierarchSearchGCT.c.

◆ collectFstatTiming

BOOLEAN UsefulStageVariables::collectFstatTiming

flag whether to collect and output F-stat timing info

Definition at line 152 of file HierarchSearchGCT.c.

◆ dopplerMax

REAL8 UsefulStageVariables::dopplerMax

extra sft wings for doppler motion

Definition at line 190 of file HierarchicalSearch.c.