LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
lsst::afw::math::LanczosWarpingKernel Class Reference

Lanczos warping: accurate but slow and can introduce ringing artifacts. More...

#include <warpExposure.h>

Inheritance diagram for lsst::afw::math::LanczosWarpingKernel:
lsst::afw::math::SeparableKernel lsst::afw::table::io::PersistableFacade< SeparableKernel > lsst::afw::math::Kernel lsst::afw::table::io::PersistableFacade< Kernel > lsst::afw::table::io::Persistable

Public Types

using KernelFunction = lsst::afw::math::Function1< Pixel >
 
using KernelFunctionPtr = std::shared_ptr< KernelFunction >
 
using Pixel = double
 
using SpatialFunctionPtr = std::shared_ptr< lsst::afw::math::Function2< double > >
 
using SpatialFunction = lsst::afw::math::Function2< double >
 
using NullSpatialFunction = lsst::afw::math::NullFunction2< double >
 
using kernel_fill_factor = generic_kernel_tag
 

Public Member Functions

 LanczosWarpingKernel (int order)
 
 LanczosWarpingKernel (const LanczosWarpingKernel &)=delete
 
 LanczosWarpingKernel (LanczosWarpingKernel &&)=delete
 
LanczosWarpingKerneloperator= (const LanczosWarpingKernel &)=delete
 
LanczosWarpingKerneloperator= (LanczosWarpingKernel &&)=delete
 
 ~LanczosWarpingKernel () override=default
 
std::shared_ptr< Kernelclone () const override
 Return a pointer to a deep copy of this kernel. More...
 
int getOrder () const
 get the order of the kernel More...
 
bool isPersistable () const noexcept override
 Return true if this particular object can be persisted using afw::table::io. More...
 
std::shared_ptr< Kernelresized (int width, int height) const override
 Return a pointer to a clone with specified kernel dimensions. More...
 
double computeVectors (std::vector< Pixel > &colList, std::vector< Pixel > &rowList, bool doNormalize, double x=0.0, double y=0.0) const
 Compute the column and row arrays in place, where kernel(col, row) = colList(col) * rowList(row) More...
 
double getKernelParameter (unsigned int i) const override
 Return a particular Kernel Parameter (no bounds checking). More...
 
std::vector< double > getKernelParameters () const override
 Return the current kernel parameters. More...
 
KernelFunctionPtr getKernelColFunction () const
 Get a deep copy of the col kernel function. More...
 
KernelFunctionPtr getKernelRowFunction () const
 Get a deep copy of the row kernel function. More...
 
std::string toString (std::string const &prefix="") const override
 Return a string representation of the kernel. More...
 
void computeCache (int const cacheSize) override
 Compute a cache of Kernel values, if desired. More...
 
int getCacheSize () const override
 Get the current cache size (0 if none) More...
 
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. More...
 
lsst::geom::Extent2I const getDimensions () const
 Return the Kernel's dimensions (width, height) More...
 
void setDimensions (lsst::geom::Extent2I dims)
 
void setWidth (int width)
 
void setHeight (int height)
 
int getWidth () const
 Return the Kernel's width. More...
 
int getHeight () const
 Return the Kernel's height. More...
 
lsst::geom::Point2I getCtr () const
 Return index of kernel's center. More...
 
lsst::geom::Box2I getBBox () const
 return parent bounding box, with XY0 = -center More...
 
unsigned int getNKernelParameters () const
 Return the number of kernel parameters (0 if none) More...
 
int getNSpatialParameters () const
 Return the number of spatial parameters (0 if not spatially varying) More...
 
SpatialFunctionPtr getSpatialFunction (unsigned int index) const
 Return a clone of the specified spatial function (one component of the spatial model) More...
 
std::vector< SpatialFunctionPtrgetSpatialFunctionList () const
 Return a list of clones of the spatial functions. More...
 
lsst::geom::Box2I growBBox (lsst::geom::Box2I const &bbox) const
 Given a bounding box for pixels one wishes to compute by convolving an image with this kernel, return the bounding box of pixels that must be accessed on the image to be convolved. More...
 
lsst::geom::Box2I shrinkBBox (lsst::geom::Box2I const &bbox) const
 Given a bounding box for an image one wishes to convolve with this kernel, return the bounding box for the region of pixels that can be computed. More...
 
void setCtr (lsst::geom::Point2I ctr)
 Set index of kernel's center. More...
 
std::vector< std::vector< double > > getSpatialParameters () const
 Return the spatial parameters parameters (an empty vector if not spatially varying) More...
 
bool isSpatiallyVarying () const
 Return true iff the kernel is spatially varying (has a spatial function) More...
 
void setKernelParameters (std::vector< double > const &params)
 Set the kernel parameters of a spatially invariant kernel. More...
 
void setKernelParameters (std::pair< double, double > const &params)
 Set the kernel parameters of a 2-component spatially invariant kernel. More...
 
void setSpatialParameters (const std::vector< std::vector< double >> params)
 Set the parameters of all spatial functions. More...
 
void computeKernelParametersFromSpatialModel (std::vector< double > &kernelParams, double x, double y) const
 Compute the kernel parameters at a specified point. More...
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file. More...
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory. More...
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object. More...
 

Static Public Member Functions

static std::shared_ptr< SeparableKernelreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< SeparableKernelreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< SeparableKernelreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< KernelreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< KernelreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< KernelreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< SeparableKerneldynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< KerneldynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

void setKernelParameter (unsigned int ind, double value) const override
 Set one kernel parameter. More...
 
std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory. More...
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs. More...
 
double doComputeImage (lsst::afw::image::Image< Pixel > &image, bool doNormalize) const override
 Low-level version of computeImage. More...
 
void setKernelParametersFromSpatialModel (double x, double y) const
 Set the kernel parameters from the spatial model (if any). More...
 

Protected Attributes

std::vector< SpatialFunctionPtr_spatialFunctionList
 

Detailed Description

Lanczos warping: accurate but slow and can introduce ringing artifacts.

This kernel is the product of two 1-dimensional Lanczos functions. The number of minima and maxima in the 1-dimensional Lanczos function is 2*order + 1. The kernel has one pixel per function minimum or maximum; but as applied to warping, the first or last pixel is always zero and can be omitted. Thus the kernel size is 2*order x 2*order.

For more information about warping kernels see makeWarpingKernel

Todo:
: make a new class WarpingKernel and make this a subclass.

Definition at line 66 of file warpExposure.h.

Member Typedef Documentation

◆ kernel_fill_factor

Definition at line 118 of file Kernel.h.

◆ KernelFunction

Definition at line 862 of file Kernel.h.

◆ KernelFunctionPtr

Definition at line 863 of file Kernel.h.

◆ NullSpatialFunction

Definition at line 115 of file Kernel.h.

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

◆ Pixel

using lsst::afw::math::Kernel::Pixel = double
inherited

Definition at line 112 of file Kernel.h.

◆ SpatialFunction

Definition at line 114 of file Kernel.h.

◆ SpatialFunctionPtr

Definition at line 113 of file Kernel.h.

Constructor & Destructor Documentation

◆ LanczosWarpingKernel() [1/3]

lsst::afw::math::LanczosWarpingKernel::LanczosWarpingKernel ( int  order)
inlineexplicit
Parameters
orderorder of Lanczos function

Definition at line 68 of file warpExposure.h.

70  : SeparableKernel(2 * order, 2 * order, LanczosFunction1<Kernel::Pixel>(order),
71  LanczosFunction1<Kernel::Pixel>(order)) {}
SeparableKernel()
Construct an empty spatially invariant SeparableKernel of size 0x0.
table::Key< int > order

◆ LanczosWarpingKernel() [2/3]

lsst::afw::math::LanczosWarpingKernel::LanczosWarpingKernel ( const LanczosWarpingKernel )
delete

◆ LanczosWarpingKernel() [3/3]

lsst::afw::math::LanczosWarpingKernel::LanczosWarpingKernel ( LanczosWarpingKernel &&  )
delete

◆ ~LanczosWarpingKernel()

lsst::afw::math::LanczosWarpingKernel::~LanczosWarpingKernel ( )
overridedefault

Member Function Documentation

◆ clone()

std::shared_ptr< Kernel > lsst::afw::math::LanczosWarpingKernel::clone ( ) const
overridevirtual

Return a pointer to a deep copy of this kernel.

This kernel exists instead of a copy constructor so one can obtain a copy of an actual kernel instead of a useless copy of the base class.

Every kernel subclass must override this method.

Returns
a pointer to a deep copy of the kernel

Reimplemented from lsst::afw::math::SeparableKernel.

Definition at line 97 of file warpExposure.cc.

97  {
99 }
int getOrder() const
get the order of the kernel

◆ computeCache()

void lsst::afw::math::SeparableKernel::computeCache ( int const  )
overridevirtualinherited

Compute a cache of Kernel values, if desired.

Warning
: few kernel classes actually support this, in which case this is a no-op and getCacheSize always returns 0.

Reimplemented from lsst::afw::math::Kernel.

Definition at line 309 of file SeparableKernel.cc.

309  {
311 
312  func = getKernelColFunction();
313  _computeCache(cacheSize, _kernelY, func, &_kernelColCache);
314 
315  func = getKernelRowFunction();
316  _computeCache(cacheSize, _kernelX, func, &_kernelRowCache);
317 }
KernelFunctionPtr getKernelRowFunction() const
Get a deep copy of the row kernel function.
std::shared_ptr< KernelFunction > KernelFunctionPtr
Definition: Kernel.h:863
KernelFunctionPtr getKernelColFunction() const
Get a deep copy of the col kernel function.
table::Key< int > cacheSize

◆ computeImage()

double lsst::afw::math::Kernel::computeImage ( lsst::afw::image::Image< Pixel > &  image,
bool  doNormalize,
double  x = 0.0,
double  y = 0.0 
) const
inherited

Compute an image (pixellized representation of the kernel) in place.

Parameters
imageimage whose pixels are to be set (output); xy0 of the image will be set to -kernel.getCtr()
doNormalizenormalize the image (so sum is 1)?
xx (column position) at which to compute spatial function
yy (row position) at which to compute spatial function
Returns
The kernel sum
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the image is the wrong size
lsst::pex::exceptions::OverflowErrorif doNormalize is true and the kernel sum is exactly 0
Note
computeNewImage has been retired; it doesn't need to be a member

Definition at line 76 of file Kernel.cc.

76  {
77  if (image.getDimensions() != this->getDimensions()) {
79  os << "image dimensions = ( " << image.getWidth() << ", " << image.getHeight() << ") != ("
80  << this->getWidth() << ", " << this->getHeight() << ") = kernel dimensions";
82  }
83  image.setXY0(-_ctrX, -_ctrY);
84  if (this->isSpatiallyVarying()) {
86  }
87  return doComputeImage(image, doNormalize);
88 }
double x
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::ostream * os
Definition: Schema.cc:557
int y
Definition: SpanSet.cc:48
int getHeight() const
Return the Kernel's height.
Definition: Kernel.h:229
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
virtual double doComputeImage(lsst::afw::image::Image< Pixel > &image, bool doNormalize) const =0
Low-level version of computeImage.
void setKernelParametersFromSpatialModel(double x, double y) const
Set the kernel parameters from the spatial model (if any).
Definition: Kernel.cc:217
Reports invalid arguments.
Definition: Runtime.h:66
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.

◆ computeKernelParametersFromSpatialModel()

void lsst::afw::math::Kernel::computeKernelParametersFromSpatialModel ( std::vector< double > &  kernelParams,
double  x,
double  y 
) const
inherited

Compute the kernel parameters at a specified point.

Warning: this is a low-level function that assumes kernelParams is the right length. It will fail in unpredictable ways if that condition is not met.

Definition at line 135 of file Kernel.cc.

136  {
137  std::vector<double>::iterator paramIter = kernelParams.begin();
139  for (; funcIter != _spatialFunctionList.end(); ++funcIter, ++paramIter) {
140  *paramIter = (*(*funcIter))(x, y);
141  }
142 }
T begin(T... args)
std::vector< SpatialFunctionPtr > _spatialFunctionList
Definition: Kernel.h:449

◆ computeVectors()

double lsst::afw::math::SeparableKernel::computeVectors ( std::vector< Pixel > &  colList,
std::vector< Pixel > &  rowList,
bool  doNormalize,
double  x = 0.0,
double  y = 0.0 
) const
inherited

Compute the column and row arrays in place, where kernel(col, row) = colList(col) * rowList(row)

x, y are ignored if there is no spatial function.

Parameters
colListcolumn vector
rowListrow vector
doNormalizenormalize the image (so sum of each is 1)?
xx (column position) at which to compute spatial function
yy (row position) at which to compute spatial function
Returns
the kernel sum (1.0 if doNormalize true)
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif colList or rowList is the wrong size
lsst::pex::exceptions::OverflowErrorif doNormalize is true and the kernel sum is exactly 0

Definition at line 122 of file SeparableKernel.cc.

123  {
124  if (static_cast<int>(colList.size()) != this->getWidth() ||
125  static_cast<int>(rowList.size()) != this->getHeight()) {
127  os << "colList.size(), rowList.size() = (" << colList.size() << ", " << rowList.size() << ") != ("
128  << this->getWidth() << ", " << this->getHeight() << ") = "
129  << "kernel dimensions";
131  }
132  if (this->isSpatiallyVarying()) {
134  }
135 
136  return basicComputeVectors(colList, rowList, doNormalize);
137 }
T size(T... args)

◆ doComputeImage()

double lsst::afw::math::SeparableKernel::doComputeImage ( lsst::afw::image::Image< Pixel > &  image,
bool  doNormalize 
) const
overrideprotectedvirtualinherited

Low-level version of computeImage.

Before this is called the image dimensions are checked, the image's xy0 is set and the kernel's parameters are set. This routine sets the pixels, including normalization if requested.

Parameters
imageimage whose pixels are to be set (output)
doNormalizenormalize the image (so sum is 1)?
Returns
The kernel sum

Implements lsst::afw::math::Kernel.

Definition at line 171 of file SeparableKernel.cc.

171  {
172  double imSum = basicComputeVectors(_localColList, _localRowList, doNormalize);
173 
174  for (int y = 0; y != image.getHeight(); ++y) {
175  image::Image<Pixel>::x_iterator imPtr = image.row_begin(y);
176  for (std::vector<Pixel>::iterator colIter = _localColList.begin(); colIter != _localColList.end();
177  ++colIter, ++imPtr) {
178  *imPtr = (*colIter) * _localRowList[y];
179  }
180  }
181 
182  return imSum;
183 }
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
T end(T... args)

◆ dynamicCast() [1/2]

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
py::object result
Definition: _schema.cc:429
uint64_t * ptr
Definition: RangeSet.cc:88

◆ dynamicCast() [2/2]

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }

◆ getBBox()

lsst::geom::Box2I lsst::afw::math::Kernel::getBBox ( ) const
inlineinherited

return parent bounding box, with XY0 = -center

Definition at line 239 of file Kernel.h.

239  {
240  return lsst::geom::Box2I(lsst::geom::Point2I(-_ctrX, -_ctrY), lsst::geom::Extent2I(_width, _height));
241  }
An integer coordinate rectangle.
Definition: Box.h:55

◆ getCacheSize()

int lsst::afw::math::SeparableKernel::getCacheSize ( ) const
overridevirtualinherited

Get the current cache size (0 if none)

Reimplemented from lsst::afw::math::Kernel.

Definition at line 319 of file SeparableKernel.cc.

319 { return _kernelColCache.size(); };

◆ getCtr()

lsst::geom::Point2I lsst::afw::math::Kernel::getCtr ( ) const
inlineinherited

Return index of kernel's center.

Definition at line 234 of file Kernel.h.

234 { return lsst::geom::Point2I(_ctrX, _ctrY); }
Point< int, 2 > Point2I
Definition: Point.h:321

◆ getDimensions()

lsst::geom::Extent2I const lsst::afw::math::Kernel::getDimensions ( ) const
inlineinherited

Return the Kernel's dimensions (width, height)

Definition at line 212 of file Kernel.h.

212 { return lsst::geom::Extent2I(_width, _height); }
Extent< int, 2 > Extent2I
Definition: Extent.h:397

◆ getHeight()

int lsst::afw::math::Kernel::getHeight ( ) const
inlineinherited

Return the Kernel's height.

Definition at line 229 of file Kernel.h.

229 { return _height; }

◆ getKernelColFunction()

SeparableKernel::KernelFunctionPtr lsst::afw::math::SeparableKernel::getKernelColFunction ( ) const
inherited

Get a deep copy of the col kernel function.

Definition at line 139 of file SeparableKernel.cc.

139  {
140  return _kernelColFunctionPtr->clone();
141 }
virtual std::shared_ptr< Function1< ReturnT > > clone() const =0
Return a pointer to a deep copy of this function.

◆ getKernelParameter()

double lsst::afw::math::SeparableKernel::getKernelParameter ( unsigned int  i) const
inlineoverridevirtualinherited

Return a particular Kernel Parameter (no bounds checking).

This version is slow, but specialisations may be faster

Reimplemented from lsst::afw::math::Kernel.

Definition at line 933 of file Kernel.h.

