lsst.meas.algorithms gabd7814034+ee5e81ffff
Public Types | Public Member Functions | List of all members
lsst::meas::algorithms::ExposurePatch< ExposureT > Class Template Reference

A convenience container for the exposure, peak and footprint that will be measured. More...

#include <ExposurePatch.h>

Public Types

typedef unsigned char FlagT
 Type for flags. More...
 
typedef std::shared_ptr< ExposurePatchPtr
 
typedef std::shared_ptr< ExposurePatch const > ConstPtr
 

Public Member Functions

 ExposurePatch (std::shared_ptr< ExposureT const > exp, std::shared_ptr< afw::detection::Footprint const > foot, geom::Point2D const &center)
 Constructor. More...
 
 ExposurePatch (std::shared_ptr< ExposureT const > exp, afw::detection::Footprint const &standardFoot, geom::Point2D const &standardCenter, afw::geom::SkyWcs const &standardWcs)
 
std::shared_ptr< ExposureT const > const getExposure () const
 Accessors. More...
 
std::shared_ptr< afw::detection::Footprint const > const getFootprint () const
 
geom::Point2D const & getCenter () const
 
geom::AffineTransform const & fromStandard () const
 
geom::AffineTransform const & toStandard () const
 
void setCenter (geom::Point2D const &center)
 Modifiers. More...
 

Detailed Description

template<typename ExposureT>
class lsst::meas::algorithms::ExposurePatch< ExposureT >

A convenience container for the exposure, peak and footprint that will be measured.

This is more useful than a std::pair or similar.

Definition at line 42 of file ExposurePatch.h.

Member Typedef Documentation

◆ ConstPtr

template<typename ExposureT >
typedef std::shared_ptr<ExposurePatch const> lsst::meas::algorithms::ExposurePatch< ExposureT >::ConstPtr

Definition at line 46 of file ExposurePatch.h.

◆ FlagT

template<typename ExposureT >
typedef unsigned char lsst::meas::algorithms::ExposurePatch< ExposureT >::FlagT

Type for flags.

Definition at line 44 of file ExposurePatch.h.

◆ Ptr

template<typename ExposureT >
typedef std::shared_ptr<ExposurePatch> lsst::meas::algorithms::ExposurePatch< ExposureT >::Ptr

Definition at line 45 of file ExposurePatch.h.

Constructor & Destructor Documentation

◆ ExposurePatch() [1/2]

template<typename ExposureT >
lsst::meas::algorithms::ExposurePatch< ExposureT >::ExposurePatch ( std::shared_ptr< ExposureT const >  exp,
std::shared_ptr< afw::detection::Footprint const >  foot,
geom::Point2D const &  center 
)
inline

Constructor.

Parameters
expExposure of interest
footFootprint on exposure
centerCenter of object on exposure

Definition at line 49 of file ExposurePatch.h.

◆ ExposurePatch() [2/2]

template<typename ExposureT >
lsst::meas::algorithms::ExposurePatch< ExposureT >::ExposurePatch ( std::shared_ptr< ExposureT const >  exp,
afw::detection::Footprint const &  standardFoot,
geom::Point2D const &  standardCenter,
afw::geom::SkyWcs const &  standardWcs 
)
inline
Parameters
expExposure of interest
standardFootFootprint on some other exposure
standardCenterCenter on that other exposure
standardWcsWCS for that other exposure

Definition at line 54 of file ExposurePatch.h.

Member Function Documentation

◆ fromStandard()

template<typename ExposureT >
geom::AffineTransform const & lsst::meas::algorithms::ExposurePatch< ExposureT >::fromStandard ( ) const
inline

Definition at line 75 of file ExposurePatch.h.

◆ getCenter()

template<typename ExposureT >
geom::Point2D const & lsst::meas::algorithms::ExposurePatch< ExposureT >::getCenter ( ) const
inline

Definition at line 74 of file ExposurePatch.h.

◆ getExposure()

template<typename ExposureT >
std::shared_ptr< ExposureT const > const lsst::meas::algorithms::ExposurePatch< ExposureT >::getExposure ( ) const
inline

Accessors.

Definition at line 72 of file ExposurePatch.h.

◆ getFootprint()

template<typename ExposureT >
std::shared_ptr< afw::detection::Footprint const > const lsst::meas::algorithms::ExposurePatch< ExposureT >::getFootprint ( ) const
inline

Definition at line 73 of file ExposurePatch.h.

◆ setCenter()

template<typename ExposureT >
void lsst::meas::algorithms::ExposurePatch< ExposureT >::setCenter ( geom::Point2D const &  center)
inline

Modifiers.

Definition at line 79 of file ExposurePatch.h.

◆ toStandard()

template<typename ExposureT >
geom::AffineTransform const & lsst::meas::algorithms::ExposurePatch< ExposureT >::toStandard ( ) const
inline

Definition at line 76 of file ExposurePatch.h.


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