lsst::afw::table::ExposureRecord Class Reference

Record class used to store exposure metadata. More...

#include <Exposure.h>

Inheritance diagram for lsst::afw::table::ExposureRecord:

Public Types
using	Table = ExposureTable
using	ColumnView = ColumnViewT< ExposureRecord >
using	Catalog = ExposureCatalogT< ExposureRecord >
using	ConstCatalog = ExposureCatalogT< const ExposureRecord >

Public Member Functions
	ExposureRecord (ConstructionToken const &token, detail::RecordData &&data)
	Constructor used by ExposureTable. More...
std::shared_ptr< ExposureTable const >	getTable () const
RecordId	getId () const
void	setId (RecordId id)
lsst::geom::Box2I	getBBox () const
void	setBBox (lsst::geom::Box2I const &bbox)
bool	contains (lsst::geom::SpherePoint const &coord, bool includeValidPolygon=false) const
	Return true if the bounding box contains the given celestial coordinate point, taking into account the Wcs of the ExposureRecord. More...
bool	contains (lsst::geom::Point2D const &point, geom::SkyWcs const &wcs, bool includeValidPolygon=false) const
	Return true if the bounding box contains the given point, taking into account its Wcs (given) and the Wcs of the ExposureRecord. More...
std::shared_ptr< geom::SkyWcs const >	getWcs () const
	Get/Set the the attached Wcs, Psf, PhotoCalib, or ApCorrMap. No copies are made. More...
void	setWcs (std::shared_ptr< geom::SkyWcs const > wcs)
std::shared_ptr< detection::Psf const >	getPsf () const
void	setPsf (std::shared_ptr< detection::Psf const > psf)
std::shared_ptr< image::PhotoCalib const >	getPhotoCalib () const
void	setPhotoCalib (std::shared_ptr< image::PhotoCalib const > photoCalib)
std::shared_ptr< image::ApCorrMap const >	getApCorrMap () const
void	setApCorrMap (std::shared_ptr< image::ApCorrMap const > apCorrMap)
std::shared_ptr< geom::polygon::Polygon const >	getValidPolygon () const
void	setValidPolygon (std::shared_ptr< geom::polygon::Polygon const > polygon)
std::shared_ptr< image::VisitInfo const >	getVisitInfo () const
void	setVisitInfo (std::shared_ptr< image::VisitInfo const > visitInfo)
std::shared_ptr< image::TransmissionCurve const >	getTransmissionCurve () const
void	setTransmissionCurve (std::shared_ptr< image::TransmissionCurve const > transmissionCurve)
std::shared_ptr< cameraGeom::Detector const >	getDetector () const
void	setDetector (std::shared_ptr< cameraGeom::Detector const > detector)
	ExposureRecord (ExposureRecord const &)=delete
	ExposureRecord (ExposureRecord &&)=delete
ExposureRecord &	operator= (ExposureRecord const &)=delete
ExposureRecord &	operator= (ExposureRecord &&)=delete
	~ExposureRecord () override
Schema	getSchema () const
	Return the Schema that holds this record's fields and keys. More...
template<typename T >
Field< T >::Element *	getElement (Key< T > const &key)
	Return a pointer to the underlying elements of a field (non-const). More...
template<typename T >
Field< T >::Element const *	getElement (Key< T > const &key) const
	Return a pointer to the underlying elements of a field (const). More...
template<typename T >
Field< T >::Reference	operator[] (Key< T > const &key)
	Return a reference (or reference-like type) to the field's value. More...
template<typename T >
Field< T >::ConstReference	operator[] (Key< T > const &key) const
	Return a const reference (or const-reference-like type) to the field's value. More...
template<typename Ref >
Ref	operator[] (ReferenceFunctorKey< Ref > const &key)
template<typename ConstRef >
ConstRef	operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
template<typename T >
Field< T >::Value	get (Key< T > const &key) const
	Return the value of a field for the given key. More...
template<typename T >
T	get (OutputFunctorKey< T > const &key) const
	Compute a calculated or aggregate field. More...
template<typename T , typename U >
void	set (Key< T > const &key, U const &value)
	Set value of a field for the given key. More...
template<typename T , typename U >
void	set (InputFunctorKey< T > const &key, U const &value)
	Set a calculated or aggregate field. More...
void	assign (BaseRecord const &other)
	Copy all field values from other to this, requiring that they have equal schemas. More...
void	assign (BaseRecord const &other, SchemaMapper const &mapper)
	Copy field values from other to this, using a mapper. More...
ndarray::Manager::Ptr	getManager () const

Protected Member Functions
void	_assign (BaseRecord const &other) override
	Called by assign() after transferring fields to allow subclass data members to be copied. More...
virtual void	_stream (std::ostream &os) const
	Called by operator<<. More...

Friends
class	ExposureTable

Detailed Description

Record class used to store exposure metadata.

Definition at line 79 of file Exposure.h.

Member Typedef Documentation

Catalog

using lsst::afw::table::ExposureRecord::Catalog = ExposureCatalogT<ExposureRecord>

Definition at line 83 of file Exposure.h.

ColumnView

using lsst::afw::table::ExposureRecord::ColumnView = ColumnViewT<ExposureRecord>

Definition at line 82 of file Exposure.h.

ConstCatalog

using lsst::afw::table::ExposureRecord::ConstCatalog = ExposureCatalogT<const ExposureRecord>

Definition at line 84 of file Exposure.h.

Table

using lsst::afw::table::ExposureRecord::Table = ExposureTable

Definition at line 81 of file Exposure.h.

Constructor & Destructor Documentation

ExposureRecord() [1/3]

lsst::afw::table::ExposureRecord::ExposureRecord ( ConstructionToken const &  token, detail::RecordData &&  data  )

inline

Constructor used by ExposureTable.

While formally public, this constructor is conceptually and effectively protected, due to the (protected) ConstructionToken argument.

This is to allow make_shared to be used, as that cannot be used on a truly protected or private constructor.

Definition at line 95 of file Exposure.h.

                                                                              :
        BaseRecord(token, std::move(data))
    {}

ExposureRecord() [2/3]

lsst::afw::table::ExposureRecord::ExposureRecord ( ExposureRecord const &  )

delete

ExposureRecord() [3/3]

lsst::afw::table::ExposureRecord::ExposureRecord ( ExposureRecord &&  )

delete

~ExposureRecord()

lsst::afw::table::ExposureRecord::~ExposureRecord ( )

overridedefault

Member Function Documentation

_assign()

void lsst::afw::table::ExposureRecord::_assign ( BaseRecord const &  other )

overrideprotectedvirtual

Called by assign() after transferring fields to allow subclass data members to be copied.

Reimplemented from lsst::afw::table::BaseRecord.

Definition at line 379 of file Exposure.cc.

                                                    {
    try {
        ExposureRecord const &s = dynamic_cast<ExposureRecord const &>(other);
        _psf = s._psf;
        _wcs = s._wcs;
        _photoCalib = s._photoCalib;
        _apCorrMap = s._apCorrMap;
        _validPolygon = s._validPolygon;
        _visitInfo = s._visitInfo;
        _transmissionCurve = s._transmissionCurve;
        _detector = s._detector;
    } catch (std::bad_cast &) {
    }
}

_stream()

void lsst::afw::table::BaseRecord::_stream ( std::ostream &  os ) const

protectedvirtualinherited

Called by operator<<.

Overrides should call the base class implementation and append additional fields on new lines, with the syntax "%(name)s: %(value)s".

Definition at line 152 of file BaseRecord.cc.

                                             {
    getSchema().forEach([&os, this](auto const& item) {
        os << item.field.getName() << ": " << this->get(item.key) << std::endl;
    });
}

assign() [1/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const &  other )

inherited

Copy all field values from other to this, requiring that they have equal schemas.

Definition at line 122 of file BaseRecord.cc.

                                               {
    if (this->getSchema() != other.getSchema()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError, "Unequal schemas in record assignment.");
    }
    this->getSchema().forEach(CopyValue(&other, this));
    this->_assign(other);  // let derived classes assign their own stuff
}

assign() [2/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const &  other, SchemaMapper const &  mapper  )

inherited

Copy field values from other to this, using a mapper.

Definition at line 130 of file BaseRecord.cc.

                                                                           {
    if (!other.getSchema().contains(mapper.getInputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between input record and mapper.");
    }
    if (!this->getSchema().contains(mapper.getOutputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between output record and mapper.");
    }
    mapper.forEach(CopyValue(&other, this));  // use the functor we defined above
    this->_assign(other);                     // let derived classes assign their own stuff
}

contains() [1/2]

bool lsst::afw::table::ExposureRecord::contains	(	lsst::geom::Point2D const &	point,
		geom::SkyWcs const &	wcs,
		bool	includeValidPolygon = false
	)		const

Return true if the bounding box contains the given point, taking into account its Wcs (given) and the Wcs of the ExposureRecord.

If includeValidPolygon is true it will also check that the point is within the validPolygon of this ExposureRecord if present if it has one; otherwise, this argument is ignored.

Exceptions

pex::exceptions::LogicError

if the ExposureRecord has no Wcs.

Definition at line 372 of file Exposure.cc.

                                                              {
    return contains(wcs.pixelToSky(point), includeValidPolygon);
}

contains() [2/2]

bool lsst::afw::table::ExposureRecord::contains	(	lsst::geom::SpherePoint const &	coord,
		bool	includeValidPolygon = false
	)		const

Return true if the bounding box contains the given celestial coordinate point, taking into account the Wcs of the ExposureRecord.

If includeValidPolygon is true it will also check that the point is within the validPolygon of this ExpoureRecord if it has one; otherwise, this argument is ignored.

Exceptions

pex::exceptions::LogicError

if the ExposureRecord has no Wcs.

Definition at line 349 of file Exposure.cc.

                                                                                              {
    if (!getWcs()) {
        throw LSST_EXCEPT(pex::exceptions::LogicError,
                          "ExposureRecord does not have a Wcs; cannot call contains()");
    }
 
    // If there is no valid polygon set to false
    if (includeValidPolygon && !getValidPolygon()) {
        includeValidPolygon = false;
    }
 
    try {
        lsst::geom::Point2D point = getWcs()->skyToPixel(coord);
        if (includeValidPolygon)
            return (lsst::geom::Box2D(getBBox()).contains(point) && getValidPolygon()->contains(point));
        else
            return lsst::geom::Box2D(getBBox()).contains(point);
    } catch (pex::exceptions::DomainError &) {
        // SkyWcs can throw if the given coordinate is outside the region where the WCS is valid.
        return false;
    }
}

get() [1/2]

template<typename T >

Field<T>::Value lsst::afw::table::BaseRecord::get ( Key< T > const &  key ) const

inlineinherited

Return the value of a field for the given key.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 151 of file BaseRecord.h.

                                                        {
        return key.getValue(getElement(key), _manager);
    }

get() [2/2]

template<typename T >

T lsst::afw::table::BaseRecord::get ( OutputFunctorKey< T > const &  key ) const

inlineinherited

Compute a calculated or aggregate field.

Definition at line 172 of file BaseRecord.h.

                                                {
        return key.get(*this);
    }

getApCorrMap()

std::shared_ptr<image::ApCorrMap const> lsst::afw::table::ExposureRecord::getApCorrMap ( ) const

inline

Definition at line 145 of file Exposure.h.

{ return _apCorrMap; }

getBBox()

lsst::geom::Box2I lsst::afw::table::ExposureRecord::getBBox

(

)

const

Definition at line 343 of file Exposure.cc.

                                            {
    return lsst::geom::Box2I(get(ExposureTable::getBBoxKey()));
}

getDetector()

std::shared_ptr<cameraGeom::Detector const> lsst::afw::table::ExposureRecord::getDetector ( ) const

inline

Definition at line 161 of file Exposure.h.

{ return _detector; }

getElement() [1/2]

template<typename T >

Field<T>::Element* lsst::afw::table::BaseRecord::getElement ( Key< T > const &  key )

inlineinherited

Return a pointer to the underlying elements of a field (non-const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 93 of file BaseRecord.h.

                                                            {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element*>(reinterpret_cast<char*>(_data) +
                                                             key.getOffset());
    }

getElement() [2/2]

template<typename T >

Field<T>::Element const* lsst::afw::table::BaseRecord::getElement ( Key< T > const &  key ) const

inlineinherited

Return a pointer to the underlying elements of a field (const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 111 of file BaseRecord.h.

                                                                        {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element const*>(reinterpret_cast<char const*>(_data) +
                                                                   key.getOffset());
    }

getId()

RecordId lsst::afw::table::ExposureRecord::getId ( ) const

inline

Definition at line 492 of file Exposure.h.

{ return get(ExposureTable::getIdKey()); }

getManager()

ndarray::Manager::Ptr lsst::afw::table::BaseRecord::getManager ( ) const

inlineinherited

Definition at line 200 of file BaseRecord.h.

{ return _manager; }

getPhotoCalib()

std::shared_ptr<image::PhotoCalib const> lsst::afw::table::ExposureRecord::getPhotoCalib ( ) const

inline

Definition at line 142 of file Exposure.h.

{ return _photoCalib; }

getPsf()

std::shared_ptr<detection::Psf const> lsst::afw::table::ExposureRecord::getPsf ( ) const

inline

Definition at line 139 of file Exposure.h.

{ return _psf; }

getSchema()

Schema lsst::afw::table::BaseRecord::getSchema ( ) const

inlineinherited

Return the Schema that holds this record's fields and keys.

Definition at line 80 of file BaseRecord.h.

{ return _table->getSchema(); }

getTable()

std::shared_ptr<ExposureTable const> lsst::afw::table::ExposureRecord::getTable ( ) const

inline

Definition at line 99 of file Exposure.h.

                                                        {
        return std::static_pointer_cast<ExposureTable const>(BaseRecord::getTable());
    }

getTransmissionCurve()

std::shared_ptr<image::TransmissionCurve const> lsst::afw::table::ExposureRecord::getTransmissionCurve ( ) const

inline

Definition at line 154 of file Exposure.h.

                                                                             {
        return _transmissionCurve;
    }

getValidPolygon()

std::shared_ptr<geom::polygon::Polygon const> lsst::afw::table::ExposureRecord::getValidPolygon ( ) const

inline

Definition at line 148 of file Exposure.h.

{ return _validPolygon; }

getVisitInfo()

std::shared_ptr<image::VisitInfo const> lsst::afw::table::ExposureRecord::getVisitInfo ( ) const

inline

Definition at line 151 of file Exposure.h.

{ return _visitInfo; }

getWcs()

std::shared_ptr<geom::SkyWcs const> lsst::afw::table::ExposureRecord::getWcs ( ) const

inline

Get/Set the the attached Wcs, Psf, PhotoCalib, or ApCorrMap. No copies are made.

Definition at line 136 of file Exposure.h.

{ return _wcs; }

operator=() [1/2]

ExposureRecord& lsst::afw::table::ExposureRecord::operator= ( ExposureRecord &&  )

delete

operator=() [2/2]

ExposureRecord& lsst::afw::table::ExposureRecord::operator= ( ExposureRecord const &  )

delete

operator[]() [1/4]

template<typename ConstRef >

ConstRef lsst::afw::table::BaseRecord::operator[] ( ConstReferenceFunctorKey< ConstRef > const &  key ) const

inlineinherited

Definition at line 190 of file BaseRecord.h.

                                                                             {
        return key.getConstReference(*this);
    }

operator[]() [2/4]

template<typename T >

Field<T>::Reference lsst::afw::table::BaseRecord::operator[] ( Key< T > const &  key )

inlineinherited

Return a reference (or reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 129 of file BaseRecord.h.

                                                             {
        return key.getReference(getElement(key), _manager);
    }

operator[]() [3/4]

template<typename T >

Field<T>::ConstReference lsst::afw::table::BaseRecord::operator[] ( Key< T > const &  key ) const

inlineinherited

Return a const reference (or const-reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 141 of file BaseRecord.h.

                                                                        {
        return key.getConstReference(getElement(key), _manager);
    }

operator[]() [4/4]

template<typename Ref >

Ref lsst::afw::table::BaseRecord::operator[] ( ReferenceFunctorKey< Ref > const &  key )

inlineinherited

Definition at line 185 of file BaseRecord.h.

                                                        {
        return key.getReference(*this);
    }

set() [1/2]

template<typename T , typename U >

void lsst::afw::table::BaseRecord::set ( InputFunctorKey< T > const &  key, U const &  value  )

inlineinherited

Set a calculated or aggregate field.

Definition at line 180 of file BaseRecord.h.

                                                            {
        return key.set(*this, value);
    }

set() [2/2]

template<typename T , typename U >

void lsst::afw::table::BaseRecord::set ( Key< T > const &  key, U const &  value  )

inlineinherited

Set value of a field for the given key.

This method has an additional template parameter because some fields accept and convert different types to the stored field type.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 164 of file BaseRecord.h.

                                                {
        key.setValue(getElement(key), _manager, value);
    }

setApCorrMap()

void lsst::afw::table::ExposureRecord::setApCorrMap ( std::shared_ptr< image::ApCorrMap const >  apCorrMap )

inline

Definition at line 146 of file Exposure.h.

{ _apCorrMap = apCorrMap; }

setBBox()

void lsst::afw::table::ExposureRecord::setBBox

(

lsst::geom::Box2I const &

bbox

)

Definition at line 347 of file Exposure.cc.

{ set(ExposureTable::getBBoxKey(), bbox); }

setDetector()

void lsst::afw::table::ExposureRecord::setDetector ( std::shared_ptr< cameraGeom::Detector const >  detector )

inline

Definition at line 162 of file Exposure.h.

                                                                       {
        _detector = std::move(detector);
    }

setId()

void lsst::afw::table::ExposureRecord::setId ( RecordId  id )

inline

Definition at line 493 of file Exposure.h.

{ set(ExposureTable::getIdKey(), id); }

setPhotoCalib()

void lsst::afw::table::ExposureRecord::setPhotoCalib ( std::shared_ptr< image::PhotoCalib const >  photoCalib )

inline

Definition at line 143 of file Exposure.h.

{ _photoCalib = photoCalib; }

setPsf()

void lsst::afw::table::ExposureRecord::setPsf ( std::shared_ptr< detection::Psf const >  psf )

inline

Definition at line 140 of file Exposure.h.

{ _psf = psf; }

setTransmissionCurve()

void lsst::afw::table::ExposureRecord::setTransmissionCurve ( std::shared_ptr< image::TransmissionCurve const >  transmissionCurve )

inline

Definition at line 157 of file Exposure.h.

                                                                                             {
        _transmissionCurve = std::move(transmissionCurve);
    }

setValidPolygon()

void lsst::afw::table::ExposureRecord::setValidPolygon ( std::shared_ptr< geom::polygon::Polygon const >  polygon )

inline

Definition at line 149 of file Exposure.h.

{ _validPolygon = polygon; }

setVisitInfo()

void lsst::afw::table::ExposureRecord::setVisitInfo ( std::shared_ptr< image::VisitInfo const >  visitInfo )

inline

Definition at line 152 of file Exposure.h.

{ _visitInfo = visitInfo; }

setWcs()

void lsst::afw::table::ExposureRecord::setWcs ( std::shared_ptr< geom::SkyWcs const >  wcs )

inline

Definition at line 137 of file Exposure.h.

{ _wcs = wcs; }

Friends And Related Function Documentation

ExposureTable

friend class ExposureTable

friend

Definition at line 178 of file Exposure.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/table/Exposure.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/table/Exposure.cc