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::ExtractGreySignedFeatures3dLvl2 Class Reference

Level 2 algorithm: algorithm allowing to extract 3d features associated to a grey signature from an image. More...

#include <ExtractGreySignedFeatures3dLvl2.h>

Inheritance diagram for ipsdk::imaproc::registration::ExtractGreySignedFeatures3dLvl2:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >

Public Member Functions

 ~ExtractGreySignedFeatures3dLvl2 ()
 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::InSubImg3dget () const
 Getter for attribute InSubImg3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSubImg3d::StorageType &value)
 Setter for attribute InSubImg3d.
 
template<>
const ipsdk::imaproc::attr::InSignatureScaleFactorget () const
 Getter for attribute InSignatureScaleFactor.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSignatureScaleFactor::StorageType &value)
 Setter for attribute InSignatureScaleFactor.
 
template<>
const ipsdk::imaproc::attr::InGradStdDevget () const
 Getter for attribute InGradStdDev.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGradStdDev::StorageType &value)
 Setter for attribute InGradStdDev.
 
template<>
const ipsdk::imaproc::attr::InGaussianCoverageget () const
 Getter for attribute InGaussianCoverage.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGaussianCoverage::StorageType &value)
 Setter for attribute InGaussianCoverage.
 
template<>
const ipsdk::imaproc::attr::InCornerDetectionParamsget () const
 Getter for attribute InCornerDetectionParams.
 
template<>
void set (const typename ipsdk::imaproc::attr::InCornerDetectionParams::StorageType &value)
 Setter for attribute InCornerDetectionParams.
 
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::InFeaturesDistXget () const
 Getter for attribute InFeaturesDistX.
 
template<>
void set (const typename ipsdk::imaproc::attr::InFeaturesDistX::StorageType &value)
 Setter for attribute InFeaturesDistX.
 
template<>
const ipsdk::imaproc::attr::InFeaturesDistYget () const
 Getter for attribute InFeaturesDistY.
 
template<>
void set (const typename ipsdk::imaproc::attr::InFeaturesDistY::StorageType &value)
 Setter for attribute InFeaturesDistY.
 
template<>
const ipsdk::imaproc::attr::InFeaturesDistZget () const
 Getter for attribute InFeaturesDistZ.
 
template<>
void set (const typename ipsdk::imaproc::attr::InFeaturesDistZ::StorageType &value)
 Setter for attribute InFeaturesDistZ.
 
template<>
const ipsdk::imaproc::attr::InInterpolationPolicyget () const
 Getter for attribute InInterpolationPolicy.
 
template<>
void set (const typename ipsdk::imaproc::attr::InInterpolationPolicy::StorageType &value)
 Setter for attribute InInterpolationPolicy.
 
template<>
const ipsdk::imaproc::attr::InSamplingBallInfoget () const
 Getter for attribute InSamplingBallInfo.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSamplingBallInfo::StorageType &value)
 Setter for attribute InSamplingBallInfo.
 
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::OutWk5Imgget () const
 Getter for attribute OutWk5Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk5Img::StorageType &value)
 Setter for attribute OutWk5Img.
 
template<>
const ipsdk::imaproc::attr::OutWk6Imgget () const
 Getter for attribute OutWk6Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk6Img::StorageType &value)
 Setter for attribute OutWk6Img.
 
template<>
const ipsdk::imaproc::attr::OutWk7Imgget () const
 Getter for attribute OutWk7Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk7Img::StorageType &value)
 Setter for attribute OutWk7Img.
 
template<>
const ipsdk::imaproc::attr::OutGreySignatures3dget () const
 Getter for attribute OutGreySignatures3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutGreySignatures3d::StorageType &value)
 Setter for attribute OutGreySignatures3d.
 
- 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< ExtractGreySignedFeatures3dLvl2createProcessor ()
 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

 ExtractGreySignedFeatures3dLvl2 ()
 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...
 
void clearIntermediateData ()
 method allowing to clear intermediate data for object
 
 IPSDK_DECLARE_DYNAMIC_RESULT_COLL (attr::InOutEigen3dDataColl, Eigen3dDataCollMap)
 dispatched collection of eigen decomposition data
 
- 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::Voxels3dPtr _pVoxels3d
 collection of voxels detected by harris detector
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InSubImg3d_pInSubImg3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InSignatureScaleFactor_pInSignatureScaleFactor
 
boost::shared_ptr< ipsdk::imaproc::attr::InGradStdDev_pInGradStdDev
 
boost::shared_ptr< ipsdk::imaproc::attr::InGaussianCoverage_pInGaussianCoverage
 
boost::shared_ptr< ipsdk::imaproc::attr::InCornerDetectionParams_pInCornerDetectionParams
 
boost::shared_ptr< ipsdk::imaproc::attr::InNbFeatures_pInNbFeatures
 
boost::shared_ptr< ipsdk::imaproc::attr::InFeaturesDistX_pInFeaturesDistX
 
boost::shared_ptr< ipsdk::imaproc::attr::InFeaturesDistY_pInFeaturesDistY
 
boost::shared_ptr< ipsdk::imaproc::attr::InFeaturesDistZ_pInFeaturesDistZ
 
boost::shared_ptr< ipsdk::imaproc::attr::InInterpolationPolicy_pInInterpolationPolicy
 
boost::shared_ptr< ipsdk::imaproc::attr::InSamplingBallInfo_pInSamplingBallInfo
 
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::OutWk5Img_pOutWk5Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk6Img_pOutWk6Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk7Img_pOutWk7Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutGreySignatures3d_pOutGreySignatures3d
 
- 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 2 algorithm: algorithm allowing to extract 3d features associated to a grey signature from an image.

See Extract grey signed features 3d for a complete algorithm description.

Author
E.Noirfalise
Date
2016/10/25

Algorithm associated library :

IPSDKIPLRegistration

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InSubImg3d [Input] grey level 3d single sub image for operation X
ipsdk::imaproc::attr::InSignatureScaleFactor [Input] image scale factor used during signature computation X
ipsdk::imaproc::attr::InGradStdDev [Input] standard deviation used for gradient computation X
ipsdk::imaproc::attr::InGaussianCoverage [Input] Parameter allowing to specify a gaussian distribution coverage for processing X
ipsdk::imaproc::attr::InCornerDetectionParams [Input] parameters used during corner detection process X
ipsdk::imaproc::attr::InNbFeatures [Input] target number of features to be detected by algorithm X
ipsdk::imaproc::attr::InFeaturesDistX [Input] distance between detected features along x axis (tchebychev distance) X
ipsdk::imaproc::attr::InFeaturesDistY [Input] distance between detected features along y axis (tchebychev distance) X
ipsdk::imaproc::attr::InFeaturesDistZ [Input] distance between detected features along z axis (tchebychev distance) X
ipsdk::imaproc::attr::InInterpolationPolicy [Input] interpolation policy used to extract local data from image X
ipsdk::imaproc::attr::InSamplingBallInfo [Input] Parameters for used sampling ball around image points 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::OutWk5Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk6Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk7Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutGreySignatures3d [Output] collection of features 3d grey signature used during processing X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pOutWk1Img,_pInSubImg3d) && 
ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk2Img,_pOutWk3Img)

Member Function Documentation

◆ getStorage()

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