lsst::meas::algorithms::KernelPsfFactory< T, K > Class Template Reference

A PersistableFactory for KernelPsf and its subclasses. More...

#include <KernelPsfFactory.h>

Inheritance diagram for lsst::meas::algorithms::KernelPsfFactory< T, K >:

Public Member Functions
virtual std::shared_ptr< afw::table::io::Persistable >	read (afw::table::io::InputArchive const &archive, afw::table::io::CatalogVector const &catalogs) const
	Construct a new object from the given InputArchive and vector of catalogs. More...
	KernelPsfFactory (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. More...

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

Detailed Description

template<typename T = KernelPsf, typename K = afw::math::Kernel>
class lsst::meas::algorithms::KernelPsfFactory< T, K >

A PersistableFactory for KernelPsf and its subclasses.

If a KernelPsf subclass has no data members other than its kernel, table persistence for it can be implemented simply by reimplementing getPersistenceName() and registering a specialization of KernelPsfFactory.

Template Parameters

T	KernelPsf subclass the factory will construct.
K	Kernel subclass the Psf constructor requires.

Definition at line 55 of file KernelPsfFactory.h.

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

KernelPsfFactory()

template<typename T = KernelPsf, typename K = afw::math::Kernel>

lsst::meas::algorithms::KernelPsfFactory< T, K >::KernelPsfFactory ( std::string const &  name )

inline

Definition at line 69 of file KernelPsfFactory.h.

: 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()

template<typename T = KernelPsf, typename K = afw::math::Kernel>

virtual std::shared_ptr<afw::table::io::Persistable> lsst::meas::algorithms::KernelPsfFactory< T, K >::read ( afw::table::io::InputArchive const &  archive, afw::table::io::CatalogVector const &  catalogs  ) const

inlinevirtual

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

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

Definition at line 57 of file KernelPsfFactory.h.

                                                                                                 {
        static KernelPsfPersistenceHelper const& keys = KernelPsfPersistenceHelper::get();
        LSST_ARCHIVE_ASSERT(catalogs.size() == 1u);
        LSST_ARCHIVE_ASSERT(catalogs.front().size() == 1u);
        afw::table::BaseRecord const& record = catalogs.front().front();
        LSST_ARCHIVE_ASSERT(record.getSchema() == keys.schema);
        // make_shared cannot be used here because
        // the KernelPsf constructor that takes shared_ptr<Kernel> is protected
        return std::shared_ptr<T>(new T(archive.get<K>(record.get(keys.kernel)), record.get(keys.averagePosition)));
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-23-gc2439a9a+fb0756638e/include/lsst/meas/algorithms/KernelPsfFactory.h