lal.pipeline.ScienceSegment Class Reference

Detailed Description

A ScienceSegment is a period of time where the experimenters determine that the inteferometer is in a state where the data is suitable for scientific analysis.

A science segment can have a list of AnalysisChunks asscociated with it that break the segment up into (possibly overlapping) smaller time intervals for analysis.

Definition at line 1849 of file pipeline.py.

Inherits object.

Public Member Functions
def	__init__ (self, segment)
def	__getitem__ (self, i)
	Allows iteration over and direct access to the AnalysisChunks contained in this ScienceSegment. More...
def	__len__ (self)
	Returns the number of AnalysisChunks contained in this ScienceSegment. More...
def	__repr__ (self)
def	__cmp__ (self, other)
	ScienceSegments are compared by the GPS start time of the segment. More...
def	make_chunks (self, length=0, overlap=0, play=0, sl=0, excl_play=0, pad_data=0)
	Divides the science segment into chunks of length seconds overlapped by overlap seconds. More...
def	add_chunk (self, start, end, trig_start=0, trig_end=0)
	Add an AnalysisChunk to the list associated with this ScienceSegment. More...
def	unused (self)
	Returns the length of data in the science segment not used to make chunks. More...
def	set_unused (self, unused)
	Set the length of data in the science segment not used to make chunks. More...
def	id (self)
	Returns the ID of this ScienceSegment. More...
def	start (self)
	Returns the GPS start time of this ScienceSegment. More...
def	end (self)
	Returns the GPS end time of this ScienceSegment. More...
def	set_start (self, t)
	Override the GPS start time (and set the duration) of this ScienceSegment. More...
def	set_end (self, t)
	Override the GPS end time (and set the duration) of this ScienceSegment. More...
def	dur (self)
	Returns the length (duration) in seconds of this ScienceSegment. More...
def	set_df_node (self, df_node)
	Set the DataFind node associated with this ScienceSegment to df_node. More...
def	get_df_node (self)
	Returns the DataFind node for this ScienceSegment. More...

Constructor & Destructor Documentation

__init__()

def lal.pipeline.ScienceSegment.__init__	(		self,
			segment
	)

Parameters

segment

a tuple containing the (segment id, gps start time, gps end time, duration) of the segment.

Definition at line 1854 of file pipeline.py.

Member Function Documentation

__getitem__()

def lal.pipeline.ScienceSegment.__getitem__	(		self,
			i
	)

Allows iteration over and direct access to the AnalysisChunks contained in this ScienceSegment.

Definition at line 1868 of file pipeline.py.

__len__()

def lal.pipeline.ScienceSegment.__len__

(

self

)

Returns the number of AnalysisChunks contained in this ScienceSegment.

Definition at line 1875 of file pipeline.py.

__repr__()

def lal.pipeline.ScienceSegment.__repr__

(

self

)

Definition at line 1878 of file pipeline.py.

__cmp__()

def lal.pipeline.ScienceSegment.__cmp__	(		self,
			other
	)

ScienceSegments are compared by the GPS start time of the segment.

Definition at line 1885 of file pipeline.py.

make_chunks()

def lal.pipeline.ScienceSegment.make_chunks	(		self,
			length = 0,
			overlap = 0,
			play = 0,
			sl = 0,
			excl_play = 0,
			pad_data = 0
	)

Divides the science segment into chunks of length seconds overlapped by overlap seconds.

If the play option is set, only chunks that contain S2 playground data are generated. If the user has a more complicated way of generating chunks, this method should be overriden in a sub-class. Any data at the end of the ScienceSegment that is too short to contain a chunk is ignored. The length of this unused data is stored and can be retrieved with the unused() method.

Parameters

length	length of chunk in seconds.
overlap	overlap between chunks in seconds.
play	1 : only generate chunks that overlap with S2 playground data. 2 : as play = 1 plus compute trig start and end times to coincide with the start/end of the playground
sl	slide by sl seconds before determining playground data.
excl_play	exclude the first excl_play second from the start and end of the chunk when computing if the chunk overlaps with playground.
pad_data	exclude the first and last pad_data seconds of the segment when generating chunks

Definition at line 1907 of file pipeline.py.

add_chunk()

def lal.pipeline.ScienceSegment.add_chunk	(		self,
			start,
			end,
			trig_start = 0,
			trig_end = 0
	)

Add an AnalysisChunk to the list associated with this ScienceSegment.

Parameters

start	GPS start time of chunk.
end	GPS end time of chunk.
trig_start	GPS start time for triggers from chunk
trig_end	trig_end

Definition at line 1945 of file pipeline.py.

unused()

def lal.pipeline.ScienceSegment.unused

(

self

)

Returns the length of data in the science segment not used to make chunks.

Definition at line 1951 of file pipeline.py.

set_unused()

def lal.pipeline.ScienceSegment.set_unused	(		self,
			unused
	)

Set the length of data in the science segment not used to make chunks.

Definition at line 1957 of file pipeline.py.

id()

def lal.pipeline.ScienceSegment.id

(

self

)

Returns the ID of this ScienceSegment.

Definition at line 1963 of file pipeline.py.

start()

def lal.pipeline.ScienceSegment.start

(

self

)

Returns the GPS start time of this ScienceSegment.

Definition at line 1969 of file pipeline.py.

end()

def lal.pipeline.ScienceSegment.end

(

self

)

Returns the GPS end time of this ScienceSegment.

Definition at line 1975 of file pipeline.py.

set_start()

def lal.pipeline.ScienceSegment.set_start	(		self,
			t
	)

Override the GPS start time (and set the duration) of this ScienceSegment.

Parameters

t	new GPS start time.

Definition at line 1982 of file pipeline.py.

set_end()

def lal.pipeline.ScienceSegment.set_end	(		self,
			t
	)

Override the GPS end time (and set the duration) of this ScienceSegment.

Parameters

t	new GPS end time.

Definition at line 1990 of file pipeline.py.

dur()

def lal.pipeline.ScienceSegment.dur

(

self

)

Returns the length (duration) in seconds of this ScienceSegment.

Definition at line 1997 of file pipeline.py.

set_df_node()

def lal.pipeline.ScienceSegment.set_df_node	(		self,
			df_node
	)

Set the DataFind node associated with this ScienceSegment to df_node.

Parameters

df_node

the DataFind node for this ScienceSegment.

Definition at line 2004 of file pipeline.py.

get_df_node()

def lal.pipeline.ScienceSegment.get_df_node

(

self

)

Returns the DataFind node for this ScienceSegment.

Definition at line 2010 of file pipeline.py.