933  {
934  unsigned int const ncol = _kernelColFunctionPtr->getNParameters();
935  if (i < ncol) {
936  return _kernelColFunctionPtr->getParameter(i);
937  } else {
938  i -= ncol;
939  return _kernelRowFunctionPtr->getParameter(i);
940  }
941  }
virtual double getParameter(unsigned int ind) const
Get one function parameter without range checking.
Definition: Function.h:119
unsigned int getNParameters() const noexcept
Return the number of function parameters.
Definition: Function.h:112

◆ getKernelParameters()

std::vector< double > lsst::afw::math::SeparableKernel::getKernelParameters ( ) const
overridevirtualinherited

Return the current kernel parameters.

If the kernel is spatially varying then the parameters are those last computed. See also computeKernelParametersFromSpatialModel. If there are no kernel parameters then returns an empty vector.

Reimplemented from lsst::afw::math::Kernel.

Definition at line 160 of file SeparableKernel.cc.

160  {
161  std::vector<double> allParams = _kernelColFunctionPtr->getParameters();
162  std::vector<double> yParams = _kernelRowFunctionPtr->getParameters();
163  std::copy(yParams.begin(), yParams.end(), std::back_inserter(allParams));
164  return allParams;
165 }
T back_inserter(T... args)
std::vector< double > const & getParameters() const noexcept
Return all function parameters.
Definition: Function.h:129
T copy(T... args)

◆ getKernelRowFunction()

SeparableKernel::KernelFunctionPtr lsst::afw::math::SeparableKernel::getKernelRowFunction ( ) const
inherited

Get a deep copy of the row kernel function.

Definition at line 143 of file SeparableKernel.cc.

143  {
144  return _kernelRowFunctionPtr->clone();
145 }

◆ getNKernelParameters()

unsigned int lsst::afw::math::Kernel::getNKernelParameters ( ) const
inlineinherited

Return the number of kernel parameters (0 if none)

Definition at line 246 of file Kernel.h.

246 { return _nKernelParams; }

◆ getNSpatialParameters()

int lsst::afw::math::Kernel::getNSpatialParameters ( ) const
inlineinherited

Return the number of spatial parameters (0 if not spatially varying)

Definition at line 251 of file Kernel.h.

251  {
252  return this->isSpatiallyVarying() ? _spatialFunctionList[0]->getNParameters() : 0;
253  }

◆ getOrder()

int lsst::afw::math::LanczosWarpingKernel::getOrder ( ) const

get the order of the kernel

Definition at line 101 of file warpExposure.cc.

101 { return this->getWidth() / 2; }

◆ getPersistenceName()

std::string lsst::afw::math::LanczosWarpingKernel::getPersistenceName ( ) const
inlineoverrideprotectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 92 of file warpExposure.h.

92 { return "LanczosWarpingKernel"; }

◆ getPythonModule()

std::string lsst::afw::math::LanczosWarpingKernel::getPythonModule ( ) const
inlineoverrideprotectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented from lsst::afw::math::Kernel.

Definition at line 94 of file warpExposure.h.

94 { return "lsst.afw.math"; }

◆ getSpatialFunction()

Kernel::SpatialFunctionPtr lsst::afw::math::Kernel::getSpatialFunction ( unsigned int  index) const
inherited

Return a clone of the specified spatial function (one component of the spatial model)

Parameters
indexindex of desired spatial function; must be in range [0, number spatial parameters - 1]
Returns
a shared pointer to a spatial function. The function is a deep copy, so setting its parameters has no effect on the kernel.
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif kernel not spatially varying
lsst::pex::exceptions::InvalidParameterErrorif index out of range

Definition at line 144 of file Kernel.cc.

144  {
145  if (index >= _spatialFunctionList.size()) {
146  if (!this->isSpatiallyVarying()) {
147  throw LSST_EXCEPT(pexExcept::InvalidParameterError, "kernel is not spatially varying");
148  } else {
149  std::ostringstream errStream;
150  errStream << "index = " << index << "; must be < , " << _spatialFunctionList.size();
152  }
153  }
154  return _spatialFunctionList[index]->clone();
155 }
T str(T... args)

◆ getSpatialFunctionList()

std::vector< Kernel::SpatialFunctionPtr > lsst::afw::math::Kernel::getSpatialFunctionList ( ) const
inherited

Return a list of clones of the spatial functions.

Returns
a list of shared pointers to spatial functions. The functions are deep copies, so setting their parameters has no effect on the kernel.

Definition at line 157 of file Kernel.cc.

