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 Attributes | List of all members
lsst::jointcal::ConstrainedAstrometryModel Class Reference

A multi-component model, fitting mappings for sensors and visits simultaneously. More...

#include <ConstrainedAstrometryModel.h>

Inheritance diagram for lsst::jointcal::ConstrainedAstrometryModel:
lsst::jointcal::AstrometryModel

Public Member Functions

 ConstrainedAstrometryModel (CcdImageList const &ccdImageList, std::shared_ptr< ProjectionHandler const > projectionHandler, int chipOrder, int visitOrder)
 
 ConstrainedAstrometryModel (ConstrainedAstrometryModel const &)=delete
 No copy or move: there is only ever one instance of a given model (i.e. per ccd+visit) More...
 
 ConstrainedAstrometryModel (ConstrainedAstrometryModel &&)=delete
 
ConstrainedAstrometryModeloperator= (ConstrainedAstrometryModel const &)=delete
 
ConstrainedAstrometryModeloperator= (ConstrainedAstrometryModel &&)=delete
 
AstrometryMapping const * getMapping (CcdImage const &) const override
 Mapping associated to a given CcdImage. More...
 
Eigen::Index assignIndices (std::string const &whatToFit, Eigen::Index firstIndex) override
 Positions the various parameter sets into the parameter vector, starting at firstIndex. More...
 
void offsetParams (Eigen::VectorXd const &Delta) override
 Dispaches the offsets after a fit step into the actual locations of parameters. More...
 
void freezeErrorTransform () override
 From there on, measurement errors are propagated using the current transforms (and no longer evolve). More...
 
std::size_t getTotalParameters () const override
 Return the total number of parameters in this model. More...
 
AstrometryTransform const & getChipTransform (CcdIdType const chip) const
 Access to mappings. More...
 
AstrometryTransform const & getVisitTransform (VisitIdType const &visit) const
 Access to mappings. More...
 
std::vector< VisitIdTypegetVisits () const
 Access to array of visits involved in the solution. More...
 
