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
|
A kernel described by a function. More...
#include <Kernel.h>
Classes | |
class | Factory |
Public Types | |
using | KernelFunction = lsst::afw::math::Function2< Pixel > |
using | KernelFunctionPtr = std::shared_ptr< lsst::afw::math::Function2< Pixel > > |
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 | |
AnalyticKernel () | |
Construct an empty spatially invariant AnalyticKernel of size 0x0. More... | |
AnalyticKernel (int width, int height, KernelFunction const &kernelFunction, Kernel::SpatialFunction const &spatialFunction=NullSpatialFunction()) | |
Construct a spatially invariant AnalyticKernel, or a spatially varying AnalyticKernel where the spatial model is described by one function (that is cloned to give one per analytic function parameter). More... | |
AnalyticKernel (int width, int height, KernelFunction const &kernelFunction, std::vector< Kernel::SpatialFunctionPtr > const &spatialFunctionList) | |
Construct a spatially varying AnalyticKernel, where the spatial model is described by a list of functions (one per analytic function parameter). More... | |
AnalyticKernel (const AnalyticKernel &)=delete | |
AnalyticKernel (AnalyticKernel &&)=delete | |
AnalyticKernel & | operator= (const AnalyticKernel &)=delete |
AnalyticKernel & | operator= (AnalyticKernel &&)=delete |
~AnalyticKernel () override=default | |
std::shared_ptr< Kernel > | clone () const override |
Return a pointer to a deep copy of this kernel. More... | |
std::shared_ptr< Kernel > | resized (int width, int height) const override |
Return a pointer to a clone with specified kernel dimensions. 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... | |
std::vector< double > | getKernelParameters () const override |
Return the current kernel parameters. More... | |
virtual KernelFunctionPtr | getKernelFunction () const |
Get a deep copy of the kernel function. More... | |
std::string | toString (std::string const &prefix="") const override |
Return a string representation of the kernel. More... | |
bool | isPersistable () const noexcept override |
Return true if this particular object can be persisted using afw::table::io. 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< SpatialFunctionPtr > | getSpatialFunctionList () const |
Return a list of clones of the spatial functions. More... | |
virtual double | getKernelParameter (unsigned int i) const |
Return a particular Kernel Parameter (no bounds checking). 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 ¶ms) |
Set the kernel parameters of a spatially invariant kernel. More... | |
void | setKernelParameters (std::pair< double, double > const ¶ms) |
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... | |
virtual void | computeCache (int const) |
Compute a cache of Kernel values, if desired. More... | |
virtual int | getCacheSize () const |
Get the current size of the kernel cache (0 if none or if caches not supported) 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< AnalyticKernel > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< AnalyticKernel > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< AnalyticKernel > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< AnalyticKernel > | dynamicCast (std::shared_ptr< Persistable > const &ptr) |
Dynamically cast a shared_ptr. More... | |
static std::shared_ptr< Kernel > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< Kernel > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< Kernel > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< Kernel > | dynamicCast (std::shared_ptr< Persistable > const &ptr) |
Dynamically cast a shared_ptr. More... | |
Protected Types | |
using | OutputArchiveHandle = io::OutputArchiveHandle |
Protected Member Functions | |
double | doComputeImage (lsst::afw::image::Image< Pixel > &image, bool doNormalize) const override |
Low-level version of computeImage. More... | |
std::string | getPersistenceName () const override |
Return the unique name used to persist this object and look up its factory. More... | |
void | write (OutputArchiveHandle &handle) const override |
Write the object to one or more catalogs. More... | |
void | setKernelParameter (unsigned int ind, double value) const override |
Set one kernel parameter. 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 | setKernelParametersFromSpatialModel (double x, double y) const |
Set the kernel parameters from the spatial model (if any). More... | |
Protected Attributes | |
KernelFunctionPtr | _kernelFunctionPtr |
std::vector< SpatialFunctionPtr > | _spatialFunctionList |
A kernel described by a function.
The function's x, y arguments are as follows:
Note: each pixel is set to the value of the kernel function at the center of the pixel (rather than averaging the function over the area of the pixel).
|
inherited |
|
inherited |
|
protectedinherited |
Definition at line 108 of file Persistable.h.
|
inherited |
|
inherited |
|
inherited |
|
explicit |
Construct an empty spatially invariant AnalyticKernel of size 0x0.
Definition at line 41 of file AnalyticKernel.cc.
|
explicit |
Construct a spatially invariant AnalyticKernel, or a spatially varying AnalyticKernel where the spatial model is described by one function (that is cloned to give one per analytic function parameter).
width | width of kernel |
height | height of kernel |
kernelFunction | kernel function; a deep copy is made |
spatialFunction | spatial function; one deep copy is made for each kernel function parameter; if omitted or set to Kernel::NullSpatialFunction() then the kernel is spatially invariant |
Definition at line 43 of file AnalyticKernel.cc.
|
explicit |
Construct a spatially varying AnalyticKernel, where the spatial model is described by a list of functions (one per analytic function parameter).
width | width of kernel |
height | height of kernel |
kernelFunction | kernel function; a deep copy is made |
spatialFunctionList | list of spatial functions, one per kernel function parameter; a deep copy is made of each function |
lsst::pex::exceptions::InvalidParameterError | if the length of spatialFunctionList != # kernel function parameters. |
Definition at line 48 of file AnalyticKernel.cc.
|
delete |
|
delete |
|
overridedefault |
|
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.
Implements lsst::afw::math::Kernel.
Definition at line 60 of file AnalyticKernel.cc.
|
inlinevirtualinherited |
Compute a cache of Kernel values, if desired.
Reimplemented in lsst::afw::math::SeparableKernel.
double lsst::afw::math::AnalyticKernel::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.
This special version accepts any size image (though you can get in trouble if the image is large enough that the image is evaluated outside its domain).
image | image whose pixels are to be set (output) xy0 of the image will be set to -kernel.getCtr() - border, where border = (image.getDimensions() - kernel.getDimensions()) / 2 |
doNormalize | normalize the image (so sum is 1)? |
x | x (column position) at which to compute spatial function |
y | y (row position) at which to compute spatial function |
lsst::pex::exceptions::InvalidParameterError | if the image is the wrong size |
lsst::pex::exceptions::OverflowError | if doNormalize is true and the kernel sum is exactly 0 |
Definition at line 82 of file AnalyticKernel.cc.
|
inherited |
|
overrideprotectedvirtual |
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.
image | image whose pixels are to be set (output) |
doNormalize | normalize the image (so sum is 1)? |
Implements lsst::afw::math::Kernel.
Definition at line 111 of file AnalyticKernel.cc.
|
staticinherited |
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;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
|
staticinherited |
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;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
|
inlineinherited |
return parent bounding box, with XY0 = -center
Definition at line 239 of file Kernel.h.
|
inlinevirtualinherited |
Get the current size of the kernel cache (0 if none or if caches not supported)
Reimplemented in lsst::afw::math::SeparableKernel.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
virtual |
Get a deep copy of the kernel function.
Definition at line 91 of file AnalyticKernel.cc.
|
inlinevirtualinherited |
Return a particular Kernel Parameter (no bounds checking).
This version is slow, but specialisations may be faster
Reimplemented in lsst::afw::math::SeparableKernel.
Definition at line 277 of file Kernel.h.
|
overridevirtual |
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 104 of file AnalyticKernel.cc.
|
inlineinherited |
|
inlineinherited |
Return the number of spatial parameters (0 if not spatially varying)
|
overrideprotectedvirtual |
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 191 of file AnalyticKernel.cc.
|
overrideprotectedvirtualinherited |
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::table::io::Persistable.
Reimplemented in lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, and lsst::afw::math::LanczosWarpingKernel.
|
inherited |
Return a clone of the specified spatial function (one component of the spatial model)
index | index of desired spatial function; must be in range [0, number spatial parameters - 1] |
lsst::pex::exceptions::InvalidParameterError | if kernel not spatially varying |
lsst::pex::exceptions::InvalidParameterError | if index out of range |
Definition at line 144 of file Kernel.cc.
|
inherited |
|
inlineinherited |
|
inlineinherited |
|
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.
Definition at line 167 of file Kernel.cc.
|
inlineoverridevirtualnoexcept |
Return true if this particular object can be persisted using afw::table::io.
Reimplemented from lsst::afw::table::io::Persistable.
|
inlineinherited |
|
delete |
|
delete |
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[in] | manager | Manager for the memory to read from. |
[in] | hdu | HDU 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.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[in] | manager | Manager for the memory to read from. |
[in] | hdu | HDU 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.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[in] | fileName | Name of the file to read. |
[in] | hdu | HDU 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.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[in] | fileName | Name of the file to read. |
[in] | hdu | HDU 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.
|
overridevirtual |
Return a pointer to a clone with specified kernel dimensions.
width | Number of columns in pixels |
height | Number of rows in pixels |
Must be implemented by derived classes.
Implements lsst::afw::math::Kernel.
Definition at line 72 of file AnalyticKernel.cc.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
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.
lsst::pex::exceptions::InvalidParameterError | always (unless subclassed) |
Reimplemented from lsst::afw::math::Kernel.
Definition at line 135 of file AnalyticKernel.cc.
|
inlineinherited |
Set the kernel parameters of a 2-component spatially invariant kernel.
Definition at line 363 of file Kernel.h.
|
inlineinherited |
Set the kernel parameters of a spatially invariant kernel.
lsst::pex::exceptions::RuntimeError | if the kernel has a spatial function |
lsst::pex::exceptions::InvalidParameterError | if the params vector is the wrong length |
Definition at line 341 of file Kernel.h.
|
protectedinherited |
|
inherited |
Set the parameters of all spatial functions.
Params is indexed as [kernel parameter][spatial parameter]
lsst::pex::exceptions::InvalidParameterError | if params is the wrong shape (if this exception is thrown then no parameters are changed) |
Definition at line 110 of file Kernel.cc.
|
inlineinherited |
|
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.
lsst::pex::exceptions::InvalidParameterError | if the resulting box would have dimension < 1 in either axis |
|
overridevirtual |
Return a string representation of the kernel.
Reimplemented from lsst::afw::math::Kernel.
Definition at line 95 of file AnalyticKernel.cc.
|
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 193 of file AnalyticKernel.cc.
|
inherited |
Write the object to an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
|
inherited |
Write the object to a FITS image in memory.
[in] | manager | Name of the file to write to. |
[in] | mode | If "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.
|
inherited |
Write the object to a regular FITS file.
[in] | fileName | Name of the file to write to. |
[in] | mode | If "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.
|
protected |
|
protectedinherited |