lsst.jointcal  16.0-15-g8e16a51+14
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::MagnitudeTransfoSpatiallyInvariant Class Reference

Photometric offset independent of position, defined as -2.5 * log(flux / fluxMag0). More...

#include <PhotometryTransfo.h>

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

Public Member Functions

 MagnitudeTransfoSpatiallyInvariant (double value=0)
 
double transform (double x, double y, double mag) const override
 Return the transform of value at (x,y). More...
 
double transformError (double x, double y, double value, double valueErr) const override
 Return the transformed valueErr at Point(x,y). More...
 
std::shared_ptr< PhotometryTransfoclone () const override
 return a copy (allocated by new) of the transformation. 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...
 
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...
 
double transform (Point const &in, double value) const
 Return the transformed value at Point(x,y). More...
 
double transformError (Point const &in, double value, double valueErr) const
 Return the transformed valueErr at Point(x,y). More...
 

Protected Member Functions

double getValue () const
 

Detailed Description

Photometric offset independent of position, defined as -2.5 * log(flux / fluxMag0).

initialMagnitude + SpatiallyInvariantTransfo -> correctedMagnitude

Definition at line 152 of file PhotometryTransfo.h.

Constructor & Destructor Documentation

◆ MagnitudeTransfoSpatiallyInvariant()

lsst::jointcal::MagnitudeTransfoSpatiallyInvariant::MagnitudeTransfoSpatiallyInvariant ( double  value = 0)
inlineexplicit

Definition at line 154 of file PhotometryTransfo.h.

Member Function Documentation

◆ clone()

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

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

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 166 of file PhotometryTransfo.h.

◆ computeParameterDerivatives()

void lsst::jointcal::MagnitudeTransfoSpatiallyInvariant::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 171 of file PhotometryTransfo.h.

◆ dump()

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

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
inlineoverridevirtualinherited

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
inlineoverridevirtualinherited

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
inlineprotectedinherited

Definition at line 108 of file PhotometryTransfo.h.

◆ offsetParams()

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

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]

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::MagnitudeTransfoSpatiallyInvariant::transform ( double  x,
double  y,
double  mag 
) const
inlineoverridevirtual

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

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 158 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::MagnitudeTransfoSpatiallyInvariant::transformError ( double  x,
double  y,
double  value,
double  valueErr 
) const
inlineoverridevirtual

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

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 161 of file PhotometryTransfo.h.


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