gwsumm.plot package

Subpackages

• gwsumm.plot.guardian package
  • Subpackages
    • gwsumm.plot.guardian.tests package
      • Submodules
      • Module contents
  • Submodules
    • gwsumm.plot.guardian.core module
      • GuardianStatePlot
  • Module contents
• gwsumm.plot.triggers package
  • Subpackages
    • gwsumm.plot.triggers.tests package
      • Submodules
      • Module contents
  • Submodules
    • gwsumm.plot.triggers.core module
      • TriggerDataPlot
      • TriggerHistogramPlot
      • TriggerPlotMixin
      • TriggerRateDataPlot
      • TriggerTimeSeriesDataPlot
  • Module contents

Submodules

• gwsumm.plot.builtin module
  • CoherenceSpectrogramDataPlot
    • CoherenceSpectrogramDataPlot.data
    • CoherenceSpectrogramDataPlot.defaults
    • CoherenceSpectrogramDataPlot.type
  • CoherenceSpectrumDataPlot
    • CoherenceSpectrumDataPlot.data
    • CoherenceSpectrumDataPlot.defaults
    • CoherenceSpectrumDataPlot.get_channel_groups()
    • CoherenceSpectrumDataPlot.type
  • RayleighSpectrogramDataPlot
    • RayleighSpectrogramDataPlot.data
    • RayleighSpectrogramDataPlot.defaults
    • RayleighSpectrogramDataPlot.type
  • RayleighSpectrumDataPlot
    • RayleighSpectrumDataPlot.data
    • RayleighSpectrumDataPlot.defaults
    • RayleighSpectrumDataPlot.type
  • SpectralVarianceDataPlot
    • SpectralVarianceDataPlot.data
    • SpectralVarianceDataPlot.defaults
    • SpectralVarianceDataPlot.parse_variance_kwargs()
    • SpectralVarianceDataPlot.type
  • SpectrogramDataPlot
    • SpectrogramDataPlot.data
    • SpectrogramDataPlot.defaults
    • SpectrogramDataPlot.draw()
    • SpectrogramDataPlot.get_ratio()
    • SpectrogramDataPlot.pid
    • SpectrogramDataPlot.type
  • SpectrumDataPlot
    • SpectrumDataPlot.data
    • SpectrumDataPlot.defaults
    • SpectrumDataPlot.draw()
    • SpectrumDataPlot.parse_references()
    • SpectrumDataPlot.type
  • TimeSeriesDataPlot
    • TimeSeriesDataPlot.add_future_shade()
    • TimeSeriesDataPlot.add_state_segments()
    • TimeSeriesDataPlot.data
    • TimeSeriesDataPlot.defaults
    • TimeSeriesDataPlot.draw()
    • TimeSeriesDataPlot.init_plot()
    • TimeSeriesDataPlot.type
  • TimeSeriesHistogram2dDataPlot
    • TimeSeriesHistogram2dDataPlot.data
    • TimeSeriesHistogram2dDataPlot.defaults
    • TimeSeriesHistogram2dDataPlot.draw()
    • TimeSeriesHistogram2dDataPlot.parse_hist_kwargs()
    • TimeSeriesHistogram2dDataPlot.parse_pcmesh_kwargs()
    • TimeSeriesHistogram2dDataPlot.type
  • TimeSeriesHistogramPlot
    • TimeSeriesHistogramPlot.data
    • TimeSeriesHistogramPlot.defaults
    • TimeSeriesHistogramPlot.draw()
    • TimeSeriesHistogramPlot.init_plot()
    • TimeSeriesHistogramPlot.parse_plot_kwargs()
    • TimeSeriesHistogramPlot.type
  • undo_demodulation()
