LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.46
LSSTDataManagementBasePackage
Persistable.cc
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 #include <map>
4 
9 #include "lsst/afw/fits.h"
10 
11 namespace lsst {
12 namespace afw {
13 namespace table {
14 namespace io {
15 
16 // ----- Persistable ----------------------------------------------------------------------------------------
17 
18 void Persistable::writeFits(fits::Fits &fitsfile) const {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }
23 
24 void Persistable::writeFits(std::string const &fileName, std::string const &mode) const {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }
28 
29 void Persistable::writeFits(fits::MemFileManager &manager, std::string const &mode) const {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
33 
35 
37 
39  assert(!isPersistable());
41  "afw::table-based persistence is not supported for this object.");
42 }
43 
44 std::shared_ptr<Persistable> Persistable::_readFits(std::string const &fileName, int hdu) {
45  fits::Fits fitsfile(fileName, "r", fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
46  fitsfile.setHdu(hdu);
47  return _readFits(fitsfile);
48 }
49 
50 std::shared_ptr<Persistable> Persistable::_readFits(fits::MemFileManager &manager, int hdu) {
52  fitsfile.setHdu(hdu);
53  return _readFits(fitsfile);
54 }
55 
56 std::shared_ptr<Persistable> Persistable::_readFits(fits::Fits &fitsfile) {
57  InputArchive archive = InputArchive::readFits(fitsfile);
58  return archive.get(1); // the first object saved always has id=1
59 }
60 
61 // ----- PersistableFactory ---------------------------------------------------------------------------------
62 
63 namespace {
64 
66 
67 RegistryMap &getRegistry() {
68  static RegistryMap instance;
69  return instance;
70 }
71 
72 } // namespace
73 
74 PersistableFactory::PersistableFactory(std::string const &name) { getRegistry()[name] = this; }
75 
77  RegistryMap::const_iterator i = getRegistry().find(name);
78  if (i == getRegistry().end()) {
79  if (!module.empty()) {
80  bool success = base::ModuleImporter::import(module);
81  if (!success) {
82  throw LSST_EXCEPT(
85  "PersistableFactory with name '%s' not found, and import of module "
86  "'%s' failed (possibly because Python calls were not available from C++).") %
87  name % module)
88  .str());
89  }
90  i = getRegistry().find(name);
91  if (i == getRegistry().end()) {
92  throw LSST_EXCEPT(
95  "PersistableFactory with name '%s' not found even after successful import "
96  "of module '%s'. Please report this as a bug in the persistence "
97  "implementation for this object.") %
98  name % module)
99  .str());
100  }
101  } else {
102  throw LSST_EXCEPT(
104  (boost::format(
105  "PersistableFactory with name '%s' not found, and no Python module to import "
106  "was provided. Please report this as a bug in the persistence implementation "
107  "for this object.") %
108  name)
109  .str());
110  }
111  }
112  return *i->second;
113 }
114 } // namespace io
115 } // namespace table
116 } // namespace afw
117 } // namespace lsst
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
T empty(T... args)
PersistableFactory(std::string const &name)
Constructor for the factory.
Definition: Persistable.cc:74
An object passed to Persistable::write to allow it to persist itself.
A base class for factory classes used to reconstruct objects from records.
Definition: Persistable.h:228
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
STL class.
static PersistableFactory const & lookup(std::string const &name, std::string const &module="")
Return the factory that has been registered with the given name.
Definition: Persistable.cc:76
virtual void write(OutputArchiveHandle &handle) const
Write the object to one or more catalogs.
Definition: Persistable.cc:38
STL class.
A multi-catalog archive object used to save table::io::Persistable objects.
Definition: OutputArchive.h:34
Reports attempts to access elements using an invalid key.
Definition: Runtime.h:151
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24
void writeFits(fits::Fits &fitsfile) const
Write the archive to an already-open FITS object.
A base class for image defects.
virtual std::string getPythonModule() const
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition: Persistable.cc:36
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
Mechanism for safely importing Python modules from C++; should not be included except by its own impl...
Reports errors in the logical structure of the program.
Definition: Runtime.h:46
void setHdu(int hdu, bool relative=false)
Set the current HDU.
Definition: fits.cc:512
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
static InputArchive readFits(fits::Fits &fitsfile)
Read an object from an already open FITS object.
static bool import(std::string const &name)
Import the given Python module, and return true if successful.
virtual bool isPersistable() const noexcept
Return true if this particular object can be persisted using afw::table::io.
Definition: Persistable.h:102
virtual std::string getPersistenceName() const
Return the unique name used to persist this object and look up its factory.
Definition: Persistable.cc:34
A multi-catalog archive object used to load table::io::Persistable objects.
Definition: InputArchive.h:31
int end
std::shared_ptr< Persistable > get(int id) const
Load the Persistable with the given ID and return it.
int put(std::shared_ptr< Persistable const > obj, bool permissive=false)
Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArc...