LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
 The data type for get and set.
 

Public Member Functions

 MagResultKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to.
 
 MagResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming mag and magErr subfields.
 
virtual MagResult get (afw::table::BaseRecord const &record) const
 Get a MagResult from the given record.
 
virtual void set (afw::table::BaseRecord &record, MagResult const &magResult) const
 Set a MagResult in the given record.
 
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.
 
virtual void set (BaseRecord &record, MagResult const &value) const=0
 
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.
 

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 140 of file FluxUtilities.h.

Member Typedef Documentation

◆ Value

using lsst::afw::table::FunctorKey< MagResult >::Value
inherited

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 152 of file FluxUtilities.h.

152: _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:

MagResultKey k(schema["a"]);
MagResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.

Definition at line 162 of file FluxUtilities.h.

162: _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 62 of file FluxUtilities.cc.

62 {
64 result._magKey = schema.addField<Mag>(schema.join(name, "mag"), "Magnitude");
65 result._magErrKey = schema.addField<MagErrElement>(schema.join(name, "magErr"), "Error on magnitude");
66 return result;
67}
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< MagResult >.

Definition at line 69 of file FluxUtilities.cc.

69 {
70 MagResult result = {record.get(_magKey), record.get(_magErrKey)};
71 return result;
72}

◆ set() [1/4]

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

◆ set() [2/4]

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

◆ set() [3/4]

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 79 of file FluxUtilities.cc.

79 {
80 record.set(_magKey, magResult.value);
81 record.set(_magErrKey, magResult.error);
82}

◆ set() [4/4]

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 74 of file FluxUtilities.cc.

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

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