LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
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 
36 namespace lsst {
37 namespace afw {
38 namespace detection {
39 
40 class HeavyFootprintCtrl;
41 
45 template <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 {
50 public:
62  explicit HeavyFootprint(
63  Footprint const& foot,
65  HeavyFootprintCtrl const* ctrl = NULL);
66 
75  explicit HeavyFootprint(Footprint const& foot, HeavyFootprintCtrl const* ctrl = NULL);
76 
81  HeavyFootprint() = default;
82  ~HeavyFootprint() override = default;
83 
84  HeavyFootprint(HeavyFootprint const& 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 
130 protected:
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 
137 private:
138  ndarray::Array<ImagePixelT, 1, 1> _image;
139  ndarray::Array<MaskPixelT, 1, 1> _mask;
140  ndarray::Array<VariancePixelT, 1, 1> _variance;
141 };
142 
147 template <typename ImagePixelT, typename MaskPixelT, typename VariancePixelT>
149  Footprint const& foot,
151  HeavyFootprintCtrl const* ctrl = NULL) {
153 }
154 
160 template <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
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::afw::detection::HeavyFootprint::getPersistenceName
std::string getPersistenceName() const override
Return the name correspoinging ot the persistence type.
Definition: HeavyFootprint.cc:263
lsst::afw::detection::HeavyFootprint::getImageArray
ndarray::Array< ImagePixelT, 1, 1 > getImageArray()
Definition: HeavyFootprint.h:107
lsst::afw::detection::makeHeavyFootprint
HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > makeHeavyFootprint(Footprint const &foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &img, HeavyFootprintCtrl const *ctrl=NULL)
Create a HeavyFootprint with footprint defined by the given Footprint and pixel values from the given...
Definition: HeavyFootprint.h:148
std::string
STL class.
lsst::afw::detection::HeavyFootprintCtrl
A control object for HeavyFootprints.
Definition: FootprintCtrl.h:99
std::shared_ptr
STL class.
lsst::afw::detection::HeavyFootprint::getMaskArray
ndarray::Array< MaskPixelT, 1, 1 > getMaskArray()
Definition: HeavyFootprint.h:108
lsst::afw::detection::HeavyFootprint::write
void write(OutputArchiveHandle &handle) const override
Write an instance of a Footprint to an output Archive.
Definition: HeavyFootprint.cc:268
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::detection::HeavyFootprint::isHeavy
bool isHeavy() const override
Is this a HeavyFootprint (yes!)
Definition: HeavyFootprint.h:93
lsst::afw::detection::HeavyFootprint::dot
double dot(HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &other) const
Dot product between HeavyFootprints.
Definition: HeavyFootprint.cc:155
lsst::afw::detection::HeavyFootprint::HeavyFootprint
HeavyFootprint(HeavyFootprint const &other)=default
lsst::afw::detection::HeavyFootprint::~HeavyFootprint
~HeavyFootprint() override=default
lsst::afw::image::MaskedImage
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
lsst::afw::detection::HeavyFootprint::insert
void insert(lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &mimage) const
Replace all the pixels in the image with the values in the HeavyFootprint.
Definition: HeavyFootprint.cc:119
lsst::afw::detection::HeavyFootprint
A set of pixels in an Image, including those pixels' actual values.
Definition: HeavyFootprint.h:49
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::image::VariancePixel
float VariancePixel
default type for MaskedImage variance images
Definition: LsstImageTypes.h:35
lsst::jointcal::Iterator
FastFinder::Iterator Iterator
Definition: FastFinder.cc:178
Footprint.h
lsst::afw::image::MaskPixel
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
Definition: LsstImageTypes.h:34
lsst::afw::detection::HeavyFootprint::getMaskBitsSet
MaskPixelT getMaskBitsSet() const
Definition: HeavyFootprint.h:116
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::detection::HeavyFootprint::operator=
HeavyFootprint & operator=(HeavyFootprint &&)=default
lsst::afw::detection::HeavyFootprint::getVarianceArray
ndarray::Array< VariancePixelT const, 1, 1 > getVarianceArray() const
Definition: HeavyFootprint.h:113
lsst::afw::image.slicing.Factory
Factory
Definition: slicing.py:252
lsst::afw::detection::HeavyFootprint::HeavyFootprint
HeavyFootprint(HeavyFootprint &&other)=default
lsst::afw::table::io::PersistableFacade
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
lsst::afw::detection::HeavyFootprint::getVarianceArray
ndarray::Array< VariancePixelT, 1, 1 > getVarianceArray()
Definition: HeavyFootprint.h:109
lsst::afw::detection::HeavyFootprint::HeavyFootprint
HeavyFootprint()=default
Default constructor for HeavyFootprint.
lsst::afw::detection::mergeHeavyFootprints
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,...
Definition: HeavyFootprint.cc:132
lsst::afw::detection::HeavyFootprint::getImageArray
ndarray::Array< ImagePixelT const, 1, 1 > getImageArray() const
Definition: HeavyFootprint.h:111
lsst::afw::detection::Footprint
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:63
lsst::afw::image::Image< ImagePixelT >
lsst::afw::table::io::Persistable::OutputArchiveHandle
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
lsst::afw::detection::HeavyFootprint::operator=
HeavyFootprint & operator=(HeavyFootprint const &)=default
lsst::afw::detection::HeavyFootprint::getMaskArray
ndarray::Array< MaskPixelT const, 1, 1 > getMaskArray() const
Definition: HeavyFootprint.h:112