lsst::afw::math::AnalyticKernel Class Reference

A kernel described by a function. More...

#include <Kernel.h>

Inheritance diagram for lsst::afw::math::AnalyticKernel:

Classes
class	Factory

Public Types
typedef lsst::afw::math::Function2< Pixel >	KernelFunction
typedef std::shared_ptr< lsst::afw::math::Function2< Pixel > >	KernelFunctionPtr
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
	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...
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< 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...
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...
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
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...
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

Detailed Description

A kernel described by a function.

The function's x, y arguments are as follows:

• -getCtr() for the lower left corner pixel
• 0, 0 for the center pixel
• (getDimensions() - 1) - getCtr() for the upper right pixel

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

Member Typedef Documentation

kernel_fill_factor

typedef generic_kernel_tag lsst::afw::math::Kernel::kernel_fill_factor

inherited

Definition at line 119 of file Kernel.h.

KernelFunction

typedef lsst::afw::math::Function2<Pixel> lsst::afw::math::AnalyticKernel::KernelFunction

Definition at line 584 of file Kernel.h.

KernelFunctionPtr

typedef std::shared_ptr<lsst::afw::math::Function2<Pixel> > lsst::afw::math::AnalyticKernel::KernelFunctionPtr

Definition at line 585 of file Kernel.h.

NullSpatialFunction

typedef lsst::afw::math::NullFunction2<double> lsst::afw::math::Kernel::NullSpatialFunction

inherited

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

typedef lsst::afw::math::Function2<double> lsst::afw::math::Kernel::SpatialFunction

inherited

Definition at line 115 of file Kernel.h.

SpatialFunctionPtr

typedef std::shared_ptr<lsst::afw::math::Function2<double> > lsst::afw::math::Kernel::SpatialFunctionPtr

inherited

Definition at line 114 of file Kernel.h.

Constructor & Destructor Documentation

AnalyticKernel() [1/5]

lsst::afw::math::AnalyticKernel::AnalyticKernel ( )

explicit

Construct an empty spatially invariant AnalyticKernel of size 0x0.

Definition at line 41 of file AnalyticKernel.cc.

: Kernel(), _kernelFunctionPtr() {}

AnalyticKernel() [2/5]

lsst::afw::math::AnalyticKernel::AnalyticKernel ( int  width, int  height, KernelFunction const &  kernelFunction, Kernel::SpatialFunction const &  spatialFunction = NullSpatialFunction()  )

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

Parameters

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.

        : Kernel(width, height, kernelFunction.getNParameters(), spatialFunction),
          _kernelFunctionPtr(kernelFunction.clone()) {}

AnalyticKernel() [3/5]

lsst::afw::math::AnalyticKernel::AnalyticKernel ( int  width, int  height, KernelFunction const &  kernelFunction, std::vector< Kernel::SpatialFunctionPtr > const &  spatialFunctionList  )

explicit

Construct a spatially varying AnalyticKernel, where the spatial model is described by a list of functions (one per analytic function parameter).

Parameters

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

Exceptions

lsst::pex::exceptions::InvalidParameterError

if the length of spatialFunctionList != # kernel function parameters.

Definition at line 48 of file AnalyticKernel.cc.

        : Kernel(width, height, spatialFunctionList), _kernelFunctionPtr(kernelFunction.clone()) {
    if (kernelFunction.getNParameters() != spatialFunctionList.size()) {
        std::ostringstream os;
        os << "kernelFunction.getNParameters() = " << kernelFunction.getNParameters()
           << " != " << spatialFunctionList.size() << " = "
           << "spatialFunctionList.size()";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    }
}

AnalyticKernel() [4/5]

lsst::afw::math::AnalyticKernel::AnalyticKernel ( const AnalyticKernel &  )

delete

AnalyticKernel() [5/5]

lsst::afw::math::AnalyticKernel::AnalyticKernel ( AnalyticKernel &&  )

delete

~AnalyticKernel()

lsst::afw::math::AnalyticKernel::~AnalyticKernel ( )

overridedefault

Member Function Documentation

clone()

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

