lsst.meas.base gfc624380f7+f1683bbee9
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::meas::base::SdssShapeResultKey Class Referenceabstract

A FunctorKey that maps SdssShapeResult to afw::table Records. More...

#include <SdssShape.h>

Inheritance diagram for lsst::meas::base::SdssShapeResultKey:
lsst::afw::table::FunctorKey< SdssShapeResult > lsst::afw::table::OutputFunctorKey< typename T > lsst::afw::table::InputFunctorKey< typename T >

Public Types

typedef T Value
 

Public Member Functions

 SdssShapeResultKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to. More...
 
 SdssShapeResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming _xx, _yy, etc. More...
 
virtual SdssShapeResult get (afw::table::BaseRecord const &record) const
 Get an SdssShapeResult from the given record. More...
 
virtual void set (afw::table::BaseRecord &record, SdssShapeResult const &value) const
 Set an SdssShapeResult in the given record. More...
 
virtual afw::geom::ellipses::Quadrupole getPsfShape (afw::table::BaseRecord const &record) const
 Get a Quadrupole for the Psf from the given record. More...
 
virtual void setPsfShape (afw::table::BaseRecord &record, afw::geom::ellipses::Quadrupole const &value) const
 Set a Quadrupole for the Psf at the position of the given record. More...
 
bool operator== (SdssShapeResultKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Keys. More...
 
bool operator!= (SdssShapeResultKey const &other) const
 
bool isValid () const
 Return True if the key is valid. More...
 
FlagHandler const & getFlagHandler () const
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static SdssShapeResultKey addFields (afw::table::Schema &schema, std::string const &name, bool doMeasurePsf)
 Add the appropriate fields to a Schema, and return a SdssShapeResultKey that manages them. More...
 

Detailed Description

A FunctorKey that maps SdssShapeResult to afw::table Records.

This is used internally by SdssShapeAlgorithm to transfer results from SdssShapeResult to SourceRecord, but it can also be used in the other direction by codes that need to extra an SdssShapeResult from a record.

Definition at line 73 of file SdssShape.h.

Constructor & Destructor Documentation

◆ SdssShapeResultKey() [1/2]

lsst::meas::base::SdssShapeResultKey::SdssShapeResultKey ( )
inline

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

Definition at line 90 of file SdssShape.h.

◆ SdssShapeResultKey() [2/2]

lsst::meas::base::SdssShapeResultKey::SdssShapeResultKey ( 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 SdssShapeResultKey via:

SdssShapeResultKey k(schema["a"]);
SdssShapeResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: SdssShape.h:90

Definition at line 673 of file SdssShape.cc.

Member Function Documentation

◆ addFields()

SdssShapeResultKey lsst::meas::base::SdssShapeResultKey::addFields ( afw::table::Schema schema,
std::string const &  name,
bool  doMeasurePsf 
)
static

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

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_xx", "_yy", etc. will be appended to this to form the full field names.
[in]numFlagsInteger to accommodate not setting the Psf shape fields when doMeasurePsf is false.
[in]doMeasurePsfBoolean indicating whether or not the Psf is being measured (as set in the SdssShapeControl class).

Definition at line 626 of file SdssShape.cc.

◆ get()

SdssShapeResult lsst::meas::base::SdssShapeResultKey::get ( afw::table::BaseRecord const &  record) const
virtual

Get an SdssShapeResult from the given record.

Implements lsst::afw::table::FunctorKey< SdssShapeResult >.

Definition at line 692 of file SdssShape.cc.

◆ getFlagHandler()

FlagHandler const & lsst::meas::base::SdssShapeResultKey::getFlagHandler ( ) const
inline

Definition at line 125 of file SdssShape.h.

◆ getPsfShape()

afw::geom::ellipses::Quadrupole lsst::meas::base::SdssShapeResultKey::getPsfShape ( afw::table::BaseRecord const &  record) const
virtual

Get a Quadrupole for the Psf from the given record.

Definition at line 707 of file SdssShape.cc.

◆ isValid()

bool lsst::meas::base::SdssShapeResultKey::isValid ( ) const

Return True if the key is valid.

Definition at line 737 of file SdssShape.cc.

◆ operator!=()

bool lsst::meas::base::SdssShapeResultKey::operator!= ( SdssShapeResultKey const &  other) const
inline

Definition at line 119 of file SdssShape.h.

◆ operator==()

bool lsst::meas::base::SdssShapeResultKey::operator== ( SdssShapeResultKey const &  other) const

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

Definition at line 729 of file SdssShape.cc.

◆ set()

void lsst::meas::base::SdssShapeResultKey::set ( afw::table::BaseRecord record,
SdssShapeResult const &  value 
) const
virtual

Set an SdssShapeResult in the given record.

Definition at line 711 of file SdssShape.cc.

◆ setPsfShape()

void lsst::meas::base::SdssShapeResultKey::setPsfShape ( afw::table::BaseRecord record,
afw::geom::ellipses::Quadrupole const &  value 
) const
virtual

Set a Quadrupole for the Psf at the position of the given record.

Definition at line 724 of file SdssShape.cc.


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