Bilinear warping: fast; good for undersampled data. More...

#include <warpExposure.h>

Inheritance diagram for lsst.afw.math::BilinearWarpingKernel:

Classes
class	BilinearFunction1
	1-dimensional bilinear interpolation function. More...

Public Member Functions
	BilinearWarpingKernel ()

virtual	~BilinearWarpingKernel ()

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

Public Member Functions inherited from lsst.afw.math::SeparableKernel
	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...

virtual	~SeparableKernel ()

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

virtual double	getKernelParameter (unsigned int i) const

virtual std::vector< double >	getKernelParameters () const
	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...

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

virtual void	computeCache (int const cacheSize)
	Compute a cache of Kernel values, if desired. More...

virtual int	getCacheSize () const
	Get the current cache size (0 if none) 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...

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

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 bool	isPersistable () const
	Return true if this particular object can be persisted using afw::table::io. More...

virtual	~Persistable ()

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

Protected Member Functions inherited from lsst.afw.math::SeparableKernel
virtual double	doComputeImage (lsst::afw::image::Image< Pixel > &image, bool doNormalize) const
	Low-level version of computeImage. 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...

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

	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

Additional Inherited Members
Public Types inherited from lsst.afw.math::SeparableKernel
typedef boost::shared_ptr < SeparableKernel >	Ptr

typedef boost::shared_ptr < SeparableKernel const >	ConstPtr

typedef lsst::afw::math::Function1 < Pixel >	KernelFunction

typedef boost::shared_ptr < KernelFunction >	KernelFunctionPtr

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

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

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

static boost::shared_ptr < SeparableKernel >	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

Bilinear warping: fast; good for undersampled data.

The kernel size is 2 x 2.

For more information about warping kernels see makeWarpingKernel

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

Definition at line 101 of file warpExposure.h.

Constructor & Destructor Documentation

lsst.afw.math::BilinearWarpingKernel::BilinearWarpingKernel ( )

inlineexplicit

Definition at line 103 of file warpExposure.h.

         :
             SeparableKernel(2, 2, BilinearFunction1(0.0), BilinearFunction1(0.0))
         {}

virtual lsst.afw.math::BilinearWarpingKernel::~BilinearWarpingKernel ( )

inlinevirtual

Definition at line 108 of file warpExposure.h.

108 {}

Member Function Documentation

boost::shared_ptr< afwMath::Kernel > lsst.afw.math::BilinearWarpingKernel::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

Reimplemented from lsst.afw.math::SeparableKernel.

Definition at line 121 of file warpExposure.cc.

                                                              {
     return PTR(afwMath::Kernel)(new afwMath::BilinearWarpingKernel());
 }

void lsst.afw.math::BilinearWarpingKernel::setKernelParameter	(	unsigned int	ind,
		double	value
	)		const

protectedvirtual

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

Definition at line 149 of file warpExposure.cc.

 {
     checkWarpingKernelParameter(this, ind, value);
     SeparableKernel::setKernelParameter(ind, value);
 }

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

/home/lsstsw/stack/Linux64/afw/11.0.rc2+4/include/lsst/afw/math/warpExposure.h
/home/lsstsw/stack/Linux64/afw/11.0.rc2+4/src/math/warpExposure.cc

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation