BaseImageYStrip2dWithKernel.h

// BaseImageYStrip2dWithKernel.h:
// ------------------------------
//

#ifndef __IPSDKIMAGE_BASEIMAGEYSTRIP2DWITHKERNEL_H__
#define __IPSDKIMAGE_BASEIMAGEYSTRIP2DWITHKERNEL_H__

// suppression warnings
// warning C4251: 'ipsdk::image::BaseImageYStrip2dWithKernel::_pStartingStrip' : class 'boost::shared_ptr<T>' needs to have dll-interface to be used by clients of class 'ipsdk::image::BaseImageYStrip2dWithKernel'
#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 BaseImageYStrip2dWithKernel : public BaseImageStrip
{
    // declare serial class
    IPSDK_DECLARE_ABSTRACT_SERIAL_WITHOUT_COPY(IPSDKImage, BaseImageYStrip2dWithKernel)

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

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

// methods
public:
    eImageStripType                 getImageStripType() const;

    const eImageBufferType&         getBufferType() const;

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

    ipUInt64                        getKernelSizeX() const;

    ipUInt64                        getKernelSizeY() const;

    ipUInt64                        getStartingKernelSizeX() const;

    ipUInt64                        getEndingKernelSizeX() const;

    ipUInt64                        getStartingKernelSizeY() const;

    ipUInt64                        getEndingKernelSizeY() const;

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

    const eStripParsingDirection&   getStripParsingDirection() const;

    ipUInt64                        getSizeX() const;

    ipUInt64                        getStripStartOffsetY() const;

    ipUInt64                        getStripSizeY() const;

    ipUInt64                        getImageSizeY() const;

    const ipUInt64                  getFullStripSize() const;

    const ipUInt64                  getPlanStripSize() const;

    const ipUInt64                  getStripNbPlans() const;

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

    ipUInt64                        getStartingSizeY() const;

    ipUInt64                        getNbMissingStartingRows() const;

    ipUInt64                        getEndingSizeY() const;

    ipUInt64                        getNbMissingEndingRows() const;

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

    ipUInt64                        getZPlanIdx() const;

    ipUInt64                        getCPlanIdx() const;

    ipUInt64                        getTPlanIdx() const;
    
    //---------------------------
    //---------------------------

    ImageYStrip2dConstPtr           getStartingStripPtr() const;

    ImageYStrip2dConstPtr           getMainStripPtr() const;

    ImageYStrip2dConstPtr           getEndingStripPtr() const;

protected:
    void                    initBase(const ipUInt64 startingKernelSizeX,
                                     const ipUInt64 endingKernelSizeX,
                                     const ipUInt64 startingKernelSizeY,
                                     const ipUInt64 endingKernelSizeY,
                                     const ImageYStrip2dPtr& pStartingStrip,
                                     const ImageYStrip2dPtr& pMainStrip,
                                     const ImageYStrip2dPtr& 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;

    ImageYStrip2dPtr        _pStartingStrip;

    ImageYStrip2dPtr        _pMainStrip;

    ImageYStrip2dPtr        _pEndingStrip;
};


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


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

#pragma warning (pop)

#endif // __IPSDKIMAGE_BASEIMAGEYSTRIP2DWITHKERNEL_H__