157  {
158  std::vector<SpatialFunctionPtr> spFuncCopyList;
159  for (auto const &spFuncIter : _spatialFunctionList) {
160  spFuncCopyList.push_back((*spFuncIter).clone());
161  }
162  return spFuncCopyList;
163 }
T push_back(T... args)

◆ getSpatialParameters()

std::vector<std::vector<double> > lsst::afw::math::Kernel::getSpatialParameters ( ) const
inlineinherited

Return the spatial parameters parameters (an empty vector if not spatially varying)

Definition at line 321 of file Kernel.h.

321  {
322  std::vector<std::vector<double>> spatialParams;
324  for (; spFuncIter != _spatialFunctionList.end(); ++spFuncIter) {
325  spatialParams.push_back((*spFuncIter)->getParameters());
326  }
327  return spatialParams;
328  }

◆ getWidth()

int lsst::afw::math::Kernel::getWidth ( ) const
inlineinherited

Return the Kernel's width.

Definition at line 224 of file Kernel.h.

224 { return _width; }

◆ growBBox()

lsst::geom::Box2I lsst::afw::math::Kernel::growBBox ( lsst::geom::Box2I const &  bbox) const
inherited

Given a bounding box for pixels one wishes to compute by convolving an image with this kernel, return the bounding box of pixels that must be accessed on the image to be convolved.

Thus the box shifted by -kernel.getCtr() and its size is expanded by kernel.getDimensions()-1.

Returns
the bbox expanded by the kernel.

Definition at line 167 of file Kernel.cc.

