Home       Trees       Indices       Help   
pylal
Package pylal :: Module InspiralUtils :: Class InspiralPage
[hide private]
[frames] | no frames]

Class InspiralPage

source code

object --+
         |
        InspiralPage

This is a class to contain all the bits of a inspiral page showing the results of a piece of code.

Instance Methods [hide private]
 
__init__(self, options, ifo_times=None, ifo_tag=None, user_tag=None, gps_start_time=None, gps_end_time=None)
Initializes this class with the options.		 source code
 
initialize(self)
Extract information from the option structure.		 source code
 
create_affixes(self)
Create the affixes (prefix/suffix) for the image naming		 source code
 
add_plot(self, plot_fig, fig_description, output_dir=None)
Add a plot to the page.		 source code
 
savefig(self, filename_base, fig, doThumb=True, dpi=None, dpi_thumb=50)
Function to create the image file.		 source code
 
write_page(self, infix=None, doThumb=True, map_list=[], coinc_summ_table=None)
Create the pages if output is enabled		 source code
 
write(self, text)
Write some text to the standard output AND to the page.		 source code
 
create_htmlname(self, infix)
Create the html filename		 source code
 
write_html_output(self, html_filename, doThumb=True, map_list=[], comment=None, coinc_summ_table=None) source code
 
write_cache_output(self, html_filename)
Write the output cache file of the plotting functions.		 source code
 
write_process_params(self)
Returns the version and the full command run		 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, options, ifo_times=None, ifo_tag=None, user_tag=None, gps_start_time=None, gps_end_time=None)
(Constructor)

source code 

Initializes this class with the options.

Overrides: object.__init__

initialize(self)

source code 

Extract information from the option structure. Does NOT alter the information in the option structure

add_plot(self, plot_fig, fig_description, output_dir=None)

source code 

Add a plot to the page.

Parameters:
  • plot_fig - handle of the figure
  • fig_description - descriptive figure text for the filename
  • output_dir - alternate output directory [optional]

savefig(self, filename_base, fig, doThumb=True, dpi=None, dpi_thumb=50)

source code 

Function to create the image file.

Parameters:
  • filename_base - basename of the filename (without the .png ending)
  • fig - handle to the figure to save
  • doThumb - save the thumbnail or not (doThumb=True by default)
  • dpi - resolution of the figure
  • dpi_thumb - resolution of the thumbnail (dpi=50 by default)

write_html_output(self, html_filename, doThumb=True, map_list=[], comment=None, coinc_summ_table=None)

source code 
Parameters:
  • doThumb - Uses the thumbnail file as the sourcs for the images
  • map_list - A list of dictionaries to create the image maps
  • comment - A comment that can be added to the page
  • coinc_summ_table - A CoincSummTable that can be added to the page

   Home       Trees       Indices       Help   
pylal
Generated by Epydoc 3.0.1 on Tue Dec 12 01:21:41 2017 http://epydoc.sourceforge.net