lsst.afw  22.0.1-35-g9503da760+2534fc217b
FitsWriter.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 #ifndef AFW_TABLE_IO_FitsWriter_h_INCLUDED
3 #define AFW_TABLE_IO_FitsWriter_h_INCLUDED
4 
5 #include <set>
6 
7 #include "lsst/base.h"
8 #include "lsst/pex/exceptions.h"
10 #include "lsst/afw/fits.h"
11 
12 namespace lsst {
13 namespace afw {
14 namespace table {
15 namespace io {
16 
25 class FitsWriter {
26 public:
28 
36  template <typename OutputT, typename ContainerT>
37  static void apply(OutputT& output, std::string const& mode, ContainerT const& container, int flags) {
38  Fits fits(output, mode, Fits::AUTO_CLOSE | Fits::AUTO_CHECK);
39  apply(fits, container, flags);
40  }
41 
43  template <typename ContainerT>
44  static void apply(Fits& fits, ContainerT const& container, int flags) {
46  std::static_pointer_cast<BaseTable const>(container.getTable())->makeFitsWriter(&fits, flags);
47  writer->write(container);
48  }
49 
57  template <typename ContainerT>
58  void write(ContainerT const& container) {
60  for (typename ContainerT::const_iterator i = container.begin(); i != container.end(); ++i) {
61  if (i->getTable() != container.getTable()) tables.insert(i->getTable());
62  }
63  for (auto const &table : tables) {
64  if ((*table).getSchema().compare(container.getTable()->getSchema(), Schema::IDENTICAL) !=
67  "Cannot save Catalog with heterogenous schemas");
68  }
69  }
70  _writeTable(container.getTable(), container.size());
71  for (typename ContainerT::const_iterator i = container.begin(); i != container.end(); ++i) {
72  _writeRecord(*i);
73  }
74  _finish();
75  }
76 
78  explicit FitsWriter(Fits* fits, int flags) : _fits(fits), _flags(flags) {}
79 
80  FitsWriter(FitsWriter const&) = default;
81  FitsWriter(FitsWriter&&) = default;
82  FitsWriter& operator=(FitsWriter const&) = default;
84  virtual ~FitsWriter() = default;
85 
86 protected:
88  virtual void _writeTable(std::shared_ptr<BaseTable const> const& table, std::size_t nRows);
89 
91  virtual void _writeRecord(BaseRecord const& source);
92 
94  virtual void _finish() {}
95 
96  Fits* _fits; // wrapped cfitsio pointer
97  int _flags; // subclass-defined flags to control writing
98  std::size_t _row; // which row we're currently processing
99 
100 private:
101  struct ProcessRecords;
102 
103  std::shared_ptr<ProcessRecords> _processor; // a private Schema::forEach functor that write records
104 };
105 } // namespace io
106 } // namespace table
107 } // namespace afw
108 } // namespace lsst
109 
110 #endif // !AFW_TABLE_IO_FitsWriter_h_INCLUDED
#define LSST_EXCEPT(type,...)
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
@ IDENTICAL
Everything is the same.
Definition: Schema.h:72
Writer object for FITS binary tables.
Definition: FitsWriter.h:25
FitsWriter(Fits *fits, int flags)
Construct from a wrapped cfitsio pointer.
Definition: FitsWriter.h:78
virtual void _writeRecord(BaseRecord const &source)
Write an individual record.
Definition: FitsWriter.cc:189
FitsWriter & operator=(FitsWriter &&)=default
FitsWriter & operator=(FitsWriter const &)=default
static void apply(OutputT &output, std::string const &mode, ContainerT const &container, int flags)
Driver for writing FITS files.
Definition: FitsWriter.h:37
void write(ContainerT const &container)
Write records in a container to disk.
Definition: FitsWriter.h:58
FitsWriter(FitsWriter const &)=default
FitsWriter(FitsWriter &&)=default
virtual void _writeTable(std::shared_ptr< BaseTable const > const &table, std::size_t nRows)
Write a table and its schema.
Definition: FitsWriter.cc:103
static void apply(Fits &fits, ContainerT const &container, int flags)
Low-level driver for writing FITS files, operating on an open FITS file.
Definition: FitsWriter.h:44
virtual void _finish()
Finish writing a catalog.
Definition: FitsWriter.h:94
T insert(T... args)
A base class for image defects.