lsst::afw::table::io::OutputArchive::Impl Class Reference

Public Member Functions
BaseCatalog	makeCatalog (Schema const &schema)
std::shared_ptr< BaseRecord >	addIndexRecord (int id, std::string const &name, std::string const &module)
void	saveEmpty (int id, std::string const &name, std::string const &module)
void	saveCatalog (BaseCatalog const &catalog, int id, std::string const &name, std::string const &module, int catPersistable)
int	put (Persistable const *obj, std::shared_ptr< Impl > const &self, bool permissive)
int	put (std::shared_ptr< Persistable const > obj, std::shared_ptr< Impl > const &self, bool permissive)
void	writeFits (fits::Fits &fitsfile)
	Impl ()

Public Attributes
int	_nextId {1}
Map	_map
BaseCatalog	_index
CatalogVector	_catalogs

Detailed Description

Definition at line 37 of file OutputArchive.cc.

Constructor & Destructor Documentation

Impl()

lsst::afw::table::io::OutputArchive::Impl::Impl ( )

inline

Definition at line 165 of file OutputArchive.cc.

           :  _map(), _index(ArchiveIndexSchema::get().schema) {
        std::shared_ptr<daf::base::PropertyList> metadata(new daf::base::PropertyList());
        metadata->set("EXTTYPE", "ARCHIVE_INDEX");
        metadata->set("EXTNAME", "ARCHIVE_INDEX");
        metadata->set("AR_CATN", 0, "# of this catalog relative to the start of this archive");
        _index.getTable()->setMetadata(metadata);
    }

Member Function Documentation

addIndexRecord()

std::shared_ptr< BaseRecord > lsst::afw::table::io::OutputArchive::Impl::addIndexRecord ( int id, std::string const & name, std::string const & module )

inline

Definition at line 60 of file OutputArchive.cc.

                                                                                                     {
        auto indexRecord = _index.addNew();
        indexRecord->set(indexKeys.id, id);
        indexRecord->set(indexKeys.name, name);
        indexRecord->set(indexKeys.module, module);
        return indexRecord;
    }

makeCatalog()

BaseCatalog lsst::afw::table::io::OutputArchive::Impl::makeCatalog ( Schema const & schema )

inline

Definition at line 39 of file OutputArchive.cc.

                                                  {
        int catArchive = 1;
        CatalogVector::iterator iter = _catalogs.begin();
        int const flags = table::Schema::EQUAL_KEYS | table::Schema::EQUAL_NAMES;
        for (; iter != _catalogs.end(); ++iter, ++catArchive) {
            if (iter->getSchema().compare(schema, flags) == flags) {
                break;
            }
        }
        if (iter == _catalogs.end()) {
            iter = _catalogs.insert(_catalogs.end(), BaseCatalog(schema));
        }
        if (!iter->getTable()->getMetadata()) {
            std::shared_ptr<daf::base::PropertyList> metadata(new daf::base::PropertyList());
            iter->getTable()->setMetadata(metadata);
            metadata->set("EXTTYPE", "ARCHIVE_DATA");
            metadata->set("AR_CATN", catArchive, "# of this catalog relative to the start of this archive");
        }
        return BaseCatalog(iter->getTable());
    }

put() [1/2]

int lsst::afw::table::io::OutputArchive::Impl::put ( Persistable const * obj, std::shared_ptr< Impl > const & self, bool permissive )

inline

Definition at line 130 of file OutputArchive.cc.

                                                                                      {
        if (!obj) return 0;
        if (permissive && !obj->isPersistable()) return 0;
        int const currentId = _nextId;
        ++_nextId;
        OutputArchiveHandle handle(currentId, obj->getPersistenceName(), obj->getPythonModule(), self);
        obj->write(handle);
        return currentId;
    }

put() [2/2]

int lsst::afw::table::io::OutputArchive::Impl::put ( std::shared_ptr< Persistable const > obj, std::shared_ptr< Impl > const & self, bool permissive )

inline

Definition at line 140 of file OutputArchive.cc.

                                                                                                    {
        if (!obj) return 0;
        if (permissive && !obj->isPersistable()) return 0;
        MapItem item(obj, _nextId);
        std::pair<Map::iterator, bool> r = _map.insert(item);
        if (r.second) {
            // We've never seen this object before.  Save it.
            return put(obj.get(), self, permissive);
        } else {
            // We had already saved this object, and insert returned an iterator
            // to the ID we used before; return that.
            return r.first->second;
        }
    }

saveCatalog()

