PythonImage.h

// PythonImage.h:
// --------------
//

#ifndef __PYIPSDKBASE_PYTHONIMAGE_H__
#define __PYIPSDKBASE_PYTHONIMAGE_H__

// suppression warnings
// warning C4251: 'ipsdk::python::PythonImage::_pBuffer' : class 'boost::shared_ptr<ipsdk::HybridBuffer>' needs to have dll-interface to be used by clients of class 'ipsdk::python::PythonImage'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <Python/PyIPSDKBase/PyIPSDKBaseExports.h>
#include <Python/PyIPSDKBase/PythonImageTypes.h>
#include <IPSDKImage/Image/BaseCompleteImage.h>
#include <IPSDKBaseData/Buffer/BufferTypes.h>
#include <Python/PyIPSDKBase/PythonImageAccessor.h>
#include <boost/python/numpy.hpp>
#include <boost/scoped_ptr.hpp>

namespace ipsdk {
namespace python {


class PYIPSDKBASE_API PythonImage : public image::BaseCompleteImage
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(PyIPSDKBase, PythonImage);

    // friend class for protected members access
    friend boost::shared_ptr<PythonImage> boost::make_shared<PythonImage>();

// predefined public types
public:
    static const image::eImageType::domain g_imageType = image::eImageType::eIT_Custom;

protected:
    PythonImage();

public:
    ~PythonImage();

// methods
public:
    static void                             setContiguousStyle(const bool bCContiguous);

    image::eImageType                       getImageType() const;

    virtual BoolResult                      init(const image::BaseImageGeometry& geometry);

    BoolResult                              init(const image::BaseImageGeometry& geometry,
                                                 const boost::python::numpy::ndarray& pythonArray);

    BoolResult                              init(const PythonImageAccessorPtr& pImageAccessor);

    BoolResult                              init(const PythonImageAccessorPtr& pImageAccessor,
                                                 const boost::python::numpy::ndarray& pythonArray);

    image::eImageAccessMode                 getAccessMode() const;

    BoolResult                              resize(const image::BaseImageGeometry& geometry);

    bool                                    isBufferOwn() const;

    boost::python::numpy::ndarray           getArray() const;

    ipBool                                  isGpuImage() const;

    ipBool                                  isDiskImage() const;

    void                                    toGPU(PythonCudaImagePtr pOutImg) const;

    PythonCudaImagePtr                      toGPU() const;

protected:
    void                    createImagePlans(const image::BaseImageGeometry& geometry,
                                             image::PlanStorageColl3d& imagePlans);

    void                    updateInternalArray(const image::BaseImageGeometry& geometry,
                                                void* pData) const;

    void                    clearDerived();

// attributes
public:
    HybridBufferPtr                         _pBuffer;

    typedef boost::python::numpy::ndarray PythonArray;

    mutable boost::shared_ptr<PythonArray>  _pArray;

    static bool                             g_bCContiguous;

    PythonImageAccessorPtr                  _pImageAccessor;

};


inline image::eImageType
PythonImage::getImageType() const
{
    return g_imageType;
}


} // end of namespace python
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __PYIPSDKBASE_PYTHONIMAGE_H__