2-dimensional polynomial function with cross terms More...

#include <FunctionLibrary.h>

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

Public Types
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
	PolynomialFunction2 (unsigned int order)
	Construct a polynomial function of specified order. More...

	PolynomialFunction2 (std::vector< double > params)
	Construct a polynomial function with specified parameters. More...

	PolynomialFunction2 (PolynomialFunction2 const &)=default

	PolynomialFunction2 (PolynomialFunction2 &&)=default

PolynomialFunction2 &	operator= (PolynomialFunction2 const &)=default

PolynomialFunction2 &	operator= (PolynomialFunction2 &&)=default

	~PolynomialFunction2 () noexcept override=default

std::shared_ptr< Function2< ReturnT > >	clone () const override
	Return a pointer to a deep copy of this function. More...

ReturnT	operator() (double x, double y) const noexcept(IS_NOTHROW_INIT< ReturnT >) override

std::vector< double >	getDFuncDParameters (double x, double y) const override
	Return the coefficients of the Function's parameters, evaluated at (x, y) I.e. More...

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

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

int	getOrder () const noexcept
	Get the polynomial order. More...

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

unsigned int	getNParameters () const noexcept
	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 noexcept
	Return all function 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...

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

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 int	nParametersFromOrder (int order)
	Compute number of parameters from polynomial order. More...

static int	orderFromNParameters (int nParameters)
	Compute polynomial order from the number of parameters. More...

static std::shared_ptr< Function2< ReturnT > >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

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

static std::shared_ptr< Function2< ReturnT > >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...

static std::shared_ptr< Function< ReturnT > >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

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

static std::shared_ptr< Function< ReturnT > >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...

static std::shared_ptr< Function2< ReturnT > >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

static std::shared_ptr< Function< ReturnT > >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

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

Census
Provide a list of current Citizens
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...

callbackIDs
Set callback Ids. The old Id is returned
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...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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...

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory. More...

void	write (afw::table::io::OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs. More...

	PolynomialFunction2 ()

std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

Protected Attributes
int	_order
	order of polynomial More...

std::vector< double >	_params

bool	_isCacheValid

Detailed Description

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

2-dimensional polynomial function with cross terms

f(x,y) = c0 (0th order)

c1 x + c2 y (1st order)
c3 x^2 + c4 x y + c5 y^2 (2nd order)
c6 x^3 + c7 x^2 y + c8 x y^2 + c9 y^3 (3rd order)
...

Intermediate products for the most recent y are cached, so when computing for a set of x, y it is more efficient to change x before you change y.

Definition at line 449 of file FunctionLibrary.h.

Member Typedef Documentation

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ OutputArchiveHandle

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

protectedinherited

Definition at line 108 of file Persistable.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

Constructor & Destructor Documentation

◆ PolynomialFunction2() [1/5]

template<typename ReturnT>

lsst::afw::math::PolynomialFunction2< ReturnT >::PolynomialFunction2 ( unsigned int order )

inlineexplicit

Construct a polynomial function of specified order.

The polynomial will have (order + 1) * (order + 2) / 2 coefficients

The parameters are initialized to zero.

Parameters

order order of polynomial (0 for constant)

Definition at line 458 of file FunctionLibrary.h.

459 : BasePolynomialFunction2<ReturnT>(order), _oldY(0), _xCoeffs(this->_order + 1) {}

lsst::afw::math::BasePolynomialFunction2::_order

int _order

order of polynomial

Definition: Function.h:433

◆ PolynomialFunction2() [2/5]

template<typename ReturnT>

lsst::afw::math::PolynomialFunction2< ReturnT >::PolynomialFunction2 ( std::vector< double > params )

inlineexplicit

Construct a polynomial function with specified parameters.

The order of the polynomial is determined from the length of the params vector: order = (sqrt(1 + 8 * length) - 3) / 2 and if this is not an integer then the length is unsuitable

Exceptions

lsst::pex::exceptions::InvalidParameterError	if params length is unsuitable
lsst::pex::exceptions::Exception	if an internal sanity check fails

Parameters

params polynomial coefficients (const, x, y, x^2, xy, y^2...); length must be one of 1, 3, 6, 10, 15...

Definition at line 471 of file FunctionLibrary.h.

474 : BasePolynomialFunction2<ReturnT>(params), _oldY(0), _xCoeffs(this->_order + 1) {}

lsst::afw::math::BasePolynomialFunction2::_order

int _order

order of polynomial

Definition: Function.h:433

◆ PolynomialFunction2() [3/5]

template<typename ReturnT>

lsst::afw::math::PolynomialFunction2< ReturnT >::PolynomialFunction2 ( PolynomialFunction2< ReturnT > const & )

default

◆ PolynomialFunction2() [4/5]

template<typename ReturnT>

lsst::afw::math::PolynomialFunction2< ReturnT >::PolynomialFunction2 ( PolynomialFunction2< ReturnT > && )

default

◆ ~PolynomialFunction2()

template<typename ReturnT>

lsst::afw::math::PolynomialFunction2< ReturnT >::~PolynomialFunction2 ( )

overridedefaultnoexcept

◆ PolynomialFunction2() [5/5]

template<typename ReturnT>

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

inlineexplicitprotected

Definition at line 562 of file FunctionLibrary.h.

562 : BasePolynomialFunction2<ReturnT>(), _oldY(0), _xCoeffs(0) {}

Member Function Documentation

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ clone()

template<typename ReturnT>

std::shared_ptr<Function2<ReturnT> > lsst::afw::math::PolynomialFunction2< ReturnT >::clone ( ) const

inlineoverridevirtual

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

Implements lsst::afw::math::Function2< ReturnT >.

Definition at line 482 of file FunctionLibrary.h.

                                                              {
         return std::shared_ptr<Function2<ReturnT>>(new PolynomialFunction2(this->_params));
     }

◆ dynamicCast() [1/2]

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< Function2< ReturnT > >::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< Function< ReturnT > >::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;
 }

