lsst::jointcal::PhotometryMapping Class Reference

A mapping containing a single photometryTransform. More...

#include <PhotometryMapping.h>

Inheritance diagram for lsst::jointcal::PhotometryMapping:

Public Member Functions
	PhotometryMapping (std::shared_ptr< PhotometryTransform > transform)
	Value transform takes ownership of transform, error transform aliases it.
std::size_t	getNpar () const override
	Number of total parameters in this mapping.
double	transform (MeasuredStar const &measuredStar, double value) const override
	Return the on-sky transformed flux for measuredStar on ccdImage.
double	transformError (MeasuredStar const &measuredStar, double value, double valueErr) const override
	Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
void	freezeErrorTransform () override
	Once this routine has been called, the error transform is not modified by offsetParams().
void	computeParameterDerivatives (MeasuredStar const &measuredStar, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const override
	Compute the derivatives with respect to the parameters (i.e.
void	offsetParams (Eigen::VectorXd const &delta)
	Offset the transform parameters by delta.
Eigen::VectorXd	getParameters () override
void	getMappingIndices (IndexVector &indices) const override
	Gets how this set of parameters (of length getNpar()) map into the "grand" fit.
void	print (std::ostream &out) const override
	Print a string representation of the contents of this mapping, for debugging.
std::shared_ptr< PhotometryTransform >	getTransform () const
std::shared_ptr< PhotometryTransform >	getTransformErrors () const
void	setFixed (bool _fixed)
	Make this mapping's parameters fixed (i.e. not varied during fitting).
bool	isFixed () const
Eigen::Index	getIndex () const
	Get the index of this mapping in the grand fit.
void	setIndex (Eigen::Index i)
	Set the index of this mapping in the grand fit.

Protected Attributes
Eigen::Index	index
bool	fixed

Detailed Description

A mapping containing a single photometryTransform.

Definition at line 136 of file PhotometryMapping.h.

Constructor & Destructor Documentation

PhotometryMapping()

lsst::jointcal::PhotometryMapping::PhotometryMapping ( std::shared_ptr< PhotometryTransform > transform )

inlineexplicit

Value transform takes ownership of transform, error transform aliases it.

Call freezeErrorTransform() to unalias the error transform.

Definition at line 143 of file PhotometryMapping.h.

            : PhotometryMappingBase(), _transform(std::move(transform)), _transformErrors(_transform) {}

Member Function Documentation

computeParameterDerivatives()

void lsst::jointcal::PhotometryMapping::computeParameterDerivatives ( MeasuredStar const & measuredStar, double value, Eigen::Ref< Eigen::VectorXd > derivatives ) const

inlineoverridevirtual

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

the coefficients).

Parameters

[in]	measuredStar	The measured star position to 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::PhotometryMappingBase.

Definition at line 171 of file PhotometryMapping.h.

                                                                                         {
        if (fixed) {
            return;
        } else {
            _transform->computeParameterDerivatives(measuredStar.x, measuredStar.y, value, derivatives);
        }
    }

freezeErrorTransform()

void lsst::jointcal::PhotometryMapping::freezeErrorTransform ( )

inlineoverridevirtual

Once this routine has been called, the error transform is not modified by offsetParams().

The routine can be called when the mappings are roughly in place. After the call, the transformations used to propagate errors are no longer affected when updating the mappings. This allows an exactly linear fit, which can be necessary for some model+data combinations.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 166 of file PhotometryMapping.h.

                                         {
        _transformErrors = std::shared_ptr<PhotometryTransform>(_transform->clone());
    }

getIndex()

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

inlineinherited

Get the index of this mapping in the grand fit.

Definition at line 121 of file PhotometryMapping.h.

{ return index; }

getMappingIndices()

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

inlineoverridevirtual

Gets how this set of parameters (of length getNpar()) map into the "grand" fit.

Expects that indices has enough space reserved.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 192 of file PhotometryMapping.h.

                                                                {
        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::PhotometryMapping::getNpar ( ) const

inlineoverridevirtual

Number of total parameters in this mapping.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 147 of file PhotometryMapping.h.

                                       {
        if (fixed) {
            return 0;
        } else {
            return _transform->getNpar();
        }
    }

getParameters()

Eigen::VectorXd lsst::jointcal::PhotometryMapping::getParameters ( )

inlineoverridevirtual

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 189 of file PhotometryMapping.h.

{ return _transform->getParameters(); }

getTransform()

std::shared_ptr< PhotometryTransform > lsst::jointcal::PhotometryMapping::getTransform ( ) const

inline

Definition at line 205 of file PhotometryMapping.h.

{ return _transform; }

getTransformErrors()

std::shared_ptr< PhotometryTransform > lsst::jointcal::PhotometryMapping::getTransformErrors ( ) const

inline

Definition at line 207 of file PhotometryMapping.h.

{ return _transformErrors; }

isFixed()

bool lsst::jointcal::PhotometryMappingBase::isFixed ( ) const

inlineinherited

Definition at line 102 of file PhotometryMapping.h.

{ return fixed; }

offsetParams()

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

inline

Offset the transform parameters by delta.

Parameters

[in]

delta

vector to offset transform parameters. Same ordering as derivatives in computeParameterDerivatives();

Definition at line 186 of file PhotometryMapping.h.

{ _transform->offsetParams(delta); }

print()

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

inlineoverridevirtual

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

Definition at line 200 of file PhotometryMapping.h.

                                               {
        out << "index: " << index << " fixed: " << fixed << " ";
        _transform->print(out);
    }

setFixed()

void lsst::jointcal::PhotometryMappingBase::setFixed ( bool _fixed )

inlineinherited

Make this mapping's parameters fixed (i.e. not varied during fitting).

Definition at line 101 of file PhotometryMapping.h.

{ fixed = _fixed; }

setIndex()

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

inlineinherited

Set the index of this mapping in the grand fit.

Definition at line 124 of file PhotometryMapping.h.

{ index = i; }

transform()

double lsst::jointcal::PhotometryMapping::transform ( MeasuredStar const & measuredStar, double value ) const

inlineoverridevirtual

Return the on-sky transformed flux for measuredStar on ccdImage.

Parameters

[in]	measuredStar	The measured star position to transform.
[in]	value	The instrument flux or magnitude to transform.

Returns

The on-sky value () transformed from value at measuredStar's position.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 156 of file PhotometryMapping.h.

                                                                                    {
        return _transform->transform(measuredStar.x, measuredStar.y, value);
    }

transformError()

double lsst::jointcal::PhotometryMapping::transformError ( MeasuredStar const & measuredStar, double value, double valueErr ) const

inlineoverridevirtual

Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.

Matches the underlying PhotometryTransform's transformError() until freezeErrorTransform() is called.

Parameters

[in]	measuredStar	The measured star position to transform.
[in]	value	The flux or magnitude to transform.
[in]	valueErr	The flux or magnitude uncertainty to transform.

Returns

The on-sky value transformed from value at measuredStar's position.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 161 of file PhotometryMapping.h.

                                                                                                          {
        return _transformErrors->transformError(measuredStar.x, measuredStar.y, value, valueErr);
    }

Member Data Documentation

fixed

bool lsst::jointcal::PhotometryMappingBase::fixed

protectedinherited

Definition at line 130 of file PhotometryMapping.h.

index

Eigen::Index lsst::jointcal::PhotometryMappingBase::index

protectedinherited

Definition at line 128 of file PhotometryMapping.h.

---

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/PhotometryMapping.h