IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Protected Member Functions | Protected Attributes | List of all members
ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType > Class Template Reference

Class allowing to initialize a plan indexed collection from plans of an image. More...

#include <FromImagePlanIndexedInitializer.h>

Inheritance diagram for ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType >:
ipsdk::imaproc::BaseFromImagePlanIndexedInitializer ipsdk::imaproc::BasePlanIndexedInitializer ipsdk::imaproc::BaseImageProcessingOutputInitializer ipsdk::processor::BaseOutputInitializer

Public Types

typedef OutputAttributeType::ValueType ValueType
 value type associated to attribute
 
typedef OutputAttributeType::StorageType StorageType
 storage type associated to attribute
 
typedef OutputAttributeType::PlanValueType PlanValueType
 plan value type associated to attribute
 
typedef OutputAttributeType::PlanStorageType PlanStorageType
 plan storage type associated to attribute
 
typedef boost::function< typename OutputAttributeType::PlanStorageType()> PlanCreator
 plan creator function
 

Public Member Functions

Constructors and destructors
 FromImagePlanIndexedInitializer ()
 
 ~FromImagePlanIndexedInitializer ()
 
void init (const PlanIndexedAttributeWeakPtr &pOutputAttribute, const ImageAttributeConstWeakPtr &pInputImageAttribute, const eFromImagePlanIndexedPolicy &fromImagePlanIndexedPolicy)
 initialize object More...
 
void init (const PlanIndexedAttributeWeakPtr &pOutputAttribute, const ImageAttributeConstWeakPtr &pInputImageAttribute, const eFromImagePlanIndexedPolicy &fromImagePlanIndexedPolicy, PlanCreator pPlanCreator)
 initialize object More...
 
- Public Member Functions inherited from ipsdk::imaproc::BaseFromImagePlanIndexedInitializer
ePlanIndexedInitializerType getPlanIndexedInitializerType () const
 retrieve plan indexed initializer type
 
const BaseImageAttributegetInputImageAttribute () const
 retrieve input image attribute associated to object More...
 
const eFromImagePlanIndexedPolicygetFromImagePlanIndexedPolicy () const
 retrieve policy used to initialize output attribute More...
 
 BaseFromImagePlanIndexedInitializer ()
 
virtual ~BaseFromImagePlanIndexedInitializer ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BasePlanIndexedInitializer
eImageProcessingInitializerType getImageProcessingInitializerType () const
 retrieve image processing initializer type
 
 BasePlanIndexedInitializer ()
 
virtual ~BasePlanIndexedInitializer ()=0
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingOutputInitializer
processor::eOutputInitializerType getOutputInitializerType () const
 retrieve initializer type
 
 BaseImageProcessingOutputInitializer ()
 
 ~BaseImageProcessingOutputInitializer ()
 
- Public Member Functions inherited from ipsdk::processor::BaseOutputInitializer
bool isInit () const
 retrieve object initialization flag
 
const BaseAttributegetOutputAttribute () const
 retrieve output attribute to be initialized More...
 
BoolResult initOutputAttribute ()
 initialize ouput attribute More...
 
std::string getInitializerFormalString () const
 retrieve string expliciting initializer content More...
 
std::string getInitializerEvaluatedString () const
 retrieve initializer evaluation string More...
 
 BaseOutputInitializer ()
 
virtual ~BaseOutputInitializer ()=0
 

Protected Member Functions

BoolResult initAttribute (BasePlanIndexedAttribute &baseAttributeOut, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT)
 initialize ouput attribute in derived class More...
 
- Protected Member Functions inherited from ipsdk::imaproc::BaseFromImagePlanIndexedInitializer
void initBase (const PlanIndexedAttributeWeakPtr &pOutputAttribute, const ImageAttributeConstWeakPtr &pInputImageAttribute, const eFromImagePlanIndexedPolicy &fromImagePlanIndexedPolicy)
 base class initialization method More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseOutputInitializer
void initBase (const AttributeWeakPtr &pOutputAttribute)
 base class initialization method More...
 
BaseAttributegetOutputAttribute ()
 retrieve output attribute to be initialized More...
 

Protected Attributes

PlanCreator _pPlanCreator
 function used to create new plan shared pointers
 

Additional Inherited Members

- Static Public Attributes inherited from ipsdk::imaproc::BaseFromImagePlanIndexedInitializer
static const ePlanIndexedInitializerType::domain g_planIndexedInitializerType = ePlanIndexedInitializerType::ePIIT_FromImage
 plan indexed output initializer type
 
- Static Public Attributes inherited from ipsdk::imaproc::BasePlanIndexedInitializer
static const eImageProcessingInitializerType::domain g_imageProcessingInitializerType = eImageProcessingInitializerType::eIPIT_PlanIndexed
 image processing output initializer type
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingOutputInitializer
static const processor::eOutputInitializerType::domain g_outputInitializerType = processor::eOutputInitializerType::eOIT_ImageProcessing
 output initializer type
 

Detailed Description

template<typename OutputAttributeType>
class ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType >

Class allowing to initialize a plan indexed collection from plans of an image.

Author
E. Noirfalise
Date
2015/06/22

Member Function Documentation

◆ init() [1/2]

template<typename OutputAttributeType >
void ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType >::init ( const PlanIndexedAttributeWeakPtr pOutputAttribute,
const ImageAttributeConstWeakPtr pInputImageAttribute,
const eFromImagePlanIndexedPolicy fromImagePlanIndexedPolicy 
)
inline

initialize object

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif pOutputAttribute.get() == 0
ipsdk::processor::IPSDKBaseProcessingExceptionif pOutputAttribute->getIOStatus() != eAttributeIO::eIOS_Output
ipsdk::processor::IPSDKBaseProcessingExceptionif pInputAttribute.get() == 0

◆ init() [2/2]

template<typename OutputAttributeType >
void ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType >::init ( const PlanIndexedAttributeWeakPtr pOutputAttribute,
const ImageAttributeConstWeakPtr pInputImageAttribute,
const eFromImagePlanIndexedPolicy fromImagePlanIndexedPolicy,
PlanCreator  pPlanCreator 
)
inline

initialize object

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif pOutputAttribute.get() == 0
ipsdk::processor::IPSDKBaseProcessingExceptionif pOutputAttribute->getIOStatus() != eAttributeIO::eIOS_Output
ipsdk::processor::IPSDKBaseProcessingExceptionif pInputAttribute.get() == 0

◆ initAttribute()

template<typename OutputAttributeType >
BoolResult ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType >::initAttribute ( BasePlanIndexedAttribute baseAttributeOut,
const ipUInt64  sizeZ,
const ipUInt64  sizeC,
const ipUInt64  sizeT 
)
inlineprotectedvirtual

initialize ouput attribute in derived class

Returns
false in case of failure

Implements ipsdk::imaproc::BaseFromImagePlanIndexedInitializer.


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