lsst.afw  21.0.0-8-gd9c33f4a0+ec3713772a
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
lsst::afw::math::PolynomialFunction2< ReturnT > Class Template Reference

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

#include <FunctionLibrary.h>

Inheritance diagram for lsst::afw::math::PolynomialFunction2< ReturnT >:
lsst::afw::math::BasePolynomialFunction2< ReturnT > lsst::afw::math::Function2< ReturnT > lsst::afw::table::io::PersistableFacade< Function2< ReturnT > > lsst::afw::math::Function< ReturnT > lsst::afw::table::io::PersistableFacade< Function< ReturnT > > lsst::afw::table::io::Persistable

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
 
PolynomialFunction2operator= (PolynomialFunction2 const &)=default
 
PolynomialFunction2operator= (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...
 
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...
 

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)

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

◆ OutputArchiveHandle

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

Definition at line 108 of file Persistable.h.

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
orderorder of polynomial (0 for constant)

Definition at line 458 of file FunctionLibrary.h.

◆ 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::InvalidParameterErrorif params length is unsuitable
lsst::pex::exceptions::Exceptionif an internal sanity check fails
Parameters
paramspolynomial 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.

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

Member Function Documentation

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

◆ dynamicCast() [1/2]

template std::shared_ptr< math::TransformBoundedField > 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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

◆ dynamicCast() [2/2]

template std::shared_ptr< math::TransformBoundedField > 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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

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

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

◆ getOrder()

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

Get the polynomial order.

Definition at line 360 of file Function.h.

◆ 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
indindex of parameter

Definition at line 119 of file Function.h.

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

◆ getPersistenceName()

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

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

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

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

◆ 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::InvalidParameterErrorif order < 0

Definition at line 369 of file Function.h.

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

template<typename ReturnT >
PolynomialFunction2& lsst::afw::math::PolynomialFunction2< ReturnT >::operator= ( PolynomialFunction2< ReturnT > const &  )
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::InvalidParameterErrorif nParameters is invalid

Definition at line 392 of file Function.h.

◆ 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]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

◆ 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]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

◆ readFits() [3/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]managerManager for the memory to read from.
[in]hduHDU 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.

◆ readFits() [4/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]managerManager for the memory to read from.
[in]hduHDU 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.

◆ readFits() [5/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]fileNameName of the file to read.
[in]hduHDU 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.

◆ readFits() [6/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]fileNameName of the file to read.
[in]hduHDU 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.

◆ 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
indindex of parameter
newValuenew value for parameter

Definition at line 143 of file Function.h.

◆ 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::InvalidParameterErrorif the wrong number of parameters is supplied.
Parameters
paramsvector of function parameters

Definition at line 156 of file Function.h.

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

◆ 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 240 of file FunctionLibrary.cc.

◆ writeFits() [1/3]

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

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

◆ 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]managerName of the file to write to.
[in]modeIf "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.

◆ writeFits() [3/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]fileNameName of the file to write to.
[in]modeIf "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.

Member Data Documentation

◆ _isCacheValid

template<typename ReturnT >
bool lsst::afw::math::Function< ReturnT >::_isCacheValid
mutableprotectedinherited

Definition at line 186 of file Function.h.

◆ _order

template<typename ReturnT >
int lsst::afw::math::BasePolynomialFunction2< ReturnT >::_order
protectedinherited

order of polynomial

Definition at line 431 of file Function.h.

◆ _params

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

Definition at line 185 of file Function.h.


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