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::ImageZStripColor3dSplit< TProcessor, InputDataType, TAttribute > Class Template Reference

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

#include <ImageZStripColor3dSplit.h>

Inheritance diagram for ipsdk::imaproc::ImageZStripColor3dSplit< TProcessor, InputDataType, TAttribute >:
ipsdk::imaproc::BaseImageZStripColor3dSplit< InputDataType, TAttribute::ValueType > ipsdk::imaproc::BaseImageStripSplit< InputDataType > ipsdk::processor::BaseDynamicSplit 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::BaseImageZStripColor3dSplit< InputDataType, TAttribute::ValueType >
typedef TAttribute::ValueType OutputType
 output data type for split operation
 
- Public Types inherited from ipsdk::imaproc::BaseImageStripSplit< 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 image::eStripAllocationType &stripAllocationType, const image::eStripParsingDirection &stripParsingDirection, const bool bAllowGreyColorGeometry)
 initialization method for splitted objects More...
 
Constructors and destructors
 ImageZStripColor3dSplit ()
 
 ~ImageZStripColor3dSplit ()
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageZStripColor3dSplit< InputDataType, TAttribute::ValueType >
eImageStripSplitType getImageStripSplitType () const
 retrieve image strip split operation type
 
const image::eStripAllocationTypegetStripAllocationType () const
 retrieve flag indicating whether splitted strip allocation should be forced More...
 
const image::eStripParsingDirectiongetStripParsingDirection () const
 retrieve strip parsing direction associated to attribute allocation should be forced More...
 
 BaseImageZStripColor3dSplit ()
 
virtual ~BaseImageZStripColor3dSplit ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageStripSplit< InputDataType >
processor::eSplitDynamicType getSplitDynamicType () const
 retrieve dynamic split operation type
 
eImageSplitType getImageSplitType () const
 retrieve image split operation type
 
const image::BaseImagegetImage () const
 retrieve image to be splitted More...
 
 BaseImageStripSplit ()
 
virtual ~BaseImageStripSplit ()=0
 
- Public Member Functions inherited from ipsdk::processor::BaseDynamicSplit
eSplitBaseType getSplitBaseType () const
 retrieve split operation base type
 
ipUInt64 getNbMinEltsPerSplit () const
 retrieve minimum number of elements for a split operation More...
 
ipUInt64 getNbMaxEltsPerSplit () const
 retrieve maximum number of elements for a split operation More...
 
BoolResult initAttribute (BaseProcessor &processor, const ipUInt64 elementsStartIndex, const ipUInt64 nbElements, const core::BaseRequestOrigin &requestOrigin)
 initialize processor attribute associate to split operation for a starting element index and a number of elements More...
 
 BaseDynamicSplit ()
 
virtual ~BaseDynamicSplit ()=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 > &pImageZStripColor3d)
 initialize processor attribute associate to split operation for a given element index More...
 
- Protected Member Functions inherited from ipsdk::imaproc::BaseImageZStripColor3dSplit< InputDataType, TAttribute::ValueType >
void initBase (const boost::shared_ptr< InputDataType > &pImage, const image::eStripAllocationType &stripAllocationType, const image::eStripParsingDirection &stripParsingDirection, const bool bAllowGreyColorGeometry)
 base class initialization method More...
 
- Protected Member Functions inherited from ipsdk::imaproc::BaseImageStripSplit< InputDataType >
void initSplitted (const boost::shared_ptr< InputDataType > &pImage, const processor::ElementsLocationInfo &elementsLocationInfo, const ipUInt64 nbMinEltsPerSplit=1, const ipUInt64 nbMaxEltsPerSplit=NumericLimits< ipUInt64 >::max())
 base class initialization method for splitted case More...
 
void initUnSplitted (const boost::shared_ptr< InputDataType > &pImage, const processor::ElementsLocationInfo &elementsLocationInfo)
 special base initialization method for un splitted case More...
 
const boost::shared_ptr< InputDataType > & getImagePtr () const
 retrieve image pointer to be splitted More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseDynamicSplit
void initSplitted (const ElementsLocationInfo &elementsLocationInfo, const ipUInt64 nbMinEltsPerSplit=1, const ipUInt64 nbMaxEltsPerSplit=NumericLimits< ipUInt64 >::max())
 base class initialization method for splitted case More...
 
void initUnSplitted (const ElementsLocationInfo &elementsLocationInfo)
 base class initialization method for un splitted case 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::BaseDynamicSplit
static const eSplitBaseType::domain g_splitBaseType = eSplitBaseType::eSBT_Dynamic
 data split type associated to object
 
- Protected Attributes inherited from ipsdk::processor::BaseDynamicSplit
ipUInt64 _nbMinEltsPerSplit
 minimum number of elements for a split operation
 
ipUInt64 _nbMaxEltsPerSplit
 maximum number of elements for a split operation
 

Detailed Description

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

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

Author
H. Delestre
Date
2016/02/11

Member Function Documentation

◆ init()

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

initialization method for splitted objects

Exceptions
ipsdk::imaproc::IPSDKImageProcessingExceptionif pImage.get() == 0
ipsdk::image::IPSDKImageExceptionif pImage.isInit() == false

◆ processAttribute()

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

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

Returns
false in case of failure

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


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