BaseImageZStrip3dWithKernel.h

// BaseImageZStrip3dWithKernel.h:
// ------------------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEZSTRIP3DWITHKERNEL_H__
#define __IPSDKIMAGE_BASEIMAGEZSTRIP3DWITHKERNEL_H__

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

#include <IPSDKImage/Fragment/Strip/BaseImageStrip.h>
#include <IPSDKBaseData/Buffer/HybridBuffer.h>

namespace ipsdk {
namespace image {


class IPSDKIMAGE_API BaseImageZStrip3dWithKernel : public BaseImageStrip
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseImageZStrip3dWithKernel)

// predefined public types
public:
    static const eImageStripType::domain g_imageStripType = eImageStripType::eIST_Z3dWithKernel;

public:
    BaseImageZStrip3dWithKernel();
    virtual ~BaseImageZStrip3dWithKernel() = 0;

// methods
public:
    eImageStripType                 getImageStripType() const;

    const eImageBufferType&         getBufferType() const;

    //---------------------------
    //---------------------------

    ipUInt64                        getKernelSizeX() const;

    ipUInt64                        getKernelSizeY() const;

    ipUInt64                        getKernelSizeZ() const;

    ipUInt64                        getStartingKernelSizeX() const;

    ipUInt64                        getEndingKernelSizeX() const;

    ipUInt64                        getStartingKernelSizeY() const;

    ipUInt64                        getEndingKernelSizeY() const;

    ipUInt64                        getStartingKernelSizeZ() const;

    ipUInt64                        getEndingKernelSizeZ() const;

    //-----------------------------------------
    //-----------------------------------------

    const eStripParsingDirection&   getStripParsingDirection() const;

    ipUInt64                        getSizeX() const;

    ipUInt64                        getSizeY() const;

    ipUInt64                        getStripStartOffsetZ() const;

    ipUInt64                        getStripSizeZ() const;

    ipUInt64                        getImageSizeZ() const;

    const ipUInt64                  getFullStripSize() const;

    const ipUInt64                  getPlanStripSize() const;

    const ipUInt64                  getStripNbPlans() const;

    //----------------------------------------
    //----------------------------------------

    ipUInt64                        getStartingSizeZ() const;

    ipUInt64                        getNbMissingStartingPlans() const;

    ipUInt64                        getEndingSizeZ() const;

    ipUInt64                        getNbMissingEndingPlans() const;

    //--------------------
    //--------------------

    ipUInt64                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;

    //---------------------------
    //---------------------------

    ImageZStrip3dConstPtr           getStartingStripPtr() const;

    ImageZStrip3dConstPtr           getMainStripPtr() const;

    ImageZStrip3dConstPtr           getEndingStripPtr() const;

protected:
    void                    initBase(const ipUInt64 startingKernelSizeX,
                                     const ipUInt64 endingKernelSizeX,
                                     const ipUInt64 startingKernelSizeY,
                                     const ipUInt64 endingKernelSizeY,
                                     const ipUInt64 startingKernelSizeZ,
                                     const ipUInt64 endingKernelSizeZ,
                                     const ImageZStrip3dPtr& pStartingStrip,
                                     const ImageZStrip3dPtr& pMainStrip,
                                     const ImageZStrip3dPtr& pEndingStrip,
                                     const DataIdentifierConstPtr& pImageIdentifier,
                                     const DataItemMapConstPtr& pImageHeader);

    bool                    isBufferInitDerived() const;

    BoolResult              initBufferDerived();

    void                    clearBufferDerived();

    eDataAccessMode         retrieveAccessMode() const;

    //-----------------------------------
    //-----------------------------------

    BoolResult              readDataDerived() const;

    BoolResult              writeDataDerived();

    void                    clearDerived();

// attributes
private:
    ipUInt64                _startingKernelSizeX;

    ipUInt64                _endingKernelSizeX;

    ipUInt64                _startingKernelSizeY;

    ipUInt64                _endingKernelSizeY;

    ipUInt64                _startingKernelSizeZ;

    ipUInt64                _endingKernelSizeZ;

    ImageZStrip3dPtr        _pStartingStrip;

    ImageZStrip3dPtr        _pMainStrip;

    ImageZStrip3dPtr        _pEndingStrip;
};


inline eImageStripType
BaseImageZStrip3dWithKernel::getImageStripType() const
{
    return g_imageStripType;
}


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEZSTRIP3DWITHKERNEL_H__