itkPyBuffer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/

#ifndef itkPyBuffer_h
#define itkPyBuffer_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkImportImageFilter.h"
#include "itkDefaultConvertPixelTraits.h"


// The python header defines _POSIX_C_SOURCE without a preceding #undef
#undef _POSIX_C_SOURCE
#include <Python.h>
// This should eventually be replaced with something that uses the buffer-api
// like the implementation in SimpleITK
#include <numpy/arrayobject.h>


namespace itk
{

template <typename TImage>
class PyBuffer
{
public:
  typedef PyBuffer         Self;

  typedef TImage                                                       ImageType;
  typedef typename ImageType::PixelType                                PixelType;
  typedef typename ImageType::SizeType                                 SizeType;
  typedef typename ImageType::IndexType                                IndexType;
  typedef typename ImageType::RegionType                               RegionType;
  typedef typename ImageType::PointType                                PointType;
  typedef typename ImageType::SpacingType                              SpacingType;
  typedef typename ImageType::Pointer                                  ImagePointer;
  typedef typename DefaultConvertPixelTraits<PixelType>::ComponentType ComponentType;

  itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);

  typedef typename Image< ComponentType, ImageDimension >::Pointer  OutputImagePointer;

  static PyObject * GetArrayFromImage( ImageType * image, bool keepAxes = false);

  static const OutputImagePointer GetImageFromArray( PyObject *obj );

protected:

private:
  PyBuffer(const Self&);       // Purposely not implemented.
  void operator=(const Self&); // Purposely not implemented.
};

// This declaration is void of a definition, so that unsupported types
// will generate a compile time error.
template <class T> struct PyTypeTraits;

template<> struct PyTypeTraits<double> { enum { value = NPY_DOUBLE }; };
template<> struct PyTypeTraits<float> { enum { value = NPY_FLOAT }; };

template<> struct PyTypeTraits<std::complex<float> > { enum { value = NPY_COMPLEX64 }; };
template<> struct PyTypeTraits<std::complex<double> > { enum { value = NPY_COMPLEX128 }; };

template<> struct PyTypeTraits<long long>{ enum { value = NPY_LONGLONG }; };
template<> struct PyTypeTraits<unsigned long long>{ enum { value = NPY_ULONGLONG }; };

template<> struct PyTypeTraits<long>{ enum { value = NPY_LONG }; };
template<> struct PyTypeTraits<unsigned long>{ enum { value = NPY_ULONG }; };

template<> struct PyTypeTraits<int>{ enum { value = NPY_INT }; };
template<> struct PyTypeTraits<unsigned int>{ enum { value = NPY_UINT }; };

template<> struct PyTypeTraits<short>{ enum { value = NPY_SHORT }; };
template<> struct PyTypeTraits<unsigned short>{ enum { value = NPY_USHORT }; };

template<> struct PyTypeTraits<signed char>{ enum { value = NPY_BYTE }; };
template<> struct PyTypeTraits<unsigned char>{ enum { value = NPY_UBYTE }; };

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPyBuffer.hxx"
#endif

#endif // _itkPyBuffer_h