Base class for initialization of a plan indexed collection from plans of an image. More...

#include <BaseFromImagePlanIndexedInitializer.h>

Inheritance diagram for ipsdk::imaproc::BaseFromImagePlanIndexedInitializer:

Public Member Functions
ePlanIndexedInitializerType	getPlanIndexedInitializerType () const
	retrieve plan indexed initializer type

const BaseImageAttribute &	getInputImageAttribute () const
	retrieve input image attribute associated to object More...

const eFromImagePlanIndexedPolicy &	getFromImagePlanIndexedPolicy () const
	retrieve policy used to initialize output attribute More...

Constructors and destructors
	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 BaseAttribute &	getOutputAttribute () 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

Static Public Attributes
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

Protected Member Functions
void	initBase (const PlanIndexedAttributeWeakPtr &pOutputAttribute, const ImageAttributeConstWeakPtr &pInputImageAttribute, const eFromImagePlanIndexedPolicy &fromImagePlanIndexedPolicy)
	base class initialization method More...

virtual BoolResult	initAttribute (BasePlanIndexedAttribute &baseAttributeOut, const ipUInt64 sizeZ, const ipUInt64 sizeC, const ipUInt64 sizeT)=0
	initialize ouput attribute in derived class More...

Protected Member Functions inherited from ipsdk::processor::BaseOutputInitializer
void	initBase (const AttributeWeakPtr &pOutputAttribute)
	base class initialization method More...

BaseAttribute &	getOutputAttribute ()
	retrieve output attribute to be initialized More...

Detailed Description

Base class for initialization of a plan indexed collection from plans of an image.

Author: E. Noirfalise

Date: 2015/06/22

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getInputImageAttribute()

const BaseImageAttribute& ipsdk::imaproc::BaseFromImagePlanIndexedInitializer::getInputImageAttribute ( ) const

retrieve input image attribute associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getFromImagePlanIndexedPolicy()

const eFromImagePlanIndexedPolicy& ipsdk::imaproc::BaseFromImagePlanIndexedInitializer::getFromImagePlanIndexedPolicy ( ) const

retrieve policy used to initialize output attribute

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ initBase()

void ipsdk::imaproc::BaseFromImagePlanIndexedInitializer::initBase	(	const PlanIndexedAttributeWeakPtr &	pOutputAttribute,
		const ImageAttributeConstWeakPtr &	pInputImageAttribute,
		const eFromImagePlanIndexedPolicy &	fromImagePlanIndexedPolicy
	)

protected

base class initialization method

Exceptions

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

◆ initAttribute()

virtual BoolResult ipsdk::imaproc::BaseFromImagePlanIndexedInitializer::initAttribute	(	BasePlanIndexedAttribute &	baseAttributeOut,
		const ipUInt64	sizeZ,
		const ipUInt64	sizeC,
		const ipUInt64	sizeT
	)

protectedpure virtual

initialize ouput attribute in derived class

Returns: false in case of failure

Implemented in ipsdk::imaproc::FromImagePlanIndexedInitializer< OutputAttributeType >.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/OutputInitializer/PlanIndexed/BaseFromImagePlanIndexedInitializer.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ getInputImageAttribute()

◆ getFromImagePlanIndexedPolicy()

◆ initBase()

◆ initAttribute()