LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
lsst::jointcal::AstrometryModel Class Referenceabstract

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:
lsst::jointcal::ConstrainedAstrometryModel lsst::jointcal::SimpleAstrometryModel

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

Protected Member Functions

virtual AstrometryMappingfindMapping (CcdImage const &ccdImage) const =0
 Return a pointer to the mapping associated with this ccdImage. More...
 

Protected Attributes

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

Detailed Description

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

Parameters
logLogger to send messages to, to keep names consistent when logging.

Definition at line 50 of file AstrometryModel.h.

Constructor & Destructor Documentation

◆ AstrometryModel()

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

Definition at line 52 of file AstrometryModel.h.

52 : _log(log) {}
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name.

◆ ~AstrometryModel()

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

Definition at line 102 of file AstrometryModel.h.

102 {};

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::SimpleAstrometryModel, and lsst::jointcal::ConstrainedAstrometryModel.

◆ findMapping()

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

Return a pointer to the mapping associated with this ccdImage.

◆ freezeErrorTransform()

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

◆ getMapping()

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

◆ 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 55 of file AstrometryModel.h.

55 { return findMapping(ccdImage)->getNpar(); }
virtual std::size_t getNpar() const =0
Number of parameters in total.
virtual AstrometryMapping * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.

◆ 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::SimpleAstrometryModel, and lsst::jointcal::ConstrainedAstrometryModel.

◆ 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::SimpleAstrometryModel, and lsst::jointcal::ConstrainedAstrometryModel.

◆ 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
ccdImageThe exposure to create the SkyWcs for.
Returns
SkyWcs containing this model.

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

◆ 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]deltavector of offsets to apply

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

◆ 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::SimpleAstrometryModel, and lsst::jointcal::ConstrainedAstrometryModel.

◆ validate()

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

Return true if this is a "reasonable" model.

Parameters
ccdImageListThe ccdImages to test the model validity on.
ndofThe 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.

30  {
31  bool check = true;
32  if (ndof < 0) {
33  check &= false;
34  LOGLS_ERROR(_log, "This model only has "
35  << ndof << " degrees of freedom, with " << getTotalParameters()
36  << " total parameters. Reduce the model complexity (e.g. polynomial order)"
37  " to better match the number of measured sources.");
38  }
39  return check;
40 }
#define LOGLS_ERROR(logger, message)
Log a error-level message using an iostream-based interface.
Definition: Log.h:679
virtual std::size_t getTotalParameters() const =0
Return the total number of parameters in this model.

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 116 of file AstrometryModel.h.


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