lsst::afw::table::SourceColumnViewT< RecordT > Class Template Reference

#include <fwd.h>

Inheritance diagram for lsst::afw::table::SourceColumnViewT< RecordT >:

Public Types
typedef RecordT	Record
typedef RecordT::Table	Table

Public Member Functions
ndarray::Array< double, 1 >	getPsfInstFlux () const
	Get the value of the PsfFlux slot measurement. More...
ndarray::Array< double, 1 >	getPsfInstFluxErr () const
	Get the uncertainty on the PsfFlux slot measurement. More...
ndarray::Array< double, 1 >	getApInstFlux () const
	Get the value of the ApFlux slot measurement. More...
ndarray::Array< double, 1 >	getApInstFluxErr () const
	Get the uncertainty on the ApFlux slot measurement. More...
ndarray::Array< double, 1 >	getModelInstFlux () const
	Get the value of the ModelFlux slot measurement. More...
ndarray::Array< double, 1 >	getModelInstFluxErr () const
	Get the uncertainty on the ModelFlux slot measurement. More...
ndarray::Array< double, 1 >	getGaussianInstFlux () const
	Get the value of the GaussianFlux slot measurement. More...
ndarray::Array< double, 1 >	getGaussianInstFluxErr () const
	Get the uncertainty on the GaussianFlux slot measurement. More...
ndarray::Array< double, 1 >	getCalibInstFlux () const
	Get the value of the CalibFlux slot measurement. More...
ndarray::Array< double, 1 >	getCalibInstFluxErr () const
	Get the uncertainty on the CalibFlux slot measurement. More...
ndarray::Array< double, 1 > const	getX () const
ndarray::Array< double, 1 > const	getY () const
ndarray::Array< double, 1 > const	getIxx () const
ndarray::Array< double, 1 > const	getIyy () const
ndarray::Array< double, 1 > const	getIxy () const
	SourceColumnViewT (SourceColumnViewT const &)=default
	SourceColumnViewT (SourceColumnViewT &&)=default
SourceColumnViewT &	operator= (SourceColumnViewT const &)=default
SourceColumnViewT &	operator= (SourceColumnViewT &&)=default
	~SourceColumnViewT ()=default
std::shared_ptr< Table >	getTable () const
	Return the table that owns the records. More...
Schema	getSchema () const
	Return the schema that defines the fields. More...
template<typename T >
ndarray::ArrayRef< T, 1 > const	operator[] (Key< T > const &key) const
	Return a 1-d array corresponding to a scalar field (or subfield). More...
template<typename T >
ndarray::ArrayRef< T, 2, 1 > const	operator[] (Key< Array< T > > const &key) const
	Return a 2-d array corresponding to an array field. More...
ndarray::result_of::vectorize< detail::FlagExtractor, ndarray::Array< Field< Flag >::Element const, 1 > >::type	operator[] (Key< Flag > const &key) const
	Return a 1-d array expression corresponding to a flag bit. More...
BitsColumn	getBits (std::vector< Key< Flag > > const &keys) const
	Return an integer array with the given Flag fields repacked into individual bits. More...
BitsColumn	getAllBits () const
	Return an integer array with all Flag fields repacked into individual bits. More...

Static Public Member Functions
template<typename InputIterator >
static SourceColumnViewT	make (std::shared_ptr< Table > const &table, InputIterator first, InputIterator last)
	Construct a BaseColumnView from an iterator range. More...
template<typename InputIterator >
static BaseColumnView	make (std::shared_ptr< BaseTable > const &table, InputIterator first, InputIterator last)
	Construct a BaseColumnView from an iterator range. More...
template<typename InputIterator >
static bool	isRangeContiguous (std::shared_ptr< BaseTable > const &table, InputIterator first, InputIterator last)
	Return true if the given record iterator range is continuous and the records all belong to the given table. More...

Protected Member Functions
	SourceColumnViewT (BaseColumnView const &base)

Detailed Description

template<typename RecordT>
class lsst::afw::table::SourceColumnViewT< RecordT >

Definition at line 65 of file fwd.h.

Member Typedef Documentation

Record

template<typename RecordT >

typedef RecordT lsst::afw::table::SourceColumnViewT< RecordT >::Record

Definition at line 551 of file Source.h.

Table

template<typename RecordT >

typedef RecordT::Table lsst::afw::table::SourceColumnViewT< RecordT >::Table

Definition at line 552 of file Source.h.

Constructor & Destructor Documentation

SourceColumnViewT() [1/3]

template<typename RecordT >

lsst::afw::table::SourceColumnViewT< RecordT >::SourceColumnViewT ( SourceColumnViewT< RecordT > const &  )

default

SourceColumnViewT() [2/3]

template<typename RecordT >

