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::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 59 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 76 of file FluxUtilities.h.

76: _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 79 of file FluxUtilities.h.

82 : _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 93 of file FluxUtilities.h.

94 : _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 114 of file FluxUtilities.h.

114{ return _instFlux; }

◆ getInstFluxErr()

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

Return the underlying instFluxErr Key.

Definition at line 117 of file FluxUtilities.h.

117{ 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 111 of file FluxUtilities.h.

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

◆ operator!=()

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

Definition at line 107 of file FluxUtilities.h.

107{ 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 104 of file FluxUtilities.h.

104 {
105 return _instFlux == other._instFlux && _instFluxErr == other._instFluxErr;
106 }

◆ 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: