lsst::afw::table::CoordErrKey Class Reference

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::CoordErrKey:

Public Types
using	ErrKeyArray = std::vector<Key<float>>
using	CovarianceKeyArray = std::vector<Key<float>>
using	NameArray = std::vector<std::string>
using	Value = T
	The data type for get and set.

Public Member Functions
	CoordErrKey ()
	CoordErrKey (ErrKeyArray const &err, CovarianceKeyArray const &cov=CovarianceKeyArray())
	CoordErrKey (SubSchema const &s, std::string const &name)
Eigen::Matrix< float, N, N >	get (BaseRecord const &record) const override
	Get a covariance matrix from the given record.
void	set (BaseRecord &record, Eigen::Matrix< float, N, N > const &value) const override
	Set a covariance matrix in the given record (uses only the lower triangle of the given matrix).
virtual void	set (BaseRecord &record, T const &value) const =0
float	getElement (BaseRecord const &record, int i, int j) const
	Return the element in row i and column j.
void	setElement (BaseRecord &record, int i, int j, float value) const
	Set the element in row i and column j.
bool	isValid () const noexcept
	Return True if all the constituent error Keys are valid.
bool	operator== (CovarianceMatrixKey const &other) const noexcept
	Compare the FunctorKey for equality with another, using its constituent Keys.
bool	operator!= (CovarianceMatrixKey const &other) const noexcept
std::size_t	hash_value () const noexcept
	Return a hash of this object.

Static Public Member Functions
static CoordErrKey	addFields (Schema &schema, std::string const &name, std::string const &unit, bool diagonalOnly=false)
static CoordErrKey	addFields (Schema &schema, std::string const &name, NameArray const &units, bool diagonalOnly=false)
static CovarianceMatrixKey	addFields (Schema &schema, std::string const &prefix, NameArray const &names, std::string const &unit, bool diagonalOnly=false)
	Add covariance matrix fields to a Schema, and return a CovarianceMatrixKey to manage them.
static CovarianceMatrixKey	addFields (Schema &schema, std::string const &prefix, NameArray const &names, NameArray const &units, bool diagonalOnly=false)
	Add covariance matrix fields to a Schema, and return a CovarianceMatrixKey to manage them.

Detailed Description

Definition at line 635 of file aggregates.h.

Member Typedef Documentation

CovarianceKeyArray

using lsst::afw::table::CoordErrKey::CovarianceKeyArray = std::vector<Key<float>>

Definition at line 638 of file aggregates.h.

ErrKeyArray

using lsst::afw::table::CoordErrKey::ErrKeyArray = std::vector<Key<float>>

Definition at line 637 of file aggregates.h.

NameArray

using lsst::afw::table::CoordErrKey::NameArray = std::vector<std::string>

Definition at line 639 of file aggregates.h.

Value

template<typename T>

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

inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

CoordErrKey() [1/3]

lsst::afw::table::CoordErrKey::CoordErrKey

(

)

CoordErrKey() [2/3]

lsst::afw::table::CoordErrKey::CoordErrKey ( ErrKeyArray const & err, CovarianceKeyArray const & cov = CovarianceKeyArray() )

explicit

CoordErrKey() [3/3]

lsst::afw::table::CoordErrKey::CoordErrKey	(	SubSchema const &	s,
		std::string const &	name )

Member Function Documentation

addFields() [1/4]

CoordErrKey lsst::afw::table::CoordErrKey::addFields ( Schema & schema, std::string const & name, NameArray const & units, bool diagonalOnly = false )

static

addFields() [2/4]

CoordErrKey lsst::afw::table::CoordErrKey::addFields ( Schema & schema, std::string const & name, std::string const & unit, bool diagonalOnly = false )

static

addFields() [3/4]

CovarianceMatrixKey lsst::afw::table::CovarianceMatrixKey< float, N >::addFields ( Schema & schema, std::string const & prefix, NameArray const & names, NameArray const & units, bool diagonalOnly = false )

staticinherited

Add covariance matrix fields to a Schema, and return a CovarianceMatrixKey to manage them.

Parameters

[out]	schema	Schema to add fields to.
[in]	prefix	String used to form the first part of all field names. Suffixes of the form '_xErr' and '_x_y_Cov' will be added to form the full field names (using names={'x', 'y'} as an example).
[in]	units	Vector of units for for error (standard deviation) values; covariance matrix elements will have "{units[i]} {units[j]}" or "{units[i]}^2", depending on whether units[i] == units[j].
[in]	names	Vector of strings containing the names of the quantities the covariance matrix represents the uncertainty of.
[in]	diagonalOnly	If true, only create fields for the error values.

addFields() [4/4]

CovarianceMatrixKey lsst::afw::table::CovarianceMatrixKey< float, N >::addFields ( Schema & schema, std::string const & prefix, NameArray const & names, std::string const & unit, bool diagonalOnly = false )

staticinherited

Add covariance matrix fields to a Schema, and return a CovarianceMatrixKey to manage them.

Parameters

[out]	schema	Schema to add fields to.
[in]	prefix	String used to form the first part of all field names. Suffixes of the form '_xErr' and '_x_y_Cov' will be added to form the full field names (using names={'x', 'y'} as an example).
[in]	unit	Unit for for error (standard deviation) values; covariance matrix elements will be unit^2.
[in]	names	Vector of strings containing the names of the quantities the covariance matrix represents the uncertainty of.
[in]	diagonalOnly	If true, only create fields for the error values.

get()

Eigen::Matrix< float, N, N > lsst::afw::table::CovarianceMatrixKey< float, N >::get ( BaseRecord const & record ) const

overridevirtualinherited

Get a covariance matrix from the given record.

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

getElement()

float lsst::afw::table::CovarianceMatrixKey< float, N >::getElement ( BaseRecord const & record, int i, int j ) const

inherited

Return the element in row i and column j.

hash_value()

std::size_t lsst::afw::table::CovarianceMatrixKey< float, N >::hash_value ( ) const

noexceptinherited

Return a hash of this object.

isValid()

bool lsst::afw::table::CovarianceMatrixKey< float, N >::isValid ( ) const

noexceptinherited

Return True if all the constituent error Keys are valid.

Note that if the only one or more off-diagonal keys are invalid, we assume that means those terms are zero, not that the whole FunctorKey is invalid.

operator!=()

bool lsst::afw::table::CovarianceMatrixKey< float, N >::operator!= ( CovarianceMatrixKey< float, 2 > const & other ) const

inlinenoexceptinherited

Definition at line 624 of file aggregates.h.

operator==()

bool lsst::afw::table::CovarianceMatrixKey< float, N >::operator== ( CovarianceMatrixKey< float, 2 > const & other ) const

noexceptinherited

Compare the FunctorKey for equality with another, using its constituent Keys.

set() [1/2]

void lsst::afw::table::CovarianceMatrixKey< float, N >::set ( BaseRecord & record, Eigen::Matrix< float, N, N > const & value ) const

overrideinherited

Set a covariance matrix in the given record (uses only the lower triangle of the given matrix).

set() [2/2]

template<typename T>

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

pure virtualinherited

Implemented in lsst::afw::table::BoxKey< Box >, lsst::afw::table::BoxKey< T >, lsst::afw::table::CoordKey, lsst::afw::table::EllipseKey, lsst::afw::table::PointKey< Element >, and lsst::afw::table::QuadrupoleKey.

setElement()

void lsst::afw::table::CovarianceMatrixKey< float, N >::setElement ( BaseRecord & record, int i, int j, float value ) const

inherited

Set the element in row i and column j.

---

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

• include/lsst/afw/table/aggregates.h