lsst.afw  20.0.0-6-g4dd452d24+1caa149b74
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
lsst::afw::math::SeparableKernel Class Reference

A kernel described by a pair of functions: func(x, y) = colFunc(x) * rowFunc(y) More...

#include <Kernel.h>

Inheritance diagram for 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 lsst::afw::math::BilinearWarpingKernel lsst::afw::math::LanczosWarpingKernel lsst::afw::math::NearestWarpingKernel

Public Types

typedef lsst::afw::math::Function1< PixelKernelFunction
 
typedef std::shared_ptr< KernelFunctionKernelFunctionPtr
 
typedef double Pixel
 
typedef std::shared_ptr< lsst::afw::math::Function2< double > > SpatialFunctionPtr
 
typedef lsst::afw::math::Function2< double > SpatialFunction
 
typedef lsst::afw::math::NullFunction2< double > NullSpatialFunction
 
typedef generic_kernel_tag kernel_fill_factor
 

Public Member Functions

 SeparableKernel ()
 Construct an empty spatially invariant SeparableKernel of size 0x0. More...
 
 SeparableKernel (int width, int height, KernelFunction const &kernelColFunction, KernelFunction const &kernelRowFunction, Kernel::SpatialFunction const &spatialFunction=NullSpatialFunction())
 Construct a spatially invariant SeparableKernel, or a spatially varying SeparableKernel that uses the same functional form to model each function parameter. More...
 
 SeparableKernel (int width, int height, KernelFunction const &kernelColFunction, KernelFunction const &kernelRowFunction, std::vector< Kernel::SpatialFunctionPtr > const &spatialFunctionList)
 Construct a spatially varying SeparableKernel. More...
 
 SeparableKernel (const SeparableKernel &)=delete
 
 SeparableKernel (SeparableKernel &&)=delete
 
SeparableKerneloperator= (const SeparableKernel &)=delete
 
SeparableKerneloperator= (SeparableKernel &&)=delete
 
 ~SeparableKernel () override=default
 
std::shared_ptr< Kernelclone () const override
 Return a pointer to a deep copy of this kernel. 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...
 
int getCtrX () const
 Return x index of kernel's center. More...
 
int getCtrY () const
 Return y 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...
 
void setCtrX (int ctrX)
 Set x index of kernel's center. More...
 
void setCtrY (int ctrY)
 Set y 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...
 
virtual bool isPersistable () const noexcept
 Return true if this particular object can be persisted using afw::table::io. 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< SeparableKerneldynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. 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< KerneldynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 

Protected Types

typedef io::OutputArchiveHandle OutputArchiveHandle
 

Protected Member Functions

double doComputeImage (lsst::afw::image::Image< Pixel > &image, bool doNormalize) const override
 Low-level version of computeImage. 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...
 
virtual std::string getPersistenceName () const
 Return the unique name used to persist this object and look up its factory. More...
 
virtual void write (OutputArchiveHandle &handle) const
 Write the object to one or more catalogs. More...
 

Protected Attributes

std::vector< SpatialFunctionPtr_spatialFunctionList
 

Detailed Description

A kernel described by a pair of functions: func(x, y) = colFunc(x) * rowFunc(y)

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).

Definition at line 907 of file Kernel.h.

Member Typedef Documentation

◆ kernel_fill_factor

Definition at line 119 of file Kernel.h.

◆ KernelFunction

Definition at line 909 of file Kernel.h.

◆ KernelFunctionPtr

Definition at line 910 of file Kernel.h.

◆ NullSpatialFunction

Definition at line 116 of file Kernel.h.

◆ OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

◆ Pixel

typedef double lsst::afw::math::Kernel::Pixel
inherited

Definition at line 113 of file Kernel.h.

◆ SpatialFunction

Definition at line 115 of file Kernel.h.

◆ SpatialFunctionPtr

Definition at line 114 of file Kernel.h.

Constructor & Destructor Documentation

◆ SeparableKernel() [1/5]

lsst::afw::math::SeparableKernel::SeparableKernel ( )
explicit

Construct an empty spatially invariant SeparableKernel of size 0x0.

Definition at line 43 of file SeparableKernel.cc.

◆ SeparableKernel() [2/5]

lsst::afw::math::SeparableKernel::SeparableKernel ( int  width,
int  height,
KernelFunction const &  kernelColFunction,
KernelFunction const &  kernelRowFunction,
Kernel::SpatialFunction const &  spatialFunction = NullSpatialFunction() 
)
explicit

Construct a spatially invariant SeparableKernel, or a spatially varying SeparableKernel that uses the same functional form to model each function parameter.

Parameters
widthwidth of kernel
heightheight of kernel
kernelColFunctionkernel column function
kernelRowFunctionkernel row function
spatialFunctionspatial function; one deep copy is made for each kernel column and row function parameter; if omitted or set to Kernel::NullSpatialFunction then the kernel is spatially invariant

Definition at line 56 of file SeparableKernel.cc.

◆ SeparableKernel() [3/5]

lsst::afw::math::SeparableKernel::SeparableKernel ( int  width,
int  height,
KernelFunction const &  kernelColFunction,
KernelFunction const &  kernelRowFunction,
std::vector< Kernel::SpatialFunctionPtr > const &  spatialFunctionList 
)
explicit

Construct a spatially varying SeparableKernel.

