LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::PhotometryTransformSpatiallyInvariant Class Referenceabstract

Photometry offset independent of position. More...

#include <PhotometryTransform.h>

Inheritance diagram for lsst::jointcal::PhotometryTransformSpatiallyInvariant:
lsst::jointcal::PhotometryTransform lsst::jointcal::FluxTransformSpatiallyInvariant lsst::jointcal::MagnitudeTransformSpatiallyInvariant

Public Member Functions

 PhotometryTransformSpatiallyInvariant (double value)
 
void print (std::ostream &out) const override
 Print the transform coefficients to stream. More...
 
std::size_t 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< PhotometryTransformclone () 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 111 of file PhotometryTransform.h.

Constructor & Destructor Documentation

◆ PhotometryTransformSpatiallyInvariant()

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

Definition at line 113 of file PhotometryTransform.h.

113 : _value(value) {}

Member Function Documentation

◆ clone()

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

◆ computeParameterDerivatives()

virtual void lsst::jointcal::PhotometryTransform::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 transform).
[in]yThe y coordinate to compute at (in the appropriate units for this transform).
[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::MagnitudeTransformChebyshev, lsst::jointcal::FluxTransformChebyshev, lsst::jointcal::MagnitudeTransformSpatiallyInvariant, and lsst::jointcal::FluxTransformSpatiallyInvariant.

◆ getNpar()

std::size_t lsst::jointcal::PhotometryTransformSpatiallyInvariant::getNpar ( ) const
inlineoverridevirtual

Return the number of parameters (used to compute chisq)

Implements lsst::jointcal::PhotometryTransform.

Definition at line 121 of file PhotometryTransform.h.

121 { return 1; }

◆ getParameters()

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

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

Implements lsst::jointcal::PhotometryTransform.

Definition at line 127 of file PhotometryTransform.h.

127  {
128  Eigen::VectorXd parameters(1);
129  parameters[0] = _value;
130  return parameters;
131  }

◆ getValue()

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

Definition at line 134 of file PhotometryTransform.h.

134 { return _value; }

◆ offsetParams()

void lsst::jointcal::PhotometryTransformSpatiallyInvariant::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::PhotometryTransform.

Definition at line 124 of file PhotometryTransform.h.

124 { _value -= delta[0]; };

◆ print()

void lsst::jointcal::PhotometryTransformSpatiallyInvariant::print ( std::ostream out) const
inlineoverridevirtual

Print the transform coefficients to stream.

Implements lsst::jointcal::PhotometryTransform.

Definition at line 116 of file PhotometryTransform.h.

116  {
117  out << "PhotometryTransformSpatiallyInvariant: " << std::setprecision(10) << _value;
118  }
T setprecision(T... args)

◆ transform() [1/2]

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

◆ transform() [2/2]

double lsst::jointcal::PhotometryTransform::transform ( Point const &  in,
double  value 
) const
inlineinherited

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

Definition at line 58 of file PhotometryTransform.h.

58 { return transform(in.x, in.y, value); }
virtual double transform(double x, double y, double value) const =0
Return the transform of value at (x,y).

◆ transformError() [1/2]

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

◆ transformError() [2/2]

double lsst::jointcal::PhotometryTransform::transformError ( Point const &  in,
double  value,
double  valueErr 
) const
inlineinherited

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

Definition at line 64 of file PhotometryTransform.h.

64  {
65  return transformError(in.x, in.y, value, valueErr);
66  }
virtual double transformError(double x, double y, double value, double valueErr) const =0
Return the transformed valueErr at Point(x,y).

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