Beam
====

.. currentmodule:: radio_beam

.. autoclass:: Beam
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Beam.T
      ~Beam.base
      ~Beam.beamarea_equiv
      ~Beam.cgs
      ~Beam.ctypes
      ~Beam.data
      ~Beam.dtype
      ~Beam.equivalencies
      ~Beam.flags
      ~Beam.flat
      ~Beam.imag
      ~Beam.info
      ~Beam.isfinite
      ~Beam.isscalar
      ~Beam.itemsize
      ~Beam.major
      ~Beam.minor
      ~Beam.nbytes
      ~Beam.ndim
      ~Beam.pa
      ~Beam.real
      ~Beam.shape
      ~Beam.si
      ~Beam.size
      ~Beam.sr
      ~Beam.strides
      ~Beam.unit
      ~Beam.value

   .. rubric:: Methods Summary

   .. autosummary::

      ~Beam.all
      ~Beam.any
      ~Beam.argmax
      ~Beam.argmin
      ~Beam.argpartition
      ~Beam.argsort
      ~Beam.as_kernel
      ~Beam.as_tophat_kernel
      ~Beam.astype
      ~Beam.attach_to_header
      ~Beam.beam_projected_area
      ~Beam.byteswap
      ~Beam.choose
      ~Beam.clip
      ~Beam.commonbeam_with
      ~Beam.compress
      ~Beam.conj
      ~Beam.conjugate
      ~Beam.convolve
      ~Beam.copy
      ~Beam.cumprod
      ~Beam.cumsum
      ~Beam.decompose
      ~Beam.deconvolve
      ~Beam.diagonal
      ~Beam.diff
      ~Beam.dot
      ~Beam.dump
      ~Beam.dumps
      ~Beam.ediff1d
      ~Beam.ellipse_to_plot
      ~Beam.fill
      ~Beam.flatten
      ~Beam.from_casa_image
      ~Beam.from_fits_bintable
      ~Beam.from_fits_header
      ~Beam.from_fits_history
      ~Beam.getfield
      ~Beam.insert
      ~Beam.iscircular
      ~Beam.item
      ~Beam.itemset
      ~Beam.jtok
      ~Beam.jtok_equiv
      ~Beam.max
      ~Beam.mean
      ~Beam.min
      ~Beam.nansum
      ~Beam.newbyteorder
      ~Beam.nonzero
      ~Beam.partition
      ~Beam.prod
      ~Beam.ptp
      ~Beam.put
      ~Beam.ravel
      ~Beam.repeat
      ~Beam.reshape
      ~Beam.resize
      ~Beam.round
      ~Beam.searchsorted
      ~Beam.setfield
      ~Beam.setflags
      ~Beam.sort
      ~Beam.squeeze
      ~Beam.std
      ~Beam.sum
      ~Beam.swapaxes
      ~Beam.take
      ~Beam.to
      ~Beam.to_header_keywords
      ~Beam.to_string
      ~Beam.to_value
      ~Beam.tobytes
      ~Beam.tofile
      ~Beam.tolist
      ~Beam.tostring
      ~Beam.trace
      ~Beam.transpose
      ~Beam.var
      ~Beam.view

   .. rubric:: Attributes Documentation

   .. autoattribute:: T
   .. autoattribute:: base
   .. autoattribute:: beamarea_equiv
   .. autoattribute:: cgs
   .. autoattribute:: ctypes
   .. autoattribute:: data
   .. autoattribute:: dtype
   .. autoattribute:: equivalencies
   .. autoattribute:: flags
   .. autoattribute:: flat
   .. autoattribute:: imag
   .. autoattribute:: info
   .. autoattribute:: isfinite
   .. autoattribute:: isscalar
   .. autoattribute:: itemsize
   .. autoattribute:: major
   .. autoattribute:: minor
   .. autoattribute:: nbytes
   .. autoattribute:: ndim
   .. autoattribute:: pa
   .. autoattribute:: real
   .. autoattribute:: shape
   .. autoattribute:: si
   .. autoattribute:: size
   .. autoattribute:: sr
   .. autoattribute:: strides
   .. autoattribute:: unit
   .. autoattribute:: value

   .. rubric:: Methods Documentation

   .. automethod:: all
   .. automethod:: any
   .. automethod:: argmax
   .. automethod:: argmin
   .. automethod:: argpartition
   .. automethod:: argsort
   .. automethod:: as_kernel
   .. automethod:: as_tophat_kernel
   .. automethod:: astype
   .. automethod:: attach_to_header
   .. automethod:: beam_projected_area
   .. automethod:: byteswap
   .. automethod:: choose
   .. automethod:: clip
   .. automethod:: commonbeam_with
   .. automethod:: compress
   .. automethod:: conj
   .. automethod:: conjugate
   .. automethod:: convolve
   .. automethod:: copy
   .. automethod:: cumprod
   .. automethod:: cumsum
   .. automethod:: decompose
   .. automethod:: deconvolve
   .. automethod:: diagonal
   .. automethod:: diff
   .. automethod:: dot
   .. automethod:: dump
   .. automethod:: dumps
   .. automethod:: ediff1d
   .. automethod:: ellipse_to_plot
   .. automethod:: fill
   .. automethod:: flatten
   .. automethod:: from_casa_image
   .. automethod:: from_fits_bintable
   .. automethod:: from_fits_header
   .. automethod:: from_fits_history
   .. automethod:: getfield
   .. automethod:: insert
   .. automethod:: iscircular
   .. automethod:: item
   .. automethod:: itemset
   .. automethod:: jtok
   .. automethod:: jtok_equiv
   .. automethod:: max
   .. automethod:: mean
   .. automethod:: min
   .. automethod:: nansum
   .. automethod:: newbyteorder
   .. automethod:: nonzero
   .. automethod:: partition
   .. automethod:: prod
   .. automethod:: ptp
   .. automethod:: put
   .. automethod:: ravel
   .. automethod:: repeat
   .. automethod:: reshape
   .. automethod:: resize
   .. automethod:: round
   .. automethod:: searchsorted
   .. automethod:: setfield
   .. automethod:: setflags
   .. automethod:: sort
   .. automethod:: squeeze
   .. automethod:: std
   .. automethod:: sum
   .. automethod:: swapaxes
   .. automethod:: take
   .. automethod:: to
   .. automethod:: to_header_keywords
   .. automethod:: to_string
   .. automethod:: to_value
   .. automethod:: tobytes
   .. automethod:: tofile
   .. automethod:: tolist
   .. automethod:: tostring
   .. automethod:: trace
   .. automethod:: transpose
   .. automethod:: var
   .. automethod:: view