Class encapsulating color geometryThis class allows to define geometry color size and type (grey, rgb, ...) More...

#include <ColorGeometry.h>

Inheritance diagram for ipsdk::image::ColorGeometry:

Public Member Functions
bool	isInit () const
	retrieve object initialisation flag

void	initGrey ()
	initialize object with grey level color geometry

void	initRgb ()
	initialize object with rgb color geometry

void	initUser (ipUInt64 sizeC)
	initialize object with user color geometry More...

void	init (const eColorGeometryType &colorGeometryType)
	initialize object with a color geometry for which size is known More...

const eColorGeometryType &	getColorGeometryType () const
	retrieve geometry color type More...

bool	isGreyLevel () const
	test whether object is associated to a grey level image More...

bool	isColor () const
	test whether object is associated to a color image More...

ipUInt64	getSizeC () const
	retrieve c size associated to object More...

std::string	getChannelName (const ipUInt64 channelIdx) const
	return the name of a given channel More...

const std::vector< std::string > &	getChannelNames () const
	return the name of all channels More...

void	setChannelName (const std::string &channelName, const ipUInt64 channelIdx)
	assign a name to a given channel More...

void	setChannelNames (const std::vector< std::string > &vChannelNames)
	assign a name to each channel More...

void	setMinIsBlack (const bool bMinIsBlack)
	Set the value of the flag _bMinIsBlack. More...

bool	minIsBlack () const
	Returns true if the minimum image value is assigned to black. More...

void	setColorGeometryType (const eColorGeometryType &vType)
	Setter of geometry type : More...

void	clear ()
	clear object data

Constructors and destructors
	ColorGeometry ()

	~ColorGeometry ()

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Protected Attributes
eColorGeometryType	_colorGeometryType
	color geometry type associated to object

ipUInt64	_sizeC
	c size associated to object

bool	_bInit
	object initialization flag

std::vector< std::string >	_vChannelNames
	Collection to store the names for each channel.

bool	_bMinIsBlack
	Flag indicating if the minimum intensity is represented by black color.

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

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

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Detailed Description

Class encapsulating color geometry

This class allows to define geometry color size and type (grey, rgb, ...)

Author: E. Noirfalise

Date: 2013/8/21

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ initUser()

void ipsdk::image::ColorGeometry::initUser ( ipUInt64 sizeC )

initialize object with user color geometry

Exceptions

ipsdk::image::IPSDKImageException if sizeC == 0

◆ init()

void ipsdk::image::ColorGeometry::init ( const eColorGeometryType & colorGeometryType )

initialize object with a color geometry for which size is known

Exceptions

ipsdk::image::IPSDKImageException if getColorGeometrySize(colorGeometryType) == 0

◆ getColorGeometryType()

const eColorGeometryType& ipsdk::image::ColorGeometry::getColorGeometryType ( ) const

retrieve geometry color type

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ isGreyLevel()

bool ipsdk::image::ColorGeometry::isGreyLevel ( ) const

test whether object is associated to a grey level image

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ isColor()

bool ipsdk::image::ColorGeometry::isColor ( ) const

test whether object is associated to a color image

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ getSizeC()

ipUInt64 ipsdk::image::ColorGeometry::getSizeC ( ) const

retrieve c size associated to object

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ getChannelName()

std::string ipsdk::image::ColorGeometry::getChannelName ( const ipUInt64 channelIdx ) const

return the name of a given channel

Exceptions

ipsdk::image::IPSDKImageException	if isInit() == false
ipsdk::image::IPSDKImageException	if channelIdx >= _vChannelNames.size()

◆ getChannelNames()

const std::vector<std::string>& ipsdk::image::ColorGeometry::getChannelNames ( ) const

return the name of all channels

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ setChannelName()

void ipsdk::image::ColorGeometry::setChannelName	(	const std::string &	channelName,
		const ipUInt64	channelIdx
	)

assign a name to a given channel

Exceptions

ipsdk::image::IPSDKImageException	if isInit() == false
ipsdk::image::IPSDKImageException	if channelIdx >= _vChannelNames.size()

◆ setChannelNames()

void ipsdk::image::ColorGeometry::setChannelNames ( const std::vector< std::string > & vChannelNames )

assign a name to each channel

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ setMinIsBlack()

void ipsdk::image::ColorGeometry::setMinIsBlack ( const bool bMinIsBlack )

Set the value of the flag _bMinIsBlack.

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ minIsBlack()

bool ipsdk::image::ColorGeometry::minIsBlack ( ) const

Returns true if the minimum image value is assigned to black.

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ setColorGeometryType()

void ipsdk::image::ColorGeometry::setColorGeometryType ( const eColorGeometryType & vType )

Setter of geometry type :

allow to switch from Color to Grey if sizeC == 1 or from Grey to Color regardless of sizeC
Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImage/Geometry/Component/ColorGeometry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ initUser()

◆ init()

◆ getColorGeometryType()

◆ isGreyLevel()

◆ isColor()

◆ getSizeC()

◆ getChannelName()

◆ getChannelNames()

◆ setChannelName()

◆ setChannelNames()

◆ setMinIsBlack()

◆ minIsBlack()

◆ setColorGeometryType()