LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::meas::base::MagResultKey Class Referenceabstract

A FunctorKey for MagResult. More...

#include <FluxUtilities.h>

Inheritance diagram for lsst::meas::base::MagResultKey:
lsst::afw::table::FunctorKey< MagResult > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value = MagResult
 The data type for get and set. More...
 

Public Member Functions

 MagResultKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to. More...
 
 MagResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming mag and magErr subfields. More...
 
virtual MagResult get (afw::table::BaseRecord const &record) const
 Get a MagResult from the given record. More...
 
virtual void set (afw::table::BaseRecord &record, MagResult const &magResult) const
 Set a MagResult in the given record. More...
 
virtual void set (afw::table::BaseRecord &record, afw::image::Measurement const &magnitude) const
 Set a MagResult in the record given the result of afw::image::PhotoCalib::instFluxToMagnitude. More...
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static MagResultKey addFields (afw::table::Schema &schema, std::string const &name)
 Add a pair of _mag, _magErr fields to a Schema, and return a MagResultKey that points to them. More...
 

Detailed Description

A FunctorKey for MagResult.

This class makes it easy to copy magnitudes and their uncertainties to and from records, and provides a method to add the appropriate fields to a Schema.

Definition at line 138 of file FluxUtilities.h.

Member Typedef Documentation

◆ Value

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ MagResultKey() [1/2]

lsst::meas::base::MagResultKey::MagResultKey ( )
inline

Default constructor; instance will not be usuable unless subsequently assigned to.

Definition at line 150 of file FluxUtilities.h.

150 : _magKey(), _magErrKey() {}

◆ MagResultKey() [2/2]

lsst::meas::base::MagResultKey::MagResultKey ( afw::table::SubSchema const &  s)
inline

Construct from a subschema, assuming mag and magErr subfields.

If a schema has "a_mag" and "a_magErr" fields, this enables construction of a MagResultKey via:

table::Schema schema
Definition: python.h:134
MagResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.

Definition at line 160 of file FluxUtilities.h.

160 : _magKey(s["mag"]), _magErrKey(s["magErr"]) {}

Member Function Documentation

◆ addFields()

MagResultKey lsst::meas::base::MagResultKey::addFields ( afw::table::Schema schema,
std::string const &  name 
)
static

Add a pair of _mag, _magErr fields to a Schema, and return a MagResultKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_mag", "_magErr" will be appended to this to form the full field names.

Definition at line 57 of file FluxUtilities.cc.

57  {
59  result._magKey = schema.addField<Mag>(schema.join(name, "mag"), "Magnitude");
60  result._magErrKey = schema.addField<MagErrElement>(schema.join(name, "magErr"), "Error on magnitude");
61  return result;
62 }
py::object result
Definition: _schema.cc:429
table::Key< std::string > name
Definition: Amplifier.cc:116
double MagErrElement
Definition: constants.h:54

◆ get()

MagResult lsst::meas::base::MagResultKey::get ( afw::table::BaseRecord const &  record) const
virtual

Get a MagResult from the given record.

Implements lsst::afw::table::OutputFunctorKey< T >.

Definition at line 64 of file FluxUtilities.cc.

64  {
65  MagResult result = {record.get(_magKey), record.get(_magErrKey)};
66  return result;
67 }

◆ set() [1/3]

void lsst::meas::base::MagResultKey::set ( afw::table::BaseRecord record,
afw::image::Measurement const &  magnitude 
) const
virtual

Set a MagResult in the record given the result of afw::image::PhotoCalib::instFluxToMagnitude.

Definition at line 74 of file FluxUtilities.cc.

74  {
75  record.set(_magKey, magResult.value);
76  record.set(_magErrKey, magResult.error);
77 }

◆ set() [2/3]

void lsst::meas::base::MagResultKey::set ( afw::table::BaseRecord record,
MagResult const &  magResult 
) const
virtual

Set a MagResult in the given record.

Definition at line 69 of file FluxUtilities.cc.

69  {
70  record.set(_magKey, magResult.mag);
71  record.set(_magErrKey, magResult.magErr);
72 }

◆ set() [3/3]

template<typename T >
virtual void lsst::afw::table::InputFunctorKey< T >::set ( BaseRecord record,
T const &  value 
) const
pure virtualinherited

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