Definition at line 60 of file AnalyticKernel.cc.

                                                  {
    std::shared_ptr<Kernel> retPtr;
    if (this->isSpatiallyVarying()) {
        retPtr.reset(new AnalyticKernel(this->getWidth(), this->getHeight(), *(this->_kernelFunctionPtr),
                                        this->_spatialFunctionList));
    } else {
        retPtr.reset(new AnalyticKernel(this->getWidth(), this->getHeight(), *(this->_kernelFunctionPtr)));
    }
    retPtr->setCtr(this->getCtr());
    return retPtr;
}

computeCache()

virtual void lsst::afw::math::Kernel::computeCache ( int  const )

inlinevirtualinherited

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.

Parameters

const

desired cache size

Reimplemented in lsst::afw::math::SeparableKernel.

Definition at line 444 of file Kernel.h.

      {}

computeImage()

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

Parameters

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

Returns

The kernel sum

Note

computeNewImage has been retired; it doesn't need to be a member

Exceptions

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.

                                                                                                        {
    lsst::geom::Extent2I llBorder = (image.getDimensions() - getDimensions()) / 2;
    image.setXY0(lsst::geom::Point2I(-lsst::geom::Extent2I(getCtr() + llBorder)));
    if (this->isSpatiallyVarying()) {
        this->setKernelParametersFromSpatialModel(x, y);
    }
    return doComputeImage(image, doNormalize);
}

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.

                                                                     {
    std::vector<double>::iterator paramIter = kernelParams.begin();
    std::vector<SpatialFunctionPtr>::const_iterator funcIter = _spatialFunctionList.begin();
    for (; funcIter != _spatialFunctionList.end(); ++funcIter, ++paramIter) {
        *paramIter = (*(*funcIter))(x, y);
    }
}

doComputeImage()

double lsst::afw::math::AnalyticKernel::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

image	image whose pixels are to be set (output)
doNormalize	normalize the image (so sum is 1)?

Returns

The kernel sum

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

Definition at line 111 of file AnalyticKernel.cc.

                                                                                      {
    double imSum = 0;
    for (int y = 0; y != image.getHeight(); ++y) {
        double const fy = image.indexToPosition(y, image::Y);
        image::Image<Pixel>::x_iterator ptr = image.row_begin(y);
        for (int x = 0; x != image.getWidth(); ++x, ++ptr) {
            double const fx = image.indexToPosition(x, image::X);
            Pixel const pixelVal = (*_kernelFunctionPtr)(fx, fy);
            *ptr = pixelVal;
            imSum += pixelVal;
        }
    }

    if (doNormalize && (imSum != 1)) {
        if (imSum == 0) {
            throw LSST_EXCEPT(pexExcept::OverflowError, "Cannot normalize; kernel sum is 0");
        }
        image /= imSum;
        imSum = 1;
    }

    return imSum;
}

dynamicCast() [1/2]

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< AnalyticKernel >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr )

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;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

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

dynamicCast() [2/2]

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< Kernel >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr )

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;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

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

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.

                                         {
        return lsst::geom::Box2I(lsst::geom::Point2I(-_ctrX, -_ctrY), lsst::geom::Extent2I(_width, _height));
    }

getCacheSize()

virtual int lsst::afw::math::Kernel::getCacheSize ( ) const

inlinevirtualinherited

Get the current size of the kernel cache (0 if none or if caches not supported)

Reimplemented in lsst::afw::math::SeparableKernel.

Definition at line 450 of file Kernel.h.

{ return 0; };

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.

{ return lsst::geom::Point2I(_ctrX, _ctrY); }

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.

                            {
        return _ctrX;
    }

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.

                            {
        return _ctrY;
    }

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.

{ return lsst::geom::Extent2I(_width, _height); }

getHeight()

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

inlineinherited

Return the Kernel's height.

Definition at line 230 of file Kernel.h.

{ return _height; }

getKernelFunction()

AnalyticKernel::KernelFunctionPtr lsst::afw::math::AnalyticKernel::getKernelFunction ( ) const

virtual

Get a deep copy of the kernel function.

Definition at line 91 of file AnalyticKernel.cc.

                                                                        {
    return _kernelFunctionPtr->clone();
}

getKernelParameter()

virtual double lsst::afw::math::Kernel::getKernelParameter ( unsigned int  i ) const

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

{ return getKernelParameters()[i]; }

getKernelParameters()

std::vector< double > lsst::afw::math::AnalyticKernel::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 104 of file AnalyticKernel.cc.

                                                            {
    return _kernelFunctionPtr->getParameters();
}

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.

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

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

