LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
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. | |
Public Member Functions | |
template<typename ImagePixelT > | |
FootprintSet (image::Image< ImagePixelT > const &img, Threshold const &threshold, int const npixMin=1, bool const setPeaks=true, table::Schema const &peakSchema=PeakTable::makeMinimalSchema()) | |
Find a FootprintSet given an Image and a threshold. | |
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. | |
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. | |
FootprintSet (lsst::geom::Box2I region) | |
Construct an empty FootprintSet given a region that its footprints would have lived in. | |
FootprintSet (FootprintSet const &rhs) | |
Copy constructor. | |
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. | |
FootprintSet (FootprintSet const &footprints1, FootprintSet const &footprints2, bool const includePeaks) | |
Return the FootprintSet corresponding to the merge of two input FootprintSets. | |
FootprintSet & | operator= (FootprintSet const &rhs) |
Assignment operator. | |
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 | |
void | setFootprints (std::shared_ptr< FootprintList > footprints) |
: Set the Footprints of detected objects | |
std::shared_ptr< FootprintList const > const | getFootprints () const |
Retun the Footprints of detected objects. | |
void | makeSources (afw::table::SourceCatalog &catalog) const |
Add a new record corresponding to each footprint to a SourceCatalog. | |
void | setRegion (lsst::geom::Box2I const ®ion) |
Set the corners of the FootprintSet's MaskedImage to region. | |
lsst::geom::Box2I const | getRegion () const |
Return the corners of the MaskedImage. | |
std::shared_ptr< image::Image< FootprintIdPixel > > | insertIntoImage () const |
Return an Image with pixels set to the Footprints in the FootprintSet. | |
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. | |
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. | |
A set of Footprints, associated with a MaskedImage.
Definition at line 55 of file FootprintSet.h.
The FootprintSet's set of Footprints.
Definition at line 58 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, | ||
table::Schema const & | peakSchema = PeakTable::makeMinimalSchema() ) |
Find a FootprintSet given an Image and a threshold.
peakSchema
is used to preserving the input peak schema when merging FootprintSets.
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? |
peakSchema | Schema for peak records, even if we don't measure them here. |
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 162 of file FootprintSet.h.
|
inline |
Retun the Footprints of detected objects.
Definition at line 172 of file FootprintSet.h.
|
inline |
Return the corners of the MaskedImage.
Definition at line 196 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 | Grow isotropically (as opposed to a Manhattan metric) |
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 167 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 206 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 215 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 146 of file FootprintSet.h.
|
inlinenoexcept |
Definition at line 154 of file FootprintSet.h.