SourceCatalog
=============

.. currentmodule:: photutils.segmentation

.. autoclass:: SourceCatalog
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~SourceCatalog.area
      ~SourceCatalog.background
      ~SourceCatalog.background_centroid
      ~SourceCatalog.background_ma
      ~SourceCatalog.background_mean
      ~SourceCatalog.background_sum
      ~SourceCatalog.bbox
      ~SourceCatalog.bbox_xmax
      ~SourceCatalog.bbox_xmin
      ~SourceCatalog.bbox_ymax
      ~SourceCatalog.bbox_ymin
      ~SourceCatalog.centroid
      ~SourceCatalog.centroid_quad
      ~SourceCatalog.centroid_win
      ~SourceCatalog.convdata
      ~SourceCatalog.convdata_ma
      ~SourceCatalog.covar_sigx2
      ~SourceCatalog.covar_sigxy
      ~SourceCatalog.covar_sigy2
      ~SourceCatalog.covariance
      ~SourceCatalog.covariance_eigvals
      ~SourceCatalog.cutout_centroid
      ~SourceCatalog.cutout_centroid_quad
      ~SourceCatalog.cutout_centroid_win
      ~SourceCatalog.cutout_maxval_index
      ~SourceCatalog.cutout_minval_index
      ~SourceCatalog.cxx
      ~SourceCatalog.cxy
      ~SourceCatalog.cyy
      ~SourceCatalog.data
      ~SourceCatalog.data_ma
      ~SourceCatalog.eccentricity
      ~SourceCatalog.ellipticity
      ~SourceCatalog.elongation
      ~SourceCatalog.equivalent_radius
      ~SourceCatalog.error
      ~SourceCatalog.error_ma
      ~SourceCatalog.extra_properties
      ~SourceCatalog.fwhm
      ~SourceCatalog.gini
      ~SourceCatalog.inertia_tensor
      ~SourceCatalog.isscalar
      ~SourceCatalog.kron_aperture
      ~SourceCatalog.kron_flux
      ~SourceCatalog.kron_fluxerr
      ~SourceCatalog.kron_radius
      ~SourceCatalog.label
      ~SourceCatalog.labels
      ~SourceCatalog.local_background
      ~SourceCatalog.local_background_aperture
      ~SourceCatalog.max_value
      ~SourceCatalog.maxval_index
      ~SourceCatalog.maxval_xindex
      ~SourceCatalog.maxval_yindex
      ~SourceCatalog.min_value
      ~SourceCatalog.minval_index
      ~SourceCatalog.minval_xindex
      ~SourceCatalog.minval_yindex
      ~SourceCatalog.moments
      ~SourceCatalog.moments_central
      ~SourceCatalog.nlabels
      ~SourceCatalog.orientation
      ~SourceCatalog.perimeter
      ~SourceCatalog.properties
      ~SourceCatalog.segment
      ~SourceCatalog.segment_area
      ~SourceCatalog.segment_flux
      ~SourceCatalog.segment_fluxerr
      ~SourceCatalog.segment_ma
      ~SourceCatalog.semimajor_sigma
      ~SourceCatalog.semiminor_sigma
      ~SourceCatalog.sky_bbox_ll
      ~SourceCatalog.sky_bbox_lr
      ~SourceCatalog.sky_bbox_ul
      ~SourceCatalog.sky_bbox_ur
      ~SourceCatalog.sky_centroid
      ~SourceCatalog.sky_centroid_icrs
      ~SourceCatalog.sky_centroid_quad
      ~SourceCatalog.sky_centroid_win
      ~SourceCatalog.slices
      ~SourceCatalog.xcentroid
      ~SourceCatalog.xcentroid_quad
      ~SourceCatalog.xcentroid_win
      ~SourceCatalog.ycentroid
      ~SourceCatalog.ycentroid_quad
      ~SourceCatalog.ycentroid_win

   .. rubric:: Methods Summary

   .. autosummary::

      ~SourceCatalog.add_extra_property
      ~SourceCatalog.circular_photometry
      ~SourceCatalog.copy
      ~SourceCatalog.fluxfrac_radius
      ~SourceCatalog.get_label
      ~SourceCatalog.get_labels
      ~SourceCatalog.kron_photometry
      ~SourceCatalog.make_circular_apertures
      ~SourceCatalog.make_cutouts
      ~SourceCatalog.make_kron_apertures
      ~SourceCatalog.plot_circular_apertures
      ~SourceCatalog.plot_kron_apertures
      ~SourceCatalog.remove_extra_properties
      ~SourceCatalog.remove_extra_property
      ~SourceCatalog.rename_extra_property
      ~SourceCatalog.to_table

   .. rubric:: Attributes Documentation

   .. autoattribute:: area
   .. autoattribute:: background
   .. autoattribute:: background_centroid
   .. autoattribute:: background_ma
   .. autoattribute:: background_mean
   .. autoattribute:: background_sum
   .. autoattribute:: bbox
   .. autoattribute:: bbox_xmax
   .. autoattribute:: bbox_xmin
   .. autoattribute:: bbox_ymax
   .. autoattribute:: bbox_ymin
   .. autoattribute:: centroid
   .. autoattribute:: centroid_quad
   .. autoattribute:: centroid_win
   .. autoattribute:: convdata
   .. autoattribute:: convdata_ma
   .. autoattribute:: covar_sigx2
   .. autoattribute:: covar_sigxy
   .. autoattribute:: covar_sigy2
   .. autoattribute:: covariance
   .. autoattribute:: covariance_eigvals
   .. autoattribute:: cutout_centroid
   .. autoattribute:: cutout_centroid_quad
   .. autoattribute:: cutout_centroid_win
   .. autoattribute:: cutout_maxval_index
   .. autoattribute:: cutout_minval_index
   .. autoattribute:: cxx
   .. autoattribute:: cxy
   .. autoattribute:: cyy
   .. autoattribute:: data
   .. autoattribute:: data_ma
   .. autoattribute:: eccentricity
   .. autoattribute:: ellipticity
   .. autoattribute:: elongation
   .. autoattribute:: equivalent_radius
   .. autoattribute:: error
   .. autoattribute:: error_ma
   .. autoattribute:: extra_properties
   .. autoattribute:: fwhm
   .. autoattribute:: gini
   .. autoattribute:: inertia_tensor
   .. autoattribute:: isscalar
   .. autoattribute:: kron_aperture
   .. autoattribute:: kron_flux
   .. autoattribute:: kron_fluxerr
   .. autoattribute:: kron_radius
   .. autoattribute:: label
   .. autoattribute:: labels
   .. autoattribute:: local_background
   .. autoattribute:: local_background_aperture
   .. autoattribute:: max_value
   .. autoattribute:: maxval_index
   .. autoattribute:: maxval_xindex
   .. autoattribute:: maxval_yindex
   .. autoattribute:: min_value
   .. autoattribute:: minval_index
   .. autoattribute:: minval_xindex
   .. autoattribute:: minval_yindex
   .. autoattribute:: moments
   .. autoattribute:: moments_central
   .. autoattribute:: nlabels
   .. autoattribute:: orientation
   .. autoattribute:: perimeter
   .. autoattribute:: properties
   .. autoattribute:: segment
   .. autoattribute:: segment_area
   .. autoattribute:: segment_flux
   .. autoattribute:: segment_fluxerr
   .. autoattribute:: segment_ma
   .. autoattribute:: semimajor_sigma
   .. autoattribute:: semiminor_sigma
   .. autoattribute:: sky_bbox_ll
   .. autoattribute:: sky_bbox_lr
   .. autoattribute:: sky_bbox_ul
   .. autoattribute:: sky_bbox_ur
   .. autoattribute:: sky_centroid
   .. autoattribute:: sky_centroid_icrs
   .. autoattribute:: sky_centroid_quad
   .. autoattribute:: sky_centroid_win
   .. autoattribute:: slices
   .. autoattribute:: xcentroid
   .. autoattribute:: xcentroid_quad
   .. autoattribute:: xcentroid_win
   .. autoattribute:: ycentroid
   .. autoattribute:: ycentroid_quad
   .. autoattribute:: ycentroid_win

   .. rubric:: Methods Documentation

   .. automethod:: add_extra_property
   .. automethod:: circular_photometry
   .. automethod:: copy
   .. automethod:: fluxfrac_radius
   .. automethod:: get_label
   .. automethod:: get_labels
   .. automethod:: kron_photometry
   .. automethod:: make_circular_apertures
   .. automethod:: make_cutouts
   .. automethod:: make_kron_apertures
   .. automethod:: plot_circular_apertures
   .. automethod:: plot_kron_apertures
   .. automethod:: remove_extra_properties
   .. automethod:: remove_extra_property
   .. automethod:: rename_extra_property
   .. automethod:: to_table