#include <PhotometryMapping.h>

Inheritance diagram for lsst::jointcal::ChipVisitMagnitudeMapping:

Public Member Functions
	ChipVisitMagnitudeMapping (std::shared_ptr< PhotometryMapping > chipMapping, std::shared_ptr< PhotometryMapping > visitMapping)

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

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

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.

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

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	setWhatToFit (bool fittingChips, bool fittingVisits)
	Set whether to fit chips or visits.

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

std::shared_ptr< PhotometryMapping >	getChipMapping () const

std::shared_ptr< PhotometryMapping >	getVisitMapping () const

std::size_t	getNParChip () const

std::size_t	getNParVisit () 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
std::size_t	_nParChip

std::size_t	_nParVisit

std::shared_ptr< PhotometryMapping >	_chipMapping

std::shared_ptr< PhotometryMapping >	_visitMapping

Eigen::Index	index

bool	fixed

Detailed Description

Definition at line 304 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ ChipVisitMagnitudeMapping()

lsst::jointcal::ChipVisitMagnitudeMapping::ChipVisitMagnitudeMapping	(	std::shared_ptr< PhotometryMapping >	chipMapping,
		std::shared_ptr< PhotometryMapping >	visitMapping )

inline

Definition at line 306 of file PhotometryMapping.h.

308 : ChipVisitPhotometryMapping(std::move(chipMapping), std::move(visitMapping)) {}

lsst::jointcal::ChipVisitPhotometryMapping::ChipVisitPhotometryMapping

ChipVisitPhotometryMapping(std::shared_ptr< PhotometryMapping > chipMapping, std::shared_ptr< PhotometryMapping > visitMapping)

Definition PhotometryMapping.h:221

std::move

T move(T... args)

Member Function Documentation

◆ computeParameterDerivatives()

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

overridevirtual

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 119 of file PhotometryMapping.cc.

                                                                                                       {
    // TODO DM-12161: possible optimization is to merge transform and computeDerivatives,
    // and/or save these intermediate calculations when transforming flux to use in derivatives.
    // Like what AstrometryMappings do with `computeTransformAndDerivatives` vs. `transformPosAndErrors`.
 
    // NOTE: See DMTN-036 for the math behind this.
    if (getNParChip() > 0 && !_chipMapping->isFixed()) {
        // The chip derivatives start at 0, independent of the full-fit indices.
        Eigen::Ref<Eigen::VectorXd> chipBlock = derivatives.segment(0, getNParChip());
        _chipMapping->getTransform()->computeParameterDerivatives(measuredStar.x, measuredStar.y, instFlux,
                                                                  chipBlock);
    }
    if (getNParVisit() > 0) {
        // The visit derivatives start at the last chip derivative, independent of the full-fit indices.
        Eigen::Ref<Eigen::VectorXd> visitBlock = derivatives.segment(getNParChip(), getNParVisit());
        _visitMapping->getTransform()->computeParameterDerivatives(
                measuredStar.getXFocal(), measuredStar.getYFocal(), instFlux, visitBlock);
    }
}

◆ freezeErrorTransform()

void lsst::jointcal::ChipVisitPhotometryMapping::freezeErrorTransform ( )

inlineoverridevirtualinherited

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 240 of file PhotometryMapping.h.

                                         {
        _chipMapping->freezeErrorTransform();
        _visitMapping->freezeErrorTransform();
    }

◆ getChipMapping()

std::shared_ptr< PhotometryMapping > lsst::jointcal::ChipVisitPhotometryMapping::getChipMapping ( ) const

inlineinherited

Definition at line 275 of file PhotometryMapping.h.

275{ return _chipMapping; }

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

121{ return index; }

lsst::jointcal::PhotometryMappingBase::index

Eigen::Index index

Definition PhotometryMapping.h:128

◆ getMappingIndices()

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

overridevirtualinherited

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 39 of file PhotometryMapping.cc.

                                                                             {
    if (indices.size() < getNpar()) indices.resize(getNpar());
    // If we're fitting the chip mapping, fill those indices.
    if (_nParChip > 0) {
        _chipMapping->getMappingIndices(indices);
    }
    // If we're fitting the visit mapping, fill those indices.
    if (_nParVisit > 0) {
        // TODO DM-12169: there is probably a better way to feed a subpart of a std::vector
        // (maybe a view or iterators?)
        IndexVector tempIndices(_visitMapping->getNpar());
        _visitMapping->getMappingIndices(tempIndices);
        // We have to insert the visit indices starting after the chip indices.
        for (std::size_t k = 0; k < _visitMapping->getNpar(); ++k) {
            indices.at(k + _nParChip) = tempIndices.at(k);
        }
    }
}

◆ getNpar()

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