◆ getDFuncDParameters()

template<typename ReturnT >

std::vector< double > lsst::afw::math::PolynomialFunction2< ReturnT >::getDFuncDParameters	(	double	x,
		double	y
	)		const

overridevirtual

Return the coefficients of the Function's parameters, evaluated at (x, y) I.e.

given c0, c1, c2, c3 ... return 1, x, y, x^2 ...

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

Definition at line 34 of file Function.cc.

                                                                                             {
     std::vector<double> coeffs(this->getNParameters());
 
     //
     // Go through params order by order, evaluating x^r y^s;  we do this by first evaluating
     // y^s for a complete order, then going through again multiplying by x^r
     //
     int i0 = 0;  // starting index for this order's coefficients
     for (int order = 0; order <= this->_order; ++order) {
         coeffs[i0] = 1;
         double zn = y;  // y^s
         for (int i = 1; i <= order; ++i) {
             coeffs[i0 + i] = zn;
             zn *= y;
         }
 
         zn = x;  // x^r
         for (int i = order - 1; i >= 0; --i) {
             coeffs[i0 + i] *= zn;
             zn *= x;
         }
 
         i0 += order + 1;
     }
 
     assert(i0 == static_cast<int>(coeffs.size()));
 
     return coeffs;
 }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ getNParameters()

template<typename ReturnT>

unsigned int lsst::afw::math::Function< ReturnT >::getNParameters ( ) const

inlinenoexceptinherited

Return the number of function parameters.

Returns: the number of function parameters

Definition at line 114 of file Function.h.

114 { return _params.size(); }

lsst::afw::math::Function::_params

std::vector< double > _params

Definition: Function.h:187

std::vector::size

T size(T... args)

◆ getOrder()

template<typename ReturnT >

int lsst::afw::math::BasePolynomialFunction2< ReturnT >::getOrder ( ) const

inlinenoexceptinherited

Get the polynomial order.

Definition at line 362 of file Function.h.

362 { return _order; }

lsst::afw::math::BasePolynomialFunction2::_order

int _order

order of polynomial

Definition: Function.h:433

◆ getParameter()

template<typename ReturnT>

virtual double lsst::afw::math::Function< ReturnT >::getParameter ( unsigned int ind ) const

inlinevirtualinherited

Get one function parameter without range checking.

Returns: the specified function parameter

Parameters

ind	index of parameter

Definition at line 121 of file Function.h.

                   {
         return _params[ind];
     }

◆ getParameters()

template<typename ReturnT>

std::vector<double> const& lsst::afw::math::Function< ReturnT >::getParameters ( ) const

inlinenoexceptinherited

Return all function parameters.

Returns: the function parameters as a vector

Definition at line 131 of file Function.h.

131 { return _params; }

lsst::afw::math::Function::_params

std::vector< double > _params

Definition: Function.h:187

◆ getPersistenceName()

template<typename ReturnT >

std::string lsst::afw::math::PolynomialFunction2< ReturnT >::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 212 of file FunctionLibrary.cc.

                                                                  {
     return "PolynomialFunction2" + Suffix<ReturnT>::get();
 }

◆ getPythonModule()

template<typename ReturnT>

std::string lsst::afw::math::Function< ReturnT >::getPythonModule ( ) const

inlineoverrideprotectedvirtualinherited

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 190 of file Function.h.

190 { return "lsst.afw.math"; }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ isLinearCombination()

template<typename ReturnT >

bool lsst::afw::math::BasePolynomialFunction2< ReturnT >::isLinearCombination ( ) const

inlineoverridevirtualnoexceptinherited

