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::FluxResultKey Class Referenceabstract

A FunctorKey for FluxResult. More...

#include <FluxUtilities.h>

Inheritance diagram for lsst::meas::base::FluxResultKey:
lsst::afw::table::FunctorKey< FluxResult > lsst::afw::table::OutputFunctorKey< FluxResult > lsst::afw::table::InputFunctorKey< FluxResult >

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

 FluxResultKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to.
 
 FluxResultKey (afw::table::Key< meas::base::Flux > const &instFlux, afw::table::Key< meas::base::FluxErrElement > const &instFluxErr)
 Construct from a pair of Keys.
 
 FluxResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming instFlux and instFluxErr subfields.
 
virtual FluxResult get (afw::table::BaseRecord const &record) const
 Get a FluxResult from the given record.
 
virtual void set (afw::table::BaseRecord &record, FluxResult const &other) const
 Set a FluxResult in the given record.
 
bool operator== (FluxResultKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying instFlux and instFluxErr Keys.
 
bool operator!= (FluxResultKey const &other) const
 
bool isValid () const
 Return True if both the instFlux and instFluxErr Keys are valid.
 
afw::table::Key< meas::base::FluxgetInstFlux () const
 Return the underlying instFlux Key.
 
afw::table::Key< FluxErrElementgetInstFluxErr () const
 Return the underlying instFluxErr Key.
 
virtual void set (BaseRecord &record, FluxResult const &value) const=0
 
virtual void set (BaseRecord &record, FluxResult const &value) const=0
 

Static Public Member Functions

static FluxResultKey addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc)
 Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to them.
 

Detailed Description

A FunctorKey for FluxResult.

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

Definition at line 61 of file FluxUtilities.h.

Member Typedef Documentation

◆ Value

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

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ FluxResultKey() [1/3]

lsst::meas::base::FluxResultKey::FluxResultKey ( )
inline

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

Definition at line 78 of file FluxUtilities.h.

78: _instFlux(), _instFluxErr() {}

◆ FluxResultKey() [2/3]

lsst::meas::base::FluxResultKey::FluxResultKey ( afw::table::Key< meas::base::Flux > const & instFlux,
afw::table::Key< meas::base::FluxErrElement > const & instFluxErr )
inline

Construct from a pair of Keys.

Definition at line 81 of file FluxUtilities.h.

84 : _instFlux(instFlux), _instFluxErr(instFluxErr) {}

◆ FluxResultKey() [3/3]

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

Construct from a subschema, assuming instFlux and instFluxErr subfields.

If a schema has "a_instFlux" and "a_instFluxErr" fields, this constructor allows you to construct a FluxResultKey via:

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

Definition at line 95 of file FluxUtilities.h.

96 : _instFlux(s["instFlux"]), _instFluxErr(s["instFluxErr"]) {}

Member Function Documentation

◆ addFields()

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

Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_instFlux", "_instFluxErr" will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.

The unit for both fields will be "count".

Definition at line 36 of file FluxUtilities.cc.

37 {
39 result._instFlux = schema.addField<meas::base::Flux>(schema.join(name, "instFlux"), doc, "count");
40 result._instFluxErr = schema.addField<meas::base::FluxErrElement>(
41 schema.join(name, "instFluxErr"), "1-sigma instFlux uncertainty", "count");
42 return result;
43}
double FluxErrElement
Definition constants.h:52

◆ get()

FluxResult lsst::meas::base::FluxResultKey::get ( afw::table::BaseRecord const & record) const
virtual

Get a FluxResult from the given record.

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

Definition at line 45 of file FluxUtilities.cc.

45 {
46 FluxResult r;
47 r.instFlux = record.get(_instFlux);
48 r.instFluxErr = record.get(_instFluxErr);
49 return r;
50}

◆ getInstFlux()

afw::table::Key< meas::base::Flux > lsst::meas::base::FluxResultKey::getInstFlux ( ) const
inline

Return the underlying instFlux Key.

Definition at line 116 of file FluxUtilities.h.

116{ return _instFlux; }

◆ getInstFluxErr()

afw::table::Key< FluxErrElement > lsst::meas::base::FluxResultKey::getInstFluxErr ( ) const
inline

Return the underlying instFluxErr Key.

Definition at line 119 of file FluxUtilities.h.

119{ return _instFluxErr; }

◆ isValid()

bool lsst::meas::base::FluxResultKey::isValid ( ) const
inline

Return True if both the instFlux and instFluxErr Keys are valid.

Definition at line 113 of file FluxUtilities.h.

113{ return _instFlux.isValid() && _instFluxErr.isValid(); }

◆ operator!=()

bool lsst::meas::base::FluxResultKey::operator!= ( FluxResultKey const & other) const
inline

Definition at line 109 of file FluxUtilities.h.

109{ return !(*this == other); }

◆ operator==()

bool lsst::meas::base::FluxResultKey::operator== ( FluxResultKey const & other) const
inline

Compare the FunctorKey for equality with another, using the underlying instFlux and instFluxErr Keys.

Definition at line 106 of file FluxUtilities.h.

106 {
107 return _instFlux == other._instFlux && _instFluxErr == other._instFluxErr;
108 }

◆ set() [1/3]

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

◆ set() [2/3]

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

◆ set() [3/3]

void lsst::meas::base::FluxResultKey::set ( afw::table::BaseRecord & record,
FluxResult const & other ) const
virtual

Set a FluxResult in the given record.

Definition at line 52 of file FluxUtilities.cc.

52 {
53 record.set(_instFlux, value.instFlux);
54 record.set(_instFluxErr, value.instFluxErr);
55}

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