Home       Trees       Indices       Help   
glue
Package glue :: Module pipeline :: Class AnalysisNode
[hide private]
[frames] | no frames]

Class AnalysisNode

source code

CondorDAGNode --+
                |
               AnalysisNode
Known Subclasses:

Contains the methods that allow an object to be built to analyse LIGO data in a Condor DAG.

Instance Methods [hide private]
 
__init__(self) source code
 
calibration(self)
Set the path to the calibration cache file for the given IFO.		 source code
 
calibration_cache_path(self)
Determine the path to the correct calibration cache file to use.		 source code
 
get_calibration(self)
Return the calibration cache file to be used by the DAG.		 source code
 
get_data_end(self)
Get the GPS end time of the data needed by this node.		 source code
 
get_data_start(self)
Get the GPS start time of the data needed by this node.		 source code
 
get_end(self)
Get the GPS end time of the node.		 source code
 
get_ifo(self)
Returns the two letter IFO code for this node.		 source code
 
get_ifo_tag(self)
Returns the IFO tag string		 source code
 
get_input(self)
Get the file that will be passed as input.		 source code
 
get_output(self)
Get the file that will be passed as output.		 source code
 
get_pad_data(self)
Get the GPS start time of the data needed by this node.		 source code
 
get_start(self)
Get the GPS start time of the node.		 source code
 
get_trig_end(self)
Get the trig end time of the node.		 source code
 
get_trig_start(self)
Get the trig start time of the node.		 source code
 
get_user_tag(self)
Returns the usertag string		 source code
 
set_cache(self, filename)
Set the LAL frame cache to to use.		 source code
 
set_data_end(self, time)
Set the GPS end time of the data needed by this analysis node.		 source code
 
set_data_start(self, time)
Set the GPS start time of the data needed by this analysis node.		 source code
 
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.		 source code
 
set_ifo(self, ifo)
Set the ifo name to analyze.		 source code
 
set_ifo_tag(self, ifo_tag, pass_to_command_line=True)
Set the ifo tag that is passed to the analysis code.		 source code
 
set_input(self, filename, pass_to_command_line=True)
Add an input to the node by adding a --input option.		 source code
 
set_output(self, filename, pass_to_command_line=True)
Add an output to the node by adding a --output option.		 source code
 
set_pad_data(self, pad)
Set the GPS start time of the data needed by this analysis node.		 source code
 
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.		 source code
 
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.		 source code
 
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.		 source code
 
set_user_tag(self, usertag, pass_to_command_line=True)
Set the user tag that is passed to the analysis code.		 source code

Inherited from CondorDAGNode: __repr__, add_checkpoint_file, add_checkpoint_macro, add_file_arg, add_file_opt, add_input_file, add_input_macro, add_io_macro, add_macro, add_output_file, add_output_macro, add_parent, add_pegasus_profile, add_post_script_arg, add_pre_script_arg, add_var_arg, add_var_condor_cmd, add_var_opt, finalize, get_args, get_category, get_checkpoint_files, get_cmd_line, get_cmd_tuple_list, get_dax_collapse, get_grid_start, get_input_files, get_name, get_opts, get_output_files, get_pegasus_profile, get_post_script, get_post_script_arg, get_priority, get_retry, get_vds_group, job, set_category, set_dax_collapse, set_grid_start, set_log_file, set_name, set_post_script, set_pre_script, set_priority, set_retry, set_vds_group, write_category, write_input_files, write_job, write_output_files, write_parents, write_post_script, write_pre_script, write_priority, write_vars

Method Details [hide private]

__init__(self)
(Constructor)

source code 
Parameters:
  • job - the CondorJob that this node corresponds to.
Overrides: CondorDAGNode.__init__
(inherited documentation)

calibration(self)

source code 

Set the path to the calibration cache file for the given IFO. During S2 the Hanford 2km IFO had two calibration epochs, so if the start time is during S2, we use the correct cache file.

set_cache(self, filename)

source code 

Set the LAL frame cache to to use. The frame cache is passed to the job with the --frame-cache argument.

Parameters:
  • filename - calibration file to use.

set_data_end(self, time)

source code 

Set the GPS end time of the data needed by this analysis node.

Parameters:
  • time - GPS end time of job.

set_data_start(self, time)

source code 

Set the GPS start time of the data needed by this analysis node.

Parameters:
  • time - GPS start time of job.

set_end(self, time, pass_to_command_line=True)

source code 

Set the GPS end time of the analysis node by setting a --gps-end-time option to the node when it is executed.

Parameters:
  • time - GPS end time of job.

set_ifo(self, ifo)

source code 

Set the ifo name to analyze. If the channel name for the job is defined, then the name of the ifo is prepended to the channel name obtained from the job configuration file and passed with a --channel-name option.

Parameters:
  • ifo - two letter ifo code (e.g. L1, H1 or H2).

set_ifo_tag(self, ifo_tag, pass_to_command_line=True)

source code 

Set the ifo tag that is passed to the analysis code.

Parameters:
  • ifo_tag - a string to identify one or more IFOs

set_input(self, filename, pass_to_command_line=True)

source code 

Add an input to the node by adding a --input option.

Parameters:
  • filename - option argument to pass as input.

set_output(self, filename, pass_to_command_line=True)

source code 

Add an output to the node by adding a --output option.

Parameters:
  • filename - option argument to pass as output.

set_pad_data(self, pad)

source code 

Set the GPS start time of the data needed by this analysis node.

Parameters:
  • time - GPS start time of job.

set_start(self, time, pass_to_command_line=True)

source code 

Set the GPS start time of the analysis node by setting a --gps-start-time option to the node when it is executed.

Parameters:
  • time - GPS start time of job.

set_trig_end(self, time, pass_to_command_line=True)

source code 

Set the trig end time of the analysis node by setting a --trig-end-time option to the node when it is executed.

Parameters:
  • time - trig end time of job.

set_trig_start(self, time, pass_to_command_line=True)

source code 

Set the trig start time of the analysis node by setting a --trig-start-time option to the node when it is executed.

Parameters:
  • time - trig start time of job.

set_user_tag(self, usertag, pass_to_command_line=True)

source code 

Set the user tag that is passed to the analysis code.

Parameters:
  • user_tag - the user tag to identify the job

   Home       Trees       Indices       Help   
glue
Generated by Epydoc 3.0.1 on Tue Dec 12 00:34:20 2017 http://epydoc.sourceforge.net