Class ShapeResultKey

Inheritance Relationships

Base Type

Class Documentation

class ShapeResultKey : public lsst::afw::table::FunctorKey<ShapeResult>

A FunctorKey for ShapeResult.

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

Unnamed Group

bool operator==(ShapeResultKey const &other) const

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

bool operator!=(ShapeResultKey const &other) const

Public Functions

ShapeResultKey()

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

ShapeResultKey(afw::table::QuadrupoleKey const &shape, afw::table::CovarianceMatrixKey<ErrElement, 3> const &shapeErr)

Construct from a pair of Keys.

ShapeResultKey(afw::table::SubSchema const &s)

Construct from a subschema, assuming _xx, _yy, etc. subfields.

If a schema has “a_xx”, “a_yy”, etc. fields, this constructor allows you to construct a ShapeResultKey via: 

ShapeResultKey k(schema["a"]);

virtual ShapeResult get(afw::table::BaseRecord const &record) const

Get a ShapeResult from the given record.

virtual void set(afw::table::BaseRecord &record, ShapeResult const &value) const

Set a ShapeResult in the given record.

bool isValid() const

Return True if the shape key is valid.

afw::table::QuadrupoleKey getShape() const

Return a FunctorKey to just the shape value.

afw::table::CovarianceMatrixKey<ErrElement, 3> getShapeErr() const

Return a FunctorKey to just the uncertainty matrix.

afw::table::Key<ShapeElement> getIxx() const

Return a Key for the xx moment.

afw::table::Key<ShapeElement> getIyy() const

Return a Key for the yy moment.

afw::table::Key<ShapeElement> getIxy() const

Return a Key for the xy moment.

Public Static Functions

static ShapeResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty, afw::table::CoordinateType coordType = afw::table::CoordinateType::PIXEL)

Add the appropriate fields to a Schema, and return a ShapeResultKey that manages them.

The unit for all fields will be pixels^2 (pixels^4 for covariances).

Parameters

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

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

  • [in] doc: String used as the documentation for the xx, yy, xy fields.

  • [in] uncertainty: Enum indicating which (if any) uncertainty values will be saved.