lsst::jointcal::SimplePolyMapping Class Reference

Mapping implementation for a polynomial transformation. More...

#include <SimpleAstrometryMapping.h>

Inheritance diagram for lsst::jointcal::SimplePolyMapping:

Public Member Functions
	~SimplePolyMapping ()=default
	SimplePolyMapping (AstrometryTransformLinear CenterAndScale, AstrometryTransformPolynomial const &transform)
	The transformation will be initialized to transform, so that the effective transformation reads transform*CenterAndScale.
	SimplePolyMapping (SimplePolyMapping const &)=delete
	No copy or move: there is only ever one instance of a given mapping (i.e.. per ccd+visit)
	SimplePolyMapping (SimplePolyMapping &&)=delete
SimplePolyMapping &	operator= (SimplePolyMapping const &)=delete
SimplePolyMapping &	operator= (SimplePolyMapping &&)=delete
void	positionDerivative (Point const &where, Eigen::Matrix2d &derivative, double epsilon) const override
	The derivative w.r.t. position.
void	computeTransformAndDerivatives (FatPoint const &where, FatPoint &outPoint, Eigen::MatrixX2d &H) const override
	Calls the transforms and implements the centering and scaling of coordinates.
void	transformPosAndErrors (FatPoint const &where, FatPoint &outPoint) const override
	The same as above but without the parameter derivatives (used to evaluate chi^2)
AstrometryTransform const &	getTransform () const override
	Access to the (fitted) transform.
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	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.
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

Mapping implementation for a polynomial transformation.

Definition at line 118 of file SimpleAstrometryMapping.h.

Constructor & Destructor Documentation

~SimplePolyMapping()

lsst::jointcal::SimplePolyMapping::~SimplePolyMapping ( )

default

SimplePolyMapping() [1/3]

lsst::jointcal::SimplePolyMapping::SimplePolyMapping	(	AstrometryTransformLinear	CenterAndScale,
		AstrometryTransformPolynomial const &	transform )

The transformation will be initialized to transform, so that the effective transformation reads transform*CenterAndScale.

Definition at line 75 of file SimpleAstrometryMapping.cc.

        : SimpleAstrometryMapping(transform), _centerAndScale(std::move(CenterAndScale)) {
    // We assume that the initialization was done properly, for example that
    // transform = pixToTangentPlane*CenterAndScale.inverted(), so we do not touch transform.
    /* store the (spatial) derivative of _centerAndScale. For the extra
       diagonal terms, just copied the ones in positionDerivatives */
    preDer(0, 0) = _centerAndScale.getCoefficient(1, 0, 0);
    preDer(1, 0) = _centerAndScale.getCoefficient(0, 1, 0);
    preDer(0, 1) = _centerAndScale.getCoefficient(1, 0, 1);
    preDer(1, 1) = _centerAndScale.getCoefficient(0, 1, 1);
 
    // check of matrix indexing (once for all)
    MatrixX2d H(3, 2);
    assert((&H(1, 0) - &H(0, 0)) == 1);
}

SimplePolyMapping() [2/3]

lsst::jointcal::SimplePolyMapping::SimplePolyMapping ( SimplePolyMapping const & )

delete

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

SimplePolyMapping() [3/3]

lsst::jointcal::SimplePolyMapping::SimplePolyMapping ( SimplePolyMapping && )

delete

Member Function Documentation

computeTransformAndDerivatives()

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

overridevirtual

Calls the transforms and implements the centering and scaling of coordinates.

Reimplemented from lsst::jointcal::SimpleAstrometryMapping.

Definition at line 109 of file SimpleAstrometryMapping.cc.

                                                                                {
    FatPoint mid;
    _centerAndScale.transformPosAndErrors(where, mid);
    transform->transformPosAndErrors(mid, outPoint);
    FatPoint tmp;
    errorProp->transformPosAndErrors(mid, tmp);
    outPoint.vx = tmp.vx;
    outPoint.vy = tmp.vy;
    outPoint.vxy = tmp.vxy;
    transform->paramDerivatives(mid, &H(0, 0), &H(0, 1));
}

freezeErrorTransform()

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

inlinevirtualinherited

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

inlineinherited

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

overridevirtualinherited

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

inlineoverridevirtualinherited

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

inlineinherited

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

Definition at line 97 of file SimpleAstrometryMapping.h.

{ return toBeFit; }

getTransform()

AstrometryTransform const & lsst::jointcal::SimplePolyMapping::getTransform ( ) const

overridevirtual

Access to the (fitted) transform.

Reimplemented from lsst::jointcal::SimpleAstrometryMapping.

Definition at line 133 of file SimpleAstrometryMapping.cc.

                                                                 {
    // Cannot fail given the contructor:
    const auto *fittedPoly =
            dynamic_cast<const AstrometryTransformPolynomial *>(&(*transform));
    actualResult = (*fittedPoly) * _centerAndScale;
    return actualResult;
}

offsetParams()

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

inlineoverridevirtualinherited

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]

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

delete

operator=() [2/2]

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

delete

positionDerivative()

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

overridevirtual

The derivative w.r.t. position.

Reimplemented from lsst::jointcal::SimpleAstrometryMapping.

Definition at line 92 of file SimpleAstrometryMapping.cc.

                                                                 {
    Point tmp = _centerAndScale.apply(where);
    errorProp->computeDerivative(tmp, *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);
    derivative = preDer * derivative;
}

print()

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

overridevirtualinherited

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 )

inlineinherited

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 )

inlineinherited

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::SimplePolyMapping::transformPosAndErrors ( FatPoint const & where, FatPoint & outPoint ) const

overridevirtual

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

Reimplemented from lsst::jointcal::SimpleAstrometryMapping.

Definition at line 122 of file SimpleAstrometryMapping.cc.

                                                                                             {
    FatPoint mid;
    _centerAndScale.transformPosAndErrors(where, mid);
    transform->transformPosAndErrors(mid, outPoint);
    FatPoint tmp;
    errorProp->transformPosAndErrors(mid, 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

protectedinherited

Definition at line 111 of file SimpleAstrometryMapping.h.

index

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

protectedinherited

Definition at line 106 of file SimpleAstrometryMapping.h.

{};

lin

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

protectedinherited

Definition at line 114 of file SimpleAstrometryMapping.h.

toBeFit

bool lsst::jointcal::SimpleAstrometryMapping::toBeFit

protectedinherited

Definition at line 105 of file SimpleAstrometryMapping.h.

transform

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

protectedinherited

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-9.0.0/Linux64/jointcal/g82479be7b0+f568feb641/include/lsst/jointcal/SimpleAstrometryMapping.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+f568feb641/src/SimpleAstrometryMapping.cc