DiskImage.h

// DiskImage.h:
// ------------
//

#ifndef __IPSDKIMAGE_DISKIMAGE_H__
#define __IPSDKIMAGE_DISKIMAGE_H__

// suppression warnings
// warning C4251: 'ipsdk::image::DiskImage::_pDiskImageAccessor' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::image::DiskImage'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKImage/Image/BaseCompleteImage.h>
#include <IPSDKImage/Image/Disk/DiskImageTypes.h>
#include <boost/shared_array.hpp>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API DiskImage : public BaseCompleteImage
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITHOUT_COPY(IPSDKImage, DiskImage);

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

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

protected:
    DiskImage();

public:
    ~DiskImage();
    
// methods
public:
    eImageType                      getImageType() const;

    ipBool                          isGpuImage() const;

    ipBool                          isDiskImage() const;

    BoolResult                      init(const DiskImageAccessorPtr& pDiskImageAccessor);

    virtual BoolResult              init(const BaseImageGeometry& geometry);

    BoolResult                      fromSubImage(const PlanStorageColl3d& imagePlans);

    eImageAccessMode                getAccessMode() const;

    const BaseDiskImageAccessor&    getDiskImageAccessor() const;

    const boost::filesystem::path&  getFilePath() const;

    BoolResult                      resize(const BaseImageGeometry& geometry);

    ipsdk::image::ImagePtr          loadPlan(const ipUInt64 z, const ipUInt64 c, const ipUInt64 t,
                                             const ipUInt64 sizeX = 0, const ipUInt64 sizeY = 0,
                                             const ipUInt64 offsetX = 0, const ipUInt64 offsetY = 0,
                                             const ipUInt64 strideX = 1, const ipUInt64 strideY = 1) const;

    ipsdk::image::ImagePtr          loadColorPlan(const ipUInt64 z, const ipUInt64 t,
                                                  const ipUInt64 sizeX = 0, const ipUInt64 sizeY = 0,
                                                  const ipUInt64 offsetX = 0, const ipUInt64 offsetY = 0,
                                                  const ipUInt64 strideX = 1, const ipUInt64 strideY = 1) const;

    ipReal64                        readPixel(const ipUInt64 x, const ipUInt64 y, const ipUInt64 z = 0, const ipUInt64 c = 0, const ipUInt64 t = 0);

    BoolResult                      writePixel(const ipReal64 value, const ipUInt64 x, const ipUInt64 y, const ipUInt64 z=0, const ipUInt64 c=0, const ipUInt64 t=0);

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

    void                            clearDerived();

    template <typename T>
    BoolResult loadToMemory(const PlanStorageConstPtr pPlanStorage, 
                            const ipUInt64 offsetX, const ipUInt64 offsetY,
                            const ipUInt64 strideX, const ipUInt64 strideY,
                            const ipUInt64 sizeX, const ipUInt64 sizeY,
                            const ipUInt64 imageSizeX, const ipUInt64 imageSizeY,
                            T* pBuffer) const;

    template <typename T>
    BoolResult readPixelValue(ipReal64& value, const ipUInt64 x, const ipUInt64 y, const ipUInt64 sizeX, const PlanStoragePtr pPlanStorage);

    template <typename T>
    BoolResult writePixelValue(const ipReal64 value, const ipUInt64 x, const ipUInt64 y, const ipUInt64 sizeX, const PlanStoragePtr pPlanStorage);

// attributes
protected:
    DiskImageAccessorPtr    _pDiskImageAccessor;
};


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

inline ipBool
DiskImage::isGpuImage() const
{
    return false;
}

inline ipBool
DiskImage::isDiskImage() const
{
    return true;
}


} // end of namespace image
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKIMAGE_DISKIMAGE_H__