Detailed Description

user input variables

Definition at line 51 of file compareFstats.c.

Data Fields
CHAR *	Fname1

CHAR *	Fname2

REAL8	tol_param

REAL8	tol_L1

REAL8	tol_L2

REAL8	tol_angle

REAL8	tol_atMax

CHAR *	outSFTbname
	Path and basefilename of output SFT files. More...

BOOLEAN	outSingleSFT
	use to output a single concatenated SFT More...

CHAR *	TDDfile
	Filename for ASCII output time-series. More...

CHAR *	TDDframedir
	directory for frame file output time-series More...

CHAR *	frameDesc
	description field entry in the frame filename More...

BOOLEAN	hardwareTDD
	Binary output timeseries in chunks of Tsft for hardware injections. More...

CHAR *	logfile
	name of logfile More...

CHAR *	timestampsFile
	Timestamps file. More...

LIGOTimeGPS	startTime
	Start-time of requested signal in detector-frame (GPS seconds) More...

INT4	duration
	Duration of requested signal in seconds. More...

INT4	generationMode
	How to generate the timeseries: all-at-once or per-sft. More...

REAL8	fmin
	Lowest frequency in output SFT (= heterodyning frequency) More...

REAL8	Band
	bandwidth of output SFT in Hz (= 1/2 sampling frequency) More...

REAL8	Tsft
	SFT time baseline Tsft. More...

REAL8	SFToverlap
	overlap SFTs by this many seconds More...

CHAR *	noiseSFTs
	Glob-like pattern specifying noise-SFTs to be added to signal. More...

REAL8	noiseSqrtSh
	single-sided sqrt(Sh) for Gaussian noise More...

CHAR *	window
	Windowing function for the time series. More...

REAL8	windowParam
	Hann fraction of Tukey window (0.0=rect; 1,0=han; 0.5=default. More...

CHAR *	IFO
	Detector: H1, L1, H2, V1, ... More...

CHAR *	actuation
	filename containg detector actuation function More...

REAL8	actuationScale
	Scale-factor to be applied to actuation-function. More...

CHAR *	ephemEarth
	Earth ephemeris file to use. More...

CHAR *	ephemSun
	Sun ephemeris file to use. More...

LIGOTimeGPS	refTime
	Pulsar reference epoch tRef in SSB ('0' means: use startTime converted to SSB) More...

REAL8	h0
	overall signal amplitude h0 More...

REAL8	cosi
	cos(iota) of inclination angle iota More...

REAL8	aPlus
	ALTERNATIVE to {h0,cosi}: Plus polarization amplitude aPlus. More...

REAL8	aCross
	ALTERNATIVE to {h0,cosi}: Cross polarization amplitude aCross. More...

REAL8	psi
	Polarization angle psi. More...

REAL8	phi0
	Initial phase phi. More...

REAL8	Alpha
	Right ascension [radians] alpha of pulsar. More...

REAL8	Delta
	Declination [radians] delta of pulsar. More...

REAL8	Freq
	physical start frequency to compute PSD for (excluding rngmed wings) More...

REAL8	f1dot
	First spindown parameter f'. More...

REAL8	f2dot
	Second spindown parameter f''. More...

REAL8	f3dot
	Third spindown parameter f'''. More...

REAL8	orbitasini
	Projected orbital semi-major axis in seconds (a/c) More...

REAL8	orbitEcc
	Orbital eccentricity. More...

LIGOTimeGPS	orbitTp
	'true' epoch of periapsis passage More...

REAL8	orbitPeriod
	Orbital period (seconds) More...

REAL8	orbitArgp
	Argument of periapsis (radians) More...

BOOLEAN	exactSignal
	generate signal timeseries as exactly as possible (slow) More...

BOOLEAN	lineFeature
	generate a monochromatic line instead of a pulsar-signal More...

INT4	randSeed
	allow user to specify random-number seed for reproducible noise-realizations More...

CHAR *	parfile

CHAR *	transientWindowType
	option .par file path More...

REAL8	transientStartTime
	GPS start-time of transient window. More...

REAL8	transientTauDays
	time-scale in days of transient window More...

REAL8	sourceDeltaT
	source-frame sampling period. More...

CHAR *	outSFTdir
	Output directory for SFTs. More...

CHAR *	outLabel
	'misc' entry in SFT-filenames, and description entry of output frame filenames More...

UINT4	outPubObsRun
	if >0, names SFTs using the public filename convention with this observing run number More...

UINT4	outPubRevision
	if outPubObsRun>0, names SFTs using the public filename convention with this revision number More...

LALStringVector *	timestampsFiles
	Names of numDet timestamps files. More...

LALStringVector *	IFOs
	list of detector-names "H1,H2,L1,.." or single detector More...

LALStringVector *	sqrtSX
	Add Gaussian noise: list of respective detectors' noise-floors sqrt{Sn}". More...

CHAR *	outFrameDir
	directory for writing output timeseries in frame files More...

LALStringVector *	inFrames
	frame glob-patterns or cache files of time-series data to be added to output (one per IFO) More...

LALStringVector *	inFrChannels
	list of frame channels to read time-series data from (one per IFO) More...

LALStringVector *	outFrChannels
	list of output frame channel names to write (one per IFO) More...

CHAR *	SFTWindowType
	Windowing function to apply to the SFT time series. More...

REAL8	SFTWindowParam
	parameter required for certain window-types More...

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

CHAR *	inputData
	directory for input sfts More...

CHAR *	outputPSD
	directory for output sfts More...

CHAR *	outputSpectBname

REAL8	FreqBand
	physical frequency band to compute PSD for (excluding rngmed wings) More...

REAL8	startTime
	earliest SFT-timestamp to include More...

REAL8	endTime
	last SFT-timestamp to include More...

CHAR *	timeStampsFile

LALStringVector *	linefiles

INT4	blocksRngMed
	number of running-median bins to use More...

INT4	maxBinsClean

INT4	PSDmthopSFTs
	for PSD, type of math. More...

INT4	PSDmthopIFOs
	for PSD, type of math. More...

BOOLEAN	outputNormSFT
	output normalised SFT power? More...

INT4	nSFTmthopSFTs
	for norm. More...

INT4	nSFTmthopIFOs
	for norm. More...

BOOLEAN	normalizeByTotalNumSFTs
	apply normalization factor from total number of SFTs over all IFOs More...

REAL8	binSizeHz
	output PSD bin size in Hz More...

INT4	binSize
	output PSD bin size in no. More...

INT4	PSDmthopBins
	for PSD, type of math. More...

INT4	nSFTmthopBins
	for norm. More...

REAL8	binStepHz
	output PSD bin step in Hz More...

INT4	binStep
	output PSD bin step in no. More...

BOOLEAN	outFreqBinEnd
	output the end frequency of each bin? More...

BOOLEAN	dumpMultiPSDVector
	output multi-PSD vector over IFOs, timestamps, and frequencies into file(s) More...

CHAR *	outputQ
	output the 'data-quality factor' Q(f) into this file More...

REAL8	fStart
	Start Frequency to load from SFT and compute PSD, including wings (it is RECOMMENDED to use –Freq instead) More...

REAL8	fBand
	Frequency Band to load from SFT and compute PSD, including wings (it is RECOMMENDED to use –FreqBand instead) More...

CHAR *	SFTfiles

BOOLEAN	headerOnly

BOOLEAN	dataOnly

BOOLEAN	timestampsOnly

UINT4	Nmax

CHAR *	skyGridFile
	alternative: matrix of (Alpha,Delta) pairs from a file More...

LALStringVector *	timeGPS
	GPS timestamps to compute detector state for (REAL8 format) More...

LALStringVector *	timeStampsFiles
	alternative: read in timestamps from file(s) More...

INT4	Tsft
	assumed length of SFTs, needed for offset to timestamps when comparing to CFS_v2, PFS etc More...

LALStringVector *	noiseSqrtShX
	per-detector noise PSD sqrt(SX) More...

BOOLEAN	singleIFOweighting
	Normalize single-IFO quantities by single-IFO SX instead of Stot. More...

CHAR *	outab
	output file for antenna pattern functions a(t), b(t) at each timestamp More...

CHAR *	outABCD
	output file for antenna pattern matrix elements A, B, C, D averaged over timestamps More...

REAL8	duration
	length of observation in seconds More...

INT4	Nseg
	number of segments to split duration into More...

CHAR *	segmentList
	ALTERNATIVE: specify segment file with format: repeated lines <startGPS endGPS duration[h] NumSFTs>". More...

CHAR *	outputMetric
	filename to write metrics into More...

CHAR *	detMotionStr
	string specifying type of detector-motion to use More...

INT4	metricType
	type of metric to compute: 0=phase-metric, 1=F-metric(s), 2=both More...

INT4	projection
	project metric onto subspace orthogonal to this coordinate-axis (0=none, 1=1st-coordinate axis, ...) More...

LALStringVector *	coords
	list of Doppler-coordinates to compute metric in, see –coordsHelp for possible values More...

BOOLEAN	coordsHelp
	output help-string explaining all the possible Doppler-coordinate names for –cords More...

BOOLEAN	approxPhase
	use an approximate phase-model, neglecting Roemer delay in spindown coordinates More...

CHAR *	detector
	detector name More...

REAL8	timeGPS
	GPS time to compute detector state for (REAL8 format) More...

CHAR *	infile1

CHAR *	infile2

CHAR *	outfile1

CHAR *	outfile2

CHAR *	outfile3

CHAR *	finalOutfile

REAL8	Tobs

REAL8	Tcoh

REAL8	fdiff_allowed

REAL8	dfdiff_allowed

REAL8	skydiff_allowed

REAL8	t0

REAL8	alpha

REAL8	delta

INT4	skylocations

LALStringVector *	IFO

CHAR *	outfilename

BOOLEAN	unrestrictedCosi

BOOLEAN	rectWindow

REAL8	fspan

CHAR *	skyRegion

BOOLEAN	v1

REAL8	Pmin

REAL8	Pmax

REAL8	dfmin

REAL8	dfmax

INT4	maxVectorLength

INT4	minTemplateLength

INT4	maxTemplateLength

INT4	vectorMath

BOOLEAN	exactflag

CHAR *	filename

CHAR *	RAJ

CHAR *	DECJ

REAL8	TstartUTCMJD

REAL8	TrefTDBMJD

REAL8	DeltaTMJD

REAL8	DurationMJD

CHAR *	det

REAL8	f0

REAL8	fdot

CHAR *	PSRJ

CHAR *	Observatory

Field Documentation

◆ Fname1

CHAR* UserVariables_t::Fname1

Definition at line 52 of file compareFstats.c.

◆ Fname2

CHAR* UserVariables_t::Fname2

Definition at line 53 of file compareFstats.c.

◆ tol_param

REAL8 UserVariables_t::tol_param

Definition at line 55 of file compareFstats.c.

◆ tol_L1

REAL8 UserVariables_t::tol_L1

Definition at line 56 of file compareFstats.c.

◆ tol_L2

REAL8 UserVariables_t::tol_L2

Definition at line 57 of file compareFstats.c.

◆ tol_angle

REAL8 UserVariables_t::tol_angle

Definition at line 58 of file compareFstats.c.

◆ tol_atMax

REAL8 UserVariables_t::tol_atMax

Definition at line 59 of file compareFstats.c.

◆ outSFTbname

CHAR* UserVariables_t::outSFTbname

Path and basefilename of output SFT files.

Definition at line 112 of file makefakedata_v4.c.

◆ outSingleSFT

BOOLEAN UserVariables_t::outSingleSFT

use to output a single concatenated SFT

Definition at line 113 of file makefakedata_v4.c.

◆ TDDfile

CHAR * UserVariables_t::TDDfile

Filename for ASCII output time-series.

Definition at line 115 of file makefakedata_v4.c.

◆ TDDframedir

CHAR* UserVariables_t::TDDframedir

directory for frame file output time-series

Definition at line 116 of file makefakedata_v4.c.

◆ frameDesc

CHAR* UserVariables_t::frameDesc

description field entry in the frame filename

Definition at line 117 of file makefakedata_v4.c.

◆ hardwareTDD

BOOLEAN UserVariables_t::hardwareTDD

Binary output timeseries in chunks of Tsft for hardware injections.

Definition at line 119 of file makefakedata_v4.c.

◆ logfile

CHAR * UserVariables_t::logfile

name of logfile

Definition at line 121 of file makefakedata_v4.c.

◆ timestampsFile

CHAR* UserVariables_t::timestampsFile

Timestamps file.

Definition at line 124 of file makefakedata_v4.c.

◆ startTime [1/2]

LIGOTimeGPS UserVariables_t::startTime

Start-time of requested signal in detector-frame (GPS seconds)

GPS start time of observation.

Definition at line 125 of file makefakedata_v4.c.

◆ duration [1/2]

INT4 UserVariables_t::duration

Duration of requested signal in seconds.

Definition at line 126 of file makefakedata_v4.c.

◆ generationMode

INT4 UserVariables_t::generationMode

How to generate the timeseries: all-at-once or per-sft.

Definition at line 129 of file makefakedata_v4.c.

◆ fmin

REAL8 UserVariables_t::fmin

Lowest frequency in output SFT (= heterodyning frequency)

Definition at line 132 of file makefakedata_v4.c.

◆ Band

REAL8 UserVariables_t::Band

bandwidth of output SFT in Hz (= 1/2 sampling frequency)

Definition at line 133 of file makefakedata_v4.c.

◆ Tsft [1/2]

REAL8 UserVariables_t::Tsft

SFT time baseline Tsft.

Definition at line 136 of file makefakedata_v4.c.

◆ SFToverlap

REAL8 UserVariables_t::SFToverlap

overlap SFTs by this many seconds

Definition at line 137 of file makefakedata_v4.c.

◆ noiseSFTs

CHAR * UserVariables_t::noiseSFTs

Glob-like pattern specifying noise-SFTs to be added to signal.

Definition at line 140 of file makefakedata_v4.c.

◆ noiseSqrtSh

REAL8 UserVariables_t::noiseSqrtSh

single-sided sqrt(Sh) for Gaussian noise

Definition at line 141 of file makefakedata_v4.c.

◆ window

CHAR* UserVariables_t::window

Windowing function for the time series.

Definition at line 144 of file makefakedata_v4.c.

◆ windowParam

REAL8 UserVariables_t::windowParam

Hann fraction of Tukey window (0.0=rect; 1,0=han; 0.5=default.

Definition at line 145 of file makefakedata_v4.c.

◆ IFO [1/2]

CHAR * UserVariables_t::IFO

Detector: H1, L1, H2, V1, ...

Definition at line 148 of file makefakedata_v4.c.

◆ actuation

CHAR* UserVariables_t::actuation

filename containg detector actuation function

Definition at line 150 of file makefakedata_v4.c.

◆ actuationScale

REAL8 UserVariables_t::actuationScale

Scale-factor to be applied to actuation-function.

Definition at line 151 of file makefakedata_v4.c.

◆ ephemEarth

CHAR * UserVariables_t::ephemEarth

Earth ephemeris file to use.

Definition at line 153 of file makefakedata_v4.c.

◆ ephemSun

CHAR * UserVariables_t::ephemSun

Sun ephemeris file to use.

Definition at line 154 of file makefakedata_v4.c.

◆ refTime

LIGOTimeGPS UserVariables_t::refTime

Pulsar reference epoch tRef in SSB ('0' means: use startTime converted to SSB)

GPS reference time of Doppler parameters.

Definition at line 157 of file makefakedata_v4.c.

◆ h0

REAL8 UserVariables_t::h0

overall signal amplitude h0

GW amplitude h_0.

Definition at line 159 of file makefakedata_v4.c.

◆ cosi

REAL8 UserVariables_t::cosi

cos(iota) of inclination angle iota

cos(iota)

Definition at line 160 of file makefakedata_v4.c.

◆ aPlus

REAL8 UserVariables_t::aPlus

ALTERNATIVE to {h0,cosi}: Plus polarization amplitude aPlus.

Definition at line 161 of file makefakedata_v4.c.

◆ aCross

REAL8 UserVariables_t::aCross

ALTERNATIVE to {h0,cosi}: Cross polarization amplitude aCross.

Definition at line 162 of file makefakedata_v4.c.

◆ psi

REAL8 UserVariables_t::psi

Polarization angle psi.

polarization-angle psi

Definition at line 163 of file makefakedata_v4.c.

◆ phi0

REAL8 UserVariables_t::phi0

Initial phase phi.

initial GW phase phi_0

Definition at line 164 of file makefakedata_v4.c.

◆ Alpha

REAL8 UserVariables_t::Alpha

Right ascension [radians] alpha of pulsar.

skyposition Alpha: radians, equatorial coords.

a single skyposition Alpha: radians, equatorial coords.

Definition at line 166 of file makefakedata_v4.c.

◆ Delta

REAL8 UserVariables_t::Delta

Declination [radians] delta of pulsar.

skyposition Delta: radians, equatorial coords.

a single skyposition Delta: radians, equatorial coords.

Definition at line 167 of file makefakedata_v4.c.

◆ Freq

REAL8 UserVariables_t::Freq

physical start frequency to compute PSD for (excluding rngmed wings)

target-frequency

Definition at line 169 of file makefakedata_v4.c.

◆ f1dot

REAL8 UserVariables_t::f1dot

First spindown parameter f'.

target 1.

spindown-value df/dt

Definition at line 170 of file makefakedata_v4.c.

◆ f2dot

REAL8 UserVariables_t::f2dot

Second spindown parameter f''.

target 2.

spindown-value d2f/dt2

Definition at line 171 of file makefakedata_v4.c.

◆ f3dot

REAL8 UserVariables_t::f3dot

Third spindown parameter f'''.

target 3.

spindown-value d3f/dt3

Definition at line 172 of file makefakedata_v4.c.

◆ orbitasini

REAL8 UserVariables_t::orbitasini

Projected orbital semi-major axis in seconds (a/c)

target projected semimajor axis of binary orbit [Units: light seconds]

Definition at line 176 of file makefakedata_v4.c.

◆ orbitEcc

REAL8 UserVariables_t::orbitEcc

Orbital eccentricity.

target eccentricity of binary orbit [Units: none]

Definition at line 177 of file makefakedata_v4.c.

◆ orbitTp

LIGOTimeGPS UserVariables_t::orbitTp

'true' epoch of periapsis passage

target time of periapse passage of the CW source in a binary orbit [Units: GPS seconds]

Definition at line 178 of file makefakedata_v4.c.

◆ orbitPeriod

REAL8 UserVariables_t::orbitPeriod

Orbital period (seconds)

target period of binary orbit [Units: s].

Definition at line 179 of file makefakedata_v4.c.

◆ orbitArgp

REAL8 UserVariables_t::orbitArgp

Argument of periapsis (radians)

target argument of periapse of binary orbit [Units: rad]

Definition at line 180 of file makefakedata_v4.c.

◆ exactSignal

BOOLEAN UserVariables_t::exactSignal

generate signal timeseries as exactly as possible (slow)

Definition at line 183 of file makefakedata_v4.c.

◆ lineFeature

BOOLEAN UserVariables_t::lineFeature

generate a monochromatic line instead of a pulsar-signal

Definition at line 184 of file makefakedata_v4.c.

◆ randSeed

INT4 UserVariables_t::randSeed

allow user to specify random-number seed for reproducible noise-realizations

Definition at line 186 of file makefakedata_v4.c.

◆ parfile

CHAR* UserVariables_t::parfile

Definition at line 188 of file makefakedata_v4.c.

◆ transientWindowType

CHAR* UserVariables_t::transientWindowType

option .par file path

name of transient window ('rect', 'exp',...)

Definition at line 189 of file makefakedata_v4.c.

◆ transientStartTime

REAL8 UserVariables_t::transientStartTime

GPS start-time of transient window.

Definition at line 190 of file makefakedata_v4.c.

◆ transientTauDays

REAL8 UserVariables_t::transientTauDays

time-scale in days of transient window

Definition at line 191 of file makefakedata_v4.c.

◆ sourceDeltaT

REAL8 UserVariables_t::sourceDeltaT

source-frame sampling period.

'0' implies previous internal defaults

'0' implies defaults set in XLALGeneratePulsarSignal()

Definition at line 193 of file makefakedata_v4.c.

◆ outSFTdir

CHAR* UserVariables_t::outSFTdir

Output directory for SFTs.

Definition at line 102 of file makefakedata_v5.c.

◆ outLabel

CHAR* UserVariables_t::outLabel

'misc' entry in SFT-filenames, and description entry of output frame filenames

Definition at line 103 of file makefakedata_v5.c.

◆ outPubObsRun

UINT4 UserVariables_t::outPubObsRun

if >0, names SFTs using the public filename convention with this observing run number

Definition at line 104 of file makefakedata_v5.c.

◆ outPubRevision

UINT4 UserVariables_t::outPubRevision

if outPubObsRun>0, names SFTs using the public filename convention with this revision number

Definition at line 105 of file makefakedata_v5.c.

◆ timestampsFiles

LALStringVector* UserVariables_t::timestampsFiles

Names of numDet timestamps files.

Definition at line 112 of file makefakedata_v5.c.

◆ IFOs

LALStringVector * UserVariables_t::IFOs

list of detector-names "H1,H2,L1,.." or single detector

Definition at line 125 of file makefakedata_v5.c.

◆ sqrtSX

LALStringVector * UserVariables_t::sqrtSX

Add Gaussian noise: list of respective detectors' noise-floors sqrt{Sn}".

(string-) list of per-IFO sqrt{Sn} values, \( \sqrt{S_X} \)

Definition at line 128 of file makefakedata_v5.c.

◆ outFrameDir

CHAR* UserVariables_t::outFrameDir

directory for writing output timeseries in frame files

Definition at line 133 of file makefakedata_v5.c.

◆ inFrames

LALStringVector* UserVariables_t::inFrames

frame glob-patterns or cache files of time-series data to be added to output (one per IFO)

Definition at line 134 of file makefakedata_v5.c.

◆ inFrChannels

LALStringVector* UserVariables_t::inFrChannels

list of frame channels to read time-series data from (one per IFO)

Definition at line 135 of file makefakedata_v5.c.

◆ outFrChannels

LALStringVector* UserVariables_t::outFrChannels

list of output frame channel names to write (one per IFO)

Definition at line 136 of file makefakedata_v5.c.

◆ SFTWindowType

CHAR* UserVariables_t::SFTWindowType

Windowing function to apply to the SFT time series.

Definition at line 139 of file makefakedata_v5.c.

◆ SFTWindowParam

REAL8 UserVariables_t::SFTWindowParam

parameter required for certain window-types

Definition at line 140 of file makefakedata_v5.c.

◆ injectionSources

LALStringVector* UserVariables_t::injectionSources

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

Definition at line 146 of file makefakedata_v5.c.

◆ inputData

CHAR* UserVariables_t::inputData

directory for input sfts

Definition at line 85 of file ComputePSD.c.

◆ outputPSD

CHAR* UserVariables_t::outputPSD

directory for output sfts

Definition at line 86 of file ComputePSD.c.

◆ outputSpectBname

CHAR* UserVariables_t::outputSpectBname

Definition at line 87 of file ComputePSD.c.

◆ FreqBand

REAL8 UserVariables_t::FreqBand

physical frequency band to compute PSD for (excluding rngmed wings)

Definition at line 90 of file ComputePSD.c.

◆ startTime [2/2]

REAL8 UserVariables_t::startTime

earliest SFT-timestamp to include

Definition at line 92 of file ComputePSD.c.

◆ endTime

REAL8 UserVariables_t::endTime

last SFT-timestamp to include

Definition at line 93 of file ComputePSD.c.

◆ timeStampsFile

CHAR* UserVariables_t::timeStampsFile

Definition at line 95 of file ComputePSD.c.

◆ linefiles

LALStringVector* UserVariables_t::linefiles

Definition at line 96 of file ComputePSD.c.

◆ blocksRngMed

INT4 UserVariables_t::blocksRngMed

number of running-median bins to use

Definition at line 97 of file ComputePSD.c.

◆ maxBinsClean

INT4 UserVariables_t::maxBinsClean

Definition at line 98 of file ComputePSD.c.

◆ PSDmthopSFTs

INT4 UserVariables_t::PSDmthopSFTs

for PSD, type of math.

operation over SFTs

Definition at line 100 of file ComputePSD.c.

◆ PSDmthopIFOs

INT4 UserVariables_t::PSDmthopIFOs

for PSD, type of math.

operation over IFOs

Definition at line 101 of file ComputePSD.c.

◆ outputNormSFT

BOOLEAN UserVariables_t::outputNormSFT

output normalised SFT power?

Definition at line 102 of file ComputePSD.c.

◆ nSFTmthopSFTs

INT4 UserVariables_t::nSFTmthopSFTs

for norm.

SFT, type of math. operation over SFTs

Definition at line 103 of file ComputePSD.c.

◆ nSFTmthopIFOs

INT4 UserVariables_t::nSFTmthopIFOs

for norm.

SFT, type of math. operation over IFOs

Definition at line 104 of file ComputePSD.c.

◆ normalizeByTotalNumSFTs

BOOLEAN UserVariables_t::normalizeByTotalNumSFTs

apply normalization factor from total number of SFTs over all IFOs

Definition at line 105 of file ComputePSD.c.

◆ binSizeHz

REAL8 UserVariables_t::binSizeHz

output PSD bin size in Hz

Definition at line 107 of file ComputePSD.c.

◆ binSize

INT4 UserVariables_t::binSize

output PSD bin size in no.

of bins

Definition at line 108 of file ComputePSD.c.

◆ PSDmthopBins

INT4 UserVariables_t::PSDmthopBins

for PSD, type of math.

operation over bins

Definition at line 109 of file ComputePSD.c.

◆ nSFTmthopBins

INT4 UserVariables_t::nSFTmthopBins

for norm.

SFT, type of math. operation over bins

Definition at line 110 of file ComputePSD.c.

◆ binStepHz

REAL8 UserVariables_t::binStepHz

output PSD bin step in Hz

Definition at line 111 of file ComputePSD.c.

◆ binStep

INT4 UserVariables_t::binStep

output PSD bin step in no.

of bins

Definition at line 112 of file ComputePSD.c.

◆ outFreqBinEnd

BOOLEAN UserVariables_t::outFreqBinEnd

output the end frequency of each bin?

Definition at line 113 of file ComputePSD.c.

◆ dumpMultiPSDVector

BOOLEAN UserVariables_t::dumpMultiPSDVector

output multi-PSD vector over IFOs, timestamps, and frequencies into file(s)

Definition at line 115 of file ComputePSD.c.

◆ outputQ

CHAR* UserVariables_t::outputQ

output the 'data-quality factor' Q(f) into this file

Definition at line 116 of file ComputePSD.c.

◆ fStart

REAL8 UserVariables_t::fStart

Start Frequency to load from SFT and compute PSD, including wings (it is RECOMMENDED to use –Freq instead)

Definition at line 118 of file ComputePSD.c.

◆ fBand

REAL8 UserVariables_t::fBand

Frequency Band to load from SFT and compute PSD, including wings (it is RECOMMENDED to use –FreqBand instead)

Definition at line 119 of file ComputePSD.c.

◆ SFTfiles

CHAR* UserVariables_t::SFTfiles

Definition at line 49 of file dumpSFT.c.

◆ headerOnly

BOOLEAN UserVariables_t::headerOnly

Definition at line 50 of file dumpSFT.c.

◆ dataOnly

BOOLEAN UserVariables_t::dataOnly

Definition at line 51 of file dumpSFT.c.

◆ timestampsOnly

BOOLEAN UserVariables_t::timestampsOnly

Definition at line 52 of file dumpSFT.c.

◆ Nmax

UINT4 UserVariables_t::Nmax

Definition at line 53 of file dumpSFT.c.

◆ skyGridFile

CHAR* UserVariables_t::skyGridFile

alternative: matrix of (Alpha,Delta) pairs from a file

Definition at line 73 of file ComputeAntennaPattern.c.

◆ timeGPS [1/2]

LALStringVector* UserVariables_t::timeGPS

GPS timestamps to compute detector state for (REAL8 format)

Definition at line 78 of file ComputeAntennaPattern.c.

◆ timeStampsFiles

LALStringVector* UserVariables_t::timeStampsFiles

alternative: read in timestamps from file(s)

Definition at line 79 of file ComputeAntennaPattern.c.

◆ Tsft [2/2]

INT4 UserVariables_t::Tsft

assumed length of SFTs, needed for offset to timestamps when comparing to CFS_v2, PFS etc

Definition at line 80 of file ComputeAntennaPattern.c.

◆ noiseSqrtShX

LALStringVector* UserVariables_t::noiseSqrtShX

per-detector noise PSD sqrt(SX)

Definition at line 82 of file ComputeAntennaPattern.c.

◆ singleIFOweighting

BOOLEAN UserVariables_t::singleIFOweighting

Normalize single-IFO quantities by single-IFO SX instead of Stot.

Definition at line 83 of file ComputeAntennaPattern.c.

◆ outab

CHAR* UserVariables_t::outab

output file for antenna pattern functions a(t), b(t) at each timestamp

Definition at line 85 of file ComputeAntennaPattern.c.

◆ outABCD

CHAR* UserVariables_t::outABCD

output file for antenna pattern matrix elements A, B, C, D averaged over timestamps

Definition at line 86 of file ComputeAntennaPattern.c.

◆ duration [2/2]

REAL8 UserVariables_t::duration

length of observation in seconds

Definition at line 148 of file FstatMetric_v2.c.

◆ Nseg

INT4 UserVariables_t::Nseg

number of segments to split duration into

Definition at line 149 of file FstatMetric_v2.c.

◆ segmentList

CHAR* UserVariables_t::segmentList

ALTERNATIVE: specify segment file with format: repeated lines <startGPS endGPS duration[h] NumSFTs>".

Definition at line 150 of file FstatMetric_v2.c.

◆ outputMetric

CHAR* UserVariables_t::outputMetric

filename to write metrics into

Definition at line 157 of file FstatMetric_v2.c.

◆ detMotionStr

CHAR* UserVariables_t::detMotionStr

string specifying type of detector-motion to use

Definition at line 159 of file FstatMetric_v2.c.

◆ metricType

INT4 UserVariables_t::metricType

type of metric to compute: 0=phase-metric, 1=F-metric(s), 2=both

Definition at line 161 of file FstatMetric_v2.c.

◆ projection

INT4 UserVariables_t::projection

project metric onto subspace orthogonal to this coordinate-axis (0=none, 1=1st-coordinate axis, ...)

Definition at line 163 of file FstatMetric_v2.c.

◆ coords

LALStringVector* UserVariables_t::coords

list of Doppler-coordinates to compute metric in, see –coordsHelp for possible values

Definition at line 165 of file FstatMetric_v2.c.

◆ coordsHelp

BOOLEAN UserVariables_t::coordsHelp

output help-string explaining all the possible Doppler-coordinate names for –cords

Definition at line 166 of file FstatMetric_v2.c.

◆ approxPhase

BOOLEAN UserVariables_t::approxPhase

use an approximate phase-model, neglecting Roemer delay in spindown coordinates

Definition at line 168 of file FstatMetric_v2.c.

◆ detector

CHAR* UserVariables_t::detector

detector name

Definition at line 62 of file PrintDetectorState.c.

◆ timeGPS [2/2]

REAL8 UserVariables_t::timeGPS

GPS time to compute detector state for (REAL8 format)

Definition at line 70 of file PrintDetectorState.c.

◆ infile1

CHAR* UserVariables_t::infile1

Definition at line 32 of file compareCandidates.c.

◆ infile2

CHAR* UserVariables_t::infile2

Definition at line 33 of file compareCandidates.c.

◆ outfile1

CHAR* UserVariables_t::outfile1

Definition at line 34 of file compareCandidates.c.

◆ outfile2

CHAR* UserVariables_t::outfile2

Definition at line 35 of file compareCandidates.c.

◆ outfile3

CHAR* UserVariables_t::outfile3

Definition at line 36 of file compareCandidates.c.

◆ finalOutfile

CHAR* UserVariables_t::finalOutfile

Definition at line 37 of file compareCandidates.c.

◆ Tobs

REAL8 UserVariables_t::Tobs

Definition at line 38 of file compareCandidates.c.

◆ Tcoh

REAL8 UserVariables_t::Tcoh

Definition at line 39 of file compareCandidates.c.

◆ fdiff_allowed

REAL8 UserVariables_t::fdiff_allowed

Definition at line 40 of file compareCandidates.c.

◆ dfdiff_allowed

REAL8 UserVariables_t::dfdiff_allowed

Definition at line 41 of file compareCandidates.c.

◆ skydiff_allowed

REAL8 UserVariables_t::skydiff_allowed

Definition at line 42 of file compareCandidates.c.

◆ t0

REAL8 UserVariables_t::t0

Definition at line 12 of file computeSignalDetector.c.

◆ alpha

REAL8 UserVariables_t::alpha

Definition at line 16 of file computeSignalDetector.c.

◆ delta

REAL8 UserVariables_t::delta

Definition at line 17 of file computeSignalDetector.c.

◆ skylocations

INT4 UserVariables_t::skylocations

Definition at line 18 of file computeSignalDetector.c.

◆ IFO [2/2]

LALStringVector* UserVariables_t::IFO

Definition at line 19 of file computeSignalDetector.c.

◆ outfilename

CHAR * UserVariables_t::outfilename

Definition at line 20 of file computeSignalDetector.c.

◆ unrestrictedCosi

BOOLEAN UserVariables_t::unrestrictedCosi

Definition at line 23 of file computeSignalDetector.c.

◆ rectWindow

BOOLEAN UserVariables_t::rectWindow

Definition at line 24 of file computeSignalDetector.c.

◆ fspan

REAL8 UserVariables_t::fspan

Definition at line 37 of file skygridsetup.c.

◆ skyRegion

CHAR* UserVariables_t::skyRegion

Definition at line 42 of file skygridsetup.c.

◆ v1

BOOLEAN UserVariables_t::v1

Definition at line 43 of file skygridsetup.c.

◆ Pmin

REAL8 UserVariables_t::Pmin

Definition at line 27 of file TwoSpectTemplateBank.c.

◆ Pmax

REAL8 UserVariables_t::Pmax

Definition at line 28 of file TwoSpectTemplateBank.c.

◆ dfmin

REAL8 UserVariables_t::dfmin

Definition at line 29 of file TwoSpectTemplateBank.c.

◆ dfmax

REAL8 UserVariables_t::dfmax

Definition at line 30 of file TwoSpectTemplateBank.c.

◆ maxVectorLength

INT4 UserVariables_t::maxVectorLength

Definition at line 34 of file TwoSpectTemplateBank.c.

◆ minTemplateLength

INT4 UserVariables_t::minTemplateLength

Definition at line 35 of file TwoSpectTemplateBank.c.

◆ maxTemplateLength

INT4 UserVariables_t::maxTemplateLength

Definition at line 36 of file TwoSpectTemplateBank.c.

◆ vectorMath

INT4 UserVariables_t::vectorMath

Definition at line 37 of file TwoSpectTemplateBank.c.

◆ exactflag

BOOLEAN UserVariables_t::exactflag

Definition at line 38 of file TwoSpectTemplateBank.c.

◆ filename

CHAR* UserVariables_t::filename

Definition at line 39 of file TwoSpectTemplateBank.c.

◆ RAJ

CHAR* UserVariables_t::RAJ

Definition at line 168 of file TEMPOcomparison.c.

◆ DECJ

CHAR* UserVariables_t::DECJ

Definition at line 169 of file TEMPOcomparison.c.

◆ TstartUTCMJD

REAL8 UserVariables_t::TstartUTCMJD

Definition at line 170 of file TEMPOcomparison.c.

◆ TrefTDBMJD

REAL8 UserVariables_t::TrefTDBMJD

Definition at line 171 of file TEMPOcomparison.c.

◆ DeltaTMJD

REAL8 UserVariables_t::DeltaTMJD

Definition at line 172 of file TEMPOcomparison.c.

◆ DurationMJD

REAL8 UserVariables_t::DurationMJD

Definition at line 173 of file TEMPOcomparison.c.

◆ det

CHAR* UserVariables_t::det

Definition at line 174 of file TEMPOcomparison.c.

◆ f0

REAL8 UserVariables_t::f0

Definition at line 177 of file TEMPOcomparison.c.

◆ fdot

REAL8 UserVariables_t::fdot

Definition at line 178 of file TEMPOcomparison.c.

◆ PSRJ

CHAR* UserVariables_t::PSRJ

Definition at line 179 of file TEMPOcomparison.c.

◆ Observatory

CHAR* UserVariables_t::Observatory

Definition at line 180 of file TEMPOcomparison.c.

Detailed Description

Data Fields

Field Documentation

◆ Fname1

◆ Fname2

◆ tol_param

◆ tol_L1

◆ tol_L2

◆ tol_angle

◆ tol_atMax

◆ outSFTbname

◆ outSingleSFT

◆ TDDfile

◆ TDDframedir

◆ frameDesc

◆ hardwareTDD

◆ logfile

◆ timestampsFile

◆ startTime [1/2]

◆ duration [1/2]

◆ generationMode

◆ fmin

◆ Band

◆ Tsft [1/2]

◆ SFToverlap

◆ noiseSFTs

◆ noiseSqrtSh

◆ window

◆ windowParam

◆ IFO [1/2]

◆ actuation

◆ actuationScale

◆ ephemEarth

◆ ephemSun

◆ refTime

◆ h0

◆ cosi

◆ aPlus

◆ aCross

◆ psi

◆ phi0

◆ Alpha

◆ Delta

◆ Freq

◆ f1dot

◆ f2dot

◆ f3dot

◆ orbitasini

◆ orbitEcc

◆ orbitTp

◆ orbitPeriod

◆ orbitArgp

◆ exactSignal

◆ lineFeature

◆ randSeed

◆ parfile

◆ transientWindowType

◆ transientStartTime

◆ transientTauDays

◆ sourceDeltaT

◆ outSFTdir

◆ outLabel

◆ outPubObsRun

◆ outPubRevision

◆ timestampsFiles

◆ IFOs

◆ sqrtSX

◆ outFrameDir

◆ inFrames

◆ inFrChannels

◆ outFrChannels

◆ SFTWindowType

◆ SFTWindowParam

◆ injectionSources

◆ inputData

◆ outputPSD

◆ outputSpectBname

◆ FreqBand

◆ startTime [2/2]

◆ endTime