itk::PyBuffer< TImage > Class Template Reference

#include <itkPyBuffer.h>

Detailed Description

template<typename TImage>
class itk::PyBuffer< TImage >

Helper class to get ITK image views into python arrays and back.

This class will receive a C buffer and create the equivalent python array view. This permits passing image buffers into python arrays from the NumPy python package.

Definition at line 49 of file itkPyBuffer.h.

Public Types
using	ComponentType = typename DefaultConvertPixelTraits< PixelType >::ComponentType
using	ImagePointer = typename ImageType::Pointer
using	ImageType = TImage
using	IndexType = typename ImageType::IndexType
using	OutputImagePointer = typename Image< ComponentType, ImageDimension >::Pointer
using	PixelType = typename ImageType::PixelType
using	PointType = typename ImageType::PointType
using	RegionType = typename ImageType::RegionType
using	Self = PyBuffer
using	SizeType = typename ImageType::SizeType
using	SpacingType = typename ImageType::SpacingType

Static Public Member Functions
static PyObject *	_GetArrayViewFromImage (ImageType *image)
static const OutputImagePointer	_GetImageViewFromArray (PyObject *arr, PyObject *shape, PyObject *numOfComponent)

Static Public Attributes
static constexpr unsigned int	ImageDimension = ImageType::ImageDimension

Private Member Functions
void	operator= (const Self &)
	PyBuffer (const Self &)

Member Typedef Documentation

template<typename TImage >

using itk::PyBuffer< TImage >::ComponentType = typename DefaultConvertPixelTraits<PixelType>::ComponentType

Definition at line 64 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::ImagePointer = typename ImageType::Pointer

Definition at line 63 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::ImageType = TImage

Type of the image from which the buffer will be converted

Definition at line 56 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::IndexType = typename ImageType::IndexType

Definition at line 59 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::OutputImagePointer = typename Image< ComponentType, ImageDimension >::Pointer

Definition at line 69 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::PixelType = typename ImageType::PixelType

Definition at line 57 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::PointType = typename ImageType::PointType

Definition at line 61 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::RegionType = typename ImageType::RegionType

Definition at line 60 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::Self = PyBuffer

Standard "Self" type alias.

Definition at line 53 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::SizeType = typename ImageType::SizeType

Definition at line 58 of file itkPyBuffer.h.

template<typename TImage >

using itk::PyBuffer< TImage >::SpacingType = typename ImageType::SpacingType

Definition at line 62 of file itkPyBuffer.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::PyBuffer< TImage >::PyBuffer ( const Self &  )

private

Member Function Documentation

template<typename TImage >

static PyObject* itk::PyBuffer< TImage >::_GetArrayViewFromImage ( ImageType *  image )

static

Get an Array with the content of the image buffer

template<typename TImage >

static const OutputImagePointer itk::PyBuffer< TImage >::_GetImageViewFromArray ( PyObject *  arr, PyObject *  shape, PyObject *  numOfComponent  )

static

Get an ITK image from a Python array

template<typename TImage >

void itk::PyBuffer< TImage >::operator= ( const Self &  )

private

Member Data Documentation

template<typename TImage >

constexpr unsigned int itk::PyBuffer< TImage >::ImageDimension = ImageType::ImageDimension

static

Image dimension.

Definition at line 67 of file itkPyBuffer.h.

---

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

• itkPyBuffer.h