LSST Applications g070148d5b3+33e5256705,g0d53e28543+25c8b88941,g0da5cf3356+2dd1178308,g1081da9e2a+62d12e78cb,g17e5ecfddb+7e422d6136,g1c76d35bf8+ede3a706f7,g295839609d+225697d880,g2e2c1a68ba+cc1f6f037e,g2ffcdf413f+853cd4dcde,g38293774b4+62d12e78cb,g3b44f30a73+d953f1ac34,g48ccf36440+885b902d19,g4b2f1765b6+7dedbde6d2,g5320a0a9f6+0c5d6105b6,g56b687f8c9+ede3a706f7,g5c4744a4d9+ef6ac23297,g5ffd174ac0+0c5d6105b6,g6075d09f38+66af417445,g667d525e37+2ced63db88,g670421136f+2ced63db88,g71f27ac40c+2ced63db88,g774830318a+463cbe8d1f,g7876bc68e5+1d137996f1,g7985c39107+62d12e78cb,g7fdac2220c+0fd8241c05,g96f01af41f+368e6903a7,g9ca82378b8+2ced63db88,g9d27549199+ef6ac23297,gabe93b2c52+e3573e3735,gb065e2a02a+3dfbe639da,gbc3249ced9+0c5d6105b6,gbec6a3398f+0c5d6105b6,gc9534b9d65+35b9f25267,gd01420fc67+0c5d6105b6,geee7ff78d7+a14128c129,gf63283c776+ede3a706f7,gfed783d017+0c5d6105b6,w.2022.47
LSST Data Management Base Package
Loading...
Searching...
No Matches
HeavyFootprint.h
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2008, 2009, 2010 LSST Corporation.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <http://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#if !defined(LSST_DETECTION_HEAVY_FOOTPRINT_H)
24#define LSST_DETECTION_HEAVY_FOOTPRINT_H
25/*
26 * Represent a set of pixels of an arbitrary shape and size, including values
27 * for those pixels; a HeavyFootprint is a Footprint that also not only a
28 * description of a region, but values within that region.
29 */
30#include <algorithm>
31#include <list>
32#include <cmath>
33#include <memory>
35
36namespace lsst {
37namespace afw {
38namespace detection {
39
40class HeavyFootprintCtrl;
41
45template <typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel,
46 typename VariancePixelT = lsst::afw::image::VariancePixel>
48 : public afw::table::io::PersistableFacade<HeavyFootprint<ImagePixelT, MaskPixelT, VariancePixelT> >,
49 public Footprint {
50public:
62 explicit HeavyFootprint(
63 Footprint const& foot,
65 HeavyFootprintCtrl const* ctrl = nullptr);
66
75 explicit HeavyFootprint(Footprint const& foot, HeavyFootprintCtrl const* ctrl = nullptr);
76
81 HeavyFootprint() = default;
82 ~HeavyFootprint() override = default;
83
84 HeavyFootprint(HeavyFootprint const& other) = default;
85 HeavyFootprint(HeavyFootprint&& other) = default;
86
89
93 bool isHeavy() const override { return true; }
94
99
106
107 ndarray::Array<ImagePixelT, 1, 1> getImageArray() { return _image; }
108 ndarray::Array<MaskPixelT, 1, 1> getMaskArray() { return _mask; }
109 ndarray::Array<VariancePixelT, 1, 1> getVarianceArray() { return _variance; }
110
111 ndarray::Array<ImagePixelT const, 1, 1> getImageArray() const { return _image; }
112 ndarray::Array<MaskPixelT const, 1, 1> getMaskArray() const { return _mask; }
113 ndarray::Array<VariancePixelT const, 1, 1> getVarianceArray() const { return _variance; }
114
115 /* Returns the OR of all the mask pixels held in this HeavyFootprint. */
116 MaskPixelT getMaskBitsSet() const {
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 }
123
129
130protected:
131 class Factory; // factory class used for persistence, public only so we can instantiate it in .cc file
132
133 std::string getPersistenceName() const override;
134
135 void write(OutputArchiveHandle& handle) const override;
136
137private:
138 ndarray::Array<ImagePixelT, 1, 1> _image;
139 ndarray::Array<MaskPixelT, 1, 1> _mask;
140 ndarray::Array<VariancePixelT, 1, 1> _variance;
141};
142
147template <typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>
149 Footprint const& foot,
151 HeavyFootprintCtrl const* ctrl = nullptr) {
153}
154
160template <typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>
162 HeavyFootprint<ImagePixelT, MaskPixelT, VariancePixelT> const& h1,
163 HeavyFootprint<ImagePixelT, MaskPixelT, VariancePixelT> const& h2);
164} // namespace detection
165} // namespace afw
166} // namespace lsst
167
168#endif
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:63
A control object for HeavyFootprints.
Definition: FootprintCtrl.h:99
A set of pixels in an Image, including those pixels' actual values.
void write(OutputArchiveHandle &handle) const override
Write an instance of a Footprint to an output Archive.
ndarray::Array< ImagePixelT const, 1, 1 > getImageArray() const
double dot(HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &other) const
Dot product between HeavyFootprints.
HeavyFootprint(HeavyFootprint &&other)=default
ndarray::Array< MaskPixelT, 1, 1 > getMaskArray()
ndarray::Array< ImagePixelT, 1, 1 > getImageArray()
HeavyFootprint(HeavyFootprint const &other)=default
HeavyFootprint & operator=(HeavyFootprint &&)=default
HeavyFootprint()=default
Default constructor for HeavyFootprint.
ndarray::Array< VariancePixelT, 1, 1 > getVarianceArray()
bool isHeavy() const override
Is this a HeavyFootprint (yes!)
ndarray::Array< VariancePixelT const, 1, 1 > getVarianceArray() const
ndarray::Array< MaskPixelT const, 1, 1 > getMaskArray() const
HeavyFootprint & operator=(HeavyFootprint const &)=default
std::string getPersistenceName() const override
Return the name correspoinging ot the persistence type.
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:74
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > mergeHeavyFootprints(HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &h1, HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &h2)
Sum the two given HeavyFootprints h1 and h2, returning a HeavyFootprint with the union footprint,...
HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > makeHeavyFootprint(Footprint const &foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &img, HeavyFootprintCtrl const *ctrl=nullptr)
Create a HeavyFootprint with footprint defined by the given Footprint and pixel values from the given...
float VariancePixel
default type for MaskedImage variance images
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks