LSST Applications g0aad566f14+98bdd3b178,g0dd44d6229+e0c2448475,g2079a07aa2+86d27d4dc4,g2305ad1205+28192cebb5,g2bbee38e9b+047b288a59,g337abbeb29+047b288a59,g33d1c0ed96+047b288a59,g3a166c0a6a+047b288a59,g3d1719c13e+98bdd3b178,g487adcacf7+08349b74a1,g4be5004598+98bdd3b178,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+742623b69a,g63cd9335cc+585e252eca,g858d7b2824+98bdd3b178,g88963caddf+0cb8e002cc,g88c60e1ba4+10d1129650,g99cad8db69+26979ce5a5,g9ddcbc5298+9a081db1e4,ga1e77700b3+a912195c07,gae0086650b+585e252eca,gb0e22166c9+60f28cb32d,gb1fda7adca+90d62c6f66,gb3a676b8dc+b4feba26a1,gb4b16eec92+950562e714,gba4ed39666+c2a2e4ac27,gbb8dafda3b+2fe9a6a885,gc120e1dc64+0553034b2f,gc28159a63d+047b288a59,gc3e9b769f7+f8a3f20ab6,gcf0d15dbbd+e0c2448475,gdaeeff99f8+f9a426f77a,gdb0af172c8+f61b8374e1,ge79ae78c31+047b288a59,w.2024.20
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > Class Template Reference

A set of pixels in an Image, including those pixels' actual values. More...

#include <HeavyFootprint.h>

Inheritance diagram for lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >:
lsst::afw::table::io::PersistableFacade< T > lsst::afw::detection::Footprint lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint > lsst::afw::table::io::Persistable

Classes

class  Factory
 

Public Member Functions

 HeavyFootprint (Footprint const &foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &mimage, HeavyFootprintCtrl const *ctrl=nullptr)
 Create a HeavyFootprint from a regular Footprint and the image that provides the pixel values.
 
 HeavyFootprint (Footprint const &foot, HeavyFootprintCtrl const *ctrl=nullptr)
 Create a HeavyFootprint from a regular Footprint, allocating space to hold foot.getArea() pixels, but not initializing them.
 
 HeavyFootprint ()=default
 Default constructor for HeavyFootprint.
 
 ~HeavyFootprint () override=default
 
 HeavyFootprint (HeavyFootprint const &other)=default
 
 HeavyFootprint (HeavyFootprint &&other)=default
 
HeavyFootprintoperator= (HeavyFootprint const &)=default
 
HeavyFootprintoperator= (HeavyFootprint &&)=default
 
bool isHeavy () const override
 Is this a HeavyFootprint (yes!)
 
void insert (lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &mimage) const
 Replace all the pixels in the image with the values in the HeavyFootprint.
 
void insert (lsst::afw::image::Image< ImagePixelT > &image) const
 Replace all the pixels in the image with the values in the HeavyFootprint.
 
ndarray::Array< ImagePixelT, 1, 1 > getImageArray ()
 
ndarray::Array< MaskPixelT, 1, 1 > getMaskArray ()
 
ndarray::Array< VariancePixelT, 1, 1 > getVarianceArray ()
 
ndarray::Array< ImagePixelT const, 1, 1 > getImageArray () const
 
ndarray::Array< MaskPixelT const, 1, 1 > getMaskArray () const
 
ndarray::Array< VariancePixelT const, 1, 1 > getVarianceArray () const
 
MaskPixelT getMaskBitsSet () const
 
double dot (HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &other) const
 Dot product between HeavyFootprints.
 
std::shared_ptr< geom::SpanSet > getSpans () const
 Return a shared pointer to the SpanSet.
 
void setSpans (std::shared_ptr< geom::SpanSet > otherSpanSet)
 Sets the shared pointer to the SpanSet in the Footprint.
 
PeakCataloggetPeaks ()
 Return the Peaks contained in this Footprint.
 
const PeakCataloggetPeaks () const
 
std::shared_ptr< PeakRecordaddPeak (float fx, float fy, float value)
 Convenience function to add a peak.
 
void sortPeaks (afw::table::Key< float > const &key=afw::table::Key< float >())
 Sort Peaks from most positive value to most negative.
 
void setPeakSchema (afw::table::Schema const &peakSchema)
 Set the Schema used by the PeakCatalog (will throw if PeakCatalog is not empty).
 
void setPeakCatalog (PeakCatalog const &otherPeaks)
 Set the peakCatalog to a copy of the supplied catalog.
 
std::size_t getArea () const
 Return the number of pixels in this Footprint.
 
lsst::geom::Point2D getCentroid () const
 Return the Footprint's centroid.
 
geom::ellipses::Quadrupole getShape () const
 Return the Footprint's shape (interpreted as an ellipse)
 
void shift (int dx, int dy)
 Shift a Footprint by (dx, dy)
 
void shift (lsst::geom::ExtentI const &d)
 Shift a Footprint by a given extent.
 
lsst::geom::Box2I getBBox () const
 Return the Footprint's bounding box.
 
lsst::geom::Box2I getRegion () const
 Return the corners of the MaskedImage the footprints live in.
 
void setRegion (lsst::geom::Box2I const &region)
 Set the corners of the MaskedImage wherein the footprints dwell.
 
void clipTo (lsst::geom::Box2I const &bbox)
 Clip the Footprint such that all values lie inside the supplied Bounding Box.
 
bool contains (lsst::geom::Point2I const &pix) const
 Tests if a pixel postion falls inside the Footprint.
 