167  {
168  return lsst::geom::Box2I(
170  lsst::geom::Extent2I(bbox.getDimensions() + getDimensions() - lsst::geom::Extent2I(1, 1)));
171 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
lsst::geom::Extent2I const getDimensions() const
Return the Kernel's dimensions (width, height)
Definition: Kernel.h:212
lsst::geom::Point2I getCtr() const
Return index of kernel's center.
Definition: Kernel.h:234

◆ isPersistable()

bool lsst::afw::math::LanczosWarpingKernel::isPersistable ( ) const
inlineoverridevirtualnoexcept

Return true if this particular object can be persisted using afw::table::io.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 87 of file warpExposure.h.

87 { return true; }

◆ isSpatiallyVarying()

bool lsst::afw::math::Kernel::isSpatiallyVarying ( ) const
inlineinherited

Return true iff the kernel is spatially varying (has a spatial function)

Definition at line 333 of file Kernel.h.

333 { return _spatialFunctionList.size() != 0; }

◆ operator=() [1/2]

LanczosWarpingKernel& lsst::afw::math::LanczosWarpingKernel::operator= ( const LanczosWarpingKernel )
delete

◆ operator=() [2/2]

LanczosWarpingKernel& lsst::afw::math::LanczosWarpingKernel::operator= ( LanczosWarpingKernel &&  )
delete

◆ readFits() [1/6]

static std::shared_ptr<Kernel > lsst::afw::table::io::PersistableFacade< Kernel >::readFits ( fits::Fits fitsfile)
inlinestaticinherited

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< Kernel > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [2/6]

static std::shared_ptr<SeparableKernel > lsst::afw::table::io::PersistableFacade< SeparableKernel >::readFits ( fits::Fits fitsfile)
inlinestaticinherited

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [3/6]

static std::shared_ptr<SeparableKernel > lsst::afw::table::io::PersistableFacade< SeparableKernel >::readFits ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [4/6]

static std::shared_ptr<Kernel > lsst::afw::table::io::PersistableFacade< Kernel >::readFits ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [5/6]

static std::shared_ptr<SeparableKernel > lsst::afw::table::io::PersistableFacade< SeparableKernel >::readFits ( std::string const &  fileName,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ readFits() [6/6]

static std::shared_ptr<Kernel > lsst::afw::table::io::PersistableFacade< Kernel >::readFits ( std::string const &  fileName,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ resized()

std::shared_ptr< Kernel > lsst::afw::math::SeparableKernel::resized ( int  width,
int  height 
) const
overridevirtualinherited

Return a pointer to a clone with specified kernel dimensions.

Parameters
widthNumber of columns in pixels
heightNumber of rows in pixels
Returns
a pointer to a clone with new dimensions.

Must be implemented by derived classes.

Implements lsst::afw::math::Kernel.

Definition at line 110 of file SeparableKernel.cc.

110  {
112  if (isSpatiallyVarying()) {
113  retPtr = std::make_shared<SeparableKernel>(width, height, *_kernelColFunctionPtr,
114  *_kernelRowFunctionPtr, _spatialFunctionList);
115  } else {
116  retPtr = std::make_shared<SeparableKernel>(width, height, *_kernelColFunctionPtr,
117  *_kernelRowFunctionPtr);
118  }
119  return retPtr;
120 }

◆ setCtr()

void lsst::afw::math::Kernel::setCtr ( lsst::geom::Point2I  ctr)
inlineinherited

Set index of kernel's center.

Definition at line 312 of file Kernel.h.

312  {
313  _ctrX = ctr.getX();
314  _ctrY = ctr.getY();
315  _setKernelXY();
316  }
virtual void _setKernelXY()
Definition: Kernel.h:459

◆ setDimensions()

void lsst::afw::math::Kernel::setDimensions ( lsst::geom::Extent2I  dims)
inlineinherited

Definition at line 214 of file Kernel.h.

214  {
215  _width = dims.getX();
216  _height = dims.getY();
217  }

◆ setHeight()

void lsst::afw::math::Kernel::setHeight ( int  height)
inlineinherited

Definition at line 219 of file Kernel.h.

219 { _height = height; }

◆ setKernelParameter()

void lsst::afw::math::LanczosWarpingKernel::setKernelParameter ( unsigned int  ind,
double  value 
) const
overrideprotectedvirtual

Set one kernel parameter.

Classes that have kernel parameters must subclass this function.

This function is marked "const", despite modifying unimportant internals, so that computeImage can be const.

Exceptions
lsst::pex::exceptions::InvalidParameterErroralways (unless subclassed)

Reimplemented from lsst::afw::math::SeparableKernel.

Definition at line 103 of file warpExposure.cc.

103  {
104  checkWarpingKernelParameter(this, ind, value);
106 }
void setKernelParameter(unsigned int ind, double value) const override
Set one kernel parameter.

◆ setKernelParameters() [1/2]

void lsst::afw::math::Kernel::setKernelParameters ( std::pair< double, double > const &  params)
inlineinherited

Set the kernel parameters of a 2-component spatially invariant kernel.

Warning
This is a low-level method intended for maximum efficiency when using warping kernels. No error checking is performed. Use the std::vector<double> form if you want safety.

Definition at line 363 of file Kernel.h.

363  {
364  this->setKernelParameter(0, params.first);
365  this->setKernelParameter(1, params.second);
366  }
virtual void setKernelParameter(unsigned int ind, double value) const
Set one kernel parameter.
Definition: Kernel.cc:213

◆ setKernelParameters() [2/2]

void lsst::afw::math::Kernel::setKernelParameters ( std::vector< double > const &  params)
inlineinherited

Set the kernel parameters of a spatially invariant kernel.

Exceptions
lsst::pex::exceptions::RuntimeErrorif the kernel has a spatial function
lsst::pex::exceptions::InvalidParameterErrorif the params vector is the wrong length

Definition at line 341 of file Kernel.h.

341  {
342  if (this->isSpatiallyVarying()) {
343  throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Kernel is spatially varying");
344  }
345  const unsigned int nParams = this->getNKernelParameters();
346  if (nParams != params.size()) {
348  (boost::format("Number of parameters is wrong, saw %d expected %d") % nParams %
349  params.size())
350  .str());
351  }
352  for (unsigned int ii = 0; ii < nParams; ++ii) {
353  this->setKernelParameter(ii, params[ii]);
354  }
355  }
unsigned int getNKernelParameters() const
Return the number of kernel parameters (0 if none)
Definition: Kernel.h:246
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ setKernelParametersFromSpatialModel()

void lsst::afw::math::Kernel::setKernelParametersFromSpatialModel ( double  x,
double  y 
) const
protectedinherited

Set the kernel parameters from the spatial model (if any).

This function has no effect if there is no spatial model.

This function is marked "const", despite modifying unimportant internals, so that computeImage can be const.

Definition at line 217 of file Kernel.cc.

217  {
219  for (int ii = 0; funcIter != _spatialFunctionList.end(); ++funcIter, ++ii) {
220  this->setKernelParameter(ii, (*(*funcIter))(x, y));
221  }
222 }

◆ setSpatialParameters()

void lsst::afw::math::Kernel::setSpatialParameters ( const std::vector< std::vector< double >>  params)
inherited

Set the parameters of all spatial functions.

Params is indexed as [kernel parameter][spatial parameter]

Exceptions
lsst::pex::exceptions::InvalidParameterErrorif params is the wrong shape (if this exception is thrown then no parameters are changed)

Definition at line 110 of file Kernel.cc.

110  {
111  // Check params size before changing anything
112  unsigned int nKernelParams = this->getNKernelParameters();
113  if (params.size() != nKernelParams) {
114  throw LSST_EXCEPT(
116  (boost::format("params has %d entries instead of %d") % params.size() % nKernelParams).str());
117  }
118  unsigned int nSpatialParams = this->getNSpatialParameters();
119  for (unsigned int ii = 0; ii < nKernelParams; ++ii) {
120  if (params[ii].size() != nSpatialParams) {
122  (boost::format("params[%d] has %d entries instead of %d") % ii %
123  params[ii].size() % nSpatialParams)
124  .str());
125  }
126  }
127  // Set parameters
128  if (nSpatialParams > 0) {
129  for (unsigned int ii = 0; ii < nKernelParams; ++ii) {
130  this->_spatialFunctionList[ii]->setParameters(params[ii]);
131  }
132  }
133 }
int getNSpatialParameters() const
Return the number of spatial parameters (0 if not spatially varying)
Definition: Kernel.h:251

◆ setWidth()

void lsst::afw::math::Kernel::setWidth ( int  width)
inlineinherited

Definition at line 218 of file Kernel.h.

218 { _width = width; }

◆ shrinkBBox()

lsst::geom::Box2I lsst::afw::math::Kernel::shrinkBBox ( lsst::geom::Box2I const &  bbox) const
inherited

Given a bounding box for an image one wishes to convolve with this kernel, return the bounding box for the region of pixels that can be computed.

Thus the box shifted by kernel.getCtr() and its size is reduced by kernel.getDimensions()-1.

Returns
the bbox shrunk by the kernel.
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the resulting box would have dimension < 1 in either axis

Definition at line 173 of file Kernel.cc.

173  {
174  if ((bbox.getWidth() < getWidth()) || ((bbox.getHeight() < getHeight()))) {
176  os << "bbox dimensions = " << bbox.getDimensions() << " < (" << getWidth() << ", " << getHeight()
177  << ") in one or both dimensions";
179  }
180  return lsst::geom::Box2I(
182  lsst::geom::Extent2I(bbox.getWidth() + 1 - getWidth(), bbox.getHeight() + 1 - getHeight()));
183 }

◆ toString()

std::string lsst::afw::math::SeparableKernel::toString ( std::string const &  prefix = "") const
overridevirtualinherited

Return a string representation of the kernel.

Reimplemented from lsst::afw::math::Kernel.

Definition at line 147 of file SeparableKernel.cc.

147  {
149  os << prefix << "SeparableKernel:" << std::endl;
150  os << prefix
151  << "..x (width) function: " << (_kernelColFunctionPtr ? _kernelColFunctionPtr->toString() : "None")
152  << std::endl;
153  os << prefix
154  << "..y (rows) function: " << (_kernelRowFunctionPtr ? _kernelRowFunctionPtr->toString() : "None")
155  << std::endl;
156  os << Kernel::toString(prefix + "\t");
157  return os.str();
158 }
std::string prefix
Definition: SchemaMapper.cc:72
std::string toString(std::string const &prefix="") const override
Return a string representation of the function.
Definition: Function.h:240
virtual std::string toString(std::string const &prefix="") const
Return a string representation of the kernel.
Definition: Kernel.cc:185
T endl(T... args)

◆ write()

void lsst::afw::math::LanczosWarpingKernel::write ( OutputArchiveHandle handle) const
overrideprotectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 212 of file warpExposure.cc.

212  {
213  auto const &keys = LanczosKernelPersistenceHelper::get();
214  table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
215  std::shared_ptr<table::BaseRecord> record = catalog.addNew();
216  record->set(keys.order, getOrder());
217  handle.saveCatalog(catalog);
218 }
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits fitsfile) const
inherited

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager manager,
std::string const &  mode = "w" 
) const
inherited

Write the object to a FITS image in memory.

Parameters
[in]managerName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName,
std::string const &  mode = "w" 
) const
inherited

Write the object to a regular FITS file.

Parameters
[in]fileNameName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }

Member Data Documentation

◆ _spatialFunctionList

std::vector<SpatialFunctionPtr> lsst::afw::math::Kernel::_spatialFunctionList
protectedinherited

Definition at line 449 of file Kernel.h.


The documentation for this class was generated from the following files: