lalinference.lalinference_pipe_utils Namespace Reference

Data Structures
class	BayesLineJob
	Class for a BayesLine job. More...
class	BayesLineNode
	Run the BayesLine code. More...
class	BayesWavePostJob
	Class for a BayesWavePost job. More...
class	BayesWavePostNode
class	BayesWavePSDJob
	Class for a BayesWave job. More...
class	BayesWavePSDNode
class	CoherenceTestJob
	Class defining the coherence test job to be run as part of a pipeline. More...
class	CoherenceTestNode
	Class defining the node for the coherence test. More...
class	CombineMCMCJob
	Class defining a job which combines several parallel MCMC chains into a single hdf5 file Input arguments: cp - A configparser object containing the setup of the analysis submitFile - Path to store the submit file logdir - A directory to hold the stderr, stdout files of the merge runs. More...
class	CombineMCMCNode
	Class defining the DAG node for a MCMC combine job Input arguments: combine_job = A CombineMCMCJob object parents = iterable of parent LALInferenceMCMC nodes (must have get_ns_file() method) More...
class	EngineJob
class	EngineNode
class	Event
	Represents a unique event to run on. More...
class	EvolveSamplesJob
	Class for evolving the spins of posterior samples. More...
class	EvolveSamplesNode
	Node to evolve spins of posterior samples. More...
class	GraceDBJob
	Class for a gracedb job. More...
class	GraceDBNode
	Run the gracedb executable to report the results. More...
class	LALInferenceBurstNode
class	LALInferenceDAGJob
	Class to define DAG Jobs for lalinference pipeline. More...
class	LALInferenceDAGNode
	Node for LALInference DAG jobs. More...
class	LALInferenceDAGSharedFSJob
class	LALInferenceDataDumpNode
class	LALInferenceMCMCNode
class	LALInferenceNestNode
class	LALInferencePipelineDAG
class	MergeJob
	Class defining a job which merges several parallel nested sampling or MCMC jobs into a single file Input arguments: cp - A configparser object containing the setup of the analysis submitFile - Path to store the submit file logdir - A directory to hold the stderr, stdout files of the merge runs engine - Set to either 'nest' or 'mcmc' for the appropriate behaviour. More...
class	MergeNode
	Class defining the DAG node for a NS merge job Input arguments: merge_job = A MergeJob object parents = iterable of parent LALInferenceNest nodes (must have get_ns_file() method) engine - Set to either 'nest' or 'mcmc' for the appropriate behaviour. More...
class	PESummaryResultsPageJob
	Class to handle the creation of the summary page job using PESummary More...
class	PESummaryResultsPageNode
class	PlotSkyMapJob
	Job to run ligo-skymap-plot. More...
class	PlotSkyMapNode
class	PostRunInfoJob
class	PostRunInfoNode
class	ResultsPageJob
class	ResultsPageNode
class	ROMJob
	Class for a ROM compute weights job. More...
class	ROMNode
	Run the ROM compute weights script. More...
class	SkyMapJob
	Node to run ligo-skymap-from-samples. More...
class	SkyMapNode

Functions
def	findSegmentsToAnalyze (ifo, frametype, state_vector_channel, bits, gpsstart, gpsend)
	Return list of segments whose data quality is good enough for PE. More...
def	guess_url (fslocation)
	Try to work out the web address of a given path. More...
def	create_events_from_coinc_and_psd (coinc_xml_obj, psd_dict=None, gid=None, threshold_snr=None, flow=20.0, roq=False, use_gracedbpsd=False)
	This function calculates seglen, fhigh, srate and horizon distance from coinc.xml and psd.xml.gz from GraceDB and create list of Events as input of pipeline. More...
def	open_pipedown_database (database_filename, tmp_space)
	Open the connection to the pipedown database. More...
def	get_zerolag_lloid (database_connection, dumpfile=None, gpsstart=None, gpsend=None, max_cfar=-1, min_cfar=-1)
	Returns a list of Event objects from pipedown data base. More...
