lsst.jointcal  14.0-25-g01ea59d+1
Public Member Functions | Protected Member Functions | Friends | List of all members
lsst::jointcal::PhotometryTransfoSpatiallyInvariant Class Reference

#include <PhotometryTransfo.h>

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

Public Member Functions

 PhotometryTransfoSpatiallyInvariant (double value=1)
 
double transform (double x, double y, double instFlux) const override
 Apply the transform to instFlux at (x,y), put result in flux. 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...
 
std::shared_ptr< PhotometryTransfoclone () const override
 return a copy (allocated by new) of the transformation. More...
 
void computeParameterDerivatives (double x, double y, double instFlux, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e. 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 instFlux) const
 Return the transformed instFlux at (x,y). More...
 

Protected Member Functions

void setValue (double value)
 

Friends

class PhotometryTransfo
 

Detailed Description

Definition at line 86 of file PhotometryTransfo.h.

Constructor & Destructor Documentation

◆ PhotometryTransfoSpatiallyInvariant()

lsst::jointcal::PhotometryTransfoSpatiallyInvariant::PhotometryTransfoSpatiallyInvariant ( double  value = 1)
inline

Definition at line 88 of file PhotometryTransfo.h.

Member Function Documentation

◆ clone()

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

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

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 103 of file PhotometryTransfo.h.

◆ computeParameterDerivatives()

void lsst::jointcal::PhotometryTransfoSpatiallyInvariant::computeParameterDerivatives ( double  x,
double  y,
double  instFlux,
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]instFluxThe instrument flux 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 108 of file PhotometryTransfo.h.

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

◆ getNpar()

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

Return the number of parameters (used to compute chisq)

Reimplemented from lsst::jointcal::PhotometryTransfo.

Definition at line 97 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 115 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 100 of file PhotometryTransfo.h.

◆ setValue()

void lsst::jointcal::PhotometryTransfoSpatiallyInvariant::setValue ( double  value)
inlineprotected

Definition at line 122 of file PhotometryTransfo.h.

◆ transform() [1/2]

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

Return the transformed instFlux at (x,y).

Definition at line 39 of file PhotometryTransfo.h.

◆ transform() [2/2]

double lsst::jointcal::PhotometryTransfoSpatiallyInvariant::transform ( double  x,
double  y,
double  instFlux 
) const
inlineoverridevirtual

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

Implements lsst::jointcal::PhotometryTransfo.

Definition at line 91 of file PhotometryTransfo.h.

Friends And Related Function Documentation

◆ PhotometryTransfo

friend class PhotometryTransfo
friend

Definition at line 124 of file PhotometryTransfo.h.


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