lsst::afw::table::SourceColumnViewT< RecordT >::SourceColumnViewT ( SourceColumnViewT< RecordT > &&  )

default

~SourceColumnViewT()

template<typename RecordT >

lsst::afw::table::SourceColumnViewT< RecordT >::~SourceColumnViewT ( )

default

SourceColumnViewT() [3/3]

template<typename RecordT >

lsst::afw::table::SourceColumnViewT< RecordT >::SourceColumnViewT ( BaseColumnView const &  base )

inlineexplicitprotected

Definition at line 633 of file Source.h.

: ColumnViewT<RecordT>(base) {}

Member Function Documentation

getAllBits()

BitsColumn lsst::afw::table::BaseColumnView::getAllBits ( ) const

inherited

Return an integer array with all Flag fields repacked into individual bits.

The returned object contains both the int64 array and accessors to obtain a mask given a Key or field name.

Exceptions

pex::exceptions::LengthError

if the schema has more than 64 Flag fields.

Definition at line 147 of file BaseColumnView.cc.

                                            {
    BitsColumn result(_impl->recordCount);
    ExtractFlagItems func = {&result._items};
    getSchema().forEach(func);
    if (result._items.size() > sizeof(BitsColumn::IntT)) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Too many Flag keys in schema; %d > %d.") % result._items.size() %
                           sizeof(BitsColumn::IntT))
                                  .str());
    }
    ndarray::ArrayRef<BitsColumn::IntT, 1, 1> array = result._array.deep();
    BitsColumn::IntT const size = result._items.size();  // just for unsigned/signed comparisons
    for (BitsColumn::IntT i = 0; i < size; ++i) {
        array |= (BitsColumn::IntT(1) << i) * (*this)[result._items[i].key];
    }
    return result;
}

getApInstFlux()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getApInstFlux ( ) const

inline

Get the value of the ApFlux slot measurement.

Definition at line 567 of file Source.h.

                                                  {
        return this->operator[](this->getTable()->getApFluxSlot().getMeasKey());
    }

getApInstFluxErr()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getApInstFluxErr ( ) const

inline

Get the uncertainty on the ApFlux slot measurement.

Definition at line 571 of file Source.h.

                                                     {
        return this->operator[](this->getTable()->getApFluxSlot().getErrKey());
    }

getBits()

BitsColumn lsst::afw::table::BaseColumnView::getBits ( std::vector< Key< Flag > > const &  keys ) const

inherited

Return an integer array with the given Flag fields repacked into individual bits.

The returned object contains both the int64 array and accessors to obtain a mask given a Key or field name.

Exceptions

pex::exceptions::LengthError

if keys.size() > 64

Definition at line 117 of file BaseColumnView.cc.

                                                                          {
    BitsColumn result(_impl->recordCount);
    ndarray::ArrayRef<BitsColumn::IntT, 1, 1> array = result._array.deep();
    if (keys.size() > sizeof(BitsColumn::IntT)) {
        throw LSST_EXCEPT(pex::exceptions::LengthError,
                          (boost::format("Too many keys passed to getBits(); %d > %d.") % keys.size() %
                           sizeof(BitsColumn::IntT))
                                  .str());
    }
    BitsColumn::IntT const size = keys.size();  // just for unsigned/signed comparisons
    for (BitsColumn::IntT i = 0; i < size; ++i) {
        array |= (BitsColumn::IntT(1) << i) * (*this)[keys[i]];
        result._items.push_back(getSchema().find(keys[i]));
    }
    return result;
}

getCalibInstFlux()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getCalibInstFlux ( ) const

inline

Get the value of the CalibFlux slot measurement.

Definition at line 594 of file Source.h.

                                                     {
        return this->operator[](this->getTable()->getCalibFluxSlot().getMeasKey());
    }

getCalibInstFluxErr()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getCalibInstFluxErr ( ) const

inline

Get the uncertainty on the CalibFlux slot measurement.

Definition at line 598 of file Source.h.

                                                        {
        return this->operator[](this->getTable()->getCalibFluxSlot().getErrKey());
    }

getGaussianInstFlux()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getGaussianInstFlux ( ) const

inline

Get the value of the GaussianFlux slot measurement.

Definition at line 585 of file Source.h.

                                                        {
        return this->operator[](this->getTable()->getGaussianFluxSlot().getMeasKey());
    }

getGaussianInstFluxErr()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getGaussianInstFluxErr ( ) const

inline

Get the uncertainty on the GaussianFlux slot measurement.

Definition at line 589 of file Source.h.

                                                           {
        return this->operator[](this->getTable()->getGaussianFluxSlot().getErrKey());
    }

getIxx()

template<typename RecordT >

ndarray::Array<double, 1> const lsst::afw::table::SourceColumnViewT< RecordT >::getIxx ( ) const

inline

Definition at line 609 of file Source.h.

                                                 {
        return this->operator[](this->getTable()->getShapeKey().getIxx());
    }

getIxy()

template<typename RecordT >

ndarray::Array<double, 1> const lsst::afw::table::SourceColumnViewT< RecordT >::getIxy ( ) const

inline

Definition at line 615 of file Source.h.

                                                 {
        return this->operator[](this->getTable()->getShapeKey().getIxy());
    }

getIyy()

template<typename RecordT >

ndarray::Array<double, 1> const lsst::afw::table::SourceColumnViewT< RecordT >::getIyy ( ) const

inline

Definition at line 612 of file Source.h.

                                                 {
        return this->operator[](this->getTable()->getShapeKey().getIyy());
    }

getModelInstFlux()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getModelInstFlux ( ) const

inline

Get the value of the ModelFlux slot measurement.

Definition at line 576 of file Source.h.

                                                     {
        return this->operator[](this->getTable()->getModelFluxSlot().getMeasKey());
    }

getModelInstFluxErr()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getModelInstFluxErr ( ) const

inline

Get the uncertainty on the ModelFlux slot measurement.

Definition at line 580 of file Source.h.

                                                        {
        return this->operator[](this->getTable()->getModelFluxSlot().getErrKey());
    }

getPsfInstFlux()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getPsfInstFlux ( ) const

inline

Get the value of the PsfFlux slot measurement.

Definition at line 558 of file Source.h.

                                                   {
        return this->operator[](this->getTable()->getPsfFluxSlot().getMeasKey());
    }

getPsfInstFluxErr()

template<typename RecordT >

ndarray::Array<double, 1> lsst::afw::table::SourceColumnViewT< RecordT >::getPsfInstFluxErr ( ) const

inline

Get the uncertainty on the PsfFlux slot measurement.

Definition at line 562 of file Source.h.

                                                      {
        return this->operator[](this->getTable()->getPsfFluxSlot().getErrKey());
    }

getSchema()

Schema lsst::afw::table::BaseColumnView::getSchema ( ) const

inlineinherited

Return the schema that defines the fields.

Definition at line 89 of file BaseColumnView.h.

{ return getTable()->getSchema(); }

getTable()

template<typename RecordT >

std::shared_ptr<Table> lsst::afw::table::ColumnViewT< RecordT >::getTable ( ) const

inlineinherited

Return the table that owns the records.

Definition at line 176 of file BaseColumnView.h.

                                          {
        return std::static_pointer_cast<Table>(BaseColumnView::getTable());
    }

getX()

template<typename RecordT >

ndarray::Array<double, 1> const lsst::afw::table::SourceColumnViewT< RecordT >::getX ( ) const

inline

Definition at line 602 of file Source.h.

                                               {
        return this->operator[](this->getTable()->getCentroidKey().getX());
    }

getY()

template<typename RecordT >

ndarray::Array<double, 1> const lsst::afw::table::SourceColumnViewT< RecordT >::getY ( ) const

inline

Definition at line 605 of file Source.h.

                                               {
        return this->operator[](this->getTable()->getCentroidKey().getY());
    }

isRangeContiguous()

template<typename InputIterator >

bool lsst::afw::table::BaseColumnView::isRangeContiguous ( std::shared_ptr< BaseTable > const &  table, InputIterator  first, InputIterator  last  )

staticinherited

Return true if the given record iterator range is continuous and the records all belong to the given table.

This tests exactly the same requiremetns needed to construct a column view, so if this test succeeds, BaseColumnView::make should as well.

Definition at line 218 of file BaseColumnView.h.

                                                           {
    if (first == last) return true;
    Schema schema = table->getSchema();
    std::size_t recordSize = schema.getRecordSize();
    std::size_t recordCount = 1;
    void* buf = first->_data;
    ndarray::Manager::Ptr manager = first->_manager;
    char* expected = reinterpret_cast<char*>(buf) + recordSize;
    for (++first; first != last; ++first, ++recordCount, expected += recordSize) {
        if (first->_data != expected || first->_manager != manager) {
            return false;
        }
    }
    return true;
}

make() [1/2]

template<typename InputIterator >

BaseColumnView lsst::afw::table::BaseColumnView::make ( std::shared_ptr< BaseTable > const &  table, InputIterator  first, InputIterator  last  )

staticinherited

Construct a BaseColumnView from an iterator range.

The iterators must dereference to a reference or const reference to a record. If the record data is not contiguous in memory, throws lsst::pex::exceptions::RuntimeError.

