2-dimensional weighted sum of Chebyshev polynomials of the first kind. More...

#include <FunctionLibrary.h>

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

Public Member Functions
	Chebyshev1Function2 (unsigned int order, lsst::geom::Box2D const &xyRange=lsst::geom::Box2D(lsst::geom::Point2D(-1.0, -1.0), lsst::geom::Point2D(1.0, 1.0)))
	Construct a Chebyshev polynomial of specified order and range. More...

	Chebyshev1Function2 (std::vector< double > params, lsst::geom::Box2D const &xyRange=lsst::geom::Box2D(lsst::geom::Point2D(-1.0, -1.0), lsst::geom::Point2D(1.0, 1.0)))
	Construct a Chebyshev polynomial with specified parameters and range. More...

	Chebyshev1Function2 (Chebyshev1Function2 const &)=default

	Chebyshev1Function2 (Chebyshev1Function2 &&)=default

Chebyshev1Function2 &	operator= (Chebyshev1Function2 const &)=default

Chebyshev1Function2 &	operator= (Chebyshev1Function2 &&)=default

	~Chebyshev1Function2 () noexcept override=default

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

lsst::geom::Box2D	getXYRange () const noexcept
	Get x,y range. More...

virtual Chebyshev1Function2	truncate (int truncOrder) const
	Return a truncated copy of lower (or equal) order. More...

ReturnT	operator() (double x, double y) const override

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

std::vector< double >	getDFuncDParameters (double x, double y) const override
	Return the derivative of the Function with respect to 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
using	OutputArchiveHandle = io::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...

	Chebyshev1Function2 ()

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::Chebyshev1Function2< ReturnT >

2-dimensional weighted sum of Chebyshev polynomials of the first kind.

f(x,y) = c0 T0(x') T0(y') # order 0

c1 T1(x') T0(y') + c2 T0(x') T1(y') # order 1
c3 T2(x') T0(y') + c4 T1(x') T1(y') + c5 T0(x') T2(y') # order 2
...

= c0 # order 0

c1 T1(x') + c2 T1(y') # order 1
c3 T2(x') + c4 T1(x') T1(y') + c5 T2(y') # order 2
...

where:

Tn(x) is the nth Chebyshev function of the first kind: T0(x) = 1 T1(x) = x Tn+1(x) = 2xTn(x) + Tn-1(x)
x' is x offset and scaled to range [-1, 1] as x ranges over [minX, maxX]
y' is y offset and scaled to range [-1, 1] as y ranges over [minY, maxY]

Return value is incorrect if function arguments are not in the range [minX, maxX], [minY, maxY].

Definition at line 719 of file FunctionLibrary.h.

Member Typedef Documentation

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ Chebyshev1Function2() [1/5]

template<typename ReturnT >

lsst::afw::math::Chebyshev1Function2< ReturnT >::Chebyshev1Function2	(	unsigned int	order,
		lsst::geom::Box2D const &	xyRange = `lsst::geom::Box2D( lsst::geom::Point2D(-1.0, -1.0), lsst::geom::Point2D(1.0, 1.0))`
	)

inlineexplicit

Construct a Chebyshev polynomial of specified order and range.

The parameters are initialized to zero.

Parameters

order	order of polynomial (0 for constant)
xyRange	allowed x,y range

Definition at line 726 of file FunctionLibrary.h.

             : BasePolynomialFunction2<ReturnT>(order),
               _oldYPrime(0),
               _yCheby(this->_order + 1),
               _xCoeffs(this->_order + 1) {
         _initialize(xyRange);
     }

◆ Chebyshev1Function2() [2/5]

template<typename ReturnT >

lsst::afw::math::Chebyshev1Function2< ReturnT >::Chebyshev1Function2	(	std::vector< double >	params,
		lsst::geom::Box2D const &	xyRange = `lsst::geom::Box2D( lsst::geom::Point2D(-1.0, -1.0), lsst::geom::Point2D(1.0, 1.0))`
	)

inlineexplicit

Construct a Chebyshev polynomial with specified parameters and range.

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

Exceptions

lsst::pex::exceptions::InvalidParameterError if params is empty

Parameters

params	polynomial coefficients length must be one of 1, 3, 6, 10, 15...
xyRange	allowed x,y range

Definition at line 744 of file FunctionLibrary.h.

             : BasePolynomialFunction2<ReturnT>(params),
               _oldYPrime(0),
               _yCheby(this->_order + 1),
               _xCoeffs(this->_order + 1) {
         _initialize(xyRange);
     }

◆ Chebyshev1Function2() [3/5]

template<typename ReturnT >

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

default

◆ Chebyshev1Function2() [4/5]

