lsst::afw::table::io::InputArchive Class Reference

A multi-catalog archive object used to load table::io::Persistable objects. More...

#include <InputArchive.h>

Classes
class	Impl

Public Types
using	Map = std::map<int, std::shared_ptr<Persistable>>

Public Member Functions
	InputArchive ()
	Construct an empty InputArchive that contains no objects.
	InputArchive (BaseCatalog const &index, CatalogVector const &dataCatalogs)
	Construct an archive from catalogs.
	InputArchive (InputArchive const &other)
	Copy-constructor. Does not deep-copy loaded Persistables.
	InputArchive (InputArchive &&other)
InputArchive &	operator= (InputArchive const &other)
	Assignment. Does not deep-copy loaded Persistables.
InputArchive &	operator= (InputArchive &&other)
	~InputArchive ()
std::shared_ptr< Persistable >	get (int id) const
	Load the Persistable with the given ID and return it.
template<typename T >
std::shared_ptr< T >	get (int id) const
	Load an object of the given type and ID with error checking.
Map const &	getAll () const
	Load and return all objects in the archive.

Static Public Member Functions
static InputArchive	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.

Detailed Description

A multi-catalog archive object used to load table::io::Persistable objects.

An InputArchive can be constructed directly from the catalogs produced by OutputArchive, or more usefully, read from a multi-extension FITS file.

See also

OutputArchive

Definition at line 31 of file InputArchive.h.

Member Typedef Documentation

Map

using lsst::afw::table::io::InputArchive::Map = std::map<int, std::shared_ptr<Persistable>>

Definition at line 33 of file InputArchive.h.

Constructor & Destructor Documentation

InputArchive() [1/4]

lsst::afw::table::io::InputArchive::InputArchive

(

)

Construct an empty InputArchive that contains no objects.

Definition at line 162 of file InputArchive.cc.

: _impl(new Impl()) {}

InputArchive() [2/4]

lsst::afw::table::io::InputArchive::InputArchive	(	BaseCatalog const &	index,
		CatalogVector const &	dataCatalogs )

Construct an archive from catalogs.

Definition at line 166 of file InputArchive.cc.

        : _impl(new Impl(index, catalogs)) {}

InputArchive() [3/4]

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

default

Copy-constructor. Does not deep-copy loaded Persistables.

InputArchive() [4/4]

lsst::afw::table::io::InputArchive::InputArchive

(

InputArchive &&

other

)

Definition at line 171 of file InputArchive.cc.

: InputArchive(other) {}

~InputArchive()

lsst::afw::table::io::InputArchive::~InputArchive ( )

default

Member Function Documentation

get() [1/2]

std::shared_ptr< Persistable > lsst::afw::table::io::InputArchive::get

(

int

id

)

const

Load the Persistable with the given ID and return it.

If the object has already been loaded once, the same instance will be returned again.

Definition at line 179 of file InputArchive.cc.

{ return _impl->get(id, *this); }

get() [2/2]

template<typename T >

std::shared_ptr< T > lsst::afw::table::io::InputArchive::get ( int id ) const

inline

Load an object of the given type and ID with error checking.

Definition at line 60 of file InputArchive.h.

                                       {
        std::shared_ptr<T> p = std::dynamic_pointer_cast<T>(get(id));
        LSST_ARCHIVE_ASSERT(p || id == 0);
        return p;
    }

getAll()

InputArchive::Map const & lsst::afw::table::io::InputArchive::getAll

(

)

const

Load and return all objects in the archive.

Definition at line 181 of file InputArchive.cc.

{ return _impl->getAll(*this); }

operator=() [1/2]

InputArchive & lsst::afw::table::io::InputArchive::operator=

(

InputArchive &&

other

)

Definition at line 175 of file InputArchive.cc.

{ return *this = other; }

operator=() [2/2]

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

default

Assignment. Does not deep-copy loaded Persistables.

readFits()

InputArchive lsst::afw::table::io::InputArchive::readFits ( fits::Fits & fitsfile )

static

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file InputArchive.cc.

                                                      {
    BaseCatalog index = BaseCatalog::readFits(fitsfile);
    std::shared_ptr<daf::base::PropertyList> metadata = index.getTable()->popMetadata();
    assert(metadata);  // BaseCatalog::readFits should always read metadata, even if there's nothing there
    if (metadata->get<std::string>("EXTTYPE") != "ARCHIVE_INDEX") {
        throw LSST_FITS_EXCEPT(fits::FitsError, fitsfile,
                               boost::format("Wrong value for archive index EXTTYPE: '%s'") %
                                       metadata->get<std::string>("EXTTYPE"));
    }
    int nCatalogs = metadata->get<int>("AR_NCAT");
    CatalogVector catalogs;
    catalogs.reserve(nCatalogs);
    for (int n = 1; n < nCatalogs; ++n) {
        fitsfile.setHdu(1, true);  // increment HDU by one
        catalogs.push_back(BaseCatalog::readFits(fitsfile));
        metadata = catalogs.back().getTable()->popMetadata();
        if (metadata->get<std::string>("EXTTYPE") != "ARCHIVE_DATA") {
            throw LSST_FITS_EXCEPT(fits::FitsError, fitsfile,
                                   boost::format("Wrong value for archive data EXTTYPE: '%s'") %
                                           metadata->get<std::string>("EXTTYPE"));
        }
        if (metadata->get<int>("AR_CATN") != n) {
            throw LSST_FITS_EXCEPT(
                    fits::FitsError, fitsfile,
                    boost::format("Incorrect order for archive catalogs: AR_CATN=%d found at position %d") %
                            metadata->get<int>("AR_CATN") % n);
        }
    }
    std::shared_ptr<Impl> impl(new Impl(index, catalogs));
    return InputArchive(impl);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/table/io/InputArchive.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/table/io/InputArchive.cc