LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
FixedKernel.cc
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 #include <stdexcept>
25 #include <memory>
26 #include <string>
27 
28 #include "lsst/pex/exceptions.h"
29 #include "lsst/afw/math/Kernel.h"
32 
34 
35 namespace lsst {
36 namespace afw {
37 
40 
41 namespace math {
42 
43 FixedKernel::FixedKernel() : Kernel(), _image(), _sum(0) {}
44 
46  : Kernel(image.getWidth(), image.getHeight(), 0), _image(image, true), _sum(0) {
47  using XIter = image::Image<Pixel>::x_iterator;
48  double imSum = 0.0;
49  for (int y = 0; y != image.getHeight(); ++y) {
50  for (XIter imPtr = image.row_begin(y), imEnd = image.row_end(y); imPtr != imEnd; ++imPtr) {
51  imSum += *imPtr;
52  }
53  }
54  this->_sum = imSum;
55 }
56 
58  : Kernel(kernel.getWidth(), kernel.getHeight(), 0), _image(kernel.getDimensions()), _sum(0) {
59  _sum = kernel.computeImage(_image, false, pos[0], pos[1]);
60 }
61 
63  std::shared_ptr<Kernel> retPtr(new FixedKernel(_image));
64  retPtr->setCtr(this->getCtr());
65  return retPtr;
66 }
67 
68 std::shared_ptr<Kernel> FixedKernel::resized(int width, int height) const {
69  if ((width <= 0) || (height <= 0)) {
71  os << "Cannot create FixedKernel with dimensions (" << width << ", " << height << "). ";
73  }
74  if ((width - getWidth()) % 2 || (height - getHeight()) % 2) {
76  os << "Cannot resize FixedKernel from (" << getWidth() << ", " << getHeight() << ") to (" << width
77  << ", " << height << "), because at least one dimension would change by an odd value.";
79  }
80 
81  lsst::geom::Box2I bboxNew(lsst::geom::Point2I((1 - width) / 2, (1 - height) / 2),
82  lsst::geom::Extent2I(width, height));
83  std::shared_ptr<image::Image<Pixel>> imNew = std::make_shared<image::Image<Pixel>>(bboxNew);
84 
85  // getBBox() instantiates a new BBox from member data _width, _height, _ctrX, _ctrY
86  // so modifying it is OK
87  lsst::geom::Box2I bboxIntersect = getBBox();
88  bboxIntersect.clip(bboxNew);
89 
90  // Kernel (this) and member image (this->_image) do not always have same XY0.
91  // Member image of resized kernel will not have same BBox as orig,
92  // but BBox of member image is ignored by the kernel.
93  int offsetX = _image.getX0() - getBBox().getMinX();
94  int offsetY = _image.getY0() - getBBox().getMinY();
95  lsst::geom::Box2I bboxIntersectShifted = lsst::geom::Box2I(
96  lsst::geom::Point2I(bboxIntersect.getMinX() + offsetX, bboxIntersect.getMinY() + offsetY),
97  bboxIntersect.getDimensions());
98  image::Image<Pixel> imIntersect = image::Image<Pixel>(_image, bboxIntersectShifted);
99 
100  imNew->assign(imIntersect, bboxIntersect);
101  std::shared_ptr<Kernel> retPtr = std::make_shared<FixedKernel>(*imNew);
102  return retPtr;
103 }
104 
105 double FixedKernel::doComputeImage(image::Image<Pixel>& image, bool doNormalize) const {
106  double multFactor = 1.0;
107  double imSum = this->_sum;
108  if (doNormalize) {
109  if (imSum == 0) {
110  throw LSST_EXCEPT(pexExcept::OverflowError, "Cannot normalize; kernel sum is 0");
111  }
112  multFactor = 1.0 / static_cast<double>(this->_sum);
113  imSum = 1.0;
114  }
115 
116  using XIter = image::Image<Pixel>::x_iterator;
117 
118  for (int y = 0; y != this->getHeight(); ++y) {
119  for (XIter imPtr = image.row_begin(y), imEnd = image.row_end(y), kPtr = this->_image.row_begin(y);
120  imPtr != imEnd; ++imPtr, ++kPtr) {
121  imPtr[0] = multFactor * kPtr[0];
122  }
123  }
124 
125  return imSum;
126 }
127 
130  os << prefix << "FixedKernel:" << std::endl;
131  os << prefix << "..sum: " << _sum << std::endl;
132  os << Kernel::toString(prefix + "\t");
133  return os.str();
134 }
135 
136 // ------ Persistence ---------------------------------------------------------------------------------------
137 
138 namespace {
139 
140 struct FixedKernelPersistenceHelper : public Kernel::PersistenceHelper {
141  table::Key<table::Array<Kernel::Pixel>> image;
142 
143  explicit FixedKernelPersistenceHelper(lsst::geom::Extent2I const& dimensions)
144  : Kernel::PersistenceHelper(0),
145  image(schema.addField<table::Array<Kernel::Pixel>>("image", "pixel values (row-major)",
146  dimensions.getX() * dimensions.getY())) {}
147 
148  explicit FixedKernelPersistenceHelper(table::Schema const& schema_)
149  : Kernel::PersistenceHelper(schema_), image(schema["image"]) {}
150 };
151 
152 } // namespace
153 
155 public:
157  CatalogVector const& catalogs) const override {
158  LSST_ARCHIVE_ASSERT(catalogs.size() == 1u);
159  LSST_ARCHIVE_ASSERT(catalogs.front().size() == 1u);
160  FixedKernelPersistenceHelper const keys(catalogs.front().getSchema());
161  afw::table::BaseRecord const& record = catalogs.front().front();
163  ndarray::flatten<1>(ndarray::static_dimension_cast<2>(image.getArray())) = record[keys.image];
164  std::shared_ptr<FixedKernel> result = std::make_shared<FixedKernel>(image);
165  result->setCtr(record.get(keys.center));
166  return result;
167  }
168 
169  explicit Factory(std::string const& name) : afw::table::io::PersistableFactory(name) {}
170 };
171 
172 namespace {
173 
174 std::string getFixedKernelPersistenceName() { return "FixedKernel"; }
175 
176 FixedKernel::Factory registration(getFixedKernelPersistenceName());
177 
178 } // namespace
179 
180 std::string FixedKernel::getPersistenceName() const { return getFixedKernelPersistenceName(); }
181 
183  FixedKernelPersistenceHelper const keys(getDimensions());
184  std::shared_ptr<afw::table::BaseRecord> record = keys.write(handle, *this);
185  (*record)[keys.image] = ndarray::flatten<1>(ndarray::copy(_image.getArray()));
186 }
187 } // namespace math
188 } // namespace afw
189 } // namespace lsst
py::object result
Definition: _schema.cc:429
table::Key< std::string > name
Definition: Amplifier.cc:116
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
table::Key< table::Array< Kernel::Pixel > > image
Definition: FixedKernel.cc:141
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:48
std::ostream * os
Definition: Schema.cc:557
std::string prefix
Definition: SchemaMapper.cc:72
int y
Definition: SpanSet.cc:48
#define LSST_ARCHIVE_ASSERT(EXPR)
An assertion macro used to validate the structure of an InputArchive.
Definition: Persistable.h:48
table::Schema schema
Definition: python.h:134
int getX0() const
Return the image's column-origin.
Definition: ImageBase.h:306
int getY0() const
Return the image's row-origin.
Definition: ImageBase.h:314
x_iterator row_begin(int y) const
Return an x_iterator to the start of the y'th row.
Definition: ImageBase.h:401
typename _view_t::x_iterator x_iterator
An iterator for traversing the pixels in a row.
Definition: ImageBase.h:133
std::shared_ptr< afw::table::io::Persistable > read(InputArchive const &archive, CatalogVector const &catalogs) const override
Construct a new object from the given InputArchive and vector of catalogs.
Definition: FixedKernel.cc:156
Factory(std::string const &name)
Definition: FixedKernel.cc:169
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition: FixedKernel.cc:180
std::shared_ptr< Kernel > clone() const override
Return a pointer to a deep copy of this kernel.
Definition: FixedKernel.cc:62
FixedKernel()
Construct an empty FixedKernel of size 0x0.
Definition: FixedKernel.cc:43
double doComputeImage(lsst::afw::image::Image< Pixel > &image, bool doNormalize) const override
Low-level version of computeImage.
Definition: FixedKernel.cc:105
std::shared_ptr< Kernel > resized(int width, int height) const override
Return a pointer to a clone with specified kernel dimensions.
Definition: FixedKernel.cc:68
std::string toString(std::string const &prefix="") const override
Return a string representation of the kernel.
Definition: FixedKernel.cc:128
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: FixedKernel.cc:182
Kernels are used for convolution with MaskedImages and (eventually) Images.
Definition: Kernel.h:110
lsst::geom::Extent2I const getDimensions() const
Return the Kernel's dimensions (width, height)
Definition: Kernel.h:212
int getHeight() const
Return the Kernel's height.
Definition: Kernel.h:229
lsst::geom::Point2I getCtr() const
Return index of kernel's center.
Definition: Kernel.h:234
virtual std::string toString(std::string const &prefix="") const
Return a string representation of the kernel.
Definition: Kernel.cc:185
int getWidth() const
Return the Kernel's width.
Definition: Kernel.h:224
double computeImage(lsst::afw::image::Image< Pixel > &image, bool doNormalize, double x=0.0, double y=0.0) const
Compute an image (pixellized representation of the kernel) in place.
Definition: Kernel.cc:76
lsst::geom::Box2I getBBox() const
return parent bounding box, with XY0 = -center
Definition: Kernel.h:239
Base class for all records.
Definition: BaseRecord.h:31
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition: BaseRecord.h:151
A vector of catalogs used by Persistable.
Definition: CatalogVector.h:29
A multi-catalog archive object used to load table::io::Persistable objects.
Definition: InputArchive.h:31
An object passed to Persistable::write to allow it to persist itself.
static std::shared_ptr< T > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18
A base class for factory classes used to reconstruct objects from records.
Definition: Persistable.h:228
An integer coordinate rectangle.
Definition: Box.h:55
int getMinY() const noexcept
Definition: Box.h:158
int getMinX() const noexcept
Definition: Box.h:157
Reports invalid arguments.
Definition: Runtime.h:66
Reports when the result of an arithmetic operation is too large for the destination type.
Definition: Runtime.h:124
T endl(T... args)
T front(T... args)
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
float Pixel
Typedefs to be used for pixel values.
Definition: common.h:37
A base class for image defects.
T size(T... args)