Loading [MathJax]/extensions/TeX/AMSsymbols.js
LAL 7.7.0.1-5e288d3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
lal.pipeline.SqliteNode Class Reference

Detailed Description

A cbc sqlite node adds to the standard AnalysisNode features common to nodes which read or write to a sqlite database.

Specifically, it adds the set_tmp_space_path and set_database methods.

Definition at line 3007 of file pipeline.py.

Inherits lal.pipeline.CondorDAGNode, and lal.pipeline.AnalysisNode.

Inherited by lal.pipeline.LigolwSqliteNode.

Public Member Functions

def __init__ (self, job)
 
def set_tmp_space (self, tmp_space)
 Sets temp-space path. More...
 
def get_tmp_space (self)
 Gets tmp-space path. More...
 
def set_database (self, database)
 Sets database option. More...
 
def get_database (self)
 Gets database option. More...
 
- Public Member Functions inherited from lal.pipeline.CondorDAGNode
def __init__ (self, job)
 
def __repr__ (self)
 
def job (self)
 Return the CondorJob that this node is associated with. More...
 
def set_pre_script (self, script)
 Sets the name of the pre script that is executed before the DAG node is run. More...
 
def add_pre_script_arg (self, arg)
 Adds an argument to the pre script that is executed before the DAG node is run. More...
 
def set_post_script (self, script)
 Sets the name of the post script that is executed before the DAG node is run. More...
 
def get_post_script (self)
 returns the name of the post script that is executed before the DAG node is run. More...
 
def add_post_script_arg (self, arg)
 Adds an argument to the post script that is executed before the DAG node is run. More...
 
def get_post_script_arg (self)
 Returns and array of arguments to the post script that is executed before the DAG node is run. More...
 
def set_name (self, name)
 Set the name for this node in the DAG. More...
 
def get_name (self)
 Get the name for this node in the DAG. More...
 
def set_category (self, category)
 Set the category for this node in the DAG. More...
 
def get_category (self)
 Get the category for this node in the DAG. More...
 
def set_priority (self, priority)
 Set the priority for this node in the DAG. More...
 
def get_priority (self)
 Get the priority for this node in the DAG. More...
 
def add_input_file (self, filename)
 Add filename as a necessary input file for this DAG node. More...
 
def add_output_file (self, filename)
 Add filename as a output file for this DAG node. More...
 
def add_checkpoint_file (self, filename)
 Add filename as a checkpoint file for this DAG node. More...
 
def get_input_files (self)
 Return list of input files for this DAG node and its job. More...
 
def get_output_files (self)
 Return list of output files for this DAG node and its job. More...
 
def get_checkpoint_files (self)
 Return a list of checkpoint files for this DAG node and its job. More...
 
def set_vds_group (self, group)
 Set the name of the VDS group key when generating a DAX. More...
 
def get_vds_group (self)
 Returns the VDS group key for this node. More...
 
def add_macro (self, name, value)
 Add a variable (macro) for this node. More...
 
def add_io_macro (self, io, filename)
 Add a variable (macro) for storing the input/output files associated with this node. More...
 
def add_input_macro (self, filename)
 Add a variable (macro) for storing the input files associated with this node. More...
 
def add_output_macro (self, filename)
 Add a variable (macro) for storing the output files associated with this node. More...
 
def add_checkpoint_macro (self, filename)
 
def get_opts (self)
 Return the opts for this node. More...
 
def add_var_condor_cmd (self, command, value)
 Add a variable (macro) condor command for this node. More...
 
def add_var_opt (self, opt, value, short=False)
 Add a variable (macro) option for this node. More...
 
def add_file_opt (self, opt, filename, file_is_output_file=False)
 Add a variable (macro) option for this node. More...
 
def add_var_arg (self, arg, quote=False)
 Add a variable (or macro) argument to the condor job. More...
 
def add_file_arg (self, filename)
 Add a variable (or macro) file name argument to the condor job. More...
 
def get_args (self)
 Return the arguments for this node. More...
 
def set_retry (self, retry)
 Set the number of times that this node in the DAG should retry. More...
 
def get_retry (self)
 Return the number of times that this node in the DAG should retry. More...
 
def write_job (self, fh)
 Write the DAG entry for this node's job to the DAG file descriptor. More...
 
def write_category (self, fh)
 Write the DAG entry for this node's category to the DAG file descriptor. More...
 
def write_priority (self, fh)
 Write the DAG entry for this node's priority to the DAG file descriptor. More...
 
def write_vars (self, fh)
 Write the variable (macro) options and arguments to the DAG file descriptor. More...
 
def write_parents (self, fh)
 Write the parent/child relations for this job to the DAG file descriptor. More...
 
def write_pre_script (self, fh)
 Write the pre script for the job, if there is one. More...
 
