lsst.jointcal  16.0-18-gdf247dd+1
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::PhotometryTransfoSpatiallyInvariant Class Referenceabstract

Photometry offset independent of position. More...

#include <PhotometryTransfo.h>

Inheritance diagram for lsst::jointcal::PhotometryTransfoSpatiallyInvariant:
lsst::jointcal::PhotometryTransfo lsst::jointcal::FluxTransfoSpatiallyInvariant lsst::jointcal::MagnitudeTransfoSpatiallyInvariant

Public Member Functions

 PhotometryTransfoSpatiallyInvariant (double value)
 
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...
 
Eigen::VectorXd getParameters () const override
 Get a copy of the parameters of this model, in the same order as offsetParams. More...
 
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 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...
 

Protected Member Functions

double getValue () const
 

Detailed Description

Photometry offset independent of position.

Abstract class.

Definition at line 87 of file PhotometryTransfo.h.

Constructor & Destructor Documentation

◆ PhotometryTransfoSpatiallyInvariant()

lsst::jointcal::PhotometryTransfoSpatiallyInvariant::PhotometryTransfoSpatiallyInvariant ( double  value)
inlineexplicit

Definition at line 89 of file PhotometryTransfo.h.

Member Function Documentation

◆ clone()

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

◆ computeParameterDerivatives()

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

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

void lsst::jointcal::PhotometryTransfoSpatiallyInvariant::dump ( std::ostream stream = std::cout) const
inlineoverridevirtual

dumps the transfo coefficients to stream.

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 92 of file PhotometryTransfo.h.

◆ getNpar()

int lsst::jointcal::PhotometryTransfoSpatiallyInvariant::getNpar ( ) const
inlineoverridevirtual

Return the number of parameters (used to compute chisq)

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 95 of file PhotometryTransfo.h.

◆ getParameters()

Eigen::VectorXd lsst::jointcal::PhotometryTransfoSpatiallyInvariant::getParameters ( ) const
inlineoverridevirtual

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

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 101 of file PhotometryTransfo.h.

◆ getValue()

double lsst::jointcal::PhotometryTransfoSpatiallyInvariant::getValue ( ) const
inlineprotected

Definition at line 108 of file PhotometryTransfo.h.

◆ offsetParams()

void lsst::jointcal::PhotometryTransfoSpatiallyInvariant::offsetParams ( Eigen::VectorXd const &  delta)
inlineoverridevirtual

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 98 of file PhotometryTransfo.h.

◆ transform() [1/2]

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

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

◆ transformError() [1/2]

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

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


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