IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Protected Member Functions | List of all members
ipsdk::imaproc::StaticImageZStrip3dSplit< TProcessor, InputDataType, TAttribute > Class Template Reference

Concrete class for static split operation generating image z strips 3d. More...

#include <StaticImageZStrip3dSplit.h>

Inheritance diagram for ipsdk::imaproc::StaticImageZStrip3dSplit< TProcessor, InputDataType, TAttribute >:
ipsdk::imaproc::BaseStaticImageZStrip3dSplit< InputDataType, TAttribute::ValueType > ipsdk::imaproc::BaseStaticImageStripSplit< InputDataType > ipsdk::processor::BaseStaticSplit ipsdk::processor::BaseDataSplit

Public Types

typedef TProcessor ProcessorType
 processor type associated to object
 
typedef TAttribute AttributeType
 attribute type associated to object
 
typedef TAttribute::ValueType OutputType
 output data type for split operation
 
- Public Types inherited from ipsdk::imaproc::BaseStaticImageZStrip3dSplit< InputDataType, TAttribute::ValueType >
typedef TAttribute::ValueType OutputType
 output data type for split operation
 
- Public Types inherited from ipsdk::imaproc::BaseStaticImageStripSplit< InputDataType >
typedef InputDataType InputType
 input data type for split operation
 

Public Member Functions

const std::string & getAttributeName () const
 retrieve attribute name associated to split operation
 
const std::string & getAttributeToolTip () const
 retrieve attribute tooltip associated to split operation
 
void init (const boost::shared_ptr< InputDataType > &pImage, const ElementsRangeColl &planElementInfoColl, const image::eStripAllocationType &stripAllocationType, const image::eStripParsingDirection &stripParsingDirection)
 initialization method for splitted objects More...
 
Constructors and destructors
 StaticImageZStrip3dSplit ()
 
 ~StaticImageZStrip3dSplit ()
 
- Public Member Functions inherited from ipsdk::imaproc::BaseStaticImageZStrip3dSplit< InputDataType, TAttribute::ValueType >
eStaticImageStripSplitType getStaticImageStripSplitType () const
 retrieve static image strip split operation type
 
 BaseStaticImageZStrip3dSplit ()
 
virtual ~BaseStaticImageZStrip3dSplit ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BaseStaticImageStripSplit< InputDataType >
processor::eSplitStaticType getSplitStaticType () const
 retrieve static split operation type
 
eImageSplitType getImageSplitType () const
 retrieve image split operation type
 
const image::BaseImagegetImage () const
 retrieve image to be splitted More...
 
 BaseStaticImageStripSplit ()
 
virtual ~BaseStaticImageStripSplit ()=0
 
- Public Member Functions inherited from ipsdk::processor::BaseStaticSplit
eSplitBaseType getSplitBaseType () const
 retrieve split operation base type
 
BoolResult initAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)
 initialize processor attribute associate to split operation for a starting element index and a number of elements More...
 
 BaseStaticSplit ()
 
virtual ~BaseStaticSplit ()=0
 
- Public Member Functions inherited from ipsdk::processor::BaseDataSplit
bool isInit () const
 retrieve object initialization flag
 
bool isSplitted () const
 check whether object will be associated to split operation More...
 
const ElementsLocationInfogetElementsLocationInfo () const
 retrieve data location informations More...
 
ipUInt64 getFullMemorySize () const
 retrieve full memory data size for elements More...
 
bool areDataLocalized () const
 check whether data are localized More...
 
bool hasLocalData () const
 check whether some data are local data More...
 
bool hasRemoteData () const
 check whether some data are remote data More...
 
void disableDataLocalization ()
 method allowing to disable data localization More...
 
 BaseDataSplit ()
 
virtual ~BaseDataSplit ()=0
 
ipUInt64 getNbElements () const
 retrieve total number of elements associated to input data More...
 
ipUInt64 getDataMemorySize (const ipUInt64 elementIdx) const
 retrieve memory size of data for a given element More...
 
