lsst.jointcal  16.0-18-gdf247dd+5
Public Member Functions | Friends | List of all members
lsst::jointcal::PhotometryTransfo Class Referenceabstract

A photometric transform, defined in terms of the input flux or magnitude. More...

#include <PhotometryTransfo.h>

Inheritance diagram for lsst::jointcal::PhotometryTransfo:
lsst::jointcal::PhotometryTransfoChebyshev lsst::jointcal::PhotometryTransfoSpatiallyInvariant lsst::jointcal::FluxTransfoChebyshev lsst::jointcal::MagnitudeTransfoChebyshev lsst::jointcal::FluxTransfoSpatiallyInvariant lsst::jointcal::MagnitudeTransfoSpatiallyInvariant

Public Member Functions

virtual double transform (double x, double y, double value) const =0
 Return the transform of value at (x,y). More...
 
double transform (Point const &in, double value) const
 Return the transformed value at Point(x,y). More...
 
virtual double transformError (double x, double y, double value, double valueErr) const =0
 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...
 
virtual void dump (std::ostream &stream=std::cout) const =0
 dumps the transfo coefficients to stream. More...
 
virtual int getNpar () const =0
 Return the number of parameters (used to compute chisq) More...
 
virtual void offsetParams (Eigen::VectorXd const &delta)=0
 Offset the parameters by some (negative) amount during fitting. More...
 
virtual std::shared_ptr< PhotometryTransfoclone () const =0
 return a copy (allocated by new) of the transformation. More...
 
virtual void computeParameterDerivatives (double x, double y, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const =0
 Compute the derivatives with respect to the parameters (i.e. More...
 
virtual Eigen::VectorXd getParameters () const =0
 Get a copy of the parameters of this model, in the same order as offsetParams. More...
 

Friends

std::ostreamoperator<< (std::ostream &s, PhotometryTransfo const &transfo)
 

Detailed Description

A photometric transform, defined in terms of the input flux or magnitude.

Unit agnostic: a higher level Model must keep track of the units going into and out of of its Transfos.

See also
lsst::afw::image::PhotoCalib

Definition at line 29 of file PhotometryTransfo.h.

Member Function Documentation

◆ clone()

virtual std::shared_ptr<PhotometryTransfo> lsst::jointcal::PhotometryTransfo::clone ( ) const
pure virtual

◆ computeParameterDerivatives()

virtual void lsst::jointcal::PhotometryTransfo::computeParameterDerivatives ( double  x,
double  y,
double  value,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
pure virtual

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.

Implemented in lsst::jointcal::MagnitudeTransfoChebyshev, lsst::jointcal::FluxTransfoChebyshev, lsst::jointcal::MagnitudeTransfoSpatiallyInvariant, and lsst::jointcal::FluxTransfoSpatiallyInvariant.

◆ dump()

virtual void lsst::jointcal::PhotometryTransfo::dump ( std::ostream stream = std::cout) const
pure virtual

dumps the transfo coefficients to stream.

Implemented in lsst::jointcal::PhotometryTransfoChebyshev, and lsst::jointcal::PhotometryTransfoSpatiallyInvariant.

◆ getNpar()

virtual int lsst::jointcal::PhotometryTransfo::getNpar ( ) const
pure virtual

Return the number of parameters (used to compute chisq)

Implemented in lsst::jointcal::PhotometryTransfoChebyshev, and lsst::jointcal::PhotometryTransfoSpatiallyInvariant.

◆ getParameters()

virtual Eigen::VectorXd lsst::jointcal::PhotometryTransfo::getParameters ( ) const
pure virtual

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

Implemented in lsst::jointcal::PhotometryTransfoChebyshev, and lsst::jointcal::PhotometryTransfoSpatiallyInvariant.

◆ offsetParams()

virtual void lsst::jointcal::PhotometryTransfo::offsetParams ( Eigen::VectorXd const &  delta)
pure virtual

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.

Implemented in lsst::jointcal::PhotometryTransfoChebyshev, and lsst::jointcal::PhotometryTransfoSpatiallyInvariant.

◆ transform() [1/2]

virtual double lsst::jointcal::PhotometryTransfo::transform ( double  x,
double  y,
double  value 
) const
pure virtual

◆ transform() [2/2]

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

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

Definition at line 35 of file PhotometryTransfo.h.

◆ transformError() [1/2]

virtual double lsst::jointcal::PhotometryTransfo::transformError ( double  x,
double  y,
double  value,
double  valueErr 
) const
pure virtual

◆ transformError() [2/2]

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

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

Definition at line 41 of file PhotometryTransfo.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream s,
PhotometryTransfo const &  transfo 
)
friend

Definition at line 48 of file PhotometryTransfo.h.


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