BaseSpectralCube
================

.. currentmodule:: spectral_cube.spectral_cube

.. autoclass:: BaseSpectralCube
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

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

   .. rubric:: Methods Summary

   .. autosummary::

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

   .. rubric:: Attributes Documentation

   .. autoattribute:: base
   .. 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:: 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_fill_value
   .. automethod:: with_mask
   .. automethod:: with_spectral_unit
   .. automethod:: world_spines