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::PlanIndexedSplit< TProcessor, InputStorageType, TAttribute > Class Template Reference

Concrete class for split operation using input plan indexed data. More...

#include <PlanIndexedSplit.h>

Inheritance diagram for ipsdk::imaproc::PlanIndexedSplit< TProcessor, InputStorageType, TAttribute >:
ipsdk::imaproc::BasePlanIndexedSplit 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 InputStorageType::element_type InputValueType
 input value type for split operation
 
typedef boost::remove_const< InputValueType >::type InputMutableValueType
 input mutable value type for split operation
 
typedef TAttribute::StorageType OutputStorageType
 output storage 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 InputStorageType &pPlanIndexedColl, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT, const bool bCanBeSingle=false)
 initialization method for splitted objects More...
 
Constructors and destructors
 PlanIndexedSplit ()
 
 ~PlanIndexedSplit ()
 
- Public Member Functions inherited from ipsdk::imaproc::BasePlanIndexedSplit
processor::eSplitStaticType getSplitStaticType () const
 retrieve static split operation type
 
eImageSplitType getImageSplitType () const
 retrieve image split operation type
 
const BasePlanIndexedCollgetPlanIndexedColl () const
 retrieve plan indexed collection to be splitted More...
 
 BasePlanIndexedSplit ()
 
virtual ~BasePlanIndexedSplit ()=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 ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)
 initialize processor attribute associate to split operation for a given element index More...
 
- Protected Member Functions inherited from ipsdk::imaproc::BasePlanIndexedSplit
void initBase (const PlanIndexedCollPtr &pPlanIndexedColl, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT, const bool bCanBeSingle)
 base class initialization method 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::BasePlanIndexedSplit
PlanIndexedCollPtr _pPlanIndexedColl
 pointer to plan indexed collection to be splitted
 
bool _bCanBeSingle
 
ipUInt64 _sizeZ
 image size associated to operation
 
ipUInt64 _sizeC
 image size associated to operation
 
ipUInt64 _sizeT
 image size associated to operation
 

Detailed Description

template<typename TProcessor, typename InputStorageType, typename TAttribute>
class ipsdk::imaproc::PlanIndexedSplit< TProcessor, InputStorageType, TAttribute >

Concrete class for split operation using input plan indexed data.

Author
E. Noirfalise
Date
2015/06/19

Member Function Documentation

◆ init()

template<typename TProcessor , typename InputStorageType , typename TAttribute >
void ipsdk::imaproc::PlanIndexedSplit< TProcessor, InputStorageType, TAttribute >::init ( const InputStorageType &  pPlanIndexedColl,
const ipUInt64  sizeZ,
const ipUInt64  sizeC,
const ipUInt64  sizeT,
const bool  bCanBeSingle = false 
)
inline

initialization method for splitted objects

Exceptions
ipsdk::imaproc::IPSDKImageProcessingExceptionif pPlanIndexedColl.get() == 0
Note
if bCanBeSingle == true we also allow plan indexed with a single element in which case we apply this element for each splitted data

◆ processAttribute()

template<typename TProcessor , typename InputStorageType , typename TAttribute >
BoolResult ipsdk::imaproc::PlanIndexedSplit< TProcessor, InputStorageType, TAttribute >::processAttribute ( processor::BaseProcessor processor,
const ipUInt32  elementIdx,
const core::BaseRequestOrigin requestOrigin 
)
inlineprotectedvirtual

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

Returns
false in case of failure

Implements ipsdk::processor::BaseStaticSplit.


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