void lsst::afw::table::io::OutputArchive::Impl::saveCatalog ( BaseCatalog const & catalog, int id, std::string const & name, std::string const & module, int catPersistable )

inline

Definition at line 76 of file OutputArchive.cc.

                                         {
        auto indexRecord = addIndexRecord(id, name, module);
        indexRecord->set(indexKeys.catPersistable, catPersistable);
        indexRecord->set(indexKeys.nRows, catalog.size());
        int catArchive = 1;
        CatalogVector::iterator iter = _catalogs.begin();
        for (; iter != _catalogs.end(); ++iter, ++catArchive) {
            if (iter->getTable() == catalog.getTable()) {
                break;
            }
        }
        if (iter == _catalogs.end()) {
            throw LSST_EXCEPT(pex::exceptions::LogicError,
                              "All catalogs passed to saveCatalog must be created by makeCatalog");
        }
        auto metadata = iter->getTable()->getMetadata();
        // If EXTNAME exists we have already assigned an EXTVER.
        // Otherwise must scan through all catalogs looking for other
        // catalogs with the same name that have been assigned EXTNAME
        // to determine this EXTVER.
        auto found_extname = metadata->exists("EXTNAME");
        if (!found_extname) {
            int extver = 1;
            // Catalogs can be filled out of order, so look for other
            // catalogs with this EXTNAME.
            CatalogVector::iterator ver_iter = _catalogs.begin();
            for (; ver_iter != _catalogs.end(); ++ver_iter) {
                auto cat_metadata = ver_iter->getTable()->getMetadata();
                if (cat_metadata->exists("EXTNAME") && cat_metadata->getAsString("EXTNAME") == name) {
                        ++extver;
                }
            }
            if (extver > 1) { // 1 is the default so no need to write it.
                metadata->set("EXTVER", extver);
            }
        }
        // Add the name of the class to the header so anyone looking at it can
        // tell what's stored there.  But we don't want to add it multiple times.
        try {
            auto names = metadata->getArray<std::string>("AR_NAME");
            if (std::find(names.begin(), names.end(), name) == names.end()) {
                iter->getTable()->getMetadata()->add("AR_NAME", name, "Class name for objects stored here");
            }
        } catch (pex::exceptions::NotFoundError &) {
            metadata->add("AR_NAME", name, "Class name for objects stored here");
        }
        // Also add an EXTNAME. The most recent AR_NAME given will be used.
        metadata->set("EXTNAME", name);
        indexRecord->set(indexKeys.row0, iter->size());
        indexRecord->set(indexKeys.catArchive, catArchive);
        iter->insert(iter->end(), catalog.begin(), catalog.end(), false);
    }

saveEmpty()

void lsst::afw::table::io::OutputArchive::Impl::saveEmpty ( int id, std::string const & name, std::string const & module )

inline

Definition at line 68 of file OutputArchive.cc.

                                                                           {
        auto indexRecord = addIndexRecord(id, name, module);
        indexRecord->set(indexKeys.nRows, 0);
        indexRecord->set(indexKeys.catPersistable, ArchiveIndexSchema::NO_CATALOGS_SAVED);
        indexRecord->set(indexKeys.row0, ArchiveIndexSchema::NO_CATALOGS_SAVED);
        indexRecord->set(indexKeys.catArchive, ArchiveIndexSchema::NO_CATALOGS_SAVED);
    }

writeFits()

void lsst::afw::table::io::OutputArchive::Impl::writeFits ( fits::Fits & fitsfile )

inline

Definition at line 155 of file OutputArchive.cc.

                                       {
        _index.getTable()->getMetadata()->set("AR_NCAT", int(_catalogs.size() + 1),
                                              "# of catalogs in this archive, including the index");
        _index.writeFits(fitsfile);
        int n = 1;
        for (CatalogVector::const_iterator iter = _catalogs.begin(); iter != _catalogs.end(); ++iter, ++n) {
            iter->writeFits(fitsfile);
        }
    }

Member Data Documentation

_catalogs

CatalogVector lsst::afw::table::io::OutputArchive::Impl::_catalogs

Definition at line 176 of file OutputArchive.cc.

_index

BaseCatalog lsst::afw::table::io::OutputArchive::Impl::_index

Definition at line 175 of file OutputArchive.cc.

_map

Map lsst::afw::table::io::OutputArchive::Impl::_map

Definition at line 174 of file OutputArchive.cc.

_nextId

int lsst::afw::table::io::OutputArchive::Impl::_nextId {1}

Definition at line 173 of file OutputArchive.cc.

{1};

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g9b50b81019+d8f85438e7/src/table/io/OutputArchive.cc