const std::shared_ptr< AstrometryTransform const > getSkyToTangentPlane (CcdImage const &ccdImage) const override
 The mapping of sky coordinates (i.e. More...
 
std::shared_ptr< afw::geom::SkyWcsmakeSkyWcs (CcdImage const &ccdImage) const override
 Make a SkyWcs that contains this model. More...
 
void print (std::ostream &out) const override
 Print a string representation of the contents of this mapping, for debugging. More...
 
std::size_t getNpar (CcdImage const &ccdImage) const
 Return the number of parameters in the mapping of CcdImage. More...
 
bool validate (CcdImageList const &ccdImageList, int ndof) const
 Return true if this is a "reasonable" model. More...
 

Protected Attributes

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

Detailed Description

A multi-component model, fitting mappings for sensors and visits simultaneously.

This is the model used to fit mappings as the combination of a transformation depending on the chip number (instrument model) and a transformation per visit (anamorphism). The two-transformation Mapping required for this model is ChipVisitAstrometryMapping. This modeling of distortions is meant for a set of images from a single mosaic imager.

Parameters
ccdImageListThe exposures that will be fit.
projectionHandlerThe projection from "Sky" (where the "true" coordinates live) to "Tangent Plane" (where the fitting occurs).
chipOrderThe polynomial order of the pixel->focal plane mapping for each sensor.
visitOrderThe polynomial order of the focal plane->tangent plane mapping for each visit.

Definition at line 62 of file ConstrainedAstrometryModel.h.

Constructor & Destructor Documentation

◆ ConstrainedAstrometryModel() [1/3]

lsst::jointcal::ConstrainedAstrometryModel::ConstrainedAstrometryModel ( CcdImageList const &  ccdImageList,
std::shared_ptr< ProjectionHandler const >  projectionHandler,
int  chipOrder,
int  visitOrder 
)

Definition at line 64 of file ConstrainedAstrometryModel.cc.

67  : AstrometryModel(LOG_GET("lsst.jointcal.ConstrainedAstrometryModel")),
68  _skyToTangentPlane(projectionHandler) {
69  // keep track of which chip we want to hold fixed (the one closest to the middle of the focal plane)
70  double minRadius2 = std::numeric_limits<double>::infinity();
71  CcdIdType constrainedChip = -1;
72 
73  // first loop to initialize all visit and chip transforms.
74  for (auto &ccdImage : ccdImageList) {
75  const CcdImage &im = *ccdImage;
76  auto visit = im.getVisit();
77  auto chip = im.getCcdId();
78  auto visitp = _visitMap.find(visit);
79  if (visitp == _visitMap.end()) {
80  _visitMap[visit] = std::make_shared<SimplePolyMapping>(AstrometryTransformLinear(),
81  AstrometryTransformPolynomial(visitOrder));
82  }
83  auto chipp = _chipMap.find(chip);
84  if (chipp == _chipMap.end()) {
85  auto center = ccdImage->getDetector()->getCenter(afw::cameraGeom::FOCAL_PLANE);
86  double radius2 = std::pow(center.getX(), 2) + std::pow(center.getY(), 2);
87  if (radius2 < minRadius2) {
88  minRadius2 = radius2;
89  constrainedChip = chip;
90  }
91 
92  auto pixelsToFocal =
93  im.getDetector()->getTransform(afw::cameraGeom::PIXELS, afw::cameraGeom::FOCAL_PLANE);
94  Frame const &frame = im.getImageFrame();
95  // construct the chip transform by approximating the pixel->Focal afw::geom::Transform.
96  AstrometryTransformPolynomial pol =
97  AstrometryTransformPolynomial(pixelsToFocal, frame, chipOrder);
98  AstrometryTransformLinear shiftAndNormalize = normalizeCoordinatesTransform(frame);
99  _chipMap[chip] = std::make_shared<SimplePolyMapping>(shiftAndNormalize,
100  pol * shiftAndNormalize.inverted());
101  }
102  }
103 
104  // Hold the "central" chip map fixed and don't fit it, to remove a degeneracy.
105  _chipMap.at(constrainedChip)->setToBeFit(false);
106 
107  // now, second loop to set the mappings of the CCdImages
108  for (auto &ccdImage : ccdImageList) {
109  const CcdImage &im = *ccdImage;
110  auto visit = im.getVisit();
111  auto chip = im.getCcdId();
112 
113  // check that the chip_indexed part was indeed assigned
114  // (i.e. the reference visit was complete)
115  if (_chipMap.find(chip) == _chipMap.end()) {
116  LOGLS_WARN(_log, "Chip " << chip << " is missing in the reference exposure, expect troubles.");
117  AstrometryTransformLinear norm = normalizeCoordinatesTransform(im.getImageFrame());
118  _chipMap[chip] =
119  std::make_shared<SimplePolyMapping>(norm, AstrometryTransformPolynomial(chipOrder));
120  }
121  _mappings[ccdImage->getHashKey()] =
122  std::make_unique<ChipVisitAstrometryMapping>(_chipMap[chip], _visitMap[visit]);
123  }
124  LOGLS_INFO(_log, "Got " << _chipMap.size() << " chip mappings and " << _visitMap.size()
125  << " visit mappings; holding chip " << constrainedChip << " fixed ("
126  << getTotalParameters() << " total parameters).");
127  LOGLS_DEBUG(_log, "CcdImage map has " << _mappings.size() << " mappings, with "
128  << _mappings.bucket_count() << " buckets and a load factor of "
129  << _mappings.load_factor());
130 }
#define LOGLS_WARN(logger, message)
Log a warn-level message using an iostream-based interface.
Definition: Log.h:659
#define LOG_GET(logger)
Returns a Log object associated with logger.
Definition: Log.h:75
#define LOGLS_INFO(logger, message)
Log a info-level message using an iostream-based interface.
Definition: Log.h:639
#define LOGLS_DEBUG(logger, message)
Log a debug-level message using an iostream-based interface.
Definition: Log.h:619
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name.
std::size_t getTotalParameters() const override
Return the total number of parameters in this model.
T infinity(T... args)
CameraSys const FOCAL_PLANE
Focal plane coordinates: Position on a 2-d planar approximation to the focal plane (x,...
Definition: CameraSys.cc:30
CameraSysPrefix const PIXELS
Pixel coordinates: Nominal position on the entry surface of a given detector (x, y unbinned pixels).
Definition: CameraSys.cc:34
T norm(const T &x)
Definition: Integrate.h:160
AstrometryTransformLinear normalizeCoordinatesTransform(const Frame &frame)
Returns the transformation that maps the input frame along both axes to [-1,1].
T pow(T... args)

◆ ConstrainedAstrometryModel() [2/3]

lsst::jointcal::ConstrainedAstrometryModel::ConstrainedAstrometryModel ( ConstrainedAstrometryModel const &  )
delete

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

◆ ConstrainedAstrometryModel() [3/3]

lsst::jointcal::ConstrainedAstrometryModel::ConstrainedAstrometryModel ( ConstrainedAstrometryModel &&  )
delete

Member Function Documentation

◆ assignIndices()

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

Positions the various parameter sets into the parameter vector, starting at firstIndex.

This routine decodes "DistortionsChip" and "DistortionsVisit" in whatToFit.

If whatToFit contains "Distortions" and not Distortions<Something>, it is understood as both chips and visits.

Implements lsst::jointcal::AstrometryModel.

Definition at line 140 of file ConstrainedAstrometryModel.cc.

141  {
142  Eigen::Index index = firstIndex;
143  if (whatToFit.find("Distortions") == std::string::npos) {
144  LOGLS_ERROR(_log, "assignIndices was called and Distortions is *not* in whatToFit");
145  return 0;
146  }
147  // if we get here "Distortions" is in whatToFit
148  _fittingChips = (whatToFit.find("DistortionsChip") != std::string::npos);
149  _fittingVisits = (whatToFit.find("DistortionsVisit") != std::string::npos);
150  // If nothing more than "Distortions" is specified, it means all:
151  if ((!_fittingChips) && (!_fittingVisits)) {
152  _fittingChips = _fittingVisits = true;
153  }
154  if (_fittingChips)
155  for (auto &i : _chipMap) {
156  i.second->setIndex(index);
157  index += i.second->getNpar();
158  }
159  if (_fittingVisits)
160  for (auto &i : _visitMap) {
161  i.second->setIndex(index);
162  index += i.second->getNpar();
163  }
164  // Tell the mappings which derivatives they will have to fill:
165  for (auto &i : _mappings) {
166  i.second->setWhatToFit(_fittingChips, _fittingVisits);
167  }
168  return index;
169 }
#define LOGLS_ERROR(logger, message)
Log a error-level message using an iostream-based interface.
Definition: Log.h:679

◆ freezeErrorTransform()

void lsst::jointcal::ConstrainedAstrometryModel::freezeErrorTransform ( )
overridevirtual

From there on, measurement errors are propagated using the current transforms (and no longer evolve).

Implements lsst::jointcal::AstrometryModel.

Definition at line 184 of file ConstrainedAstrometryModel.cc.

184  {
185  for (auto i = _visitMap.begin(); i != _visitMap.end(); ++i) i->second->freezeErrorTransform();
186  for (auto i = _chipMap.begin(); i != _chipMap.end(); ++i) i->second->freezeErrorTransform();
187 }

◆ getChipTransform()

const AstrometryTransform & lsst::jointcal::ConstrainedAstrometryModel::getChipTransform ( CcdIdType const  chip) const

Access to mappings.

Definition at line 189 of file ConstrainedAstrometryModel.cc.

189  {
190  auto chipp = _chipMap.find(chip);
191  if (chipp == _chipMap.end()) {
192  std::stringstream errMsg;
193  errMsg << "No such chipId: " << chip << " among ";
194  outputMapKeys(_chipMap, errMsg);
195  std::cout << std::endl;
196  throw pexExcept::InvalidParameterError(errMsg.str());
197  }
198  return chipp->second->getTransform();
199 }
Reports invalid arguments.
Definition: Runtime.h:66
T endl(T... args)
T str(T... args)

◆ getMapping()

const AstrometryMapping * lsst::jointcal::ConstrainedAstrometryModel::getMapping ( CcdImage const &  ) const
overridevirtual

Mapping associated to a given CcdImage.

Implements lsst::jointcal::AstrometryModel.

Definition at line 132 of file ConstrainedAstrometryModel.cc.

132  {
133  return findMapping(ccdImage);
134 }

◆ getNpar()

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

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()

const std::shared_ptr<AstrometryTransform const> lsst::jointcal::ConstrainedAstrometryModel::getSkyToTangentPlane ( CcdImage const &  ccdImage) const
inlineoverridevirtual

The mapping of sky coordinates (i.e.

the coordinate system in which fitted stars are reported) onto the Tangent plane (into which the pixel coordinates are transformed).

Implements lsst::jointcal::AstrometryModel.

Definition at line 113 of file ConstrainedAstrometryModel.h.

114  {
115  return _skyToTangentPlane->getSkyToTangentPlane(ccdImage);
116  }

◆ getTotalParameters()

std::size_t lsst::jointcal::ConstrainedAstrometryModel::getTotalParameters ( ) const
overridevirtual

Return the total number of parameters in this model.

Implements lsst::jointcal::AstrometryModel.

Definition at line 221 of file ConstrainedAstrometryModel.cc.

221  {
222  std::size_t total = 0;
223  for (auto &i : _chipMap) {
224  total += i.second->getNpar();
225  }
226  for (auto &i : _visitMap) {
227  total += i.second->getNpar();
228  }
229  return total;
230 }

◆ getVisits()

std::vector< VisitIdType > lsst::jointcal::ConstrainedAstrometryModel::getVisits ( ) const

Access to array of visits involved in the solution.

Definition at line 202 of file ConstrainedAstrometryModel.cc.

202  {
204  res.reserve(_visitMap.size());
205  for (auto i = _visitMap.begin(); i != _visitMap.end(); ++i) res.push_back(i->first);
206  return res;
207 }
T push_back(T... args)
T reserve(T... args)

◆ getVisitTransform()

const AstrometryTransform & lsst::jointcal::ConstrainedAstrometryModel::getVisitTransform ( VisitIdType const &  visit) const

Access to mappings.

Definition at line 209 of file ConstrainedAstrometryModel.cc.

209  {
210  auto visitp = _visitMap.find(visit);
211  if (visitp == _visitMap.end()) {
212  std::stringstream errMsg;
213  errMsg << "No such visitId: " << visit << " among ";
214  outputMapKeys(_visitMap, errMsg);
215  std::cout << std::endl;
216  throw pexExcept::InvalidParameterError(errMsg.str());
217  }
218  return visitp->second->getTransform();
219 }

◆ makeSkyWcs()

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

Make a SkyWcs that contains this model.

Parameters
ccdImageThe exposure to create the SkyWcs for.
Returns
SkyWcs containing this model.

Implements lsst::jointcal::AstrometryModel.

Definition at line 232 of file ConstrainedAstrometryModel.cc.

232  {
233  auto proj = std::dynamic_pointer_cast<const TanRaDecToPixel>(getSkyToTangentPlane(ccdImage));
234  jointcal::Point tangentPoint(proj->getTangentPoint());
235 
236  auto imageFrame = ccdImage.getImageFrame();
237  auto pixelsToFocal = getChipTransform(ccdImage.getCcdId()).toAstMap(imageFrame);
238  jointcal::Frame focalBox = getChipTransform(ccdImage.getCcdId()).apply(imageFrame, false);
239  auto focalToIwc = getVisitTransform(ccdImage.getVisit()).toAstMap(focalBox);
240 
241  ast::Frame pixelFrame(2, "Domain=PIXELS");
242  ast::Frame focalFrame(2, "Domain=FOCAL");
243  ast::Frame iwcFrame(2, "Domain=IWC");
244 
245  // make a basic SkyWcs and extract the IWC portion
246  auto iwcToSkyWcs = afw::geom::makeSkyWcs(
247  geom::Point2D(0, 0), geom::SpherePoint(tangentPoint.x, tangentPoint.y, geom::degrees),
249  auto iwcToSkyMap = iwcToSkyWcs->getFrameDict()->getMapping("PIXELS", "SKY");
250  auto skyFrame = iwcToSkyWcs->getFrameDict()->getFrame("SKY");
251 
252  ast::FrameDict frameDict(pixelFrame);
253  frameDict.addFrame("PIXELS", *pixelsToFocal, focalFrame);
254  frameDict.addFrame("FOCAL", *focalToIwc, iwcFrame);
255  frameDict.addFrame("IWC", *iwcToSkyMap, *skyFrame);
256  return std::make_shared<afw::geom::SkyWcs>(frameDict);
257 }
A FrameSet whose frames can be referenced by domain name.
Definition: FrameDict.h:67
Frame is used to represent a coordinate system.
Definition: Frame.h:157
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
virtual std::shared_ptr< ast::Mapping > toAstMap(jointcal::Frame const &domain) const
Create an equivalent AST mapping for this transformation, including an analytic inverse if possible.
virtual void apply(const double xIn, const double yIn, double &xOut, double &yOut) const =0
AstrometryTransform const & getChipTransform(CcdIdType const chip) const
Access to mappings.
AstrometryTransform const & getVisitTransform(VisitIdType const &visit) const
Access to mappings.
const std::shared_ptr< AstrometryTransform const > getSkyToTangentPlane(CcdImage const &ccdImage) const override
The mapping of sky coordinates (i.e.
rectangle with sides parallel to axes.
Definition: Frame.h:38
A point in a plane.
Definition: Point.h:37
std::shared_ptr< SkyWcs > makeSkyWcs(daf::base::PropertySet &metadata, bool strip=false)
Construct a SkyWcs from FITS keywords.
Definition: SkyWcs.cc:521
Eigen::Matrix2d makeCdMatrix(lsst::geom::Angle const &scale, lsst::geom::Angle const &orientation=0 *lsst::geom::degrees, bool flipX=false)
Make a WCS CD matrix.
Definition: SkyWcs.cc:133
constexpr AngleUnit degrees
constant with units of degrees
Definition: Angle.h:109

◆ offsetParams()

void lsst::jointcal::ConstrainedAstrometryModel::offsetParams ( Eigen::VectorXd const &  Delta)
overridevirtual

Dispaches the offsets after a fit step into the actual locations of parameters.

Implements lsst::jointcal::AstrometryModel.

Definition at line 171 of file ConstrainedAstrometryModel.cc.

171  {
172  if (_fittingChips)
173  for (auto &i : _chipMap) {
174  auto mapping = i.second.get();
175  mapping->offsetParams(delta.segment(mapping->getIndex(), mapping->getNpar()));
176  }
177  if (_fittingVisits)
178  for (auto &i : _visitMap) {
179  auto mapping = i.second.get();
180  mapping->offsetParams(delta.segment(mapping->getIndex(), mapping->getNpar()));
181  }
182 }

◆ operator=() [1/2]

ConstrainedAstrometryModel& lsst::jointcal::ConstrainedAstrometryModel::operator= ( ConstrainedAstrometryModel &&  )
delete

◆ operator=() [2/2]

ConstrainedAstrometryModel& lsst::jointcal::ConstrainedAstrometryModel::operator= ( ConstrainedAstrometryModel const &  )
delete

◆ print()

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

Definition at line 259 of file ConstrainedAstrometryModel.cc.

259  {
260  out << "Constrained Astrometry Model (" << _mappings.size() << " composite mappings; " << _chipMap.size()
261  << " sensor mappings, " << _visitMap.size() << " visit mappings):" << std::endl;
262  out << *_skyToTangentPlane << std::endl;
263  out << "Sensor to sky transforms:" << std::endl;
264  for (auto &i : _mappings) {
265  out << i.first << std::endl;
266  out << *(i.second) << std::endl;
267  }
268 }

◆ validate()

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

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 }
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
protectedinherited

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: