lsst::meas::base::SdssShapeResultKey Class Reference

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

#include <SdssShape.h>

Inheritance diagram for lsst::meas::base::SdssShapeResultKey:

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. subfields. More...
virtual SdssShapeResult	get (afw::table::BaseRecord const &record) const
	Get a CentroidResult from the given record. More...
virtual void	set (afw::table::BaseRecord &record, SdssShapeResult const &value) const
	Set a CentroidResult in the given record. More...
bool	isValid () const
	Return True if the key is valid. More...
FlagHandler const &	getFlagHandler () const
bool	operator== (SdssShapeResultKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Keys. More...
bool	operator!= (SdssShapeResultKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Keys. More...
Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< SdssShapeResult >
virtual	~OutputFunctorKey ()
Public Member Functions inherited from lsst::afw::table::InputFunctorKey< SdssShapeResult >
virtual void	set (BaseRecord &record, SdssShapeResultconst &value) const =0
virtual	~InputFunctorKey ()

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

Private Attributes
ShapeResultKey	_shapeResult
CentroidResultKey	_centroidResult
FluxResultKey	_fluxResult
afw::table::Key< ErrElement >	_flux_xx_Cov
afw::table::Key< ErrElement >	_flux_yy_Cov
afw::table::Key< ErrElement >	_flux_xy_Cov
FlagHandler	_flagHandler

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 66 of file SdssShape.h.

Constructor & Destructor Documentation

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

inline

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

Definition at line 82 of file SdssShape.h.

{}

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"]);
*  

Definition at line 686 of file SdssShape.cc.

                                                                  :
    _shapeResult(s),
    _centroidResult(s),
    _fluxResult(s),
    _flux_xx_Cov(s["flux"]["xx"]["Cov"]),
    _flux_yy_Cov(s["flux"]["yy"]["Cov"]),
    _flux_xy_Cov(s["flux"]["xy"]["Cov"]),
    _flagHandler(s, flagDefs.begin(), flagDefs.end())
{}

Member Function Documentation

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

static

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

Parameters

[in,out]	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.

Definition at line 654 of file SdssShape.cc.

  {
    SdssShapeResultKey r;
    r._shapeResult = ShapeResultKey::addFields(schema, name, "elliptical Gaussian adaptive moments",
                                               SIGMA_ONLY);
    r._centroidResult = CentroidResultKey::addFields(schema, name, "elliptical Gaussian adaptive moments",
                                                     NO_UNCERTAINTY);
    r._fluxResult = FluxResultKey::addFields(schema, name, "elliptical Gaussian adaptive moments");
    r._flux_xx_Cov = schema.addField<ErrElement>(
        schema.join(name, "flux", "xx", "Cov"),
        (boost::format("uncertainty covariance between %s and %s")
         % schema.join(name, "flux") % schema.join(name, "xx")).str(),
        "dn*pixels^2"
    );
    r._flux_yy_Cov = schema.addField<ErrElement>(
        schema.join(name, "flux", "yy", "Cov"),
        (boost::format("uncertainty covariance between %s and %s")
         % schema.join(name, "flux") % schema.join(name, "yy")).str(),
        "dn*pixels^2"
    );
    r._flux_xy_Cov = schema.addField<ErrElement>(
        schema.join(name, "flux", "xy", "Cov"),
        (boost::format("uncertainty covariance between %s and %s")
         % schema.join(name, "flux") % schema.join(name, "xy")).str(),
        "dn*pixels^2"
    );
    r._flagHandler = FlagHandler::addFields(schema, name, flagDefs.begin(), flagDefs.end());
    return r;
}

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

virtual

Get a CentroidResult from the given record.

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

Definition at line 696 of file SdssShape.cc.

                                                                               {
    SdssShapeResult result;
    static_cast<ShapeResult&>(result) = record.get(_shapeResult);
    static_cast<CentroidResult&>(result) = record.get(_centroidResult);
    static_cast<FluxResult&>(result) = record.get(_fluxResult);
    result.flux_xx_Cov = record.get(_flux_xx_Cov);
    result.flux_yy_Cov = record.get(_flux_yy_Cov);
    result.flux_xy_Cov = record.get(_flux_xy_Cov);
    for (int n = 0; n < SdssShapeAlgorithm::N_FLAGS; ++n) {
        result.flags[n] = _flagHandler.getValue(record, n);
    }
    return result;
}

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

inline

Definition at line 110 of file SdssShape.h.

{ return _flagHandler; }

bool lsst::meas::base::SdssShapeResultKey::isValid

(

)

const

Return True if the key is valid.

Definition at line 732 of file SdssShape.cc.

                                       {
    return _shapeResult.isValid() &&
        _centroidResult.isValid() &&
        _fluxResult.isValid() &&
        _flux_xx_Cov.isValid() &&
        _flux_yy_Cov.isValid() &&
        _flux_xy_Cov.isValid();
    // don't bother with flags - if we've gotten this far, it's basically impossible the flags don't match
}

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

inline

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

Definition at line 104 of file SdssShape.h.

{ return !(*this == other); }

bool lsst::meas::base::SdssShapeResultKey::operator==

(

SdssShapeResultKey const &

other

)

const

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

Definition at line 722 of file SdssShape.cc.

                                                                          {
    return _shapeResult == other._shapeResult &&
        _centroidResult == other._centroidResult &&
        _fluxResult == other._fluxResult &&
        _flux_xx_Cov == other._flux_xx_Cov &&
        _flux_yy_Cov == other._flux_yy_Cov &&
        _flux_xy_Cov == other._flux_xy_Cov;
    // don't bother with flags - if we've gotten this far, it's basically impossible the flags don't match
}

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

virtual

Set a CentroidResult in the given record.

Definition at line 710 of file SdssShape.cc.

                                                                                             {
    record.set(_shapeResult, value);
    record.set(_centroidResult, value);
    record.set(_fluxResult, value);
    record.set(_flux_xx_Cov, value.flux_xx_Cov);
    record.set(_flux_yy_Cov, value.flux_yy_Cov);
    record.set(_flux_xy_Cov, value.flux_xy_Cov);
    for (int n = 0; n < SdssShapeAlgorithm::N_FLAGS; ++n) {
        _flagHandler.setValue(record, n, value.flags[n]);
    }
}

Member Data Documentation

CentroidResultKey lsst::meas::base::SdssShapeResultKey::_centroidResult

private

Definition at line 114 of file SdssShape.h.

FlagHandler lsst::meas::base::SdssShapeResultKey::_flagHandler

private

Definition at line 119 of file SdssShape.h.

afw::table::Key<ErrElement> lsst::meas::base::SdssShapeResultKey::_flux_xx_Cov

private

Definition at line 116 of file SdssShape.h.

afw::table::Key<ErrElement> lsst::meas::base::SdssShapeResultKey::_flux_xy_Cov

private

Definition at line 118 of file SdssShape.h.

afw::table::Key<ErrElement> lsst::meas::base::SdssShapeResultKey::_flux_yy_Cov

private

Definition at line 117 of file SdssShape.h.

FluxResultKey lsst::meas::base::SdssShapeResultKey::_fluxResult

private

Definition at line 115 of file SdssShape.h.

ShapeResultKey lsst::meas::base::SdssShapeResultKey::_shapeResult

private

Definition at line 113 of file SdssShape.h.

---

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

• /home/lsstsw/stack/Linux64/meas_base/11.0+1/include/lsst/meas/base/SdssShape.h
• /home/lsstsw/stack/Linux64/meas_base/11.0+1/src/SdssShape.cc