lsst::afw::math::BasePolynomialFunction2< ReturnT > Class Template Reference

Base class for 2-dimensional polynomials of the form: More...

#include <Function.h>

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

Public Member Functions
	BasePolynomialFunction2 (unsigned int order)
	Construct a polynomial function of specified order.
	BasePolynomialFunction2 (std::vector< double > params)
	Construct a polynomial function with specified parameters.
	BasePolynomialFunction2 (BasePolynomialFunction2 const &)=default
	BasePolynomialFunction2 (BasePolynomialFunction2 &&)=default
BasePolynomialFunction2 &	operator= (BasePolynomialFunction2 const &)=default
BasePolynomialFunction2 &	operator= (BasePolynomialFunction2 &&)=default
	~BasePolynomialFunction2 () noexcept override=default
int	getOrder () const noexcept
	Get the polynomial order.
bool	isLinearCombination () const noexcept override
	Is the function a linear combination of its parameters?
std::vector< double >	getDFuncDParameters (double x, double y) const override
	Return the derivative of the Function with respect to its parameters.
virtual std::shared_ptr< Function2< ReturnT > >	clone () const =0
	Return a pointer to a deep copy of this function.
virtual ReturnT	operator() (double x, double y) const =0
std::string	toString (std::string const &prefix="") const override
	Return a string representation of the function.
unsigned int	getNParameters () const noexcept
	Return the number of function parameters.
virtual double	getParameter (unsigned int ind) const
	Get one function parameter without range checking.
std::vector< double > const &	getParameters () const noexcept
	Return all function parameters.
void	setParameter (unsigned int ind, double newValue)
	Set one function parameter without range checking.
void	setParameters (std::vector< double > const &params)
	Set all function parameters.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.
virtual bool	isPersistable () const noexcept
	Return true if this particular object can be persisted using afw::table::io.

Static Public Member Functions
static int	nParametersFromOrder (int order)
	Compute number of parameters from polynomial order.
static int	orderFromNParameters (int nParameters)
	Compute polynomial order from the number of parameters.
static std::shared_ptr< Function2< ReturnT > >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< Function2< ReturnT > >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< Function2< ReturnT > >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< Function< ReturnT > >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< Function< ReturnT > >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< Function< ReturnT > >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< Function2< ReturnT > >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.
static std::shared_ptr< Function< ReturnT > >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
	BasePolynomialFunction2 ()
std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory.
virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs.

Protected Attributes
int	_order
	order of polynomial
std::vector< double >	_params
bool	_isCacheValid

Detailed Description

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

Base class for 2-dimensional polynomials of the form:

f(x,y) =   c0 f0(x) f0(y)                                        (0th order)
         + c1 f1(x) f0(x) + c2 f0(x) f1(y)                       (1st order)
         + c3 f2(x) f0(y) + c4 f1(x) f1(y) + c5 f0(x) f2(y)      (2nd order)
         + ...

and typically f0(x) = 1

Definition at line 326 of file Function.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

BasePolynomialFunction2() [1/5]

template<typename ReturnT >

lsst::afw::math::BasePolynomialFunction2< ReturnT >::BasePolynomialFunction2 ( 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 335 of file Function.h.

            : Function2<ReturnT>(BasePolynomialFunction2::nParametersFromOrder(order)), _order(order) {}

BasePolynomialFunction2() [2/5]

template<typename ReturnT >

lsst::afw::math::BasePolynomialFunction2< ReturnT >::BasePolynomialFunction2 ( 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 (see orderFromNParameters) and only certain lengths are suitable: 1, 3, 6, 10, 15...

Exceptions

lsst::pex::exceptions::InvalidParameterError

if params length is unsuitable

Parameters

params

polynomial coefficients

Definition at line 346 of file Function.h.

            : Function2<ReturnT>(params),
              _order(BasePolynomialFunction2::orderFromNParameters(static_cast<int>(params.size()))) {}

BasePolynomialFunction2() [3/5]

template<typename ReturnT >

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

default

BasePolynomialFunction2() [4/5]

template<typename ReturnT >

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

default

~BasePolynomialFunction2()

template<typename ReturnT >

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

overridedefaultnoexcept

BasePolynomialFunction2() [5/5]

template<typename ReturnT >

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

inlineexplicitprotected

Definition at line 434 of file Function.h.

: Function2<ReturnT>(1), _order(0) {}

Member Function Documentation

clone()

template<typename ReturnT >

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

pure virtualinherited

Return a pointer to a deep copy of this function.

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

Every non-virtual function must override this method.

Returns

a pointer to a deep copy of the function

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

dynamicCast() [1/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.

dynamicCast() [2/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.

getDFuncDParameters()

template<typename ReturnT >

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

inlineoverridevirtual

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.

{ return _params.size(); }

getOrder()

template<typename ReturnT >

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

inlinenoexcept

Get the polynomial order.

Definition at line 360 of file Function.h.

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

{ return _params; }

getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const

protectedvirtualinherited

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented in lsst::afw::image::FilterLabel, lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::PcaPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 34 of file Persistable.cc.

{ return std::string(); }

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.

{ return "lsst.afw.math"; }

isLinearCombination()

template<typename ReturnT >

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

inlineoverridevirtualnoexcept

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.

{ return true; }

isPersistable()

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const

inlinevirtualnoexceptinherited

Return true if this particular object can be persisted using afw::table::io.

Reimplemented in lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 102 of file Persistable.h.

{ return false; }

nParametersFromOrder()

template<typename ReturnT >

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

inlinestatic

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 >

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

pure virtualinherited

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

operator=() [1/2]

template<typename ReturnT >

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

default

operator=() [2/2]

template<typename ReturnT >

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

default

orderFromNParameters()

template<typename ReturnT >

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

inlinestatic

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

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.

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.

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.

readFits() [5/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.

readFits() [6/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.

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::Function2< ReturnT >::toString ( std::string const & = "" ) const

inlineoverridevirtualinherited

Return a string representation of the function.

Returns

a string representation of the function

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

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

Definition at line 299 of file Function.h.

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

write()

void lsst::afw::table::io::Persistable::write ( OutputArchiveHandle & handle ) const

protectedvirtualinherited

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 in lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::meas::extensions::psfex::PsfexPsf, lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::FixedKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::WarpingControl, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::modelfit::Mixture, lsst::afw::image::FilterLabel, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 38 of file Persistable.cc.

                                                   {
    assert(!isPersistable());
    throw LSST_EXCEPT(pex::exceptions::LogicError,
                      "afw::table-based persistence is not supported for this object.");
}

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

protected

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 file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/math/Function.h