LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
A set of Footprints, associated with a MaskedImage. More...
#include <FootprintSet.h>
Public Types | |
using | FootprintList = std::vector< std::shared_ptr< Footprint > > |
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=nullptr) |
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 = nullptr |
||
) |
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 && | rhs | ) |
FootprintSet& lsst::afw::detection::FootprintSet::operator= | ( | FootprintSet const & | rhs | ) |
Assignment operator.
|
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.