Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALApps 10.1.0.1-8a6b96f
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
tmpltbank.c File Reference

Prototypes

int arg_parse_check (int argc, char *argv[], ProcessParamsTable *procparams)
 
int main (int argc, char *argv[])
 

Detailed Description

Name

lalapps_tmpltbank — program to generate inspiral template banks.

Synopsis

lalapps_tmpltbank [–help] [–verbose] [–version] [–user-tag usertag] [–comment comment] –gps-start-time gps_start –gps-end-time gps_end [–pad-data time_pad] [–glob-frame-data] [–frame-type type] [–frame-cache cache_file] –calibration-cache cal_file –glob-calibration-data –channel-name channel [–calibrated-data cal_type] [–geo-high-pass-freq geo_freq] [–geo-high-pass-order geo_order] [–geo-high-pass-atten geo_atten] –sample-rate sample_freq –resample-filter filter_type [–disable-high-pass] [–enable-high-pass high_freq] [–high-pass-order high_order] [–high-pass-attenuation high_atten] –spectrum-type spectype [–dynamic-range-exponent exp] –segment-length seglen [–number-of-segments segnum] [–standard-candle] [–candle-snr candle_snr] [–candle-mass1 candle_mass1] [–candle-mass2 candle_mass2] –low-frequency-cutoff cutlow –high-frequency-cutoff cuthigh [–minimum-mass minmass] [–maximum-mass maxmass] [–minimum-psi0 psi0min] [–maximum-psi0 psi0max] [–minimum-psi3 psi3min] [–maximum-psi3 psi3max] [–maximum-fcut-tmplts maxTemp] [–alpha alpha] –minimal-match match –order order –approximant approx –space space [–write-raw-data] [–write-response] [–write-spectrum] [–write-strain-spectrum]

Options

The following command line arguments are available when running tmpltbank.c \

–alpha alpha

Set BCV amplitude correction to alpha.

–approximant approx

Sets the approximant of the waveform to approx. TaylorT2 is the standard stationary phase frequency domain chirp used in the BNS search. Available parameters: TaylorT1, TaylorT2, TaylorT3, TaylorF1, TaylorF2, PadeT1, PadeF1, EOB, BCV, SpinTaylorT3, BCVSpin.

–calibrated-data type

Calibrated data of type real_4 or real_8.

–calibration-cache cal_file

Obtain calibration from LAL frame cache cal_file.

–candle-mass1 candle_mass1

Mass candle_mass1 of first component in candle binary. Must be specified is the option –standard-candle is set.

–candle-mass2 candle_mass2

Mass candle_mass2 of second component in candle binary. Must be specified is the option –standard-candle is set.

–candle-snr candle_snr

Set the signal-to-noise ratio of standard candle to candle_snr. Must be specified is the option –standard-candle is set.

–channel-name channel

Read data from interferometer channel channel.

–comment comment

Set the process table comment to comment.

–disable-high-pass

Turn off the IIR highpass filter. This is an optimistc option. Someday the data will be so good we won't need high pass filtering!

–dynamic-range-exponent exp

Set dynamic range scaling to \({2}^{exp}\).

–enable-high-pass high_freq

High pass data above high_freq Hz using an IIR filter.

–frame-cache cache_file

This option is used instead of –glob-frame-data to read frame data from a frame cache file cache_file.

–frame-type type

This option specified the type of frames containing the input data. This option must be specified with the –glob-frame-data option.???????????

–geo-high-pass-atten geo_atten

Set the attenuation of the high pass filter to geo_atten. Only if –calibrated-data is set to real_8.

–geo-high-pass-freq geo_freq

This sets the high pass filter frequency for GEO data above geo_freq Hz using an IIR filter. Only if –calibrated-data is set to real_8.

–geo-high-pass-order geo_order

Set the order of the GEO high pass filter to geo_order. Only if –calibrated-data is set to real_8.

–glob-calibration-data

Is this option is specified, the calibration is obtained by globbing in the working directory.?????????

–glob-frame-data

