lsst.meas.algorithms  13.0-23-gb99accf8+8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 boost::shared_ptr
< ExposurePatch
Ptr
 
typedef boost::shared_ptr
< ExposurePatch const > 
ConstPtr
 

Public Member Functions

 ExposurePatch (boost::shared_ptr< ExposureT const > exp, boost::shared_ptr< afw::detection::Footprint const > foot, afw::geom::Point2D const &center)
 Constructor. More...
 
 ExposurePatch (boost::shared_ptr< ExposureT const > exp, afw::detection::Footprint const &standardFoot, afw::geom::Point2D const &standardCenter, afw::image::Wcs const &standardWcs)
 
boost::shared_ptr< ExposureT
const > const 
getExposure () const
 Accessors. More...
 
boost::shared_ptr
< afw::detection::Footprint
const > const 
getFootprint () const
 
afw::geom::Point2D const & getCenter () const
 
afw::geom::AffineTransform const & fromStandard () const
 
afw::geom::AffineTransform const & toStandard () const
 
void setCenter (afw::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 39 of file ExposurePatch.h.

Member Typedef Documentation

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

Definition at line 43 of file ExposurePatch.h.

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

Type for flags.

Definition at line 41 of file ExposurePatch.h.

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

Definition at line 42 of file ExposurePatch.h.

Constructor & Destructor Documentation

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

Constructor.

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

Definition at line 46 of file ExposurePatch.h.

template<typename ExposureT>
lsst::meas::algorithms::ExposurePatch< ExposureT >::ExposurePatch ( boost::shared_ptr< ExposureT const >  exp,
afw::detection::Footprint const &  standardFoot,
afw::geom::Point2D const &  standardCenter,
afw::image::Wcs 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 50 of file ExposurePatch.h.

Member Function Documentation

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

Definition at line 70 of file ExposurePatch.h.

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

Definition at line 69 of file ExposurePatch.h.

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

Accessors.

Definition at line 67 of file ExposurePatch.h.

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

Definition at line 68 of file ExposurePatch.h.

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

Modifiers.

Definition at line 74 of file ExposurePatch.h.

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

Definition at line 71 of file ExposurePatch.h.


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