LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
A set of Footprints, associated with a MaskedImage. More...
#include <FootprintSet.h>
Public Types | |
typedef std::vector< std::shared_ptr< Footprint > > | FootprintList |
The FootprintSet's set of Footprints. More... | |
Public Member Functions | |
template<typename ImagePixelT > | |
FootprintSet (image::Image< ImagePixelT > const &img, Threshold const &threshold, int const npixMin=1, bool const setPeaks=true) | |
Find a FootprintSet given an Image and a threshold. More... | |
template<typename MaskPixelT > | |
FootprintSet (image::Mask< MaskPixelT > const &img, Threshold const &threshold, int const npixMin=1) | |
Find a FootprintSet given a Mask and a threshold. More... | |
template<typename ImagePixelT , typename MaskPixelT > | |
FootprintSet (image::MaskedImage< ImagePixelT, MaskPixelT > const &img, Threshold const &threshold, std::string const &planeName="", int const npixMin=1, bool const setPeaks=true) | |
Find a FootprintSet given a MaskedImage and a threshold. More... | |
FootprintSet (lsst::geom::Box2I region) | |
Construct an empty FootprintSet given a region that its footprints would have lived in. More... | |
FootprintSet (FootprintSet const &rhs) | |
Copy constructor. More... | |
FootprintSet (FootprintSet const &set, int rGrow, FootprintControl const &ctrl) | |
FootprintSet (FootprintSet &&rhs) | |
~FootprintSet () | |
FootprintSet (FootprintSet const &set, int rGrow, bool isotropic=true) | |
Grow all the Footprints in the input FootprintSet, returning a new FootprintSet. More... | |
FootprintSet (FootprintSet const &footprints1, FootprintSet const &footprints2, bool const includePeaks) | |
Return the FootprintSet corresponding to the merge of two input FootprintSets. More... | |
FootprintSet & | operator= (FootprintSet const &rhs) |
Assignment operator. More... | |
FootprintSet & | operator= (FootprintSet &&rhs) |
void | swap (FootprintSet &rhs) noexcept |
void | swapFootprintList (FootprintList &rhs) noexcept |
std::shared_ptr< FootprintList > | getFootprints () |
: Return the Footprints of detected objects More... | |
void | setFootprints (std::shared_ptr< FootprintList > footprints) |
: Set the Footprints of detected objects More... | |
std::shared_ptr< FootprintList const > const | getFootprints () const |
Retun the Footprints of detected objects. More... | |
void | makeSources (afw::table::SourceCatalog &catalog) const |
Add a new record corresponding to each footprint to a SourceCatalog. More... | |
void | setRegion (lsst::geom::Box2I const ®ion) |
Set the corners of the FootprintSet's MaskedImage to region. More... | |
lsst::geom::Box2I const | getRegion () const |
Return the corners of the MaskedImage. More... | |
std::shared_ptr< image::Image< FootprintIdPixel > > | insertIntoImage () const |
Return an Image with pixels set to the Footprints in the FootprintSet. More... | |
template<typename MaskPixelT > | |
void | setMask (image::Mask< MaskPixelT > *mask, std::string const &planeName) |
template<typename MaskPixelT > | |
void | setMask (std::shared_ptr< image::Mask< MaskPixelT >> mask, std::string const &planeName) |
void | merge (FootprintSet const &rhs, int tGrow=0, int rGrow=0, bool isotropic=true) |
Merge a FootprintSet into *this. More... | |
template<typename ImagePixelT , typename MaskPixelT > | |
void | makeHeavy (image::MaskedImage< ImagePixelT, MaskPixelT > const &mimg, HeavyFootprintCtrl const *ctrl=NULL) |
Convert all the Footprints in the FootprintSet to be HeavyFootprints. More... | |
A set of Footprints, associated with a MaskedImage.
Definition at line 53 of file FootprintSet.h.
The FootprintSet's set of Footprints.
Definition at line 56 of file FootprintSet.h.
lsst::afw::detection::FootprintSet::FootprintSet | ( | image::Image< ImagePixelT > const & | img, |
Threshold const & | threshold, | ||
int const | npixMin = 1 , |
||
bool const | setPeaks = true |
||
) |
Find a FootprintSet given an Image and a threshold.
img | Image to search for objects |
threshold | threshold to find objects |
npixMin | minimum number of pixels in an object |
setPeaks | should I set the Peaks list? |
lsst::afw::detection::FootprintSet::FootprintSet | ( | image::Mask< MaskPixelT > const & | img, |
Threshold const & | threshold, | ||
int const | npixMin = 1 |
||
) |
Find a FootprintSet given a Mask and a threshold.
img | Image to search for objects |
threshold | threshold to find objects |
npixMin | minimum number of pixels in an object |
lsst::afw::detection::FootprintSet::FootprintSet | ( | image::MaskedImage< ImagePixelT, MaskPixelT > const & | img, |
Threshold const & | threshold, | ||
std::string const & | planeName = "" , |
||
int const | npixMin = 1 , |
||
bool const | setPeaks = true |
||
) |
Find a FootprintSet given a MaskedImage and a threshold.
Go through an image, finding sets of connected pixels above threshold and assembling them into Footprints; the resulting set of objects is returned
If threshold.getPolarity() is true, pixels above the Threshold are assembled into Footprints; if it's false, then pixels below Threshold are processed (Threshold will probably have to be below the background level for this to make sense, e.g. for difference imaging)
img | MaskedImage to search for objects |
threshold | threshold for footprints (controls size) |
planeName | mask plane to set (if != "") |
npixMin | minimum number of pixels in an object |
setPeaks | should I set the Peaks list? |
lsst::afw::detection::FootprintSet::FootprintSet | ( | lsst::geom::Box2I | region | ) |
Construct an empty FootprintSet given a region that its footprints would have lived in.
region | the desired region |
lsst::afw::detection::FootprintSet::FootprintSet | ( | FootprintSet const & | rhs | ) |
Copy constructor.
rhs | the input FootprintSet |
lsst::afw::detection::FootprintSet::FootprintSet | ( | FootprintSet const & | set, |
int | rGrow, | ||
FootprintControl const & | ctrl | ||
) |
lsst::afw::detection::FootprintSet::FootprintSet | ( | FootprintSet && | rhs | ) |
lsst::afw::detection::FootprintSet::~FootprintSet | ( | ) |
lsst::afw::detection::FootprintSet::FootprintSet | ( | FootprintSet const & | set, |
int | rGrow, | ||
bool | isotropic = true |
||
) |
Grow all the Footprints in the input FootprintSet, returning a new FootprintSet.
The output FootprintSet may contain fewer Footprints, as some may well have been merged
set | the input FootprintSet |
rGrow | Grow Footprints by r pixels |
isotropic | Grow isotropically (as opposed to a Manhattan metric) |
lsst::afw::detection::FootprintSet::FootprintSet | ( | FootprintSet const & | footprints1, |
FootprintSet const & | footprints2, | ||
bool const | includePeaks | ||
) |
Return the FootprintSet corresponding to the merge of two input FootprintSets.
|
inline |
: Return the Footprints of detected objects
Definition at line 156 of file FootprintSet.h.
|
inline |
Retun the Footprints of detected objects.
Definition at line 166 of file FootprintSet.h.
|
inline |
Return the corners of the MaskedImage.
Definition at line 190 of file FootprintSet.h.
std::shared_ptr<image::Image<FootprintIdPixel> > lsst::afw::detection::FootprintSet::insertIntoImage | ( | ) | const |
Return an Image with pixels set to the Footprints in the FootprintSet.
void lsst::afw::detection::FootprintSet::makeHeavy | ( | image::MaskedImage< ImagePixelT, MaskPixelT > const & | mimg, |
HeavyFootprintCtrl const * | ctrl = NULL |
||
) |
Convert all the Footprints in the FootprintSet to be HeavyFootprints.
mimg | the image providing pixel values |
ctrl | Control how we manipulate HeavyFootprints |
void lsst::afw::detection::FootprintSet::makeSources | ( | afw::table::SourceCatalog & | catalog | ) | const |
Add a new record corresponding to each footprint to a SourceCatalog.
[in,out] | catalog | Catalog to append new sources to. |
The new sources will have their footprints set to point to the footprints in the footprint set; they will not be deep-copied.
void lsst::afw::detection::FootprintSet::merge | ( | FootprintSet const & | rhs, |
int | tGrow = 0 , |
||
int | rGrow = 0 , |
||
bool | isotropic = true |
||
) |
Merge a FootprintSet into *this.
rhs | the Footprints to merge |
tGrow | No. of pixels to grow this Footprints |
rGrow | No. of pixels to grow rhs Footprints |
isotropic | Use (expensive) isotropic grow |
FootprintSet& lsst::afw::detection::FootprintSet::operator= | ( | FootprintSet const & | rhs | ) |
Assignment operator.
FootprintSet& lsst::afw::detection::FootprintSet::operator= | ( | FootprintSet && | rhs | ) |
|
inline |
: Set the Footprints of detected objects
Definition at line 161 of file FootprintSet.h.
|
inline |
mask | Set bits in the mask |
planeName | Here's the name of the mask plane to fit |
Definition at line 200 of file FootprintSet.h.
|
inline |
mask | Set bits in the mask |
planeName | Here's the name of the mask plane to fit |
Definition at line 209 of file FootprintSet.h.
void lsst::afw::detection::FootprintSet::setRegion | ( | lsst::geom::Box2I const & | region | ) |
Set the corners of the FootprintSet's MaskedImage to region.
region | desired region |
|
inlinenoexcept |
Definition at line 140 of file FootprintSet.h.
|
inlinenoexcept |
Definition at line 148 of file FootprintSet.h.