Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Persistable.cc
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2
3#include <map>
4
9#include "lsst/afw/fits.h"
10
11namespace lsst {
12namespace afw {
13namespace table {
14namespace io {
15
16// ----- Persistable ----------------------------------------------------------------------------------------
17
18void Persistable::writeFits(fits::Fits &fitsfile) const {
19 OutputArchive archive;
20 archive.put(this);
21 archive.writeFits(fitsfile);
22}
23
24void Persistable::writeFits(std::string const &fileName, std::string const &mode) const {
26 writeFits(fitsfile);
27}
28
29void Persistable::writeFits(fits::MemFileManager &manager, std::string const &mode) const {
31 writeFits(fitsfile);
32}
33
35
37
39 assert(!isPersistable());
41 "afw::table-based persistence is not supported for this object.");
42}
43
44std::shared_ptr<Persistable> Persistable::_readFits(std::string const &fileName, int hdu) {
46 fitsfile.setHdu(hdu);
47 return _readFits(fitsfile);
48}
49
50std::shared_ptr<Persistable> Persistable::_readFits(fits::MemFileManager &manager, int hdu) {
52 fitsfile.setHdu(hdu);
53 return _readFits(fitsfile);
54}
55
56std::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
63namespace {
64
66
67RegistryMap &getRegistry() {
68 static RegistryMap instance;
69 return instance;
70}
71
72} // namespace
73
74PersistableFactory::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(
84 (boost::format(
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()) {
94 (boost::format(
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
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
Mechanism for safely importing Python modules from C++; should not be included except by its own impl...
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition fits.h:308
Lifetime-management for memory that goes into FITS memory files.
Definition fits.h:125
static InputArchive readFits(fits::Fits &fitsfile)
Read an object from an already open FITS object.
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...
void writeFits(fits::Fits &fitsfile) const
Write the archive to an already-open FITS object.
static PersistableFactory const & lookup(std::string const &name, std::string const &module="")
Return the factory that has been registered with the given name.
PersistableFactory(std::string const &name)
Constructor for the factory.
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
io::OutputArchiveHandle OutputArchiveHandle
virtual bool isPersistable() const noexcept
Return true if this particular object can be persisted using afw::table::io.
virtual std::string getPythonModule() const
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
virtual std::string getPersistenceName() const
Return the unique name used to persist this object and look up its factory.
virtual void write(OutputArchiveHandle &handle) const
Write the object to one or more catalogs.
static bool import(std::string const &name)
Import the given Python module, and return true if successful.
Reports errors in the logical structure of the program.
Definition Runtime.h:46
Reports attempts to access elements using an invalid key.
Definition Runtime.h:151