lsst::afw::detection::FootprintFactory Class Reference

Inheritance diagram for lsst::afw::detection::FootprintFactory:

Public Member Functions
std::shared_ptr< afw::table::io::Persistable >	read (afw::table::io::InputArchive const &archive, afw::table::io::CatalogVector const &catalogs) const override
	Construct a new object from the given InputArchive and vector of catalogs.
	FootprintFactory (std::string const &name)

Static Public Member Functions
static PersistableFactory const &	lookup (std::string const &name, std::string const &module="")
	Return the factory that has been registered with the given name.

Protected Types
using	InputArchive = io::InputArchive
using	CatalogVector = io::CatalogVector

Detailed Description

Definition at line 246 of file Footprint.cc.

Member Typedef Documentation

CatalogVector

using lsst::afw::table::io::PersistableFactory::CatalogVector = io::CatalogVector

protectedinherited

Definition at line 231 of file Persistable.h.

InputArchive

using lsst::afw::table::io::PersistableFactory::InputArchive = io::InputArchive

protectedinherited

Definition at line 230 of file Persistable.h.

Constructor & Destructor Documentation

FootprintFactory()

lsst::afw::detection::FootprintFactory::FootprintFactory ( std::string const & name )

inlineexplicit

Definition at line 260 of file Footprint.cc.

: afw::table::io::PersistableFactory(name) {}

Member Function Documentation

lookup()

PersistableFactory const & lsst::afw::table::io::PersistableFactory::lookup ( std::string const & name, std::string const & module = "" )

staticinherited

Return the factory that has been registered with the given name.

If the lookup fails and module is not an empty string, we will attempt to import a Python module with that name (this will only work when the C++ is being called from Python) and try again.

Definition at line 76 of file Persistable.cc.

                                                                                                   {
    RegistryMap::const_iterator i = getRegistry().find(name);
    if (i == getRegistry().end()) {
        if (!module.empty()) {
            bool success = base::ModuleImporter::import(module);
            if (!success) {
                throw LSST_EXCEPT(
                        pex::exceptions::NotFoundError,
                        (boost::format(
                                 "PersistableFactory with name '%s' not found, and import of module "
                                 "'%s' failed (possibly because Python calls were not available from C++).") %
                         name % module)
                                .str());
            }
            i = getRegistry().find(name);
            if (i == getRegistry().end()) {
                throw LSST_EXCEPT(
                        pex::exceptions::LogicError,
                        (boost::format(
                                 "PersistableFactory with name '%s' not found even after successful import "
                                 "of module '%s'.  Please report this as a bug in the persistence "
                                 "implementation for this object.") %
                         name % module)
                                .str());
            }
        } else {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    (boost::format(
                             "PersistableFactory with name '%s' not found, and no Python module to import "
                             "was provided.  Please report this as a bug in the persistence implementation "
                             "for this object.") %
                     name)
                            .str());
        }
    }
    return *i->second;
}

read()

std::shared_ptr< afw::table::io::Persistable > lsst::afw::detection::FootprintFactory::read ( afw::table::io::InputArchive const & archive, afw::table::io::CatalogVector const & catalogs ) const

inlineoverridevirtual

Construct a new object from the given InputArchive and vector of catalogs.

Implements lsst::afw::table::io::PersistableFactory.

Definition at line 248 of file Footprint.cc.

                                                                    {
        // Verify there are two catalogs
        LSST_ARCHIVE_ASSERT(catalogs.size() == 2u);
        std::shared_ptr<Footprint> loadedFootprint =
                detection::Footprint::readSpanSet(catalogs.front(), archive);
        // Now read in the PeakCatalog records
        detection::Footprint::readPeaks(catalogs.back(), *loadedFootprint);
        return loadedFootprint;
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+66d966b544/src/detection/Footprint.cc