This option along with –frame-type can be used instead of –frame-cache to read data stored locally in the working directory. It finds files of the specified frame type with a *.gwf extension.

–gps-end-time gps_end

Set the integer part of the GPS time gps_end you want to stop reading data.

–gps-start-time gps_start

Set the integer part of the GPS time gps_start from which you wish to begin reading data.

–help

display the help message which gives brief explanations of the command arguments.

–high-frequency-cutoff cuthigh

Do not filter above cuthigh Hz.

–high-pass-attenuation high_atten

Set the attenuation of the high pass filter to high_atten.

–high-pass-order high_order

Set the order of the high pass filter to high_order.

–low-frequency-cutoff cutlow

Do not filter below cutlow Hz.

-maximum-fcut-tmplts maxTemp

Set the maximum number of templates in fcut direction to maxTemp.

–maximum-mass maxmass

Set maximum component mass of bank to maxmass.

–maximum-psi0 psi0max

Set maximum range of BCV parameter psi0 to psi0max.

–maximum-psi3 psi3max

Set maximum range of BCV parameter psi3 to psi3max.

–minimal-match match

Specifies the minimal match match between templates in the bank and all possible signals in the parameter space.

–minimum-mass minmass

Set minimum component mass of bank to minmass.

–minimum-psi0 psi0min

Set minimum range of BCV parameter psi0 to psi0min.

–minimum-psi3 psi3min

Set minimum range of BCV parameter psi3 to psi3min.

–number-of-segments segnum

Set number of data segments to segnum.

–order order

This sets the order of the waveform to order. Usually it is set to twoPN (second order post newtonian). Available parameters: newtonian, oneHalfPN, onePN, onePointFivePN, twoPN, twoPointFivePN, threePN, threePointFivePN.

–pad-data time_pad

This flag specifies an amount of time time_pad to add to the beginning and end of the input time series data. Padding the data is necessary because resampling and filtering corrupts these portions. 8 seconds is the accepted choice for this paramenter. See LAL documentation for a description of resampling and high pass filtering.

–resample-filter filter_type

Set resample filter filter_type to ldas or butterworth. In the normal case the ldas filter is used.

–sample-rate sample_freq

Specifies the sampling frequency sample_freq at which you want to filter the data downsampling if necessary.

–segment-length seglen

Set data segment length to seglen points.

–space space

In order to make the template bank coordinates nice and friendly these parameters are used instead of masses. Usually Tau0Tau3 is used. Available parameters: Tau0Tau2, Tau0Tau3, Psi0Psi3.

–spectrum-type spec_type

Use PSD estimator spec_type mean or median to choose how the average is calculated. Since the median average is less affected by a loud glitch median is used generally.

–standard-candle

Compute a standard candle from the PSD. In that case the arguments candle-mass1, candle-mass2 and candle-snr must also be specified.

–verbose

print progress information as the code executes.

–version

print version information and exit without running the tmpltbank code.

–user-tag usertag

Set the user tag to the string usertag. This string must not contain spaces or dashes ("-"). This string will appear in the name of the file to which output information is written, and is recorded in the various XML tables within the file.

–write-raw-data

Write raw data to a frame file.

–write-response

Write the computed response function to a frame.

–write-spectrum

Write the uncalibrated psd to a frame.

–write-strain-spectrum

Write the calibrated strain psd to a text file.

Description

lalapps_tmpltbank is a stand alone code for generating inspiral template banks for LIGO or GEO data with the LAL bank package. The code generates a calibrated power spectrum at the specified time for the requested channel and uses this to compute the template bank. The number of templates and the values of the bank parameters in the bank also depend on the minimal match, the minimum and maximum values of mass1 and mass2 (for the BNS search) or the minimum and maximum values of psi0, psi3, the bank-alpha and the number of fcut values (for the BCV search), which are all command-line arguments. Other necessary pieces of information are the approximant and its order and the space that the template bank will be laid on. The output of the code is an xml file and the bank is contained in a sngl_inspiral table. The code has also the capability of outputing the raw data, the response function and the calibrated and unclibrated power spectra to frame files. See the LAL bank package documentation for detailed information on the algorithms used to generate the template banks.

