LSSTApplications  1.1.2+25,10.0+13,10.0+132,10.0+133,10.0+224,10.0+41,10.0+8,10.0-1-g0f53050+14,10.0-1-g4b7b172+19,10.0-1-g61a5bae+98,10.0-1-g7408a83+3,10.0-1-gc1e0f5a+19,10.0-1-gdb4482e+14,10.0-11-g3947115+2,10.0-12-g8719d8b+2,10.0-15-ga3f480f+1,10.0-2-g4f67435,10.0-2-gcb4bc6c+26,10.0-28-gf7f57a9+1,10.0-3-g1bbe32c+14,10.0-3-g5b46d21,10.0-4-g027f45f+5,10.0-4-g86f66b5+2,10.0-4-gc4fccf3+24,10.0-40-g4349866+2,10.0-5-g766159b,10.0-5-gca2295e+25,10.0-6-g462a451+1
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst.afw.table::KeyTuple< MeasurementT > Struct Template Reference

A three-element tuple of measurement, uncertainty, and flag keys. More...

#include <slots.h>

Public Member Functions

 KeyTuple ()
 Default-constructor; all keys will be invalid. More...
 
 KeyTuple (typename MeasurementT::MeasKey const &meas_, typename MeasurementT::ErrKey const &err_, Key< Flag > const &flag_)
 Main constructor. More...
 

Public Attributes

MeasurementT::MeasKey meas
 Key used for the measured value. More...
 
MeasurementT::ErrKey err
 Key used for the uncertainty. More...
 
Key< Flag > flag
 Failure bit; set if the measurement did not fully succeed. More...
 

Detailed Description

template<typename MeasurementT>
struct lsst.afw.table::KeyTuple< MeasurementT >

A three-element tuple of measurement, uncertainty, and flag keys.

Most measurement should have more than one flag key to indicate different kinds of failures. This flag key should usually be set to be a logical OR of all of them, so it is set whenever a measurement cannot be fully trusted.

Definition at line 255 of file slots.h.

Constructor & Destructor Documentation

template<typename MeasurementT >
lsst.afw.table::KeyTuple< MeasurementT >::KeyTuple ( )
inline

Default-constructor; all keys will be invalid.

Definition at line 261 of file slots.h.

261 {}
template<typename MeasurementT >
lsst.afw.table::KeyTuple< MeasurementT >::KeyTuple ( typename MeasurementT::MeasKey const &  meas_,
typename MeasurementT::ErrKey const &  err_,
Key< Flag > const &  flag_ 
)
inline

Main constructor.

Definition at line 264 of file slots.h.

268  : meas(meas_), err(err_), flag(flag_) {}
MeasurementT::ErrKey err
Key used for the uncertainty.
Definition: slots.h:257
Key< Flag > flag
Failure bit; set if the measurement did not fully succeed.
Definition: slots.h:258
MeasurementT::MeasKey meas
Key used for the measured value.
Definition: slots.h:256

Member Data Documentation

template<typename MeasurementT >
MeasurementT::ErrKey lsst.afw.table::KeyTuple< MeasurementT >::err

Key used for the uncertainty.

Definition at line 257 of file slots.h.

template<typename MeasurementT >
Key<Flag> lsst.afw.table::KeyTuple< MeasurementT >::flag

Failure bit; set if the measurement did not fully succeed.

Definition at line 258 of file slots.h.

template<typename MeasurementT >
MeasurementT::MeasKey lsst.afw.table::KeyTuple< MeasurementT >::meas

Key used for the measured value.

Definition at line 256 of file slots.h.


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