ipUInt64 getDataMemorySize () const
 retrieve memory size of data for a given element More...
 

Protected Member Functions

bool checkProcessorType (const processor::BaseProcessor &processor)
 check processor type in derived class
 
BoolResult processAttribute (processor::BaseProcessor &processor, const boost::shared_ptr< OutputType > &pImageZStrip3d)
 initialize processor attribute associate to split operation for a given element index More...
 
- Protected Member Functions inherited from ipsdk::imaproc::BaseStaticImageZStrip3dSplit< InputDataType, TAttribute::ValueType >
void initBase (const boost::shared_ptr< InputDataType > &pImage, const ElementsRangeColl &planElementInfoColl, const image::eStripAllocationType &stripAllocationType, const image::eStripParsingDirection &stripParsingDirection)
 base class initialization method More...
 
- Protected Member Functions inherited from ipsdk::imaproc::BaseStaticImageStripSplit< InputDataType >
void initBase (const boost::shared_ptr< InputDataType > &pImage, const processor::ElementsLocationInfo &elementsLocationInfo)
 base class initialization method More...
 
const boost::shared_ptr< InputDataType > & getImagePtr () const
 retrieve image pointer to be splitted More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseDataSplit
void initBaseSplitted (const ElementsLocationInfo &elementsLocationInfo)
 base class initialization method for splitted elements More...
 
void initBaseUnSplitted (const ElementsLocationInfo &elementsLocationInfo)
 base class initialization method for un splitted elements More...
 
void throwNullInputSharedPtr ()
 

Additional Inherited Members

- Static Public Attributes inherited from ipsdk::processor::BaseStaticSplit
static const eSplitBaseType::domain g_splitBaseType = eSplitBaseType::eSBT_Static
 data split type associated to object
 
- Protected Attributes inherited from ipsdk::imaproc::BaseStaticImageZStrip3dSplit< InputDataType, TAttribute::ValueType >
image::eStripParsingDirection _stripParsingDirection
 strip parsing direction associated to attribute
 
image::eStripAllocationType _stripAllocationType
 flag indicating whether splitted strip allocation should be forced
 
ElementsRangeColl _planElementInfoColl
 

Detailed Description

template<typename TProcessor, typename InputDataType, typename TAttribute>
class ipsdk::imaproc::StaticImageZStrip3dSplit< TProcessor, InputDataType, TAttribute >

Concrete class for static split operation generating image z strips 3d.

Author
E. Noirfalise
Date
2015/02/10

Member Function Documentation

◆ init()

template<typename TProcessor , typename InputDataType , typename TAttribute >
void ipsdk::imaproc::StaticImageZStrip3dSplit< TProcessor, InputDataType, TAttribute >::init ( const boost::shared_ptr< InputDataType > &  pImage,
const ElementsRangeColl planElementInfoColl,
const image::eStripAllocationType stripAllocationType,
const image::eStripParsingDirection stripParsingDirection 
)
inline

initialization method for splitted objects

Exceptions
ipsdk::imaproc::IPSDKImageProcessingExceptionif pImage.get() == 0
ipsdk::imaproc::IPSDKImageProcessingExceptionif planElementInfoColl[i]._startOffset + planElementInfoColl[i]._size > pImage->getSizeZ()

◆ processAttribute()

template<typename TProcessor , typename InputDataType , typename TAttribute >
BoolResult ipsdk::imaproc::StaticImageZStrip3dSplit< TProcessor, InputDataType, TAttribute >::processAttribute ( processor::BaseProcessor processor,
const boost::shared_ptr< OutputType > &  pImageZStrip3d 
)
inlineprotectedvirtual

initialize processor attribute associate to split operation for a given element index

Returns
false in case of failure

Implements ipsdk::imaproc::BaseStaticImageZStrip3dSplit< InputDataType, TAttribute::ValueType >.


The documentation for this class was generated from the following file: