 |
LALApps 10.1.0.1-eeff03c
|
|
|
LALApps 10.1.0.1-eeff03c
|
|
Prototypes | |
| int | arg_parse_check (int argc, char *argv[], ProcessParamsTable *procparams) |
| int | main (int argc, char *argv[]) |
lalapps_tmpltbank — program to generate inspiral template banks.
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]
The following command line arguments are available when running tmpltbank.c \
–alpha alphaSet BCV amplitude correction to alpha.
–approximant approxSets 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 typeCalibrated data of type real_4 or real_8.
–calibration-cache cal_fileObtain calibration from LAL frame cache cal_file.
–candle-mass1 candle_mass1Mass candle_mass1 of first component in candle binary. Must be specified is the option –standard-candle is set.
–candle-mass2 candle_mass2Mass candle_mass2 of second component in candle binary. Must be specified is the option –standard-candle is set.
–candle-snr candle_snrSet the signal-to-noise ratio of standard candle to candle_snr. Must be specified is the option –standard-candle is set.
–channel-name channelRead data from interferometer channel channel.
–comment commentSet the process table comment to comment.
–disable-high-passTurn 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 expSet dynamic range scaling to \({2}^{exp}\).
–enable-high-pass high_freqHigh pass data above high_freq Hz using an IIR filter.
–frame-cache cache_fileThis option is used instead of –glob-frame-data to read frame data from a frame cache file cache_file.
–frame-type typeThis 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_attenSet the attenuation of the high pass filter to geo_atten. Only if –calibrated-data is set to real_8.
–geo-high-pass-freq geo_freqThis 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_orderSet the order of the GEO high pass filter to geo_order. Only if –calibrated-data is set to real_8.
–glob-calibration-dataIs this option is specified, the calibration is obtained by globbing in the working directory.?????????
–glob-frame-dataThis 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_endSet the integer part of the GPS time gps_end you want to stop reading data.
–gps-start-time gps_startSet the integer part of the GPS time gps_start from which you wish to begin reading data.
–helpdisplay the help message which gives brief explanations of the command arguments.
–high-frequency-cutoff cuthighDo not filter above cuthigh Hz.
–high-pass-attenuation high_attenSet the attenuation of the high pass filter to high_atten.
–high-pass-order high_orderSet the order of the high pass filter to high_order.
–low-frequency-cutoff cutlowDo not filter below cutlow Hz.
-maximum-fcut-tmplts maxTempSet the maximum number of templates in fcut direction to maxTemp.
–maximum-mass maxmassSet maximum component mass of bank to maxmass.
–maximum-psi0 psi0maxSet maximum range of BCV parameter psi0 to psi0max.
–maximum-psi3 psi3maxSet maximum range of BCV parameter psi3 to psi3max.
–minimal-match matchSpecifies the minimal match match between templates in the bank and all possible signals in the parameter space.
–minimum-mass minmassSet minimum component mass of bank to minmass.
–minimum-psi0 psi0minSet minimum range of BCV parameter psi0 to psi0min.
–minimum-psi3 psi3minSet minimum range of BCV parameter psi3 to psi3min.
–number-of-segments segnumSet number of data segments to segnum.
–order orderThis 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_padThis 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_typeSet resample filter filter_type to ldas or butterworth. In the normal case the ldas filter is used.
–sample-rate sample_freqSpecifies the sampling frequency sample_freq at which you want to filter the data downsampling if necessary.
–segment-length seglenSet data segment length to seglen points.
–space spaceIn 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_typeUse 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-candleCompute a standard candle from the PSD. In that case the arguments candle-mass1, candle-mass2 and candle-snr must also be specified.
–verboseprint progress information as the code executes.
–versionprint version information and exit without running the tmpltbank code.
–user-tag usertagSet 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-dataWrite raw data to a frame file.
–write-responseWrite the computed response function to a frame.
–write-spectrumWrite the uncalibrated psd to a frame.
–write-strain-spectrumWrite the calibrated strain psd to a text file.
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.
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 } |
| #define CVS_ID_STRING "$Id$" |
Definition at line 352 of file tmpltbank.c.
| #define CVS_NAME_STRING "$Name$" |
Definition at line 353 of file tmpltbank.c.
| #define CVS_REVISION "$Revision$" |
Definition at line 354 of file tmpltbank.c.
| #define CVS_SOURCE "$Source$" |
Definition at line 355 of file tmpltbank.c.
| #define CVS_DATE "$Date$" |
Definition at line 356 of file tmpltbank.c.
| #define PROGRAM_NAME "tmpltbank" |
Definition at line 357 of file tmpltbank.c.
| #define ADD_PROCESS_PARAM | ( | pptype, | |
| format, | |||
| ppvalue | |||
| ) |
Definition at line 1333 of file tmpltbank.c.
| #define USAGE | ( | a | ) |
Definition at line 1343 of file tmpltbank.c.
| anonymous enum |
| Enumerator | |
|---|---|
| undefined | |
| real_4 | |
| real_8 | |
Definition at line 362 of file tmpltbank.c.
| anonymous enum |
| Enumerator | |
|---|---|
| specType_mean | |
| specType_median | |
| specType_simulated | |
| specType_undefined | |
Definition at line 373 of file tmpltbank.c.
| int arg_parse_check | ( | int | argc, |
| char * | argv[], | ||
| ProcessParamsTable * | procparams | ||
| ) |
Definition at line 1447 of file tmpltbank.c.
Definition at line 478 of file tmpltbank.c.
| enum { ... } calData |
| enum { ... } specType |
|
extern |
defined in lal/lib/std/LALError.c
| LIGOTimeGPS gpsStartTime = { 0, 0 } |
Definition at line 392 of file tmpltbank.c.
| LIGOTimeGPS gpsEndTime = { 0, 0 } |
Definition at line 393 of file tmpltbank.c.
| INT4 padData = 0 |
Definition at line 394 of file tmpltbank.c.
| CHAR* fqChanName = NULL |
Definition at line 395 of file tmpltbank.c.
| INT4 globFrameData = 0 |
Definition at line 396 of file tmpltbank.c.
| CHAR* frInCacheName = NULL |
Definition at line 397 of file tmpltbank.c.
| CHAR* frInType = NULL |
Definition at line 398 of file tmpltbank.c.
| INT4 numPoints = -1 |
Definition at line 399 of file tmpltbank.c.
| INT4 numSegments = -1 |
Definition at line 400 of file tmpltbank.c.
| CHAR ifo[3] |
Definition at line 401 of file tmpltbank.c.
| CHAR* channelName = NULL |
Definition at line 402 of file tmpltbank.c.
| INT4 inputDataLength = 0 |
Definition at line 403 of file tmpltbank.c.
| INT4 resampFiltType = -1 |
Definition at line 404 of file tmpltbank.c.
| INT4 sampleRate = -1 |
Definition at line 405 of file tmpltbank.c.
| INT4 highPass = -1 |
Definition at line 406 of file tmpltbank.c.
| REAL4 highPassFreq = 0 |
Definition at line 407 of file tmpltbank.c.
| INT4 highPassOrder = -1 |
Definition at line 408 of file tmpltbank.c.
| REAL4 highPassAtten = -1 |
Definition at line 409 of file tmpltbank.c.
| REAL4 fLow = -1 |
Definition at line 410 of file tmpltbank.c.
| CHAR* calCacheName = NULL |
Definition at line 411 of file tmpltbank.c.
| INT4 globCalData = 0 |
Definition at line 412 of file tmpltbank.c.
| INT4 pointCal = 0 |
Definition at line 413 of file tmpltbank.c.
| REAL4 dynRangeExponent = 0 |
Definition at line 414 of file tmpltbank.c.
| REAL4 strainHighPassFreq = -1 |
Definition at line 415 of file tmpltbank.c.
| INT4 strainHighPassOrder = -1 |
Definition at line 416 of file tmpltbank.c.
| REAL4 strainHighPassAtten = -1 |
Definition at line 417 of file tmpltbank.c.
Definition at line 418 of file tmpltbank.c.
| REAL4 minMass = -1 |
Definition at line 421 of file tmpltbank.c.
| REAL4 maxMass = -1 |
Definition at line 422 of file tmpltbank.c.
| REAL4 minTotalMass = -1 |
Definition at line 423 of file tmpltbank.c.
| REAL4 maxTotalMass = -1 |
Definition at line 424 of file tmpltbank.c.
| REAL4 chirpMassCutoff = -1 |
Definition at line 425 of file tmpltbank.c.
| REAL4 etaMinCutoff = -1 |
Definition at line 426 of file tmpltbank.c.
| REAL4 etaMaxCutoff = -1 |
Definition at line 427 of file tmpltbank.c.
| REAL4 psi0Min = 0 |
Definition at line 428 of file tmpltbank.c.
| REAL4 psi0Max = 0 |
Definition at line 429 of file tmpltbank.c.
| REAL4 psi3Min = 0 |
Definition at line 430 of file tmpltbank.c.
| REAL4 psi3Max = 0 |
Definition at line 431 of file tmpltbank.c.
| REAL4 alpha = 0 |
Definition at line 432 of file tmpltbank.c.
| REAL4 betaMin = 0 |
Definition at line 433 of file tmpltbank.c.
| REAL4 betaMax = 0 |
Definition at line 434 of file tmpltbank.c.
| INT4 maxFcutTmplts = -1 |
Definition at line 435 of file tmpltbank.c.
| REAL4 minMatch = -1 |
Definition at line 436 of file tmpltbank.c.
| REAL4 fUpper = -1 |
Definition at line 437 of file tmpltbank.c.
| REAL4 chiMin = 0.0 |
Definition at line 438 of file tmpltbank.c.
| REAL4 chiMax = 1.0 |
Definition at line 439 of file tmpltbank.c.
| REAL4 kappaMin = -1.0 |
Definition at line 440 of file tmpltbank.c.
| REAL4 kappaMax = 1.0 |
Definition at line 441 of file tmpltbank.c.
| INT4 nPointsChi = 3 |
Definition at line 442 of file tmpltbank.c.
| INT4 nPointsKappa = 5 |
Definition at line 443 of file tmpltbank.c.
| LALPNOrder order |
Definition at line 444 of file tmpltbank.c.
Definition at line 445 of file tmpltbank.c.
| CoordinateSpace space |
Definition at line 446 of file tmpltbank.c.
| INT4 haveGridSpacing = 0 |
Definition at line 447 of file tmpltbank.c.
| INT4 computeMoments = 1 |
Definition at line 448 of file tmpltbank.c.
| FreqCut maxFreqCut |
Definition at line 449 of file tmpltbank.c.
| FreqCut minFreqCut |
Definition at line 450 of file tmpltbank.c.
| INT4 numFreqCut = 0 |
Definition at line 451 of file tmpltbank.c.
| GridSpacing gridSpacing = SquareNotOriented |
Definition at line 453 of file tmpltbank.c.
| int polygonFit = 1 |
Definition at line 454 of file tmpltbank.c.
| INT4 computeCandle = 0 |
Definition at line 457 of file tmpltbank.c.
| REAL4 candleSnr = -1 |
Definition at line 458 of file tmpltbank.c.
| REAL4 candleMinMass = -1 |
Definition at line 459 of file tmpltbank.c.
| REAL4 candleMaxMass = 50 |
Definition at line 460 of file tmpltbank.c.
| CHAR** tdFileNames = NULL |
Definition at line 463 of file tmpltbank.c.
| INT4 numTDFiles = 0 |
Definition at line 464 of file tmpltbank.c.
| CHAR* userTag = NULL |
Definition at line 467 of file tmpltbank.c.
| CHAR* ifoTag = NULL |
Definition at line 468 of file tmpltbank.c.
| int writeRawData = 0 |
Definition at line 469 of file tmpltbank.c.
| int writeResponse = 0 |
Definition at line 470 of file tmpltbank.c.
| int writeSpectrum = 0 |
Definition at line 471 of file tmpltbank.c.
| int writeStrainSpec = 0 |
Definition at line 472 of file tmpltbank.c.
| INT4 outCompress = 0 |
Definition at line 473 of file tmpltbank.c.
| CHAR comment[LIGOMETA_COMMENT_MAX] |
Definition at line 476 of file tmpltbank.c.
1.9.4