Class EllipseKey

Inheritance Relationships

Base Type

Class Documentation

class EllipseKey : public lsst::afw::table::FunctorKey<lsst::afw::geom::ellipses::Ellipse>

A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys.

Unnamed Group

bool operator==(EllipseKey const &other) const

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

bool operator!=(EllipseKey const &other) const

Unnamed Group

QuadrupoleKey getCore() const

Return constituent FunctorKeys.

PointKey<double> getCenter() const

Public Functions

EllipseKey()

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

EllipseKey(QuadrupoleKey const &qKey, PointKey<double> const &pKey)

Construct from individual Keys.

EllipseKey(SubSchema const &s)

Construct from a subschema, assuming (xx, yy, xy, x, y) subfields

If a schema has “a_xx”, “a_yy”, “a_xy”, “a_x”, and “a_y” fields, this constructor allows you to construct an EllipseKey via: 

EllipseKey k(schema["a"]);

EllipseKey(EllipseKey const&)
EllipseKey(EllipseKey&&)
EllipseKey &operator=(EllipseKey const&)
EllipseKey &operator=(EllipseKey&&)
~EllipseKey()
geom::ellipses::Ellipse get(BaseRecord const &record) const

Get an Ellipse from the given record.

void set(BaseRecord &record, geom::ellipses::Ellipse const &value) const

Set an Ellipse in the given record.

std::size_t hash_value() const

Return a hash of this object.

bool isValid() const

Return True if all the constituent Keys are valid.

Public Static Functions

static EllipseKey addFields(Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)

Add a set of _xx, _yy, _xy, _x, _y fields to a Schema, and return an EllipseKey that points to them.

Parameters

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

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

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

  • [in] unit: String used as the unit for x and y fields; “<unit>^2” will be used for xx, yy, and xy fields.