lsst.afw g776a55d5bd+f790144ad9
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"
37
38namespace lsst {
39namespace afw {
40namespace detection {
41
49
54public:
57
66 template <typename ImagePixelT>
67 FootprintSet(image::Image<ImagePixelT> const& img, Threshold const& threshold, int const npixMin = 1,
68 bool const setPeaks = true);
69
77 template <typename MaskPixelT>
78 FootprintSet(image::Mask<MaskPixelT> const& img, Threshold const& threshold, int const npixMin = 1);
79
98 template <typename ImagePixelT, typename MaskPixelT>
100 std::string const& planeName = "", int const npixMin = 1, bool const setPeaks = true);
101
114 FootprintSet(FootprintSet const& set, int rGrow, FootprintControl const& ctrl);
128 FootprintSet(FootprintSet const& set, int rGrow, bool isotropic = true);
134 FootprintSet(FootprintSet const& footprints1, FootprintSet const& footprints2, bool const includePeaks);
135
139
140 void swap(FootprintSet& rhs) noexcept {
141 using std::swap; // See Meyers, Effective C++, Item 25
142 swap(*_footprints, *rhs.getFootprints());
143 lsst::geom::Box2I rhsRegion = rhs.getRegion();
144 rhs.setRegion(getRegion());
145 setRegion(rhsRegion);
146 }
147
148 void swapFootprintList(FootprintList& rhs) noexcept {
149 using std::swap;
150 swap(*_footprints, rhs);
151 }
152
157
161 void setFootprints(std::shared_ptr<FootprintList> footprints) { _footprints = footprints; }
162
166 std::shared_ptr<FootprintList const> const getFootprints() const { return _footprints; }
167
177
185 void setRegion(lsst::geom::Box2I const& region);
186
190 lsst::geom::Box2I const getRegion() const { return _region; }
191
198
199 template <typename MaskPixelT>
201 std::string const& planeName
202 ) {
203 for (auto const& foot : *_footprints) {
204 foot->getSpans()->setMask(*mask, image::Mask<MaskPixelT>::getPlaneBitMask(planeName));
205 }
206 }
207
208 template <typename MaskPixelT>
210 std::string const& planeName
211 ) {
212 setMask(mask.get(), planeName);
213 }
214
223 void merge(FootprintSet const& rhs, int tGrow = 0, int rGrow = 0, bool isotropic = true);
224
231 template <typename ImagePixelT, typename MaskPixelT>
233 HeavyFootprintCtrl const* ctrl = nullptr);
234
235private:
237 lsst::geom::Box2I _region;
238};
239} // namespace detection
240} // namespace afw
241} // namespace lsst
242
243#endif
afw::table::Key< afw::table::Array< MaskPixelT > > mask
A Control Object for Footprints, controlling e.g.
Definition: FootprintCtrl.h:34
A set of Footprints, associated with a MaskedImage.
Definition: FootprintSet.h:53
FootprintSet(image::Image< ImagePixelT > const &img, Threshold const &threshold, int const npixMin=1, bool const setPeaks=true)
Find a FootprintSet given an Image and a threshold.
void setFootprints(std::shared_ptr< FootprintList > footprints)
: Set the Footprints of detected objects
Definition: FootprintSet.h:161
FootprintSet & operator=(FootprintSet &&rhs)
void setMask(image::Mask< MaskPixelT > *mask, std::string const &planeName)
Definition: FootprintSet.h:200
std::shared_ptr< FootprintList > getFootprints()
: Return the Footprints of detected objects
Definition: FootprintSet.h:156
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)
Definition: FootprintSet.h:209
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.
Definition: FootprintSet.h:166
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
Definition: FootprintSet.h:140
lsst::geom::Box2I const getRegion() const
Return the corners of the MaskedImage.
Definition: FootprintSet.h:190
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
Definition: FootprintSet.h:148
A control object for HeavyFootprints.
Definition: FootprintCtrl.h:99
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:77
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
daf::base::PropertySet * set
Definition: fits.cc:912
A base class for image defects.
T swap(T... args)