lsst.afw  19.0.0-25-g6c8df7140+1
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
lsst::afw::table::ExposureRecord Class Reference

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

#include <Exposure.h>

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

Public Types

typedef ExposureTable Table
 
typedef ColumnViewT< ExposureRecordColumnView
 
typedef ExposureCatalogT< ExposureRecordCatalog
 
typedef ExposureCatalogT< ExposureRecord const > ConstCatalog
 

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
 
ExposureRecordoperator= (ExposureRecord const &)=delete
 
ExposureRecordoperator= (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 >
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

Definition at line 83 of file Exposure.h.

◆ ColumnView

Definition at line 82 of file Exposure.h.

◆ ConstCatalog

Definition at line 84 of file Exposure.h.

◆ Table

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.

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

◆ _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 153 of file BaseRecord.cc.

◆ 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 123 of file BaseRecord.cc.

◆ 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 131 of file BaseRecord.cc.

◆ 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::LogicErrorif the ExposureRecord has no Wcs.

Definition at line 372 of file Exposure.cc.

◆ 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::LogicErrorif the ExposureRecord has no Wcs.

Definition at line 349 of file Exposure.cc.

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

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

◆ getApCorrMap()

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

Definition at line 145 of file Exposure.h.

◆ getBBox()

lsst::geom::Box2I lsst::afw::table::ExposureRecord::getBBox ( ) const

Definition at line 343 of file Exposure.cc.

◆ getDetector()

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

Definition at line 161 of file Exposure.h.

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

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

◆ getId()

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

Definition at line 492 of file Exposure.h.

◆ getManager()

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

Definition at line 200 of file BaseRecord.h.

◆ getPhotoCalib()

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

Definition at line 142 of file Exposure.h.

◆ getPsf()

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

Definition at line 139 of file Exposure.h.

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

◆ getTable()

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

Definition at line 99 of file Exposure.h.

◆ getTransmissionCurve()

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

Definition at line 154 of file Exposure.h.

◆ getValidPolygon()

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

Definition at line 148 of file Exposure.h.

◆ getVisitInfo()

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

Definition at line 151 of file Exposure.h.

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

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

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

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

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

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

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

◆ setApCorrMap()

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

Definition at line 146 of file Exposure.h.

◆ setBBox()

void lsst::afw::table::ExposureRecord::setBBox ( lsst::geom::Box2I const &  bbox)

Definition at line 347 of file Exposure.cc.

◆ setDetector()

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

Definition at line 162 of file Exposure.h.

◆ setId()

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

Definition at line 493 of file Exposure.h.

◆ setPhotoCalib()

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

Definition at line 143 of file Exposure.h.

◆ setPsf()

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

Definition at line 140 of file Exposure.h.

◆ setTransmissionCurve()

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

Definition at line 157 of file Exposure.h.

◆ setValidPolygon()

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

Definition at line 149 of file Exposure.h.

◆ setVisitInfo()

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

Definition at line 152 of file Exposure.h.

◆ setWcs()

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

Definition at line 137 of file Exposure.h.

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: