Package pylal :: Package dq :: Module summary :: Class SummaryTab

Class SummaryTab

object --+
         |
        SummaryTab

The default meta-class for the summary tabs. It provides the basics so developers should subclass SummaryTab to generate something useful.

Instance Methods

[hide private]

__init__(self, name, **kwargs)
Initialise a SummaryTab object.

source code

name(self)

source code

directory(self)

source code

start_time(self)

source code

end_time(self)

source code

span(self)

source code

segments(self)

source code

plots(self)

source code

subplots(self)

source code

href(self)

source code

index(self)
URL to the index for this Tab.

source code

add_child(self, tab)

source code

get_child(self, name)

source code

write_menu(self, jobdir, startdate=None, weekday=calendar.MONDAY)
Write the HTML menu for this tab.

source code

write_ifo_links(self, baselist, thisifo, tablink)
Write the links to summary pages for other interferometers.

source code

frametohtml(self)
Write this Tab's frame to file as HTML.

source code

build(self, **initargs)
Write this Tab's full HTML to the index file.

source code

add_information(self, cp, cpsec)
Add an "Information" section to this SummaryTab.

source code

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

Class Variables

[hide private]

mode = 0

ifo = None
hash(x)

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, name, **kwargs)
(Constructor)

source code

Initialise a SummaryTab object. At least a name must be given.

Parameters:

name (str) - a name string for the tab

Overrides: object.__init__

name(self)

source code

Decorators:

@name.deleter

directory(self)

source code

Decorators:

@directory.deleter

start_time(self)

source code

Decorators:

@start_time.deleter

end_time(self)

source code

Decorators:

@end_time.deleter

span(self)

source code

Decorators:

@span.deleter

segments(self)

source code

Decorators:

@segments.deleter

plots(self)

source code

Decorators:

@plots.deleter

subplots(self)

source code

Decorators:

@subplots.deleter

href(self)

source code

Decorators:

@href.deleter

index(self)

source code

URL to the index for this Tab.

Decorators:

@property

write_menu(self, jobdir, startdate=None, weekday=calendar.MONDAY)

source code

Write the HTML menu for this tab.

Parameters:

jobdir (str) - output directory of this job
startdate (datetime.datetime) - date at which to start the menubar calendar
weekday (int) - day on which to start week in calendar (0=monday)

write_ifo_links(self, baselist, thisifo, tablink)

source code

Write the links to summary pages for other interferometers.

Parameters:

baselist (list of tuples) - list of (ifo, url) pairs defining the base for each IFO.
thisifo (str) - IFO prefix for this Tab.
tablink (str) - relative URL of this Tab to append to all IFO base URLs.

frametohtml(self)

source code

Write this Tab's frame to file as HTML. This allows it to be jquery loaded into a parent page.

build(self, **initargs)

source code

Write this Tab's full HTML to the index file.

Parameters:

**initargs - keyword arguments to pass to markup.page.init.

add_information(self, cp, cpsec)

source code

Add an "Information" section to this SummaryTab.

Parameters:

cp (configparser.configparser) - INI configuration for this job.
cpsec (str) - INI-file section name from which to read the 'html-information' option.

Class SummaryTab

__init__(self, name, **kwargs) (Constructor)

name(self)

directory(self)

start_time(self)

end_time(self)

span(self)

segments(self)

plots(self)

subplots(self)

href(self)

index(self)

write_menu(self, jobdir, startdate=None, weekday=calendar.MONDAY)

write_ifo_links(self, baselist, thisifo, tablink)

frametohtml(self)

build(self, **initargs)

add_information(self, cp, cpsec)

init(self, name, **kwargs)
(Constructor)