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

Writer object for FITS binary tables. More...

#include <FitsWriter.h>

Public Types
typedef afw::fits::Fits	Fits

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

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. More...
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. More...

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

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

Private Attributes
boost::shared_ptr< ProcessRecords >	_processor

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 22 of file FitsWriter.h.

Member Typedef Documentation

typedef afw::fits::Fits lsst::afw::table::io::FitsWriter::Fits

Definition at line 25 of file FitsWriter.h.

Constructor & Destructor Documentation

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

inlineexplicit

Construct from a wrapped cfitsio pointer.

Definition at line 80 of file FitsWriter.h.

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

Member Function Documentation

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

inlineprotectedvirtual

Finish writing a catalog.

Definition at line 91 of file FitsWriter.h.

{}

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

protectedvirtual

Write an individual record.

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

protectedvirtual

Write a table and its schema.

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 35 of file FitsWriter.h.

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

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 42 of file FitsWriter.h.

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

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 56 of file FitsWriter.h.

                                             {
        std::set<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 (std::set<PTR(BaseTable const)>::iterator j = tables.begin(); j != tables.end(); ++j) {
            if (
                (**j).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* lsst::afw::table::io::FitsWriter::_fits

protected

Definition at line 93 of file FitsWriter.h.

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

protected

Definition at line 94 of file FitsWriter.h.

boost::shared_ptr< ProcessRecords > lsst::afw::table::io::FitsWriter::_processor

private

Definition at line 99 of file FitsWriter.h.

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

protected

Definition at line 95 of file FitsWriter.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/table/io/FitsWriter.h