IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ipsdk::imaproc::itrans::MatchStatsImgLvl1 Class Reference

Level 1 algorithm: adjust image dynamic range from a reference using statistics matching. More...

#include <MatchStatsImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::itrans::MatchStatsImgLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >

Public Member Functions

 ~MatchStatsImgLvl1 ()
 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...
 
processor::RetrievalResult provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult statsMsr (const core::BasePriority &priority, core::ActionProviderPtr &pProvider, const ipsdk::image::ImageConstPtr &pInImg, ipsdk::imaproc::attr::StatsResultPtr &pStatsRes)
 
processor::RetrievalResult adjustDynamicMinMax (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult adjustDynamicMeanStdDev (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
Attribute accessors

Setters and Getters for attributes

template<>
const ipsdk::imaproc::attr::InImgget () const
 Getter for attribute InImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::InImg::StorageType &value)
 Setter for attribute InImg.
 
template<>
const ipsdk::imaproc::attr::InOptRefImgget () const
 Getter for attribute InOptRefImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptRefImg::StorageType &value)
 Setter for attribute InOptRefImg.
 
template<>
const ipsdk::imaproc::attr::InOptRefStatsIndicatorsget () const
 Getter for attribute InOptRefStatsIndicators.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptRefStatsIndicators::StorageType &value)
 Setter for attribute InOptRefStatsIndicators.
 
template<>
const ipsdk::imaproc::attr::InMatchStatsCriterionget () const
 Getter for attribute InMatchStatsCriterion.
 
template<>
void set (const typename ipsdk::imaproc::attr::InMatchStatsCriterion::StorageType &value)
 Setter for attribute InMatchStatsCriterion.
 
template<>
const ipsdk::imaproc::attr::OutImgget () const
 Getter for attribute OutImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutImg::StorageType &value)
 Setter for attribute OutImg.
 
- Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
virtual eProcessorType getProcessorType () const =0
 
BoolResult init (const eProcessorRulePolicy rulePolicy=eProcessorRulePolicy::ePRP_DisableSubRules)
 
const eProcessorRulePolicygetProcessorRulePolicy () const
 
std::string getFullInfoStr () const
 
const BaseRulegetGlobalRule () const
 
const ProcessorDispatchPolicygetDispatchPolicy () 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 BaseDataItemgetHeaderItem (const std::string &key) const
 
BaseDataItemgetHeaderItem (const std::string &key)
 
const BaseDataItemgetHeaderItem (const std::string &key) const
 
BaseDataItemgetHeaderItem (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 BaseAttributegetAttribute (ipUInt32 index) const
 
BaseAttributegetAttribute (ipUInt32 index)
 
const BaseAttributegetAttribute (const std::string &attributeName) const
 
BaseAttributegetAttribute (const std::string &attributeName)
 
const BaseAttributegetAttribute (ipUInt32 index) const
 
BaseAttributegetAttribute (ipUInt32 index)
 
const BaseAttributegetAttribute (const std::string &attributeName) const
 
BaseAttributegetAttribute (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 BaseOutputInitializergetOutputInitializer (const std::string &attributeName) const
 
const BaseOutputInitializergetOutputInitializer (const std::string &attributeName) const
 

Static Public Member Functions

static boost::shared_ptr< MatchStatsImgLvl1createProcessor ()
 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

 MatchStatsImgLvl1 ()
 constructor
 
ipsdk::processor::RetrievalResult retrieveProvider (const ipsdk::core::BasePriority &priority, ipsdk::ipUInt32 curNbIter, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve provider associated to asynchronous processing in derived class More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
virtual BoolResult initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0
 

Protected Attributes

attr::StatsResultConstPtr _pRefStats
 Intermediate results.
 
attr::StatsResultConstPtr _pInStats
 
attr::StatsResultPtr _pResStats
 
ipUInt32 _iterOffset
 Iteration offset due to conditions during the process.
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg_pInImg
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptRefImg_pInOptRefImg
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptRefStatsIndicators_pInOptRefStatsIndicators
 
boost::shared_ptr< ipsdk::imaproc::attr::InMatchStatsCriterion_pInMatchStatsCriterion
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

- Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
typedef std::vector< AttributePtrAttributeColl
 
typedef std::map< std::string, OutputInitializerPtrOutputInitializerColl
 

Detailed Description

Level 1 algorithm: adjust image dynamic range from a reference using statistics matching.

See Statistical Match for a complete algorithm description.

Author
H. Delestre
Date
2015/04/17

Algorithm associated library :

IPSDKIPLIntensityTransform

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InImg [Input] image for processing operation X
ipsdk::imaproc::attr::InOptRefImg [Input Optional] reference image X
ipsdk::imaproc::attr::InOptRefStatsIndicators [Input Optional] statistical indicators of reference X
ipsdk::imaproc::attr::InMatchStatsCriterion [Input] criterion used to adjust image dynamic X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation ipsdk::imaproc::duplicateInOut (_pOutImg, _pInImg)

Global attributes rule :

Global rule on attributes is given by
(ipsdk::imaproc::matchSize (_pInImg,_pOutImg) && 
 (ipsdk::processor::If (
   ipsdk::processor::isSet (_pInOptRefImg),
   (ipsdk::processor::Not (
     ipsdk::processor::isSet (_pInOptRefStatsIndicators))),
   (ipsdk::processor::isSet (_pInOptRefStatsIndicators)))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::itrans::MatchStatsImgLvl1::getStorage ( )

retrieve storage associated to a given attribute

Note
This method is only available for Output and In/Out attributes
Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ retrieveProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::itrans::MatchStatsImgLvl1::retrieveProvider ( const ipsdk::core::BasePriority priority,
ipsdk::ipUInt32  curNbIter,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

method allowing to retrieve provider associated to asynchronous processing in derived class

Returns
provider retrieval result.
Note
On success provider pointer must not be null nor uninitialized

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