LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Class to describe the properties of a detected object from an image. More...
#include <Footprint.h>
Public Member Functions | |
Footprint (std::shared_ptr< geom::SpanSet > inputSpans, lsst::geom::Box2I const ®ion=lsst::geom::Box2I()) | |
Constructor for Footprint object. More... | |
Footprint (std::shared_ptr< geom::SpanSet > inputSpans, afw::table::Schema const &peakSchema, lsst::geom::Box2I const ®ion=lsst::geom::Box2I()) | |
Constructor for the Footprint object. More... | |
Footprint () | |
Constructor of a empty Footprint object. More... | |
Footprint (Footprint const &other)=default | |
Footprint (Footprint &&)=default | |
Footprint & | operator= (Footprint const &other)=default |
Footprint & | operator= (Footprint &&)=default |
~Footprint () override=default | |
virtual bool | isHeavy () const |
Indicates if this object is a HeavyFootprint. More... | |
std::shared_ptr< geom::SpanSet > | getSpans () const |
Return a shared pointer to the SpanSet. More... | |
void | setSpans (std::shared_ptr< geom::SpanSet > otherSpanSet) |
Sets the shared pointer to the SpanSet in the Footprint. More... | |
PeakCatalog & | getPeaks () |
Return the Peaks contained in this Footprint. More... | |
const PeakCatalog & | getPeaks () const |
std::shared_ptr< PeakRecord > | addPeak (float fx, float fy, float value) |
Convenience function to add a peak. More... | |
void | sortPeaks (afw::table::Key< float > const &key=afw::table::Key< float >()) |
Sort Peaks from most positive value to most negative. More... | |
void | setPeakSchema (afw::table::Schema const &peakSchema) |
Set the Schema used by the PeakCatalog (will throw if PeakCatalog is not empty). More... | |
void | setPeakCatalog (PeakCatalog const &otherPeaks) |
Set the peakCatalog to a copy of the supplied catalog. More... | |
std::size_t | getArea () const |
Return the number of pixels in this Footprint. More... | |
lsst::geom::Point2D | getCentroid () const |
Return the Footprint's centroid. More... | |
geom::ellipses::Quadrupole | getShape () const |
Return the Footprint's shape (interpreted as an ellipse) More... | |
void | shift (int dx, int dy) |
Shift a Footprint by (dx, dy) More... | |
void | shift (lsst::geom::ExtentI const &d) |
Shift a Footprint by a given extent. More... | |
lsst::geom::Box2I | getBBox () const |
Return the Footprint's bounding box. More... | |
lsst::geom::Box2I | getRegion () const |
Return the corners of the MaskedImage the footprints live in. More... | |
void | setRegion (lsst::geom::Box2I const ®ion) |
Set the corners of the MaskedImage wherein the footprints dwell. More... | |
void | clipTo (lsst::geom::Box2I const &bbox) |
Clip the Footprint such that all values lie inside the supplied Bounding Box. More... | |
bool | contains (lsst::geom::Point2I const &pix) const |
Tests if a pixel postion falls inside the Footprint. More... | |
std::shared_ptr< Footprint > | transform (std::shared_ptr< geom::SkyWcs > source, std::shared_ptr< geom::SkyWcs > target, lsst::geom::Box2I const ®ion, bool doClip=true) const |
Transform the footprint from one WCS to another. More... | |
std::shared_ptr< Footprint > | transform (lsst::geom::LinearTransform const &t, lsst::geom::Box2I const ®ion, bool doClip=true) const |
Return a new Footprint whose pixels are the product of applying the specified transformation. More... | |
std::shared_ptr< Footprint > | transform (lsst::geom::AffineTransform const &t, lsst::geom::Box2I const ®ion, bool doClip=true) const |
Return a new Footprint whose pixels are the product of applying the specified transformation. More... | |
std::shared_ptr< Footprint > | transform (geom::TransformPoint2ToPoint2 const &t, lsst::geom::Box2I const ®ion, bool doClip=true) const |
Return a new Footprint whose pixels are the product of applying the specified transformation. More... | |
bool | isPersistable () const noexcept override |
Report if this object is persistable. More... | |
void | dilate (int r, geom::Stencil s=geom::Stencil::CIRCLE) |
Dilate the Footprint with a defined kernel. More... | |
void | dilate (geom::SpanSet const &other) |
Dilate the Footprint with a defined kernel. More... | |
void | erode (int r, geom::Stencil s=geom::Stencil::CIRCLE) |
Erode the Footprint with a defined kernel. More... | |
void | erode (geom::SpanSet const &other) |
Erode the Footprint with a defined kernel. More... | |
void | removeOrphanPeaks () |
Remove peaks from the PeakCatalog that fall outside the area of the Footprint. More... | |
bool | isContiguous () const |
Reports if the Footprint is simply connected or has multiple components. More... | |
std::vector< std::shared_ptr< Footprint > > | split () const |
Split a multi-component Footprint into a vector of contiguous Footprints. More... | |
bool | operator== (Footprint const &other) const |
equality operator More... | |
void | writeFits (std::string const &fileName, std::string const &mode="w") const |
Write the object to a regular FITS file. More... | |
void | writeFits (fits::MemFileManager &manager, std::string const &mode="w") const |
Write the object to a FITS image in memory. More... | |
void | writeFits (fits::Fits &fitsfile) const |
Write the object to an already-open FITS object. More... | |
Static Public Member Functions | |
static std::shared_ptr< lsst::afw::detection::Footprint > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< lsst::afw::detection::Footprint > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< lsst::afw::detection::Footprint > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< lsst::afw::detection::Footprint > | dynamicCast (std::shared_ptr< Persistable > const &ptr) |
Dynamically cast a shared_ptr. More... | |
Protected Types | |
using | OutputArchiveHandle = io::OutputArchiveHandle |
Protected Member Functions | |
std::string | getPersistenceName () const override |
Return the name correspoinging ot the persistence type. More... | |
std::string | getPythonModule () const override |
Return the python module the object will live in. More... | |
void | write (OutputArchiveHandle &handle) const override |
Write an instance of a Footprint to an output Archive. More... | |
Static Protected Member Functions | |
static std::unique_ptr< Footprint > | readSpanSet (afw::table::BaseCatalog const &, afw::table::io::InputArchive const &) |
Static method used to unpersist the SpanSet member of the Footprint class. More... | |
static void | readPeaks (afw::table::BaseCatalog const &, Footprint &) |
Static method used to unpersist the PeakCatalog member of the Footprint class. More... | |
Friends | |
class | FootprintFactory |
class | FootprintMerge |
Class to describe the properties of a detected object from an image.
A Footprint is designed to be constructed with information about a detected object in an image. Internally a Footprint holds a SpanSet which is used to describe the location of the object in the image (the x, y pixel locations which are considered part of the object). In addition a Footprint contains a PeakCatalog which is used to store the location and intensity of peaks in the detection.
Definition at line 62 of file Footprint.h.
|
protectedinherited |
Definition at line 108 of file Persistable.h.
|
explicit |
Constructor for Footprint object.
inputSpans | Shared pointer to a SpanSet defining the pixels included in the Footprint. |
region | Bounding box of the image in which the Footprint was created, defaults to empty box. |
Definition at line 38 of file Footprint.cc.
|
explicit |
Constructor for the Footprint object.
inputSpans | Shared pointer to a SpanSet defining the pixels included in the Footprint. |
peakSchema | schema to be used in the PeakCatalog |
region | Bounding box of the image in which the Footprint was created, defaults to empty box. |
Definition at line 41 of file Footprint.cc.
|
inlineexplicit |
|
default |
|
default |
|
overridedefault |
std::shared_ptr< PeakRecord > lsst::afw::detection::Footprint::addPeak | ( | float | fx, |
float | fy, | ||
float | value | ||
) |
Convenience function to add a peak.
fx | Float containing the x position of a peak |
fy | Float containing the y position of a peak |
value | The intensity value of the peak |
Definition at line 47 of file Footprint.cc.
void lsst::afw::detection::Footprint::clipTo | ( | lsst::geom::Box2I const & | bbox | ) |
Clip the Footprint such that all values lie inside the supplied Bounding Box.
bbox | Integer box object that defines the boundaries the footprint should be clipped to. |
Definition at line 74 of file Footprint.cc.
bool lsst::afw::detection::Footprint::contains | ( | lsst::geom::Point2I const & | pix | ) | const |
Tests if a pixel postion falls inside the Footprint.
pix | Integer point object defining the position of a pixel to test |
Definition at line 79 of file Footprint.cc.
void lsst::afw::detection::Footprint::dilate | ( | geom::SpanSet const & | other | ) |
Dilate the Footprint with a defined kernel.
This function enlarges the SpanSet which defines the area of the Footprint by an amount governed by the input kernel
other | SpanSet to use as the kernel in dilation |
Definition at line 124 of file Footprint.cc.
void lsst::afw::detection::Footprint::dilate | ( | int | r, |
geom::Stencil | s = geom::Stencil::CIRCLE |
||
) |
Dilate the Footprint with a defined kernel.
This function enlarges the SpanSet which defines the area of the Footprint by an amount governed by in input kernel
r | The radius of the stencil object used to create a dilation kernel |
s | The stencil object used to create the dilation kernel |
Definition at line 122 of file Footprint.cc.
|
staticinherited |
Dynamically cast a shared_ptr.
Dynamically cast a shared pointer and raise on failure.
You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
void lsst::afw::detection::Footprint::erode | ( | geom::SpanSet const & | other | ) |
Erode the Footprint with a defined kernel.
This function reduces the size of the SpanSet which defines the area of the Footprint by an amount governed by the input kernel
other | SpanSet to use as the kernel in erosion |
Definition at line 131 of file Footprint.cc.
void lsst::afw::detection::Footprint::erode | ( | int | r, |
geom::Stencil | s = geom::Stencil::CIRCLE |
||
) |
Erode the Footprint with a defined kernel.
This function reduces the size of the SpanSet which defines the area of the Footprint by an amount governed by the input kernel
r | The radius of the stencil object used to create a erosion kernel |
s | The stencil object used to create the erosion kernel |
Definition at line 126 of file Footprint.cc.
|
inline |
Return the number of pixels in this Footprint.
This function returns the real number of pixels, not the area of the bbox.
Definition at line 173 of file Footprint.h.
|
inline |
Return the Footprint's bounding box.
Definition at line 208 of file Footprint.h.
|
inline |
Return the Footprint's centroid.
The centroid is calculated as the mean of the pixel centers
Definition at line 180 of file Footprint.h.
|
inline |
Return the Peaks contained in this Footprint.
The peaks should be ordered by decreasing pixel intensity at the peak position (so the most negative peak appears last). Users that add new Peaks manually are responsible for maintaining this sorting.
Definition at line 129 of file Footprint.h.
|
inline |
Definition at line 130 of file Footprint.h.
|
overrideprotectedvirtual |
Return the name correspoinging ot the persistence type.
Reimplemented from lsst::afw::table::io::Persistable.
Reimplemented in lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >.
Definition at line 255 of file Footprint.cc.
|
inlineoverrideprotectedvirtual |
Return the python module the object will live in.
Reimplemented from lsst::afw::table::io::Persistable.
Definition at line 362 of file Footprint.h.
|
inline |
Return the corners of the MaskedImage the footprints live in.
Definition at line 213 of file Footprint.h.
|
inline |
Return the Footprint's shape (interpreted as an ellipse)
The shape is determined by measuring the moments of the pixel centers about its centroid (cf. getCentroid)
Definition at line 188 of file Footprint.h.
|
inline |
Return a shared pointer to the SpanSet.
Definition at line 115 of file Footprint.h.
|
inline |
Reports if the Footprint is simply connected or has multiple components.
Definition at line 335 of file Footprint.h.
|
inlinevirtual |
Indicates if this object is a HeavyFootprint.
Reimplemented in lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >.
Definition at line 111 of file Footprint.h.
|
inlineoverridevirtualnoexcept |
Report if this object is persistable.
Reimplemented from lsst::afw::table::io::Persistable.
Definition at line 283 of file Footprint.h.
bool lsst::afw::detection::Footprint::operator== | ( | Footprint const & | other | ) | const |
equality operator
other | The Footprint for which equality will be computed |
Definition at line 162 of file Footprint.cc.
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[in] | manager | Manager for the memory to read from. |
[in] | hdu | HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty. |
Definition at line 205 of file Persistable.h.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[in] | fileName | Name of the file to read. |
[in] | hdu | HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty. |
Definition at line 194 of file Persistable.h.
|
staticprotected |
Static method used to unpersist the PeakCatalog member of the Footprint class.
Definition at line 296 of file Footprint.cc.
|
staticprotected |
Static method used to unpersist the SpanSet member of the Footprint class.
Definition at line 272 of file Footprint.cc.
void lsst::afw::detection::Footprint::removeOrphanPeaks | ( | ) |
Remove peaks from the PeakCatalog that fall outside the area of the Footprint.
Definition at line 136 of file Footprint.cc.
void lsst::afw::detection::Footprint::setPeakCatalog | ( | PeakCatalog const & | otherPeaks | ) |
Set the peakCatalog to a copy of the supplied catalog.
PeakCatalog will be copied into the Footprint, but a PeakCatalog is a shallow copy, so records will not be duplicated. This function will throw an error if the PeakCatalog of *this is not empty.
otherPeaks | The PeakCatalog to copy |
Definition at line 421 of file Footprint.cc.
void lsst::afw::detection::Footprint::setPeakSchema | ( | afw::table::Schema const & | peakSchema | ) |
Set the Schema used by the PeakCatalog (will throw if PeakCatalog is not empty).
peakSchema | The schema to use in the PeakCatalog |
pex::exceptions::LogicError | Thrown if if the PeakCatalog is not empty |
Definition at line 417 of file Footprint.cc.
|
inline |
Set the corners of the MaskedImage wherein the footprints dwell.
region | A box describing the corners of the Image the Footprint derives from |
Definition at line 220 of file Footprint.h.
void lsst::afw::detection::Footprint::setSpans | ( | std::shared_ptr< geom::SpanSet > | otherSpanSet | ) |
Sets the shared pointer to the SpanSet in the Footprint.
otherSpanSet | Shared pointer to a SpanSet |
Definition at line 45 of file Footprint.cc.
void lsst::afw::detection::Footprint::shift | ( | int | dx, |
int | dy | ||
) |
Shift a Footprint by (dx, dy)
dx | How much to move Footprint in column direction |
dy | How much to move in row direction |
Definition at line 64 of file Footprint.cc.
|
inline |
Shift a Footprint by a given extent.
d | ExtentI object which gives the dimensions the Footprint should be shifted |
Definition at line 203 of file Footprint.h.
void lsst::afw::detection::Footprint::sortPeaks | ( | afw::table::Key< float > const & | key = afw::table::Key<float>() | ) |
Sort Peaks from most positive value to most negative.
If the key passed is invalid (the default) PeakTable::getPeakValueKey() will be used.
key | A key corresponding to the field in the Schema the PeakCatalog is to be sorted by. |
Definition at line 57 of file Footprint.cc.
std::vector< std::shared_ptr< Footprint > > lsst::afw::detection::Footprint::split | ( | ) | const |
Split a multi-component Footprint into a vector of contiguous Footprints.
Split a multi-component Footprint such that each Footprint in the output vector is contiguous and contains only peaks that can be found within the bounds of the Footprint
Definition at line 145 of file Footprint.cc.
std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform | ( | geom::TransformPoint2ToPoint2 const & | t, |
lsst::geom::Box2I const & | region, | ||
bool | doClip = true |
||
) | const |
Return a new Footprint whose pixels are the product of applying the specified transformation.
t | A 2-D transform which will be used to map the pixels |
region | Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box. |
doClip | If true, clip the new footprint to the region bbox before returning it. |
Definition at line 98 of file Footprint.cc.
std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform | ( | lsst::geom::AffineTransform const & | t, |
lsst::geom::Box2I const & | region, | ||
bool | doClip = true |
||
) | const |
Return a new Footprint whose pixels are the product of applying the specified transformation.
t | An affine transform object which will be used to map the pixels |
region | Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box. |
doClip | If true, clip the new footprint to the region bbox before returning it. |
Definition at line 93 of file Footprint.cc.
std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform | ( | lsst::geom::LinearTransform const & | t, |
lsst::geom::Box2I const & | region, | ||
bool | doClip = true |
||
) | const |
Return a new Footprint whose pixels are the product of applying the specified transformation.
t | A linear transform object which will be used to map the pixels |
region | Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box. |
doClip | If true, clip the new footprint to the region bbox before returning it. |
Definition at line 88 of file Footprint.cc.
std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform | ( | std::shared_ptr< geom::SkyWcs > | source, |
std::shared_ptr< geom::SkyWcs > | target, | ||
lsst::geom::Box2I const & | region, | ||
bool | doClip = true |
||
) | const |
Transform the footprint from one WCS to another.
source | Wcs that defines the coordinate system of the input footprint. |
target | Wcs that defines that desired coordinate system of the returned footprint. |
region | Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box. |
doClip | If true, clip the new footprint to the region bbox before returning it. |
Definition at line 81 of file Footprint.cc.
|
overrideprotectedvirtual |
Write an instance of a Footprint to an output Archive.
Reimplemented from lsst::afw::table::io::Persistable.
Reimplemented in lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >.
Definition at line 257 of file Footprint.cc.
|
inherited |
Write the object to an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
|
inherited |
Write the object to a FITS image in memory.
[in] | manager | Name of the file to write to. |
[in] | mode | If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file. |
Definition at line 29 of file Persistable.cc.
|
inherited |
Write the object to a regular FITS file.
[in] | fileName | Name of the file to write to. |
[in] | mode | If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file. |
Definition at line 24 of file Persistable.cc.
|
friend |
Definition at line 369 of file Footprint.h.
|
friend |
Definition at line 382 of file Footprint.h.