Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 138 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 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:

MagResultKey k(schema["a"]);
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}
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 64 of file FluxUtilities.cc.

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

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

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

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

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

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