LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | 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::afw::table::io::PersistableFacade< Function< ReturnT > > lsst::afw::table::io::Persistable

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...
 
 PolynomialFunction1 (PolynomialFunction1 const &)=default
 
 PolynomialFunction1 (PolynomialFunction1 &&)=default
 
PolynomialFunction1operator= (PolynomialFunction1 const &)=default
 
PolynomialFunction1operator= (PolynomialFunction1 &&)=default
 
 ~PolynomialFunction1 () noexcept override=default
 
std::shared_ptr< Function1< ReturnT > > clone () const override
 Return a pointer to a deep copy of this function. More...
 
bool isLinearCombination () const noexcept override
 Is the function a linear combination of its parameters? More...
 
ReturnT operator() (double x) const noexcept(IS_NOTHROW_INIT< ReturnT >) override
 
unsigned int getOrder () const noexcept
 Get the polynomial order. More...
 
std::string toString (std::string const &prefix) const override
 Return a string representation of the function. More...
 
virtual void computeCache (int const n)
 
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...
 
virtual bool isPersistable () const noexcept
 Return true if this particular object can be persisted using afw::table::io. More...
 

Static Public Member Functions

static std::shared_ptr< Function1< ReturnT > > readFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< Function1< ReturnT > > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< Function1< 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< Function1< 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

 PolynomialFunction1 ()
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 
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...
 

Protected Attributes

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

◆ PolynomialFunction1() [1/5]

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

379  : Function1<ReturnT>(order + 1) {}
table::Key< int > order

◆ PolynomialFunction1() [2/5]

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

389  : Function1<ReturnT>(params) {
390  if (params.size() < 1) {
392  "PolynomialFunction1 called with empty vector");
393  }
394  }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
Reports invalid arguments.
Definition: Runtime.h:66
T size(T... args)

◆ PolynomialFunction1() [3/5]

template<typename ReturnT >
lsst::afw::math::PolynomialFunction1< ReturnT >::PolynomialFunction1 ( PolynomialFunction1< ReturnT > const &  )
default

◆ PolynomialFunction1() [4/5]

template<typename ReturnT >
lsst::afw::math::PolynomialFunction1< ReturnT >::PolynomialFunction1 ( PolynomialFunction1< ReturnT > &&  )
default

◆ ~PolynomialFunction1()

template<typename ReturnT >
lsst::afw::math::PolynomialFunction1< ReturnT >::~PolynomialFunction1 ( )
overridedefaultnoexcept

◆ PolynomialFunction1() [5/5]

template<typename ReturnT >
lsst::afw::math::PolynomialFunction1< ReturnT >::PolynomialFunction1 ( )
inlineexplicitprotected

Definition at line 431 of file FunctionLibrary.h.

431 : Function1<ReturnT>(1) {}

Member Function Documentation

◆ clone()

template<typename ReturnT >
std::shared_ptr<Function1<ReturnT> > lsst::afw::math::PolynomialFunction1< 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 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 402 of file FunctionLibrary.h.

◆ computeCache()

template<typename ReturnT >
virtual void lsst::afw::math::Function1< ReturnT >::computeCache ( int const  n)
inlinevirtualinherited

Definition at line 244 of file Function.h.

244 {}

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

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
py::object result
Definition: _schema.cc:429
uint64_t * ptr
Definition: RangeSet.cc:88

◆ dynamicCast() [2/2]

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< Function1< 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.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }

◆ 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(); }

◆ getOrder()

template<typename ReturnT >
unsigned int lsst::afw::math::PolynomialFunction1< ReturnT >::getOrder ( ) const
inlinenoexcept

Get the polynomial order.

Definition at line 420 of file FunctionLibrary.h.

420 { return this->getNParameters() - 1; };
unsigned int getNParameters() const noexcept
Return the number of function parameters.
Definition: Function.h:112

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

120  {
121  return _params[ind];
122  }

◆ 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()

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

Definition at line 34 of file Persistable.cc.

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

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

◆ isLinearCombination()

template<typename ReturnT >
bool lsst::afw::math::PolynomialFunction1< 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 406 of file FunctionLibrary.h.

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

Definition at line 102 of file Persistable.h.

102 { return false; }

◆ operator()()

template<typename ReturnT >
ReturnT lsst::afw::math::PolynomialFunction1< ReturnT >::operator() ( double  x) const
inlineoverridevirtualnoexcept

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

Definition at line 408 of file FunctionLibrary.h.

408  {
409  int const order = static_cast<int>(this->_params.size()) - 1;
410  double retVal = this->_params[order];
411  for (int ii = order - 1; ii >= 0; --ii) {
412  retVal = (retVal * x) + this->_params[ii];
413  }
414  return static_cast<ReturnT>(retVal);
415  }
double x

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ readFits() [1/6]

static std::shared_ptr<Function1< ReturnT > > lsst::afw::table::io::PersistableFacade< Function1< 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.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< Function1< ReturnT > > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

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

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [3/6]

static std::shared_ptr<Function1< ReturnT > > lsst::afw::table::io::PersistableFacade< Function1< 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.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

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

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

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

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ readFits() [6/6]

static std::shared_ptr<Function1< ReturnT > > lsst::afw::table::io::PersistableFacade< Function1< 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.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

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

145  {
146  _isCacheValid = false;
147  _params[ind] = newValue;
148  }

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

157  {
158  if (_params.size() != params.size()) {
159  throw LSST_EXCEPT(
161  (boost::format("params has %d entries instead of %d") % params.size() % _params.size())
162  .str());
163  }
164  _isCacheValid = false;
165  _params = params;
166  }
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ toString()

template<typename ReturnT >
std::string lsst::afw::math::PolynomialFunction1< 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::Function1< ReturnT >.

Definition at line 422 of file FunctionLibrary.h.

422  {
424  os << "PolynomialFunction1 []: ";
425  os << Function1<ReturnT>::toString(prefix);
426  return os.str();
427  }
std::ostream * os
Definition: Schema.cc:557
std::string prefix
Definition: SchemaMapper.cc:72

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

Definition at line 38 of file Persistable.cc.

38  {
39  assert(!isPersistable());
40  throw LSST_EXCEPT(pex::exceptions::LogicError,
41  "afw::table-based persistence is not supported for this object.");
42 }
virtual bool isPersistable() const noexcept
Return true if this particular object can be persisted using afw::table::io.
Definition: Persistable.h:102

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

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

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

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

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

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }

Member Data Documentation

◆ _isCacheValid

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

Definition at line 186 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: