lsst.afw g1f6fc4ca13+8b5155b42b
FitsSchemaInputMapper.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2#ifndef AFW_TABLE_IO_FitsSchemaInputMapper_h_INCLUDED
3#define AFW_TABLE_IO_FitsSchemaInputMapper_h_INCLUDED
4
5#include "lsst/afw/fits.h"
10
11namespace lsst {
12namespace afw {
13namespace table {
14namespace io {
15
21public:
22 FitsColumnReader() noexcept = default;
23
24 // Neither copyable nor moveable.
27 FitsColumnReader &operator=(FitsColumnReader const &) = delete;
28 FitsColumnReader &operator=(FitsColumnReader &&) = delete;
29
42 virtual void prepRead(std::size_t firstRow, std::size_t nRows, fits::Fits & fits) {}
43
53 virtual void readCell(BaseRecord &record, std::size_t row, fits::Fits &fits,
54 std::shared_ptr<InputArchive> const &archive) const = 0;
55
56 virtual ~FitsColumnReader() noexcept = default;
57};
58
63 int column; // column number (0-indexed); -1 for Flag fields
64 int bit; // flag bit number (0-indexed); -1 for non-Flag fields
65 std::string ttype; // name of the field (from TTYPE keys)
66 std::string tform; // FITS column format code (from TFORM keys)
67 std::string tccls; // which field class to use (from our own TCCLS keys)
68 std::string tunit; // field units (from TUNIT keys)
69 std::string doc; // field docs (from comments on TTYPE keys)
70
71 explicit FitsSchemaItem(int column_, int bit_) : column(column_), bit(bit_) {}
72};
73
92public:
94
108
110 FitsSchemaInputMapper(daf::base::PropertyList &metadata, bool stripMetadata);
111
117
121 void setArchive(std::shared_ptr<InputArchive> archive);
122
128 bool readArchive(afw::fits::Fits &fits);
129
131 bool hasArchive() const;
132
139 Item const *find(std::string const &ttype) const;
140
147 Item const *find(int column) const;
148
153 void erase(Item const *item);
154
159 void erase(std::string const &ttype);
160
165 void erase(int column);
166
170 void customize(std::unique_ptr<FitsColumnReader> reader);
171
177 Schema finalize();
178
182 void readRecord(BaseRecord &record, afw::fits::Fits &fits, std::size_t row);
183
184private:
185 class Impl;
187};
188} // namespace io
189} // namespace table
190} // namespace afw
191} // namespace lsst
192
193#endif // !AFW_TABLE_IO_FitsSchemaInputMapper_h_INCLUDED
Fits * fits
Definition: FitsWriter.cc:90
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
Base class for all records.
Definition: BaseRecord.h:31
Defines the fields and offsets for a table.
Definition: Schema.h:51
Polymorphic reader interface used to read different kinds of objects from one or more FITS binary tab...
virtual ~FitsColumnReader() noexcept=default
virtual void readCell(BaseRecord &record, std::size_t row, fits::Fits &fits, std::shared_ptr< InputArchive > const &archive) const =0
Read values from a single row.
virtual void prepRead(std::size_t firstRow, std::size_t nRows, fits::Fits &fits)
Optionally read ahead and cache values from multiple rows.
A class that describes a mapping from a FITS binary table to an afw::table Schema.
FitsSchemaInputMapper & operator=(FitsSchemaInputMapper const &)
FitsSchemaInputMapper(FitsSchemaInputMapper const &)
static std::size_t PREPPED_ROWS_FACTOR
When processing each column, divide this number by the record size (in bytes) and ask CFITSIO to read...
FitsSchemaInputMapper & operator=(FitsSchemaInputMapper &&)
FitsSchemaInputMapper(FitsSchemaInputMapper &&)
void erase(int column)
A base class for image defects.
STL namespace.
A structure that describes a field as a collection of related strings read from the FITS header.