Add state bar

gwsumm/plot/builtin.py

@@ -41,7 +41,7 @@
 from ..data import (get_timeseries, get_spectrogram,
                     get_coherence_spectrogram, get_range_spectrogram,
                     get_spectrum, get_coherence_spectrum, get_range_spectrum)
-from ..state import ALLSTATE
+from ..state import (ALLSTATE, SummaryState)
 from .registry import (get_plot, register_plot)
 from .mixins import DataLabelSvgMixin
 
@@ -95,13 +95,23 @@
             method.
         """
         # allow user to disable the state segments axes
+
+        state = self.state
+        # If the state is not set or is set to "All",
+        # update the state to match the statebar's state.
+        # This allows the statebar's state to be included
+        # as a segment in the time series plot.
+        if isinstance(self.statebar, SummaryState) and (
+                state is None or (state.name.lower() == ALLSTATE)):
+            state = self.statebar
+
         if self.pargs.pop('no-state-segments', False):
             visible = False
-        if visible is None and self.state is not None and (
-                self.state.name.lower() != ALLSTATE):
+        if visible is None and state is not None and (
+                state.name.lower() != ALLSTATE):
             visible = True
         if visible:
-            sax = self.plot.add_segments_bar(self.state, ax, height=.14,
+            sax = self.plot.add_segments_bar(state, ax, height=.14,
                                              pad=.1,  **kwargs)
             sax.tick_params(axis='y', which='major', labelsize=12)
             sax.yaxis.set_ticks_position('none')

gwsumm/plot/core.py

@@ -252,13 +252,15 @@ class DataPlot(SummaryPlot):
 
     def __init__(self, channels, start, end, state=None, outdir='.',
                  tag=None, pid=None, href=None, new=True, all_data=False,
-                 read=True, fileformat='png', caption=None, **pargs):
+                 read=True, fileformat='png', caption=None, statebar=None,
+                 **pargs):
         super(DataPlot, self).__init__(href=href, new=new, caption=caption)
         if isinstance(channels, str):
             channels = split_channels(channels)
         self.channels = channels
         self.span = (start, end)
         self.state = state
+        self.statebar = statebar
         self._outdir = outdir
         if tag is not None:
             self.tag = tag

gwsumm/tabs/builtin.py

@@ -597,7 +597,7 @@
     """
     type = 'state'
 
-    def __init__(self, name, states=list(), **kwargs):
+    def __init__(self, name, states=list(), statebar=None, **kwargs):
         """Initialise a new `Tab`.
         """
         if kwargs.get('mode', None) is None:
@@ -609,6 +609,9 @@
             states = [states]
         self.states = states
 
+        # process statebar
+        self.statebar = statebar
+
     # -------------------------------------------
     # StateTab properties
 
@@ -665,6 +668,16 @@
     def defaultstate(self, state):
         self._defaultstate = state
 
+    @property
+    def statebar(self):
+        return self._statebar
+
+    @statebar.setter
+    def statebar(self, state):
+        if not isinstance(state, SummaryState) and state is not None:
+            state = get_state(state)
+        self._statebar = state
+
     @property
     def frames(self):
         # write page for each state
@@ -689,6 +702,18 @@
         else:
             # otherwise use 'all' state - full span with no gaps
             kwargs.setdefault('states', ['All'])
+
+        # Load statebar, used for adding a state segment to a timeseries plot.
+        # This is only applied to the "All" or unassigned (None) state.
+        if cp.has_option(section, 'statebar'):
+            # statebar should be a single element
+            # if a list is given, consider just the first element
+            kwargs.setdefault(
+                'statebar', [re_quote.sub('', s).strip() for s in
+                             cp.get(section, 'statebar').split(',')][0])
+        else:
+            kwargs.setdefault('statebar', None)
+
         # parse core Tab information
         return super(StateTab, cls).from_ini(cp, section, *args, **kwargs)
 

gwsumm/tabs/data.py

@@ -288,10 +288,11 @@
                 if type_:
                     plot = PlotClass.from_ini(cp, pdef, start, end, sources,
                                               state=None, outdir=plotdir,
-                                              **mods)
+                                              statebar=job.statebar, **mods)
                 else:
                     plot = PlotClass(sources, start, end, state=None,
-                                     outdir=plotdir, **mods)
+                                     statebar=job.statebar, outdir=plotdir,
+                                     **mods)
                 job.plots.append(plot)
                 if subidx == index:
                     for span in subplots:
@@ -305,10 +306,12 @@
                     if type_:
                         plot = PlotClass.from_ini(cp, pdef, start, end,
                                                   sources, state=state,
+                                                  statebar=job.statebar,
                                                   outdir=plotdir, **mods)
                     else:
                         plot = PlotClass(sources, start, end, state=state,
-                                         outdir=plotdir, **mods)
+                                         statebar=job.statebar, outdir=plotdir,
+                                         **mods)
                     job.plots.append(plot)
                     if subidx == index:
                         for span in subplots:
@@ -334,6 +337,10 @@
         allstate.fetch(config=config, segdb_error=segdb_error, **kwargs)
         for state in self.states:
             state.fetch(config=config, segdb_error=segdb_error, **kwargs)
+        # finilize statebar
+        if self.statebar is not None:
+            self.statebar.fetch(config=config, segdb_error=segdb_error,
+                                **kwargs)
 
     def process(self, config=ConfigParser(), nproc=1, **stateargs):
         """Process data for this tab
@@ -356,13 +363,18 @@
             segdb_error=stateargs.get('segdb_error', 'raise'),
             datafind_error=stateargs.get('datafind_error', 'raise'),
             nproc=nproc, nds=stateargs.get('nds', None))
-        vprint("States finalised [%d total]\n" % len(self.states))
+        vprint(f"States finalised [{len(self.states) + len([self.statebar])}"
+               " total]\n")
         for state in self.states:
-            vprint("    {0.name}: {1} segments | {2} seconds".format(
-                state, len(state.active), abs(state.active)))
+            vprint(f"    {state.name}: {len(state.active)} segments"
+                   f" | {abs(state.active)} seconds")
             if state is self.defaultstate:
                 vprint(" [DEFAULT]")
             vprint('\n')
+        if self.statebar is not None:
+            vprint(f"    {self.statebar.name}: {len(self.statebar.active)}"
+                   f" segments | {abs(state.active)} seconds")
+            vprint('\n')
 
         # pre-process requests for 'all-data' plots
         all_data = any([(p.all_data & p.new) for p in self.plots])