LSSTApplications  11.0-13-gbb96280,12.1.rc1,12.1.rc1+1,12.1.rc1+2,12.1.rc1+5,12.1.rc1+8,12.1.rc1-1-g06d7636+1,12.1.rc1-1-g253890b+5,12.1.rc1-1-g3d31b68+7,12.1.rc1-1-g3db6b75+1,12.1.rc1-1-g5c1385a+3,12.1.rc1-1-g83b2247,12.1.rc1-1-g90cb4cf+6,12.1.rc1-1-g91da24b+3,12.1.rc1-2-g3521f8a,12.1.rc1-2-g39433dd+4,12.1.rc1-2-g486411b+2,12.1.rc1-2-g4c2be76,12.1.rc1-2-gc9c0491,12.1.rc1-2-gda2cd4f+6,12.1.rc1-3-g3391c73+2,12.1.rc1-3-g8c1bd6c+1,12.1.rc1-3-gcf4b6cb+2,12.1.rc1-4-g057223e+1,12.1.rc1-4-g19ed13b+2,12.1.rc1-4-g30492a7
LSSTDataManagementBasePackage
Classes | Namespaces | Functions
Footprint.h File Reference

Represent a set of pixels of an arbitrary shape and size. More...

#include <algorithm>
#include <list>
#include <set>
#include <cmath>
#include <cstdint>
#include <memory>
#include "ndarray.h"
#include "lsst/base.h"
#include "lsst/pex/policy/Policy.h"
#include "lsst/afw/image/MaskedImage.h"
#include "lsst/afw/image/Wcs.h"
#include "lsst/afw/detection/Peak.h"
#include "lsst/afw/geom.h"
#include "lsst/afw/geom/ellipses.h"
#include "lsst/afw/table/fwd.h"
#include "lsst/afw/table/io/Persistable.h"

Go to the source code of this file.

Classes

class  lsst::afw::detection::Footprint
 A set of pixels in an Image. More...
 

Namespaces

 lsst
 Remove all non-astronomical counts from the Chunk Exposure's pixels.
 
 lsst::afw
 
 lsst::afw::detection
 

Functions

void lsst::afw::detection::nearestFootprint (std::vector< boost::shared_ptr< Footprint >> const &foots, lsst::afw::image::Image< std::uint16_t >::Ptr argmin, lsst::afw::image::Image< std::uint16_t >::Ptr dist)
 
boost::shared_ptr< Footprint > lsst::afw::detection::mergeFootprints (Footprint const &foot1, Footprint const &foot2)
 
boost::shared_ptr< Footprint > lsst::afw::detection::mergeFootprints (Footprint &foot1, Footprint &foot2)
 
boost::shared_ptr< Footprint > lsst::afw::detection::shrinkFootprint (Footprint const &foot, int nGrow, bool isotropic)
 
boost::shared_ptr< Footprint > lsst::afw::detection::growFootprint (Footprint const &foot, int nGrow, bool isotropic=true)
 
boost::shared_ptr< Footprint > lsst::afw::detection::growFootprint (boost::shared_ptr< Footprint > const &foot, int nGrow, bool isotropic=true)
 
boost::shared_ptr< Footprint > lsst::afw::detection::growFootprint (Footprint const &foot, int nGrow, bool left, bool right, bool up, bool down)
 Grow a Footprint in at least one of the cardinal directions, returning a new Footprint. More...
 
std::vector
< lsst::afw::geom::Box2I
lsst::afw::detection::footprintToBBoxList (Footprint const &foot)
 
template<typename ImageT >
ImageT::Pixel lsst::afw::detection::setImageFromFootprint (ImageT *image, Footprint const &footprint, typename ImageT::Pixel const value)
 Set all image pixels in a Footprint to a given value. More...
 
template<typename ImageT >
ImageT::Pixel lsst::afw::detection::setImageFromFootprintList (ImageT *image, boost::shared_ptr< std::vector< boost::shared_ptr< Footprint >> const > footprints, typename ImageT::Pixel const value)
 Set all image pixels in a set of Footprints to a given value. More...
 
template<typename ImageT >
ImageT::Pixel lsst::afw::detection::setImageFromFootprintList (ImageT *image, std::vector< boost::shared_ptr< Footprint >> const &footprints, typename ImageT::Pixel const value)
 Set all image pixels in a set of Footprints to a given value. More...
 
template<typename MaskT >
MaskT lsst::afw::detection::setMaskFromFootprint (lsst::afw::image::Mask< MaskT > *mask, Footprint const &footprint, MaskT const bitmask)
 OR bitmask into all the Mask's pixels that are in the Footprint. More...
 
template<typename MaskT >
MaskT lsst::afw::detection::clearMaskFromFootprint (lsst::afw::image::Mask< MaskT > *mask, Footprint const &footprint, MaskT const bitmask)
 (AND ~bitmask) all the Mask's pixels that are in the Footprint; that is, set to zero in the Mask-intersecting-Footprint all bits that are 1 in then bitmask. More...
 
template<typename ImageOrMaskedImageT >
void lsst::afw::detection::copyWithinFootprint (Footprint const &foot, boost::shared_ptr< ImageOrMaskedImageT > const input, boost::shared_ptr< ImageOrMaskedImageT > output)
 
template<typename MaskT >
MaskT lsst::afw::detection::setMaskFromFootprintList (lsst::afw::image::Mask< MaskT > *mask, std::vector< boost::shared_ptr< Footprint >> const &footprints, MaskT const bitmask)
 OR bitmask into all the Mask's pixels which are in the set of Footprints. More...
 
template<typename MaskT >
MaskT lsst::afw::detection::setMaskFromFootprintList (lsst::afw::image::Mask< MaskT > *mask, boost::shared_ptr< std::vector< boost::shared_ptr< Footprint >> const > const &footprints, MaskT const bitmask)
 OR bitmask into all the Mask's pixels which are in the set of Footprints. More...
 
template<typename MaskT >
boost::shared_ptr< Footprint > lsst::afw::detection::footprintAndMask (boost::shared_ptr< Footprint > const &foot, typename image::Mask< MaskT >::Ptr const &mask, MaskT const bitmask)
 Return a Footprint that's the intersection of a Footprint with a Mask. More...
 

Detailed Description

Represent a set of pixels of an arbitrary shape and size.

Footprint is fundamental in astronomical image processing, as it defines what is meant by a Source.

Definition in file Footprint.h.