LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
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< T > lsst::afw::table::InputFunctorKey< T >

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, T 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"]);
A FunctorKey for FluxResult.

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}
FluxResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
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< T >.

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(); }
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition Key.h:97

◆ 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/2]

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}

◆ set() [2/2]

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

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