lsst::jointcal::SimpleAstrometryMapping Class Reference

Class for a simple mapping implementing a generic AstrometryTransform. More...

#include <SimpleAstrometryMapping.h>

Inheritance diagram for lsst::jointcal::SimpleAstrometryMapping:

Public Member Functions
	SimpleAstrometryMapping (AstrometryTransform const &astrometryTransform, bool toBeFit=true)
	SimpleAstrometryMapping (SimpleAstrometryMapping const &)=delete
	No copy or move: there is only ever one instance of a given mapping (i.e.. per ccd+visit)
	SimpleAstrometryMapping (SimpleAstrometryMapping &&)=delete
SimpleAstrometryMapping &	operator= (SimpleAstrometryMapping const &)=delete
SimpleAstrometryMapping &	operator= (SimpleAstrometryMapping &&)=delete
virtual void	freezeErrorTransform ()
std::size_t	getNpar () const override
	Number of parameters in total.
void	getMappingIndices (IndexVector &indices) const override
	Sets how this set of parameters (of length Npar()) map into the "grand" fit Expects that indices has enough space reserved.
void	transformPosAndErrors (FatPoint const &where, FatPoint &outPoint) const override
	The same as above but without the parameter derivatives (used to evaluate chi^2)
void	positionDerivative (Point const &where, Eigen::Matrix2d &derivative, double epsilon) const override
	The derivative w.r.t. position.
void	offsetParams (Eigen::VectorXd const &delta) override
	Remember the error scale and freeze it.
Eigen::Index	getIndex () const
	position of the parameters within the grand fitting scheme
void	setIndex (Eigen::Index i)
	Set the index of this mapping in the grand fit.
void	computeTransformAndDerivatives (FatPoint const &where, FatPoint &outPoint, Eigen::MatrixX2d &H) const override
	Actually applies the AstrometryMapping and evaluates the derivatives w.r.t the fitted parameters.
virtual AstrometryTransform const &	getTransform () const
	Access to the (fitted) transform.
bool	getToBeFit () const
	Get whether this mapping is fit as part of a Model.
void	setToBeFit (bool value)
	Set whether this Mapping is to be fit as part of a Model.
void	print (std::ostream &out) const override
	Print a string representation of the contents of this mapping, for debugging.

Protected Attributes
bool	toBeFit
Eigen::Index	index {}
std::shared_ptr< AstrometryTransform >	transform
std::shared_ptr< AstrometryTransform >	errorProp
std::unique_ptr< AstrometryTransformLinear >	lin

Detailed Description

Class for a simple mapping implementing a generic AstrometryTransform.

It uses a template rather than a pointer so that the derived classes can use the specifics of the transform. The class simplePolyMapping overloads a few routines.

Definition at line 42 of file SimpleAstrometryMapping.h.

Constructor & Destructor Documentation

SimpleAstrometryMapping() [1/3]

lsst::jointcal::SimpleAstrometryMapping::SimpleAstrometryMapping ( AstrometryTransform const & astrometryTransform, bool toBeFit = true )

inline

Definition at line 44 of file SimpleAstrometryMapping.h.

            : toBeFit(toBeFit),
              transform(astrometryTransform.clone()),
              errorProp(transform),
              lin(new AstrometryTransformLinear) {}

SimpleAstrometryMapping() [2/3]

lsst::jointcal::SimpleAstrometryMapping::SimpleAstrometryMapping ( SimpleAstrometryMapping const & )

delete

No copy or move: there is only ever one instance of a given mapping (i.e.. per ccd+visit)

SimpleAstrometryMapping() [3/3]

lsst::jointcal::SimpleAstrometryMapping::SimpleAstrometryMapping ( SimpleAstrometryMapping && )

delete

Member Function Documentation

computeTransformAndDerivatives()

void lsst::jointcal::SimpleAstrometryMapping::computeTransformAndDerivatives ( FatPoint const & where, FatPoint & outPoint, Eigen::MatrixX2d & H ) const

overridevirtual

Actually applies the AstrometryMapping and evaluates the derivatives w.r.t the fitted parameters.

This is grouped into a single call because for most models, evaluating the derivatives w.r.T parameters is not much longer than just transforming

Implements lsst::jointcal::AstrometryMapping.

Reimplemented in lsst::jointcal::SimplePolyMapping.

Definition at line 67 of file SimpleAstrometryMapping.cc.

                                                                                      {
    transformPosAndErrors(where, outPoint);
    transform->paramDerivatives(where, &H(0, 0), &H(0, 1));
}

freezeErrorTransform()

virtual void lsst::jointcal::SimpleAstrometryMapping::freezeErrorTransform ( )

inlinevirtual

Definition at line 56 of file SimpleAstrometryMapping.h.

                                        {
        // from there on, updating the transform does not change the errors.
        errorProp = transform->clone();
    }

getIndex()

Eigen::Index lsst::jointcal::SimpleAstrometryMapping::getIndex ( ) const

inline

position of the parameters within the grand fitting scheme

Definition at line 84 of file SimpleAstrometryMapping.h.

{ return index; }

getMappingIndices()

void lsst::jointcal::SimpleAstrometryMapping::getMappingIndices ( IndexVector & indices ) const

overridevirtual

Sets how this set of parameters (of length Npar()) map into the "grand" fit Expects that indices has enough space reserved.

Implements lsst::jointcal::AstrometryMapping.

Definition at line 34 of file SimpleAstrometryMapping.cc.

                                                                          {
    if (indices.size() < getNpar()) {
        indices.resize(getNpar());
    }
    for (std::size_t k = 0; k < getNpar(); ++k) {
        indices[k] = index + k;
    }
}

