#include <aggregates.h>
Public Types | |
| typedef std::vector< Key< T > > | SigmaKeyArray |
| typedef std::vector< Key< T > > | CovarianceKeyArray |
| typedef std::vector< std::string > | NameArray |
Public Member Functions | |
| CovarianceMatrixKey () | |
| Construct an invalid instance; must assign before subsequent use. More... | |
| CovarianceMatrixKey (SigmaKeyArray const &sigma, CovarianceKeyArray const &cov=CovarianceKeyArray()) | |
| Construct a from arrays of per-element Keys. More... | |
| template<typename U > | |
| CovarianceMatrixKey (Key< Covariance< U > > const &other) | |
| Construct from a (now-deprecated Key<Covariance<U>>) More... | |
| CovarianceMatrixKey (SubSchema const &s, NameArray const &names) | |
| Construct from a subschema and an array of names for each parameter of the matrix. More... | |
| virtual Eigen::Matrix< T, N, N > | get (BaseRecord const &record) const |
| Get a covariance matrix from the given record. More... | |
| virtual void | set (BaseRecord &record, Eigen::Matrix< T, N, N > const &value) const |
| Set a covariance matrix in the given record (uses only the lower triangle of the given matrix) More... | |
| bool | isValid () const |
| Return True if all the constituent sigma Keys are valid. More... | |
| bool | operator== (CovarianceMatrixKey const &other) const |
| Compare the FunctorKey for equality with another, using its constituent Keys. More... | |
| bool | operator!= (CovarianceMatrixKey const &other) const |
| Compare the FunctorKey for equality with another, using its constituent Keys. More... | |
 Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< Eigen::Matrix< T, N, N > > | |
| virtual | ~OutputFunctorKey () |
| Public Member Functions inherited from lsst::afw::table::InputFunctorKey< Eigen::Matrix< T, N, N > > | |
| virtual | ~InputFunctorKey () |
Private Attributes | |
| bool | _isDiagonalVariance |
| SigmaKeyArray | _sigma |
| CovarianceKeyArray | _cov |
Detailed Description
template<typename T, int N>
class lsst::afw::table::CovarianceMatrixKey< T, N >
Definition at line 276 of file aggregates.h.
Member Typedef Documentation
| typedef std::vector< Key<T> > lsst::afw::table::CovarianceMatrixKey< T, N >::CovarianceKeyArray |
Definition at line 280 of file aggregates.h.
| typedef std::vector<std::string> lsst::afw::table::CovarianceMatrixKey< T, N >::NameArray |
Definition at line 281 of file aggregates.h.
| typedef std::vector< Key<T> > lsst::afw::table::CovarianceMatrixKey< T, N >::SigmaKeyArray |
Definition at line 279 of file aggregates.h.
Constructor & Destructor Documentation
| lsst::afw::table::CovarianceMatrixKey< T, N >::CovarianceMatrixKey | ( | ) |
Construct an invalid instance; must assign before subsequent use.
|
explicit |
Construct a from arrays of per-element Keys.
The sigma array Keys should point to the square root of the diagonal of the covariance matrix. The cov array Keys should point to the off-diagonal elements of the lower-triangle, packed first in rows, then in columns (or equivalently, in the upper-triangle, packed first in columns, then in rows). For a 4x4 matrix, the order is is:
The cov array may also be empty, to indicate that no off-diagonal elements are stored, and should be set to zero. If not empty, the size of the cov matrix must be exactly n*(n-1)/2, where n is the size of the sigma matrix.
|
explicit |
Construct from a (now-deprecated Key<Covariance<U>>)
This template is only instantiated for the following combinations of template parameters:
- CovarianceMatrixKey<float,Eigen::Dynamic> and Key< ovariance<float> >
- CovarianceMatrixKey<float,2> and Key< Covariance< Point<float> >
- CovarianceMatrixKey<float,3> and Key< Covariance< Moments<float> > Calling templates other than these will result in linker errors.
To access this functionality in Python, please use the makeCovarianceMatrixKey free functions; Swig wasn't able to instantiate the templated constructors.
| lsst::afw::table::CovarianceMatrixKey< T, N >::CovarianceMatrixKey | ( | SubSchema const & | s, |
| NameArray const & | names | ||
| ) |
Construct from a subschema and an array of names for each parameter of the matrix.
The field names should match the following convention:
- diagonal elements should have names like "p1Sigma", where "p1" is the name of the parameter, and should contain the square root of the variance in that parameter.
- off-diagonal elements hould have names like "p1_p2_Cov", where "p1" and "p2" are names of parameters. For example, for the covariance matrix of a position, we'd look for "xSigma", "ySigma", and "x_y_Cov".
Member Function Documentation
|
virtual |
Get a covariance matrix from the given record.
Implements lsst::afw::table::OutputFunctorKey< Eigen::Matrix< T, N, N > >.
| bool lsst::afw::table::CovarianceMatrixKey< T, N >::isValid | ( | ) | const |
Return True if all the constituent sigma 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.
|
inline |
Compare the FunctorKey for equality with another, using its constituent Keys.
Definition at line 355 of file aggregates.h.
| bool lsst::afw::table::CovarianceMatrixKey< T, N >::operator== | ( | CovarianceMatrixKey< T, N > const & | other | ) | const |
Compare the FunctorKey for equality with another, using its constituent Keys.
|
virtual |
Set a covariance matrix in the given record (uses only the lower triangle of the given matrix)
Implements lsst::afw::table::InputFunctorKey< Eigen::Matrix< T, N, N > >.
Member Data Documentation
|
private |
Definition at line 361 of file aggregates.h.
|
private |
Definition at line 359 of file aggregates.h.
|
private |
Definition at line 360 of file aggregates.h.
The documentation for this class was generated from the following file:
- /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/table/aggregates.h
