ipsdk::imaproc::itrans::EqualizeLvl1 Class Reference

Level 1 algorithm: computation of LUT resulting from histogram equalization on input image. More...

#include <EqualizeLvl1.h>

Inheritance diagram for ipsdk::imaproc::itrans::EqualizeLvl1:

Public Member Functions
	~EqualizeLvl1 ()
	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 processor
const std::string	getLibraryName () const
	retrieve library name associated processor
template<typename TAttribute >
TAttribute::StorageType	getStorage ()
	retrieve storage associated to a given attribute More...
Attribute accessors
Setters and Getters for attributes
template<>
const ipsdk::imaproc::attr::InHistogram &	get () const
	Getter for attribute InHistogram.
template<>
void	set (const typename ipsdk::imaproc::attr::InHistogram::StorageType &value)
	Setter for attribute InHistogram.
template<>
const ipsdk::imaproc::attr::InOutputRange &	get () const
	Getter for attribute InOutputRange.
template<>
void	set (const typename ipsdk::imaproc::attr::InOutputRange::StorageType &value)
	Setter for attribute InOutputRange.
template<>
const ipsdk::imaproc::attr::OutIntensityLUT &	get () const
	Getter for attribute OutIntensityLUT.
template<>
void	set (const typename ipsdk::imaproc::attr::OutIntensityLUT::StorageType &value)
	Setter for attribute OutIntensityLUT.
Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
virtual eProcessorType	getProcessorType () const =0
BoolResult	init (const eProcessorRulePolicy rulePolicy=eProcessorRulePolicy::ePRP_DisableSubRules)
const eProcessorRulePolicy &	getProcessorRulePolicy () const
std::string	getFullInfoStr () const
const BaseRule &	getGlobalRule () const
const ProcessorDispatchPolicy &	getDispatchPolicy () const
void	restrictDispatchPolicy (const ProcessorDispatchPolicy &policy)
bool	isProgressAvailable () const
ipsdk::processor::eProcessorProgressAvailability	getProgressAvailability () const
ipsdk::ipUInt64	getTotalNbIterations () const
bool	existsHeaderKey (const std::string &key) const
bool	existsHeaderKey (const std::string &key) const
ItemNames	getHeaderKeys () const
ItemNames	getHeaderKeys () const
const BaseDataItem &	getHeaderItem (const std::string &key) const
BaseDataItem &	getHeaderItem (const std::string &key)
const BaseDataItem &	getHeaderItem (const std::string &key) const
BaseDataItem &	getHeaderItem (const std::string &key)
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
void	removeHeaderItem (const std::string &key)
void	removeHeaderItem (const std::string &key)
void	clearHeader ()
void	clearHeader ()
ipUInt32	getNbAttributes () const
ipUInt32	getNbAttributes () const
const BaseAttribute &	getAttribute (ipUInt32 index) const
BaseAttribute &	getAttribute (ipUInt32 index)
const BaseAttribute &	getAttribute (const std::string &attributeName) const
BaseAttribute &	getAttribute (const std::string &attributeName)
const BaseAttribute &	getAttribute (ipUInt32 index) const
BaseAttribute &	getAttribute (ipUInt32 index)
const BaseAttribute &	getAttribute (const std::string &attributeName) const
BaseAttribute &	getAttribute (const std::string &attributeName)
bool	existsAttribute (const std::string &attributeName) const
bool	existsAttribute (const std::string &attributeName) const
StringVector	getAttributeNameColl () const
StringVector	getAttributeNameColl () const
bool	hasOutputInitializer (const std::string &attributeName) const
bool	hasOutputInitializer (const std::string &attributeName) const
const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const
const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

Static Public Member Functions
static boost::shared_ptr< EqualizeLvl1 >	createProcessor ()
	processor 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 processor
static const std::string	getLibraryNameStr ()
	retrieve library name associated processor

Protected Member Functions
	EqualizeLvl1 ()
	constructor
ExecResult	mainProcess ()
	main processing method overloaded in derived class More...
Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0

Protected Attributes
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InHistogram >	_pInHistogram
boost::shared_ptr< ipsdk::imaproc::attr::InOutputRange >	_pInOutputRange
boost::shared_ptr< ipsdk::imaproc::attr::OutIntensityLUT >	_pOutIntensityLUT
Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
eProcessorProgressAvailability	_processorProgressAvailability
ipUInt32	_nbIter

Additional Inherited Members
Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
typedef std::vector< AttributePtr >	AttributeColl
typedef std::map< std::string, OutputInitializerPtr >	OutputInitializerColl

Detailed Description

Level 1 algorithm: computation of LUT resulting from histogram equalization on input image.

See Equalization LUT computation for a complete algorithm description.

Author

H. Delestre

Date

2014/07/22

Copyright

2014 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLIntensityTransform

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InHistogram	[Input] histogram properties	X
ipsdk::imaproc::attr::InOutputRange	[Input] output image intensity range for algorithm	X
ipsdk::imaproc::attr::OutIntensityLUT	[Output] intensity lookup table used by algorithm	ipsdk::processor::allocate (_pOutIntensityLUT)

Global attributes rule :

Global rule on attributes is given by
ipsdk::processor::none ()

Member Function Documentation

getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::itrans::EqualizeLvl1::getStorage

(

)

retrieve storage associated to a given attribute

Note

This method is only available for Output and In/Out attributes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

mainProcess()

ExecResult ipsdk::imaproc::itrans::EqualizeLvl1::mainProcess ( )

protected

main processing method overloaded in derived class

Returns

execution result

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLIntensityTransform/Processor/Equalize/EqualizeLvl1.h