LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
LSST Data Management Base Package
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
lsst::afw::table::io::PersistableFacade< T > Class Template Reference

A CRTP facade class for subclasses of Persistable. More...

#include <Persistable.h>

Inheritance diagram for lsst::afw::table::io::PersistableFacade< T >:
lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint > lsst::afw::math::Function< Kernel::Pixel > lsst::afw::math::Function< Pixel > lsst::afw::math::Function< double > lsst::afw::math::Function1< Kernel::Pixel > lsst::afw::math::Function2< Pixel > lsst::afw::math::Function2< double > lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >

Static Public Member Functions

static std::shared_ptr< T > readFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object.
 
static std::shared_ptr< T > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file.
 
static std::shared_ptr< T > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory.
 
static std::shared_ptr< T > dynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr.
 

Detailed Description

template<typename T>
class lsst::afw::table::io::PersistableFacade< T >

A CRTP facade class for subclasses of Persistable.

Derived classes should generally inherit from PersistableFacade at all levels, but only inherit from Persistable via the base class of each hierarchy. For example, with Psfs: 

class Psf: public PersistableFacade<Psf>, public Persistable { ... };
class DoubleGaussianPsf: public PersistableFacade<DoubleGaussianPsf>, public Psf { ... };

Inheriting from PersistableFacade is not required for any classes but the base of each hierarchy, but doing so can save users from having to do some dynamic_casts.

Note
PersistableFacade should usually be the first class in a list of base classes; if it appears after a base class that inherits from different specialization of PersistableFacade, those base class member functions will hide the desired ones.

Definition at line 176 of file Persistable.h.

Member Function Documentation

◆ dynamicCast()

template<typename T >
template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< T >::dynamicCast ( std::shared_ptr< Persistable > const & ptr)
static

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

18 {
19 auto result = std::dynamic_pointer_cast<T>(ptr);
20 if (!result) {
21 throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22 }
23 return result;
24}
result
py::object result
Definition _schema.cc:429
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
ptr
uint64_t * ptr
Definition RangeSet.cc:95

◆ readFits() [1/3]

template<typename T >
static std::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( fits::Fits & fitsfile)
inlinestatic

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183 {
184 return dynamicCast(Persistable::_readFits(fitsfile));
185 }
lsst::afw::table::io::PersistableFacade::dynamicCast
static std::shared_ptr< T > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition Persistable.cc:18

◆ readFits() [2/3]

template<typename T >
static std::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( fits::MemFileManager & manager,
int hdu = fits::DEFAULT_HDU )
inlinestatic

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

205 {
206 return dynamicCast(Persistable::_readFits(manager, hdu));
207 }

◆ readFits() [3/3]

template<typename T >
static std::shared_ptr< T > lsst::afw::table::io::PersistableFacade< T >::readFits ( std::string const & fileName,
int hdu = fits::DEFAULT_HDU )
inlinestatic

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

194 {
195 return dynamicCast(Persistable::_readFits(fileName, hdu));
196 }
The documentation for this class was generated from the following files:
Generated on Wed Apr 24 2024 08:56:05 for LSST Applications by doxygen 1.10.0