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
ComputePSD.c File Reference

Compute power spectral densities. More...

Prototypes

int initUserVars (int argc, char *argv[], UserVariables_t *uvar)
 register all "user-variables" More...
 
void LALfwriteSpectrograms (LALStatus *status, const CHAR *bname, const MultiPSDVector *multiPSD)
 Write a multi-PSD into spectrograms for each IFO. More...
 
MultiSFTVectorXLALReadSFTs (ConfigVariables_t *cfg, const UserVariables_t *uvar)
 Load all SFTs according to user-input, returns multi-SFT vector. More...
 
int XLALWriteREAL8FrequencySeries_to_file (const REAL8FrequencySeries *series, const char *fname)
 Write given REAL8FrequencySeries into file. More...
 
int main (int argc, char *argv[])
 

Detailed Description

Compute power spectral densities.

Author
Badri Krishnan, Iraj Gholami, Reinhard Prix, Alicia Sintes, Karl Wette

Definition in file ComputePSD.c.

Go to the source code of this file.

Data Structures

struct  UserVariables_t
 user input variables More...
 
struct  ConfigVariables_t
 Config variables 'derived' from user-input. More...
 

Macros

#define COMPUTEPSDC_ENORM   0
 
#define COMPUTEPSDC_ESUB   1
 
#define COMPUTEPSDC_EARG   2
 
#define COMPUTEPSDC_EBAD   3
 
#define COMPUTEPSDC_EFILE   4
 
#define COMPUTEPSDC_ENULL   5
 
#define COMPUTEPSDC_EMEM   6
 
#define COMPUTEPSDC_MSGENORM   "Normal exit"
 
#define COMPUTEPSDC_MSGESUB   "Subroutine failed"
 
#define COMPUTEPSDC_MSGEARG   "Error parsing arguments"
 
#define COMPUTEPSDC_MSGEBAD   "Bad argument values"
 
#define COMPUTEPSDC_MSGEFILE   "Could not create output file"
 
#define COMPUTEPSDC_MSGENULL   "Null Pointer"
 
#define COMPUTEPSDC_MSGEMEM   "Out of memory"
 
#define TRUE   (1==1)
 
#define FALSE   (1==0)
 

Variables

int vrbflg
 defined in lal/lib/std/LALError.c More...
 

Macro Definition Documentation

◆ COMPUTEPSDC_ENORM

#define COMPUTEPSDC_ENORM   0

Definition at line 58 of file ComputePSD.c.

◆ COMPUTEPSDC_ESUB

#define COMPUTEPSDC_ESUB   1

Definition at line 59 of file ComputePSD.c.

◆ COMPUTEPSDC_EARG

#define COMPUTEPSDC_EARG   2

Definition at line 60 of file ComputePSD.c.

◆ COMPUTEPSDC_EBAD

#define COMPUTEPSDC_EBAD   3

Definition at line 61 of file ComputePSD.c.

◆ COMPUTEPSDC_EFILE

#define COMPUTEPSDC_EFILE   4

Definition at line 62 of file ComputePSD.c.

◆ COMPUTEPSDC_ENULL

#define COMPUTEPSDC_ENULL   5

Definition at line 63 of file ComputePSD.c.

◆ COMPUTEPSDC_EMEM

#define COMPUTEPSDC_EMEM   6

Definition at line 64 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGENORM

#define COMPUTEPSDC_MSGENORM   "Normal exit"

Definition at line 66 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGESUB

#define COMPUTEPSDC_MSGESUB   "Subroutine failed"

Definition at line 67 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGEARG

#define COMPUTEPSDC_MSGEARG   "Error parsing arguments"

Definition at line 68 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGEBAD

#define COMPUTEPSDC_MSGEBAD   "Bad argument values"

Definition at line 69 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGEFILE

#define COMPUTEPSDC_MSGEFILE   "Could not create output file"

Definition at line 70 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGENULL

#define COMPUTEPSDC_MSGENULL   "Null Pointer"

Definition at line 71 of file ComputePSD.c.

◆ COMPUTEPSDC_MSGEMEM

#define COMPUTEPSDC_MSGEMEM   "Out of memory"

Definition at line 72 of file ComputePSD.c.

◆ TRUE

#define TRUE   (1==1)

Definition at line 76 of file ComputePSD.c.

◆ FALSE

#define FALSE   (1==0)

Definition at line 77 of file ComputePSD.c.

Function Documentation

◆ initUserVars()

int initUserVars ( int  argc,
char argv[],
UserVariables_t uvar 
)

register all "user-variables"

Definition at line 298 of file ComputePSD.c.

◆ LALfwriteSpectrograms()

void LALfwriteSpectrograms ( LALStatus status,
const CHAR bname,
const MultiPSDVector multiPSD 
)

Write a multi-PSD into spectrograms for each IFO.

Using gnuplot 'binary' matrix format The filename for each IFO is generated as 'bname-IFO'

Definition at line 467 of file ComputePSD.c.

◆ XLALReadSFTs()

MultiSFTVector * XLALReadSFTs ( ConfigVariables_t cfg,
const UserVariables_t uvar 
)

Load all SFTs according to user-input, returns multi-SFT vector.

Returns
cfg: Returns 'effective' range of SFT-bins [firstBin, lastBin], which which the PSD will be estimated:
  • if the user input {fStart, fBand} then these are loaded from SFTs and directly translated into bins
  • if user input {Freq, FreqBand}, we load a wider frequency-band ADDING running-median/2 on either side from the SFTs, and firstBind, lastBin correspond to {Freq,FreqBand} (rounded to closest bins) Also returns the 'data-segment' for which SFTs were loaded
Parameters
[out]cfgreturn derived configuration info (firstBin, lastBin, segment)
[in]uvarcomplete user-input

Definition at line 575 of file ComputePSD.c.

◆ XLALWriteREAL8FrequencySeries_to_file()

int XLALWriteREAL8FrequencySeries_to_file ( const REAL8FrequencySeries series,
const char fname 
)

Write given REAL8FrequencySeries into file.

Parameters
[in]seriesfrequency-series to write to file
[in]fnamefilename to write into

Definition at line 697 of file ComputePSD.c.

◆ main()

int main ( int  argc,
char argv[] 
)

Definition at line 146 of file ComputePSD.c.

Variable Documentation

◆ vrbflg

int vrbflg
extern

defined in lal/lib/std/LALError.c