A simple Persistable struct containing ExposureCatalogs that record the inputs to a coadd. More...

#include <CoaddInputs.h>

Inheritance diagram for lsst::afw::image::CoaddInputs:

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

	CoaddInputs (CoaddInputs const &)

	CoaddInputs (CoaddInputs &&)

CoaddInputs &	operator= (CoaddInputs const &)

CoaddInputs &	operator= (CoaddInputs &&)

	~CoaddInputs () override

bool	isPersistable () const noexcept override
	Whether the object is in fact persistable - in this case, always true. More...

std::shared_ptr< typehandling::Storable >	cloneStorable () const override
	Create a new CoaddInputs that is a copy of this one. More...

virtual std::string	toString () const
	Create a string representation of this object (optional operation). More...

virtual std::size_t	hash_value () const
	Return a hash of this object (optional operation). More...

virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable. More...

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

Static Public Member Functions
static std::shared_ptr< CoaddInputs >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static std::shared_ptr< CoaddInputs >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...

static std::shared_ptr< CoaddInputs >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...

static std::shared_ptr< CoaddInputs >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

Public Attributes
table::ExposureCatalog	visits

table::ExposureCatalog	ccds

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory. More...

std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs. More...

Static Protected Member Functions
template<class T >
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable. More...

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 49 of file CoaddInputs.h.

Member Typedef Documentation

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ CoaddInputs() [1/5]

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 56 of file CoaddInputs.cc.

56 : visits(), ccds() {}

lsst::afw::image::CoaddInputs::visits

table::ExposureCatalog visits

Definition: CoaddInputs.h:51

lsst::afw::image::CoaddInputs::ccds

table::ExposureCatalog ccds

Definition: CoaddInputs.h:52

◆ CoaddInputs() [2/5]

lsst::afw::image::CoaddInputs::CoaddInputs	(	table::Schema const &	visitSchema,
		table::Schema const &	ccdSchema
	)

Construct new catalogs from the given schemas.

Definition at line 58 of file CoaddInputs.cc.

59 : visits(visitSchema), ccds(ccdSchema) {}

◆ CoaddInputs() [3/5]

lsst::afw::image::CoaddInputs::CoaddInputs	(	table::ExposureCatalog const &	visits_,
		table::ExposureCatalog const &	ccds_
	)

Construct from shallow copies of the given catalogs.

Definition at line 61 of file CoaddInputs.cc.

62 : visits(visits_), ccds(ccds_) {}

◆ CoaddInputs() [4/5]

lsst::afw::image::CoaddInputs::CoaddInputs ( CoaddInputs const & )

default

◆ CoaddInputs() [5/5]

lsst::afw::image::CoaddInputs::CoaddInputs ( CoaddInputs && )

default

◆ ~CoaddInputs()

lsst::afw::image::CoaddInputs::~CoaddInputs ( )

overridedefault

Member Function Documentation

◆ cloneStorable()

std::shared_ptr< typehandling::Storable > lsst::afw::image::CoaddInputs::cloneStorable ( ) const

overridevirtual

Create a new CoaddInputs that is a copy of this one.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 72 of file CoaddInputs.cc.

                                                                      {
     return std::make_unique<CoaddInputs>(*this);
 }

◆ dynamicCast()

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

staticinherited

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::LogicError if the cast fails

param[in] ptr The pointer to be cast.

Returns: The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError If the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

                                                                                         {
     auto result = std::dynamic_pointer_cast<T>(ptr);
     if (!result) {
         throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
     }
     return result;
 }

◆ equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const & other ) const

virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns: This implementation returns whether the two objects are the same.

Warning: This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also: singleClassEquals

Note: When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 48 of file Storable.cc.

48 { return this == &other; }

◆ getPersistenceName()

std::string lsst::afw::image::CoaddInputs::getPersistenceName ( ) const

overrideprotectedvirtual

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 76 of file CoaddInputs.cc.

76 { return "CoaddInputs"; }

◆ getPythonModule()

std::string lsst::afw::image::CoaddInputs::getPythonModule ( ) const

overrideprotectedvirtual

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 78 of file CoaddInputs.cc.

78 { return "lsst.afw.image"; }

◆ hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException Thrown if this object is not hashable.

Note: C++ subclass authors are responsible for any associated specializations of std::hash.; When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::FilterLabel, and lsst::afw::geom::polygon::Polygon.

Definition at line 44 of file Storable.cc.

                                      {
     throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
 }

◆ isPersistable()

bool lsst::afw::image::CoaddInputs::isPersistable ( ) const

overridevirtualnoexcept

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 70 of file CoaddInputs.cc.

70 { return true; }

◆ operator=() [1/2]

CoaddInputs & lsst::afw::image::CoaddInputs::operator= ( CoaddInputs && )

default

◆ operator=() [2/2]

CoaddInputs & lsst::afw::image::CoaddInputs::operator= ( CoaddInputs const & )

default

◆ readFits() [1/3]

static std::shared_ptr<CoaddInputs > lsst::afw::table::io::PersistableFacade< CoaddInputs >::readFits ( fits::Fits & fitsfile )

inlinestaticinherited

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 Persistable.h.

                                                          {
         return dynamicCast(Persistable::_readFits(fitsfile));
     }

◆ readFits() [2/3]

static std::shared_ptr<CoaddInputs > lsst::afw::table::io::PersistableFacade< CoaddInputs >::readFits	(	fits::MemFileManager &	manager,
		int	hdu = `fits::DEFAULT_HDU`
	)

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU 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.

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

◆ readFits() [3/3]

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

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU 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.

                                                                                            {
         return dynamicCast(Persistable::_readFits(fileName, hdu));
     }

◆ singleClassEquals()

template<class T >

static bool lsst::afw::typehandling::Storable::singleClassEquals	(	T const &	lhs,
		Storable const &	rhs
	)

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns: true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety: Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note: This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

                                                                      {
         auto typedRhs = dynamic_cast<T const*>(&rhs);
         if (typedRhs != nullptr) {
             return lhs == *typedRhs;
         } else {
             return false;
         }
     }

◆ toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const

virtualinherited

Create a string representation of this object (optional operation).

Exceptions

UnsupportedOperationException Thrown if this object does not have a string representation.

Note: When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::geom::SkyWcs, and lsst::afw::geom::polygon::Polygon.

Definition at line 40 of file Storable.cc.

                                    {
     throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
 }

◆ write()

void lsst::afw::image::CoaddInputs::write ( OutputArchiveHandle & handle ) const

overrideprotectedvirtual

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 80 of file CoaddInputs.cc.

                                                          {
     visits.writeToArchive(handle, true);  // true == permissive - just ignore Psfs, Wcss that can't be saved
     ccds.writeToArchive(handle, true);
 }

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits & fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in] fitsfile Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                     {
     OutputArchive archive;
     archive.put(this);
     archive.writeFits(fitsfile);
 }

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits	(	fits::MemFileManager &	manager,
		std::string const &	mode = `"w"`
	)		const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                     {
     fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
     writeFits(fitsfile);
 }

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits	(	std::string const &	fileName,
		std::string const &	mode = `"w"`
	)		const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                   {
     fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
     writeFits(fitsfile);
 }

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		Storable const &	storable
	)

Parameters

os	the desired output stream
storable	the object to print

Returns: a reference to os

Exceptions

UnsupportedOperationException Thrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

                                                                         {
     return os << storable.toString();
 }

Member Data Documentation

◆ ccds

table::ExposureCatalog lsst::afw::image::CoaddInputs::ccds

Definition at line 52 of file CoaddInputs.h.

◆ visits

table::ExposureCatalog lsst::afw::image::CoaddInputs::visits

Definition at line 51 of file CoaddInputs.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/image/CoaddInputs.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/image/CoaddInputs.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Related Functions

Detailed Description

Member Typedef Documentation

◆ OutputArchiveHandle

Constructor & Destructor Documentation

◆ CoaddInputs() [1/5]

◆ CoaddInputs() [2/5]

◆ CoaddInputs() [3/5]

◆ CoaddInputs() [4/5]

◆ CoaddInputs() [5/5]

◆ ~CoaddInputs()

Member Function Documentation

◆ cloneStorable()

◆ dynamicCast()

◆ equals()

◆ getPersistenceName()

◆ getPythonModule()

◆ hash_value()

◆ isPersistable()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ readFits() [1/3]

◆ readFits() [2/3]

◆ readFits() [3/3]

◆ singleClassEquals()

◆ toString()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]

Friends And Related Function Documentation

◆ operator<<()

Member Data Documentation

◆ ccds

◆ visits