lsst.afw g5a732f18d5+66d966b544
Loading...
Searching...
No Matches
Classes | Typedefs | Functions
lsst::afw::table::python Namespace Reference

Classes

class  PyCatalogIndexIterator
 

Typedefs

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

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.
 
template<typename Record >
ndarray::Array< double const, 1, 1 > _getArrayFromCatalog (CatalogT< Record > const &catalog, Key< Angle > const &key)
 Extract a column from a potentially non-contiguous Catalog (angle specialization)
 
template<typename T , typename Record >
ndarray::Array< typename Field< T >::Value const, 2, 2 > _getArrayFromCatalog (CatalogT< Record > const &catalog, Key< Array< T > > const &key)
 Extract an array-valued column from a potentially non-contiguous Catalog into a 2-d array.
 
template<typename Record >
void _setFlagColumnToArray (CatalogT< Record > &catalog, Key< Flag > const &key, ndarray::Array< bool const, 1 > const &array)
 
template<typename Record >
void _setFlagColumnToScalar (CatalogT< Record > &catalog, Key< Flag > const &key, bool value)
 
template<typename T , typename Record >
void declareCatalogOverloads (PyCatalog< Record > &cls)
 Declare field-type-specific overloaded catalog member functions for one field type.
 
template<typename T , typename Record >
void declareCatalogArrayOverloads (PyCatalog< Record > &cls)
 Declare field-type-specific overloaded catalog member functions for one array-valued field type.
 
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>.
 
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>.
 
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>.
 

Typedef Documentation

◆ PyCatalog

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

Definition at line 39 of file catalog.h.

◆ PyColumnView

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

Definition at line 39 of file columnView.h.

◆ PySortedCatalog

Initial value:
pybind11::class_<SortedCatalogT<Record>, std::shared_ptr<SortedCatalogT<Record>>, CatalogT<Record>>

Definition at line 39 of file sortedCatalog.h.

Function Documentation

◆ _getArrayFromCatalog() [1/3]

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

Extract a column from a potentially non-contiguous Catalog (angle specialization)

Parameters
catalogCatalog
keyKey to column to extract

Definition at line 59 of file catalog.h.

◆ _getArrayFromCatalog() [2/3]

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

Extract an array-valued column from a potentially non-contiguous Catalog into a 2-d array.

Parameters
catalogCatalog
keyKey to column to extract

Definition at line 75 of file catalog.h.

◆ _getArrayFromCatalog() [3/3]

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 43 of file catalog.h.

◆ _setFlagColumnToArray()

template<typename Record >
void lsst::afw::table::python::_setFlagColumnToArray ( CatalogT< Record > & catalog,
Key< Flag > const & key,
ndarray::Array< bool const, 1 > const & array )

Definition at line 89 of file catalog.h.

◆ _setFlagColumnToScalar()

template<typename Record >
void lsst::afw::table::python::_setFlagColumnToScalar ( CatalogT< Record > & catalog,
Key< Flag > const & key,
bool value )

Definition at line 109 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 276 of file catalog.h.

◆ declareCatalogArrayOverloads()

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

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

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

Definition at line 235 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 168 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 53 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.