Class FluxResultKey

Inheritance Relationships

Base Type

Class Documentation

class FluxResultKey : public lsst::afw::table::FunctorKey<FluxResult>

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.

Unnamed Group

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

Public 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.

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

FluxResultKey k(schema["a"]);

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 isValid() const

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

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

Return the underlying instFlux Key.

afw::table::Key<FluxErrElement> getInstFluxErr() const

Return the underlying instFluxErr Key.

Public Static 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.

The unit for both fields will be “count”.

Parameters

  • [inout] schema: Schema to add fields to.

  • [in] name: Name prefix for all fields; “_instFlux”, “_instFluxErr” will be appended to this to form the full field names.

  • [in] doc: String used as the documentation for the fields.