std::shared_ptr< Footprinttransform (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.
 
std::shared_ptr< Footprinttransform (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.
 
std::shared_ptr< Footprinttransform (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.
 
std::shared_ptr< Footprinttransform (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.
 
bool isPersistable () const noexcept override
 Report if this object is persistable.
 
void dilate (int r, geom::Stencil s=geom::Stencil::CIRCLE)
 Dilate the Footprint with a defined kernel.
 
void dilate (geom::SpanSet const &other)
 Dilate the Footprint with a defined kernel.
 
void erode (int r, geom::Stencil s=geom::Stencil::CIRCLE)
 Erode the Footprint with a defined kernel.
 
void erode (geom::SpanSet const &other)
 Erode the Footprint with a defined kernel.
 
void removeOrphanPeaks ()
 Remove peaks from the PeakCatalog that fall outside the area of the Footprint.
 
void updatePeakSignificance (double sigma)
 Compute and update the significance of each peak, given a single value for sigma.
 
void updatePeakSignificance (image::Image< float > const &variance, int polarity)
 Compute and update the significance of each peak, using the variance image.
 
bool isContiguous () const
 Reports if the Footprint is simply connected or has multiple components.
 
std::vector< std::shared_ptr< Footprint > > split () const
 Split a multi-component Footprint into a vector of contiguous Footprints.
 
bool operator== (Footprint const &other) const
 equality operator
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file.
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory.
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object.
 

Static Public Member Functions

static std::shared_ptr< T > readFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object.
 
static std::shared_ptr< T > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file.
 
static std::shared_ptr< T > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory.
 
static std::shared_ptr< T > dynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr.
 
static std::shared_ptr< lsst::afw::detection::FootprintreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object.
 
static std::shared_ptr< lsst::afw::detection::FootprintreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file.
 
static std::shared_ptr< lsst::afw::detection::FootprintreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory.
 
static std::shared_ptr< lsst::afw::detection::FootprintdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr.
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

std::string getPersistenceName () const override
 Return the name correspoinging ot the persistence type.
 
void write (OutputArchiveHandle &handle) const override
 Write an instance of a Footprint to an output Archive.
 
std::string getPythonModule () const override
 Return the python module the object will live in.
 

Static Protected Member Functions

static std::unique_ptr< FootprintreadSpanSet (afw::table::BaseCatalog const &, afw::table::io::InputArchive const &)
 Static method used to unpersist the SpanSet member of the Footprint class.
 
static void readPeaks (afw::table::BaseCatalog const &, Footprint &)
 Static method used to unpersist the PeakCatalog member of the Footprint class.
 

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
class lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >

A set of pixels in an Image, including those pixels' actual values.

Definition at line 47 of file HeavyFootprint.h.

Member Typedef Documentation

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ HeavyFootprint() [1/5]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( Footprint const & foot,
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const & mimage,
HeavyFootprintCtrl const * ctrl = nullptr )
explicit

Create a HeavyFootprint from a regular Footprint and the image that provides the pixel values.

Parameters
footThe Footprint defining the pixels to set
mimageThe pixel values
ctrlControl how we manipulate HeavyFootprints
Note
the HeavyFootprintCtrl is passed by const* not const& so that we needn't provide a definition in the header.

Definition at line 71 of file HeavyFootprint.cc.

74 : Footprint(foot),
75 _image(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
76 _mask(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
77 _variance(ndarray::allocate(ndarray::makeVector(foot.getArea()))) {
78 HeavyFootprintCtrl ctrl_s = HeavyFootprintCtrl();
79
80 if (!ctrl) {
81 ctrl = &ctrl_s;
82 }
83
84 switch (ctrl->getModifySource()) {
86 getSpans()->flatten(_image, mimage.getImage()->getArray(), mimage.getXY0());
87 getSpans()->flatten(_mask, mimage.getMask()->getArray(), mimage.getXY0());
88 getSpans()->flatten(_variance, mimage.getVariance()->getArray(), mimage.getXY0());
89 break;
91 ImagePixelT const ival = ctrl->getImageVal();
92 MaskPixelT const mval = ctrl->getMaskVal();
93 VariancePixelT const vval = ctrl->getVarianceVal();
94
95 getSpans()->applyFunctor(FlattenWithSetter<ImagePixelT>(ival), ndarray::ndFlat(_image),
96 ndarray::ndImage(mimage.getImage()->getArray(), mimage.getXY0()));
97 getSpans()->applyFunctor(FlattenWithSetter<MaskPixelT>(mval), ndarray::ndFlat(_mask),
98 ndarray::ndImage(mimage.getMask()->getArray(), mimage.getXY0()));
99 getSpans()->applyFunctor(FlattenWithSetter<VariancePixelT>(vval), ndarray::ndFlat(_variance),
100 ndarray::ndImage(mimage.getVariance()->getArray(), mimage.getXY0()));
101 break;
102 }
103 }
104}
Footprint()
Constructor of a empty Footprint object.
Definition Footprint.h:96
std::shared_ptr< geom::SpanSet > getSpans() const
Return a shared pointer to the SpanSet.
Definition Footprint.h:115
lsst::geom::Point2I getXY0() const
Return the image's origin.
VariancePtr getVariance() const
Return a (shared_ptr to) the MaskedImage's variance.
MaskPtr getMask() const
Return a (shared_ptr to) the MaskedImage's mask.
ImagePtr getImage() const
Return a (shared_ptr to) the MaskedImage's image.
details::ImageNdGetter< T, inA, inB > ndImage(ndarray::Array< T, inA, inB > const &array, lsst::geom::Point2I xy0=lsst::geom::Point2I())
Marks a ndarray to be interpreted as an image when applying a functor from a SpanSet.
details::FlatNdGetter< T, inA, inB > ndFlat(ndarray::Array< T, inA, inB > const &array)
Marks a ndarray to be interpreted as a 1D vector when applying a functor from a SpanSet.

◆ HeavyFootprint() [2/5]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( Footprint const & foot,
HeavyFootprintCtrl const * ctrl = nullptr )
explicit

Create a HeavyFootprint from a regular Footprint, allocating space to hold foot.getArea() pixels, but not initializing them.

This is used when unpersisting a HeavyFootprint.

Parameters
footThe Footprint defining the pixels to set
ctrlControl how we manipulate HeavyFootprints

Definition at line 107 of file HeavyFootprint.cc.

109 : Footprint(foot),
110 _image(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
111 _mask(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
112 _variance(ndarray::allocate(ndarray::makeVector(foot.getArea()))) {}

◆ HeavyFootprint() [3/5]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( )
default

Default constructor for HeavyFootprint.

Most common use for this will be in combination with the assignment operator

◆ ~HeavyFootprint()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::~HeavyFootprint ( )
overridedefault

◆ HeavyFootprint() [4/5]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const & other)
default

◆ HeavyFootprint() [5/5]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > && other)
default

Member Function Documentation

◆ addPeak()

std::shared_ptr< PeakRecord > Footprint::addPeak ( float fx,
float fy,
float value )
inherited

Convenience function to add a peak.

Parameters
fxFloat containing the x position of a peak
fyFloat containing the y position of a peak
valueThe intensity value of the peak

Definition at line 47 of file Footprint.cc.

47 {
49 p->setIx(fx);
50 p->setIy(fy);
51 p->setFx(fx);
52 p->setFy(fy);
53 p->setPeakValue(height);
54 return p;
55}
PeakCatalog & getPeaks()
Return the Peaks contained in this Footprint.
Definition Footprint.h:129
std::shared_ptr< RecordT > addNew()
Create a new record, add it to the end of the catalog, and return a pointer to it.
Definition Catalog.h:489

◆ clipTo()

void Footprint::clipTo ( lsst::geom::Box2I const & bbox)
inherited

Clip the Footprint such that all values lie inside the supplied Bounding Box.

Parameters
bboxInteger box object that defines the boundaries the footprint should be clipped to.

Definition at line 74 of file Footprint.cc.

74 {
75 setSpans(getSpans()->clippedTo(box));
77}
void removeOrphanPeaks()
Remove peaks from the PeakCatalog that fall outside the area of the Footprint.
Definition Footprint.cc:136
void setSpans(std::shared_ptr< geom::SpanSet > otherSpanSet)
Sets the shared pointer to the SpanSet in the Footprint.
Definition Footprint.cc:45

◆ contains()

bool Footprint::contains ( lsst::geom::Point2I const & pix) const
inherited

Tests if a pixel postion falls inside the Footprint.

Parameters
pixInteger point object defining the position of a pixel to test

Definition at line 79 of file Footprint.cc.

79{ return getSpans()->contains(pix); }

◆ dilate() [1/2]

void Footprint::dilate ( geom::SpanSet const & other)
inherited

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

Parameters
otherSpanSet to use as the kernel in dilation

Definition at line 124 of file Footprint.cc.

124{ setSpans(getSpans()->dilated(other)); }

◆ dilate() [2/2]

void Footprint::dilate ( int r,
geom::Stencil s = geom::Stencil::CIRCLE )
inherited

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

Parameters
rThe radius of the stencil object used to create a dilation kernel
sThe stencil object used to create the dilation kernel

Definition at line 122 of file Footprint.cc.

122{ setSpans(getSpans()->dilated(r, s)); }

◆ dot()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
double lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::dot ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const & other) const

Dot product between HeavyFootprints.

The mask and variance planes are ignored.

Definition at line 151 of file HeavyFootprint.cc.

152 {
153 // Coordinated cycling through the iterators while juggling the offsets into the arrays
154 using ArrayIter = typename ndarray::Array<const ImagePixelT, 1, 1>::Iterator;
155 ArrayIter lhsArray = getImageArray().begin(), rhsArray = rhs.getImageArray().begin();
156 auto lhsIter = getSpans()->begin(), rhsIter = rhs.getSpans()->begin();
157 auto const lhsEnd = getSpans()->end(), rhsEnd = rhs.getSpans()->end();
158 double sum = 0.0;
159 while (lhsIter != lhsEnd && rhsIter != rhsEnd) {
160 geom::Span const &lhsSpan = *lhsIter, rhsSpan = *rhsIter;
161 int const yLhs = lhsSpan.getY(), yRhs = rhsSpan.getY();
162 if (yLhs == yRhs) {
163 int const x0Lhs = lhsSpan.getX0(), x1Lhs = lhsSpan.getX1();
164 int const x0Rhs = rhsSpan.getX0(), x1Rhs = rhsSpan.getX1();
165 int const xMin = std::max(x0Lhs, x0Rhs), xMax = std::min(x1Lhs, x1Rhs);
166 if (xMin <= xMax) {
167 lhsArray += xMin - x0Lhs;
168 rhsArray += xMin - x0Rhs;
169 for (int x = xMin; x <= xMax; ++x, ++lhsArray, ++rhsArray) {
170 sum += (*lhsArray) * (*rhsArray);
171 }
172 // Rewind to the start of the span, for easier sync between spans and arrays
173 lhsArray -= xMax + 1 - x0Lhs;
174 rhsArray -= xMax + 1 - x0Rhs;
175 }
176 if (x1Lhs <= x1Rhs) {
177 lhsArray += lhsSpan.getWidth();
178 ++lhsIter;
179 } else {
180 rhsArray += rhsSpan.getWidth();
181 ++rhsIter;
182 }
183 continue;
184 } else if (yLhs < yRhs) {
185 while (lhsIter != lhsEnd && lhsIter->getY() < yRhs) {
186 lhsArray += lhsIter->getWidth();
187 ++lhsIter;
188 }
189 continue;
190 } else { // yLhs > yRhs
191 while (rhsIter != rhsEnd && rhsIter->getY() < yLhs) {
192 rhsArray += rhsIter->getWidth();
193 ++rhsIter;
194 }
195 continue;
196 }
197 }
198 return sum;
199}
ndarray::Array< ImagePixelT, 1, 1 > getImageArray()
T max(T... args)
T min(T... args)

◆ dynamicCast() [1/2]

template<typename T >
template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< T >::dynamicCast ( std::shared_ptr< Persistable > const & ptr)
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;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

18 {
19 auto result = std::dynamic_pointer_cast<T>(ptr);
20 if (!result) {
21 throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22 }
23 return result;
24}
py::object result
Definition _schema.cc:429
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
uint64_t * ptr
Definition RangeSet.cc:95

◆ dynamicCast() [2/2]

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;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

◆ erode() [1/2]

void Footprint::erode ( geom::SpanSet const & other)
inherited

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

Parameters
otherSpanSet to use as the kernel in erosion

Definition at line 131 of file Footprint.cc.

131 {
132 setSpans(getSpans()->eroded(other));
134}

◆ erode() [2/2]

void Footprint::erode ( int r,
geom::Stencil s = geom::Stencil::CIRCLE )
inherited

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

Parameters
rThe radius of the stencil object used to create a erosion kernel
sThe stencil object used to create the erosion kernel

Definition at line 126 of file Footprint.cc.

126 {
127 setSpans(getSpans()->eroded(r, s));
129}

◆ getArea()

std::size_t lsst::afw::detection::Footprint::getArea ( ) const
inlineinherited

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.

173{ return _spans->getArea(); }

◆ getBBox()

lsst::geom::Box2I lsst::afw::detection::Footprint::getBBox ( ) const
inlineinherited

Return the Footprint's bounding box.

Definition at line 208 of file Footprint.h.

208{ return _spans->getBBox(); }

◆ getCentroid()

lsst::geom::Point2D lsst::afw::detection::Footprint::getCentroid ( ) const
inlineinherited

Return the Footprint's centroid.

The centroid is calculated as the mean of the pixel centers

Definition at line 180 of file Footprint.h.

180{ return _spans->computeCentroid(); }

◆ getImageArray() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ndarray::Array< ImagePixelT, 1, 1 > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getImageArray ( )
inline

Definition at line 107 of file HeavyFootprint.h.

107{ return _image; }

◆ getImageArray() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ndarray::Array< ImagePixelT const, 1, 1 > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getImageArray ( ) const
inline

Definition at line 111 of file HeavyFootprint.h.

111{ return _image; }

◆ getMaskArray() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ndarray::Array< MaskPixelT, 1, 1 > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getMaskArray ( )
inline

Definition at line 108 of file HeavyFootprint.h.

108{ return _mask; }

◆ getMaskArray() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ndarray::Array< MaskPixelT const, 1, 1 > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getMaskArray ( ) const
inline

Definition at line 112 of file HeavyFootprint.h.

112{ return _mask; }

◆ getMaskBitsSet()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
MaskPixelT lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getMaskBitsSet ( ) const
inline

Definition at line 116 of file HeavyFootprint.h.

116 {
117 MaskPixelT maskbits = 0;
118 for (typename ndarray::Array<MaskPixelT, 1, 1>::Iterator i = _mask.begin(); i != _mask.end(); ++i) {
119 maskbits |= *i;
120 }
121 return maskbits;
122 }

◆ getPeaks() [1/2]

PeakCatalog & lsst::afw::detection::Footprint::getPeaks ( )
inlineinherited

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.

129{ return _peaks; }

◆ getPeaks() [2/2]

const PeakCatalog & lsst::afw::detection::Footprint::getPeaks ( ) const
inlineinherited

Definition at line 130 of file Footprint.h.

130{ return _peaks; }

◆ getPersistenceName()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
std::string lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getPersistenceName ( ) const
overrideprotectedvirtual

Return the name correspoinging ot the persistence type.

Reimplemented from lsst::afw::detection::Footprint.

Definition at line 259 of file HeavyFootprint.cc.

259 {
260 return "HeavyFootprint" + ComputeSuffix<ImagePixelT, MaskPixelT, VariancePixelT>::apply();
261}

◆ getPythonModule()

std::string lsst::afw::detection::Footprint::getPythonModule ( ) const
inlineoverrideprotectedvirtualinherited

Return the python module the object will live in.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 385 of file Footprint.h.

385{ return "lsst.afw.detection"; }

◆ getRegion()

lsst::geom::Box2I lsst::afw::detection::Footprint::getRegion ( ) const
inlineinherited

Return the corners of the MaskedImage the footprints live in.

Definition at line 213 of file Footprint.h.

213{ return _region; }

◆ getShape()

geom::ellipses::Quadrupole lsst::afw::detection::Footprint::getShape ( ) const
inlineinherited

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.

188{ return _spans->computeShape(); }

◆ getSpans()

std::shared_ptr< geom::SpanSet > lsst::afw::detection::Footprint::getSpans ( ) const
inlineinherited

Return a shared pointer to the SpanSet.

Definition at line 115 of file Footprint.h.

115{ return _spans; }

◆ getVarianceArray() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ndarray::Array< VariancePixelT, 1, 1 > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getVarianceArray ( )
inline

Definition at line 109 of file HeavyFootprint.h.

109{ return _variance; }

◆ getVarianceArray() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
ndarray::Array< VariancePixelT const, 1, 1 > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getVarianceArray ( ) const
inline

Definition at line 113 of file HeavyFootprint.h.

113{ return _variance; }

◆ insert() [1/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::insert ( lsst::afw::image::Image< ImagePixelT > & image) const

Replace all the pixels in the image with the values in the HeavyFootprint.

Parameters
[out]imageImage to set

Definition at line 123 of file HeavyFootprint.cc.

123 {
124 getSpans()->unflatten(image.getArray(), _image, image.getXY0());
125}

◆ insert() [2/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::insert ( lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > & mimage) const

Replace all the pixels in the image with the values in the HeavyFootprint.

Definition at line 115 of file HeavyFootprint.cc.

116 {
117 getSpans()->unflatten(mimage.getImage()->getArray(), _image, mimage.getXY0());
118 getSpans()->unflatten(mimage.getMask()->getArray(), _mask, mimage.getXY0());
119 getSpans()->unflatten(mimage.getVariance()->getArray(), _variance, mimage.getXY0());
120}

◆ isContiguous()

bool lsst::afw::detection::Footprint::isContiguous ( ) const
inlineinherited

Reports if the Footprint is simply connected or has multiple components.

Definition at line 358 of file Footprint.h.

358{ return getSpans()->isContiguous(); };

◆ isHeavy()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
bool lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::isHeavy ( ) const
inlineoverridevirtual

Is this a HeavyFootprint (yes!)

Reimplemented from lsst::afw::detection::Footprint.

Definition at line 93 of file HeavyFootprint.h.

93{ return true; }

◆ isPersistable()

bool lsst::afw::detection::Footprint::isPersistable ( ) const
inlineoverridevirtualnoexceptinherited

Report if this object is persistable.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 283 of file Footprint.h.

283{ return true; }

◆ operator=() [1/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
HeavyFootprint & lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > && )
default

◆ operator=() [2/2]

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
HeavyFootprint & lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const & )
default

◆ operator==()

bool Footprint::operator== ( Footprint const & other) const
inherited

equality operator

Parameters
otherThe Footprint for which equality will be computed

Definition at line 176 of file Footprint.cc.

176 {
177 /* If the peakCatalogs are not the same length the Footprints can't be equal */
178 if (getPeaks().size() != other.getPeaks().size()) {
179 return false;
180 }
181 /* Check that for every peak in the PeakCatalog there is a corresponding peak
182 * in the other, and if not return false
183 */
184 for (auto const& selfPeak : getPeaks()) {
185 bool match = false;
186 for (auto const& otherPeak : other.getPeaks()) {
187 if (selfPeak.getI() == otherPeak.getI() && selfPeak.getF() == otherPeak.getF() &&
188 selfPeak.getPeakValue() == otherPeak.getPeakValue()) {
189 match = true;
190 break;
191 }
192 }
193 if (!match) {
194 return false;
195 }
196 }
197 /* At this point the PeakCatalogs have evaluated true, compare the SpanSets
198 */
199 return *(getSpans()) == *(other.getSpans());
200}
size_type size() const
Return the number of elements in the catalog.
Definition Catalog.h:412

◆ readFits() [1/6]

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

◆ readFits() [2/6]

template<typename T >
static std::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( fits::Fits & fitsfile)
inlinestaticinherited

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183 {
184 return dynamicCast(Persistable::_readFits(fitsfile));
185 }
static std::shared_ptr< T > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.

◆ readFits() [3/6]

static std::shared_ptr< lsst::afw::detection::Footprint > lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint >::readFits ( fits::MemFileManager & manager,
int hdu = fits::DEFAULT_HDU )
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

◆ readFits() [4/6]

template<typename T >
static std::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( fits::MemFileManager & manager,
int hdu = fits::DEFAULT_HDU )
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

205 {
206 return dynamicCast(Persistable::_readFits(manager, hdu));
207 }

◆ readFits() [5/6]

static std::shared_ptr< lsst::afw::detection::Footprint > lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint >::readFits ( std::string const & fileName,
int hdu = fits::DEFAULT_HDU )
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

◆ readFits() [6/6]

template<typename T >
static std::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( std::string const & fileName,
int hdu = fits::DEFAULT_HDU )
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

194 {
195 return dynamicCast(Persistable::_readFits(fileName, hdu));
196 }

◆ readPeaks()

void Footprint::readPeaks ( afw::table::BaseCatalog const & peakCat,
Footprint & loadedFootprint )
staticprotectedinherited

Static method used to unpersist the PeakCatalog member of the Footprint class.

Definition at line 310 of file Footprint.cc.

310 {
311 using namespace std::string_literals;
312 if (!peakCat.getSchema().contains(PeakTable::makeMinimalSchema())) {
313 // need to handle an older form of Peak persistence for backwards compatibility
314 afw::table::SchemaMapper mapper(peakCat.getSchema());
315 mapper.addMinimalSchema(PeakTable::makeMinimalSchema());
316 afw::table::Key<float> oldX = peakCat.getSchema()["x"];
317 afw::table::Key<float> oldY = peakCat.getSchema()["y"];
318 afw::table::Key<float> oldPeakValue = peakCat.getSchema()["value"];
319 mapper.addMapping(oldX, "f.x"s);
320 mapper.addMapping(oldY, "f.y"s);
321 mapper.addMapping(oldPeakValue, "peakValue"s);
322 loadedFootprint.setPeakSchema(mapper.getOutputSchema());
323 auto peaks = loadedFootprint.getPeaks();
324 peaks.reserve(peakCat.size());
325 for (auto const& peak : peakCat) {
326 auto newPeak = peaks.addNew();
327 newPeak->assign(peak, mapper);
328 newPeak->setIx(static_cast<int>(newPeak->getFx()));
329 newPeak->setIy(static_cast<int>(newPeak->getFy()));
330 }
331 return;
332 }
333 loadedFootprint.setPeakSchema(peakCat.getSchema());
334 auto& peaks = loadedFootprint.getPeaks();
335 peaks.reserve(peakCat.size());
336 for (auto const& peak : peakCat) {
337 peaks.addNew()->assign(peak);
338 }
339}
SchemaMapper * mapper
static afw::table::Schema makeMinimalSchema()
Return a minimal schema for Peak tables and records.
Definition Peak.h:137

◆ readSpanSet()

std::unique_ptr< Footprint > Footprint::readSpanSet ( afw::table::BaseCatalog const & catalog,
afw::table::io::InputArchive const & archive )
staticprotectedinherited

Static method used to unpersist the SpanSet member of the Footprint class.

Definition at line 286 of file Footprint.cc.

287 {
288 int fieldCount = catalog.getSchema().getFieldCount();
289 LSST_ARCHIVE_ASSERT(fieldCount == 1 || fieldCount == 3);
290 std::shared_ptr<geom::SpanSet> loadedSpanSet;
291 if (fieldCount == 1) {
292 // This is a new style footprint with a SpanSet as a member, treat accordingly
293 auto const schemaAndKey = spanSetPersistenceHelper();
294 int persistedSpanSetId = catalog.front().get(schemaAndKey.second);
295 loadedSpanSet = std::dynamic_pointer_cast<geom::SpanSet>(archive.get(persistedSpanSetId));
296 } else {
297 // This block is for an old style footprint load.
298 auto const& keys = LegacyFootprintPersistenceHelper::get();
300 tempVec.reserve(catalog.size());
301 for (auto const& val : catalog) {
302 tempVec.emplace_back(val.get(keys.spanY), val.get(keys.spanX0), val.get(keys.spanX1));
303 }
304 loadedSpanSet = std::make_shared<geom::SpanSet>(std::move(tempVec));
305 }
306 auto loadedFootprint = std::unique_ptr<Footprint>(new Footprint(loadedSpanSet));
307 return loadedFootprint;
308}
#define LSST_ARCHIVE_ASSERT(EXPR)
An assertion macro used to validate the structure of an InputArchive.
Definition Persistable.h:48
T emplace_back(T... args)
T move(T... args)
T reserve(T... args)
ImageT val
Definition CR.cc:146

◆ removeOrphanPeaks()

void Footprint::removeOrphanPeaks ( )
inherited

Remove peaks from the PeakCatalog that fall outside the area of the Footprint.

Definition at line 136 of file Footprint.cc.

136 {
137 for (auto iter = getPeaks().begin(); iter != getPeaks().end(); ++iter) {
138 if (!getSpans()->contains(lsst::geom::Point2I(iter->getIx(), iter->getIy()))) {
139 iter = getPeaks().erase(iter);
140 --iter;
141 }
142 }
143}
T begin(T... args)
iterator erase(iterator pos)
Erase the record pointed to by pos, and return an iterator the next record.
Definition Catalog.h:564

◆ setPeakCatalog()

void Footprint::setPeakCatalog ( PeakCatalog const & otherPeaks)
inherited

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.

Parameters
otherPeaksThe PeakCatalog to copy

Definition at line 435 of file Footprint.cc.

435 {
436 if (!getPeaks().empty()) {
437 throw LSST_EXCEPT(pex::exceptions::LogicError, "Cannot change the PeakCatalog unless it is empty");
438 }
439 // this syntax doesn't work in Python, which is why this method has to exist
440 getPeaks() = otherPeaks;
441}

◆ setPeakSchema()

void Footprint::setPeakSchema ( afw::table::Schema const & peakSchema)
inherited

Set the Schema used by the PeakCatalog (will throw if PeakCatalog is not empty).

Parameters
peakSchemaThe schema to use in the PeakCatalog
Exceptions
pex::exceptions::LogicErrorThrown if if the PeakCatalog is not empty

Definition at line 431 of file Footprint.cc.

431 {
432 setPeakCatalog(PeakCatalog(peakSchema));
433}
void setPeakCatalog(PeakCatalog const &otherPeaks)
Set the peakCatalog to a copy of the supplied catalog.
Definition Footprint.cc:435
afw::table::CatalogT< PeakRecord > PeakCatalog
Definition Peak.h:244

◆ setRegion()

void lsst::afw::detection::Footprint::setRegion ( lsst::geom::Box2I const & region)
inlineinherited

Set the corners of the MaskedImage wherein the footprints dwell.

Parameters
regionA box describing the corners of the Image the Footprint derives from

Definition at line 220 of file Footprint.h.

220{ _region = region; }

◆ setSpans()

void Footprint::setSpans ( std::shared_ptr< geom::SpanSet > otherSpanSet)
inherited

Sets the shared pointer to the SpanSet in the Footprint.

Parameters
otherSpanSetShared pointer to a SpanSet

Definition at line 45 of file Footprint.cc.

45{ _spans = otherSpanSet; }

◆ shift() [1/2]

void Footprint::shift ( int dx,
int dy )
inherited

Shift a Footprint by (dx, dy)

Parameters
dxHow much to move Footprint in column direction
dyHow much to move in row direction

Definition at line 64 of file Footprint.cc.

64 {
65 setSpans(getSpans()->shiftedBy(dx, dy));
66 for (auto& peak : getPeaks()) {
67 peak.setIx(peak.getIx() + dx);
68 peak.setIy(peak.getIy() + dy);
69 peak.setFx(peak.getFx() + dx);
70 peak.setFy(peak.getFy() + dy);
71 }
72}

◆ shift() [2/2]

void lsst::afw::detection::Footprint::shift ( lsst::geom::ExtentI const & d)
inlineinherited

Shift a Footprint by a given extent.

Parameters
dExtentI object which gives the dimensions the Footprint should be shifted

Definition at line 203 of file Footprint.h.

203{ shift(d.getX(), d.getY()); }
void shift(int dx, int dy)
Shift a Footprint by (dx, dy)
Definition Footprint.cc:64

◆ sortPeaks()

void Footprint::sortPeaks ( afw::table::Key< float > const & key = afw::table::Key<float>())
inherited

Sort Peaks from most positive value to most negative.

If the key passed is invalid (the default) PeakTable::getPeakValueKey() will be used.

Parameters
keyA key corresponding to the field in the Schema the PeakCatalog is to be sorted by.

Definition at line 57 of file Footprint.cc.

57 {
58 auto validatedKey = key.isValid() ? key : PeakTable::getPeakValueKey();
59 getPeaks().sort([&validatedKey](detection::PeakRecord const& a, detection::PeakRecord const& b) {
60 return a.get(validatedKey) > b.get(validatedKey);
61 });
62}
table::Key< int > b
static afw::table::Key< float > getPeakValueKey()
Definition Peak.h:169
void sort(Key< T > const &key)
Sort the catalog in-place by the field with the given key.
Definition Catalog.h:755

◆ split()

std::vector< std::shared_ptr< Footprint > > Footprint::split ( ) const
inherited

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 159 of file Footprint.cc.

159 {
160 auto splitSpanSets = getSpans()->split();
162 footprintList.reserve(splitSpanSets.size());
163 for (auto& spanPtr : splitSpanSets) {
164 auto tmpFootprintPointer = std::make_shared<Footprint>(spanPtr, getPeaks().getSchema(), getRegion());
165 tmpFootprintPointer->_peaks = getPeaks();
166 // No need to remove any peaks, as there is only one Footprint, so it will
167 // simply be a copy of the original
168 if (splitSpanSets.size() > 1) {
169 tmpFootprintPointer->removeOrphanPeaks();
170 }
171 footprintList.push_back(std::move(tmpFootprintPointer));
172 }
173 return footprintList;
174}
lsst::geom::Box2I getRegion() const
Return the corners of the MaskedImage the footprints live in.
Definition Footprint.h:213
T push_back(T... args)

◆ transform() [1/4]

std::shared_ptr< Footprint > Footprint::transform ( geom::TransformPoint2ToPoint2 const & t,
lsst::geom::Box2I const & region,
bool doClip = true ) const
inherited

Return a new Footprint whose pixels are the product of applying the specified transformation.

Parameters
tA 2-D transform which will be used to map the pixels
regionUsed to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClipIf true, clip the new footprint to the region bbox before returning it.

Definition at line 98 of file Footprint.cc.

99 {
100 // Transfrom the SpanSet first
101 auto transformedSpan = getSpans()->transformedBy(t);
102 // Use this new SpanSet and the peakSchema to create a new Footprint
103 auto newFootprint = std::make_shared<Footprint>(transformedSpan, getPeaks().getSchema(), region);
104 // now populate the new Footprint with transformed Peaks
106 peakPosList.reserve(_peaks.size());
107 for (auto const& peak : getPeaks()) {
108 peakPosList.emplace_back(peak.getF());
109 }
110 auto newPeakPosList = t.applyForward(peakPosList);
111 auto newPeakPos = newPeakPosList.cbegin();
112 for (auto peak = getPeaks().cbegin(), endPeak = getPeaks().cend(); peak != endPeak;
113 ++peak, ++newPeakPos) {
114 newFootprint->addPeak(newPeakPos->getX(), newPeakPos->getY(), peak->getPeakValue());
115 }
116 if (doClip) {
117 newFootprint->clipTo(region);
118 }
119 return newFootprint;
120}

◆ transform() [2/4]

std::shared_ptr< Footprint > Footprint::transform ( lsst::geom::AffineTransform const & t,
lsst::geom::Box2I const & region,
bool doClip = true ) const
inherited

Return a new Footprint whose pixels are the product of applying the specified transformation.

Parameters
tAn affine transform object which will be used to map the pixels
regionUsed to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClipIf true, clip the new footprint to the region bbox before returning it.

Definition at line 93 of file Footprint.cc.

94 {
95 return transform(*geom::makeTransform(t), region, doClip);
96}
table::Key< int > transform

◆ transform() [3/4]

std::shared_ptr< Footprint > Footprint::transform ( lsst::geom::LinearTransform const & t,
lsst::geom::Box2I const & region,
bool doClip = true ) const
inherited

Return a new Footprint whose pixels are the product of applying the specified transformation.

Parameters
tA linear transform object which will be used to map the pixels
regionUsed to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClipIf true, clip the new footprint to the region bbox before returning it.

Definition at line 88 of file Footprint.cc.

89 {
90 return transform(lsst::geom::AffineTransform(t), region, doClip);
91}
An affine coordinate transformation consisting of a linear transformation and an offset.

◆ transform() [4/4]

std::shared_ptr< Footprint > Footprint::transform ( std::shared_ptr< geom::SkyWcs > source,
std::shared_ptr< geom::SkyWcs > target,
lsst::geom::Box2I const & region,
bool doClip = true ) const
inherited

Transform the footprint from one WCS to another.

Parameters
sourceWcs that defines the coordinate system of the input footprint.
targetWcs that defines that desired coordinate system of the returned footprint.
regionUsed to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClipIf true, clip the new footprint to the region bbox before returning it.

Definition at line 81 of file Footprint.cc.

83 {
84 auto srcToTarget = geom::makeWcsPairTransform(*source, *target);
85 return transform(*srcToTarget, region, doClip);
86}
Key< Flag > const & target

◆ updatePeakSignificance() [1/2]

void Footprint::updatePeakSignificance ( double sigma)
inherited

Compute and update the significance of each peak, given a single value for sigma.

The Footprint peak schema must already have a significance field in it.

Parameters
sigmaThe standard deviation for peak detection, positive or negative as appropriate.
Exceptions
pex::exceptions::NotFoundErrorThrown if the the peaks do not have a significance field.

Definition at line 145 of file Footprint.cc.

145 {
146 auto key = _peaks.getSchema().find<double>("significance").key;
147 for (auto& peak : _peaks) {
148 peak.set(key, peak.getPeakValue() / sigma);
149 }
150}
afw::table::Key< double > sigma
Schema getSchema() const
Return the schema associated with the catalog's table.
Definition Catalog.h:117
SchemaItem< T > find(std::string const &name) const
Find a SchemaItem in the Schema by name.
Definition Schema.cc:467

◆ updatePeakSignificance() [2/2]

void Footprint::updatePeakSignificance ( image::Image< float > const & variance,
int polarity )
inherited

Compute and update the significance of each peak, using the variance image.

The Footprint peak schema must already have a significance field in it.

Parameters
varianceThe variance plane of the image that this footprint is in.
polarity+1 if this is detected as a positive footprint, -1 if negative.
Exceptions
pex::exceptions::NotFoundErrorThrown if the the peaks do not have a significance field.

Definition at line 152 of file Footprint.cc.

152 {
153 auto key = _peaks.getSchema().find<double>("significance").key;
154 for (auto& peak : _peaks) {
155 peak.set(key, polarity * peak.getPeakValue() / std::sqrt(variance[peak.getI()]));
156 }
157}
afw::table::Key< afw::table::Array< VariancePixelT > > variance
T sqrt(T... args)

◆ write()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
void lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::write ( OutputArchiveHandle & handle) const
overrideprotectedvirtual

Write an instance of a Footprint to an output Archive.

Reimplemented from lsst::afw::detection::Footprint.

Definition at line 264 of file HeavyFootprint.cc.

264 {
265 HeavyFootprintPersistenceHelper<ImagePixelT, MaskPixelT, VariancePixelT> const& keys =
266 HeavyFootprintPersistenceHelper<ImagePixelT, MaskPixelT, VariancePixelT>::get();
267 // delegate to Footprint::write to handle spans and peaks
268 Footprint::write(handle);
269 // add one more catalog for pixel values
270 afw::table::BaseCatalog cat = handle.makeCatalog(keys.schema);
271 std::shared_ptr<afw::table::BaseRecord> record = cat.addNew();
272 // We could deep-copy the arrays instead of const-casting them, which might be marginally safer,
273 // but we always save an OutputArchive to disk immediately after we create it, so there's really
274 // no chance that we could get the HeavyFootprint in trouble by having this view modified.
275 record->set(keys.image, ndarray::const_array_cast<ImagePixelT>(getImageArray()));
276 record->set(keys.mask, ndarray::const_array_cast<MaskPixelT>(getMaskArray()));
277 record->set(keys.variance, ndarray::const_array_cast<VariancePixelT>(getVarianceArray()));
278 handle.saveCatalog(cat);
279}
void write(OutputArchiveHandle &handle) const override
Write an instance of a Footprint to an output Archive.
Definition Footprint.cc:271
ndarray::Array< MaskPixelT, 1, 1 > getMaskArray()
ndarray::Array< VariancePixelT, 1, 1 > getVarianceArray()
CatalogT< BaseRecord > BaseCatalog
Definition fwd.h:72

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits & fitsfile) const
inherited

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18 {
19 OutputArchive archive;
20 archive.put(this);
21 archive.writeFits(fitsfile);
22}

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager & manager,
std::string const & mode = "w" ) const
inherited

Write the object to a FITS image in memory.

Parameters
[in]managerName of the file to write to.
[in]modeIf "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.

29 {
30 fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31 writeFits(fitsfile);
32}
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const & fileName,
std::string const & mode = "w" ) const
inherited

Write the object to a regular FITS file.

Parameters
[in]fileNameName of the file to write to.
[in]modeIf "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.

24 {
25 fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26 writeFits(fitsfile);
27}

The documentation for this class was generated from the following files: