Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst::afw::table::Field< T > Struct Template Reference

A description of a field in a table. More...

#include <Field.h>

Inheritance diagram for lsst::afw::table::Field< T >:
lsst::afw::table::FieldBase< T >

Public Types

using Element = typename FieldBase<T>::Element
 Type used to store field data in the table (a field may have multiple elements).
 
using Value = T
 the type returned by BaseRecord::get
 
using Reference = T &
 the type returned by BaseRecord::operator[] (non-const)
 
using ConstReference = const T &
 the type returned by BaseRecord::operator[] (const)
 

Public Member Functions

 Field (std::string const &name, std::string const &doc, std::string const &units="", FieldBase< T > const &size=FieldBase< T >())
 Construct a new field.
 
 Field (std::string const &name, std::string const &doc, FieldBase< T > const &size)
 Construct a new field.
 
 Field (Field const &)=default
 
 Field (Field &&) noexcept=default
 
Fieldoperator= (Field const &)=default
 
Fieldoperator= (Field &&) noexcept=default
 
 ~Field () noexcept=default
 
std::string const & getName () const noexcept
 Return the name of the field.
 
std::string const & getDoc () const noexcept
 Return the documentation for the field.
 
std::string const & getUnits () const noexcept
 Return the units for the field.
 
Field< T > copyRenamed (std::string const &newName) const
 Return a new Field with a new name and other properties the same as this.
 
std::size_t getElementCount () const noexcept
 Return the number of subfield elements (always one for scalars).
 

Static Public Member Functions

static std::string getTypeString ()
 Return a string description of the field type.
 

Protected Member Functions

void stream (std::ostream &os) const
 Defines how Fields are printed.
 
Reference getReference (Element *p, ndarray::Manager::Ptr const &) const
 Used to implement BaseRecord::operator[] (non-const).
 
ConstReference getConstReference (Element const *p, ndarray::Manager::Ptr const &) const
 Used to implement BaseRecord::operator[] (const).
 
Value getValue (Element const *p, ndarray::Manager::Ptr const &) const
 Used to implement BaseRecord::get.
 
void setValue (Element *p, ndarray::Manager::Ptr const &, Value v) const
 Used to implement BaseRecord::set.
 

Static Protected Member Functions

static FieldBase makeDefault () noexcept
 Needed to allow Keys to be default-constructed.
 

Friends

std::ostreamoperator<< (std::ostream &os, Field< T > const &field)
 Stringification.
 

Detailed Description

template<typename T>
struct lsst::afw::table::Field< T >

A description of a field in a table.

Field combines a type with the field name, documentation, units, and in some cases, the size of the field.

Specializations for different field types are inherited through FieldBase; see the documentation for those specializations for additional information about particular field types.

Definition at line 24 of file Field.h.

Member Typedef Documentation

◆ ConstReference

template<typename T>
using lsst::afw::table::FieldBase< T >::ConstReference = const T &
inherited

the type returned by BaseRecord::operator[] (const)

Definition at line 44 of file FieldBase.h.

◆ Element

template<typename T>
using lsst::afw::table::Field< T >::Element = typename FieldBase<T>::Element

Type used to store field data in the table (a field may have multiple elements).

Definition at line 26 of file Field.h.

◆ Reference

template<typename T>
using lsst::afw::table::FieldBase< T >::Reference = T &
inherited

the type returned by BaseRecord::operator[] (non-const)

Definition at line 43 of file FieldBase.h.

◆ Value

template<typename T>
using lsst::afw::table::FieldBase< T >::Value = T
inherited

the type returned by BaseRecord::get

Definition at line 42 of file FieldBase.h.

Constructor & Destructor Documentation

◆ Field() [1/4]

template<typename T>
lsst::afw::table::Field< T >::Field ( std::string const & name,
std::string const & doc,
std::string const & units = "",
FieldBase< T > const & size = FieldBase<T>() )
inline

Construct a new field.

Parameters
[in]nameName of the field. Schemas provide extra functionality for names whose components are separated by underscores. Field names should be limited to letters, numbers, and underscores.
[in]docDocumentation for the field. Should not contain single-quotes to avoid FITS round-trip problems.
[in]unitsUnits for the field. Should not contain single-quotes to avoid FITS round-trip problems.
[in]sizeSize of the field as an integer, if appropriate. Field types that accept a size have a FieldBase that is implicitly constructable from an integer, so the argument type should be considered to effectively be int; using FieldBase here allows use to throw when the signature does not match the field type.

Definition at line 44 of file Field.h.

46 : FieldBase<T>(size), _name(name), _doc(doc), _units(units) {}
A description of a field in a table.
Definition Field.h:24

◆ Field() [2/4]

template<typename T>
lsst::afw::table::Field< T >::Field ( std::string const & name,
std::string const & doc,
FieldBase< T > const & size )
inline

Construct a new field.

Parameters
[in]nameName of the field. Schemas provide extra functionality for names whose components are separated by underscores. Field names should be limited to letters, numbers, and underscores.
[in]docDocumentation for the field.
[in]sizeSize of the field as an integer, if appropriate. Field types that accept a size have a FieldBase that is implicitly constructable from an integer, so the argument type should be considered to effectively be int; using FieldBase here allows use to throw when the signature does not match the field type.

Definition at line 61 of file Field.h.

62 : FieldBase<T>(size), _name(name), _doc(doc), _units() {}

◆ Field() [3/4]

template<typename T>
lsst::afw::table::Field< T >::Field ( Field< T > const & )
default

