A Function taking two arguments. More...

#include <Function.h>

Inheritance diagram for lsst::afw::math::Function2< ReturnT >:

Public Types
typedef boost::shared_ptr < Function2< ReturnT > >	Ptr

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 Member Functions
	Function2 (unsigned int nParams)
	Construct a Function2 given the number of function parameters. More...

	Function2 (std::vector< double > const &params)
	Construct a Function2 given the function parameters. More...

virtual	~Function2 ()

virtual Ptr	clone () const =0
	Return a pointer to a deep copy of this function. More...

virtual ReturnT	operator() (double x, double y) const =0

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

virtual std::vector< double >	getDFuncDParameters (double, double) const

Public Member Functions inherited from lsst::afw::math::Function< ReturnT >
	Function (unsigned int nParams)
	Construct a Function given the number of function parameters. More...

	Function (std::vector< double > const &params)
	Construct a Function given the function parameters. More...

virtual	~Function ()

unsigned int	getNParameters () const
	Return the number of function parameters. More...

virtual double	getParameter (unsigned int ind) const
	Get one function parameter without range checking. More...

std::vector< double > const &	getParameters () const
	Return all function parameters. More...

virtual bool	isLinearCombination () const
	Is the function a linear combination of its parameters? More...

void	setParameter (unsigned int ind, double newValue)
	Set one function parameter without range checking. More...

void	setParameters (std::vector< double > const &params)
	Set all function parameters. 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::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
	Function2 ()

Protected Member Functions inherited from lsst::afw::math::Function< ReturnT >
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

	Function ()

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)

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

Friends
class	boost::serialization::access

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

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

static boost::shared_ptr < Function2< ReturnT > >	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< Function< ReturnT > >
static boost::shared_ptr < Function< ReturnT > >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

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

static boost::shared_ptr < Function< ReturnT > >	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::Function< ReturnT >
std::vector< double >	_params

bool	_isCacheValid

Detailed Description

template<typename ReturnT>
class lsst::afw::math::Function2< ReturnT >

A Function taking two arguments.

Subclass and override operator() to do useful work.

Definition at line 300 of file Function.h.

Member Typedef Documentation

template<typename ReturnT>

typedef boost::shared_ptr<Function2<ReturnT> > lsst::afw::math::Function2< ReturnT >::Ptr

Definition at line 304 of file Function.h.

Constructor & Destructor Documentation

template<typename ReturnT>

lsst::afw::math::Function2< ReturnT >::Function2 ( unsigned int nParams )

inlineexplicit

Construct a Function2 given the number of function parameters.

The function parameters are initialized to 0.

Parameters

nParams number of function parameters

Definition at line 311 of file Function.h.

         :
             Function<ReturnT>(nParams)
         {}

template<typename ReturnT>

lsst::afw::math::Function2< ReturnT >::Function2 ( std::vector< double > const & params )

inlineexplicit

Construct a Function2 given the function parameters.

The number of function parameters is set to the length of params.

Parameters

params function parameters

Definition at line 322 of file Function.h.

         :
             Function<ReturnT>(params)
         {}

template<typename ReturnT>

virtual lsst::afw::math::Function2< ReturnT >::~Function2 ( )

inlinevirtual

Definition at line 328 of file Function.h.

328 {}

template<typename ReturnT>

lsst::afw::math::Function2< ReturnT >::Function2 ( )

inlineexplicitprotected

Definition at line 358 of file Function.h.

358 : Function<ReturnT>() {}

Member Function Documentation

template<typename ReturnT>

virtual Ptr lsst::afw::math::Function2< ReturnT >::clone ( ) const

pure virtual

Return a pointer to a deep copy of this function.

This function exists instead of a copy constructor so one can obtain a copy of an actual function instead of a useless copy of the base class.

Every non-virtual function must override this method.

Returns: a pointer to a deep copy of the function

Implemented in lsst::afw::math::LanczosFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::NullFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::IntegerDeltaFunction2< ReturnT >, lsst::meas::algorithms::ShapeletSpatialFunction, and lsst::meas::algorithms::ShapeletKernelFunction.

template<typename ReturnT>

virtual std::vector<double> lsst::afw::math::Function2< ReturnT >::getDFuncDParameters	(	double	,
		double
	)		const

inlinevirtual

Return the derivative of the Function with respect to its parameters

Reimplemented in lsst::afw::math::PolynomialFunction2< ReturnT >, and lsst::afw::math::BasePolynomialFunction2< ReturnT >.

Definition at line 351 of file Function.h.

                                                                             {
             throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError,
                               "getDFuncDParameters is not implemented for this class");
         }

template<typename ReturnT>

virtual ReturnT lsst::afw::math::Function2< ReturnT >::operator()	(	double	x,
		double	y
	)		const

pure virtual

Implemented in lsst::afw::math::LanczosFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::NullFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::IntegerDeltaFunction2< ReturnT >, lsst::meas::algorithms::ShapeletSpatialFunction, and lsst::meas::algorithms::ShapeletKernelFunction.

template<typename ReturnT>

template<class Archive >

void lsst::afw::math::Function2< ReturnT >::serialize	(	Archive &	ar,
		unsigned const int	version
	)

inlineprivate

Definition at line 364 of file Function.h.

                                                                 {
             ar & make_nvp("fn", boost::serialization::base_object<Function<ReturnT> >(*this));
         }

template<typename ReturnT>

virtual std::string lsst::afw::math::Function2< ReturnT >::toString ( std::string const & = "" ) const

inlinevirtual

Return a string representation of the function.

Returns: a string representation of the function

Reimplemented from lsst::afw::math::Function< ReturnT >.

Reimplemented in lsst::afw::math::LanczosFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, and lsst::afw::math::IntegerDeltaFunction2< ReturnT >.

Definition at line 345 of file Function.h.

                                                                      {
             return std::string("Function2: ") + Function<ReturnT>::toString(prefix);
         }

Friends And Related Function Documentation

template<typename ReturnT>

friend class boost::serialization::access

friend

Definition at line 361 of file Function.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/Function.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

template<typename ReturnT> class lsst::afw::math::Function2< ReturnT >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename ReturnT>
class lsst::afw::math::Function2< ReturnT >