Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInference 4.1.9.1-5e288d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LALInferenceReadData.c File Reference

Prototypes

static void LALInferenceSetGPSTrigtime (LIGOTimeGPS *GPStrig, ProcessParamsTable *commandLine)
 
struct fvecinterpFromFile (char *filename, REAL8 squareinput)
 
REAL8 interpolate (struct fvec *fvec, REAL8 f)
 
void InjectFD (LALInferenceIFOData *IFOdata, SimInspiralTable *inj_table, ProcessParamsTable *commandLine)
 -----------— Inject in Frequency domain --------------—‍/ More...
 
int enforce_m1_larger_m2 (SimInspiralTable *injEvent)
 
void MetaNoiseFunc (LALStatus *status, REAL8 *psd, REAL8 f, struct fvec *interp, NoiseFunc *noisefunc)
 
static REAL8TimeSeriesreadTseries (LALCache *cache, CHAR *channel, LIGOTimeGPS start, REAL8 length)
 
static void makeWhiteData (LALInferenceIFOData *IFOdata)
 
static void PrintSNRsToFile (LALInferenceIFOData *IFOdata, char SNRpath[])
 
static LALCacheGlobFramesPWD (char *ifo)
 
static INT4 getDataOptionsByDetectors (ProcessParamsTable *commandLine, char ***ifos, char ***caches, char ***channels, char ***flows, char ***fhighs, char ***timeslides, char ***asds, char ***psds, UINT4 *N)
 Parse the command line looking for options of the kind –ifo H1 –H1-channel H1:LDAS_STRAIN –H1-cache H1.cache –H1-flow 20.0 –H1-fhigh 4096.0 –H1-timeslide 100.0 –H1-asd asd_ascii.txt –H1-psd psd_ascii.txt ... It is necessary to use this method instead of the old method for the pipeline to work in DAX mode. More...
 
static INT4 getNamedDataOptionsByDetectors (ProcessParamsTable *commandLine, char ***ifos, char ***out, const char *name, UINT4 *N)
 Parse the command line looking for options of the kind —IFO-name value Unlike the function above, this one does not have a preset list of names to lookup, but instead uses the option "name" It is necessary to use this method instead of the old method for the pipeline to work in DAX mode. More...
 
static void LALInferencePrintDataWithInjection (LALInferenceIFOData *IFOdata, ProcessParamsTable *commandLine)
 
LALInferenceIFODataLALInferenceReadData (ProcessParamsTable *commandLine)
 Read IFO data according to command line arguments. More...
 
void LALInferenceInjectInspiralSignal (LALInferenceIFOData *IFOdata, ProcessParamsTable *commandLine)
 
void LALInferenceInjectionToVariables (SimInspiralTable *theEventTable, LALInferenceVariables *vars)
 Fill the variables passed in vars with the parameters of the injection passed in event will over-write and destroy any existing parameters. More...
 
LALInferenceVariablesLALInferencePrintInjectionSample (LALInferenceRunState *runState)
 Function to output a sample with logL values etc for the injection, if one is made. More...
 
void LALInferenceSetupROQmodel (LALInferenceModel *model, ProcessParamsTable *commandLine)
 
void LALInferenceSetupROQdata (LALInferenceIFOData *IFOdata, ProcessParamsTable *commandLine)
 
void LALInferenceInjectFromMDC (ProcessParamsTable *commandLine, LALInferenceIFOData *IFOdata)
 

Go to the source code of this file.

Data Structures

struct  fvec
 

Macros

#define LALINFERENCE_DEFAULT_FLOW   "20.0"
 
#define USAGE   "\ ----------------------------------------------\n\ --- Data Parameters --------------------------\n\ ----------------------------------------------\n\ Options for reading/generating data. User should specify which interferometers\n\ to use and their data source using the following options. The data source\n\ can be either a LFS cache file (generated by gw_data_find) with channel name\n\ (e.g. --H1-cache H1.cache --H1-channel H1:DCS-CALIB-STRAIN_C02 )\n\ or internally-generated gaussian noise with a given detector PSD model\n\ (e.g. --H1-cache LALSimAdLIGO --dataseed 1234)\n\ or by searching for frame files in the local directory\n\ (e.g. --glob-frame-data --H1-channel H1:DCS-CALIB-STRAIN_C02)\n\ \n\ Additional noise curves for simulated data can be specified by providing\n\ their PSD or ASD as a text file. See detailed options below.\n\ \n\ --ifo IFO1 [--ifo IFO2 ...] IFOs can be H1,L1,V1\n\ --IFO1-cache cache1 Cache files \n\ [--IFO2-cache2 cache2 ...] lal PSDs: LAL{Ad}LIGO, LALVirgo\n\ lalsimuation PSDs: LALSim{Ad}LIGO, LALSim{Ad}Virgo\n\ interpolate from file: interp:asd_file.txt\n\ --psdstart GPStime GPS start time of PSD estimation data\n\ --psdlength length Length of PSD estimation data in seconds\n\ --seglen length Length of segments for PSD estimation and analysis in seconds\n\ (--glob-frame-data) Will search for frame files containing data in the PWD.\n\ Filenames must begin with the IFO's 1-letter code, e.g. H-*.gwf\n\ (--dont-dump-extras) If given, won't save PSD and SNR files\n\ (--dump-geocenter-pols) If given, print out the TD/FD h_plus and h_cross polarisations\n\ (--trigtime GPStime) GPS time of the trigger to analyse\n\ (optional when using --margtime or --margtimephi)\n\ (--segment-start) GPS time of the start of the segment\n\ (optional with --trigtime,\n\ default: seglen-2 s before --trigtime)\n\ (--srate rate) Downsample data to rate in Hz (4096.0,)\n\ (--padding PAD [sec] Override default 0.4 seconds padding\n\ (--injectionsrate rate) Downsample injection signal to rate in Hz (--srate)\n\ (--IFO1-flow freq1 Specify lower frequency cutoff for overlap integral (20.0)\n\ [--IFO2-flow freq2 ...])\n\ (--IFO1-fhigh freq1 Specify higher frequency cutoff for overlap integral (Nyquist\n\ [--IFO2-fhigh freq2 ...]) freq 0.5*srate)\n\ (--IFO1-channel chan1 Specify channel names when reading cache files\n\ [--IFO2-channel chan2 ...])\n\ (--IFO1-asd asd1-ascii.txt Read in ASD from ascii file. This is not equivalent \n\ [--IFO2-asd asd2-ascii.txt ...]) to using --IFO1-cache interp:asd_file.txt since the former\n\ won't use the ascii ASD to generate fake noise. \n\ (--IFO1-psd psd1-ascii.txt Read in PSD from ascii file. This is not equivalent \n\ [--IFO2-psd psd2-ascii.txt ...]) to using --IFO1-cache interp:asd_file.txt since the former\n\ won't use the ascii PSD to generate fake noise. \n\ (--dataseed number) Specify random seed to use when generating data\n\ (--lalinspiralinjection) Enables injections via the LALInspiral package\n\ (--inj-fref) Reference frequency of parameters in injection XML (default 100Hz)\n\ (--inj-lambda1) value of lambda1 to be injected, LALSimulation only (0)\n\ (--inj-lambda2) value of lambda2 to be injected, LALSimulation only (0)\n\ (--inj-lambdaT value of lambdaT to be injected (0)\n\ (--inj-dlambdaT value of dlambdaT to be injected (0)\n\ (--inj-logp1) value of logp1 to be injected\n\ (--inj-gamma1) value of gamma1 to be injected\n\ (--inj-gamma2) value of gamma2 to be injected\n\ (--inj-gamma3) value of gamma3 to be injected\n\ (--inj-SDgamma0) value of SDgamma0 to be injected (0)\n\ (--inj-SDgamma1) value of SDgamma1 to be injected (0)\n\ (--inj-SDgamma2) value of SDgamma2 to be injected (0)\n\ (--inj-SDgamma3) value of SDgamma3 to be injected (0)\n\ (--inj-spinOrder PNorder) Specify twice the injection PN order (e.g. 5 <==> 2.5PN)\n\ of spin effects effects to use, only for LALSimulation\n\ (default: -1 <==> Use all spin effects).\n\ (--inj-tidalOrder PNorder) Specify twice the injection PN order (e.g. 10 <==> 5PN)\n\ of tidal effects to use, only for LALSimulation\n\ (default: -1 <==> Use all tidal effects).\n\ (--inj-spin-frame FRAME Specify injection spin frame: choice of total-j, orbital-l, view.\n\ (Default = OrbitalL).\n\ (--inj-numreldata FileName) Location of NR data file for the injection of NR waveforms (with NR_hdf5 in injection XML file).\n\ (--0noise) Sets the noise realisation to be identically zero\n\ (for the fake caches above only)\n\ \n"
 