inlineoverridevirtualinherited

Number of total parameters in this mapping.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 230 of file PhotometryMapping.h.

230{ return _nParChip + _nParVisit; }

◆ getNParChip()

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::getNParChip ( ) const

inlineinherited

Definition at line 278 of file PhotometryMapping.h.

278{ return _nParChip; }

◆ getNParVisit()

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::getNParVisit ( ) const

inlineinherited

Definition at line 279 of file PhotometryMapping.h.

279{ return _nParVisit; }

◆ getParameters()

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

inlineoverridevirtualinherited

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 246 of file PhotometryMapping.h.

                                           {
        Eigen::VectorXd joined(getNpar());
        joined << _chipMapping->getParameters(), _visitMapping->getParameters();
        return joined;
    }

◆ getVisitMapping()

std::shared_ptr< PhotometryMapping > lsst::jointcal::ChipVisitPhotometryMapping::getVisitMapping ( ) const

inlineinherited

Definition at line 276 of file PhotometryMapping.h.

276{ return _visitMapping; }

◆ isFixed()

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

inlineinherited

Definition at line 102 of file PhotometryMapping.h.

102{ return fixed; }

lsst::jointcal::PhotometryMappingBase::fixed

bool fixed

Definition PhotometryMapping.h:130

◆ print()

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

inlineoverridevirtualinherited

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 267 of file PhotometryMapping.h.

                                               {
        out << "index: " << index << std::endl;
        out << "chip mapping: ";
        _chipMapping->print(out);
        out << std::endl << "visit mapping: ";
        _visitMapping->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.

101{ 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.

124{ index = i; }

◆ setWhatToFit()

void lsst::jointcal::ChipVisitPhotometryMapping::setWhatToFit	(	bool	fittingChips,
		bool	fittingVisits )

inherited

Set whether to fit chips or visits.

This must be called before anything that depends on knowing the number of parameters in the fit, such as offsetParams(), getParameters(), or computeParameterDerivatives().

Parameters

fittingChips	Fit the chip transform.
fittingVisits	Fit the visit transform.

Definition at line 58 of file PhotometryMapping.cc.

                                                                                               {
    if (fittingChips) {
        _nParChip = _chipMapping->getNpar();
    } else {
        _nParChip = 0;
    }
    if (fittingVisits) {
        _nParVisit = _visitMapping->getNpar();
    } else {
        _nParVisit = 0;
    }
}

◆ transform()

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

inlineoverridevirtualinherited

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 233 of file PhotometryMapping.h.

                                                                                    {
        double temp = _chipMapping->getTransform()->transform(measuredStar.x, measuredStar.y, value);
        return _visitMapping->getTransform()->transform(measuredStar.getXFocal(), measuredStar.getYFocal(),
                                                        temp);
    }

◆ transformError()

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

overridevirtual

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.

Note: This method takes instFlux and instFluxErr: the error calculation has to use fluxes to get the math right.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 112 of file PhotometryMapping.cc.

                                                                           {
    // The transformed error is s_mout = 2.5/ln(10) * instFluxErr / instFlux
    // because the other components of the mapping (f0, the polynomials) disappear in the partial derivative.
    return 2.5 / std::log(10.0) * instFluxErr / instFlux;
}

Member Data Documentation

◆ _chipMapping

std::shared_ptr<PhotometryMapping> lsst::jointcal::ChipVisitPhotometryMapping::_chipMapping

protectedinherited

Definition at line 286 of file PhotometryMapping.h.

◆ _nParChip

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::_nParChip

protectedinherited

Definition at line 283 of file PhotometryMapping.h.

◆ _nParVisit

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::_nParVisit

protectedinherited

Definition at line 283 of file PhotometryMapping.h.

◆ _visitMapping

std::shared_ptr<PhotometryMapping> lsst::jointcal::ChipVisitPhotometryMapping::_visitMapping

protectedinherited

Definition at line 287 of file PhotometryMapping.h.

◆ 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 files:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+ed77629bff/include/lsst/jointcal/PhotometryMapping.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+ed77629bff/src/PhotometryMapping.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ChipVisitMagnitudeMapping()

Member Function Documentation

◆ computeParameterDerivatives()

◆ freezeErrorTransform()

◆ getChipMapping()

◆ getIndex()

◆ getMappingIndices()

◆ getNpar()

◆ getNParChip()

◆ getNParVisit()

◆ getParameters()

◆ getVisitMapping()

◆ isFixed()

◆ print()

◆ setFixed()

◆ setIndex()

◆ setWhatToFit()

◆ transform()

◆ transformError()

Member Data Documentation

◆ _chipMapping

◆ _nParChip

◆ _nParVisit

◆ _visitMapping

◆ fixed

◆ index