Relates transform(s) to their position in the fitting matrix and allows interaction with the transform(s). More...

#include <PhotometryMapping.h>

Inheritance diagram for lsst::jointcal::PhotometryMappingBase:

Public Member Functions
	PhotometryMappingBase ()

virtual	~PhotometryMappingBase ()

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

	PhotometryMappingBase (PhotometryMappingBase &&)=delete

PhotometryMappingBase &	operator= (PhotometryMappingBase const &)=delete

PhotometryMappingBase &	operator= (PhotometryMappingBase &&)=delete

virtual std::size_t	getNpar () const =0
	Number of total parameters in this mapping. More...

virtual double	transform (MeasuredStar const &measuredStar, double value) const =0
	Return the on-sky transformed flux for measuredStar on ccdImage. More...

virtual double	transformError (MeasuredStar const &measuredStar, double value, double valueErr) const =0
	Return the on-sky transformed flux uncertainty for measuredStar on ccdImage. More...

virtual void	freezeErrorTransform ()=0
	Once this routine has been called, the error transform is not modified by offsetParams(). More...

virtual void	computeParameterDerivatives (MeasuredStar const &measuredStar, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const =0
	Compute the derivatives with respect to the parameters (i.e. More...

void	setFixed (bool _fixed)
	Make this mapping's parameters fixed (i.e. not varied during fitting). More...

bool	isFixed ()

virtual Eigen::VectorXd	getParameters ()=0

virtual void	getMappingIndices (IndexVector &indices) const =0
	Gets how this set of parameters (of length getNpar()) map into the "grand" fit. More...

virtual void	print (std::ostream &out) const =0
	Print a string representation of the contents of this mapping, for debugging. More...

Eigen::Index	getIndex ()
	Get the index of this mapping in the grand fit. More...

void	setIndex (Eigen::Index i)
	Set the index of this mapping in the grand fit. More...

Protected Attributes
Eigen::Index	index

bool	fixed

Detailed Description

Relates transform(s) to their position in the fitting matrix and allows interaction with the transform(s).

Definition at line 44 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ PhotometryMappingBase() [1/3]

lsst::jointcal::PhotometryMappingBase::PhotometryMappingBase ( )

inline

Definition at line 46 of file PhotometryMapping.h.

46 : index(-1), fixed(false) {}

lsst::jointcal::PhotometryMappingBase::index

Eigen::Index index

Definition: PhotometryMapping.h:127

lsst::jointcal::PhotometryMappingBase::fixed

bool fixed

Definition: PhotometryMapping.h:129

◆ ~PhotometryMappingBase()

virtual lsst::jointcal::PhotometryMappingBase::~PhotometryMappingBase ( )

inlinevirtual

Definition at line 47 of file PhotometryMapping.h.

47 {};

◆ PhotometryMappingBase() [2/3]

lsst::jointcal::PhotometryMappingBase::PhotometryMappingBase ( PhotometryMappingBase const & )

delete

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

◆ PhotometryMappingBase() [3/3]

lsst::jointcal::PhotometryMappingBase::PhotometryMappingBase ( PhotometryMappingBase && )

delete

Member Function Documentation

◆ computeParameterDerivatives()

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

pure virtual

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.

Implemented in lsst::jointcal::ChipVisitMagnitudeMapping, lsst::jointcal::ChipVisitFluxMapping, and lsst::jointcal::PhotometryMapping.

◆ freezeErrorTransform()

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

pure virtual

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.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ getIndex()

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

inline

Get the index of this mapping in the grand fit.

Definition at line 120 of file PhotometryMapping.h.

120 { return index; }

◆ getMappingIndices()

virtual void lsst::jointcal::PhotometryMappingBase::getMappingIndices ( IndexVector & indices ) const

pure virtual

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

Expects that indices has enough space reserved.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ getNpar()

virtual std::size_t lsst::jointcal::PhotometryMappingBase::getNpar ( ) const

pure virtual

Number of total parameters in this mapping.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ getParameters()

virtual Eigen::VectorXd lsst::jointcal::PhotometryMappingBase::getParameters ( )

pure virtual

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ isFixed()

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

inline

Definition at line 101 of file PhotometryMapping.h.

101 { return fixed; }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ print()

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

pure virtual

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.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ setFixed()

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

inline

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

Definition at line 100 of file PhotometryMapping.h.

100 { fixed = _fixed; }

◆ setIndex()

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

inline

Set the index of this mapping in the grand fit.

Definition at line 123 of file PhotometryMapping.h.

123 { index = i; }

◆ transform()

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

pure virtual

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.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ transformError()

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

pure virtual

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.

Implemented in lsst::jointcal::ChipVisitMagnitudeMapping, lsst::jointcal::ChipVisitFluxMapping, and lsst::jointcal::PhotometryMapping.

Member Data Documentation

◆ fixed

bool lsst::jointcal::PhotometryMappingBase::fixed

protected

Definition at line 129 of file PhotometryMapping.h.

◆ index

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

protected

Definition at line 127 of file PhotometryMapping.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/include/lsst/jointcal/PhotometryMapping.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PhotometryMappingBase() [1/3]

◆ ~PhotometryMappingBase()

◆ PhotometryMappingBase() [2/3]

◆ PhotometryMappingBase() [3/3]

Member Function Documentation

◆ computeParameterDerivatives()

◆ freezeErrorTransform()

◆ getIndex()

◆ getMappingIndices()

◆ getNpar()

◆ getParameters()

◆ isFixed()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print()

◆ setFixed()

◆ setIndex()

◆ transform()

◆ transformError()

Member Data Documentation

◆ fixed

◆ index