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::registration::GreySignedFeatures2dRegistrationImgLvl2 Class Reference

Level 2 algorithm: Apply to the first input image the transform estimated between the two input images using ExtractGreySignedFeatures2d. More...

#include <GreySignedFeatures2dRegistrationImgLvl2.h>

Inheritance diagram for ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationImgLvl2:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >

Public Member Functions

 ~GreySignedFeatures2dRegistrationImgLvl2 ()
 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::InSubImg2d1get () const
 Getter for attribute InSubImg2d1.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSubImg2d1::StorageType &value)
 Setter for attribute InSubImg2d1.
 
template<>
const ipsdk::imaproc::attr::InSubImg2d2get () const
 Getter for attribute InSubImg2d2.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSubImg2d2::StorageType &value)
 Setter for attribute InSubImg2d2.
 
template<>
const ipsdk::imaproc::attr::InNbFeaturesget () const
 Getter for attribute InNbFeatures.
 
template<>
void set (const typename ipsdk::imaproc::attr::InNbFeatures::StorageType &value)
 Setter for attribute InNbFeatures.
 
template<>
const ipsdk::imaproc::attr::InOptRegMotionModel2dget () const
 Getter for attribute InOptRegMotionModel2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptRegMotionModel2d::StorageType &value)
 Setter for attribute InOptRegMotionModel2d.
 
template<>
const ipsdk::imaproc::attr::InOptCorrelationThreshold2dget () const
 Getter for attribute InOptCorrelationThreshold2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptCorrelationThreshold2d::StorageType &value)
 Setter for attribute InOptCorrelationThreshold2d.
 
template<>
const ipsdk::imaproc::attr::InOptRegistrationEstimationConfigget () const
 Getter for attribute InOptRegistrationEstimationConfig.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptRegistrationEstimationConfig::StorageType &value)
 Setter for attribute InOptRegistrationEstimationConfig.
 
template<>
const ipsdk::imaproc::attr::InOptInterpolationPolicyget () const
 Getter for attribute InOptInterpolationPolicy.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptInterpolationPolicy::StorageType &value)
 Setter for attribute InOptInterpolationPolicy.
 
template<>
const ipsdk::imaproc::attr::OutWk1Imgget () const
 Getter for attribute OutWk1Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk1Img::StorageType &value)
 Setter for attribute OutWk1Img.
 
template<>
const ipsdk::imaproc::attr::OutWk2Imgget () const
 Getter for attribute OutWk2Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk2Img::StorageType &value)
 Setter for attribute OutWk2Img.
 
template<>
const ipsdk::imaproc::attr::OutWk3Imgget () const
 Getter for attribute OutWk3Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk3Img::StorageType &value)
 Setter for attribute OutWk3Img.
 
template<>
const ipsdk::imaproc::attr::OutWk4Imgget () const
 Getter for attribute OutWk4Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk4Img::StorageType &value)
 Setter for attribute OutWk4Img.
 
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.
 
template<>
const ipsdk::imaproc::attr::OutRegistrationMotionTransform2dget () const
 Getter for attribute OutRegistrationMotionTransform2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutRegistrationMotionTransform2d::StorageType &value)
 Setter for attribute OutRegistrationMotionTransform2d.
 
template<>
const ipsdk::imaproc::attr::OutOptMaskImgget () const
 Getter for attribute OutOptMaskImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutOptMaskImg::StorageType &value)
 Setter for attribute OutOptMaskImg.
 
- Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
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< GreySignedFeatures2dRegistrationImgLvl2createProcessor ()
 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

 GreySignedFeatures2dRegistrationImgLvl2 ()
 constructor
 
ipsdk::processor::RetrievalResult retrieveFirstProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve first provider associated to asynchronous processing in derived class More...
 
ipsdk::processor::RetrievalResult retrieveSecondProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve second provider associated to asynchronous processing in derived class More...
 
eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult retrieveThirdProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 
eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult retrieveFourthProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 
- Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
virtual BoolResult initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0
 

Protected Attributes

ipsdk::imaproc::attr::Features2dGreySignaturePtr _pSignature1
 
ipsdk::imaproc::attr::Features2dGreySignaturePtr _pSignature2
 
ipsdk::imaproc::attr::Features2dRegistrationResultPtr _pFeatures2dRegistrationResult
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InSubImg2d1_pInSubImg2d1
 
boost::shared_ptr< ipsdk::imaproc::attr::InSubImg2d2_pInSubImg2d2
 
boost::shared_ptr< ipsdk::imaproc::attr::InNbFeatures_pInNbFeatures
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptRegMotionModel2d_pInOptRegMotionModel2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptCorrelationThreshold2d_pInOptCorrelationThreshold2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptRegistrationEstimationConfig_pInOptRegistrationEstimationConfig
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptInterpolationPolicy_pInOptInterpolationPolicy
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk1Img_pOutWk1Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk2Img_pOutWk2Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk3Img_pOutWk3Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk4Img_pOutWk4Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
boost::shared_ptr< ipsdk::imaproc::attr::OutRegistrationMotionTransform2d_pOutRegistrationMotionTransform2d
 
boost::shared_ptr< ipsdk::imaproc::attr::OutOptMaskImg_pOutOptMaskImg
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

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

Detailed Description

Level 2 algorithm: Apply to the first input image the transform estimated between the two input images using ExtractGreySignedFeatures2d.

See Image registration using 2D grey signed features for a complete algorithm description.

Author
R. Abbal
Date
2024/09/10

Algorithm associated library :

IPSDKIPLRegistration

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InSubImg2d1 [Input] First grey level 2d sub image for operation X
ipsdk::imaproc::attr::InSubImg2d2 [Input] Second grey level 2d image for operation X
ipsdk::imaproc::attr::InNbFeatures [Input] target number of features to be detected by algorithm X
ipsdk::imaproc::attr::InOptRegMotionModel2d [Input Optional] 2d motion model which should be used for computation X
ipsdk::imaproc::attr::InOptCorrelationThreshold2d [Input Optional] threshold on 2d correlation scores used during pairs matching X
ipsdk::imaproc::attr::InOptRegistrationEstimationConfig [Input Optional] configuration for robust estimation part of features registration X
ipsdk::imaproc::attr::InOptInterpolationPolicy [Input Optional] interpolation policy used to extract local data from image X
ipsdk::imaproc::attr::OutWk1Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk2Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk3Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk4Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation X
ipsdk::imaproc::attr::OutRegistrationMotionTransform2d [Output] transformation associated to a 2d motion X
ipsdk::imaproc::attr::OutOptMaskImg [Output Optional] mask image for processing operation X

Global attributes rule :

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

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationImgLvl2::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

◆ retrieveFirstProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationImgLvl2::retrieveFirstProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

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

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

◆ retrieveSecondProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationImgLvl2::retrieveSecondProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

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

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

◆ retrieveThirdProvider()

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationImgLvl2::retrieveThirdProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

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

◆ retrieveFourthProvider()

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationImgLvl2::retrieveFourthProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

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


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