A kernel created from an Image. More...

#include <Kernel.h>

Inheritance diagram for lsst::afw::math::FixedKernel:

Classes
class	Factory

Public Types
typedef boost::shared_ptr < FixedKernel >	Ptr

typedef boost::shared_ptr < FixedKernel const >	ConstPtr

Public Types inherited from lsst::afw::math::Kernel
typedef double	Pixel

typedef boost::shared_ptr< Kernel >	Ptr

typedef boost::shared_ptr < Kernel const >	ConstPtr

typedef boost::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 Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback )(const Citizen *ptr)

Public Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr

Public Member Functions
	FixedKernel ()
	Construct an empty FixedKernel of size 0x0. More...

	FixedKernel (lsst::afw::image::Image< Pixel > const &image)
	Construct a FixedKernel from an image. More...

	FixedKernel (lsst::afw::math::Kernel const &kernel, lsst::afw::geom::Point2D const &pos)
	Construct a FixedKernel from a generic Kernel. More...

virtual	~FixedKernel ()

virtual boost::shared_ptr< Kernel >	clone () const
	Return a pointer to a deep copy of this kernel. More...

virtual std::string	toString (std::string const &prefix="") const
	Return a string representation of the kernel. More...

virtual Pixel	getSum () const

virtual bool	isPersistable () const
	Return true if this particular object can be persisted using afw::table::io. More...

Public Member Functions inherited from lsst::afw::math::Kernel
	Kernel ()
	Construct a null Kernel of size 0,0. More...

	Kernel (int width, int height, unsigned int nKernelParams, SpatialFunction const &spatialFunction=NullSpatialFunction())
	Construct a spatially invariant Kernel or a spatially varying Kernel with one spatial function that is duplicated as needed. More...

	Kernel (int width, int height, const std::vector< SpatialFunctionPtr > spatialFunctionList)
	Construct a spatially varying Kernel with a list of spatial functions (one per kernel parameter) More...

virtual	~Kernel ()

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

geom::Extent2I const	getDimensions () const
	Return the Kernel's dimensions (width, height) More...

void	setDimensions (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::afw::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::afw::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

virtual std::vector< double >	getKernelParameters () const
	Return the current kernel parameters. More...

lsst::afw::geom::Box2I	growBBox (lsst::afw::geom::Box2I const &bbox) const

lsst::afw::geom::Box2I	shrinkBBox (lsst::afw::geom::Box2I const &bbox) const

void	setCtr (lsst::afw::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...

Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)

	Citizen (Citizen const &)

	~Citizen ()

Citizen &	operator= (Citizen const &)

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)

virtual	~Persistable (void)

template<class Archive >
void	serialize (Archive &, unsigned int const)

Public Member Functions inherited from lsst::afw::table::io::Persistable
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	~Persistable ()

Protected Member Functions
double	doComputeImage (lsst::afw::image::Image< Pixel > &image, bool doNormalize) const
	Low-level version of computeImage. 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 Member Functions inherited from lsst::afw::math::Kernel
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

virtual void	setKernelParameter (unsigned int ind, double value) const
	Set one kernel parameter. More...

void	setKernelParametersFromSpatialModel (double x, double y) const
	Set the kernel parameters from the spatial model (if any). More...

Protected Member Functions inherited from lsst::afw::table::io::Persistable
	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, unsigned int const version)

Private Attributes
lsst::afw::image::Image< Pixel >	_image

Pixel	_sum

Friends
class	boost::serialization::access

Additional Inherited Members
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< FixedKernel >
static boost::shared_ptr < FixedKernel >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr < FixedKernel >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr < FixedKernel >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< Kernel >
static boost::shared_ptr< Kernel >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr< Kernel >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr< Kernel >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Protected Types inherited from lsst::afw::table::io::Persistable
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Attributes inherited from lsst::afw::math::Kernel
std::vector< SpatialFunctionPtr >	_spatialFunctionList

Detailed Description

A kernel created from an Image.

It has no adjustable parameters and so cannot be spatially varying.

Definition at line 551 of file Kernel.h.

Member Typedef Documentation

typedef boost::shared_ptr< FixedKernel const> lsst::afw::math::FixedKernel::ConstPtr

Definition at line 554 of file Kernel.h.

typedef boost::shared_ptr< FixedKernel > lsst::afw::math::FixedKernel::Ptr

Definition at line 553 of file Kernel.h.

Constructor & Destructor Documentation

lsst::afw::math::FixedKernel::FixedKernel ( )

explicit

Construct an empty FixedKernel of size 0x0.

Definition at line 36 of file FixedKernel.cc.

 :
     Kernel(),
     _image(),
     _sum(0) {
 }

lsst::afw::math::FixedKernel::FixedKernel ( lsst::afw::image::Image< Pixel > const & image )

