LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
FootprintSet.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008, 2009, 2010 LSST Corporation.
5 *
6 * This product includes software developed by the
7 * LSST Project (http://www.lsst.org/).
8 *
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the LSST License Statement and
20 * the GNU General Public License along with this program. If not,
21 * see <http://www.lsstcorp.org/LegalNotices/>.
22 */
23
24#if !defined(LSST_DETECTION_FOOTPRINT_SET_H)
25#define LSST_DETECTION_FOOTPRINT_SET_H
26/*
27 * Represent a collections of footprints associated with image data
28 */
29#include <cstdint>
30
31#include "lsst/geom.h"
39
40namespace lsst {
41namespace afw {
42namespace detection {
43
51
56public:
59
71 template <typename ImagePixelT>
72 FootprintSet(image::Image<ImagePixelT> const& img, Threshold const& threshold, int const npixMin = 1,
73 bool const setPeaks = true,
74 table::Schema const& peakSchema = PeakTable::makeMinimalSchema());
75
83 template <typename MaskPixelT>
84 FootprintSet(image::Mask<MaskPixelT> const& img, Threshold const& threshold, int const npixMin = 1);
85
104 template <typename ImagePixelT, typename MaskPixelT>
106 std::string const& planeName = "", int const npixMin = 1, bool const setPeaks = true);
107
120 FootprintSet(FootprintSet const& set, int rGrow, FootprintControl const& ctrl);
134 FootprintSet(FootprintSet const& set, int rGrow, bool isotropic = true);
140 FootprintSet(FootprintSet const& footprints1, FootprintSet const& footprints2, bool const includePeaks);
141
145
146 void swap(FootprintSet& rhs) noexcept {
147 using std::swap; // See Meyers, Effective C++, Item 25
148 swap(*_footprints, *rhs.getFootprints());
149 lsst::geom::Box2I rhsRegion = rhs.getRegion();
150 rhs.setRegion(getRegion());
151 setRegion(rhsRegion);
152 }
153
154 void swapFootprintList(FootprintList& rhs) noexcept {
155 using std::swap;
156 swap(*_footprints, rhs);
157 }
158
163
167 void setFootprints(std::shared_ptr<FootprintList> footprints) { _footprints = footprints; }
168
172 std::shared_ptr<FootprintList const> const getFootprints() const { return _footprints; }
173
183
191 void setRegion(lsst::geom::Box2I const& region);
192
196 lsst::geom::Box2I const getRegion() const { return _region; }
197
204
205 template <typename MaskPixelT>
207 std::string const& planeName
208 ) {
209 for (auto const& foot : *_footprints) {
210 foot->getSpans()->setMask(*mask, image::Mask<MaskPixelT>::getPlaneBitMask(planeName));
211 }
212 }
213
214 template <typename MaskPixelT>
216 std::string const& planeName
217 ) {
218 setMask(mask.get(), planeName);
219 }
220
229 void merge(FootprintSet const& rhs, int tGrow = 0, int rGrow = 0, bool isotropic = true);
230
237 template <typename ImagePixelT, typename MaskPixelT>
239 HeavyFootprintCtrl const* ctrl = nullptr);
240
241private:
243 lsst::geom::Box2I _region;
244};
245
253
254} // namespace detection
255} // namespace afw
256} // namespace lsst
257
258#endif
A Control Object for Footprints, controlling e.g.
A set of Footprints, associated with a MaskedImage.
void setFootprints(std::shared_ptr< FootprintList > footprints)
: Set the Footprints of detected objects
FootprintSet & operator=(FootprintSet &&rhs)
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.
void setMask(image::Mask< MaskPixelT > *mask, std::string const &planeName)
std::shared_ptr< FootprintList > getFootprints()
: Return the Footprints of detected objects
void merge(FootprintSet const &rhs, int tGrow=0, int rGrow=0, bool isotropic=true)
Merge a FootprintSet into *this.
FootprintSet(lsst::geom::Box2I region)
Construct an empty FootprintSet given a region that its footprints would have lived in.
FootprintSet(FootprintSet const &set, int rGrow, FootprintControl const &ctrl)
void setMask(std::shared_ptr< image::Mask< MaskPixelT > > mask, std::string const &planeName)
std::vector< std::shared_ptr< Footprint > > FootprintList
The FootprintSet's set of Footprints.
FootprintSet(FootprintSet const &set, int rGrow, bool isotropic=true)
Grow all the Footprints in the input FootprintSet, returning a new FootprintSet.
std::shared_ptr< FootprintList const > const getFootprints() const
Retun the Footprints of detected objects.
FootprintSet(FootprintSet const &rhs)
Copy constructor.
FootprintSet & operator=(FootprintSet const &rhs)
Assignment operator.
FootprintSet(image::Mask< MaskPixelT > const &img, Threshold const &threshold, int const npixMin=1)
Find a FootprintSet given a Mask and a threshold.
void makeHeavy(image::MaskedImage< ImagePixelT, MaskPixelT > const &mimg, HeavyFootprintCtrl const *ctrl=nullptr)
Convert all the Footprints in the FootprintSet to be HeavyFootprints.
void swap(FootprintSet &rhs) noexcept
lsst::geom::Box2I const getRegion() const
Return the corners of the MaskedImage.
void makeSources(afw::table::SourceCatalog &catalog) const
Add a new record corresponding to each footprint to a SourceCatalog.
FootprintSet(FootprintSet &&rhs)
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.
void setRegion(lsst::geom::Box2I const &region)
Set the corners of the FootprintSet's MaskedImage to region.
std::shared_ptr< image::Image< FootprintIdPixel > > insertIntoImage() const
Return an Image with pixels set to the Footprints in the FootprintSet.
FootprintSet(FootprintSet const &footprints1, FootprintSet const &footprints2, bool const includePeaks)
Return the FootprintSet corresponding to the merge of two input FootprintSets.
void swapFootprintList(FootprintList &rhs) noexcept
A control object for HeavyFootprints.
static afw::table::Schema makeMinimalSchema()
Return a minimal schema for Peak tables and records.
Definition Peak.h:137
A Threshold is used to pass a threshold value to detection algorithms.
Definition Threshold.h:43
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
Represent a 2-dimensional array of bitmask pixels.
Definition Mask.h:82
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
Defines the fields and offsets for a table.
Definition Schema.h:51
An integer coordinate rectangle.
Definition Box.h:55
std::ostream & operator<<(std::ostream &os, Footprint const &rhs)
Print a Footprint to the stream.
Definition Footprint.cc:443
std::uint64_t FootprintIdPixel
Pixel type for FootprintSet::insertIntoImage()
T swap(T... args)