IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType > Class Template Reference

Class allowing to initialize an output image from two other images deducing output image buffer type from input image buffer types and a promote binary operation type. More...

#include <PromoteBinaryImageInitializer.h>

Inheritance diagram for ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >:
ipsdk::imaproc::BaseImageBinaryInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType > ipsdk::imaproc::BaseImageInitializer ipsdk::imaproc::BaseImageProcessingOutputInitializer ipsdk::processor::BaseOutputInitializer

Public Member Functions

eImageInitializerType getImageInitializerType () const
 retrieve image initializer type
 
void init (const boost::weak_ptr< OutputAttributeType > &pOutputAttribute, const boost::weak_ptr< const InputAttributeType1 > &pInputAttribute1, const boost::weak_ptr< const InputAttributeType2 > &pInputAttribute2, const ePromoteBinaryType &promoteBinaryType, const bool bAllowReInterpretation=false)
 initialize object More...
 
const ePromoteBinaryTypegetPromoteBinaryType () const
 retrieve custom promote type used for output attribute initialization More...
 
BoolResult initAttribute ()
 initialize ouput attribute More...
 
std::string createInitializerFormalString () const
 retrieve string expliciting initializer content
 
std::string createInitializerEvaluatedString () const
 retrieve initializer evaluation string
 
Constructors and destructors
 PromoteBinaryImageInitializer ()
 
 ~PromoteBinaryImageInitializer ()
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageBinaryInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >
 BaseImageBinaryInitializer ()
 
virtual ~BaseImageBinaryInitializer ()=0
 
const InputAttributeType1 & getInputImageAttribute1 () const
 retrieve input image attributes associated to object More...
 
const InputAttributeType2 & getInputImageAttribute2 () const
 retrieve input image attributes associated to object More...
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageInitializer
eImageProcessingInitializerType getImageProcessingInitializerType () const
 retrieve image processing initializer type
 
 BaseImageInitializer ()
 
virtual ~BaseImageInitializer ()=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
 

Static Public Attributes

static const eImageInitializerType::domain g_imageInitializerType = eImageInitializerType::eIIT_PromoteBinary
 image output initializer type
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImageInitializer
static const eImageProcessingInitializerType::domain g_imageProcessingInitializerType = eImageProcessingInitializerType::eIPIT_Image
 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 Attributes

ePromoteBinaryType _promoteBinaryType
 promote type used for output attribute initialization
 
bool _bAllowReInterpretation
 

Additional Inherited Members

- Protected Member Functions inherited from ipsdk::imaproc::BaseImageBinaryInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >
void initBase (const boost::weak_ptr< OutputAttributeType > &pOutputAttribute, const boost::weak_ptr< const InputAttributeType1 > &pInputAttribute1, const boost::weak_ptr< const InputAttributeType2 > &pInputAttribute2)
 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...
 

Detailed Description

template<typename InputAttributeType1, typename InputAttributeType2, typename OutputAttributeType>
class ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >

Class allowing to initialize an output image from two other images deducing output image buffer type from input image buffer types and a promote binary operation type.

Author
E. Noirfalise
Date
2014/06/23

Member Function Documentation

◆ init()

template<typename InputAttributeType1 , typename InputAttributeType2 , typename OutputAttributeType >
void ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >::init ( const boost::weak_ptr< OutputAttributeType > &  pOutputAttribute,
const boost::weak_ptr< const InputAttributeType1 > &  pInputAttribute1,
const boost::weak_ptr< const InputAttributeType2 > &  pInputAttribute2,
const ePromoteBinaryType promoteBinaryType,
const bool  bAllowReInterpretation = false 
)

initialize object

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

◆ getPromoteBinaryType()

template<typename InputAttributeType1 , typename InputAttributeType2 , typename OutputAttributeType >
const ePromoteBinaryType& ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >::getPromoteBinaryType ( ) const

retrieve custom promote type used for output attribute initialization

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ initAttribute()

template<typename InputAttributeType1 , typename InputAttributeType2 , typename OutputAttributeType >
BoolResult ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >::initAttribute ( )
virtual

initialize ouput attribute

Returns
false in case of failure

Implements ipsdk::processor::BaseOutputInitializer.

Member Data Documentation

◆ _bAllowReInterpretation

template<typename InputAttributeType1 , typename InputAttributeType2 , typename OutputAttributeType >
bool ipsdk::imaproc::PromoteBinaryImageInitializer< InputAttributeType1, InputAttributeType2, OutputAttributeType >::_bAllowReInterpretation
protected

flag indicating whether image data reinterpretation is allowed. This means that we will take the greatest data size between images


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