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 Types
using	Value = SdssShapeResult
	The data type for get and set. More...

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.

Member Typedef Documentation

Value

using lsst::afw::table::FunctorKey< SdssShapeResult >::Value = SdssShapeResult

inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.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"]);

Definition at line 673 of file SdssShape.cc.

        : _shapeResult(s),
          _centroidResult(s),
          _instFluxResult(s),
          _instFlux_xx_Cov(s["instFlux"]["xx"]["Cov"]),
          _instFlux_yy_Cov(s["instFlux"]["yy"]["Cov"]),
          _instFlux_xy_Cov(s["instFlux"]["xy"]["Cov"]) {
    // The input SubSchema may optionally provide for a PSF.
    try {
        _psfShapeResult = afw::table::QuadrupoleKey(s["psf"]);
        _flagHandler = FlagHandler(s, SdssShapeAlgorithm::getFlagDefinitions());
        _includePsf = true;
    } catch (pex::exceptions::NotFoundError &e) {
        _flagHandler =
                FlagHandler(s, SdssShapeAlgorithm::getFlagDefinitions(), {SdssShapeAlgorithm::PSF_SHAPE_BAD});
        _includePsf = false;
    }
}

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]	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]	numFlags	Integer to accommodate not setting the Psf shape fields when doMeasurePsf is false.
[in]	doMeasurePsf	Boolean indicating whether or not the Psf is being measured (as set in the SdssShapeControl class).

Definition at line 626 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._instFluxResult = FluxResultKey::addFields(schema, name, "elliptical Gaussian adaptive moments");
 
    // Only include PSF shape fields if doMeasurePsf = True
    if (doMeasurePsf) {
        r._includePsf = true;
        r._psfShapeResult = afw::table::QuadrupoleKey::addFields(
                schema, schema.join(name, "psf"), "adaptive moments of the PSF model at the object position");
    } else {
        r._includePsf = false;
    }
 
    r._instFlux_xx_Cov =
            schema.addField<ErrElement>(schema.join(name, "instFlux", "xx", "Cov"),
                                        (boost::format("uncertainty covariance between %s and %s") %
                                         schema.join(name, "instFlux") % schema.join(name, "xx"))
                                                .str(),
                                        "count*pixel^2");
    r._instFlux_yy_Cov =
            schema.addField<ErrElement>(schema.join(name, "instFlux", "yy", "Cov"),
                                        (boost::format("uncertainty covariance between %s and %s") %
                                         schema.join(name, "instFlux") % schema.join(name, "yy"))
                                                .str(),
                                        "count*pixel^2");
    r._instFlux_xy_Cov =
            schema.addField<ErrElement>(schema.join(name, "instFlux", "xy", "Cov"),
                                        (boost::format("uncertainty covariance between %s and %s") %
                                         schema.join(name, "instFlux") % schema.join(name, "xy"))
                                                .str(),
                                        "count*pixel^2");
 
    // Skip the psf flag if not recording the PSF shape.
    if (r._includePsf) {
        r._flagHandler = FlagHandler::addFields(schema, name, SdssShapeAlgorithm::getFlagDefinitions());
    } else {
        r._flagHandler = FlagHandler::addFields(schema, name, SdssShapeAlgorithm::getFlagDefinitions(),
                                                {SdssShapeAlgorithm::PSF_SHAPE_BAD});
    }
    return r;
}

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::OutputFunctorKey< T >.

Definition at line 692 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(_instFluxResult);
    result.instFlux_xx_Cov = record.get(_instFlux_xx_Cov);
    result.instFlux_yy_Cov = record.get(_instFlux_yy_Cov);
    result.instFlux_xy_Cov = record.get(_instFlux_xy_Cov);
    for (size_t n = 0; n < SdssShapeAlgorithm::N_FLAGS; ++n) {
        if (n == SdssShapeAlgorithm::PSF_SHAPE_BAD.number && !_includePsf) continue;
        result.flags[n] = _flagHandler.getValue(record, n);
    }
    return result;
}

getFlagHandler()

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

inline

Definition at line 125 of file SdssShape.h.

{ return _flagHandler; }

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.

                                                                                                {
    return record.get(_psfShapeResult);
}

isValid()

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

(

)

const

Return True if the key is valid.

Definition at line 737 of file SdssShape.cc.

                                       {
    return _shapeResult.isValid() && _centroidResult.isValid() && _instFluxResult.isValid() &&
           _psfShapeResult.isValid() && _instFlux_xx_Cov.isValid() && _instFlux_yy_Cov.isValid() &&
           _instFlux_xy_Cov.isValid();
    // don't bother with flags - if we've gotten this far, it's basically impossible the flags are invalid
}

operator!=()

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

inline

Definition at line 119 of file SdssShape.h.

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

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.

                                                                         {
    return _shapeResult == other._shapeResult && _centroidResult == other._centroidResult &&
           _instFluxResult == other._instFluxResult && _psfShapeResult == other._psfShapeResult &&
           _instFlux_xx_Cov == other._instFlux_xx_Cov && _instFlux_yy_Cov == other._instFlux_yy_Cov &&
           _instFlux_xy_Cov == other._instFlux_xy_Cov;
    // don't bother with flags - if we've gotten this far, it's basically impossible the flags don't match
}

set() [1/2]

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.

                                                                                           {
    record.set(_shapeResult, value);
    record.set(_centroidResult, value);
    record.set(_instFluxResult, value);
    record.set(_instFlux_xx_Cov, value.instFlux_xx_Cov);
    record.set(_instFlux_yy_Cov, value.instFlux_yy_Cov);
    record.set(_instFlux_xy_Cov, value.instFlux_xy_Cov);
    for (size_t n = 0; n < SdssShapeAlgorithm::N_FLAGS; ++n) {
        if (n == SdssShapeAlgorithm::PSF_SHAPE_BAD.number && !_includePsf) continue;
        _flagHandler.setValue(record, n, value.flags[n]);
    }
}

set() [2/2]

template<typename T >

virtual void lsst::afw::table::InputFunctorKey< T >::set ( BaseRecord &  record, T const &  value  ) const

pure virtualinherited

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.

                                                                                   {
    record.set(_psfShapeResult, value);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/include/lsst/meas/base/SdssShape.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/src/SdssShape.cc