Example

lalapps_tmpltbank \
--gps-start-time 734357353 --gps-end-time 734358377 \
--frame-cache cache/L-734357345-734361107.cache \
--segment-length 1048576 --number-of-segments 7 \
--pad-data 7 --sample-rate 4096 --resample-filter ldas \
--enable-high-pass 5.000000e+01 --spectrum-type median
--low-frequency-cutoff 7.000000e+01 --high-frequency-cutoff 2.048000e+03 \
--minimum-mass 1.000000e+00 --maximum-mass 3.000000e+00 \
--minimal-match 9.700000e-01 --calibration-cache \
/ldas_outgoing/calibration/cache_files/L1-CAL-V03-729273600-734367600.cache \
--channel-name L1:LSC-AS_Q
REAL4 number
#define L(i, j)
REAL8 cutoff(qfvars *vars, REAL8 accx, REAL8 *upn)
sigmaKerr data[0]
enable
Tau0Tau3
TaylorT1
char name[LIGOMETA_SOURCE_MAX]
Definition: inspinj.c:561
type
frequency
time
start
char * channel
LALPNOrder order
Definition: tmpltbank.c:444
CoordinateSpace space
Definition: tmpltbank.c:446
int resample(REAL4TimeSeries *series, REAL8 srate)
Definition: view.c:470
int filter(REAL4TimeSeries *series, REAL8 minfreq, REAL8 maxfreq)
Definition: view.c:479

Author
Duncan Brown and Alexander Dietz

Definition in file tmpltbank.c.

Go to the source code of this file.

Macros

#define CVS_ID_STRING   "$Id$"
 
#define CVS_NAME_STRING   "$Name$"
 
#define CVS_REVISION   "$Revision$"
 
#define CVS_SOURCE   "$Source$"
 
#define CVS_DATE   "$Date$"
 
#define PROGRAM_NAME   "tmpltbank"
 
#define ADD_PROCESS_PARAM(pptype, format, ppvalue)
 
#define USAGE(a)
 

Enumerations

enum  { undefined , real_4 , real_8 }
 
enum  { specType_mean , specType_median , specType_simulated , specType_undefined }
 

Variables

enum { ... }  calData = undefined
 
enum { ... }  specType = specType_undefined
 
int vrbflg
 defined in lal/lib/std/LALError.c More...
 
LIGOTimeGPS gpsStartTime = { 0, 0 }
 
LIGOTimeGPS gpsEndTime = { 0, 0 }
 
INT4 padData = 0
 
CHARfqChanName = NULL
 
INT4 globFrameData = 0
 
CHARfrInCacheName = NULL
 
CHARfrInType = NULL
 
INT4 numPoints = -1
 
INT4 numSegments = -1
 
CHAR ifo [3]
 
CHARchannelName = NULL
 
INT4 inputDataLength = 0
 
INT4 resampFiltType = -1
 
INT4 sampleRate = -1
 
INT4 highPass = -1
 
REAL4 highPassFreq = 0
 
INT4 highPassOrder = -1
 
REAL4 highPassAtten = -1
 
REAL4 fLow = -1
 
CHARcalCacheName = NULL
 
INT4 globCalData = 0
 
INT4 pointCal = 0
 
REAL4 dynRangeExponent = 0
 
REAL4 strainHighPassFreq = -1
 
INT4 strainHighPassOrder = -1
 
REAL4 strainHighPassAtten = -1
 
REAL8(* specFunc )(REAL8) = NULL
 
REAL4 minMass = -1
 
REAL4 maxMass = -1
 
REAL4 minTotalMass = -1
 
REAL4 maxTotalMass = -1
 
REAL4 chirpMassCutoff = -1
 
REAL4 etaMinCutoff = -1
 
REAL4 etaMaxCutoff = -1
 
REAL4 psi0Min = 0
 
REAL4 psi0Max = 0
 
