Photometric response model which has a single photometric factor per CcdImage. More...

#include <SimplePhotometryModel.h>

Inheritance diagram for lsst::jointcal::SimplePhotometryModel:

Public Member Functions
	SimplePhotometryModel (CcdImageList const &ccdImageList, LOG_LOGGER log, double errorPedestal=0)

	SimplePhotometryModel (SimplePhotometryModel const &)=delete
	No copy or move: there is only ever one instance of a given model.

	SimplePhotometryModel (SimplePhotometryModel &&)=delete

SimplePhotometryModel &	operator= (SimplePhotometryModel const &)=delete

SimplePhotometryModel &	operator= (SimplePhotometryModel &&)=delete

Eigen::Index	assignIndices (std::string const &whatToFit, Eigen::Index firstIndex) override
	Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex.

void	offsetParams (Eigen::VectorXd const &delta) override
	Offset the parameters by the provided amounts (by -delta).

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

void	getMappingIndices (CcdImage const &ccdImage, IndexVector &indices) const override
	Get how this set of parameters (of length Npar()) map into the "grand" fit.

std::size_t	getTotalParameters () const override
	Return the total number of parameters in this model.

void	computeParameterDerivatives (MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const override
	Compute the parametric derivatives of this model.

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

	~SimplePhotometryModel ()=default

virtual void	offsetFittedStar (FittedStar &fittedStar, double delta) const =0
	Offset the appropriate flux or magnitude (by -delta).

virtual double	computeResidual (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
	Compute the residual between the model applied to a star and its associated fittedStar.

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

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

virtual double	getRefError (RefStar const &refStar) const =0
	Return the refStar error appropriate for this model (e.g. fluxErr or magErr).

virtual double	computeRefResidual (FittedStar const &fittedStar, RefStar const &refStar) const =0
	Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).

virtual std::shared_ptr< afw::image::PhotoCalib >	toPhotoCalib (CcdImage const &ccdImage) const =0
	Return the mapping of ccdImage represented as a PhotoCalib.

std::size_t	getNpar (CcdImage const &ccdImage) const
	Return the number of parameters in the mapping of CcdImage.

PhotometryMappingBase const &	getMapping (CcdImage const &ccdImage) const
	Get the mapping associated with ccdImage.

bool	validate (CcdImageList const &ccdImageList, int ndof) const
	Return true if this is a "reasonable" model.

bool	checkPositiveOnBBox (CcdImage const &ccdImage) const
	Check that the model is positive on the ccdImage bbox.

double	getErrorPedestal () const

double	tweakFluxError (jointcal::MeasuredStar const &measuredStar) const
	Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.

double	tweakMagnitudeError (jointcal::MeasuredStar const &measuredStar) const
	Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.

Protected Types
using	MapType = std::unordered_map<CcdImageKey, std::unique_ptr<PhotometryMapping>>

Protected Member Functions
PhotometryMappingBase *	findMapping (CcdImage const &ccdImage) const override
	Return the mapping associated with this ccdImage.

Protected Attributes
MapType	_myMap

LOG_LOGGER	_log
	lsst.logging instance, to be created by a subclass so that messages have consistent name.

double	errorPedestal

Detailed Description

Photometric response model which has a single photometric factor per CcdImage.

Definition at line 44 of file SimplePhotometryModel.h.

Member Typedef Documentation

◆ MapType

using lsst::jointcal::SimplePhotometryModel::MapType = std::unordered_map<CcdImageKey, std::unique_ptr<PhotometryMapping>>

protected

Definition at line 82 of file SimplePhotometryModel.h.

Constructor & Destructor Documentation

◆ SimplePhotometryModel() [1/3]

lsst::jointcal::SimplePhotometryModel::SimplePhotometryModel	(	CcdImageList const &	ccdImageList,
		LOG_LOGGER	log,
		double	errorPedestal = 0 )

inline

Definition at line 46 of file SimplePhotometryModel.h.

            : PhotometryModel(std::move(log), errorPedestal) {
        _myMap.reserve(ccdImageList.size());
    }

◆ SimplePhotometryModel() [2/3]

lsst::jointcal::SimplePhotometryModel::SimplePhotometryModel ( SimplePhotometryModel const & )

delete

No copy or move: there is only ever one instance of a given model.

◆ SimplePhotometryModel() [3/3]

lsst::jointcal::SimplePhotometryModel::SimplePhotometryModel ( SimplePhotometryModel && )

delete

◆ ~SimplePhotometryModel()

lsst::jointcal::SimplePhotometryModel::~SimplePhotometryModel ( )

default

Member Function Documentation

◆ assignIndices()

Eigen::Index lsst::jointcal::SimplePhotometryModel::assignIndices	(	std::string const &	whatToFit,
		Eigen::Index	firstIndex )

overridevirtual

Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex.

Parameters

[in]	whatToFit	String containing parameters to fit.
[in]	firstIndex	Index to start assigning at.

Returns: The highest assigned index.

Implements lsst::jointcal::PhotometryModel.

Definition at line 38 of file SimplePhotometryModel.cc.

                                                                                                 {
    Eigen::Index ipar = firstIndex;
    for (auto const &i : _myMap) {
        auto mapping = i.second.get();
        mapping->setIndex(ipar);
        ipar += mapping->getNpar();
    }
    return ipar;
}

◆ checkPositiveOnBBox()

bool lsst::jointcal::PhotometryModel::checkPositiveOnBBox ( CcdImage const & ccdImage ) const

inherited

Check that the model is positive on the ccdImage bbox.

Parameters

ccdImage The ccdImage to test.

Returns: True if the image is positive on a sampling of points of the ccdImage bbox.

Definition at line 49 of file PhotometryModel.cc.

                                                                        {
    bool check = true;
    auto bbox = ccdImage.getImageFrame();
    for (auto const &x : {bbox.xMin, bbox.getCenter().x, bbox.xMax})
        for (auto const &y : {bbox.yMin, bbox.getCenter().y, bbox.yMax}) {
            // flux, fluxErr, instFlux, instFluxErr all 1
            jointcal::MeasuredStar star(jointcal::BaseStar(x, y, 1, 1));
            star.setInstFluxAndErr(1, 1);
            double result = transform(ccdImage, star);
            // Don't short circuit so that we log every place the model is negative.
            if (result < 0) {
                LOGLS_WARN(_log, "CcdImage " << ccdImage.getName() << " is negative at (" << x << "," << y
                                             << "): " << result);
                check = false;
            }
        }
    return check;
}

◆ computeParameterDerivatives()

void lsst::jointcal::SimplePhotometryModel::computeParameterDerivatives	(	MeasuredStar const &	measuredStar,
		CcdImage const &	ccdImage,
		Eigen::VectorXd &	derivatives ) const

overridevirtual

Compute the parametric derivatives of this model.

Parameters

[in]	measuredStar	The measured star with the position and flux to compute at.
[in]	ccdImage	The ccdImage containing the measured star, to find the correct mapping.
[out]	derivatives	The computed derivatives. Must be pre-allocated to the correct size.

Implements lsst::jointcal::PhotometryModel.

Definition at line 76 of file SimplePhotometryModel.cc.

                                                                                          {
    auto mapping = findMapping(ccdImage);
    mapping->computeParameterDerivatives(measuredStar, measuredStar.getInstFlux(), derivatives);
}

◆ computeRefResidual()

virtual double lsst::jointcal::PhotometryModel::computeRefResidual	(	FittedStar const &	fittedStar,
		RefStar const &	refStar ) const

pure virtualinherited

Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ computeResidual()

virtual double lsst::jointcal::PhotometryModel::computeResidual	(	CcdImage const &	ccdImage,
		MeasuredStar const &	measuredStar ) const

pure virtualinherited

Compute the residual between the model applied to a star and its associated fittedStar.

\[ residual = Model(measuredStar) - fittedStar \]

Parameters

ccdImage	The ccdImage where measuredStar resides.
measuredStar	The measured star position to compute the residual of.

Returns: The residual.

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ findMapping()

PhotometryMappingBase * lsst::jointcal::SimplePhotometryModel::findMapping ( CcdImage const & ccdImage ) const

overrideprotectedvirtual

Return the mapping associated with this ccdImage.

Implements lsst::jointcal::PhotometryModel.

Definition at line 91 of file SimplePhotometryModel.cc.

                                                                                        {
    auto i = _myMap.find(ccdImage.getHashKey());
    if (i == _myMap.end())
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
                          "SimplePhotometryModel cannot find CcdImage " + ccdImage.getName());
    return i->second.get();
}