def	get_zerolag_pipedown (database_connection, dumpfile=None, gpsstart=None, gpsend=None, max_cfar=-1, min_cfar=-1)
	Returns a list of Event objects from pipedown data base. More...
def	get_timeslides_pipedown (database_connection, dumpfile=None, gpsstart=None, gpsend=None, max_cfar=-1)
	Returns a list of Event objects with times and timeslide offsets. More...
def	mkdirs (path)
	Helper function. More...
def	chooseEngineNode (name)
def	get_engine_name (cp)
def	scan_timefile (timefile)
def	get_xml_psds (psdxml, ifos, outpath, end_time=None)
	Get a psd.xml.gz file and: 1) Reads it 2) Checks the psd file contains all the IFO we want to analyze 3) Writes down the PSDs into an ascii file for each IFO in psd.xml.gz. More...
def	get_trigger_chirpmass (coinc_xml_obj)
def	get_roq_mchirp_priors (path, roq_paths, roq_params, key, coinc_xml_obj=None, sim_inspiral=None)
def	get_roq_component_mass_priors (path, roq_paths, roq_params, key, coinc_xml_obj=None, sim_inspiral=None)
def	get_roq_mass_freq_scale_factor (mc_priors, trigger_mchirp, force_flow=None)
def	mchirp_from_components (m1, m2)
def	Query_ROQ_Bounds_Type (path, roq_paths)
def	extract_approx (cp)
def	topdir (path)
	Returns the top directory in a path, e.g. More...

Function Documentation

findSegmentsToAnalyze()

def lalinference.lalinference_pipe_utils.findSegmentsToAnalyze	(		ifo,
			frametype,
			state_vector_channel,
			bits,
			gpsstart,
			gpsend
	)

Return list of segments whose data quality is good enough for PE.

The data quality is examined with statevector in frame files. If frame files do not exist, return empty list.

Parameters

ifo: string frametype: string state_vector_channel: string bits: list of string List of bits. This function extracts the data taken when all of the bits in this list are "active" assuming such data is good enough for PE. gpsstart, gpsend: float GPS period to analyse

Definition at line 48 of file lalinference_pipe_utils.py.

guess_url()

def lalinference.lalinference_pipe_utils.guess_url

(

fslocation

)

Try to work out the web address of a given path.

Definition at line 85 of file lalinference_pipe_utils.py.

create_events_from_coinc_and_psd()

def lalinference.lalinference_pipe_utils.create_events_from_coinc_and_psd	(		coinc_xml_obj,
			psd_dict = None,
			gid = None,
			threshold_snr = None,
			flow = 20.0,
			roq = False,
			use_gracedbpsd = False
	)

This function calculates seglen, fhigh, srate and horizon distance from coinc.xml and psd.xml.gz from GraceDB and create list of Events as input of pipeline.

This function is based on Chris Pankow's script.

Parameters

coinc_xml_obj: ligolw.ligolw.Document file object of coinc.xml psd_dict: dictionary of REAL8FrequencySeries PSDs of all the ifos threshold_snr: float snr threshold for detection flow: float lower frequecy cutoff for overlap calculation roq: bool Whether the run uses ROQ or not use_gracedbpsd: bool Whether the gracedb PSD is used or not in PE

Definition at line 210 of file lalinference_pipe_utils.py.

open_pipedown_database()

def lalinference.lalinference_pipe_utils.open_pipedown_database	(		database_filename,
			tmp_space
	)

Open the connection to the pipedown database.

Definition at line 319 of file lalinference_pipe_utils.py.

get_zerolag_lloid()

def lalinference.lalinference_pipe_utils.get_zerolag_lloid	(		database_connection,
			dumpfile = None,
			gpsstart = None,
			gpsend = None,
			max_cfar = -1,
			min_cfar = -1
	)

Returns a list of Event objects from pipedown data base.

Can dump some stats to dumpfile if given, and filter by gpsstart and gpsend to reduce the nunmber or specify max_cfar to select by combined FAR

Definition at line 337 of file lalinference_pipe_utils.py.

get_zerolag_pipedown()

