LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
122
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
171
178
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
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition fits.h:308
Base class for all records.
Definition BaseRecord.h:31
Defines the fields and offsets for a table.
Definition Schema.h:51
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.
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...
bool readArchive(afw::fits::Fits &fits)
Set the Archive by reading from the HDU specified by the AR_HDU header entry.
Schema finalize()
Map any remaining items into regular Schema items, and return the final Schema.
FitsSchemaInputMapper & operator=(FitsSchemaInputMapper &&)
FitsSchemaInputMapper(FitsSchemaInputMapper &&)
void customize(std::unique_ptr< FitsColumnReader > reader)
Customize a mapping by providing a FitsColumnReader instance that will be invoked by readRecords().
void readRecord(BaseRecord &record, afw::fits::Fits &fits, std::size_t row)
Fill a record from a FITS binary table row.
FitsSchemaInputMapper(daf::base::PropertyList &metadata, bool stripMetadata)
Construct a mapper from a PropertyList of FITS header values, stripping recognized keys if desired.
void erase(Item const *item)
Remove the given item (which should have been retrieved via find()) from the mapping,...
bool hasArchive() const
Return true if the mapper has an InputArchive.
Item const * find(std::string const &ttype) const
Find an item with the given column name (ttype), returning nullptr if no such column exists.
void setArchive(std::shared_ptr< InputArchive > archive)
Set the Archive to an externally-provided one, overriding any that may have been read.
Class for storing ordered metadata with comments.
STL namespace.
A structure that describes a field as a collection of related strings read from the FITS header.