LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
CcdImage.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #ifndef LSST_JOINTCAL_CCD_IMAGE_H
26 #define LSST_JOINTCAL_CCD_IMAGE_H
27 
28 #include <list>
29 #include <string>
30 
32 #include "lsst/afw/table/Source.h"
33 #include "lsst/afw/geom/SkyWcs.h"
37 #include "lsst/geom/Box.h"
38 #include "lsst/geom/SpherePoint.h"
41 #include "lsst/jointcal/Frame.h"
42 
43 namespace lsst {
44 namespace jointcal {
45 
47 
48 typedef int VisitIdType;
49 typedef int CcdIdType;
51 struct CcdImageKey {
54  bool operator!=(CcdImageKey const &right) const { return !(*this == right); }
55  bool operator==(CcdImageKey const &right) const { return (visit == right.visit) && (ccd == right.ccd); }
56 };
57 // typedef std::pair<VisitIdType, CcdIdType> CcdImageKey;
58 std::ostream &operator<<(std::ostream &out, CcdImageKey const &key);
59 
64 class CcdImage {
65 public:
70  std::string const &fluxField);
71 
73  CcdImage(CcdImage const &) = delete;
74  CcdImage(CcdImage &&) = delete;
75  CcdImage &operator=(CcdImage const &) = delete;
76  CcdImage &operator=(CcdImage &&) = delete;
77 
79  std::string getName() const { return _name; }
80 
86  MeasuredStarList const &getWholeCatalog() const { return _wholeCatalog; }
87 
89 
94  MeasuredStarList const &getCatalogForFit() const { return _catalogForFit; }
95  MeasuredStarList &getCatalogForFit() { return _catalogForFit; }
97 
102  }
103 
113 
119  void setCommonTangentPoint(Point const &commonTangentPoint);
120 
126  jointcal::Point const &getCommonTangentPoint() const { return _commonTangentPoint; }
127 
129  return _pixelToCommonTangentPlane;
130  }
131 
133  return _commonTangentPlaneToTangentPlane;
134  }
135 
137  return _tangentPlaneToCommonTangentPlane;
138  }
139 
140  std::shared_ptr<AstrometryTransform> const getPixelToTangentPlane() const { return _pixelToTangentPlane; }
141 
142  std::shared_ptr<AstrometryTransform> const getSkyToTangentPlane() const { return _skyToTangentPlane; }
143 
145  CcdIdType getCcdId() const { return _ccdId; }
146 
148  VisitIdType getVisit() const { return _visit; }
149 
151 
152  CcdImageKey getHashKey() const { return CcdImageKey{_visit, _ccdId}; }
153 
155  double getAirMass() const { return _airMass; }
156 
157  double getEpoch() const { return _epoch; }
158 
161 
165  lsst::geom::SpherePoint getBoresightRaDec() const { return _boresightRaDec; }
166 
167  double getHourAngle() const { return _hourAngle; }
168 
169  double getLstObs() const { return _lstObs; }
170 
172  double getSinEta() const { return _sinEta; }
173 
175  double getCosEta() const { return _cosEta; }
176 
178  double getTanZ() const { return _tanZ; }
179 
181  Point getRefractionVector() const { return Point(_tanZ * _cosEta, _tanZ * _sinEta); }
182 
184  std::string getFilter() const { return _filter; }
185 
187  std::shared_ptr<AstrometryTransform> const getReadWcs() const { return _readWcs; }
188 
190  Frame const &getImageFrame() const { return _imageFrame; }
191 
192 private:
194  std::string const &fluxField);
195 
196  jointcal::Frame _imageFrame; // in pixels
197 
198  MeasuredStarList _wholeCatalog; // the catalog of measured objets
199  MeasuredStarList _catalogForFit;
200 
201  std::shared_ptr<AstrometryTransformSkyWcs> _readWcs; // apply goes from pix to sky
202 
203  // The following ones should probably be mostly removed.
204  // go from CommonTangentPlane to this tangent plane.
205  std::shared_ptr<AstrometryTransform> _commonTangentPlaneToTangentPlane;
206  std::shared_ptr<AstrometryTransform> _tangentPlaneToCommonTangentPlane; // reverse one
207  std::shared_ptr<AstrometryTransform> _pixelToCommonTangentPlane; // pixels -> CTP
208  std::shared_ptr<AstrometryTransform> _pixelToTangentPlane;
209 
210  std::shared_ptr<AstrometryTransform> _skyToTangentPlane;
211 
212  std::string _name;
213  CcdIdType _ccdId;
214  VisitIdType _visit;
215 
216  lsst::geom::SpherePoint _boresightRaDec;
217  double _airMass; // airmass value.
218  double _epoch; // julian epoch year (e.g. 2000.0 for J2000)
221  // refraction
222  // eta : parallactic angle, z: zenithal angle (X = 1/cos(z))
223  double _sinEta, _cosEta, _tanZ;
224  // Local Sidereal Time and hour angle of observation
225  double _lstObs, _hourAngle;
226 
227  std::string _filter;
228 
229  jointcal::Point _commonTangentPoint;
230 };
231 } // namespace jointcal
232 } // namespace lsst
233 
234 // Add our preferred hash of CcdImageKey to the std:: namespace, so it's always available "for free".
235 namespace std {
236 template <>
244  size_t operator()(lsst::jointcal::CcdImageKey const &key) const {
245  return hash<size_t>()(static_cast<size_t>(key.visit) | (static_cast<size_t>(key.ccd) << 32));
246  }
247 };
248 } // namespace std
249 
250 #endif // LSST_JOINTCAL_CCD_IMAGE_H
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
table::Key< int > detector
Implementation of the Photometric Calibration class.
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:66
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
Definition: SortedCatalog.h:42
An integer coordinate rectangle.
Definition: Box.h:55
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
MeasuredStarList const & getWholeCatalog() const
Gets the as-read catalog.
Definition: CcdImage.h:86
CcdIdType getCcdId() const
returns ccd ID
Definition: CcdImage.h:145
VisitIdType getVisit() const
returns visit ID
Definition: CcdImage.h:148
void setCommonTangentPoint(Point const &commonTangentPoint)
Sets the common tangent point and computes necessary transforms.
Definition: CcdImage.cc:168
CcdImage(afw::table::SourceCatalog &record, std::shared_ptr< lsst::afw::geom::SkyWcs > wcs, std::shared_ptr< lsst::afw::image::VisitInfo > visitInfo, lsst::geom::Box2I const &bbox, std::string const &filter, std::shared_ptr< afw::image::PhotoCalib > photoCalib, std::shared_ptr< afw::cameraGeom::Detector > detector, int visit, int ccd, std::string const &fluxField)
Definition: CcdImage.cc:111
std::shared_ptr< AstrometryTransform > const getTangentPlaneToCommonTangentPlane() const
Definition: CcdImage.h:136
CcdImage & operator=(CcdImage &&)=delete
std::shared_ptr< AstrometryTransform > const getSkyToTangentPlane() const
Definition: CcdImage.h:142
std::shared_ptr< AstrometryTransform > const getPixelToTangentPlane() const
Definition: CcdImage.h:140
double getEpoch() const
Definition: CcdImage.h:157
std::pair< int, int > countStars() const
Count the number of valid measured and reference stars that fall within this ccdImage.
Definition: CcdImage.cc:153
CcdImage & operator=(CcdImage const &)=delete
std::shared_ptr< afw::image::PhotoCalib > getPhotoCalib() const
Return the exposure's photometric calibration.
Definition: CcdImage.h:160
Frame const & getImageFrame() const
Frame in pixels.
Definition: CcdImage.h:190
void resetCatalogForFit()
Clear the catalog for fitting and set it to a copy of the whole catalog.
Definition: CcdImage.h:99
std::shared_ptr< afw::cameraGeom::Detector > getDetector() const
Definition: CcdImage.h:150
CcdImage(CcdImage const &)=delete
No move or copy: each CCD image is unique to that ccd+visit, and Associations holds all CcdImages.
double getSinEta() const
Parallactic angle.
Definition: CcdImage.h:172
Point getRefractionVector() const
Definition: CcdImage.h:181
double getHourAngle() const
Definition: CcdImage.h:167
MeasuredStarList const & getCatalogForFit() const
Gets the catalog to be used for fitting, which may have been cleaned-up.
Definition: CcdImage.h:94
std::shared_ptr< AstrometryTransform > const getReadWcs() const
the wcs read in the header. NOT updated when fitting.
Definition: CcdImage.h:187
std::string getFilter() const
return the CcdImage filter name
Definition: CcdImage.h:184
CcdImage(CcdImage &&)=delete
lsst::geom::SpherePoint getBoresightRaDec() const
Gets the boresight RA/Dec.
Definition: CcdImage.h:165
std::shared_ptr< AstrometryTransform > const getCommonTangentPlaneToTangentPlane() const
Definition: CcdImage.h:132
std::string getName() const
Return the _name that identifies this ccdImage.
Definition: CcdImage.h:79
double getLstObs() const
Definition: CcdImage.h:169
double getTanZ() const
Parallactic angle.
Definition: CcdImage.h:178
double getCosEta() const
Parallactic angle.
Definition: CcdImage.h:175
std::shared_ptr< AstrometryTransform > const getPixelToCommonTangentPlane() const
Definition: CcdImage.h:128
jointcal::Point const & getCommonTangentPoint() const
Gets the common tangent point, shared between all ccdImages.
Definition: CcdImage.h:126
CcdImageKey getHashKey() const
Definition: CcdImage.h:152
double getAirMass() const
Airmass.
Definition: CcdImage.h:155
MeasuredStarList & getCatalogForFit()
Definition: CcdImage.h:95
rectangle with sides parallel to axes.
Definition: Frame.h:38
A list of MeasuredStar. They are usually filled in Associations::createCcdImage.
Definition: MeasuredStar.h:151
A point in a plane.
Definition: Point.h:37
void copyTo(StarList< Star > &copy) const
clears copy and makes a copy of the std::list to copy
Definition: StarList.cc:68
T clear(T... args)
T right(T... args)
int VisitIdType
Definition: CcdImage.h:48
std::list< std::shared_ptr< CcdImage > > CcdImageList
Definition: CcdImage.h:46
std::ostream & operator<<(std::ostream &stream, AstrometryMapping const &mapping)
A base class for image defects.
STL namespace.
For hashing a ccdImage: the pair of (visit, ccd) IDs should be unique to each ccdImage.
Definition: CcdImage.h:51
bool operator==(CcdImageKey const &right) const
Definition: CcdImage.h:55
bool operator!=(CcdImageKey const &right) const
Definition: CcdImage.h:54
size_t operator()(lsst::jointcal::CcdImageKey const &key) const
Definition: CcdImage.h:244
Key< int > visitInfo
Definition: Exposure.cc:70
Key< int > photoCalib
Definition: Exposure.cc:67