Class QuadrupoleKey

Inheritance Relationships

Base Type

Class Documentation

class QuadrupoleKey : public lsst::afw::table::FunctorKey<lsst::afw::geom::ellipses::Quadrupole>

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys.

Unnamed Group

bool operator==(QuadrupoleKey const &other) const

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

bool operator!=(QuadrupoleKey const &other) const

Unnamed Group

Key<double> getIxx() const

Return a constituent Key.

Key<double> getIyy() const
Key<double> getIxy() const

Public Functions

QuadrupoleKey()

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

QuadrupoleKey(Key<double> const &ixx, Key<double> const &iyy, Key<double> const &ixy)

Construct from individual Keys.

QuadrupoleKey(SubSchema const &s)

Construct from a subschema with appropriate subfields

If the schema has “a_xx”, “a_yy” and “a_xy” fields this constructor enables you to construct a QuadrupoleKey via: 

QuadrupoleKey k(schema["a"], coordType);

QuadrupoleKey(QuadrupoleKey const&)
QuadrupoleKey(QuadrupoleKey&&)
QuadrupoleKey &operator=(QuadrupoleKey const&)
QuadrupoleKey &operator=(QuadrupoleKey&&)
~QuadrupoleKey()
geom::ellipses::Quadrupole get(BaseRecord const &record) const

Get a Quadrupole from the given record.

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

Set a Quadrupole 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 QuadrupoleKey addFields(Schema &schema, std::string const &name, std::string const &doc, CoordinateType coordType = CoordinateType::PIXEL)

Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them.

Parameters

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

  • [in] name: Name prefix for all fields; (“_xx”, “_yy”, “_xy”) will be appended to this to form the full field names. In celestial coordinates, we use “x” as a synonym for “RA” and “y” for “dec”.

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

  • [in] coordType: Type of coordinates in use (PIXEL or CELESTIAL).