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

Prototypes

int main (int argc, char *argv[])
 

Detailed Description

Name

lalapps_splitbank — splits a template bank file into several smaller files

Synopsis

lalapps_splitbank –bank-file file –comment comment –help –minimal-match m –number-of-banks n –user-tag comment –verbose –version

Description

lalapps_splitbank splits a LIGO_LW XML file containing inspiral templates in a sngl_inspiral table into several smaller bank files. This allows a template bank to be split across several inspiral jobs and then recombined with lalapps_inca or lalapps_sire.

The name of the output template bank files is derived from the name of the input bank file and the number of files that the bank should be split into. For example, if the input bank file:\

H1-TRIGBANK_L1-729330491-2048.xml\

is split into 3 output files, then these will be named:\

H1-TRIGBANK_L1_00-729330491-2048.xml\ H1-TRIGBANK_L1_01-729330491-2048.xml\ H1-TRIGBANK_L1_02-729330491-2048.xml\

The naming convention is to insert the bank file number after the usertag part of the filename and before the GPS start time part of the file name.

In the case that the input file contains no templates, empty output bank files are generated. This is done since DAGman does not implement decision rules yet, so the nodes in the DAG must be identical regardless of the data flowing through them.

Options
–bank-file file

Read the templates from the sngl_inspiral table in the file file.

–comment comment

Add the string comment to the process table in the output XML file.

–help

Display a usage message and exit.

–minimal-match m

Set the minimal match of the output template bank file to m. This option is not really needed for running lalapps_splitbank, it just put that value of m for the minimal match in all splited template banks.

–number-of-banks n

Split the input template banks into n seperate output bank files.

–user-tag comment

Set the user tag to the string comment. 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.

–verbose

Print debugging information to the standard output while executing.

–version
Print the CVS id and exit.

Example
lalapps_splitbank --bank-file L1-TMPLTBANK-732488741-2048.xml \
--number-of-banks 3 --minimal-match 0.97
REAL4 number

Algorithm

lalapps_splitbank counts the number of templates in the input file. It increments this by one and divides by the number of template banks to generate using standard integer division. This gives the upper limit on the number of templates in a single output file.

Author
Duncan Brown and Alexander Dietz

Definition in file splitbank.c.

Go to the source code of this file.

Macros

#define CVS_ID_STRING   "$Id$"
 
#define CVS_REVISION   "$Revision$"
 
#define CVS_SOURCE   "$Source$"
 
#define CVS_DATE   "$Date$"
 
#define PROGRAM_NAME   "splitbank"
 
#define USAGE
 

Variables

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

Macro Definition Documentation

◆ CVS_ID_STRING

#define CVS_ID_STRING   "$Id$"

Definition at line 153 of file splitbank.c.

◆ CVS_REVISION

#define CVS_REVISION   "$Revision$"

Definition at line 154 of file splitbank.c.

◆ CVS_SOURCE

#define CVS_SOURCE   "$Source$"

Definition at line 155 of file splitbank.c.

◆ CVS_DATE

#define CVS_DATE   "$Date$"

Definition at line 156 of file splitbank.c.

◆ PROGRAM_NAME

#define PROGRAM_NAME   "splitbank"

Definition at line 157 of file splitbank.c.

◆ USAGE

#define USAGE
Value:
"Usage: %s [options] [LIGOLW XML input files]\n\n"\
" --help display this message\n"\
" --verbose print progress information\n"\
" --version print version information\n"\
" --user-tag STRING set the process_params usertag to STRING\n"\
" --comment STRING set the process table comment to STRING\n"\
"\n"\
" --bank-file FILE read template bank parameters from FILE\n"\
" --number-of-banks N split template bank into N files\n"\
" --minimal-match M set minimal match of triggered bank to M\n"\

Definition at line 159 of file splitbank.c.

Function Documentation

◆ main()

int main ( int  argc,
char argv[] 
)

Definition at line 174 of file splitbank.c.

Variable Documentation

◆ vrbflg

int vrbflg
extern

defined in lal/lib/std/LALError.c