lsst.afw  21.0.0-35-g4939cbb3d+fb0e51fe34
SchemaMapper.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 #ifndef AFW_TABLE_SchemaMapper_h_INCLUDED
3 #define AFW_TABLE_SchemaMapper_h_INCLUDED
4 
5 #include <memory>
6 
8 
9 namespace lsst {
10 namespace afw {
11 namespace table {
12 
13 class BaseRecord;
14 
22 public:
24  Schema const getInputSchema() const { return _impl->_input; }
25 
27  Schema const getOutputSchema() const { return _impl->_output; }
28 
30  Schema& editOutputSchema() { return _impl->_output; }
31 
33  template <typename T>
34  Key<T> addOutputField(Field<T> const& newField, bool doReplace = false) {
35  return _impl->_output.addField(newField, doReplace);
36  }
37 
48  template <typename T>
49  Key<T> addMapping(Key<T> const& inputKey, bool doReplace = false);
50 
61  template <typename T>
62  Key<T> addMapping(Key<T> const& inputKey, Field<T> const& outputField, bool doReplace = false);
63 
74  template <typename T>
75  Key<T> addMapping(Key<T> const& inputKey, std::string const& outputName, bool doReplace = true);
76 
82  template <typename T>
83  Key<T> addMapping(Key<T> const& inputKey, char const* outputName, bool doReplace = true) = delete;
84 
97  template <typename Predicate>
98  void addMappingsWhere(Predicate predicate, bool doReplace = true);
99 
110  void addMinimalSchema(Schema const& minimal, bool doMap = true);
111 
122  static SchemaMapper removeMinimalSchema(Schema const& input, Schema const& minimal);
123 
125  void invert();
126 
128  template <typename T>
129  bool isMapped(Key<T> const& inputKey) const;
130 
132  template <typename T>
133  Key<T> getMapping(Key<T> const& inputKey) const;
134 
136 
149  template <typename F>
150  void forEach(F& func) const {
151  for (auto const & item : _impl->_map) {
152  std::visit([&func](auto const & pair) { func(pair.first, pair.second); }, item);
153  }
154  }
155  template <typename F>
156  void forEach(F const& func) const {
157  for (auto const & item : _impl->_map) {
158  std::visit([&func](auto const & pair) { func(pair.first, pair.second); }, item);
159  }
160  }
162 
164  explicit SchemaMapper();
165 
181  explicit SchemaMapper(Schema const& input, Schema const& output);
182 
200  explicit SchemaMapper(Schema const& input, bool shareAliasMap = false);
201 
203  SchemaMapper(SchemaMapper const& other);
204  SchemaMapper(SchemaMapper&& other);
205 
207  SchemaMapper& operator=(SchemaMapper const& other);
209 
211 
222  std::vector<Schema> const& inputs,
224 
225 private:
226  template <typename Predicate>
227  struct AddMappingsWhere {
228  template <typename T>
229  void operator()(SchemaItem<T> const& item) const {
230  if (predicate(item)) mapper->addMapping(item.key, doReplace);
231  }
232 
233  AddMappingsWhere(SchemaMapper* mapper_, Predicate predicate_, bool doReplace_)
234  : mapper(mapper_), predicate(predicate_), doReplace(doReplace_) {}
235 
237  Predicate predicate;
238  bool doReplace;
239  };
240 
241  typedef detail::SchemaMapperImpl Impl;
242 
243  std::unique_ptr<Impl> _impl;
244 };
245 
246 template <typename Predicate>
247 void SchemaMapper::addMappingsWhere(Predicate predicate, bool doReplace) {
248  _impl->_input.forEach(AddMappingsWhere<Predicate>(this, predicate, doReplace));
249 }
250 } // namespace table
251 } // namespace afw
252 } // namespace lsst
253 
254 #endif // !AFW_TABLE_SchemaMapper_h_INCLUDED
SchemaMapper * mapper
Definition: SchemaMapper.cc:71
Schema minimal
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
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
Schema const getOutputSchema() const
Return the output schema (copy-on-write).
Definition: SchemaMapper.h:27
SchemaMapper()
Construct an empty mapper; useless unless you assign a fully-constructed one to it.
Key< T > addOutputField(Field< T > const &newField, bool doReplace=false)
Add a new field to the output Schema that is not connected to the input Schema.
Definition: SchemaMapper.h:34
SchemaMapper & operator=(SchemaMapper const &other)
Assignment (copy-on-write).
void forEach(F &func) const
Call the given functor for each key pair in the mapper.
Definition: SchemaMapper.h:150
Schema & editOutputSchema()
Return a reference to the output schema that allows it to be modified in place.
Definition: SchemaMapper.h:30
Key< T > addMapping(Key< T > const &inputKey, bool doReplace=false)
Add a new field to the output Schema that is a copy of a field in the input Schema.
static SchemaMapper removeMinimalSchema(Schema const &input, Schema const &minimal)
Create a mapper by removing fields from the front of a schema.
static std::vector< SchemaMapper > join(std::vector< Schema > const &inputs, std::vector< std::string > const &prefixes=std::vector< std::string >())
Combine a sequence of schemas into one, creating a SchemaMapper for each.
void forEach(F const &func) const
Definition: SchemaMapper.h:156
Key< T > getMapping(Key< T > const &inputKey) const
Return the output Key corresponding to the given input Key, or raise NotFoundError.
bool isMapped(Key< T > const &inputKey) const
Return true if the given input Key is mapped to an output Key.
void addMinimalSchema(Schema const &minimal, bool doMap=true)
Add the given minimal schema to the output schema.
void invert()
Swap the input and output schemas in-place.
Key< T > addMapping(Key< T > const &inputKey, char const *outputName, bool doReplace=true)=delete
This deliberately deleted overload ensures we don't accidentally cast string literals to bool.
Schema const getInputSchema() const
Return the input schema (copy-on-write).
Definition: SchemaMapper.h:24
void addMappingsWhere(Predicate predicate, bool doReplace=true)
Add mappings for all fields that match criteria defined by a predicate.
Definition: SchemaMapper.h:247
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
A base class for image defects.
A description of a field in a table.
Definition: Field.h:24
A simple pair-like struct for mapping a Field (name and description) with a Key (used for actual data...
Definition: SchemaImpl.h:22