lsst::jointcal::MagnitudeTransfoSpatiallyInvariant Class Reference

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

#include <PhotometryTransform.h>

Inheritance diagram for lsst::jointcal::MagnitudeTransfoSpatiallyInvariant:

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< PhotometryTransform >	clone () 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 transform 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 + SpatiallyInvariantTransform -> correctedMagnitude

Definition at line 175 of file PhotometryTransform.h.

Constructor & Destructor Documentation

MagnitudeTransfoSpatiallyInvariant()

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

inlineexplicit

Definition at line 177 of file PhotometryTransform.h.

            : PhotometryTransformSpatiallyInvariant(value) {}

Member Function Documentation

clone()

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

inlineoverridevirtual

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

Implements lsst::jointcal::PhotometryTransform.

Definition at line 189 of file PhotometryTransform.h.

                                                              {
        return std::make_shared<MagnitudeTransfoSpatiallyInvariant>(getValue());
    }

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

Implements lsst::jointcal::PhotometryTransform.

Definition at line 194 of file PhotometryTransform.h.

                                                                                         {
        // the derivative of a spatially constant transform w.r.t. that value is 1.
        derivatives[0] = 1;
    }

dump()

void lsst::jointcal::PhotometryTransformSpatiallyInvariant::dump ( std::ostream &  stream = std::cout ) const

inlineoverridevirtualinherited

dumps the transform coefficients to stream.

Implements lsst::jointcal::PhotometryTransform.

Definition at line 115 of file PhotometryTransform.h.

{ stream << std::setprecision(10) << _value; }

getNpar()

int lsst::jointcal::PhotometryTransformSpatiallyInvariant::getNpar ( ) const

inlineoverridevirtualinherited

Return the number of parameters (used to compute chisq)

Implements lsst::jointcal::PhotometryTransform.

Definition at line 118 of file PhotometryTransform.h.

{ return 1; }

getParameters()

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

inlineoverridevirtualinherited

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

Implements lsst::jointcal::PhotometryTransform.

Definition at line 124 of file PhotometryTransform.h.

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

getValue()

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

inlineprotectedinherited

Definition at line 131 of file PhotometryTransform.h.

{ return _value; }

offsetParams()

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

Definition at line 121 of file PhotometryTransform.h.

{ _value -= delta[0]; };

transform() [1/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); }

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::PhotometryTransform.

Definition at line 181 of file PhotometryTransform.h.

{ return mag + getValue(); }

transformError() [1/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);
    }

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::PhotometryTransform.

Definition at line 184 of file PhotometryTransform.h.

                                                                                            {
        return valueErr;
    }

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/jointcal/16.0-26-g3163dd8+5/include/lsst/jointcal/PhotometryTransform.h