lsst.jointcal  14.0-17-ge3cc87b+1
Public Member Functions | Friends | List of all members
lsst::jointcal::PhotometryTransfo Class Referenceabstract

#include <PhotometryTransfo.h>

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

Public Member Functions

virtual double transform (double x, double y, double instFlux) const =0
 Apply the transform to instFlux at (x,y), put result in flux. More...
 
double transform (Point const &in, double instFlux) const
 Return the transformed instFlux at (x,y). More...
 
virtual void dump (std::ostream &stream=std::cout) const =0
 dumps the transfo coefficients to stream. More...
 
virtual int getNpar () const
 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 instFlux, 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

Definition at line 33 of file PhotometryTransfo.h.

Member Function Documentation

◆ clone()

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

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

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

◆ computeParameterDerivatives()

virtual void lsst::jointcal::PhotometryTransfo::computeParameterDerivatives ( double  x,
double  y,
double  instFlux,
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]instFluxThe instrument flux to compute the derivative at.
[out]derivativesThe computed derivatives, in the same order as the deltas in offsetParams.

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

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

Return the number of parameters (used to compute chisq)

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

Definition at line 50 of file PhotometryTransfo.h.

◆ 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  instFlux 
) const
pure virtual

Apply the transform to instFlux at (x,y), put result in flux.

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

◆ transform() [2/2]

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

Return the transformed instFlux at (x,y).

Definition at line 39 of file PhotometryTransfo.h.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 44 of file PhotometryTransfo.h.


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