LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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"
35
36namespace lsst {
37namespace afw {
38
39namespace image {
40class PhotoCalib;
41class ApCorrMap;
42class VisitInfo;
43class TransmissionCurve;
44} // namespace image
45
46namespace detection {
47class Psf;
48} // namespace detection
49
50namespace geom {
51class SkyWcs;
52namespace polygon {
53class Polygon;
54}
55} // namespace geom
56
57namespace cameraGeom {
58class Detector;
59} // namespace cameraGeom
60
61namespace table {
62
63class ExposureRecord;
64class ExposureTable;
65
66template <typename RecordT>
67class ExposureCatalogT;
68
69namespace io {
70
71class OutputArchiveHandle;
72class InputArchive;
73
74} // namespace io
75
79class ExposureRecord : public BaseRecord {
80public:
85
98
100 return std::static_pointer_cast<ExposureTable const>(BaseRecord::getTable());
101 }
102
103 RecordId getId() const;
104 void setId(RecordId id);
105
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
138
141
144
147
149 void setValidPolygon(std::shared_ptr<geom::polygon::Polygon const> polygon) { _validPolygon = polygon; }
150
153
155 return _transmissionCurve;
156 }
160
163 _detector = std::move(detector);
164 }
166
171 ~ExposureRecord() override;
172
173protected:
174
175 void _assign(BaseRecord const& other) override;
176
177private:
178 friend class ExposureTable;
179
188};
189
195class ExposureTable : public BaseTable {
196public:
201
207 static std::shared_ptr<ExposureTable> make(Schema const& schema);
208
217 Schema r = getMinimalSchema().schema;
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
268protected:
269 explicit ExposureTable(Schema const& schema);
270
273
274 std::shared_ptr<BaseTable> _clone() const override;
275
277
278private:
279 // Struct that holds the minimal schema and the special keys we've added to it.
280 struct MinimalSchema {
281 Schema schema;
282 Key<RecordId> id;
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.
298
301 int flags) const;
302};
303
310template <typename RecordT>
311class ExposureCatalogT : public SortedCatalogT<RecordT> {
313
314public:
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>
346
353 template <typename OtherRecordT>
355
360 ~ExposureCatalogT() = default;
361
362 using Base::writeFits;
363
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
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
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
484protected:
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
afw::table::Key< afw::table::Array< MaskPixelT > > mask
SchemaMapper * mapper
table::Key< table::Array< std::uint8_t > > wcs
Definition SkyWcs.cc:66
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition fits.h:308
Lifetime-management for memory that goes into FITS memory files.
Definition fits.h:125
Tag types used to declare specialized field types.
Definition misc.h:31
Base class for all records.
Definition BaseRecord.h:31
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:126
std::shared_ptr< Table > getTable() const
Return the table associated with the catalog.
Definition Catalog.h:114
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:310
Custom catalog class for ExposureRecord/Table.
Definition Exposure.h:311
ExposureCatalogT & operator=(ExposureCatalogT &&)=default
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
typename Base::const_iterator const_iterator
Definition Exposure.h:319
typename Record::Table Table
Definition Exposure.h:316
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 & operator=(ExposureCatalogT const &)=default
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
typename Base::iterator iterator
Definition Exposure.h:318
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< 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
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(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::PhotoCalib const > getPhotoCalib() const
Definition Exposure.h:142
std::shared_ptr< detection::Psf const > getPsf() const
Definition Exposure.h:139
void setVisitInfo(std::shared_ptr< image::VisitInfo const > visitInfo)
Definition Exposure.h:152
std::shared_ptr< image::VisitInfo const > getVisitInfo() const
Definition Exposure.h:151
lsst::geom::Box2I getBBox() const
Definition Exposure.cc:343
std::shared_ptr< image::TransmissionCurve const > getTransmissionCurve() const
Definition Exposure.h:154
std::shared_ptr< geom::polygon::Polygon const > getValidPolygon() const
Definition Exposure.h:148
void setTransmissionCurve(std::shared_ptr< image::TransmissionCurve const > transmissionCurve)
Definition Exposure.h:157
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
ExposureRecord(ExposureRecord &&)=delete
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
ExposureRecord & operator=(ExposureRecord &&)=delete
void setBBox(lsst::geom::Box2I const &bbox)
Definition Exposure.cc:347
std::shared_ptr< ExposureTable const > getTable() const
Definition Exposure.h:99
void setPsf(std::shared_ptr< detection::Psf const > psf)
Definition Exposure.h:140
ExposureRecord & operator=(ExposureRecord const &)=delete
std::shared_ptr< cameraGeom::Detector const > getDetector() const
Definition Exposure.h:161
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
std::shared_ptr< image::ApCorrMap const > getApCorrMap() const
Definition Exposure.h:145
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< ExposureRecord > makeRecord()
Default-construct an associated record.
Definition Exposure.h:250
static PointKey< int > getBBoxMinKey()
Key for the minimum point of the bbox.
Definition Exposure.h:239
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
std::shared_ptr< BaseRecord > _makeRecord() override
Default-construct an associated record (protected implementation).
Definition Exposure.cc:435
std::shared_ptr< ExposureTable > clone() const
Return a polymorphic deep copy of the table.
Definition Exposure.h:247
std::shared_ptr< io::FitsWriter > makeFitsWriter(fits::Fits *fitsfile, int flags) const override
Definition Exposure.cc:421
static Box2IKey getBBoxKey()
Key for the full bbox.
Definition Exposure.h:243
static Key< RecordId > getIdKey()
Get keys for standard fields shared by all references.
Definition Exposure.h:237
ExposureTable & operator=(ExposureTable &&)=delete
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
ExposureTable(ExposureTable const &other)
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 std::shared_ptr< ExposureTable > make(Schema const &schema)
Construct a new table.
Definition Exposure.cc:394
ExposureTable & operator=(ExposureTable const &)=delete
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.
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
typename Base::const_iterator const_iterator
typename Base::iterator iterator
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.
Writer object for FITS binary tables.
Definition FitsWriter.h:25
A multi-catalog archive object used to load table::io::Persistable objects.
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
daf::base::PropertySet * set
Definition fits.cc:931
T move(T... args)
const int DEFAULT_HDU
Specify that the default HDU should be read.
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