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
AnalyticKernel.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 <sstream>
25 
26 #include "lsst/pex/exceptions.h"
27 #include "lsst/afw/math/Kernel.h"
30 
32 
33 namespace lsst {
34 namespace afw {
35 
36 template std::shared_ptr<math::AnalyticKernel> table::io::PersistableFacade<
37  math::AnalyticKernel>::dynamicCast(std::shared_ptr<table::io::Persistable> const &);
38 
39 namespace math {
40 
41 AnalyticKernel::AnalyticKernel() : Kernel(), _kernelFunctionPtr() {}
42 
44  Kernel::SpatialFunction const &spatialFunction)
45  : Kernel(width, height, kernelFunction.getNParameters(), spatialFunction),
46  _kernelFunctionPtr(kernelFunction.clone()) {}
47 
49  std::vector<Kernel::SpatialFunctionPtr> const &spatialFunctionList)
50  : Kernel(width, height, spatialFunctionList), _kernelFunctionPtr(kernelFunction.clone()) {
51  if (kernelFunction.getNParameters() != spatialFunctionList.size()) {
53  os << "kernelFunction.getNParameters() = " << kernelFunction.getNParameters()
54  << " != " << spatialFunctionList.size() << " = "
55  << "spatialFunctionList.size()";
57  }
58 }
59 
62  if (this->isSpatiallyVarying()) {
63  retPtr.reset(new AnalyticKernel(this->getWidth(), this->getHeight(), *(this->_kernelFunctionPtr),
64  this->_spatialFunctionList));
65  } else {
66  retPtr.reset(new AnalyticKernel(this->getWidth(), this->getHeight(), *(this->_kernelFunctionPtr)));
67  }
68  retPtr->setCtr(this->getCtr());
69  return retPtr;
70 }
71 
72 std::shared_ptr<Kernel> AnalyticKernel::resized(int width, int height) const {
74  if (isSpatiallyVarying()) {
75  retPtr = std::make_shared<AnalyticKernel>(width, height, *_kernelFunctionPtr, _spatialFunctionList);
76  } else {
77  retPtr = std::make_shared<AnalyticKernel>(width, height, *_kernelFunctionPtr);
78  }
79  return retPtr;
80 }
81 
82 double AnalyticKernel::computeImage(image::Image<Pixel> &image, bool doNormalize, double x, double y) const {
83  lsst::geom::Extent2I llBorder = (image.getDimensions() - getDimensions()) / 2;
84  image.setXY0(lsst::geom::Point2I(-lsst::geom::Extent2I(getCtr() + llBorder)));
85  if (this->isSpatiallyVarying()) {
87  }
88  return doComputeImage(image, doNormalize);
89 }
90 
92  return _kernelFunctionPtr->clone();
93 }
94 
97  os << prefix << "AnalyticKernel:" << std::endl;
98  os << prefix << "..function: " << (_kernelFunctionPtr ? _kernelFunctionPtr->toString() : "None")
99  << std::endl;
100  os << Kernel::toString(prefix + "\t");
101  return os.str();
102 }
103 
105  return _kernelFunctionPtr->getParameters();
106 }
107 
108 //
109 // Protected Member Functions
110 //
111 double AnalyticKernel::doComputeImage(image::Image<Pixel> &image, bool doNormalize) const {
112  double imSum = 0;
113  for (int y = 0; y != image.getHeight(); ++y) {
114  double const fy = image.indexToPosition(y, image::Y);
116  for (int x = 0; x != image.getWidth(); ++x, ++ptr) {
117  double const fx = image.indexToPosition(x, image::X);
118  Pixel const pixelVal = (*_kernelFunctionPtr)(fx, fy);
119  *ptr = pixelVal;
120  imSum += pixelVal;
121  }
122  }
123 
124  if (doNormalize && (imSum != 1)) {
125  if (imSum == 0) {
126  throw LSST_EXCEPT(pexExcept::OverflowError, "Cannot normalize; kernel sum is 0");
127  }
128  image /= imSum;
129  imSum = 1;
130  }
131 
132  return imSum;
133 }
134 
135 void AnalyticKernel::setKernelParameter(unsigned int ind, double value) const {
136  _kernelFunctionPtr->setParameter(ind, value);
137 }
138 
139 // ------ Persistence ---------------------------------------------------------------------------------------
140 
141 namespace {
142 
143 struct AnalyticKernelPersistenceHelper : public Kernel::PersistenceHelper {
144  table::Key<int> kernelFunction;
145 
146  explicit AnalyticKernelPersistenceHelper(int nSpatialFunctions)
147  : Kernel::PersistenceHelper(nSpatialFunctions),
148  kernelFunction(schema.addField<int>(
149  "kernelfunction", "archive ID for analytic function used to produce kernel images")) {}
150 
151  explicit AnalyticKernelPersistenceHelper(table::Schema const &schema_)
152  : Kernel::PersistenceHelper(schema_), kernelFunction(schema["kernelfunction"]) {}
153 };
154 
155 } // namespace
156 
158 public:
160  CatalogVector const &catalogs) const override {
161  LSST_ARCHIVE_ASSERT(catalogs.size() == 1u);
162  LSST_ARCHIVE_ASSERT(catalogs.front().size() == 1u);
163  AnalyticKernelPersistenceHelper const keys(catalogs.front().getSchema());
164  afw::table::BaseRecord const &record = catalogs.front().front();
166  archive.get<AnalyticKernel::KernelFunction>(record.get(keys.kernelFunction));
168  if (keys.spatialFunctions.isValid()) {
169  result = std::make_shared<AnalyticKernel>(record.get(keys.dimensions.getX()),
170  record.get(keys.dimensions.getY()), *kernelFunction,
171  keys.readSpatialFunctions(archive, record));
172  } else {
173  result = std::make_shared<AnalyticKernel>(record.get(keys.dimensions.getX()),
174  record.get(keys.dimensions.getY()), *kernelFunction);
175  }
176  result->setCtr(record.get(keys.center));
177  return result;
178  }
179 
180  explicit Factory(std::string const &name) : afw::table::io::PersistableFactory(name) {}
181 };
182 
183 namespace {
184 
185 std::string getAnalyticKernelPersistenceName() { return "AnalyticKernel"; }
186 
187 AnalyticKernel::Factory registration(getAnalyticKernelPersistenceName());
188 
189 } // namespace
190 
191 std::string AnalyticKernel::getPersistenceName() const { return getAnalyticKernelPersistenceName(); }
192 
194  AnalyticKernelPersistenceHelper const keys(_spatialFunctionList.size());
195  std::shared_ptr<afw::table::BaseRecord> record = keys.write(handle, *this);
196  record->set(keys.kernelFunction, handle.put(_kernelFunctionPtr.get()));
197 }
198 } // namespace math
199 } // namespace afw
200 } // namespace lsst
py::object result
Definition: _schema.cc:429
table::Key< std::string > name
Definition: Amplifier.cc:116
table::Key< int > kernelFunction
double x
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
uint64_t * ptr
Definition: RangeSet.cc:88
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
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.
std::vector< double > getKernelParameters() const override
Return the current kernel parameters.
std::string toString(std::string const &prefix="") const override
Return a string representation of the kernel.
std::shared_ptr< Kernel > resized(int width, int height) const override
Return a pointer to a clone with specified kernel dimensions.
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.
std::shared_ptr< Kernel > clone() const override
Return a pointer to a deep copy of this kernel.
void setKernelParameter(unsigned int ind, double value) const override
Set one kernel parameter.
virtual KernelFunctionPtr getKernelFunction() const
Get a deep copy of the kernel function.
double doComputeImage(lsst::afw::image::Image< Pixel > &image, bool doNormalize) const override
Low-level version of computeImage.
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
KernelFunctionPtr _kernelFunctionPtr
Definition: Kernel.h:633
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
AnalyticKernel()
Construct an empty spatially invariant AnalyticKernel of size 0x0.
A Function taking two arguments.
Definition: Function.h:259
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
std::vector< SpatialFunctionPtr > _spatialFunctionList
Definition: Kernel.h:449
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
bool isSpatiallyVarying() const
Return true iff the kernel is spatially varying (has a spatial function)
Definition: Kernel.h:333
void setKernelParametersFromSpatialModel(double x, double y) const
Set the kernel parameters from the spatial model (if any).
Definition: Kernel.cc:217
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
std::shared_ptr< Persistable > get(int id) const
Load the Persistable with the given ID and return it.
An object passed to Persistable::write to allow it to persist itself.
int put(Persistable const *obj, bool permissive=false)
Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArc...
A base class for factory classes used to reconstruct objects from records.
Definition: Persistable.h:228
PersistableFactory(std::string const &name)
Constructor for the factory.
Definition: Persistable.cc:74
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)
T get(T... args)
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
A base class for image defects.
T reset(T... args)
T size(T... args)