template<typename ReturnT >

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

default

◆ ~Chebyshev1Function2()

template<typename ReturnT >

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

overridedefaultnoexcept

◆ Chebyshev1Function2() [5/5]

template<typename ReturnT >

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

inlineexplicitprotected

Definition at line 899 of file FunctionLibrary.h.

             : BasePolynomialFunction2<ReturnT>(),
               _oldYPrime(0),
               _yCheby(0),
               _xCoeffs(0),
               _minX(0.0),
               _minY(0.0),
               _maxX(0.0),
               _maxY(0.0),
               _scaleX(1.0),
               _scaleY(1.0),
               _offsetX(0.0),
               _offsetY(0.0) {}

Member Function Documentation

◆ clone()

template<typename ReturnT >

std::shared_ptr<Function2<ReturnT> > lsst::afw::math::Chebyshev1Function2< 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 762 of file FunctionLibrary.h.

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

◆ 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 218 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 218 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::BasePolynomialFunction2< ReturnT >::getDFuncDParameters	(	double	x,
		double	y
	)		const

inlineoverridevirtualinherited

Return the derivative of the Function with respect to its parameters.

Because this is a polynomial, c0 F0(x,y) + c1 F1(x,y) + c2 F2(x,y) + ... we can set ci = 0 for all i except the parameter of interest and evaluate. This isn't necessarily the most efficient algorithm, but it's general, and you can override it if it isn't suitable for your particular subclass.

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

Reimplemented in lsst::afw::math::PolynomialFunction2< ReturnT >.

Definition at line 411 of file Function.h.

                                                                              {
         unsigned int const numParams = this->getNParameters();  // Number of parameters
         std::vector<double> deriv(numParams);                   // Derivatives, to return
  
         std::shared_ptr<Function2<ReturnT>> dummy =
                 this->clone();  // Dummy function to evaluate for derivatives
         for (unsigned int i = 0; i < numParams; ++i) {
             dummy->setParameter(i, 0.0);
         }
  
         for (unsigned int i = 0; i < numParams; ++i) {
             dummy->setParameter(i, 1.0);
             deriv[i] = (*dummy)(x, y);
             dummy->setParameter(i, 0.0);
         }
  
         return deriv;
     }

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

112 { return _params.size(); }

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

360 { return _order; }

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

129 { return _params; }

◆ getPersistenceName()

template<typename ReturnT >

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

                                                                  {
     return "Chebyshev1Function2" + 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 188 of file Function.h.

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

◆ getXYRange()

template<typename ReturnT >

lsst::geom::Box2D lsst::afw::math::Chebyshev1Function2< ReturnT >::getXYRange ( ) const

inlinenoexcept

Get x,y range.

Definition at line 770 of file FunctionLibrary.h.

                                               {
         return lsst::geom::Box2D(lsst::geom::Point2D(_minX, _minY), lsst::geom::Point2D(_maxX, _maxY));
     };

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

362 { return true; }

◆ isPersistable()

template<typename ReturnT >

bool lsst::afw::math::Chebyshev1Function2< 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 863 of file FunctionLibrary.h.

863 { return true; }

◆ 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 369 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::Chebyshev1Function2< ReturnT >::operator()	(	double	x,
		double	y
	)		const

inlineoverridevirtual

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

Definition at line 791 of file FunctionLibrary.h.

                                                           {
         /* Solve as follows:
         - f(x,y) = Cy0 T0(y') + Cy1 T1(y') + Cy2 T2(y') + Cy3 T3(y') + ...
         where:
           Cy0 = P0 T0(x') + P1 T1(x') + P3 T2(x') + P6 T3(x') + ...
           Cy1 = P2 T0(x') + P4 T1(x') + P7 T2(x') + ...
           Cy2 = P5 T0(x') + P8 T1(x') + ...
           Cy3 = P9 T0(x') + ...
           ...
  
         First compute Tn(x') for each n
         Then use that to compute Cy0, Cy1, ...Cyn
         Then solve the y Chebyshev polynomial using the Clenshaw algorithm
         */
         double const xPrime = (x + _offsetX) * _scaleX;
         double const yPrime = (y + _offsetY) * _scaleY;
  
         const int nParams = static_cast<int>(this->_params.size());
         const int order = this->_order;
  
         if (order == 0) {
             return this->_params[0];  // No caching required
         }
  
         if ((yPrime != _oldYPrime) || !this->_isCacheValid) {
             // update cached _yCheby and _xCoeffs
             _yCheby[0] = 1.0;
             _yCheby[1] = yPrime;
             for (int chebyInd = 2; chebyInd <= order; chebyInd++) {
                 _yCheby[chebyInd] = (2 * yPrime * _yCheby[chebyInd - 1]) - _yCheby[chebyInd - 2];
             }
  
             for (int coeffInd = 0; coeffInd <= order; coeffInd++) {
                 _xCoeffs[coeffInd] = 0;
             }
             for (int coeffInd = 0, endCoeffInd = 0, paramInd = 0; paramInd < nParams; paramInd++) {
                 _xCoeffs[coeffInd] += this->_params[paramInd] * _yCheby[endCoeffInd];
                 --coeffInd;
                 ++endCoeffInd;
                 if (coeffInd < 0) {
                     coeffInd = endCoeffInd;
                     endCoeffInd = 0;
                 }
             }
  
             _oldYPrime = yPrime;
             this->_isCacheValid = true;
         }
  
         // Clenshaw function for solving the Chebyshev polynomial
         // Non-recursive version from Kresimir Cosic
         if (order == 1) {
             return _xCoeffs[0] + (_xCoeffs[1] * xPrime);
         }
         double cshPrev = _xCoeffs[order];
         double csh = (2 * xPrime * _xCoeffs[order]) + _xCoeffs[order - 1];
         for (int i = order - 2; i > 0; --i) {
             double cshNext = (2 * xPrime * csh) + _xCoeffs[i] - cshPrev;
             cshPrev = csh;
             csh = cshNext;
         }
         return (xPrime * csh) + _xCoeffs[0] - cshPrev;
     }

◆ operator=() [1/2]

template<typename ReturnT >

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

default

◆ operator=() [2/2]

template<typename ReturnT >

Chebyshev1Function2& lsst::afw::math::Chebyshev1Function2< ReturnT >::operator= ( Chebyshev1Function2< 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::InvalidParameterError if nParameters is invalid

Definition at line 392 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<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() [2/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() [3/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));
     }

◆ readFits() [4/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() [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]	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() [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]	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));
     }