getNpar()

std::size_t lsst::jointcal::SimpleAstrometryMapping::getNpar ( ) const

inlineoverridevirtual

Number of parameters in total.

Implements lsst::jointcal::AstrometryMapping.

Definition at line 62 of file SimpleAstrometryMapping.h.

                                       {
        if (toBeFit)
            return transform->getNpar();
        else
            return 0;
    }

getToBeFit()

bool lsst::jointcal::SimpleAstrometryMapping::getToBeFit ( ) const

inline

Get whether this mapping is fit as part of a Model.

Definition at line 97 of file SimpleAstrometryMapping.h.

{ return toBeFit; }

getTransform()

virtual AstrometryTransform const & lsst::jointcal::SimpleAstrometryMapping::getTransform ( ) const

inlinevirtual

Access to the (fitted) transform.

Reimplemented in lsst::jointcal::SimplePolyMapping.

Definition at line 94 of file SimpleAstrometryMapping.h.

{ return *transform; }

offsetParams()

void lsst::jointcal::SimpleAstrometryMapping::offsetParams ( Eigen::VectorXd const & delta )

inlineoverridevirtual

Remember the error scale and freeze it.

Implements lsst::jointcal::AstrometryMapping.

Definition at line 79 of file SimpleAstrometryMapping.h.

                                                           {
        if (toBeFit) transform->offsetParams(delta);
    }

operator=() [1/2]

SimpleAstrometryMapping & lsst::jointcal::SimpleAstrometryMapping::operator= ( SimpleAstrometryMapping && )

delete

operator=() [2/2]

SimpleAstrometryMapping & lsst::jointcal::SimpleAstrometryMapping::operator= ( SimpleAstrometryMapping const & )

delete

positionDerivative()

void lsst::jointcal::SimpleAstrometryMapping::positionDerivative ( Point const & where, Eigen::Matrix2d & derivative, double epsilon ) const

overridevirtual

The derivative w.r.t. position.

Implements lsst::jointcal::AstrometryMapping.

Reimplemented in lsst::jointcal::SimplePolyMapping.

Definition at line 52 of file SimpleAstrometryMapping.cc.

                                                                       {
    errorProp->computeDerivative(where, *lin, epsilon);
    derivative(0, 0) = lin->getCoefficient(1, 0, 0);
    //
    /* This does not work : it was proved by rotating the frame
       see the compilation switch ROTATE_T2 in constrainedAstrometryModel.cc
    derivative(1,0) = lin->getCoefficient(1,0,1);
    derivative(0,1) = lin->getCoefficient(0,1,0);
    */
    derivative(1, 0) = lin->getCoefficient(0, 1, 0);
    derivative(0, 1) = lin->getCoefficient(1, 0, 1);
    derivative(1, 1) = lin->getCoefficient(0, 1, 1);
}

print()

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

overridevirtual

Print a string representation of the contents of this mapping, for debugging.

This string representation can be very verbose, as it contains all of the parameters of all of the transforms in this mapping.

Implements lsst::jointcal::AstrometryMapping.

Definition at line 73 of file SimpleAstrometryMapping.cc.

{ out << *transform; }

setIndex()

void lsst::jointcal::SimpleAstrometryMapping::setIndex ( Eigen::Index i )

inline

Set the index of this mapping in the grand fit.

Definition at line 87 of file SimpleAstrometryMapping.h.

{ index = i; }

setToBeFit()

void lsst::jointcal::SimpleAstrometryMapping::setToBeFit ( bool value )

inline

Set whether this Mapping is to be fit as part of a Model.

Definition at line 99 of file SimpleAstrometryMapping.h.

{ toBeFit = value; }

transformPosAndErrors()

void lsst::jointcal::SimpleAstrometryMapping::transformPosAndErrors ( FatPoint const & where, FatPoint & outPoint ) const

overridevirtual

The same as above but without the parameter derivatives (used to evaluate chi^2)

Implements lsst::jointcal::AstrometryMapping.

Reimplemented in lsst::jointcal::SimplePolyMapping.

Definition at line 43 of file SimpleAstrometryMapping.cc.

                                                                                                   {
    transform->transformPosAndErrors(where, outPoint);
    FatPoint tmp;
    errorProp->transformPosAndErrors(where, tmp);
    outPoint.vx = tmp.vx;
    outPoint.vy = tmp.vy;
    outPoint.vxy = tmp.vxy;
}

Member Data Documentation

errorProp

std::shared_ptr<AstrometryTransform> lsst::jointcal::SimpleAstrometryMapping::errorProp

protected

Definition at line 111 of file SimpleAstrometryMapping.h.

index

Eigen::Index lsst::jointcal::SimpleAstrometryMapping::index {}

protected

Definition at line 106 of file SimpleAstrometryMapping.h.

{};

lin

std::unique_ptr<AstrometryTransformLinear> lsst::jointcal::SimpleAstrometryMapping::lin

protected

Definition at line 114 of file SimpleAstrometryMapping.h.

toBeFit

bool lsst::jointcal::SimpleAstrometryMapping::toBeFit

protected

Definition at line 105 of file SimpleAstrometryMapping.h.

transform

std::shared_ptr<AstrometryTransform> lsst::jointcal::SimpleAstrometryMapping::transform

protected

Definition at line 109 of file SimpleAstrometryMapping.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/jointcal/gbb8dafda3b+e9bba80f27/include/lsst/jointcal/SimpleAstrometryMapping.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/jointcal/gbb8dafda3b+e9bba80f27/src/SimpleAstrometryMapping.cc