Footprint
=========

.. currentmodule:: lsst.afw.detection

.. autoclass:: Footprint
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Footprint.peaks
      ~Footprint.spans

   .. rubric:: Methods Summary

   .. autosummary::

      ~Footprint.addPeak
      ~Footprint.assign
      ~Footprint.clipTo
      ~Footprint.contains
      ~Footprint.dilate
      ~Footprint.erode
      ~Footprint.getArea
      ~Footprint.getBBox
      ~Footprint.getCentroid
      ~Footprint.getPeaks
      ~Footprint.getRegion
      ~Footprint.getShape
      ~Footprint.getSpans
      ~Footprint.isContiguous
      ~Footprint.isHeavy
      ~Footprint.isPersistable
      ~Footprint.readFits
      ~Footprint.removeOrphanPeaks
      ~Footprint.setPeakCatalog
      ~Footprint.setPeakSchema
      ~Footprint.setRegion
      ~Footprint.setSpans
      ~Footprint.shift
      ~Footprint.sortPeaks
      ~Footprint.split
      ~Footprint.transform
      ~Footprint.writeFits

   .. rubric:: Attributes Documentation

   .. autoattribute:: peaks
   .. autoattribute:: spans

   .. rubric:: Methods Documentation

   .. automethod:: addPeak
   .. automethod:: assign
   .. automethod:: clipTo
   .. automethod:: contains
   .. automethod:: dilate
   .. automethod:: erode
   .. automethod:: getArea
   .. automethod:: getBBox
   .. automethod:: getCentroid
   .. automethod:: getPeaks
   .. automethod:: getRegion
   .. automethod:: getShape
   .. automethod:: getSpans
   .. automethod:: isContiguous
   .. automethod:: isHeavy
   .. automethod:: isPersistable
   .. automethod:: readFits
   .. automethod:: removeOrphanPeaks
   .. automethod:: setPeakCatalog
   .. automethod:: setPeakSchema
   .. automethod:: setRegion
   .. automethod:: setSpans
   .. automethod:: shift
   .. automethod:: sortPeaks
   .. automethod:: split
   .. automethod:: transform
   .. automethod:: writeFits