[Input Optional] Black image, usually obtained by closing all optical ports of the camera, or by turning off all the light sources. Used by shading correction algorithm More...

#include <InOptBlackImg.h>

Inheritance diagram for ipsdk::imaproc::attr::InOptBlackImg:

Public Member Functions
	~InOptBlackImg ()
	destructor

const std::string &	getObjectName () const
	method allowing to retrieve object name

const std::string &	getToolTip () const
	method allowing to retrieve object tooltip

const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to attribute

const std::string	getLibraryName () const
	retrieve library name associated attribute

Public Member Functions inherited from ipsdk::imaproc::BaseInputImageAttribute
void	init (const image::ImageConstPtr &pImage)

StorageType	getStorage () const

Public Member Functions inherited from ipsdk::imaproc::BaseImageAttribute
eImageProcessingAttributeType	getImageProcessingAttributeType () const

const image::eImageBufferType &	getImageBufferType () const

const image::BaseImage &	getImage () const

image::ImageConstPtr	getImagePtr () const

Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingAttribute
processor::eAttributeType	getAttributeType () const

Public Member Functions inherited from ipsdk::processor::BaseAttribute
bool	isInit () const

const BaseRule &	getRule () const

BoolResult	isValid () const

void	clear ()

bool	isOutOptionalInitForced () const

void	setOutOptionalInitForced (bool bOutOptionalInitForced) const

bool	isOutOptionalInitForced () const

void	setOutOptionalInitForced (bool bOutOptionalInitForced) const

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const

void	setSerializationMode (const eSklSrzMode &sklSrzMode) const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Public Member Functions inherited from ipsdk::BaseIOData
virtual eIOStatus	getIOStatus () const=0

virtual bool	isInput () const=0

virtual bool	isOutput () const=0

virtual bool	isInOut () const=0

Public Member Functions inherited from ipsdk::BaseOptData
virtual eOptStatus	getOptStatus () const=0

virtual bool	isMandatory () const=0

virtual bool	isOptional () const=0

Static Public Member Functions
static boost::shared_ptr< InOptBlackImg >	createAttribute ()
	attribute creation function

static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name

static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to attribute

static const std::string	getLibraryNameStr ()
	retrieve library name associated attribute

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Protected Member Functions
	InOptBlackImg ()
	constructor

Protected Member Functions inherited from ipsdk::imaproc::BaseImageAttribute
void	initBase (const image::ImagePtr &pImage)

image::BaseImage &	accessImage ()

void	clearDerived ()

image::ImageConstPtr	accessImagePtr () const

image::ImagePtr	accessImagePtr ()

image::ImageConstPtr	accessImagePtr () const

image::ImagePtr	accessImagePtr ()

Protected Member Functions inherited from ipsdk::processor::BaseAttribute
void	initBase ()

virtual BoolResult	syncInputDerived (const Guid &processingSocketGuid)

virtual BoolResult	syncOutputDerived (const Guid &processingSocketGuid)

virtual RulePtr	createRule (const AttributePtr &pBaseThis) const=0

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)

Additional Inherited Members
Public Types inherited from ipsdk::imaproc::BaseInputImageAttribute
typedef image::BaseImage	ValueType

typedef image::ImageConstPtr	StorageType

typedef BaseInputImageAttribute	BaseImageAttributeType

Static Public Attributes inherited from ipsdk::imaproc::BaseImageAttribute
static const eImageProcessingAttributeType::domain	g_imageProcessingAttributeType

Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingAttribute
static const processor::eAttributeType::domain	g_attributeType

Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode

Detailed Description

[Input Optional] Black image, usually obtained by closing all optical ports of the camera, or by turning off all the light sources. Used by shading correction algorithm

Author: H. Delestre

Date: 2014/10/30

Copyright: 2014 Reactiv'IP, all right reserved.

Attribute associated library :

IPSDKIPLAttributes

Attribute rule :

Rule on attribute is given by
ipsdk::processor::none ()

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/Attribute/Image/Input/Optional/InOptBlackImg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Attribute associated library :

Attribute rule :