def lalinference.lalinference_pipe_utils.get_zerolag_pipedown	(		database_connection,
			dumpfile = None,
			gpsstart = None,
			gpsend = None,
			max_cfar = -1,
			min_cfar = -1
	)

Returns a list of Event objects from pipedown data base.

Can dump some stats to dumpfile if given, and filter by gpsstart and gpsend to reduce the nunmber or specify max_cfar to select by combined FAR

Definition at line 380 of file lalinference_pipe_utils.py.

get_timeslides_pipedown()

def lalinference.lalinference_pipe_utils.get_timeslides_pipedown	(		database_connection,
			dumpfile = None,
			gpsstart = None,
			gpsend = None,
			max_cfar = -1
	)

Returns a list of Event objects with times and timeslide offsets.

Definition at line 421 of file lalinference_pipe_utils.py.

mkdirs()

def lalinference.lalinference_pipe_utils.mkdirs

(

path

)

Helper function.

Make the given directory, creating intermediate dirs if necessary, and don't complain about it already existing.

Definition at line 472 of file lalinference_pipe_utils.py.

chooseEngineNode()

def lalinference.lalinference_pipe_utils.chooseEngineNode

(

name

)

Definition at line 476 of file lalinference_pipe_utils.py.

get_engine_name()

def lalinference.lalinference_pipe_utils.get_engine_name

(

cp

)

Definition at line 491 of file lalinference_pipe_utils.py.

scan_timefile()

def lalinference.lalinference_pipe_utils.scan_timefile

(

timefile

)

Definition at line 504 of file lalinference_pipe_utils.py.

get_xml_psds()

def lalinference.lalinference_pipe_utils.get_xml_psds	(		psdxml,
			ifos,
			outpath,
			end_time = None
	)

Get a psd.xml.gz file and: 1) Reads it 2) Checks the psd file contains all the IFO we want to analyze 3) Writes down the PSDs into an ascii file for each IFO in psd.xml.gz.

The name of the file contains the trigtime (if given) and the IFO name. Input: psdxml: psd.xml.gz file ifos: list of ifos used for the analysis outpath: path where the ascii PSD will be written to (end_time): trigtime for this event. Will be used a part of the PSD file name

Definition at line 531 of file lalinference_pipe_utils.py.

get_trigger_chirpmass()

def lalinference.lalinference_pipe_utils.get_trigger_chirpmass

(

coinc_xml_obj

)

Definition at line 590 of file lalinference_pipe_utils.py.

get_roq_mchirp_priors()

def lalinference.lalinference_pipe_utils.get_roq_mchirp_priors	(		path,
			roq_paths,
			roq_params,
			key,
			coinc_xml_obj = None,
			sim_inspiral = None
	)

Definition at line 609 of file lalinference_pipe_utils.py.

get_roq_component_mass_priors()

def lalinference.lalinference_pipe_utils.get_roq_component_mass_priors	(		path,
			roq_paths,
			roq_params,
			key,
			coinc_xml_obj = None,
			sim_inspiral = None
	)

Definition at line 643 of file lalinference_pipe_utils.py.

get_roq_mass_freq_scale_factor()

def lalinference.lalinference_pipe_utils.get_roq_mass_freq_scale_factor	(		mc_priors,
			trigger_mchirp,
			force_flow = None
	)

Definition at line 669 of file lalinference_pipe_utils.py.

mchirp_from_components()

def lalinference.lalinference_pipe_utils.mchirp_from_components	(		m1,
			m2
	)

Definition at line 683 of file lalinference_pipe_utils.py.

Query_ROQ_Bounds_Type()

def lalinference.lalinference_pipe_utils.Query_ROQ_Bounds_Type	(		path,
			roq_paths
	)

Definition at line 686 of file lalinference_pipe_utils.py.

extract_approx()

def lalinference.lalinference_pipe_utils.extract_approx

(

cp

)

Definition at line 703 of file lalinference_pipe_utils.py.

topdir()

def lalinference.lalinference_pipe_utils.topdir

(

path

)

Returns the top directory in a path, e.g.

topdir('a/b/c') -> 'a'

Definition at line 2759 of file lalinference_pipe_utils.py.