Detailed Description

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

Definition at line 1455 of file pipeline.py.

Inherits object.

Inherited by lal.pipeline.LSCDataFindNode, lal.pipeline.LigolwAddNode, lal.pipeline.LigolwCutNode, lal.pipeline.NoopNode, and lal.pipeline.SqliteNode.

Public Member Functions
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.AnalysisNode.__init__ ( self )

Reimplemented in lal.pipeline.LSCDataFindNode, lal.pipeline.LigolwAddNode, lal.pipeline.LigolwCutNode, lal.pipeline.NoopNode, lal.pipeline.SqliteNode, and lal.pipeline.LigolwSqliteNode.

Definition at line 1456 of file pipeline.py.

Member Function Documentation

◆ set_start()

def lal.pipeline.AnalysisNode.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.

Parameters

time	GPS start time of job.
pass_to_command_line	add gps-start-time as variable option.

Reimplemented in lal.pipeline.LSCDataFindNode.

Definition at line 1479 of file pipeline.py.

◆ get_start()

def lal.pipeline.AnalysisNode.get_start ( self )

Get the GPS start time of the node.

Reimplemented in lal.pipeline.LSCDataFindNode.

Definition at line 1490 of file pipeline.py.

◆ set_end()

def lal.pipeline.AnalysisNode.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.

Parameters

time	GPS end time of job.
pass_to_command_line	add gps-end-time as variable option.

Reimplemented in lal.pipeline.LSCDataFindNode.

Definition at line 1499 of file pipeline.py.

◆ get_end()

def lal.pipeline.AnalysisNode.get_end ( self )

Get the GPS end time of the node.

Reimplemented in lal.pipeline.LSCDataFindNode.

Definition at line 1508 of file pipeline.py.

◆ set_data_start()

def lal.pipeline.AnalysisNode.set_data_start	(	self,
		time
	)

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

Parameters

time	GPS start time of job.

Definition at line 1515 of file pipeline.py.

◆ get_data_start()

def lal.pipeline.AnalysisNode.get_data_start ( self )

Get the GPS start time of the data needed by this node.

Definition at line 1521 of file pipeline.py.

◆ set_pad_data()

def lal.pipeline.AnalysisNode.set_pad_data	(	self,
		pad
	)

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

Parameters

pad pad

Definition at line 1528 of file pipeline.py.

◆ get_pad_data()

def lal.pipeline.AnalysisNode.get_pad_data ( self )

Get the GPS start time of the data needed by this node.

Definition at line 1534 of file pipeline.py.

◆ set_data_end()

def lal.pipeline.AnalysisNode.set_data_end	(	self,
		time
	)

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

Parameters

time	GPS end time of job.

Definition at line 1541 of file pipeline.py.

◆ get_data_end()

def lal.pipeline.AnalysisNode.get_data_end ( self )

Get the GPS end time of the data needed by this node.

Definition at line 1547 of file pipeline.py.

◆ set_trig_start()

def lal.pipeline.AnalysisNode.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.

Parameters

time	trig start time of job.
pass_to_command_line	add trig-start-time as a variable option.

Definition at line 1556 of file pipeline.py.

◆ get_trig_start()

def lal.pipeline.AnalysisNode.get_trig_start ( self )

Get the trig start time of the node.

Definition at line 1564 of file pipeline.py.

◆ set_trig_end()

def lal.pipeline.AnalysisNode.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.

Parameters

time	trig end time of job.
pass_to_command_line	add trig-end-time as a variable option.

Definition at line 1573 of file pipeline.py.

◆ get_trig_end()

def lal.pipeline.AnalysisNode.get_trig_end ( self )

Get the trig end time of the node.

Definition at line 1581 of file pipeline.py.

◆ set_input()

def lal.pipeline.AnalysisNode.set_input	(	self,
		filename,
		pass_to_command_line = `True`
	)

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

Parameters

filename	option argument to pass as input.
pass_to_command_line	add input as a variable option.

Definition at line 1589 of file pipeline.py.

◆ get_input()

def lal.pipeline.AnalysisNode.get_input ( self )

Get the file that will be passed as input.

Definition at line 1598 of file pipeline.py.

◆ set_output()

def lal.pipeline.AnalysisNode.set_output	(	self,
		filename,
		pass_to_command_line = `True`
	)

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

Parameters

filename	option argument to pass as output.
pass_to_command_line	add output as a variable option.

Definition at line 1606 of file pipeline.py.

◆ get_output()

def lal.pipeline.AnalysisNode.get_output ( self )

Get the file that will be passed as output.

Reimplemented in lal.pipeline.LSCDataFindNode, and lal.pipeline.LigolwSqliteNode.

Definition at line 1615 of file pipeline.py.

◆ set_ifo()

def lal.pipeline.AnalysisNode.set_ifo	(	self,
		ifo
	)

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).

Definition at line 1624 of file pipeline.py.

◆ get_ifo()

def lal.pipeline.AnalysisNode.get_ifo ( self )

Returns the two letter IFO code for this node.

Definition at line 1632 of file pipeline.py.

◆ set_ifo_tag()

def lal.pipeline.AnalysisNode.set_ifo_tag	(	self,
		ifo_tag,
		pass_to_command_line = `True`
	)

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

Parameters

ifo_tag	a string to identify one or more IFOs
pass_to_command_line	add ifo-tag as a variable option.

Definition at line 1640 of file pipeline.py.

◆ get_ifo_tag()

def lal.pipeline.AnalysisNode.get_ifo_tag ( self )

Returns the IFO tag string.

Definition at line 1648 of file pipeline.py.

◆ set_user_tag()

def lal.pipeline.AnalysisNode.set_user_tag	(	self,
		usertag,
		pass_to_command_line = `True`
	)

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

Parameters

usertag	the user tag to identify the job
pass_to_command_line	add user-tag as a variable option.

Definition at line 1656 of file pipeline.py.

◆ get_user_tag()

def lal.pipeline.AnalysisNode.get_user_tag ( self )

Returns the usertag string.

Definition at line 1664 of file pipeline.py.

◆ set_cache()

def lal.pipeline.AnalysisNode.set_cache	(	self,
		filename
	)

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.

Definition at line 1672 of file pipeline.py.

◆ calibration_cache_path()

def lal.pipeline.AnalysisNode.calibration_cache_path ( self )

Determine the path to the correct calibration cache file to use.

Definition at line 1700 of file pipeline.py.

◆ calibration()

def lal.pipeline.AnalysisNode.calibration ( self )

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.

Definition at line 1727 of file pipeline.py.

◆ get_calibration()

def lal.pipeline.AnalysisNode.get_calibration ( self )

Return the calibration cache file to be used by the DAG.

Definition at line 1741 of file pipeline.py.

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ set_start()

◆ get_start()

◆ set_end()

◆ get_end()

◆ set_data_start()

◆ get_data_start()

◆ set_pad_data()

◆ get_pad_data()

◆ set_data_end()

◆ get_data_end()

◆ set_trig_start()

◆ get_trig_start()

◆ set_trig_end()

◆ get_trig_end()

◆ set_input()

◆ get_input()

◆ set_output()

◆ get_output()

◆ set_ifo()

◆ get_ifo()

◆ set_ifo_tag()

◆ get_ifo_tag()

◆ set_user_tag()

◆ get_user_tag()

◆ set_cache()

◆ calibration_cache_path()

◆ calibration()

◆ get_calibration()

◆ init()