◆ freezeErrorTransform()

void lsst::jointcal::SimplePhotometryModel::freezeErrorTransform ( )

overridevirtual

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

Definition at line 55 of file SimplePhotometryModel.cc.

                                                 {
    for (auto &i : _myMap) {
        i.second->freezeErrorTransform();
    }
}

◆ getErrorPedestal()

double lsst::jointcal::PhotometryModel::getErrorPedestal ( ) const

inlineinherited

Definition at line 197 of file PhotometryModel.h.

197{ return errorPedestal; }

◆ getMapping()

PhotometryMappingBase const & lsst::jointcal::PhotometryModel::getMapping ( CcdImage const & ccdImage ) const

inlineinherited

Get the mapping associated with ccdImage.

Definition at line 157 of file PhotometryModel.h.

                                                                            {
        return *(findMapping(ccdImage));
    }

◆ getMappingIndices()

void lsst::jointcal::SimplePhotometryModel::getMappingIndices	(	CcdImage const &	ccdImage,
		IndexVector &	indices ) const

overridevirtual

Get how this set of parameters (of length Npar()) map into the "grand" fit.

Parameters

[in]	ccdImage	The ccdImage to look up.
[out]	indices	The indices of the mapping associated with ccdImage.

Implements lsst::jointcal::PhotometryModel.

