lsst::jointcal::AstrometryModel Class Reference

Interface between AstrometryFit and the combinations of Mappings from pixels to some tangent plane (aka distortions). More...

#include <AstrometryModel.h>

Inheritance diagram for lsst::jointcal::AstrometryModel:

Public Member Functions
	AstrometryModel (LOG_LOGGER log)
std::size_t	getNpar (CcdImage const &ccdImage) const
	Return the number of parameters in the mapping of CcdImage.
virtual const AstrometryMapping *	getMapping (CcdImage const &) const =0
	Mapping associated to a given CcdImage.
virtual Eigen::Index	assignIndices (std::string const &whatToFit, Eigen::Index firstIndex)=0
	Assign indices to parameters involved in mappings, starting at firstIndex.
virtual void	offsetParams (Eigen::VectorXd const &delta)=0
	Offset the parameters by the provided amounts (by -delta).
virtual const std::shared_ptr< AstrometryTransform const >	getSkyToTangentPlane (CcdImage const &ccdImage) const =0
	The transformation used to project the positions of FittedStars.
virtual std::shared_ptr< afw::geom::SkyWcs >	makeSkyWcs (CcdImage const &ccdImage) const =0
	Make a SkyWcs that contains this model.
virtual void	freezeErrorTransform ()=0
virtual std::size_t	getTotalParameters () const =0
	Return the total number of parameters in this model.
virtual void	print (std::ostream &out) const =0
	Print a string representation of the contents of this mapping, for debugging.
virtual	~AstrometryModel ()=default
bool	validate (CcdImageList const &ccdImageList, int ndof) const
	Return true if this is a "reasonable" model.

Protected Member Functions
virtual AstrometryMapping *	findMapping (CcdImage const &ccdImage) const =0
	Return a pointer to the mapping associated with this ccdImage.

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

Detailed Description

Interface between AstrometryFit and the combinations of Mappings from pixels to some tangent plane (aka distortions).

Parameters

log	Logger to send messages to, to keep names consistent when logging.

Definition at line 51 of file AstrometryModel.h.

Constructor & Destructor Documentation

AstrometryModel()

lsst::jointcal::AstrometryModel::AstrometryModel ( LOG_LOGGER log )

inline

Definition at line 53 of file AstrometryModel.h.

: _log(std::move(log)) {}

~AstrometryModel()

virtual lsst::jointcal::AstrometryModel::~AstrometryModel ( )

virtualdefault

Member Function Documentation

assignIndices()

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

pure virtual

Assign indices to parameters involved in mappings, starting at firstIndex.

Returns the highest assigned index.

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

findMapping()

virtual AstrometryMapping * lsst::jointcal::AstrometryModel::findMapping ( CcdImage const & ccdImage ) const

protectedpure virtual

Return a pointer to the mapping associated with this ccdImage.

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

freezeErrorTransform()

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

pure virtual

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

getMapping()

virtual const AstrometryMapping * lsst::jointcal::AstrometryModel::getMapping ( CcdImage const & ) const

pure virtual

Mapping associated to a given CcdImage.

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

getNpar()

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

inline

Return the number of parameters in the mapping of CcdImage.

Definition at line 56 of file AstrometryModel.h.

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

getSkyToTangentPlane()

virtual const std::shared_ptr< AstrometryTransform const > lsst::jointcal::AstrometryModel::getSkyToTangentPlane ( CcdImage const & ccdImage ) const

pure virtual

The transformation used to project the positions of FittedStars.

This defines the coordinate system into which the Mapping of this Ccdimage maps the pixel coordinates.

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

getTotalParameters()

virtual std::size_t lsst::jointcal::AstrometryModel::getTotalParameters ( ) const

pure virtual

Return the total number of parameters in this model.

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

makeSkyWcs()

virtual std::shared_ptr< afw::geom::SkyWcs > lsst::jointcal::AstrometryModel::makeSkyWcs ( CcdImage const & ccdImage ) const

pure virtual

Make a SkyWcs that contains this model.

Parameters

ccdImage

The exposure to create the SkyWcs for.

Returns

SkyWcs containing this model.

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

offsetParams()

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

pure virtual

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

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

print()

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

Implemented in lsst::jointcal::ConstrainedAstrometryModel, and lsst::jointcal::SimpleAstrometryModel.

validate()

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

Return true if this is a "reasonable" model.

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 30 of file AstrometryModel.cc.

                                                                               {
    bool check = true;
    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::AstrometryModel::_log

protected

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

Definition at line 117 of file AstrometryModel.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+e2bd23ab8b/include/lsst/jointcal/AstrometryModel.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/jointcal/g82479be7b0+e2bd23ab8b/src/AstrometryModel.cc