lsst::afw::table::BitsColumn Class Reference

A packed representation of a collection of Flag field columns. More...

#include <BaseColumnView.h>

Public Types
using	SizeT = std::size_t

Public Member Functions
ndarray::Array< SizeT, 1, 1 >	getArray () const
SizeT	getBit (Key< Flag > const &key) const
SizeT	getBit (std::string const &name) const
SizeT	getMask (Key< Flag > const &key) const
SizeT	getMask (std::string const &name) const
std::vector< SchemaItem< Flag > > const &	getSchemaItems () const

Friends
class	BaseColumnView

Detailed Description

A packed representation of a collection of Flag field columns.

The packing of bits here is not necessarily the same as the packing using in the actual table, as the latter may contain more than 64 bits spread across multiple integers.

A BitsColumn can only be constructed by calling BaseColumnView::getBits().

Definition at line 42 of file BaseColumnView.h.

Member Typedef Documentation

SizeT

using lsst::afw::table::BitsColumn::SizeT = std::size_t

Definition at line 44 of file BaseColumnView.h.

Member Function Documentation

getArray()

ndarray::Array< SizeT, 1, 1 > lsst::afw::table::BitsColumn::getArray ( ) const

inline

Definition at line 46 of file BaseColumnView.h.

{ return _array; }

getBit() [1/2]

BitsColumn::SizeT lsst::afw::table::BitsColumn::getBit

(

Key< Flag > const &

key

)

const

Definition at line 33 of file BaseColumnView.cc.

                                                             {
    SizeT r = std::find_if(_items.begin(), _items.end(), MatchKey(key)) - _items.begin();
    if (std::size_t(r) == _items.size()) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("'%s' not found in BitsColumn") % key).str());
    }
    return r;
}

getBit() [2/2]

BitsColumn::SizeT lsst::afw::table::BitsColumn::getBit

(

std::string const &

name

)

const

Definition at line 42 of file BaseColumnView.cc.

                                                              {
    SizeT r = std::find_if(_items.begin(), _items.end(), MatchName(name)) - _items.begin();
    if (std::size_t(r) == _items.size()) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("'%s' not found in BitsColumn") % name).str());
    }
    return r;
}

getMask() [1/2]

SizeT lsst::afw::table::BitsColumn::getMask ( Key< Flag > const & key ) const

inline

Definition at line 51 of file BaseColumnView.h.

{ return SizeT(1) << getBit(key); }

getMask() [2/2]

SizeT lsst::afw::table::BitsColumn::getMask ( std::string const & name ) const

inline

Definition at line 52 of file BaseColumnView.h.

{ return SizeT(1) << getBit(name); }

getSchemaItems()

std::vector< SchemaItem< Flag > > const & lsst::afw::table::BitsColumn::getSchemaItems ( ) const

inline

Definition at line 54 of file BaseColumnView.h.

{ return _items; }

Friends And Related Symbol Documentation

BaseColumnView

friend class BaseColumnView

friend

Definition at line 57 of file BaseColumnView.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/table/BaseColumnView.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/src/table/BaseColumnView.cc