getPersistenceName()

std::string lsst::afw::math::AnalyticKernel::getPersistenceName ( ) const

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.

{ return getAnalyticKernelPersistenceName(); }

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.

{ 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

index

index 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::InvalidParameterError	if kernel not spatially varying
lsst::pex::exceptions::InvalidParameterError	if index out of range

Definition at line 153 of file Kernel.cc.

                                                                            {
    if (index >= _spatialFunctionList.size()) {
        if (!this->isSpatiallyVarying()) {
            throw LSST_EXCEPT(pexExcept::InvalidParameterError, "kernel is not spatially varying");
        } else {
            std::ostringstream errStream;
            errStream << "index = " << index << "; must be < , " << _spatialFunctionList.size();
            throw LSST_EXCEPT(pexExcept::InvalidParameterError, errStream.str());
        }
    }
    return _spatialFunctionList[index]->clone();
}

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.

                                                                         {
    std::vector<SpatialFunctionPtr> spFuncCopyList;
    for (std::vector<SpatialFunctionPtr>::const_iterator spFuncIter = _spatialFunctionList.begin();
         spFuncIter != _spatialFunctionList.end(); ++spFuncIter) {
        spFuncCopyList.push_back((**spFuncIter).clone());
    }
    return spFuncCopyList;
}

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.

                                                                     {
        std::vector<std::vector<double>> spatialParams;
        std::vector<SpatialFunctionPtr>::const_iterator spFuncIter = _spatialFunctionList.begin();
        for (; spFuncIter != _spatialFunctionList.end(); ++spFuncIter) {
            spatialParams.push_back((*spFuncIter)->getParameters());
        }
        return spatialParams;
    }

getWidth()

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

inlineinherited

Return the Kernel's width.

Definition at line 225 of file Kernel.h.

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

                                                              {
    return lsst::geom::Box2I(
            lsst::geom::Point2I(bbox.getMin() - lsst::geom::Extent2I(getCtr())),
            lsst::geom::Extent2I(bbox.getDimensions() + getDimensions() - lsst::geom::Extent2I(1, 1)));
}

isPersistable()

bool lsst::afw::math::AnalyticKernel::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 666 of file Kernel.h.

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

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

operator=() [1/2]

AnalyticKernel& lsst::afw::math::AnalyticKernel::operator= ( const AnalyticKernel &  )

delete

operator=() [2/2]

AnalyticKernel& lsst::afw::math::AnalyticKernel::operator= ( AnalyticKernel &&  )

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]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return dynamicCast(Persistable::_readFits(fitsfile));
    }

readFits() [2/6]

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

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return dynamicCast(Persistable::_readFits(fitsfile));
    }

readFits() [3/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]	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.

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

readFits() [4/6]

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

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

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

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

readFits() [5/6]

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

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

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

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

readFits() [6/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]	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.

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

resized()

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

overridevirtual

Return a pointer to a clone with specified kernel dimensions.

Parameters

width	Number of columns in pixels
height	Number 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 72 of file AnalyticKernel.cc.

                                                                         {
    std::shared_ptr<Kernel> retPtr;
    if (isSpatiallyVarying()) {
        retPtr = std::make_shared<AnalyticKernel>(width, height, *_kernelFunctionPtr, _spatialFunctionList);
    } else {
        retPtr = std::make_shared<AnalyticKernel>(width, height, *_kernelFunctionPtr);
    }
    return retPtr;
}

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.

                                            {
        _ctrX = ctr.getX();
        _ctrY = ctr.getY();
        _setKernelXY();
    }

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.

                              {
        _ctrX = ctrX;
        _setKernelXY();
    }

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.

                              {
        _ctrY = ctrY;
        _setKernelXY();
    }

setDimensions()

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

inlineinherited

Definition at line 215 of file Kernel.h.

                                              {
        _width = dims.getX();
        _height = dims.getY();
    }

setHeight()

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

inlineinherited

Definition at line 220 of file Kernel.h.

{ _height = height; }

setKernelParameter()

void lsst::afw::math::AnalyticKernel::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::InvalidParameterError

always (unless subclassed)

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

Definition at line 135 of file AnalyticKernel.cc.

                                                                            {
    _kernelFunctionPtr->setParameter(ind, value);
}

