LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Friends | List of all members
lsst.afw.math::PolynomialFunction1< ReturnT > Class Template Reference

1-dimensional polynomial function. More...

#include <FunctionLibrary.h>

Inheritance diagram for lsst.afw.math::PolynomialFunction1< ReturnT >:
lsst.afw.math::Function1< ReturnT > lsst.afw.table.io::PersistableFacade< Function1< ReturnT > > lsst.afw.math::Function< ReturnT > lsst::daf::base::Citizen lsst.afw.table.io::PersistableFacade< Function< ReturnT > > lsst.afw.table.io::Persistable

Public Types

typedef Function1< ReturnT >::Ptr Function1Ptr
 
- Public Types inherited from lsst.afw.math::Function1< ReturnT >
typedef boost::shared_ptr
< Function1< 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

 PolynomialFunction1 (unsigned int order)
 Construct a polynomial function of the specified order. More...
 
 PolynomialFunction1 (std::vector< double > params)
 Construct a polynomial function with the specified parameters. More...
 
virtual ~PolynomialFunction1 ()
 
virtual Function1Ptr clone () const
 Return a pointer to a deep copy of this function. More...
 
virtual bool isLinearCombination () const
 Is the function a linear combination of its parameters? More...
 
virtual ReturnT operator() (double x) const
 
unsigned int getOrder () const
 Get the polynomial order. More...
 
virtual std::string toString (std::string const &prefix) const
 Return a string representation of the function. More...
 
- Public Member Functions inherited from lsst.afw.math::Function1< ReturnT >
 Function1 (unsigned int nParams)
 Construct a Function1 given the number of function parameters. More...
 
 Function1 (std::vector< double > const &params)
 Construct a Function1 given the function parameters. More...
 
virtual ~Function1 ()
 
virtual void computeCache (int const n)
 
- 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...
 
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 ()
 
Citizenoperator= (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

 PolynomialFunction1 ()
 
- Protected Member Functions inherited from lsst.afw.math::Function1< ReturnT >
 Function1 ()
 
- 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 int const version)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.afw.table.io::PersistableFacade< Function1< ReturnT > >
static boost::shared_ptr
< Function1< ReturnT > > 
readFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static boost::shared_ptr
< Function1< ReturnT > > 
readFits (std::string const &fileName, int hdu=0)
 Read an object from a regular FITS file. More...
 
static boost::shared_ptr
< Function1< 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::PolynomialFunction1< ReturnT >

1-dimensional polynomial function.

f(x) = c0 + c1 x + c2 x^2 + ... cn-1 x^(n-1)

Definition at line 435 of file FunctionLibrary.h.

Member Typedef Documentation

template<typename ReturnT >
typedef Function1<ReturnT>::Ptr lsst.afw.math::PolynomialFunction1< ReturnT >::Function1Ptr

Definition at line 437 of file FunctionLibrary.h.

Constructor & Destructor Documentation

template<typename ReturnT >
lsst.afw.math::PolynomialFunction1< ReturnT >::PolynomialFunction1 ( unsigned int  order)
inlineexplicit

Construct a polynomial function of the specified order.

The parameters are initialized to zero.

Parameters
orderorder of polynomial (0 for constant)

Definition at line 444 of file FunctionLibrary.h.

446  :
447  Function1<ReturnT>(order+1) {
448  }
template<typename ReturnT >
lsst.afw.math::PolynomialFunction1< ReturnT >::PolynomialFunction1 ( std::vector< double >  params)
inlineexplicit

Construct a polynomial function with the specified parameters.

The order of the polynomial is set to the length of the params vector.

Exceptions
lsst::pex::exceptions::InvalidParameterif params is empty
Parameters
paramspolynomial coefficients (const, x, x^2...)

Definition at line 457 of file FunctionLibrary.h.

459  :
460  Function1<ReturnT>(params)
461  {
462  if (params.size() < 1) {
463  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
464  "PolynomialFunction1 called with empty vector");
465  }
466  }
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
template<typename ReturnT >
virtual lsst.afw.math::PolynomialFunction1< ReturnT >::~PolynomialFunction1 ( )
inlinevirtual

Definition at line 468 of file FunctionLibrary.h.

468 {}
template<typename ReturnT >
lsst.afw.math::PolynomialFunction1< ReturnT >::PolynomialFunction1 ( )
inlineexplicitprotected

Definition at line 499 of file FunctionLibrary.h.

499 : Function1<ReturnT>(1) {}

Member Function Documentation

template<typename ReturnT >
virtual Function1Ptr lsst.afw.math::PolynomialFunction1< ReturnT >::clone ( ) const
inlinevirtual

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 concrete subclass must override this method.

Returns
a pointer to a deep copy of the function

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

Definition at line 470 of file FunctionLibrary.h.

470  {
471  return Function1Ptr(new PolynomialFunction1(this->_params));
472  }
Function1< ReturnT >::Ptr Function1Ptr
std::vector< double > _params
Definition: Function.h:204
template<typename ReturnT >
unsigned int lsst.afw.math::PolynomialFunction1< ReturnT >::getOrder ( ) const
inline

Get the polynomial order.

Definition at line 488 of file FunctionLibrary.h.

488 { return this->getNParameters() - 1; };
unsigned int getNParameters() const
Return the number of function parameters.
Definition: Function.h:125
template<typename ReturnT >
virtual bool lsst.afw.math::PolynomialFunction1< ReturnT >::isLinearCombination ( ) const
inlinevirtual

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 474 of file FunctionLibrary.h.

474 { return true; };
template<typename ReturnT >
virtual ReturnT lsst.afw.math::PolynomialFunction1< ReturnT >::operator() ( double  x) const
inlinevirtual

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

Definition at line 476 of file FunctionLibrary.h.

476  {
477  int const order = static_cast<int>(this->_params.size()) - 1;
478  double retVal = this->_params[order];
479  for (int ii = order-1; ii >= 0; --ii) {
480  retVal = (retVal * x) + this->_params[ii];
481  }
482  return static_cast<ReturnT>(retVal);
483  }
int x
std::vector< double > _params
Definition: Function.h:204
template<typename ReturnT >
template<class Archive >
void lsst.afw.math::PolynomialFunction1< ReturnT >::serialize ( Archive &  ar,
unsigned int const  version 
)
inlineprivate

Definition at line 504 of file FunctionLibrary.h.

504  {
505  ar & make_nvp("fn1", boost::serialization::base_object<Function1<ReturnT> >(*this));
506  }
template<typename ReturnT >
virtual std::string lsst.afw.math::PolynomialFunction1< 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::Function1< ReturnT >.

Definition at line 490 of file FunctionLibrary.h.

490  {
491  std::ostringstream os;
492  os << "PolynomialFunction1 []: ";
493  os << Function1<ReturnT>::toString(prefix);
494  return os.str();
495  }

Friends And Related Function Documentation

template<typename ReturnT >
friend class boost::serialization::access
friend

Definition at line 502 of file FunctionLibrary.h.


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