Detailed Description

Structure specifying an SFT file name, following the convention in [4] .

Definition at line 266 of file SFTfileIO.h.

Data Fields
CHAR	path [4096]
	Path to the SFT file. More...

CHAR	extn [32]
	Extension of the SFT file; defaults to 'sft'. More...

UINT4	numSFTs
	Number of SFTs in the file; set by `XLALWriteSFT`[Vector]2StandardFile() More...

CHAR	detector [3]
	2-character detector prefix (e.g. More...

UINT4	SFTtimebase
	Timebase in seconds of the SFT; set by `XLALWriteSFT`[Vector]2StandardFile() More...

CHAR	window_type [32]
	window function applied to SFT More...

REAL8	window_param
	parameter of window function, if required More...

UINT4	gpsStart
	GPS time in seconds at the beginning of the first SFT in the file; set by `XLALWriteSFT`[Vector]2StandardFile() More...

UINT4	SFTspan
	Total time interval in seconds covered by SFT file; set by `XLALWriteSFT`[Vector]2StandardFile() More...

CHAR	privMisc [256]
	For private SFTs: miscellaneous description field. More...

UINT4	pubObsRun
	For public SFTs: observing run number. More...

CHAR	pubObsKind [4]
	For public SFTs: kind of data ('RUN', 'AUX', 'SIM', 'DEV') More...

UINT4	pubRevision
	For public SFTs: revision number of SFT production. More...

CHAR	pubChannel [256]
	For public SFTs: channel name of data used to make SFTs. More...

UINT4	nbFirstBinFreq
	For narrow-band SFTs: SFT first bin frequency divided by SFT time base, rounded down. More...

UINT4	nbFirstBinRem
	For narrow-band SFTs: remainder of division of SFT first bin frequency by SFT time base. More...

UINT4	nbBinWidthFreq
	For narrow-band SFTs: SFT bandwidth divided by SFT time base, rounded down. More...

UINT4	nbBinWidthRem
	For narrow-band SFTs: remainder of division of SFT bandwidth by SFT time base. More...

Field Documentation

◆ path

CHAR SFTFilenameSpec::path[4096]

Path to the SFT file.

Definition at line 267 of file SFTfileIO.h.

◆ extn

CHAR SFTFilenameSpec::extn[32]

Extension of the SFT file; defaults to 'sft'.

Definition at line 268 of file SFTfileIO.h.

◆ numSFTs

UINT4 SFTFilenameSpec::numSFTs

Number of SFTs in the file; set by XLALWriteSFT[Vector]2StandardFile()

Definition at line 269 of file SFTfileIO.h.

◆ detector

CHAR SFTFilenameSpec::detector[3]

2-character detector prefix (e.g.

'H1', 'L1', 'V1'); set by XLALWriteSFT[Vector]2StandardFile()

Definition at line 270 of file SFTfileIO.h.

◆ SFTtimebase

UINT4 SFTFilenameSpec::SFTtimebase

Timebase in seconds of the SFT; set by XLALWriteSFT[Vector]2StandardFile()

Definition at line 271 of file SFTfileIO.h.

◆ window_type

CHAR SFTFilenameSpec::window_type[32]

window function applied to SFT

Definition at line 272 of file SFTfileIO.h.

◆ window_param

REAL8 SFTFilenameSpec::window_param

parameter of window function, if required

Definition at line 273 of file SFTfileIO.h.

◆ gpsStart

UINT4 SFTFilenameSpec::gpsStart

GPS time in seconds at the beginning of the first SFT in the file; set by XLALWriteSFT[Vector]2StandardFile()

Definition at line 274 of file SFTfileIO.h.

◆ SFTspan

UINT4 SFTFilenameSpec::SFTspan

Total time interval in seconds covered by SFT file; set by XLALWriteSFT[Vector]2StandardFile()

Definition at line 275 of file SFTfileIO.h.

◆ privMisc

CHAR SFTFilenameSpec::privMisc[256]

For private SFTs: miscellaneous description field.

Definition at line 276 of file SFTfileIO.h.

◆ pubObsRun

UINT4 SFTFilenameSpec::pubObsRun

For public SFTs: observing run number.

Definition at line 277 of file SFTfileIO.h.

◆ pubObsKind

CHAR SFTFilenameSpec::pubObsKind[4]

For public SFTs: kind of data ('RUN', 'AUX', 'SIM', 'DEV')

Definition at line 278 of file SFTfileIO.h.

◆ pubRevision

UINT4 SFTFilenameSpec::pubRevision

For public SFTs: revision number of SFT production.

Definition at line 279 of file SFTfileIO.h.

◆ pubChannel

CHAR SFTFilenameSpec::pubChannel[256]

For public SFTs: channel name of data used to make SFTs.

Definition at line 280 of file SFTfileIO.h.

◆ nbFirstBinFreq

UINT4 SFTFilenameSpec::nbFirstBinFreq

For narrow-band SFTs: SFT first bin frequency divided by SFT time base, rounded down.

Definition at line 281 of file SFTfileIO.h.

◆ nbFirstBinRem

UINT4 SFTFilenameSpec::nbFirstBinRem

For narrow-band SFTs: remainder of division of SFT first bin frequency by SFT time base.

Definition at line 282 of file SFTfileIO.h.

◆ nbBinWidthFreq

UINT4 SFTFilenameSpec::nbBinWidthFreq

For narrow-band SFTs: SFT bandwidth divided by SFT time base, rounded down.

Definition at line 283 of file SFTfileIO.h.

◆ nbBinWidthRem

UINT4 SFTFilenameSpec::nbBinWidthRem

For narrow-band SFTs: remainder of division of SFT bandwidth by SFT time base.

Definition at line 284 of file SFTfileIO.h.