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
Exposure.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008, 2009, 2010, 2011 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 #ifndef AFW_TABLE_Exposure_h_INCLUDED
24 #define AFW_TABLE_Exposure_h_INCLUDED
25 
26 #include "lsst/geom/Box.h"
27 #include "lsst/geom/SpherePoint.h"
28 #include "lsst/afw/fitsDefaults.h"
35 
36 namespace lsst {
37 namespace afw {
38 
39 namespace image {
40 class PhotoCalib;
41 class ApCorrMap;
42 class VisitInfo;
43 class TransmissionCurve;
44 } // namespace image
45 
46 namespace detection {
47 class Psf;
48 } // namespace detection
49 
50 namespace geom {
51 class SkyWcs;
52 namespace polygon {
53 class Polygon;
54 }
55 } // namespace geom
56 
57 namespace cameraGeom {
58 class Detector;
59 } // namespace cameraGeom
60 
61 namespace table {
62 
63 class ExposureRecord;
64 class ExposureTable;
65 
66 template <typename RecordT>
67 class ExposureCatalogT;
68 
69 namespace io {
70 
71 class OutputArchiveHandle;
72 class InputArchive;
73 
74 } // namespace io
75 
79 class ExposureRecord : public BaseRecord {
80 public:
85 
96  BaseRecord(token, std::move(data))
97  {}
98 
100  return std::static_pointer_cast<ExposureTable const>(BaseRecord::getTable());
101  }
102 
103  RecordId getId() const;
104  void setId(RecordId id);
105 
106  lsst::geom::Box2I getBBox() const;
107  void setBBox(lsst::geom::Box2I const& bbox);
108 
119  bool contains(lsst::geom::SpherePoint const& coord, bool includeValidPolygon = false) const;
120 
131  bool contains(lsst::geom::Point2D const& point, geom::SkyWcs const& wcs,
132  bool includeValidPolygon = false) const;
133 
135  std::shared_ptr<geom::SkyWcs const> getWcs() const { return _wcs; }
138 
141 
144 
147 
149  void setValidPolygon(std::shared_ptr<geom::polygon::Polygon const> polygon) { _validPolygon = polygon; }
150 
153 
155  return _transmissionCurve;
156  }
158  _transmissionCurve = std::move(transmissionCurve);
159  }
160 
163  _detector = std::move(detector);
164  }
166 
167  ExposureRecord(ExposureRecord const&) = delete;
171  ~ExposureRecord() override;
172 
173 protected:
174 
175  void _assign(BaseRecord const& other) override;
176 
177 private:
178  friend class ExposureTable;
179 
188 };
189 
195 class ExposureTable : public BaseTable {
196 public:
201 
208 
217  Schema r = getMinimalSchema().schema;
218  r.disconnectAliases();
219  return r;
220  }
221 
228  static bool checkSchema(Schema const& other) { return other.contains(getMinimalSchema().schema); }
229 
231 
237  static Key<RecordId> getIdKey() { return getMinimalSchema().id; }
239  static PointKey<int> getBBoxMinKey() { return getMinimalSchema().bbox.getMin(); }
241  static PointKey<int> getBBoxMaxKey() { return getMinimalSchema().bbox.getMax(); }
243  static Box2IKey getBBoxKey() { return getMinimalSchema().bbox; }
245 
247  std::shared_ptr<ExposureTable> clone() const { return std::static_pointer_cast<ExposureTable>(_clone()); }
248 
251  return std::static_pointer_cast<ExposureRecord>(_makeRecord());
252  }
253 
256  return std::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other));
257  }
258 
261  return std::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other, mapper));
262  }
263 
266  ~ExposureTable() override;
267 
268 protected:
269  explicit ExposureTable(Schema const& schema);
270 
272  ExposureTable(ExposureTable&& other);
273 
274  std::shared_ptr<BaseTable> _clone() const override;
275 
277 
278 private:
279  // Struct that holds the minimal schema and the special keys we've added to it.
280  struct MinimalSchema {
281  Schema schema;
283  Box2IKey bbox;
284 
285  MinimalSchema();
286  };
287 
288  // Return the singleton minimal schema.
289  static MinimalSchema& getMinimalSchema();
290 
291  friend class io::FitsWriter;
292 
293  template <typename RecordT>
294  friend class ExposureCatalogT;
295 
296  // Return a writer object that knows how to save in FITS format. See also FitsWriter.
297  std::shared_ptr<io::FitsWriter> makeFitsWriter(fits::Fits* fitsfile, int flags) const override;
298 
299  std::shared_ptr<io::FitsWriter> makeFitsWriter(fits::Fits* fitsfile,
301  int flags) const;
302 };
303 
310 template <typename RecordT>
311 class ExposureCatalogT : public SortedCatalogT<RecordT> {
313 
314 public:
315  using Record = RecordT;
316  using Table = typename Record::Table;
317 
318  using iterator = typename Base::iterator;
320 
328 
330  explicit ExposureCatalogT(Schema const& schema) : Base(schema) {}
331 
342  template <typename InputIterator>
343  ExposureCatalogT(std::shared_ptr<Table> const& table, InputIterator first, InputIterator last,
344  bool deep = false)
345  : Base(table, first, last, deep) {}
346 
353  template <typename OtherRecordT>
355 
360  ~ExposureCatalogT() = default;
361 
362  using Base::writeFits;
363 
371  void writeFits(fits::Fits& fitsfile, std::shared_ptr<io::OutputArchive> archive, int flags = 0) const {
372  std::shared_ptr<io::FitsWriter> writer = this->getTable()->makeFitsWriter(&fitsfile, archive, flags);
373  writer->write(*this);
374  }
375 
386  static ExposureCatalogT readFits(std::string const& filename, int hdu = fits::DEFAULT_HDU,
387  int flags = 0) {
388  return io::FitsReader::apply<ExposureCatalogT>(filename, hdu, flags);
389  }
390 
402  int flags = 0) {
403  return io::FitsReader::apply<ExposureCatalogT>(manager, hdu, flags);
404  }
405 
413  static ExposureCatalogT readFits(fits::Fits& fitsfile, int flags = 0) {
414  return io::FitsReader::apply<ExposureCatalogT>(fitsfile, flags);
415  }
416 
424  int flags = 0) {
425  return io::FitsReader::apply<ExposureCatalogT>(fitsfile, flags, archive);
426  }
427 
435  void writeToArchive(io::OutputArchiveHandle& handle, bool ignoreUnpersistable = true) const;
436 
443  static ExposureCatalogT readFromArchive(io::InputArchive const& archive, BaseCatalog const& catalog);
444 
450  ExposureCatalogT<RecordT> subset(ndarray::Array<bool const, 1> const& mask) const {
452  }
453 
459  return ExposureCatalogT(Base::subset(startd, stopd, step));
460  }
461 
471  bool includeValidPolygon = false) const;
472 
481  ExposureCatalogT subsetContaining(lsst::geom::Point2D const& point, geom::SkyWcs const& wcs,
482  bool includeValidPolygon = false) const;
483 
484 protected:
485  explicit ExposureCatalogT(Base const& other) : Base(other) {}
486 };
487 
491 
494 } // namespace table
495 } // namespace afw
496 } // namespace lsst
497 
498 #endif // !AFW_TABLE_Exposure_h_INCLUDED
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
char * data
Definition: BaseRecord.cc:61
int const step
table::Key< int > id
Definition: Detector.cc:162
table::Key< int > detector
afw::table::Key< afw::table::Array< MaskPixelT > > mask
SchemaMapper * mapper
Definition: SchemaMapper.cc:71
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:66
table::Schema schema
Definition: python.h:134
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
Column-wise view into a sequence of records that have been allocated contiguously.
Base class for all records.
Definition: BaseRecord.h:31
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:164
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition: BaseRecord.h:151
std::shared_ptr< BaseTable const > getTable() const
Return the table this record is associated with.
Definition: BaseRecord.h:83
Base class for all tables.
Definition: BaseTable.h:61
std::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: BaseTable.cc:128
Iterator class for CatalogT.
Definition: Catalog.h:40
typename Record::Table Table
Definition: Catalog.h:103
std::shared_ptr< Table > getTable() const
Return the table associated with the catalog.
Definition: Catalog.h:115
void writeFits(std::string const &filename, std::string const &mode="w", int flags=0) const
Write a FITS binary table to a regular file.
Definition: Catalog.h:311
Custom catalog class for ExposureRecord/Table.
Definition: Exposure.h:311
ExposureCatalogT(ExposureCatalogT &&)=default
static ExposureCatalogT readFits(std::string const &filename, int hdu=fits::DEFAULT_HDU, int flags=0)
Read a FITS binary table from a regular file.
Definition: Exposure.h:386
static ExposureCatalogT readFits(fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU, int flags=0)
Read a FITS binary table from a RAM file.
Definition: Exposure.h:401
ExposureCatalogT(Base const &other)
Definition: Exposure.h:485
ExposureCatalogT(ExposureCatalogT const &)=default
ExposureCatalogT(std::shared_ptr< Table > const &table, InputIterator first, InputIterator last, bool deep=false)
Construct a vector from a table and an iterator range.
Definition: Exposure.h:343
ExposureCatalogT< RecordT > subset(ndarray::Array< bool const, 1 > const &mask) const
Return the subset of a catalog corresponding to the True values of the given mask array.
Definition: Exposure.h:450
static ExposureCatalogT readFromArchive(io::InputArchive const &archive, BaseCatalog const &catalog)
Convenience input function for Persistables that contain an ExposureCatalog.
Definition: Exposure.cc:456
void writeToArchive(io::OutputArchiveHandle &handle, bool ignoreUnpersistable=true) const
Convenience output function for Persistables that contain an ExposureCatalog.
Definition: Exposure.cc:444
static ExposureCatalogT readFits(fits::Fits &fitsfile, int flags=0)
Read a FITS binary table from a file object already at the correct extension.
Definition: Exposure.h:413
ExposureCatalogT(Schema const &schema)
Construct a vector from a schema, creating a table with Table::make(schema).
Definition: Exposure.h:330
static ExposureCatalogT readFits(fits::Fits &fitsfile, std::shared_ptr< io::InputArchive > archive, int flags=0)
Read a FITS binary table from a file object already at the correct extension.
Definition: Exposure.h:423
void writeFits(fits::Fits &fitsfile, std::shared_ptr< io::OutputArchive > archive, int flags=0) const
Write a FITS binary table to an open file object.
Definition: Exposure.h:371
ExposureCatalogT subsetContaining(lsst::geom::SpherePoint const &coord, bool includeValidPolygon=false) const
Return a shallow subset of the catalog with only those records that contain the given point.
Definition: Exposure.cc:471
ExposureCatalogT subset(std::ptrdiff_t startd, std::ptrdiff_t stopd, std::ptrdiff_t step) const
Shallow copy a subset of another ExposureCatalog.
Definition: Exposure.h:458
ExposureCatalogT(std::shared_ptr< Table > const &table=std::shared_ptr< Table >())
Construct a vector from a table (or nothing).
Definition: Exposure.h:327
ExposureCatalogT & operator=(ExposureCatalogT const &)=default
ExposureCatalogT & operator=(ExposureCatalogT &&)=default
ExposureCatalogT(ExposureCatalogT< OtherRecordT > const &other)
Shallow copy constructor from a container containing a related record type.
Definition: Exposure.h:354
Record class used to store exposure metadata.
Definition: Exposure.h:79
bool contains(lsst::geom::SpherePoint const &coord, bool includeValidPolygon=false) const
Return true if the bounding box contains the given celestial coordinate point, taking into account th...
Definition: Exposure.cc:349
std::shared_ptr< image::VisitInfo const > getVisitInfo() const
Definition: Exposure.h:151
std::shared_ptr< image::ApCorrMap const > getApCorrMap() const
Definition: Exposure.h:145
std::shared_ptr< geom::SkyWcs const > getWcs() const
Get/Set the the attached Wcs, Psf, PhotoCalib, or ApCorrMap. No copies are made.
Definition: Exposure.h:136
std::shared_ptr< geom::polygon::Polygon const > getValidPolygon() const
Definition: Exposure.h:148
ExposureRecord & operator=(ExposureRecord const &)=delete
void setVisitInfo(std::shared_ptr< image::VisitInfo const > visitInfo)
Definition: Exposure.h:152
lsst::geom::Box2I getBBox() const
Definition: Exposure.cc:343
ExposureRecord & operator=(ExposureRecord &&)=delete
std::shared_ptr< ExposureTable const > getTable() const
Definition: Exposure.h:99
std::shared_ptr< image::TransmissionCurve const > getTransmissionCurve() const
Definition: Exposure.h:154
std::shared_ptr< detection::Psf const > getPsf() const
Definition: Exposure.h:139
void setTransmissionCurve(std::shared_ptr< image::TransmissionCurve const > transmissionCurve)
Definition: Exposure.h:157
ExposureRecord(ExposureRecord &&)=delete
std::shared_ptr< cameraGeom::Detector const > getDetector() const
Definition: Exposure.h:161
void setValidPolygon(std::shared_ptr< geom::polygon::Polygon const > polygon)
Definition: Exposure.h:149
ExposureRecord(ConstructionToken const &token, detail::RecordData &&data)
Constructor used by ExposureTable.
Definition: Exposure.h:95
void setApCorrMap(std::shared_ptr< image::ApCorrMap const > apCorrMap)
Definition: Exposure.h:146
void setWcs(std::shared_ptr< geom::SkyWcs const > wcs)
Definition: Exposure.h:137
ExposureRecord(ExposureRecord const &)=delete
void setBBox(lsst::geom::Box2I const &bbox)
Definition: Exposure.cc:347
std::shared_ptr< image::PhotoCalib const > getPhotoCalib() const
Definition: Exposure.h:142
void setPsf(std::shared_ptr< detection::Psf const > psf)
Definition: Exposure.h:140
void _assign(BaseRecord const &other) override
Called by assign() after transferring fields to allow subclass data members to be copied.
Definition: Exposure.cc:379
void setPhotoCalib(std::shared_ptr< image::PhotoCalib const > photoCalib)
Definition: Exposure.h:143
void setDetector(std::shared_ptr< cameraGeom::Detector const > detector)
Definition: Exposure.h:162
Table class used to store exposure metadata.
Definition: Exposure.h:195
std::shared_ptr< ExposureTable > clone() const
Return a polymorphic deep copy of the table.
Definition: Exposure.h:247
static PointKey< int > getBBoxMinKey()
Key for the minimum point of the bbox.
Definition: Exposure.h:239
ExposureTable & operator=(ExposureTable const &)=delete
std::shared_ptr< BaseRecord > _makeRecord() override
Default-construct an associated record (protected implementation).
Definition: Exposure.cc:435
std::shared_ptr< ExposureRecord > makeRecord()
Default-construct an associated record.
Definition: Exposure.h:250
std::shared_ptr< ExposureRecord > copyRecord(BaseRecord const &other, SchemaMapper const &mapper)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: Exposure.h:260
static Key< RecordId > getIdKey()
Get keys for standard fields shared by all references.
Definition: Exposure.h:237
static Box2IKey getBBoxKey()
Key for the full bbox.
Definition: Exposure.h:243
static bool checkSchema(Schema const &other)
Return true if the given schema is a valid ExposureTable schema.
Definition: Exposure.h:228
static Schema makeMinimalSchema()
Return a minimal schema for Exposure tables and records.
Definition: Exposure.h:216
ExposureTable(Schema const &schema)
Definition: Exposure.cc:403
static PointKey< int > getBBoxMaxKey()
Key for the maximum point of the bbox.
Definition: Exposure.h:241
std::shared_ptr< BaseTable > _clone() const override
Clone implementation with noncovariant return types.
Definition: Exposure.cc:431
std::shared_ptr< ExposureRecord > copyRecord(BaseRecord const &other)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: Exposure.h:255
ExposureTable & operator=(ExposureTable &&)=delete
ExposureTable(ExposureTable const &other)
static std::shared_ptr< ExposureTable > make(Schema const &schema)
Construct a new table.
Definition: Exposure.cc:394
A class used as a handle to a particular field in a table.
Definition: Key.h:53
Defines the fields and offsets for a table.
Definition: Schema.h:51
void disconnectAliases()
Sever the connection between this schema and any others with which it shares aliases.
Definition: Schema.cc:540
int contains(Schema const &other, int flags=EQUAL_KEYS) const
Test whether the given schema is a subset of this.
Definition: Schema.cc:490
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
Definition: SortedCatalog.h:42
SortedCatalogT< RecordT > subset(ndarray::Array< bool const, 1 > const &mask) const
Return the subset of a catalog corresponding to the True values of the given mask array.
typename Base::const_iterator const_iterator
Definition: SortedCatalog.h:50
typename Base::iterator iterator
Definition: SortedCatalog.h:49
Writer object for FITS binary tables.
Definition: FitsWriter.h:25
A multi-catalog archive object used to load table::io::Persistable objects.
Definition: InputArchive.h:31
An object passed to Persistable::write to allow it to persist itself.
An integer coordinate rectangle.
Definition: Box.h:55
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
T move(T... args)
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
A base class for image defects.
STL namespace.
Helper struct that contains the information passed from BaseTable to BaseRecord at construction.
Definition: BaseTable.h:32
Key< int > psf
Definition: Exposure.cc:65
Key< int > visitInfo
Definition: Exposure.cc:70
Key< int > photoCalib
Definition: Exposure.cc:67
Key< int > transmissionCurve
Definition: Exposure.cc:71
Key< int > apCorrMap
Definition: Exposure.cc:68