lsst::afw::table::io::FitsWriter Class Reference

Writer object for FITS binary tables. More...

#include <FitsWriter.h>

Classes
struct	ProcessRecords

Public Types
using	Fits = afw::fits::Fits

Public Member Functions
template<typename ContainerT>
void	write (ContainerT const &container)
	Write records in a container to disk.
	FitsWriter (Fits *fits, int flags)
	Construct from a wrapped cfitsio pointer.
	FitsWriter (FitsWriter const &)=default
	FitsWriter (FitsWriter &&)=default
FitsWriter &	operator= (FitsWriter const &)=default
FitsWriter &	operator= (FitsWriter &&)=default
virtual	~FitsWriter ()=default

Static Public Member Functions
template<typename OutputT, typename ContainerT>
static void	apply (OutputT &output, std::string const &mode, ContainerT const &container, int flags)
	Driver for writing FITS files.
template<typename ContainerT>
static void	apply (Fits &fits, ContainerT const &container, int flags)
	Low-level driver for writing FITS files, operating on an open FITS file.

Protected Member Functions
virtual void	_writeTable (std::shared_ptr< BaseTable const > const &table, std::size_t nRows)
	Write a table and its schema.
virtual void	_writeRecord (BaseRecord const &source)
	Write an individual record.
virtual void	_finish ()
	Finish writing a catalog.

Protected Attributes
Fits *	_fits
int	_flags
std::size_t	_row

Detailed Description

Writer object for FITS binary tables.

FitsWriter itself provides support for writing FITS binary tables from base containers. Derived record/base pairs should derive their own writer from FitsWriter and reimplement BaseTable::makeFitsWriter to return it. Subclasses will usually delegate most of the work back to FitsWriter.

Definition at line 25 of file FitsWriter.h.

Member Typedef Documentation

Fits

using lsst::afw::table::io::FitsWriter::Fits = afw::fits::Fits

Definition at line 27 of file FitsWriter.h.

Constructor & Destructor Documentation

FitsWriter() [1/3]

lsst::afw::table::io::FitsWriter::FitsWriter ( Fits * fits, int flags )

inlineexplicit

Construct from a wrapped cfitsio pointer.

Definition at line 78 of file FitsWriter.h.

: _fits(fits), _flags(flags) {}

FitsWriter() [2/3]

lsst::afw::table::io::FitsWriter::FitsWriter ( FitsWriter const & )

default

FitsWriter() [3/3]

lsst::afw::table::io::FitsWriter::FitsWriter ( FitsWriter && )

default

~FitsWriter()

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

virtualdefault

Member Function Documentation

_finish()

virtual void lsst::afw::table::io::FitsWriter::_finish ( )

inlineprotectedvirtual

Finish writing a catalog.

Definition at line 94 of file FitsWriter.h.

{}

_writeRecord()

void lsst::afw::table::io::FitsWriter::_writeRecord ( BaseRecord const & source )

protectedvirtual

Write an individual record.

Definition at line 188 of file FitsWriter.cc.

                                                      {
    ++_row;
    _processor->apply(&record);
}

_writeTable()

void lsst::afw::table::io::FitsWriter::_writeTable ( std::shared_ptr< BaseTable const > const & table, std::size_t nRows )

protectedvirtual

Write a table and its schema.

Definition at line 102 of file FitsWriter.cc.

                                                                                         {
    Schema schema = table->getSchema();
    _fits->createTable();
    LSST_FITS_CHECK_STATUS(*_fits, "creating table");
    std::size_t nFlags = schema.getFlagFieldCount();
    if (nFlags > 0) {
        int n = _fits->addColumn<bool>("flags", nFlags, "bits for all Flag fields; see also TFLAGn");
        _fits->writeKey("FLAGCOL", n + 1, "Column number for the bitflags.");
    }
    ProcessSchema::apply(*_fits, schema);
    writeAliasMap(*_fits, *schema.getAliasMap());
    // write the version number to the fits header, plus any other metadata
    std::shared_ptr<daf::base::PropertyList> metadata = table->getMetadata();
    if (!metadata) {
        metadata = std::make_shared<daf::base::PropertyList>();
    }
    metadata->set<int>("AFW_TABLE_VERSION", Schema::VERSION);
    _fits->writeMetadata(*metadata);
    // In case the metadata was attached to the table, clean it up.
    metadata->remove("AFW_TABLE_VERSION");
    _row = -1;
    _fits->addRows(nRows);
    _processor = std::make_shared<ProcessRecords>(_fits, schema, nFlags, _row);
}

apply() [1/2]

template<typename ContainerT>

static void lsst::afw::table::io::FitsWriter::apply ( Fits & fits, ContainerT const & container, int flags )

inlinestatic

Low-level driver for writing FITS files, operating on an open FITS file.

Definition at line 44 of file FitsWriter.h.

                                                                          {
        std::shared_ptr<FitsWriter> writer =
                std::static_pointer_cast<BaseTable const>(container.getTable())->makeFitsWriter(&fits, flags);
        writer->write(container);
    }

apply() [2/2]

template<typename OutputT, typename ContainerT>

static void lsst::afw::table::io::FitsWriter::apply ( OutputT & output, std::string const & mode, ContainerT const & container, int flags )

inlinestatic

Driver for writing FITS files.

A container class will usually provide a member function that calls this driver, which opens the FITS file, calls makeFitsWriter on the container's table, and then calls Writer::write on it.

Definition at line 37 of file FitsWriter.h.

                                                                                                      {
        Fits fits(output, mode, Fits::AUTO_CLOSE | Fits::AUTO_CHECK);
        apply(fits, container, flags);
    }

operator=() [1/2]

FitsWriter & lsst::afw::table::io::FitsWriter::operator= ( FitsWriter && )

default

operator=() [2/2]

FitsWriter & lsst::afw::table::io::FitsWriter::operator= ( FitsWriter const & )

default

write()

template<typename ContainerT>

void lsst::afw::table::io::FitsWriter::write ( ContainerT const & container )

inline

Write records in a container to disk.

The given container must have a getTable() member function that returns a shared_ptr to a table, and the iterators returned by begin() and end() must dereference to a type convertible to BaseRecord const &.

Definition at line 58 of file FitsWriter.h.

                                            {
        std::set<std::shared_ptr<BaseTable const>> tables;
        for (typename ContainerT::const_iterator i = container.begin(); i != container.end(); ++i) {
            if (i->getTable() != container.getTable()) tables.insert(i->getTable());
        }
        for (auto const &table : tables) {
            if ((*table).getSchema().compare(container.getTable()->getSchema(), Schema::IDENTICAL) !=
                Schema::IDENTICAL) {
                throw LSST_EXCEPT(pex::exceptions::LogicError,
                                  "Cannot save Catalog with heterogenous schemas");
            }
        }
        _writeTable(container.getTable(), container.size());
        for (typename ContainerT::const_iterator i = container.begin(); i != container.end(); ++i) {
            _writeRecord(*i);
        }
        _finish();
    }

Member Data Documentation

_fits

Fits* lsst::afw::table::io::FitsWriter::_fits

protected

Definition at line 96 of file FitsWriter.h.

_flags

int lsst::afw::table::io::FitsWriter::_flags

protected

Definition at line 97 of file FitsWriter.h.

_row

std::size_t lsst::afw::table::io::FitsWriter::_row

protected

Definition at line 98 of file FitsWriter.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/table/io/FitsWriter.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/table/io/FitsWriter.cc