lsst.afw  19.0.0-23-g9b026a6e0
Typedefs | Functions
lsst::afw::table::python Namespace Reference

Typedefs

template<typename Record >
using PyCatalog = pybind11::class_< CatalogT< Record >, std::shared_ptr< CatalogT< Record > >>
 
template<typename Record >
using PyColumnView = pybind11::class_< ColumnViewT< Record >, std::shared_ptr< ColumnViewT< Record > >, BaseColumnView >
 
template<typename Record >
using PySortedCatalog = pybind11::class_< SortedCatalogT< Record >, std::shared_ptr< SortedCatalogT< Record > >, CatalogT< Record > >
 

Functions

template<typename T , typename Record >
ndarray::Array< typename Field< T >::Value const, 1, 1 > _getArrayFromCatalog (CatalogT< Record > const &catalog, Key< T > const &key)
 Extract a column from a potentially non-contiguous Catalog. More...
 
template<typename Record >
ndarray::Array< double const, 1, 1 > _getArrayFromCatalog (CatalogT< Record > const &catalog, Key< lsst::geom::Angle > const &key)
 
template<typename T , typename Record >
void declareCatalogOverloads (PyCatalog< Record > &cls)
 Declare field-type-specific overloaded catalog member functions for one field type. More...
 
template<typename Record >
PyCatalog< Record > declareCatalog (utils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
 Wrap an instantiation of lsst::afw::table::CatalogT<Record>. More...
 
template<typename Record >
PyColumnView< Record > declareColumnView (utils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
 Declare member and static functions for a given instantiation of lsst::afw::table::ColumnViewT<RecordT>. More...
 
template<typename Record >
PySortedCatalog< Record > declareSortedCatalog (utils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
 Wrap an instantiation of lsst::afw::table::SortedCatalogT<Record>. More...
 

Typedef Documentation

◆ PyCatalog

template<typename Record >
using lsst::afw::table::python::PyCatalog = typedef pybind11::class_<CatalogT<Record>, std::shared_ptr<CatalogT<Record> >>

Definition at line 38 of file catalog.h.

◆ PyColumnView

template<typename Record >
using lsst::afw::table::python::PyColumnView = typedef pybind11::class_<ColumnViewT<Record>, std::shared_ptr<ColumnViewT<Record> >, BaseColumnView>

Definition at line 38 of file columnView.h.

◆ PySortedCatalog

template<typename Record >
using lsst::afw::table::python::PySortedCatalog = typedef pybind11::class_<SortedCatalogT<Record>, std::shared_ptr<SortedCatalogT<Record> >, CatalogT<Record> >

Definition at line 39 of file sortedCatalog.h.

Function Documentation

◆ _getArrayFromCatalog() [1/2]

template<typename Record >
ndarray::Array<double const, 1, 1> lsst::afw::table::python::_getArrayFromCatalog ( CatalogT< Record > const &  catalog,
Key< lsst::geom::Angle > const &  key 
)
Parameters
catalogCatalog
keyKey to column to extract

Definition at line 58 of file catalog.h.

◆ _getArrayFromCatalog() [2/2]

template<typename T , typename Record >
ndarray::Array<typename Field<T>::Value const, 1, 1> lsst::afw::table::python::_getArrayFromCatalog ( CatalogT< Record > const &  catalog,
Key< T > const &  key 
)

Extract a column from a potentially non-contiguous Catalog.

Parameters
catalogCatalog
keyKey to column to extract

Definition at line 42 of file catalog.h.

◆ declareCatalog()

template<typename Record >
PyCatalog<Record> lsst::afw::table::python::declareCatalog ( utils::python::WrapperCollection wrappers,
std::string const &  name,
bool  isBase = false 
)

Wrap an instantiation of lsst::afw::table::CatalogT<Record>.

In addition to calling this method you must call addCatalogMethods on the class object in Python.

Template Parameters
RecordRecord type, e.g. BaseRecord or SimpleRecord.
Parameters
[in]wrappersPackage manager class will be added to.
[in]nameName prefix of the record type, e.g. "Base" or "Simple".
[in]isBaseWhether this instantiation is only being used as a base class (used to set the class name).

Definition at line 130 of file catalog.h.

◆ declareCatalogOverloads()

template<typename T , typename Record >
void lsst::afw::table::python::declareCatalogOverloads ( PyCatalog< Record > &  cls)

Declare field-type-specific overloaded catalog member functions for one field type.

Template Parameters
TField type.
RecordRecord type, e.g. BaseRecord or SimpleRecord.
Parameters
[in]clsCatalog pybind11 class.

Definition at line 80 of file catalog.h.

◆ declareColumnView()

template<typename Record >
PyColumnView<Record> lsst::afw::table::python::declareColumnView ( utils::python::WrapperCollection wrappers,
std::string const &  name,
bool  isBase = false 
)

Declare member and static functions for a given instantiation of lsst::afw::table::ColumnViewT<RecordT>.

Template Parameters
RecordRecord type, e.g. BaseRecord or SimpleRecord.
Parameters
[in]wrappersPackage manager class will be added to.
[in]nameName prefix of the record type, e.g. "Base" or "Simple".
[in]isBaseWhether this instantiation is only being used as a base class (used to set the class name).

Definition at line 52 of file columnView.h.

◆ declareSortedCatalog()

template<typename Record >
PySortedCatalog<Record> lsst::afw::table::python::declareSortedCatalog ( utils::python::WrapperCollection wrappers,
std::string const &  name,
bool  isBase = false 
)

Wrap an instantiation of lsst::afw::table::SortedCatalogT<Record>.

In addition to calling this method (which also instantiates and wraps the CatalogT base class), you must call addCatalogMethods on the class object in Python.

Template Parameters
RecordRecord type, e.g. BaseRecord or SimpleRecord.
Parameters
[in]wrappersPackage manager class will be added to.
[in]nameName prefix of the record type, e.g. "Base" or "Simple".
[in]isBaseWhether this instantiation is only being used as a base class (used to set the class name).

Definition at line 57 of file sortedCatalog.h.