Package pylal :: Module pylal_exttrig_llutils :: Class GRB
[hide private]
[frames] | no frames]

Class GRB

source code

object --+
         |
        GRB

Class holding all the infos for a GRB and for setting up a new analysis DAG.

Instance Methods [hide private]
 
__init__(self, grb_name=None, grb_ra=None, grb_de=None, grb_time=None, errorbox=None, sat=None)
Initializes the GRB class with a basic set of information
source code
 
set_paths(self, input_dir=None, main_dir=None, ini_file=None, inj_file=None, config_file=None, condor_log_path=None, log_file=None)
Set paths for this GRB, like the path to the main directory, and the analysis directory
source code
 
get_pylal_dir(self) source code
 
get_lalapps_dir(self) source code
 
get_glue_dir(self) source code
 
set_addresses(self, addresses)
Set adresses for the online notification
source code
 
get_basic_dagname(self)
Construction of the dagname
source code
 
get_time_string(self)
Returns the standard suffix used for plots and html files containing the GPS starttime and the length of the processed data.
source code
 
make_links(self, sourcedir, destdir, list_exec)
Using a list of executables names to make symbolic links rather than copying the files itself.
source code
 
create_exttrig_xml_file(self)
Creates an exttrig xml file with the basic informations of the GRB in it.
source code
 
create_call_datafind_online(self, starttime, endtime, ifo, output_location)
Creates a call to the function 'lalapps_online_datafind' to find the data.
source code
 
create_call_datafind_offline(self, starttime, endtime, ifo, output_location)
Creates a call to the function 'ligo_data_find' to find the data after more than ~2 weeks.
source code
 
run_datafind(self)
Run the datafind command to find the data
source code
 
check_data_to_use(self)
Checking the difference between now and the requested data to indentify if we can use online data or have to use offline data
source code
 
update_inifile(self, list_replacements)
Function to conveniently replace some of the parameters in the ini-file by specific values.
source code
 
get_hipe_arguments(self)
Returns the common part for the call to lalapps_trigger_hipe
source code
 
prepare_inspiral_analysis(self)
Main piece to create and prepare the inspiral analysis
source code
 
prepare_injection_analysis(self) source code
 
prepare_onoff_analysis(self)
Prepare the onoff directory with all needed files and code and prepare the DAG.
source code
 
prepare_lik_analysis(self)
Prepare the likelihood directory with all needed files and code and prepare the DAG.
source code
 
check_analysis_directory(self, dag_key)
Check if the dagman.out file does exist after some while for the dag with 'dag_key'
source code
 
make_cvs_copy(self, files, dest_dir)
Copies all the files given in the list 'files' to dest_dir and creates a file 'cvs_versions.txt' in dest_dir containing the actual CVS version of the files
source code
 
get_html_status(self)
Returns the status of the DAGs of this instance in form of a dictionary.
source code
 
calculate_optimality(self) source code
 
apply_sed_file(self, path, infile, outfile)
Applies the sed file to an in file
source code
 
create_sed_file(self, sedfile)
Creates the replacement sed file that will be used later on several in files.
source code
 
get_code_setup(self)
Returns the setup script used for the current environment
source code
 
create_setup_script(self, dest_dir)
Create a setup script in the directory
source code
 
cleanup(self, path)
Cleanup of the temporary files stored in the main dir to either put them into the GRB directories or into the Auxiliary directory
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, grb_name=None, grb_ra=None, grb_de=None, grb_time=None, errorbox=None, sat=None)
(Constructor)

source code 

Initializes the GRB class with a basic set of information

Parameters:
  • grb_name - the name of the GRB without the term 'GRB' (e.g.: 070201)
  • grb_ra - right ascension of this GRB given in degrees
  • grb_de - declination of this GRB given in degrees
  • grb_time - GPS trigger time of the GRB
  • errorbox - size of the errorbox as stated in Isabel's list
  • sat - Name of the satellite providing those data
Overrides: object.__init__

set_paths(self, input_dir=None, main_dir=None, ini_file=None, inj_file=None, config_file=None, condor_log_path=None, log_file=None)

source code 

Set paths for this GRB, like the path to the main directory, and the analysis directory

Parameters:
  • input_dir - path to the CVS directory
  • main_dir - main directory for the whole online analysis
  • ini_file - the name of the ini-file for the inspiral analysis
  • inj-file - name of the ini-file for the injections
  • config_file - name of the config file used
  • condor_log_path - path to the condor log path
  • log_file - file of the llmonitor log file (usually llmonitor.log)

get_basic_dagname(self)

source code 

Construction of the dagname

Returns:
name of the dagfile without the '.dag'

get_time_string(self)

source code 

Returns the standard suffix used for plots and html files containing the GPS starttime and the length of the processed data. Example: 935460888-51000

Returns:
standard GPS time suffix for file naming

make_links(self, sourcedir, destdir, list_exec)

source code 

Using a list of executables names to make symbolic links rather than copying the files itself.

Parameters:
  • sourcedir - source directory containing the files
  • destdir - destination directory in which the links should go
  • list_exec - list of files to be linked

create_exttrig_xml_file(self)

source code 

Creates an exttrig xml file with the basic informations of the GRB in it. Data given in strings or as float

create_call_datafind_online(self, starttime, endtime, ifo, output_location)

source code 

Creates a call to the function 'lalapps_online_datafind' to find the data. To be used only for data from the last 2 weeks...

create_call_datafind_offline(self, starttime, endtime, ifo, output_location)

source code 

Creates a call to the function 'ligo_data_find' to find the data after more than ~2 weeks. Don't ask me...

prepare_onoff_analysis(self)

source code 

Prepare the onoff directory with all needed files and code and prepare the DAG. Don't start DAG here

Returns:
name of the DAG file

prepare_lik_analysis(self)

source code 

Prepare the likelihood directory with all needed files and code and prepare the DAG. Don't start DAG here

Returns:
name of the DAG file

make_cvs_copy(self, files, dest_dir)

source code 

Copies all the files given in the list 'files' to dest_dir and creates a file 'cvs_versions.txt' in dest_dir containing the actual CVS version of the files

Parameters:
  • files - list of files to be copied from self.input_dir
  • dest_dir - destination directory

get_code_setup(self)

source code 

Returns the setup script used for the current environment

Returns:
path to source file

create_setup_script(self, dest_dir)

source code 

Create a setup script in the directory

Parameters:
  • dest_dir - destination directory

cleanup(self, path)

source code 

Cleanup of the temporary files stored in the main dir to either put them into the GRB directories or into the Auxiliary directory

Parameters:
  • path - path to where to shift the files