Parameters
widthwidth of kernel
heightheight of kernel
kernelColFunctionkernel column function
kernelRowFunctionkernel row function
spatialFunctionListlist of spatial funcs, one per kernel column and row function parameter; a deep copy is made of each function
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the length of spatialFunctionList != # kernel function parameters.

Definition at line 72 of file SeparableKernel.cc.

◆ SeparableKernel() [4/5]

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

◆ SeparableKernel() [5/5]

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

◆ ~SeparableKernel()

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

Member Function Documentation

◆ clone()

std::shared_ptr< Kernel > lsst::afw::math::SeparableKernel::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

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

Reimplemented in lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, and lsst::afw::math::LanczosWarpingKernel.

Definition at line 97 of file SeparableKernel.cc.

◆ computeCache()

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

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 310 of file SeparableKernel.cc.

◆ 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 85 of file Kernel.cc.

◆ 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 144 of file Kernel.cc.

◆ 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

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 123 of file SeparableKernel.cc.

◆ doComputeImage()

double lsst::afw::math::SeparableKernel::doComputeImage ( lsst::afw::image::Image< Pixel > &  image,
bool  doNormalize 
) const
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.

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 172 of file SeparableKernel.cc.

◆ 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.

◆ 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.

◆ getBBox()

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

return parent bounding box, with XY0 = -center

Definition at line 262 of file Kernel.h.

◆ getCacheSize()

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

Get the current cache size (0 if none)

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

Definition at line 320 of file SeparableKernel.cc.

◆ getCtr()

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

Return index of kernel's center.

Definition at line 235 of file Kernel.h.

◆ getCtrX()

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

Return x index of kernel's center.

Deprecated:
Use getCtr instead

Definition at line 244 of file Kernel.h.

◆ getCtrY()

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

Return y index of kernel's center.

Deprecated:
Use getCtr instead

Definition at line 255 of file Kernel.h.

◆ getDimensions()

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

Return the Kernel's dimensions (width, height)

Definition at line 213 of file Kernel.h.

◆ getHeight()

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

Return the Kernel's height.

Definition at line 230 of file Kernel.h.

◆ getKernelColFunction()

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

Get a deep copy of the col kernel function.

Definition at line 140 of file SeparableKernel.cc.

◆ getKernelParameter()

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

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 980 of file Kernel.h.

◆ getKernelParameters()

std::vector< double > lsst::afw::math::SeparableKernel::getKernelParameters ( ) const
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 161 of file SeparableKernel.cc.

◆ getKernelRowFunction()

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

Get a deep copy of the row kernel function.

Definition at line 144 of file SeparableKernel.cc.

◆ getNKernelParameters()

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

Return the number of kernel parameters (0 if none)

Definition at line 269 of file Kernel.h.

◆ getNSpatialParameters()

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

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

Definition at line 274 of file Kernel.h.

◆ getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const
protectedvirtualinherited

◆ getPythonModule()

std::string lsst::afw::math::Kernel::getPythonModule ( ) const
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.

Definition at line 235 of file Kernel.cc.

◆ 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 153 of file Kernel.cc.

◆ 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 166 of file Kernel.cc.

◆ 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 368 of file Kernel.h.

◆ getWidth()

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

Return the Kernel's width.

Definition at line 225 of file Kernel.h.

◆ 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 177 of file Kernel.cc.

◆ isPersistable()

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const
inlinevirtualnoexceptinherited

◆ isSpatiallyVarying()

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

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

Definition at line 380 of file Kernel.h.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

SeparableKernel& lsst::afw::math::SeparableKernel::operator= ( SeparableKernel &&  )
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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ resized()

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

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 111 of file SeparableKernel.cc.

◆ setCtr()

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

Set index of kernel's center.

Definition at line 335 of file Kernel.h.

◆ setCtrX()

void lsst::afw::math::Kernel::setCtrX ( int  ctrX)
inlineinherited

Set x index of kernel's center.

Deprecated:
Use setCtr instead

Definition at line 348 of file Kernel.h.

◆ setCtrY()

void lsst::afw::math::Kernel::setCtrY ( int  ctrY)
inlineinherited

Set y index of kernel's center.

Deprecated:
Use setCtr instead

Definition at line 360 of file Kernel.h.

◆ setDimensions()

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

Definition at line 215 of file Kernel.h.

◆ setHeight()

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

Definition at line 220 of file Kernel.h.

◆ setKernelParameter()

void lsst::afw::math::SeparableKernel::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::Kernel.

Reimplemented in lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, and lsst::afw::math::LanczosWarpingKernel.

Definition at line 186 of file SeparableKernel.cc.

◆ 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 410 of file Kernel.h.

◆ 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 388 of file Kernel.h.

◆ 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 228 of file Kernel.cc.

◆ 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 119 of file Kernel.cc.

◆ setWidth()

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

Definition at line 219 of file Kernel.h.

◆ 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 183 of file Kernel.cc.

◆ toString()

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

Return a string representation of the kernel.

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

Definition at line 148 of file SeparableKernel.cc.

◆ write()

void lsst::afw::table::io::Persistable::write ( OutputArchiveHandle handle) const
protectedvirtualinherited

◆ 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.

◆ 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.

◆ 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.

Member Data Documentation

◆ _spatialFunctionList

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

Definition at line 496 of file Kernel.h.


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