lsst::afw::table::io::Persistable Class Reference

A base class for objects that can be persisted via afw::table::io Archive classes. More...

#include <Persistable.h>

Inheritance diagram for lsst::afw::table::io::Persistable:

Public Member Functions
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...
virtual bool	isPersistable () const noexcept
	Return true if this particular object can be persisted using afw::table::io. More...
virtual	~Persistable () noexcept=default

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs. More...
	Persistable () noexcept=default
	Persistable (Persistable const &other) noexcept=default
	Persistable (Persistable &&other) noexcept=default
Persistable &	operator= (Persistable const &other) noexcept=default
Persistable &	operator= (Persistable &&other) noexcept=default

Friends
class	io::OutputArchive
class	io::InputArchive
template<typename T >
class	PersistableFacade

Detailed Description

A base class for objects that can be persisted via afw::table::io Archive classes.

Inheriting from Persistable provides a public API for reading/writing individual objects to FITS that is fully defined in the base class, with derived classes only needing to implement persistence to catalogs. It is expected that objects that contain multiple persistables (such as Exposures) will create their own InputArchives and OutputArchives, and use these to avoid writing the same object twice (which would otherwise be a big concern for future objects like ExposureCatalog and CoaddPsf).

Generally speaking, an abstract base class that inherits from Persistable should also inherit from PersistableFacade<Base>. A concrete class that inherits (possibly indirectly) from Persistable should inherit from PersistableFacade<Derived> (though this just provides a slightly nicer interface to users), implement isPersistable(), getPersistenceName(), getPythonModule(), and write(), and define a subclass of PersistableFactory. Inheritance from PersistableFacade should always precede inheritance from Persistable.

Persistable has no pure virtual member functions, and instead contains a default implementation that throws LogicError when the user attempts to save an object for which persistence has not actually been implemented.

Definition at line 74 of file Persistable.h.

Member Typedef Documentation

OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protected

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

~Persistable()

virtual lsst::afw::table::io::Persistable::~Persistable ( )

virtualdefaultnoexcept

Persistable() [1/3]

lsst::afw::table::io::Persistable::Persistable ( )

protecteddefaultnoexcept

Persistable() [2/3]

lsst::afw::table::io::Persistable::Persistable ( Persistable const &  other )

protecteddefaultnoexcept

Persistable() [3/3]

lsst::afw::table::io::Persistable::Persistable ( Persistable &&  other )

protecteddefaultnoexcept

Member Function Documentation

getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const

protectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.

Definition at line 34 of file Persistable.cc.

{ return std::string(); }

getPythonModule()

std::string lsst::afw::table::io::Persistable::getPythonModule ( ) const

protectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::Kernel, lsst::afw::math::Function< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::TransmissionCurve, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.

Definition at line 36 of file Persistable.cc.

{ return std::string(); }

isPersistable()

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const

inlinevirtualnoexcept

Return true if this particular object can be persisted using afw::table::io.

Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::extensions::psfex::PsfexPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::image::CoaddInputs, lsst::afw::image::ApCorrMap, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SpanSet, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::TransformMap, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::Detector, and lsst::afw::cameraGeom::Camera.

Definition at line 102 of file Persistable.h.

{ return false; }

operator=() [1/2]

Persistable& lsst::afw::table::io::Persistable::operator= ( Persistable &&  other )

protecteddefaultnoexcept

operator=() [2/2]

Persistable& lsst::afw::table::io::Persistable::operator= ( Persistable const &  other )

protecteddefaultnoexcept

write()

void lsst::afw::table::io::Persistable::write ( OutputArchiveHandle &  handle ) const

protectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::FilterLabel, lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::Camera, lsst::meas::extensions::psfex::PsfexPsf, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, and lsst::afw::math::GaussianFunction2< ReturnT >.

Definition at line 38 of file Persistable.cc.

                                                   {
    assert(!isPersistable());
    throw LSST_EXCEPT(pex::exceptions::LogicError,
                      "afw::table-based persistence is not supported for this object.");
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits

(

fits::Fits &

fitsfile

)

const

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits	(	fits::MemFileManager &	manager,
		std::string const &	mode = "w"
	)		const

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits	(	std::string const &	fileName,
		std::string const &	mode = "w"
	)		const

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

Friends And Related Function Documentation

io::InputArchive

friend class io::InputArchive

friend

Definition at line 146 of file Persistable.h.

io::OutputArchive

friend class io::OutputArchive

friend

Definition at line 145 of file Persistable.h.

PersistableFacade

template<typename T >

friend class PersistableFacade

friend

Definition at line 149 of file Persistable.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/table/io/Persistable.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/table/io/Persistable.cc