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
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
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:
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
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>
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
Footprint(std::shared_ptr< geom::SpanSet > inputSpans, lsst::geom::Box2I const &region=lsst::geom::Box2I())
Constructor for Footprint object.
Definition Footprint.cc:38
A control object for HeavyFootprints.
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
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.
ndarray::Array< MaskPixelT, 1, 1 > getMaskArray()
ndarray::Array< ImagePixelT, 1, 1 > getImageArray()
HeavyFootprint(HeavyFootprint const &other)=default
HeavyFootprint & operator=(HeavyFootprint &&)=default
void insert(lsst::afw::image::Image< ImagePixelT > &image) const
Replace all the pixels in the image with the values in the HeavyFootprint.
HeavyFootprint(Footprint const &foot, HeavyFootprintCtrl const *ctrl=nullptr)
Create a HeavyFootprint from a regular Footprint, allocating space to hold foot.getArea() pixels,...
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
void insert(lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &mimage) const
Replace all the pixels in the image with the values in the HeavyFootprint.
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.
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...
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
float VariancePixel
default type for MaskedImage variance images