BackgroundRates
===============

.. currentmodule:: gdt.core.background.primitives

.. autoclass:: BackgroundRates
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~BackgroundRates.chan_widths
      ~BackgroundRates.count_uncertainty
      ~BackgroundRates.counts
      ~BackgroundRates.emax
      ~BackgroundRates.emin
      ~BackgroundRates.energy_centroids
      ~BackgroundRates.energy_range
      ~BackgroundRates.exposure
      ~BackgroundRates.num_chans
      ~BackgroundRates.num_times
      ~BackgroundRates.quality
      ~BackgroundRates.rate_uncertainty
      ~BackgroundRates.rate_uncertainty_per_kev
      ~BackgroundRates.rates
      ~BackgroundRates.rates_per_kev
      ~BackgroundRates.size
      ~BackgroundRates.time_centroids
      ~BackgroundRates.time_range
      ~BackgroundRates.time_widths
      ~BackgroundRates.tstart
      ~BackgroundRates.tstop

   .. rubric:: Methods Summary

   .. autosummary::

      ~BackgroundRates.closest_energy_edge
      ~BackgroundRates.closest_time_edge
      ~BackgroundRates.contiguous_energy_bins
      ~BackgroundRates.contiguous_time_bins
      ~BackgroundRates.from_rates
      ~BackgroundRates.get_exposure
      ~BackgroundRates.integrate_energy
      ~BackgroundRates.integrate_time
      ~BackgroundRates.merge_energy
      ~BackgroundRates.merge_time
      ~BackgroundRates.rebin_energy
      ~BackgroundRates.rebin_time
      ~BackgroundRates.slice_energy
      ~BackgroundRates.slice_time
      ~BackgroundRates.sum_time
      ~BackgroundRates.to_bak

   .. rubric:: Attributes Documentation

   .. autoattribute:: chan_widths
   .. autoattribute:: count_uncertainty
   .. autoattribute:: counts
   .. autoattribute:: emax
   .. autoattribute:: emin
   .. autoattribute:: energy_centroids
   .. autoattribute:: energy_range
   .. autoattribute:: exposure
   .. autoattribute:: num_chans
   .. autoattribute:: num_times
   .. autoattribute:: quality
   .. autoattribute:: rate_uncertainty
   .. autoattribute:: rate_uncertainty_per_kev
   .. autoattribute:: rates
   .. autoattribute:: rates_per_kev
   .. autoattribute:: size
   .. autoattribute:: time_centroids
   .. autoattribute:: time_range
   .. autoattribute:: time_widths
   .. autoattribute:: tstart
   .. autoattribute:: tstop

   .. rubric:: Methods Documentation

   .. automethod:: closest_energy_edge
   .. automethod:: closest_time_edge
   .. automethod:: contiguous_energy_bins
   .. automethod:: contiguous_time_bins
   .. automethod:: from_rates
   .. automethod:: get_exposure
   .. automethod:: integrate_energy
   .. automethod:: integrate_time
   .. automethod:: merge_energy
   .. automethod:: merge_time
   .. automethod:: rebin_energy
   .. automethod:: rebin_time
   .. automethod:: slice_energy
   .. automethod:: slice_time
   .. automethod:: sum_time
   .. automethod:: to_bak