• gwsumm.plot.core module
  • DataPlot
    • DataPlot.DRAW_PARAMS
    • DataPlot.add_channel()
    • DataPlot.add_hvlines()
    • DataPlot.allchannels
    • DataPlot.apply_parameters()
    • DataPlot.channels
    • DataPlot.defaults
    • DataPlot.draw()
    • DataPlot.end
    • DataPlot.finalize()
    • DataPlot.from_ini()
    • DataPlot.get_channel_groups()
    • DataPlot.href
    • DataPlot.ifos
    • DataPlot.init_plot()
    • DataPlot.logx
    • DataPlot.logy
    • DataPlot.outputfile
    • DataPlot.parse_legend_kwargs()
    • DataPlot.parse_list()
    • DataPlot.parse_plot_kwargs()
    • DataPlot.parse_rcParams()
    • DataPlot.pid
    • DataPlot.process()
    • DataPlot.span
    • DataPlot.start
    • DataPlot.state
    • DataPlot.tag
    • DataPlot.type
  • SummaryPlot
    • SummaryPlot.caption
    • SummaryPlot.from_ini()
    • SummaryPlot.href
    • SummaryPlot.new
    • SummaryPlot.src
    • SummaryPlot.type
• gwsumm.plot.mixins module
  • DataLabelSvgMixin
    • DataLabelSvgMixin.draw_svg()
  • SegmentLabelSvgMixin
    • SegmentLabelSvgMixin.draw_svg()
  • SvgMixin
    • SvgMixin.draw_svg()
    • SvgMixin.finalize()
    • SvgMixin.finalize_svg()
• gwsumm.plot.noisebudget module
  • NoiseBudgetPlot
    • NoiseBudgetPlot.data
    • NoiseBudgetPlot.defaults
    • NoiseBudgetPlot.parse_residual_params()
    • NoiseBudgetPlot.parse_sum_params()
    • NoiseBudgetPlot.type
  • RelativeNoiseBudgetPlot
    • RelativeNoiseBudgetPlot.data
    • RelativeNoiseBudgetPlot.defaults
    • RelativeNoiseBudgetPlot.type
• gwsumm.plot.range module
  • GWpyTimeVolumeDataPlot
    • GWpyTimeVolumeDataPlot.type
  • RangeCumulativeHistogramPlot
    • RangeCumulativeHistogramPlot.defaults
    • RangeCumulativeHistogramPlot.type
  • RangeCumulativeSpectrumDataPlot
    • RangeCumulativeSpectrumDataPlot.data
    • RangeCumulativeSpectrumDataPlot.defaults
    • RangeCumulativeSpectrumDataPlot.type
  • RangeDataHistogramPlot
    • RangeDataHistogramPlot.defaults
    • RangeDataHistogramPlot.type
  • RangeDataPlot
    • RangeDataPlot.defaults
    • RangeDataPlot.type
  • RangePlotMixin
    • RangePlotMixin.data
    • RangePlotMixin.defaults
    • RangePlotMixin.draw()
  • RangeSpectrogramDataPlot
    • RangeSpectrogramDataPlot.defaults
    • RangeSpectrogramDataPlot.type
  • RangeSpectrumDataPlot
    • RangeSpectrumDataPlot.data
    • RangeSpectrumDataPlot.defaults
    • RangeSpectrumDataPlot.type
  • SimpleTimeVolumeDataPlot
    • SimpleTimeVolumeDataPlot.DRAW_PARAMS
    • SimpleTimeVolumeDataPlot.calculate_time_volume()
    • SimpleTimeVolumeDataPlot.combined_time_volume()
    • SimpleTimeVolumeDataPlot.data
    • SimpleTimeVolumeDataPlot.defaults
    • SimpleTimeVolumeDataPlot.draw()
    • SimpleTimeVolumeDataPlot.from_ini()
    • SimpleTimeVolumeDataPlot.parse_plot_kwargs()
    • SimpleTimeVolumeDataPlot.pid
    • SimpleTimeVolumeDataPlot.type
• gwsumm.plot.registry module
  • get_plot()
  • register_plot()
• gwsumm.plot.segments module
  • DutyDataPlot
    • DutyDataPlot.calculate_duty_factor()
    • DutyDataPlot.data
    • DutyDataPlot.defaults
    • DutyDataPlot.draw()
    • DutyDataPlot.get_bins()
    • DutyDataPlot.parse_plot_kwargs()
    • DutyDataPlot.pid
    • DutyDataPlot.type
  • NetworkDutyBarPlot
    • NetworkDutyBarPlot.NETWORK_COLOR
    • NetworkDutyBarPlot.NETWORK_NAME
    • NetworkDutyBarPlot.defaults
    • NetworkDutyBarPlot.draw()
    • NetworkDutyBarPlot.type
  • NetworkDutyPiePlot
    • NetworkDutyPiePlot.NETWORK_COLOR
    • NetworkDutyPiePlot.NETWORK_NAME
    • NetworkDutyPiePlot.defaults
    • NetworkDutyPiePlot.draw()
    • NetworkDutyPiePlot.type
  • ODCDataPlot
    • ODCDataPlot.data
    • ODCDataPlot.defaults
    • ODCDataPlot.draw()
    • ODCDataPlot.get_bitmask_channels()
    • ODCDataPlot.pid
    • ODCDataPlot.type
  • SegmentBarPlot
    • SegmentBarPlot.SCALE_UNIT
    • SegmentBarPlot.defaults
    • SegmentBarPlot.draw()
    • SegmentBarPlot.type
  • SegmentDataPlot
    • SegmentDataPlot.DRAW_PARAMS
    • SegmentDataPlot.add_flag()
    • SegmentDataPlot.add_legend()
    • SegmentDataPlot.allflags
    • SegmentDataPlot.data
    • SegmentDataPlot.defaults
    • SegmentDataPlot.draw()
    • SegmentDataPlot.flags
    • SegmentDataPlot.from_ini()
    • SegmentDataPlot.get_channel_groups()
    • SegmentDataPlot.get_segment_color()
    • SegmentDataPlot.ifos
    • SegmentDataPlot.init_plot()
    • SegmentDataPlot.padding
    • SegmentDataPlot.parse_plot_kwargs()
    • SegmentDataPlot.pid
    • SegmentDataPlot.type
  • SegmentHistogramPlot
    • SegmentHistogramPlot.data
    • SegmentHistogramPlot.defaults
    • SegmentHistogramPlot.draw()
    • SegmentHistogramPlot.parse_plot_kwargs()
    • SegmentHistogramPlot.type
  • SegmentPiePlot
    • SegmentPiePlot.defaults
    • SegmentPiePlot.draw()
    • SegmentPiePlot.parse_plot_kwargs()
    • SegmentPiePlot.parse_wedge_kwargs()
    • SegmentPiePlot.type
  • StateVectorDataPlot
    • StateVectorDataPlot.DRAW_PARAMS
    • StateVectorDataPlot.data
    • StateVectorDataPlot.defaults
    • StateVectorDataPlot.draw()
    • StateVectorDataPlot.flag
    • StateVectorDataPlot.get_segment_color()
    • StateVectorDataPlot.init_plot()
    • StateVectorDataPlot.parse_plot_kwargs()
    • StateVectorDataPlot.pid
    • StateVectorDataPlot.type
  • common_limits()
  • tint_hex()
• gwsumm.plot.sei module
  • SeiWatchDogPlot
    • SeiWatchDogPlot.data
    • SeiWatchDogPlot.draw()
    • SeiWatchDogPlot.outputfile
    • SeiWatchDogPlot.type
• gwsumm.plot.utils module
  • get_column_label()
  • get_column_string()
  • hash()

Module contents

A Plot is a representation of an image to be included in the HTML output a tab.

For simple purposes, a Plot is just a reference to an existing image file that can be imported into an HTML page via the <img> tag.

For more complicated purposes, a number of data plot classes are provided to allow users to generate images on-the-fly. The available classes are:

TimeSeriesDataPlot(*args, **kwargs)	DataPlot of some TimeSeries data.
SpectrogramDataPlot(*args, **kwargs)	DataPlot a Spectrogram
SegmentDataPlot(flags, start, end[, state, ...])	Segment plot of one or more DataQualityFlags <DataQualityFlag>.
StateVectorDataPlot(*args, **kwargs)	DataPlot of some StateVector data.
SpectrumDataPlot(channels, start, end[, ...])	Spectrum plot for a SummaryTab
TimeSeriesHistogramPlot(channels, start, end)	HistogramPlot from a Series
TriggerTimeSeriesDataPlot(*args, **kwargs)	Custom time-series plot to handle discontiguous TimeSeries.
TriggerHistogramPlot(*args, **kwargs)	HistogramPlot from a LIGO_LW Table
TriggerRateDataPlot(*args, **kwargs)	TimeSeriesDataPlot of trigger rate.