Spectrum
========

.. currentmodule:: specutils

.. autoclass:: Spectrum
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Spectrum.array_axis_physical_types
      ~Spectrum.bin_edges
      ~Spectrum.combined_wcs
      ~Spectrum.data
      ~Spectrum.dimensions
      ~Spectrum.energy
      ~Spectrum.extra_coords
      ~Spectrum.flux
      ~Spectrum.frequency
      ~Spectrum.global_coords
      ~Spectrum.mask
      ~Spectrum.meta
      ~Spectrum.photon_flux
      ~Spectrum.plotter
      ~Spectrum.psf
      ~Spectrum.quantity
      ~Spectrum.radial_velocity
      ~Spectrum.read
      ~Spectrum.redshift
      ~Spectrum.rest_value
      ~Spectrum.shape
      ~Spectrum.spectral_axis
      ~Spectrum.spectral_axis_direction
      ~Spectrum.spectral_axis_index
      ~Spectrum.spectral_wcs
      ~Spectrum.uncertainty
      ~Spectrum.unit
      ~Spectrum.velocity
      ~Spectrum.velocity_convention
      ~Spectrum.wavelength
      ~Spectrum.wcs
      ~Spectrum.write

   .. rubric:: Methods Summary

   .. autosummary::

      ~Spectrum.add
      ~Spectrum.axis_world_coords
      ~Spectrum.axis_world_coords_values
      ~Spectrum.collapse
      ~Spectrum.crop
      ~Spectrum.crop_by_values
      ~Spectrum.divide
      ~Spectrum.explode_along_axis
      ~Spectrum.max
      ~Spectrum.mean
      ~Spectrum.median
      ~Spectrum.min
      ~Spectrum.multiply
      ~Spectrum.new_flux_unit
      ~Spectrum.plot
      ~Spectrum.rebin
      ~Spectrum.reproject_to
      ~Spectrum.set_radial_velocity_to
      ~Spectrum.set_redshift_to
      ~Spectrum.shift_spectrum_to
      ~Spectrum.squeeze
      ~Spectrum.subtract
      ~Spectrum.sum
      ~Spectrum.to
      ~Spectrum.with_flux_unit
      ~Spectrum.with_spectral_axis_and_flux_units
      ~Spectrum.with_spectral_axis_last
      ~Spectrum.with_spectral_axis_unit
      ~Spectrum.with_spectral_unit
      ~Spectrum.with_velocity_convention

   .. rubric:: Attributes Documentation

   .. autoattribute:: array_axis_physical_types
   .. autoattribute:: bin_edges
   .. autoattribute:: combined_wcs
   .. autoattribute:: data
   .. autoattribute:: dimensions
   .. autoattribute:: energy
   .. autoattribute:: extra_coords
   .. autoattribute:: flux
   .. autoattribute:: frequency
   .. autoattribute:: global_coords
   .. autoattribute:: mask
   .. autoattribute:: meta
   .. autoattribute:: photon_flux
   .. autoattribute:: plotter
   .. autoattribute:: psf
   .. autoattribute:: quantity
   .. autoattribute:: radial_velocity
   .. autoattribute:: read
   .. autoattribute:: redshift
   .. autoattribute:: rest_value
   .. autoattribute:: shape
   .. autoattribute:: spectral_axis
   .. autoattribute:: spectral_axis_direction
   .. autoattribute:: spectral_axis_index
   .. autoattribute:: spectral_wcs
   .. autoattribute:: uncertainty
   .. autoattribute:: unit
   .. autoattribute:: velocity
   .. autoattribute:: velocity_convention
   .. autoattribute:: wavelength
   .. autoattribute:: wcs
   .. autoattribute:: write

   .. rubric:: Methods Documentation

   .. automethod:: add
   .. automethod:: axis_world_coords
   .. automethod:: axis_world_coords_values
   .. automethod:: collapse
   .. automethod:: crop
   .. automethod:: crop_by_values
   .. automethod:: divide
   .. automethod:: explode_along_axis
   .. automethod:: max
   .. automethod:: mean
   .. automethod:: median
   .. automethod:: min
   .. automethod:: multiply
   .. automethod:: new_flux_unit
   .. automethod:: plot
   .. automethod:: rebin
   .. automethod:: reproject_to
   .. automethod:: set_radial_velocity_to
   .. automethod:: set_redshift_to
   .. automethod:: shift_spectrum_to
   .. automethod:: squeeze
   .. automethod:: subtract
   .. automethod:: sum
   .. automethod:: to
   .. automethod:: with_flux_unit
   .. automethod:: with_spectral_axis_and_flux_units
   .. automethod:: with_spectral_axis_last
   .. automethod:: with_spectral_axis_unit
   .. automethod:: with_spectral_unit
   .. automethod:: with_velocity_convention