REAL4 psi3Min = 0
 
REAL4 psi3Max = 0
 
REAL4 alpha = 0
 
REAL4 betaMin = 0
 
REAL4 betaMax = 0
 
INT4 maxFcutTmplts = -1
 
REAL4 minMatch = -1
 
REAL4 fUpper = -1
 
REAL4 chiMin = 0.0
 
REAL4 chiMax = 1.0
 
REAL4 kappaMin = -1.0
 
REAL4 kappaMax = 1.0
 
INT4 nPointsChi = 3
 
INT4 nPointsKappa = 5
 
LALPNOrder order
 
Approximant approximant
 
CoordinateSpace space
 
INT4 haveGridSpacing = 0
 
INT4 computeMoments = 1
 
FreqCut maxFreqCut
 
FreqCut minFreqCut
 
INT4 numFreqCut = 0
 
GridSpacing gridSpacing = SquareNotOriented
 
int polygonFit = 1
 
INT4 computeCandle = 0
 
REAL4 candleSnr = -1
 
REAL4 candleMinMass = -1
 
REAL4 candleMaxMass = 50
 
CHAR ** tdFileNames = NULL
 
INT4 numTDFiles = 0
 
CHARuserTag = NULL
 
CHARifoTag = NULL
 
int writeRawData = 0
 
int writeResponse = 0
 
int writeSpectrum = 0
 
int writeStrainSpec = 0
 
INT4 outCompress = 0
 
CHAR comment [LIGOMETA_COMMENT_MAX]
 

Macro Definition Documentation

◆ CVS_ID_STRING

#define CVS_ID_STRING   "$Id$"

Definition at line 352 of file tmpltbank.c.

◆ CVS_NAME_STRING

#define CVS_NAME_STRING   "$Name$"

Definition at line 353 of file tmpltbank.c.

◆ CVS_REVISION

#define CVS_REVISION   "$Revision$"

Definition at line 354 of file tmpltbank.c.

◆ CVS_SOURCE

#define CVS_SOURCE   "$Source$"

Definition at line 355 of file tmpltbank.c.

◆ CVS_DATE

#define CVS_DATE   "$Date$"

Definition at line 356 of file tmpltbank.c.

◆ PROGRAM_NAME

#define PROGRAM_NAME   "tmpltbank"

Definition at line 357 of file tmpltbank.c.

◆ ADD_PROCESS_PARAM

