SpectralCube
============

.. currentmodule:: spectral_cube

.. autoclass:: SpectralCube
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~SpectralCube.base
      ~SpectralCube.beam
      ~SpectralCube.fill_value
      ~SpectralCube.filled_data
      ~SpectralCube.hdu
      ~SpectralCube.hdulist
      ~SpectralCube.header
      ~SpectralCube.latitude_extrema
      ~SpectralCube.longitude_extrema
      ~SpectralCube.mask
      ~SpectralCube.meta
      ~SpectralCube.ndim
      ~SpectralCube.pixels_per_beam
      ~SpectralCube.read
      ~SpectralCube.shape
      ~SpectralCube.size
      ~SpectralCube.spatial_coordinate_map
      ~SpectralCube.spectral_axis
      ~SpectralCube.spectral_extrema
      ~SpectralCube.unit
      ~SpectralCube.unitless
      ~SpectralCube.unitless_filled_data
      ~SpectralCube.unmasked_data
      ~SpectralCube.velocity_convention
      ~SpectralCube.wcs
      ~SpectralCube.world
      ~SpectralCube.world_extrema
      ~SpectralCube.write

   .. rubric:: Methods Summary

   .. autosummary::

      ~SpectralCube.apply_function
      ~SpectralCube.apply_function_parallel_spatial
      ~SpectralCube.apply_function_parallel_spectral
      ~SpectralCube.apply_numpy_function
      ~SpectralCube.argmax
      ~SpectralCube.argmax_world
      ~SpectralCube.argmin
      ~SpectralCube.argmin_world
      ~SpectralCube.check_jybeam_smoothing
      ~SpectralCube.chunked
      ~SpectralCube.closest_spectral_channel
      ~SpectralCube.convolve_to
      ~SpectralCube.downsample_axis
      ~SpectralCube.filled
      ~SpectralCube.find_lines
      ~SpectralCube.flattened
      ~SpectralCube.flattened_world
      ~SpectralCube.get_mask_array
      ~SpectralCube.linewidth_fwhm
      ~SpectralCube.linewidth_sigma
      ~SpectralCube.mad_std
      ~SpectralCube.mask_channels
      ~SpectralCube.max
      ~SpectralCube.mean
      ~SpectralCube.median
      ~SpectralCube.min
      ~SpectralCube.minimal_subcube
      ~SpectralCube.moment
      ~SpectralCube.moment0
      ~SpectralCube.moment1
      ~SpectralCube.moment2
      ~SpectralCube.percentile
      ~SpectralCube.plot_channel_maps
      ~SpectralCube.reproject
      ~SpectralCube.sigma_clip_spectrally
      ~SpectralCube.spatial_filter
      ~SpectralCube.spatial_smooth
      ~SpectralCube.spatial_smooth_median
      ~SpectralCube.spectral_filter
      ~SpectralCube.spectral_interpolate
      ~SpectralCube.spectral_slab
      ~SpectralCube.spectral_smooth
      ~SpectralCube.spectral_smooth_median
      ~SpectralCube.std
      ~SpectralCube.subcube
      ~SpectralCube.subcube_from_crtfregion
      ~SpectralCube.subcube_from_ds9region
      ~SpectralCube.subcube_from_mask
      ~SpectralCube.subcube_from_regions
      ~SpectralCube.subcube_slices_from_mask
      ~SpectralCube.sum
      ~SpectralCube.to
      ~SpectralCube.to_ds9
      ~SpectralCube.to_glue
      ~SpectralCube.to_pvextractor
      ~SpectralCube.to_yt
      ~SpectralCube.unmasked_copy
      ~SpectralCube.with_beam
      ~SpectralCube.with_fill_value
      ~SpectralCube.with_mask
      ~SpectralCube.with_spectral_unit
      ~SpectralCube.world_spines

   .. rubric:: Attributes Documentation

   .. autoattribute:: base
   .. autoattribute:: beam
   .. autoattribute:: fill_value
   .. autoattribute:: filled_data
   .. autoattribute:: hdu
   .. autoattribute:: hdulist
   .. autoattribute:: header
   .. autoattribute:: latitude_extrema
   .. autoattribute:: longitude_extrema
   .. autoattribute:: mask
   .. autoattribute:: meta
   .. autoattribute:: ndim
   .. autoattribute:: pixels_per_beam
   .. autoattribute:: read
   .. autoattribute:: shape
   .. autoattribute:: size
   .. autoattribute:: spatial_coordinate_map
   .. autoattribute:: spectral_axis
   .. autoattribute:: spectral_extrema
   .. autoattribute:: unit
   .. autoattribute:: unitless
   .. autoattribute:: unitless_filled_data
   .. autoattribute:: unmasked_data
   .. autoattribute:: velocity_convention
   .. autoattribute:: wcs
   .. autoattribute:: world
   .. autoattribute:: world_extrema
   .. autoattribute:: write

   .. rubric:: Methods Documentation

   .. automethod:: apply_function
   .. automethod:: apply_function_parallel_spatial
   .. automethod:: apply_function_parallel_spectral
   .. automethod:: apply_numpy_function
   .. automethod:: argmax
   .. automethod:: argmax_world
   .. automethod:: argmin
   .. automethod:: argmin_world
   .. automethod:: check_jybeam_smoothing
   .. automethod:: chunked
   .. automethod:: closest_spectral_channel
   .. automethod:: convolve_to
   .. automethod:: downsample_axis
   .. automethod:: filled
   .. automethod:: find_lines
   .. automethod:: flattened
   .. automethod:: flattened_world
   .. automethod:: get_mask_array
   .. automethod:: linewidth_fwhm
   .. automethod:: linewidth_sigma
   .. automethod:: mad_std
   .. automethod:: mask_channels
   .. automethod:: max
   .. automethod:: mean
   .. automethod:: median
   .. automethod:: min
   .. automethod:: minimal_subcube
   .. automethod:: moment
   .. automethod:: moment0
   .. automethod:: moment1
   .. automethod:: moment2
   .. automethod:: percentile
   .. automethod:: plot_channel_maps
   .. automethod:: reproject
   .. automethod:: sigma_clip_spectrally
   .. automethod:: spatial_filter
   .. automethod:: spatial_smooth
   .. automethod:: spatial_smooth_median
   .. automethod:: spectral_filter
   .. automethod:: spectral_interpolate
   .. automethod:: spectral_slab
   .. automethod:: spectral_smooth
   .. automethod:: spectral_smooth_median
   .. automethod:: std
   .. automethod:: subcube
   .. automethod:: subcube_from_crtfregion
   .. automethod:: subcube_from_ds9region
   .. automethod:: subcube_from_mask
   .. automethod:: subcube_from_regions
   .. automethod:: subcube_slices_from_mask
   .. automethod:: sum
   .. automethod:: to
   .. automethod:: to_ds9
   .. automethod:: to_glue
   .. automethod:: to_pvextractor
   .. automethod:: to_yt
   .. automethod:: unmasked_copy
   .. automethod:: with_beam
   .. automethod:: with_fill_value
   .. automethod:: with_mask
   .. automethod:: with_spectral_unit
   .. automethod:: world_spines