def write_post_script (self, fh)
 Write the post script for the job, if there is one. More...
 
def write_input_files (self, fh)
 Write as a comment into the DAG file the list of input files for this DAG node. More...
 
def write_output_files (self, fh)
 Write as a comment into the DAG file the list of output files for this DAG node. More...
 
def set_log_file (self, log)
 Set the Condor log file to be used by this CondorJob. More...
 
def add_parent (self, node)
 Add a parent to this node. More...
 
def get_cmd_tuple_list (self)
 Return a list of tuples containg the command line arguments. More...
 
def get_cmd_line (self)
 Return the full command line that will be used when this node is run by DAGman. More...
 
def finalize (self)
 The finalize method of a node is called before the node is finally added to the DAG and can be overridden to do any last minute clean up (such as setting extra command line arguments) More...
 
- Public Member Functions inherited from lal.pipeline.AnalysisNode
def __init__ (self)
 
def set_start (self, time, pass_to_command_line=True)
 Set the GPS start time of the analysis node by setting a –gps-start-time option to the node when it is executed. More...
 
def get_start (self)
 Get the GPS start time of the node. More...
 
def set_end (self, time, pass_to_command_line=True)
 Set the GPS end time of the analysis node by setting a –gps-end-time option to the node when it is executed. More...
 
def get_end (self)
 Get the GPS end time of the node. More...
 
def set_data_start (self, time)
 Set the GPS start time of the data needed by this analysis node. More...
 
def get_data_start (self)
 Get the GPS start time of the data needed by this node. More...
 
def set_pad_data (self, pad)
 Set the GPS start time of the data needed by this analysis node. More...
 
def get_pad_data (self)
 Get the GPS start time of the data needed by this node. More...
 
def set_data_end (self, time)
 Set the GPS end time of the data needed by this analysis node. More...
 
def get_data_end (self)
 Get the GPS end time of the data needed by this node. More...
 
def set_trig_start (self, time, pass_to_command_line=True)
 Set the trig start time of the analysis node by setting a –trig-start-time option to the node when it is executed. More...
 
def get_trig_start (self)
 Get the trig start time of the node. More...
 
def set_trig_end (self, time, pass_to_command_line=True)
 Set the trig end time of the analysis node by setting a –trig-end-time option to the node when it is executed. More...
 
def get_trig_end (self)
 Get the trig end time of the node. More...
 
def set_input (self, filename, pass_to_command_line=True)
 Add an input to the node by adding a –input option. More...
 
def get_input (self)
 Get the file that will be passed as input. More...
 
def set_output (self, filename, pass_to_command_line=True)
 Add an output to the node by adding a –output option. More...
 
def get_output (self)
 Get the file that will be passed as output. More...
 
def set_ifo (self, ifo)
 Set the ifo name to analyze. More...
 
def get_ifo (self)
 Returns the two letter IFO code for this node. More...
 
def set_ifo_tag (self, ifo_tag, pass_to_command_line=True)
 Set the ifo tag that is passed to the analysis code. More...
 
def get_ifo_tag (self)
 Returns the IFO tag string. More...
 
def set_user_tag (self, usertag, pass_to_command_line=True)
 Set the user tag that is passed to the analysis code. More...
 
def get_user_tag (self)
 Returns the usertag string. More...
 
def set_cache (self, filename)
 Set the LAL frame cache to to use. More...
 
def calibration_cache_path (self)
 Determine the path to the correct calibration cache file to use. More...
 
def calibration (self)
 Set the path to the calibration cache file for the given IFO. More...
 
def get_calibration (self)
 Return the calibration cache file to be used by the DAG. More...
 

Constructor & Destructor Documentation

◆ __init__()

def lal.pipeline.SqliteNode.__init__ (   self,
  job 
)
Parameters
joban Sqlite job

Reimplemented from lal.pipeline.CondorDAGNode.

Reimplemented in lal.pipeline.LigolwSqliteNode.

Definition at line 3011 of file pipeline.py.

Member Function Documentation

◆ set_tmp_space()

def lal.pipeline.SqliteNode.set_tmp_space (   self,
  tmp_space 
)

Sets temp-space path.

This should be on a local disk.

Parameters
tmp_spacetmp_space

Definition at line 3021 of file pipeline.py.

◆ get_tmp_space()

def lal.pipeline.SqliteNode.get_tmp_space (   self)

Gets tmp-space path.

Definition at line 3028 of file pipeline.py.

◆ set_database()

def lal.pipeline.SqliteNode.set_database (   self,
  database 
)

Sets database option.

Parameters
databasedatabase

Definition at line 3035 of file pipeline.py.

◆ get_database()

def lal.pipeline.SqliteNode.get_database (   self)

Gets database option.

Definition at line 3042 of file pipeline.py.