Is the function a linear combination of its parameters?

Returns: true if the function can be expressed as: sum over i of parameter_i * function_i(args)

Warning: : subclasses must override if true.

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

Definition at line 364 of file Function.h.

364 { return true; }

◆ isPersistable()

template<typename ReturnT>

bool lsst::afw::math::PolynomialFunction2< ReturnT >::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 549 of file FunctionLibrary.h.

549 { return true; }

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ nParametersFromOrder()

template<typename ReturnT >

static int lsst::afw::math::BasePolynomialFunction2< ReturnT >::nParametersFromOrder ( int order )

inlinestaticinherited

Compute number of parameters from polynomial order.

Exceptions

lsst::pex::exceptions::InvalidParameterError if order < 0

Definition at line 371 of file Function.h.

                                                {
         if (order < 0) {
             std::ostringstream os;
             os << "order=" << order << " invalid: must be >= 0";
             throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError, os.str());
         }
         return (order + 1) * (order + 2) / 2;
     }

◆ operator()()

template<typename ReturnT>

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

inlineoverridevirtualnoexcept

Implements lsst::afw::math::Function2< ReturnT >.

Definition at line 486 of file FunctionLibrary.h.

                                                                                              {
         /* Solve as follows:
         - f(x,y) = Cx0 + Cx1 x + Cx2 x^2 + Cx3 x^3 + ...
         where:
           Cx0 = P0 + P2 y + P5 y^2 + P9 y^3 + ...
           Cx1 = P1 + P4 y + P8 y2 + ...
           Cx2 = P3 + P7 y + ...
           Cx3 = P6 + ...
           ...
 
         Compute Cx0, Cx1...Cxn by solving 1-d polynomials in y in the usual way.
         These values are cached and only recomputed for new values of Y or if the parameters change.
 
         Then compute f(x,y) by solving the 1-d polynomial in x in the usual way.
         */
         const int maxXCoeffInd = this->_order;
 
         if ((y != _oldY) || !this->_isCacheValid) {
             // update _xCoeffs cache
             // note: paramInd is decremented in both of the following loops
             int paramInd = static_cast<int>(this->_params.size()) - 1;
 
             // initialize _xCoeffs to coeffs for pure y^n; e.g. for 3rd order:
             // _xCoeffs[0] = _params[9], _xCoeffs[1] = _params[8], ... _xCoeffs[3] = _params[6]
             for (int xCoeffInd = 0; xCoeffInd <= maxXCoeffInd; ++xCoeffInd, --paramInd) {
                 _xCoeffs[xCoeffInd] = this->_params[paramInd];
             }
 
             // finish computing _xCoeffs
             for (int xCoeffInd = 0, endXCoeffInd = maxXCoeffInd; paramInd >= 0; --paramInd) {
                 _xCoeffs[xCoeffInd] = (_xCoeffs[xCoeffInd] * y) + this->_params[paramInd];
                 ++xCoeffInd;
                 if (xCoeffInd >= endXCoeffInd) {
                     xCoeffInd = 0;
                     --endXCoeffInd;
                 }
             }
 
             _oldY = y;
             this->_isCacheValid = true;
         }
 
         // use _xCoeffs to compute result
         double retVal = _xCoeffs[maxXCoeffInd];
         for (int xCoeffInd = maxXCoeffInd - 1; xCoeffInd >= 0; --xCoeffInd) {
             retVal = (retVal * x) + _xCoeffs[xCoeffInd];
         }
         return static_cast<ReturnT>(retVal);
     }

◆ operator=() [1/2]

template<typename ReturnT>

PolynomialFunction2& lsst::afw::math::PolynomialFunction2< ReturnT >::operator= ( PolynomialFunction2< ReturnT > const & )

default

◆ operator=() [2/2]

template<typename ReturnT>

PolynomialFunction2& lsst::afw::math::PolynomialFunction2< ReturnT >::operator= ( PolynomialFunction2< ReturnT > && )

default

◆ orderFromNParameters()

template<typename ReturnT >

static int lsst::afw::math::BasePolynomialFunction2< ReturnT >::orderFromNParameters ( int nParameters )

inlinestaticinherited

Compute polynomial order from the number of parameters.

Only certain values of nParameters are acceptable, including: nParameters order 1 0 3 1 6 2 10 3 15 4 ...

Exceptions

lsst::pex::exceptions::InvalidParameterError if nParameters is invalid

Definition at line 394 of file Function.h.

                                                      {
         int order = static_cast<int>(
                 0.5 + ((-3.0 + (std::sqrt(1.0 + (8.0 * static_cast<double>(nParameters))))) / 2.0));
         if (nParameters != BasePolynomialFunction2::nParametersFromOrder(order)) {
             std::ostringstream os;
             os << "nParameters=" << nParameters << " invalid: order is not an integer";
             throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError, os.str());
         }
         return order;
     }

◆ readFits() [1/6]

static std::shared_ptr<Function< ReturnT > > lsst::afw::table::io::PersistableFacade< Function< ReturnT > >::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<Function2< ReturnT > > lsst::afw::table::io::PersistableFacade< Function2< ReturnT > >::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<Function< ReturnT > > lsst::afw::table::io::PersistableFacade< Function< ReturnT > >::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<Function2< ReturnT > > lsst::afw::table::io::PersistableFacade< Function2< ReturnT > >::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<Function2< ReturnT > > lsst::afw::table::io::PersistableFacade< Function2< ReturnT > >::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<Function< ReturnT > > lsst::afw::table::io::PersistableFacade< Function< ReturnT > >::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));
     }

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ setParameter()

template<typename ReturnT>

void lsst::afw::math::Function< ReturnT >::setParameter	(	unsigned int	ind,
		double	newValue
	)

inlineinherited

Set one function parameter without range checking.

Parameters

ind	index of parameter
newValue	new value for parameter

Definition at line 145 of file Function.h.

     {
         _isCacheValid = false;
         _params[ind] = newValue;
     }

◆ setParameters()

template<typename ReturnT>

void lsst::afw::math::Function< ReturnT >::setParameters ( std::vector< double > const & params )

inlineinherited

Set all function parameters.

Exceptions

lsst::pex::exceptions::InvalidParameterError if the wrong number of parameters is supplied.

Parameters

params vector of function parameters

Definition at line 158 of file Function.h.

     {
         if (_params.size() != params.size()) {
             throw LSST_EXCEPT(
                     pexExcept::InvalidParameterError,
                     (boost::format("params has %d entries instead of %d") % params.size() % _params.size())
                             .str());
         }
         _isCacheValid = false;
         _params = params;
     }

◆ toString()

template<typename ReturnT>

std::string lsst::afw::math::PolynomialFunction2< ReturnT >::toString ( std::string const & ) const

inlineoverridevirtual

Return a string representation of the function.

Returns: a string representation of the function

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

Definition at line 542 of file FunctionLibrary.h.

                                                                {
         std::ostringstream os;
         os << "PolynomialFunction2 [" << this->_order << "]: ";
         os << Function2<ReturnT>::toString(prefix);
         return os.str();
     }

◆ write()

template<typename ReturnT >

void lsst::afw::math::PolynomialFunction2< ReturnT >::write ( afw::table::io::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 244 of file FunctionLibrary.cc.

                                                                                  {
     PolynomialFunction2PersistenceHelper const keys(this->getNParameters());
     table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
     keys.coefficients.assignVector(*catalog.addNew(), this->getParameters());
     handle.saveCatalog(catalog);
 }

◆ 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

◆ _isCacheValid

template<typename ReturnT>

bool lsst::afw::math::Function< ReturnT >::_isCacheValid

mutableprotectedinherited

Definition at line 188 of file Function.h.

◆ _order

template<typename ReturnT >

int lsst::afw::math::BasePolynomialFunction2< ReturnT >::_order

protectedinherited

order of polynomial

Definition at line 433 of file Function.h.

◆ _params

template<typename ReturnT>

std::vector<double> lsst::afw::math::Function< ReturnT >::_params

protectedinherited

Definition at line 187 of file Function.h.

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

/j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/include/lsst/afw/math/FunctionLibrary.h
/j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/src/math/Function.cc
/j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/src/math/FunctionLibrary.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ memCallback

◆ memId

◆ memNewCallback

◆ OutputArchiveHandle

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PolynomialFunction2() [1/5]

◆ PolynomialFunction2() [2/5]

◆ PolynomialFunction2() [3/5]

◆ PolynomialFunction2() [4/5]

◆ ~PolynomialFunction2()

◆ PolynomialFunction2() [5/5]

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ clone()

◆ dynamicCast() [1/2]

◆ dynamicCast() [2/2]

◆ getDFuncDParameters()

◆ getId()

◆ getNextMemId()

◆ getNParameters()

◆ getOrder()

◆ getParameter()

◆ getParameters()

◆ getPersistenceName()

◆ getPythonModule()

◆ hasBeenCorrupted()

◆ init()

◆ isLinearCombination()

◆ isPersistable()

◆ markPersistent()

◆ nParametersFromOrder()

◆ operator()()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ orderFromNParameters()

◆ readFits() [1/6]

◆ readFits() [2/6]

◆ readFits() [3/6]

◆ readFits() [4/6]

◆ readFits() [5/6]

◆ readFits() [6/6]

◆ repr()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ setParameter()

◆ setParameters()

◆ toString()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]

Member Data Documentation

◆ _isCacheValid

◆ _order

◆ _params

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