Typedefs

typedef void() NoiseFunc(LALStatus *statusPtr, REAL8 *psd, REAL8 f)
 

Variables

static const LALUnit strainPerCount ={0,{0,0,0,0,0,1,-1},{0,0,0,0,0,0,0}}
 

Macro Definition Documentation

◆ LALINFERENCE_DEFAULT_FLOW

#define LALINFERENCE_DEFAULT_FLOW   "20.0"

Definition at line 88 of file LALInferenceReadData.c.

◆ USAGE

#define USAGE   "\ ----------------------------------------------\n\ --- Data Parameters --------------------------\n\ ----------------------------------------------\n\ Options for reading/generating data. User should specify which interferometers\n\ to use and their data source using the following options. The data source\n\ can be either a LFS cache file (generated by gw_data_find) with channel name\n\ (e.g. --H1-cache H1.cache --H1-channel H1:DCS-CALIB-STRAIN_C02 )\n\ or internally-generated gaussian noise with a given detector PSD model\n\ (e.g. --H1-cache LALSimAdLIGO --dataseed 1234)\n\ or by searching for frame files in the local directory\n\ (e.g. --glob-frame-data --H1-channel H1:DCS-CALIB-STRAIN_C02)\n\ \n\ Additional noise curves for simulated data can be specified by providing\n\ their PSD or ASD as a text file. See detailed options below.\n\ \n\ --ifo IFO1 [--ifo IFO2 ...] IFOs can be H1,L1,V1\n\ --IFO1-cache cache1 Cache files \n\ [--IFO2-cache2 cache2 ...] lal PSDs: LAL{Ad}LIGO, LALVirgo\n\ lalsimuation PSDs: LALSim{Ad}LIGO, LALSim{Ad}Virgo\n\ interpolate from file: interp:asd_file.txt\n\ --psdstart GPStime GPS start time of PSD estimation data\n\ --psdlength length Length of PSD estimation data in seconds\n\ --seglen length Length of segments for PSD estimation and analysis in seconds\n\ (--glob-frame-data) Will search for frame files containing data in the PWD.\n\ Filenames must begin with the IFO's 1-letter code, e.g. H-*.gwf\n\ (--dont-dump-extras) If given, won't save PSD and SNR files\n\ (--dump-geocenter-pols) If given, print out the TD/FD h_plus and h_cross polarisations\n\ (--trigtime GPStime) GPS time of the trigger to analyse\n\ (optional when using --margtime or --margtimephi)\n\ (--segment-start) GPS time of the start of the segment\n\ (optional with --trigtime,\n\ default: seglen-2 s before --trigtime)\n\ (--srate rate) Downsample data to rate in Hz (4096.0,)\n\ (--padding PAD [sec] Override default 0.4 seconds padding\n\ (--injectionsrate rate) Downsample injection signal to rate in Hz (--srate)\n\ (--IFO1-flow freq1 Specify lower frequency cutoff for overlap integral (20.0)\n\ [--IFO2-flow freq2 ...])\n\ (--IFO1-fhigh freq1 Specify higher frequency cutoff for overlap integral (Nyquist\n\ [--IFO2-fhigh freq2 ...]) freq 0.5*srate)\n\ (--IFO1-channel chan1 Specify channel names when reading cache files\n\ [--IFO2-channel chan2 ...])\n\ (--IFO1-asd asd1-ascii.txt Read in ASD from ascii file. This is not equivalent \n\ [--IFO2-asd asd2-ascii.txt ...]) to using --IFO1-cache interp:asd_file.txt since the former\n\ won't use the ascii ASD to generate fake noise. \n\ (--IFO1-psd psd1-ascii.txt Read in PSD from ascii file. This is not equivalent \n\ [--IFO2-psd psd2-ascii.txt ...]) to using --IFO1-cache interp:asd_file.txt since the former\n\ won't use the ascii PSD to generate fake noise. \n\ (--dataseed number) Specify random seed to use when generating data\n\ (--lalinspiralinjection) Enables injections via the LALInspiral package\n\ (--inj-fref) Reference frequency of parameters in injection XML (default 100Hz)\n\ (--inj-lambda1) value of lambda1 to be injected, LALSimulation only (0)\n\ (--inj-lambda2) value of lambda2 to be injected, LALSimulation only (0)\n\ (--inj-lambdaT value of lambdaT to be injected (0)\n\ (--inj-dlambdaT value of dlambdaT to be injected (0)\n\ (--inj-logp1) value of logp1 to be injected\n\ (--inj-gamma1) value of gamma1 to be injected\n\ (--inj-gamma2) value of gamma2 to be injected\n\ (--inj-gamma3) value of gamma3 to be injected\n\ (--inj-SDgamma0) value of SDgamma0 to be injected (0)\n\ (--inj-SDgamma1) value of SDgamma1 to be injected (0)\n\ (--inj-SDgamma2) value of SDgamma2 to be injected (0)\n\ (--inj-SDgamma3) value of SDgamma3 to be injected (0)\n\ (--inj-spinOrder PNorder) Specify twice the injection PN order (e.g. 5 <==> 2.5PN)\n\ of spin effects effects to use, only for LALSimulation\n\ (default: -1 <==> Use all spin effects).\n\ (--inj-tidalOrder PNorder) Specify twice the injection PN order (e.g. 10 <==> 5PN)\n\ of tidal effects to use, only for LALSimulation\n\ (default: -1 <==> Use all tidal effects).\n\ (--inj-spin-frame FRAME Specify injection spin frame: choice of total-j, orbital-l, view.\n\ (Default = OrbitalL).\n\ (--inj-numreldata FileName) Location of NR data file for the injection of NR waveforms (with NR_hdf5 in injection XML file).\n\ (--0noise) Sets the noise realisation to be identically zero\n\ (for the fake caches above only)\n\ \n"

Definition at line 492 of file LALInferenceReadData.c.

Typedef Documentation

◆ NoiseFunc

typedef void() NoiseFunc(LALStatus *statusPtr, REAL8 *psd, REAL8 f)

Definition at line 152 of file LALInferenceReadData.c.

Function Documentation

◆ LALInferenceSetGPSTrigtime()

static void LALInferenceSetGPSTrigtime ( LIGOTimeGPS GPStrig,
ProcessParamsTable commandLine 
)
static

Definition at line 2887 of file LALInferenceReadData.c.

◆ interpFromFile()

struct fvec * interpFromFile ( char filename,
REAL8  squareinput 
)

Definition at line 93 of file LALInferenceReadData.c.

◆ interpolate()

REAL8 interpolate ( struct fvec fvec,
REAL8  f 
)

Definition at line 136 of file LALInferenceReadData.c.

◆ InjectFD()

void InjectFD ( LALInferenceIFOData IFOdata,
SimInspiralTable inj_table,
ProcessParamsTable commandLine 
)

-----------— Inject in Frequency domain --------------—‍/

Definition at line 1942 of file LALInferenceReadData.c.

◆ enforce_m1_larger_m2()

int enforce_m1_larger_m2 ( SimInspiralTable injEvent)

Definition at line 2576 of file LALInferenceReadData.c.

