lsst.jointcal  16.0-21-g96865c2+1
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::MagnitudeTransfoChebyshev Class Reference

nth-order 2d Chebyshev photometry transfo, plus the input flux. More...

#include <PhotometryTransfo.h>

Inheritance diagram for lsst::jointcal::MagnitudeTransfoChebyshev:
lsst::jointcal::PhotometryTransfoChebyshev lsst::jointcal::PhotometryTransfo

Public Member Functions

 MagnitudeTransfoChebyshev (size_t order, afw::geom::Box2D const &bbox)
 
 MagnitudeTransfoChebyshev (ndarray::Array< double, 2, 2 > const &coefficients, afw::geom::Box2D const &bbox)
 
double transform (double x, double y, double value) const override
 Return the transform of value at (x,y). More...
 
void computeParameterDerivatives (double x, double y, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e. More...
 
std::shared_ptr< PhotometryTransfoclone () const override
 return a copy (allocated by new) of the transformation. More...
 
double transformError (double x, double y, double value, double valueErr) const override
 Return the transformed valueErr at Point(x,y). More...
 
double transformError (Point const &in, double value, double valueErr) const
 Return the transformed valueErr at Point(x,y). More...
 
void dump (std::ostream &stream=std::cout) const override
 dumps the transfo coefficients to stream. More...
 
int getNpar () const override
 Return the number of parameters (used to compute chisq) More...
 
void offsetParams (Eigen::VectorXd const &delta) override
 Offset the parameters by some (negative) amount during fitting. More...
 
ndarray::Array< double, 2, 2 > getCoefficients () const
 Get a copy of the coefficients of the polynomials, as a 2d array (NOTE: layout is [y][x]) More...
 
Eigen::VectorXd getParameters () const override
 Get a copy of the parameters of this model, in the same order as offsetParams. More...
 
ndarray::Size getOrder () const
 
afw::geom::Box2D getBBox () const
 
double mean () const
 
double transform (Point const &in, double value) const
 Return the transformed value at Point(x,y). More...
 

Protected Member Functions

double computeChebyshev (double x, double y) const
 Return the value of this polynomial at x,y. More...
 
void computeChebyshevDerivatives (double x, double y, Eigen::Ref< Eigen::VectorXd > derivatives) const
 Set the derivatives of this polynomial at x,y. More...
 

Detailed Description

nth-order 2d Chebyshev photometry transfo, plus the input flux.

Definition at line 298 of file PhotometryTransfo.h.

Constructor & Destructor Documentation

◆ MagnitudeTransfoChebyshev() [1/2]

lsst::jointcal::MagnitudeTransfoChebyshev::MagnitudeTransfoChebyshev ( size_t  order,
afw::geom::Box2D const &  bbox 
)
inline

Definition at line 300 of file PhotometryTransfo.h.

◆ MagnitudeTransfoChebyshev() [2/2]

lsst::jointcal::MagnitudeTransfoChebyshev::MagnitudeTransfoChebyshev ( ndarray::Array< double, 2, 2 > const &  coefficients,
afw::geom::Box2D const &  bbox 
)
inline

Definition at line 303 of file PhotometryTransfo.h.

Member Function Documentation

◆ clone()

std::shared_ptr<PhotometryTransfo> lsst::jointcal::MagnitudeTransfoChebyshev::clone ( void  ) const
inlineoverridevirtual

return a copy (allocated by new) of the transformation.

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 319 of file PhotometryTransfo.h.

◆ computeChebyshev()

double lsst::jointcal::PhotometryTransfoChebyshev::computeChebyshev ( double  x,
double  y 
) const
protectedinherited

Return the value of this polynomial at x,y.

For use in the sublcass transform() methods.

Definition at line 132 of file PhotometryTransfo.cc.

◆ computeChebyshevDerivatives()

void lsst::jointcal::PhotometryTransfoChebyshev::computeChebyshevDerivatives ( double  x,
double  y,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
protectedinherited

Set the derivatives of this polynomial at x,y.

For use in the sublcass computeParameterDerivatives() methods.

Definition at line 138 of file PhotometryTransfo.cc.

◆ computeParameterDerivatives()

void lsst::jointcal::MagnitudeTransfoChebyshev::computeParameterDerivatives ( double  x,
double  y,
double  value,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
inlineoverridevirtual

Compute the derivatives with respect to the parameters (i.e.

the coefficients).

Parameters
[in]xThe x coordinate to compute at (in the appropriate units for this transfo).
[in]yThe y coordinate to compute at (in the appropriate units for this transfo).
[in]valueThe instrument flux or magnitude to compute the derivative at.
[out]derivativesThe computed derivatives, in the same order as the deltas in offsetParams.

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 312 of file PhotometryTransfo.h.

◆ dump()

void lsst::jointcal::PhotometryTransfoChebyshev::dump ( std::ostream stream = std::cout) const
inlineoverridevirtualinherited

dumps the transfo coefficients to stream.

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 222 of file PhotometryTransfo.h.

◆ getBBox()

afw::geom::Box2D lsst::jointcal::PhotometryTransfoChebyshev::getBBox ( ) const
inlineinherited

Definition at line 238 of file PhotometryTransfo.h.

◆ getCoefficients()

ndarray::Array<double, 2, 2> lsst::jointcal::PhotometryTransfoChebyshev::getCoefficients ( ) const
inlineinherited

Get a copy of the coefficients of the polynomials, as a 2d array (NOTE: layout is [y][x])

Definition at line 231 of file PhotometryTransfo.h.

◆ getNpar()

int lsst::jointcal::PhotometryTransfoChebyshev::getNpar ( ) const
inlineoverridevirtualinherited

Return the number of parameters (used to compute chisq)

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 225 of file PhotometryTransfo.h.

◆ getOrder()

ndarray::Size lsst::jointcal::PhotometryTransfoChebyshev::getOrder ( ) const
inlineinherited

Definition at line 236 of file PhotometryTransfo.h.

◆ getParameters()

Eigen::VectorXd lsst::jointcal::PhotometryTransfoChebyshev::getParameters ( ) const
overridevirtualinherited

Get a copy of the parameters of this model, in the same order as offsetParams.

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 118 of file PhotometryTransfo.cc.

◆ mean()

double lsst::jointcal::PhotometryTransfoChebyshev::mean ( ) const
inherited

Definition at line 116 of file PhotometryTransfo.cc.

◆ offsetParams()

void lsst::jointcal::PhotometryTransfoChebyshev::offsetParams ( Eigen::VectorXd const &  delta)
overridevirtualinherited

Offset the parameters by some (negative) amount during fitting.

Equivalent to flatten(parameters) -= delta

Ordering of delta is the same as the ordering of the derivatives returned from computeParameterDerivatives.

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 83 of file PhotometryTransfo.cc.

◆ transform() [1/2]

double lsst::jointcal::PhotometryTransfo::transform ( Point const &  in,
double  value 
) const
inlineinherited

Return the transformed value at Point(x,y).

Definition at line 35 of file PhotometryTransfo.h.

◆ transform() [2/2]

double lsst::jointcal::MagnitudeTransfoChebyshev::transform ( double  x,
double  y,
double  value 
) const
inlineoverridevirtual

Return the transform of value at (x,y).

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 307 of file PhotometryTransfo.h.

◆ transformError() [1/2]

double lsst::jointcal::PhotometryTransfo::transformError ( Point const &  in,
double  value,
double  valueErr 
) const
inlineinherited

Return the transformed valueErr at Point(x,y).

Definition at line 41 of file PhotometryTransfo.h.

◆ transformError() [2/2]

double lsst::jointcal::PhotometryTransfoChebyshev::transformError ( double  x,
double  y,
double  value,
double  valueErr 
) const
inlineoverridevirtualinherited

Return the transformed valueErr at Point(x,y).

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 219 of file PhotometryTransfo.h.


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