setKernelParameters() [1/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::RuntimeError	if the kernel has a spatial function
lsst::pex::exceptions::InvalidParameterError	if the params vector is the wrong length

Definition at line 388 of file Kernel.h.

                                                                     {
        if (this->isSpatiallyVarying()) {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, "Kernel is spatially varying");
        }
        const unsigned int nParams = this->getNKernelParameters();
        if (nParams != params.size()) {
            throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                              (boost::format("Number of parameters is wrong, saw %d expected %d") % nParams %
                               params.size())
                                      .str());
        }
        for (unsigned int ii = 0; ii < nParams; ++ii) {
            this->setKernelParameter(ii, params[ii]);
        }
    }

setKernelParameters() [2/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.

                                                                           {
        this->setKernelParameter(0, params.first);
        this->setKernelParameter(1, params.second);
    }

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.

                                                                         {
    std::vector<SpatialFunctionPtr>::const_iterator funcIter = _spatialFunctionList.begin();
    for (int ii = 0; funcIter != _spatialFunctionList.end(); ++funcIter, ++ii) {
        this->setKernelParameter(ii, (*(*funcIter))(x, y));
    }
}

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::InvalidParameterError

if params is the wrong shape (if this exception is thrown then no parameters are changed)

Definition at line 119 of file Kernel.cc.

                                                                            {
    // Check params size before changing anything
    unsigned int nKernelParams = this->getNKernelParameters();
    if (params.size() != nKernelParams) {
        throw LSST_EXCEPT(
                pexExcept::InvalidParameterError,
                (boost::format("params has %d entries instead of %d") % params.size() % nKernelParams).str());
    }
    unsigned int nSpatialParams = this->getNSpatialParameters();
    for (unsigned int ii = 0; ii < nKernelParams; ++ii) {
        if (params[ii].size() != nSpatialParams) {
            throw LSST_EXCEPT(pexExcept::InvalidParameterError,
                              (boost::format("params[%d] has %d entries instead of %d") % ii %
                               params[ii].size() % nSpatialParams)
                                      .str());
        }
    }
    // Set parameters
    if (nSpatialParams > 0) {
        for (unsigned int ii = 0; ii < nKernelParams; ++ii) {
            this->_spatialFunctionList[ii]->setParameters(params[ii]);
        }
    }
}

setWidth()

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

inlineinherited

Definition at line 219 of file Kernel.h.

{ _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::InvalidParameterError

if the resulting box would have dimension < 1 in either axis

Definition at line 183 of file Kernel.cc.

                                                                {
    if ((bbox.getWidth() < getWidth()) || ((bbox.getHeight() < getHeight()))) {
        std::ostringstream os;
        os << "bbox dimensions = " << bbox.getDimensions() << " < (" << getWidth() << ", " << getHeight()
           << ") in one or both dimensions";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    }
    return lsst::geom::Box2I(
            lsst::geom::Point2I(bbox.getMinX() + getCtrX(), bbox.getMinY() + getCtrY()),
            lsst::geom::Extent2I(bbox.getWidth() + 1 - getWidth(), bbox.getHeight() + 1 - getHeight()));
}

toString()

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

overridevirtual

Return a string representation of the kernel.

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

Definition at line 95 of file AnalyticKernel.cc.

                                                                {
    std::ostringstream os;
    os << prefix << "AnalyticKernel:" << std::endl;
    os << prefix << "..function: " << (_kernelFunctionPtr ? _kernelFunctionPtr->toString() : "None")
       << std::endl;
    os << Kernel::toString(prefix + "\t");
    return os.str();
}

write()

void lsst::afw::math::AnalyticKernel::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 193 of file AnalyticKernel.cc.

                                                            {
    AnalyticKernelPersistenceHelper const keys(_spatialFunctionList.size());
    std::shared_ptr<afw::table::BaseRecord> record = keys.write(handle, *this);
    record->set(keys.kernelFunction, handle.put(_kernelFunctionPtr.get()));
}

writeFits() [1/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]	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.

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

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

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

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

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

Member Data Documentation

_kernelFunctionPtr

KernelFunctionPtr lsst::afw::math::AnalyticKernel::_kernelFunctionPtr

protected

Definition at line 680 of file Kernel.h.

_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:

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/math/Kernel.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/math/AnalyticKernel.cc