LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
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< MagResult > lsst::afw::table::InputFunctorKey< MagResult >

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, MagResult 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:

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 }

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

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]

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

The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::Mag
double Mag
Definition: constants.h:53
lsst::meas::base::MagErrElement
double MagErrElement
Definition: constants.h:54
lsst::meas::base::MagResultKey::MagResultKey
MagResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: FluxUtilities.h:150
result
py::object result
Definition: _schema.cc:429