◆ MetaNoiseFunc()

void MetaNoiseFunc ( LALStatus status,
REAL8 psd,
REAL8  f,
struct fvec interp,
NoiseFunc noisefunc 
)

Definition at line 155 of file LALInferenceReadData.c.

◆ readTseries()

static REAL8TimeSeries * readTseries ( LALCache cache,
CHAR channel,
LIGOTimeGPS  start,
REAL8  length 
)
static

Definition at line 225 of file LALInferenceReadData.c.

◆ makeWhiteData()

static void makeWhiteData ( LALInferenceIFOData IFOdata)
static

Definition at line 1314 of file LALInferenceReadData.c.

◆ PrintSNRsToFile()

static void PrintSNRsToFile ( LALInferenceIFOData IFOdata,
char  SNRpath[] 
)
static

Definition at line 2353 of file LALInferenceReadData.c.

◆ GlobFramesPWD()

static LALCache * GlobFramesPWD ( char ifo)
static

Definition at line 183 of file LALInferenceReadData.c.

◆ getDataOptionsByDetectors()

static INT4 getDataOptionsByDetectors ( ProcessParamsTable commandLine,
char ***  ifos,
char ***  caches,
char ***  channels,
char ***  flows,
char ***  fhighs,
char ***  timeslides,
char ***  asds,
char ***  psds,
UINT4 N 
)
static

Parse the command line looking for options of the kind –ifo H1 –H1-channel H1:LDAS_STRAIN –H1-cache H1.cache –H1-flow 20.0 –H1-fhigh 4096.0 –H1-timeslide 100.0 –H1-asd asd_ascii.txt –H1-psd psd_ascii.txt ... It is necessary to use this method instead of the old method for the pipeline to work in DAX mode.

Warning: do not mix options between the old and new style.

Definition at line 258 of file LALInferenceReadData.c.

◆ getNamedDataOptionsByDetectors()

static INT4 getNamedDataOptionsByDetectors ( ProcessParamsTable commandLine,
char ***  ifos,
char ***  out,
const char name,
UINT4 N 
)
static

Parse the command line looking for options of the kind —IFO-name value Unlike the function above, this one does not have a preset list of names to lookup, but instead uses the option "name" It is necessary to use this method instead of the old method for the pipeline to work in DAX mode.

Warning: do not mix options between the old and new style. Return 0 if the number of options –IFO-name doesn't much the number of ifos, 1 otherwise. Fills in the pointer out with the values that were found.

Definition at line 338 of file LALInferenceReadData.c.

◆ LALInferencePrintDataWithInjection()

static void LALInferencePrintDataWithInjection ( LALInferenceIFOData IFOdata,
ProcessParamsTable commandLine 
)
static

Definition at line 376 of file LALInferenceReadData.c.

◆ LALInferenceInjectInspiralSignal()

void LALInferenceInjectInspiralSignal ( LALInferenceIFOData IFOdata,
ProcessParamsTable commandLine 
)

< +-polarization waveform

< x-polarization waveform

Definition at line 1382 of file LALInferenceReadData.c.

Variable Documentation

◆ strainPerCount

const LALUnit strainPerCount ={0,{0,0,0,0,0,1,-1},{0,0,0,0,0,0,0}}
static

Definition at line 175 of file LALInferenceReadData.c.