Definition at line 61 of file SimplePhotometryModel.cc.

                                                                                    {
    auto mapping = findMapping(ccdImage);
    if (indices.size() < mapping->getNpar()) indices.resize(mapping->getNpar());
    indices[0] = mapping->getIndex();
}

◆ getNpar()

std::size_t lsst::jointcal::PhotometryModel::getNpar ( CcdImage const & ccdImage ) const

inlineinherited

Return the number of parameters in the mapping of CcdImage.

Definition at line 154 of file PhotometryModel.h.

154{ return findMapping(ccdImage)->getNpar(); }

lsst::jointcal::PhotometryMappingBase::getNpar

virtual std::size_t getNpar() const =0

Number of total parameters in this mapping.

◆ getRefError()

virtual double lsst::jointcal::PhotometryModel::getRefError ( RefStar const & refStar ) const

pure virtualinherited

Return the refStar error appropriate for this model (e.g. fluxErr or magErr).

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ getTotalParameters()

std::size_t lsst::jointcal::SimplePhotometryModel::getTotalParameters ( ) const

overridevirtual

Return the total number of parameters in this model.

Implements lsst::jointcal::PhotometryModel.

Definition at line 68 of file SimplePhotometryModel.cc.

                                                          {
    std::size_t total = 0;
    for (auto &i : _myMap) {
        total += i.second->getNpar();
    }
    return total;
}

◆ offsetFittedStar()

virtual void lsst::jointcal::PhotometryModel::offsetFittedStar	(	FittedStar &	fittedStar,
		double	delta ) const

pure virtualinherited

Offset the appropriate flux or magnitude (by -delta).

Parameters

fittedStar	The star to update.
delta	The amount to update by.

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ offsetParams()

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

overridevirtual

Offset the parameters by the provided amounts (by -delta).

The shifts are applied according to the indices given in assignIndices.

Parameters

[in] delta vector of offsets to apply

Implements lsst::jointcal::PhotometryModel.

Definition at line 48 of file SimplePhotometryModel.cc.

                                                                   {
    for (auto &i : _myMap) {
        auto mapping = i.second.get();
        mapping->offsetParams(delta.segment(mapping->getIndex(), mapping->getNpar()));
    }
}

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ print()

void lsst::jointcal::SimplePhotometryModel::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 model.

Implements lsst::jointcal::PhotometryModel.

Definition at line 83 of file SimplePhotometryModel.cc.

                                                       {
    for (auto &i : _myMap) {
        out << i.first << ": ";
        i.second->print(out);
        out << std::endl;
    }
}

◆ toPhotoCalib()

virtual std::shared_ptr< afw::image::PhotoCalib > lsst::jointcal::PhotometryModel::toPhotoCalib ( CcdImage const & ccdImage ) const

pure virtualinherited

Return the mapping of ccdImage represented as a PhotoCalib.

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ transform()

virtual double lsst::jointcal::PhotometryModel::transform	(	CcdImage const &	ccdImage,
		MeasuredStar const &	measuredStar ) const

pure virtualinherited

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

