lsst::jointcal::PhotometryTransform Class Reference

A photometric transform, defined in terms of the input flux or magnitude. More...

#include <PhotometryTransform.h>

Inheritance diagram for lsst::jointcal::PhotometryTransform:

Public Member Functions
virtual double	transform (double x, double y, double value) const =0
	Return the transform of value at (x,y).
double	transform (Point const &in, double value) const
	Return the transformed value at Point(x,y).
virtual double	transformError (double x, double y, double value, double valueErr) const =0
	Return the transformed valueErr at Point(x,y).
double	transformError (Point const &in, double value, double valueErr) const
	Return the transformed valueErr at Point(x,y).
virtual void	print (std::ostream &out) const =0
	Print the transform coefficients to stream.
virtual std::size_t	getNpar () const =0
	Return the number of parameters (used to compute chisq)
virtual void	offsetParams (Eigen::VectorXd const &delta)=0
	Offset the parameters by some (negative) amount during fitting.
virtual std::shared_ptr< PhotometryTransform >	clone () const =0
	return a copy (allocated by new) of the transformation.
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.
virtual Eigen::VectorXd	getParameters () const =0
	Get a copy of the parameters of this model, in the same order as offsetParams.
virtual	~PhotometryTransform ()=default

Friends
std::ostream &	operator<< (std::ostream &s, PhotometryTransform const &transform)

Detailed Description

A photometric transform, defined in terms of the input flux or magnitude.

Unit agnostic: a higher level Model must keep track of the units going into and out of of its Transforms.

See also

lsst::afw::image::PhotoCalib

Definition at line 52 of file PhotometryTransform.h.

Constructor & Destructor Documentation

~PhotometryTransform()

virtual lsst::jointcal::PhotometryTransform::~PhotometryTransform ( )

virtualdefault

Member Function Documentation

clone()

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

pure virtual

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

Implemented in lsst::jointcal::FluxTransformChebyshev, lsst::jointcal::FluxTransformSpatiallyInvariant, lsst::jointcal::MagnitudeTransformChebyshev, and lsst::jointcal::MagnitudeTransformSpatiallyInvariant.

computeParameterDerivatives()

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

pure virtual

Compute the derivatives with respect to the parameters (i.e.

the coefficients).

Parameters

[in]	x	The x coordinate to compute at (in the appropriate units for this transform).
[in]	y	The y coordinate to compute at (in the appropriate units for this transform).
[in]	value	The instrument flux or magnitude to compute the derivative at.
[out]	derivatives	The computed derivatives, in the same order as the deltas in offsetParams.

Implemented in lsst::jointcal::FluxTransformChebyshev, lsst::jointcal::FluxTransformSpatiallyInvariant, lsst::jointcal::MagnitudeTransformChebyshev, and lsst::jointcal::MagnitudeTransformSpatiallyInvariant.

getNpar()

virtual std::size_t lsst::jointcal::PhotometryTransform::getNpar ( ) const

pure virtual

Return the number of parameters (used to compute chisq)

Implemented in lsst::jointcal::PhotometryTransformChebyshev, and lsst::jointcal::PhotometryTransformSpatiallyInvariant.

getParameters()

virtual Eigen::VectorXd lsst::jointcal::PhotometryTransform::getParameters ( ) const

pure virtual

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

Implemented in lsst::jointcal::PhotometryTransformChebyshev, and lsst::jointcal::PhotometryTransformSpatiallyInvariant.

offsetParams()

virtual void lsst::jointcal::PhotometryTransform::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::PhotometryTransformChebyshev, and lsst::jointcal::PhotometryTransformSpatiallyInvariant.

print()

virtual void lsst::jointcal::PhotometryTransform::print ( std::ostream & out ) const

pure virtual

Print the transform coefficients to stream.

Implemented in lsst::jointcal::PhotometryTransformChebyshev, and lsst::jointcal::PhotometryTransformSpatiallyInvariant.

transform() [1/2]

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

pure virtual

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

Implemented in lsst::jointcal::FluxTransformChebyshev, lsst::jointcal::FluxTransformSpatiallyInvariant, lsst::jointcal::MagnitudeTransformChebyshev, and lsst::jointcal::MagnitudeTransformSpatiallyInvariant.

transform() [2/2]

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

inline

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

Definition at line 58 of file PhotometryTransform.h.

{ return transform(in.x, in.y, value); }

transformError() [1/2]

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

pure virtual

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

Implemented in lsst::jointcal::FluxTransformSpatiallyInvariant, lsst::jointcal::MagnitudeTransformSpatiallyInvariant, and lsst::jointcal::PhotometryTransformChebyshev.

transformError() [2/2]

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

inline

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

Definition at line 64 of file PhotometryTransform.h.

                                                                                {
        return transformError(in.x, in.y, value, valueErr);
    }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & s, PhotometryTransform const & transform )

friend

Definition at line 71 of file PhotometryTransform.h.

                                                                                       {
        transform.print(s);
        return s;
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-11.0.0/Linux/jointcal/g29ae962dfc+fb55f2edb0/include/lsst/jointcal/PhotometryTransform.h