LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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.