◆ Field() [4/4]

template<typename T>
lsst::afw::table::Field< T >::Field ( Field< T > && )
defaultnoexcept

◆ ~Field()

template<typename T>
lsst::meas::extensions::psfex::Field::~Field ( )
defaultnoexcept

Definition at line 50 of file fieldImpl.cc.

51{
52 for (int i = 0; i != impl->next; ++i) {
53 free(impl->wcs[i]); // psfex's wcs isn't quite the same as ours ...
54 impl->wcs[i] = NULL; // ... so don't let psfex free it
55 }
57 impl = NULL;
58}

Member Function Documentation

◆ copyRenamed()

template<typename T>
Field< T > lsst::afw::table::Field< T >::copyRenamed ( std::string const & newName) const
inline

Return a new Field with a new name and other properties the same as this.

Definition at line 89 of file Field.h.

89 {
90 return Field<T>(newName, getDoc(), getUnits(), *this);
91 }
std::string const & getUnits() const noexcept
Return the units for the field.
Definition Field.h:77
Field(std::string const &name, std::string const &doc, std::string const &units="", FieldBase< T > const &size=FieldBase< T >())
Construct a new field.
Definition Field.h:44
std::string const & getDoc() const noexcept
Return the documentation for the field.
Definition Field.h:74

◆ getConstReference()

template<typename T>
ConstReference lsst::afw::table::FieldBase< T >::getConstReference ( Element const * p,
ndarray::Manager::Ptr const &  ) const
inlineprotectedinherited

Used to implement BaseRecord::operator[] (const).

Definition at line 78 of file FieldBase.h.

78{ return *p; }
Field base class default implementation (used for numeric scalars and lsst::geom::Angle).
Definition FieldBase.h:41

◆ getDoc()

template<typename T>
std::string const & lsst::afw::table::Field< T >::getDoc ( ) const
inlinenoexcept

Return the documentation for the field.

Definition at line 74 of file Field.h.

74{ return _doc; }

◆ getElementCount()

template<typename T>
std::size_t lsst::afw::table::FieldBase< T >::getElementCount ( ) const
inlinenoexceptinherited

Return the number of subfield elements (always one for scalars).

Definition at line 48 of file FieldBase.h.

48{ return 1; }

◆ getName()

template<typename T>
std::string const & lsst::afw::table::Field< T >::getName ( ) const
inlinenoexcept

Return the name of the field.

Definition at line 71 of file Field.h.

71{ return _name; }

◆ getReference()

template<typename T>
Reference lsst::afw::table::FieldBase< T >::getReference ( Element * p,
ndarray::Manager::Ptr const &  ) const
inlineprotectedinherited

Used to implement BaseRecord::operator[] (non-const).

Definition at line 75 of file FieldBase.h.

75{ return *p; }

◆ getTypeString()

template<typename T>
std::string lsst::afw::table::FieldBase< T >::getTypeString ( )
staticinherited

Return a string description of the field type.

Definition at line 56 of file FieldBase.cc.

56 {
58}

◆ getUnits()

template<typename T>
std::string const & lsst::afw::table::Field< T >::getUnits ( ) const
inlinenoexcept

Return the units for the field.

Definition at line 77 of file Field.h.

77{ return _units; }

◆ getValue()

template<typename T>
Value lsst::afw::table::FieldBase< T >::getValue ( Element const * p,
ndarray::Manager::Ptr const &  ) const
inlineprotectedinherited

Used to implement BaseRecord::get.

Definition at line 81 of file FieldBase.h.

81{ return *p; }

◆ makeDefault()

template<typename T>
static FieldBase lsst::afw::table::FieldBase< T >::makeDefault ( )
inlinestaticprotectednoexceptinherited

Needed to allow Keys to be default-constructed.

Definition at line 69 of file FieldBase.h.

69{ return FieldBase(); }

◆ operator=() [1/2]

template<typename T>
Field & lsst::afw::table::Field< T >::operator= ( Field< T > && )
defaultnoexcept

◆ operator=() [2/2]

template<typename T>
Field & lsst::afw::table::Field< T >::operator= ( Field< T > const & )
default

◆ setValue()

template<typename T>
void lsst::afw::table::FieldBase< T >::setValue ( Element * p,
ndarray::Manager::Ptr const & ,
Value v ) const
inlineprotectedinherited

Used to implement BaseRecord::set.

Definition at line 84 of file FieldBase.h.

84{ *p = v; }

◆ stream()

template<typename T>
void lsst::afw::table::FieldBase< T >::stream ( std::ostream & os) const
inlineprotectedinherited

Defines how Fields are printed.

Definition at line 72 of file FieldBase.h.

72{}

Friends And Related Symbol Documentation

◆ operator<<

template<typename T>
std::ostream & operator<< ( std::ostream & os,
Field< T > const & field )
friend

Stringification.

Definition at line 80 of file Field.h.

80 {
81 os << "Field['" << Field<T>::getTypeString() << "'](name=\"" << field.getName() << "\"";
82 if (!field.getDoc().empty()) os << ", doc=\"" << field.getDoc() << "\"";
83 if (!field.getUnits().empty()) os << ", units=\"" << field.getUnits() << "\"";
85 return os << ")";
86 }
T empty(T... args)
static std::string getTypeString()
Return a string description of the field type.
Definition FieldBase.cc:56
void stream(std::ostream &os) const
Defines how Fields are printed.
Definition FieldBase.h:72
std::string const & getName() const noexcept
Return the name of the field.
Definition Field.h:71

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