lsst.afw g9b27d6183c+9f38135d59
|
A FunctorKey used to get or set a ndarray::Array from a sequence of scalar Keys. More...
#include <arrays.h>
Public Types | |
using | Value = ndarray::Array< T const, 1, 1 > |
The data type for get and set. More... | |
Public Member Functions | |
ArrayKey () noexcept | |
Default constructor; instance will not be usable unless subsequently assigned to. More... | |
ArrayKey (std::vector< Key< T > > const &keys) | |
Construct from a vector of scalar Keys. More... | |
ArrayKey (Key< Array< T > > const &other) noexcept | |
Construct from a compound Key< Array<T> > More... | |
ArrayKey (SubSchema const &s) | |
Construct from a subschema, assuming *_0, *_1, *_2, etc. More... | |
ArrayKey (ArrayKey const &) noexcept | |
ArrayKey (ArrayKey &&) noexcept | |
ArrayKey & | operator= (ArrayKey const &) noexcept |
ArrayKey & | operator= (ArrayKey &&) noexcept |
~ArrayKey () noexcept override | |
std::size_t | getSize () const noexcept |
Return the number of elements in the array. More... | |
ndarray::Array< T const, 1, 1 > | get (BaseRecord const &record) const override |
Get an array from the given record. More... | |
void | set (BaseRecord &record, ndarray::Array< T const, 1, 1 > const &value) const override |
Set an array in the given record. More... | |
ndarray::ArrayRef< T, 1, 1 > | getReference (BaseRecord &record) const override |
Get non-const reference array from the given record. More... | |
ndarray::ArrayRef< T const, 1, 1 > | getConstReference (BaseRecord const &record) const override |
Get const reference array from the given record. More... | |
bool | operator== (ArrayKey< T > const &other) const noexcept |
Compare the FunctorKey for equality with another, using the underlying scalar Keys. More... | |
bool | operator!= (ArrayKey< T > const &other) const noexcept |
std::size_t | hash_value () const noexcept |
Return a hash of this object. More... | |
bool | isValid () const noexcept |
Return True if the FunctorKey contains valid scalar keys. More... | |
Key< T > | operator[] (std::size_t i) const |
Return a scalar Key for an element of the array. More... | |
ArrayKey | slice (std::size_t begin, std::size_t end) const |
Return a FunctorKey corresponding to a range of elements. More... | |
Static Public Member Functions | |
static ArrayKey | addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit, std::vector< T > const &docData) |
Add an array of fields to a Schema, and return an ArrayKey that points to them. More... | |
static ArrayKey | addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit, size_t size) |
Add an array of fields to a Schema, and return an ArrayKey that points to them. More... | |
A FunctorKey used to get or set a ndarray::Array from a sequence of scalar Keys.
ArrayKey operates on the convention that arrays are defined by a set of contiguous scalar fields (i.e. added to the Schema in order, with no interruption) of the same type, with a common field name prefix and "_0", "_1" etc. suffixes.
|
inherited |
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
|
inlinenoexcept |
|
explicit |
|
explicitnoexcept |
|
explicit |
|
defaultnoexcept |
|
defaultnoexcept |
|
overridedefaultnoexcept |
|
static |
Add an array of fields to a Schema, and return an ArrayKey that points to them.
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_0", "_1", etc. will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the fields. |
[in] | unit | String used as the unit for all fields. |
[in] | size | Number of fields to add. |
|
static |
Add an array of fields to a Schema, and return an ArrayKey that points to them.
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_0", "_1", etc. will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the fields. Should include a single boost::format template string, which will be substituted with the appropriate element from the docData array to form the full documentation string. |
[in] | unit | String used as the unit for all fields. |
[in] | docData | Vector of values substituted into the doc fields. The length of the vector determines the number of fields added. |
|
overridevirtual |
Get an array from the given record.
Implements lsst::afw::table::OutputFunctorKey< ndarray::Array< T const, 1, 1 > >.
|
overridevirtual |
Get const reference array from the given record.
Implements lsst::afw::table::ConstReferenceFunctorKey< ndarray::ArrayRef< T const, 1, 1 > >.
|
overridevirtual |
Get non-const reference array from the given record.
Implements lsst::afw::table::ReferenceFunctorKey< ndarray::ArrayRef< T, 1, 1 > >.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Return True if the FunctorKey contains valid scalar keys.
|
inlinenoexcept |
|
defaultnoexcept |
|
defaultnoexcept |
|
inlinenoexcept |
Compare the FunctorKey for equality with another, using the underlying scalar Keys.
Key< T > lsst::afw::table::ArrayKey< T >::operator[] | ( | std::size_t | i | ) | const |
|
overridevirtual |
Set an array in the given record.
Implements lsst::afw::table::InputFunctorKey< ndarray::Array< T const, 1, 1 > >.
ArrayKey< T > lsst::afw::table::ArrayKey< T >::slice | ( | std::size_t | begin, |
std::size_t | end | ||
) | const |
Return a FunctorKey corresponding to a range of elements.