◆ 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 143 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 156 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::Chebyshev1Function2< 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 855 of file FunctionLibrary.h.

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

◆ truncate()

template<typename ReturnT >

virtual Chebyshev1Function2 lsst::afw::math::Chebyshev1Function2< ReturnT >::truncate ( int truncOrder ) const

inlinevirtual

Return a truncated copy of lower (or equal) order.

Exceptions

lsst::pex::exceptions::InvalidParameter if truncated order > original order

Parameters

truncOrder order of truncated polynomial

Definition at line 779 of file FunctionLibrary.h.

                                                  {
         if (truncOrder > this->_order) {
             std::ostringstream os;
             os << "truncated order=" << truncOrder << " must be <= original order=" << this->_order;
             throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError, os.str());
         }
         int truncNParams = this->nParametersFromOrder(truncOrder);
         std::vector<double> truncParams(this->_params.begin(), this->_params.begin() + truncNParams);
         return Chebyshev1Function2(truncParams, this->getXYRange());
     }

◆ write()

template<typename ReturnT >

void lsst::afw::math::Chebyshev1Function2< 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 247 of file FunctionLibrary.cc.

                                                                                  {
     Chebyshev1Function2PersistenceHelper const keys(this->getNParameters());
     table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
     std::shared_ptr<table::BaseRecord> record = catalog.addNew();
     keys.coefficients.assignVector(*record, this->getParameters());
     lsst::geom::Box2D bbox = getXYRange();
     record->set(keys.min, bbox.getMin());
     record->set(keys.max, bbox.getMax());
     handle.saveCatalog(catalog);
 }

◆ 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] fitsfile Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                     {
     OutputArchive archive;
     archive.put(this);
     archive.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	(	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);
 }

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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/math/FunctionLibrary.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/math/FunctionLibrary.cc

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ OutputArchiveHandle

Constructor & Destructor Documentation

◆ Chebyshev1Function2() [1/5]

◆ Chebyshev1Function2() [2/5]

◆ Chebyshev1Function2() [3/5]

◆ Chebyshev1Function2() [4/5]

◆ ~Chebyshev1Function2()

◆ Chebyshev1Function2() [5/5]

Member Function Documentation

◆ clone()

◆ dynamicCast() [1/2]

◆ dynamicCast() [2/2]

◆ getDFuncDParameters()

◆ getNParameters()

◆ getOrder()

◆ getParameter()

◆ getParameters()

◆ getPersistenceName()

◆ getPythonModule()

◆ getXYRange()

◆ isLinearCombination()

◆ isPersistable()

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

◆ setParameter()

◆ setParameters()

◆ toString()

◆ truncate()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]

Member Data Documentation

◆ _isCacheValid

◆ _order

◆ _params

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