Definition at line 197 of file BaseColumnView.h.

                                                        {
    if (first == last) {
        return BaseColumnView(table, 0, 0, ndarray::Manager::Ptr());
    }
    Schema schema = table->getSchema();
    std::size_t recordSize = schema.getRecordSize();
    std::size_t recordCount = 1;
    void* buf = first->_data;
    ndarray::Manager::Ptr manager = first->_manager;
    char* expected = reinterpret_cast<char*>(buf) + recordSize;
    for (++first; first != last; ++first, ++recordCount, expected += recordSize) {
        if (first->_data != expected || first->_manager != manager) {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                              "Record data is not contiguous in memory.");
        }
    }
    return BaseColumnView(table, recordCount, buf, manager);
}

make() [2/2]

template<typename RecordT >

template<typename InputIterator >

static SourceColumnViewT lsst::afw::table::SourceColumnViewT< RecordT >::make ( std::shared_ptr< Table > const &  table, InputIterator  first, InputIterator  last  )

inlinestatic

Construct a BaseColumnView from an iterator range.

The iterators must dereference to a reference or const reference to a record. If the record data is not contiguous in memory, throws lsst::pex::exceptions::RuntimeError.

Definition at line 621 of file Source.h.

                                                      {
        return SourceColumnViewT(BaseColumnView::make(table, first, last));
    }

operator=() [1/2]

template<typename RecordT >

SourceColumnViewT& lsst::afw::table::SourceColumnViewT< RecordT >::operator= ( SourceColumnViewT< RecordT > const &  )

default

operator=() [2/2]

template<typename RecordT >

SourceColumnViewT& lsst::afw::table::SourceColumnViewT< RecordT >::operator= ( SourceColumnViewT< RecordT > &&  )

default

operator[]() [1/3]

template<typename T >

ndarray::ArrayRef< T, 1 > const lsst::afw::table::BaseColumnView::operator[] ( Key< T > const &  key ) const

inherited

Return a 1-d array corresponding to a scalar field (or subfield).

Definition at line 71 of file BaseColumnView.cc.

                                                                                       {
    if (!key.isValid()) {
        throw LSST_EXCEPT(
            pex::exceptions::LogicError,
            "Key is not valid (if this is a SourceCatalog, make sure slot aliases have been set up).");
    }
    return ndarray::external(reinterpret_cast<T *>(reinterpret_cast<char *>(_impl->buf) + key.getOffset()),
                             ndarray::makeVector(_impl->recordCount),
                             ndarray::makeVector(int(_impl->table->getSchema().getRecordSize() / sizeof(T))),
                             _impl->manager);
}

operator[]() [2/3]

template<typename T >

ndarray::ArrayRef< T, 2, 1 > const lsst::afw::table::BaseColumnView::operator[] ( Key< Array< T > > const &  key ) const

inherited

Return a 2-d array corresponding to an array field.

Definition at line 84 of file BaseColumnView.cc.

                                                                                                  {
    if (!key.isValid()) {
        throw LSST_EXCEPT(
            pex::exceptions::LogicError,
            "Key is not valid (if this is a SourceCatalog, make sure slot aliases have been set up).");
    }
    if (key.isVariableLength()) {
        throw LSST_EXCEPT(pex::exceptions::LogicError, "Cannot get columns for variable-length array fields");
    }
    return ndarray::external(
            reinterpret_cast<T *>(reinterpret_cast<char *>(_impl->buf) + key.getOffset()),
            ndarray::makeVector(_impl->recordCount, key.getSize()),
            ndarray::makeVector(int(_impl->table->getSchema().getRecordSize() / sizeof(T)), 1),
            _impl->manager);
}

operator[]() [3/3]

ndarray::result_of::vectorize< detail::FlagExtractor, ndarray::Array< Field< Flag >::Element const, 1 > >::type lsst::afw::table::BaseColumnView::operator[] ( Key< Flag > const &  key ) const

inherited

Return a 1-d array expression corresponding to a flag bit.

In C++, the return value is a lazy ndarray expression template that performs the bitwise & operation on every element when that element is requested. In Python, the result will be copied into a bool NumPy array.

Definition at line 101 of file BaseColumnView.cc.

                                                             {
    if (!key.isValid()) {
        throw LSST_EXCEPT(
            pex::exceptions::LogicError,
            "Key is not valid (if this is a SourceCatalog, make sure slot aliases have been set up).");
    }
    return ndarray::vectorize(detail::FlagExtractor(key),
                              ndarray::Array<Field<Flag>::Element const, 1>(ndarray::external(
                                      reinterpret_cast<Field<Flag>::Element *>(
                                              reinterpret_cast<char *>(_impl->buf) + key.getOffset()),
                                      ndarray::makeVector(_impl->recordCount),
                                      ndarray::makeVector(int(_impl->table->getSchema().getRecordSize() /
                                                              sizeof(Field<Flag>::Element))),
                                      _impl->manager)));
}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/table/fwd.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/table/Source.h