lsst::jointcal::PhotometryTransformSpatiallyInvariant Class Reference

Photometry offset independent of position. More...

#include <PhotometryTransform.h>

Inheritance diagram for lsst::jointcal::PhotometryTransformSpatiallyInvariant:

Public Member Functions
	PhotometryTransformSpatiallyInvariant (double value)
void	print (std::ostream &out) const override
	Print the transform coefficients to stream.
std::size_t	getNpar () const override
	Return the number of parameters (used to compute chisq)
void	offsetParams (Eigen::VectorXd const &delta) override
	Offset the parameters by some (negative) amount during fitting.
Eigen::VectorXd	getParameters () const override
	Get a copy of the parameters of this model, in the same order as offsetParams.
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 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.

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.

: _value(value) {}

Member Function Documentation

clone()

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

pure virtualinherited

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

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

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]	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::FluxTransformSpatiallyInvariant, lsst::jointcal::MagnitudeTransformSpatiallyInvariant, lsst::jointcal::FluxTransformChebyshev, and lsst::jointcal::MagnitudeTransformChebyshev.

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.

{ 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.

                                                 {
        Eigen::VectorXd parameters(1);
        parameters[0] = _value;
        return parameters;
    }

getValue()

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

inlineprotected

Definition at line 134 of file PhotometryTransform.h.

{ 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.

{ _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.

                                               {
        out << "PhotometryTransformSpatiallyInvariant: " << std::setprecision(10) << _value;
    }

transform() [1/2]

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

pure virtualinherited

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

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

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.

{ 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 virtualinherited

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

inlineinherited

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

Definition at line 64 of file PhotometryTransform.h.

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

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+ed77629bff/include/lsst/jointcal/PhotometryTransform.h