#define ADD_PROCESS_PARAM (   pptype,
  format,
  ppvalue 
)
Value:
this_proc_param = this_proc_param->next = (ProcessParamsTable *) \
calloc( 1, sizeof(ProcessParamsTable) );\
snprintf( this_proc_param->program, LIGOMETA_PROGRAM_MAX, "%s", \
snprintf( this_proc_param->param, LIGOMETA_PARAM_MAX, "--%s", \
long_options[option_index].name );\
snprintf( this_proc_param->type, LIGOMETA_TYPE_MAX, "%s", pptype );\
snprintf( this_proc_param->value, LIGOMETA_VALUE_MAX, format, ppvalue );
#define PROGRAM_NAME
Definition: tmpltbank.c:357

Definition at line 1333 of file tmpltbank.c.

◆ USAGE

#define USAGE (   a)

Definition at line 1343 of file tmpltbank.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
undefined 
real_4 
real_8 

Definition at line 362 of file tmpltbank.c.

◆ anonymous enum

anonymous enum
Enumerator
specType_mean 
specType_median 
specType_simulated 
specType_undefined 

Definition at line 373 of file tmpltbank.c.

Function Documentation

◆ arg_parse_check()

int arg_parse_check ( int  argc,
char argv[],
ProcessParamsTable procparams 
)

Definition at line 1447 of file tmpltbank.c.

◆ main()

int main ( int  argc,
char argv[] 
)

Definition at line 478 of file tmpltbank.c.

Variable Documentation

◆ 

enum { ... } calData

◆ 

enum { ... } specType

◆ vrbflg

int vrbflg
extern

defined in lal/lib/std/LALError.c

◆ gpsStartTime

LIGOTimeGPS gpsStartTime = { 0, 0 }

Definition at line 392 of file tmpltbank.c.

◆ gpsEndTime

LIGOTimeGPS gpsEndTime = { 0, 0 }

Definition at line 393 of file tmpltbank.c.

◆ padData

INT4 padData = 0

Definition at line 394 of file tmpltbank.c.

◆ fqChanName

CHAR* fqChanName = NULL

Definition at line 395 of file tmpltbank.c.

◆ globFrameData

INT4 globFrameData = 0

Definition at line 396 of file tmpltbank.c.

◆ frInCacheName

CHAR* frInCacheName = NULL

Definition at line 397 of file tmpltbank.c.

◆ frInType

CHAR* frInType = NULL

Definition at line 398 of file tmpltbank.c.

◆ numPoints

INT4 numPoints = -1

Definition at line 399 of file tmpltbank.c.

◆ numSegments

INT4 numSegments = -1

Definition at line 400 of file tmpltbank.c.

◆ ifo

CHAR ifo[3]

Definition at line 401 of file tmpltbank.c.

◆ channelName

CHAR* channelName = NULL

Definition at line 402 of file tmpltbank.c.

◆ inputDataLength

INT4 inputDataLength = 0

Definition at line 403 of file tmpltbank.c.

◆ resampFiltType

INT4 resampFiltType = -1

Definition at line 404 of file tmpltbank.c.

◆ sampleRate

INT4 sampleRate = -1

Definition at line 405 of file tmpltbank.c.

◆ highPass

INT4 highPass = -1

Definition at line 406 of file tmpltbank.c.

◆ highPassFreq

REAL4 highPassFreq = 0

Definition at line 407 of file tmpltbank.c.

◆ highPassOrder

INT4 highPassOrder = -1

Definition at line 408 of file tmpltbank.c.

◆ highPassAtten

REAL4 highPassAtten = -1

Definition at line 409 of file tmpltbank.c.

◆ fLow

REAL4 fLow = -1

Definition at line 410 of file tmpltbank.c.

◆ calCacheName

CHAR* calCacheName = NULL

Definition at line 411 of file tmpltbank.c.

◆ globCalData

INT4 globCalData = 0

Definition at line 412 of file tmpltbank.c.

◆ pointCal

INT4 pointCal = 0

Definition at line 413 of file tmpltbank.c.

◆ dynRangeExponent

REAL4 dynRangeExponent = 0

Definition at line 414 of file tmpltbank.c.

◆ strainHighPassFreq

REAL4 strainHighPassFreq = -1

Definition at line 415 of file tmpltbank.c.

◆ strainHighPassOrder

INT4 strainHighPassOrder = -1

Definition at line 416 of file tmpltbank.c.

◆ strainHighPassAtten

REAL4 strainHighPassAtten = -1

Definition at line 417 of file tmpltbank.c.

◆ specFunc

REAL8(* specFunc) (REAL8) ( REAL8  ) = NULL

Definition at line 418 of file tmpltbank.c.

◆ minMass

REAL4 minMass = -1

Definition at line 421 of file tmpltbank.c.

◆ maxMass

REAL4 maxMass = -1

Definition at line 422 of file tmpltbank.c.

◆ minTotalMass

REAL4 minTotalMass = -1

Definition at line 423 of file tmpltbank.c.

◆ maxTotalMass

REAL4 maxTotalMass = -1

Definition at line 424 of file tmpltbank.c.

◆ chirpMassCutoff

REAL4 chirpMassCutoff = -1

Definition at line 425 of file tmpltbank.c.

◆ etaMinCutoff

REAL4 etaMinCutoff = -1

Definition at line 426 of file tmpltbank.c.

◆ etaMaxCutoff

REAL4 etaMaxCutoff = -1

Definition at line 427 of file tmpltbank.c.

◆ psi0Min

REAL4 psi0Min = 0

Definition at line 428 of file tmpltbank.c.

◆ psi0Max

REAL4 psi0Max = 0

Definition at line 429 of file tmpltbank.c.

◆ psi3Min

REAL4 psi3Min = 0

Definition at line 430 of file tmpltbank.c.

◆ psi3Max

REAL4 psi3Max = 0

Definition at line 431 of file tmpltbank.c.

◆ alpha

REAL4 alpha = 0

Definition at line 432 of file tmpltbank.c.

◆ betaMin

REAL4 betaMin = 0

Definition at line 433 of file tmpltbank.c.

◆ betaMax

REAL4 betaMax = 0

Definition at line 434 of file tmpltbank.c.

◆ maxFcutTmplts

INT4 maxFcutTmplts = -1

Definition at line 435 of file tmpltbank.c.

◆ minMatch

REAL4 minMatch = -1

Definition at line 436 of file tmpltbank.c.

◆ fUpper

REAL4 fUpper = -1

Definition at line 437 of file tmpltbank.c.

◆ chiMin

REAL4 chiMin = 0.0

Definition at line 438 of file tmpltbank.c.

◆ chiMax

REAL4 chiMax = 1.0

Definition at line 439 of file tmpltbank.c.

◆ kappaMin

REAL4 kappaMin = -1.0

Definition at line 440 of file tmpltbank.c.

◆ kappaMax

REAL4 kappaMax = 1.0

Definition at line 441 of file tmpltbank.c.

◆ nPointsChi

INT4 nPointsChi = 3

Definition at line 442 of file tmpltbank.c.

◆ nPointsKappa

INT4 nPointsKappa = 5

Definition at line 443 of file tmpltbank.c.

◆ order

LALPNOrder order

Definition at line 444 of file tmpltbank.c.

◆ approximant

Definition at line 445 of file tmpltbank.c.

◆ space

Definition at line 446 of file tmpltbank.c.

◆ haveGridSpacing

INT4 haveGridSpacing = 0

Definition at line 447 of file tmpltbank.c.

◆ computeMoments

INT4 computeMoments = 1

Definition at line 448 of file tmpltbank.c.

◆ maxFreqCut

FreqCut maxFreqCut

Definition at line 449 of file tmpltbank.c.

◆ minFreqCut

FreqCut minFreqCut

Definition at line 450 of file tmpltbank.c.

◆ numFreqCut

INT4 numFreqCut = 0

Definition at line 451 of file tmpltbank.c.

◆ gridSpacing

Definition at line 453 of file tmpltbank.c.

◆ polygonFit

int polygonFit = 1

Definition at line 454 of file tmpltbank.c.

◆ computeCandle

INT4 computeCandle = 0

Definition at line 457 of file tmpltbank.c.

◆ candleSnr

REAL4 candleSnr = -1

Definition at line 458 of file tmpltbank.c.

◆ candleMinMass

REAL4 candleMinMass = -1

Definition at line 459 of file tmpltbank.c.

◆ candleMaxMass

REAL4 candleMaxMass = 50

Definition at line 460 of file tmpltbank.c.

◆ tdFileNames

CHAR** tdFileNames = NULL

Definition at line 463 of file tmpltbank.c.

◆ numTDFiles

INT4 numTDFiles = 0

Definition at line 464 of file tmpltbank.c.

◆ userTag

CHAR* userTag = NULL

Definition at line 467 of file tmpltbank.c.

◆ ifoTag

CHAR* ifoTag = NULL

Definition at line 468 of file tmpltbank.c.

◆ writeRawData

int writeRawData = 0

Definition at line 469 of file tmpltbank.c.

◆ writeResponse

int writeResponse = 0

Definition at line 470 of file tmpltbank.c.

◆ writeSpectrum

int writeSpectrum = 0

Definition at line 471 of file tmpltbank.c.

◆ writeStrainSpec

int writeStrainSpec = 0

Definition at line 472 of file tmpltbank.c.

◆ outCompress

INT4 outCompress = 0

Definition at line 473 of file tmpltbank.c.

◆ comment

Definition at line 476 of file tmpltbank.c.