Parameters

[in]	ccdImage	The ccdImage where measuredStar resides.
	measuredStar	The measured star position to transform.

Returns: The on-sky flux transformed from instFlux at measuredStar's position.

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ transformError()

virtual double lsst::jointcal::PhotometryModel::transformError	(	CcdImage const &	ccdImage,
		MeasuredStar const &	measuredStar ) const

pure virtualinherited

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

Identical to transform() until freezeErrorTransform() is called.

Parameters

[in]	ccdImage	The ccdImage where measuredStar resides.
	measuredStar	The measured star position to transform.

Returns: The on-sky flux transformed from instFlux at measuredStar's position.

Implemented in lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::SimpleFluxModel, and lsst::jointcal::SimpleMagnitudeModel.

◆ tweakFluxError()

double lsst::jointcal::PhotometryModel::tweakFluxError ( jointcal::MeasuredStar const & measuredStar ) const

inlineinherited

Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.

Definition at line 200 of file PhotometryModel.h.

                                                                          {
        if (errorPedestal == 0) {
            return measuredStar.getInstFluxErr();
        } else {
            return std::hypot(measuredStar.getInstFluxErr(), measuredStar.getInstFlux() * errorPedestal);
        }
    }

◆ tweakMagnitudeError()

double lsst::jointcal::PhotometryModel::tweakMagnitudeError ( jointcal::MeasuredStar const & measuredStar ) const

inlineinherited

Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.

Definition at line 209 of file PhotometryModel.h.

                                                                               {
        if (errorPedestal == 0) {
            return measuredStar.getInstMagErr();
        } else {
            return std::hypot(measuredStar.getInstMagErr(), errorPedestal);
        }
    }

◆ validate()

bool lsst::jointcal::PhotometryModel::validate	(	CcdImageList const &	ccdImageList,
		int	ndof ) const

inherited

Return true if this is a "reasonable" model.

A valid photometry model is positive within each sensor's bounding box.

Parameters

ccdImageList	The ccdImages to test the model validity on.
ndof	The number of degrees of freedom in the fit, e.g. from Fitterbase.computeChi2().

Returns: True if the model is valid on all ccdImages.

Definition at line 33 of file PhotometryModel.cc.

                                                                               {
    bool check = true;
    for (auto const &ccdImage : ccdImageList) {
        // Don't short circuit so that we log every place the model is negative.
        check &= checkPositiveOnBBox(*ccdImage);
    }
    if (ndof < 0) {
        check &= false;
        LOGLS_ERROR(_log, "This model only has "
                                  << ndof << " degrees of freedom, with " << getTotalParameters()
                                  << " total parameters. Reduce the model complexity (e.g. polynomial order)"
                                     " to better match the number of measured sources.");
    }
    return check;
}

Member Data Documentation

◆ _log

LOG_LOGGER lsst::jointcal::PhotometryModel::_log

protectedinherited

lsst.logging instance, to be created by a subclass so that messages have consistent name.

Definition at line 224 of file PhotometryModel.h.

◆ _myMap

MapType lsst::jointcal::SimplePhotometryModel::_myMap

protected

Definition at line 83 of file SimplePhotometryModel.h.

◆ errorPedestal

double lsst::jointcal::PhotometryModel::errorPedestal

protectedinherited

Definition at line 227 of file PhotometryModel.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/SimplePhotometryModel.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+ed77629bff/src/SimplePhotometryModel.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MapType

Constructor & Destructor Documentation

◆ SimplePhotometryModel() [1/3]

◆ SimplePhotometryModel() [2/3]

◆ SimplePhotometryModel() [3/3]

◆ ~SimplePhotometryModel()

Member Function Documentation

◆ assignIndices()

◆ checkPositiveOnBBox()

◆ computeParameterDerivatives()

◆ computeRefResidual()

◆ computeResidual()

◆ findMapping()

◆ freezeErrorTransform()

◆ getErrorPedestal()

◆ getMapping()

◆ getMappingIndices()

◆ getNpar()

◆ getRefError()

◆ getTotalParameters()

◆ offsetFittedStar()

◆ offsetParams()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print()

◆ toPhotoCalib()

◆ transform()

◆ transformError()

◆ tweakFluxError()

◆ tweakMagnitudeError()

◆ validate()

Member Data Documentation

◆ _log

◆ _myMap

◆ errorPedestal