Tab API

gwsumm.tabs Package

This module defines the Tab API, and all of the built-in tab objects

Functions

get_tab(name)

Query the registry for the tab class registered to the given name

register_tab(tab[, name, force])

Register a new summary Tab to the given name

Classes

AboutTab(*args, **kwargs)

Page describing how the containing HTML pages were generated

AccountingTab(*args, **kwargs)

Summarise the data recorded by the operating mode channels

BaseTab(name[, index, shortname, parent, ...])

The core Tab object, defining basic functionality

DataTab(*args, **kwargs)

A tab where plots and data summaries are built upon request

Error404Tab(*args, **kwargs)

Custom HTTP 404 error page

EventTab(*args, **kwargs)

Tab defined around a central GPS time

EventTriggerTab(*args, **kwargs)

Custom DataTab displaying a summary of event trigger generation

ExternalTab(*args, **kwargs)

A simple tab to link HTML from an external source

FscanTab(*args, **kwargs)

Custom tab displaying a summary of Fscan results.

GpsTab(name[, index, shortname, parent, ...])

Stub for GPS-related tabs

GraceDbTab(*args, **kwargs)

Custom tab displaying a summary of GraceDb results.

GuardianTab(*args, **kwargs)

Summarises the data recorded by an Advanced LIGO Guardian node.

IntervalTab(*args, **kwargs)

Tab defined within a GPS [start, end) interval

ParentTab(*args, **kwargs)

Dummy Tab only for navigation

PlotTab(*args, **kwargs)

A simple tab to layout some figures in the #main div.

ProcessedTab()

Abstract base class to detect necessity to run Tab.process()

SEIWatchDogTab(*args, **kwargs)

Summarise the WatchDog trips recorded from the SEI system.

StampPEMTab(*args, **kwargs)

Custom tab displaying a summary of StampPEM results.

StateTab(*args, **kwargs)

Tab with multiple content pages defined via 'states'

StaticTab(name[, index, shortname, parent, ...])

Simple Tab with no GPS association

Tab(*args, **kwargs)

A Simple HTML tab.

TabList([entries])

Custom list of Tab objects with sorting and parsing

UrlTab(*args, **kwargs)

Class Inheritance Diagram

digraph inheritance3d6cedfdfd { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AboutTab" [URL="../api/gwsumm.tabs.misc.html#gwsumm.tabs.misc.AboutTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Page describing how the containing HTML pages were generated"]; "Tab" -> "AboutTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AccountingTab" [URL="../api/gwsumm.tabs.management.html#gwsumm.tabs.management.AccountingTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Summarise the data recorded by the operating mode channels"]; "DataTab" -> "AccountingTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseTab" [URL="../api/gwsumm.tabs.core.html#gwsumm.tabs.core.BaseTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The core `Tab` object, defining basic functionality"]; "DataTab" [URL="../api/gwsumm.tabs.data.html#gwsumm.tabs.data.DataTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A tab where plots and data summaries are built upon request"]; "ProcessedTab" -> "DataTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StateTab" -> "DataTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Error404Tab" [URL="../api/gwsumm.tabs.misc.html#gwsumm.tabs.misc.Error404Tab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom HTTP 404 error page"]; "Tab" -> "Error404Tab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EventTab" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="`Tab` defined around a central GPS time"]; "GpsTab" -> "EventTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EventTriggerTab" [URL="../api/gwsumm.tabs.etg.html#gwsumm.tabs.etg.EventTriggerTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom `DataTab` displaying a summary of event trigger generation"]; "DataTab" -> "EventTriggerTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ExternalTab" [URL="../api/gwsumm.tabs.builtin.html#gwsumm.tabs.builtin.ExternalTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple tab to link HTML from an external source"]; "Tab" -> "ExternalTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FscanTab" [URL="../api/gwsumm.tabs.fscan.html#gwsumm.tabs.fscan.FscanTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom tab displaying a summary of Fscan results."]; "DataTab" -> "FscanTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GpsTab" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Stub for GPS-related tabs"]; "BaseTab" -> "GpsTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GraceDbTab" [URL="../api/gwsumm.tabs.gracedb.html#gwsumm.tabs.gracedb.GraceDbTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom tab displaying a summary of GraceDb results."]; "DataTab" -> "GraceDbTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GuardianTab" [URL="../api/gwsumm.tabs.guardian.html#gwsumm.tabs.guardian.GuardianTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Summarises the data recorded by an Advanced LIGO Guardian node."]; "DataTab" -> "GuardianTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IntervalTab" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="`Tab` defined within a GPS [start, end) interval"]; "GpsTab" -> "IntervalTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ParentTab" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Dummy `Tab` only for navigation"]; "Tab" -> "ParentTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PlotTab" [URL="../api/gwsumm.tabs.builtin.html#gwsumm.tabs.builtin.PlotTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple tab to layout some figures in the #main div."]; "Tab" -> "PlotTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProcessedTab" [URL="../api/gwsumm.tabs.data.html#gwsumm.tabs.data.ProcessedTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract base class to detect necessity to run Tab.process()"]; "SEIWatchDogTab" [URL="../api/gwsumm.tabs.sei.html#gwsumm.tabs.sei.SEIWatchDogTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Summarise the WatchDog trips recorded from the SEI system."]; "DataTab" -> "SEIWatchDogTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StampPEMTab" [URL="../api/gwsumm.tabs.stamp.html#gwsumm.tabs.stamp.StampPEMTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom tab displaying a summary of StampPEM results."]; "DataTab" -> "StampPEMTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StateTab" [URL="../api/gwsumm.tabs.builtin.html#gwsumm.tabs.builtin.StateTab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Tab with multiple content pages defined via 'states'"]; "PlotTab" -> "StateTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StaticTab" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Simple `Tab` with no GPS association"]; "BaseTab" -> "StaticTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Tab" [URL="../api/gwsumm.tabs.core.html#gwsumm.tabs.core.Tab",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A Simple HTML tab."]; "BaseTab" -> "Tab" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TabList" [URL="../api/gwsumm.tabs.core.html#gwsumm.tabs.core.TabList",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom `list` of `Tab` objects with sorting and parsing"]; "UrlTab" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "Tab" -> "UrlTab" [arrowsize=0.5,style="setlinewidth(0.5)"]; }