A simple Persistable struct containing ExposureCatalogs that record the inputs to a coadd. More...
#include <CoaddInputs.h>
Public Member Functions | |
| CoaddInputs () | |
| Default constructor. More... | |
| CoaddInputs (table::Schema const &visitSchema, table::Schema const &ccdSchema) | |
| Construct new catalogs from the given schemas. More... | |
| CoaddInputs (table::ExposureCatalog const &visits_, table::ExposureCatalog const &ccds_) | |
| Construct from shallow copies of the given catalogs. More... | |
| virtual bool | isPersistable () const |
| Whether the object is in fact persistable - in this case, always true. More... | |
 Public Member Functions inherited from lsst.afw.table.io::Persistable | |
| 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 | ~Persistable () |
Public Attributes | |
| table::ExposureCatalog | visits |
| table::ExposureCatalog | ccds |
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... | |
| Protected Member Functions inherited from lsst.afw.table.io::Persistable | |
| Persistable () | |
| Persistable (Persistable const &other) | |
| void | operator= (Persistable const &other) |
Additional Inherited Members | |
| Static Public Member Functions inherited from lsst.afw.table.io::PersistableFacade< CoaddInputs > | |
| static boost::shared_ptr < CoaddInputs > | readFits (fits::Fits &fitsfile) |
| Read an object from an already open FITS object. More... | |
| static boost::shared_ptr < CoaddInputs > | readFits (std::string const &fileName, int hdu=0) |
| Read an object from a regular FITS file. More... | |
| static boost::shared_ptr < CoaddInputs > | readFits (fits::MemFileManager &manager, int hdu=0) |
| Read an object from a FITS file in memory. More... | |
| Protected Types inherited from lsst.afw.table.io::Persistable | |
| typedef io::OutputArchiveHandle | OutputArchiveHandle |
Detailed Description
A simple Persistable struct containing ExposureCatalogs that record the inputs to a coadd.
The visits catalog corresponds to what task code refers to as coaddTempExps, while the ccds catalog corresponds to individual input CCD images (calexps), and has a "visitId" column that points back to the visits catalog.
The records in the visits catalog will all have the same Wcs as the coadd, as they represent images that have already been warped to the coadd frame. Regardless of whether or not the coadd is PSF-matched, the visit record Psf will generally be CoaddPsfs (albeit single-depth ones, so they simply pick out the single non-coadd-Psf that is valid for each point).
Definition at line 46 of file CoaddInputs.h.
Constructor & Destructor Documentation
| lsst.afw.image::CoaddInputs::CoaddInputs | ( | ) |
Default constructor.
This simply calls the Catalog default constructors, which means the catalogs have no associated Table and hence cannot be used for anything until a valid Catalog is assigned to them.
Definition at line 52 of file CoaddInputs.cc.
| lsst.afw.image::CoaddInputs::CoaddInputs | ( | table::Schema const & | visitSchema, |
| table::Schema const & | ccdSchema | ||
| ) |
| lsst.afw.image::CoaddInputs::CoaddInputs | ( | table::ExposureCatalog const & | visits_, |
| table::ExposureCatalog const & | ccds_ | ||
| ) |
Member Function Documentation
|
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 from lsst.afw.table.io::Persistable.
Definition at line 64 of file CoaddInputs.cc.
|
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 from lsst.afw.table.io::Persistable.
Definition at line 66 of file CoaddInputs.cc.
|
virtual |
Whether the object is in fact persistable - in this case, always true.
To avoid letting coadd provenance prevent coadd code from running, if a nested Wcs or Psf is not persistable, it will silently not be saved, instead of throwing an exception.
Reimplemented from lsst.afw.table.io::Persistable.
Definition at line 62 of file CoaddInputs.cc.
|
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 from lsst.afw.table.io::Persistable.
Definition at line 68 of file CoaddInputs.cc.
Member Data Documentation
| table::ExposureCatalog lsst.afw.image::CoaddInputs::ccds |
Definition at line 49 of file CoaddInputs.h.
| table::ExposureCatalog lsst.afw.image::CoaddInputs::visits |
Definition at line 48 of file CoaddInputs.h.
The documentation for this class was generated from the following files:
- /home/lsstsw/stack/Linux64/afw/11.0.rc2+4/include/lsst/afw/image/CoaddInputs.h
- /home/lsstsw/stack/Linux64/afw/11.0.rc2+4/src/image/CoaddInputs.cc