explicit

Construct a FixedKernel from an image.

Parameters

image image for kernel

Definition at line 43 of file FixedKernel.cc.

   :
     Kernel(image.getWidth(), image.getHeight(), 0),
     _image(image, true),
     _sum(0) {
 
     typedef afwImage::Image<Pixel>::x_iterator XIter;
     double imSum = 0.0;
     for (int y = 0; y != image.getHeight(); ++y) {
         for (XIter imPtr = image.row_begin(y), imEnd = image.row_end(y); imPtr != imEnd; ++imPtr) {
             imSum += *imPtr;
         }
     }
     this->_sum = imSum;
 }

lsst::afw::math::FixedKernel::FixedKernel	(	lsst::afw::math::Kernel const &	kernel,
		lsst::afw::geom::Point2D const &	pos
	)

explicit

Construct a FixedKernel from a generic Kernel.

Parameters

kernel	Kernel to convert to Fixed
pos	desired position

Definition at line 60 of file FixedKernel.cc.

   :
     Kernel(kernel.getWidth(), kernel.getHeight(), 0),
     _image(kernel.getDimensions()),
     _sum(0) {
     _sum = kernel.computeImage(_image, false, pos[0], pos[1]);
 }

virtual lsst::afw::math::FixedKernel::~FixedKernel ( )

inlinevirtual

Definition at line 576 of file Kernel.h.

576 {}

Member Function Documentation

boost::shared_ptr< afwMath::Kernel > lsst::afw::math::FixedKernel::clone ( ) const

virtual

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 70 of file FixedKernel.cc.

                                                    {
     PTR(afwMath::Kernel) retPtr(new afwMath::FixedKernel(_image));
     retPtr->setCtr(this->getCtr());
     return retPtr;
 }

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

protectedvirtual

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.

Returns: The kernel sum

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

Definition at line 76 of file FixedKernel.cc.

         {
     double multFactor = 1.0;
     double imSum = this->_sum;
     if (doNormalize) {
         if (imSum == 0) {
             throw LSST_EXCEPT(pexExcept::OverflowError, "Cannot normalize; kernel sum is 0");
         }
         multFactor = 1.0/static_cast<double>(this->_sum);
         imSum = 1.0;
     }
 
     typedef afwImage::Image<Pixel>::x_iterator XIter;
 
     for (int y = 0; y != this->getHeight(); ++y) {
         for (XIter imPtr = image.row_begin(y), imEnd = image.row_end(y), kPtr = this->_image.row_begin(y);
             imPtr != imEnd; ++imPtr, ++kPtr) {
             imPtr[0] = multFactor*kPtr[0];
         }
     }
 
     return imSum;
 }

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

protectedvirtual

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 165 of file FixedKernel.cc.

165 { return getFixedKernelPersistenceName(); }

virtual Pixel lsst::afw::math::FixedKernel::getSum ( ) const

inlinevirtual

Definition at line 582 of file Kernel.h.

                                      {
             return _sum;
         }

virtual bool lsst::afw::math::FixedKernel::isPersistable ( ) const

inlinevirtual

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

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

Definition at line 586 of file Kernel.h.

586 { return true; }

template<class Archive >

void lsst::afw::math::FixedKernel::serialize	(	Archive &	ar,
		unsigned int const	version
	)

inlineprivate

Definition at line 606 of file Kernel.h.

                                                                     {
                 ar & make_nvp("k",
                         boost::serialization::base_object<Kernel>(*this));
                 ar & make_nvp("img", _image);
                 ar & make_nvp("sum", _sum);
             }

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

virtual

Return a string representation of the kernel.

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

Definition at line 102 of file FixedKernel.cc.

                                                                     {
     std::ostringstream os;
     os << prefix << "FixedKernel:" << std::endl;
     os << prefix << "..sum: " << _sum << std::endl;
     os << Kernel::toString(prefix + "\t");
     return os.str();
 }

void lsst::afw::math::FixedKernel::write ( OutputArchiveHandle & handle ) const

protectedvirtual

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 167 of file FixedKernel.cc.

                                                           {
     FixedKernelPersistenceHelper const keys(getDimensions());
     PTR(afw::table::BaseRecord) record = keys.write(handle, *this);
     (*record)[keys.image] = ndarray::flatten<1>(ndarray::copy(_image.getArray()));
 }

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 604 of file Kernel.h.

Member Data Documentation

lsst::afw::image::Image<Pixel> lsst::afw::math::FixedKernel::_image

private

Definition at line 601 of file Kernel.h.

Pixel lsst::afw::math::FixedKernel::_sum

private

Definition at line 602 of file Kernel.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/Kernel.h
/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/math/FixedKernel.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation