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

Level 1 algorithm: Extracts the corners in a 3d image. More...

#include <HarrisCorner3dLvl1.h>

Inheritance diagram for ipsdk::imaproc::fd::HarrisCorner3dLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >

Public Member Functions

 ~HarrisCorner3dLvl1 ()
 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::InImg3dget () const
 Getter for attribute InImg3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InImg3d::StorageType &value)
 Setter for attribute InImg3d.
 
template<>
const ipsdk::imaproc::attr::InOptGradStdDevget () const
 Getter for attribute InOptGradStdDev.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptGradStdDev::StorageType &value)
 Setter for attribute InOptGradStdDev.
 
template<>
const ipsdk::imaproc::attr::InOptGradientGaussianCoverageget () const
 Getter for attribute InOptGradientGaussianCoverage.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptGradientGaussianCoverage::StorageType &value)
 Setter for attribute InOptGradientGaussianCoverage.
 
template<>
const ipsdk::imaproc::attr::InOptCornerDetectionParams3dget () const
 Getter for attribute InOptCornerDetectionParams3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptCornerDetectionParams3d::StorageType &value)
 Setter for attribute InOptCornerDetectionParams3d.
 
template<>
const ipsdk::imaproc::attr::InLocalExtremaConfigget () const
 Getter for attribute InLocalExtremaConfig.
 
template<>
void set (const typename ipsdk::imaproc::attr::InLocalExtremaConfig::StorageType &value)
 Setter for attribute InLocalExtremaConfig.
 
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::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::OutPIVoxels3dget () const
 Getter for attribute OutPIVoxels3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutPIVoxels3d::StorageType &value)
 Setter for attribute OutPIVoxels3d.
 
- Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
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< HarrisCorner3dLvl1createProcessor ()
 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

 HarrisCorner3dLvl1 ()
 constructor
 
ipsdk::processor::RetrievalResult retrieveProvider (const ipsdk::core::BasePriority &priority, 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::BaseAsync1Action >
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::InImg3d_pInImg3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptGradStdDev_pInOptGradStdDev
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptGradientGaussianCoverage_pInOptGradientGaussianCoverage
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptCornerDetectionParams3d_pInOptCornerDetectionParams3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InLocalExtremaConfig_pInLocalExtremaConfig
 
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::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::OutPIVoxels3d_pOutPIVoxels3d
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

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

Detailed Description

Level 1 algorithm: Extracts the corners in a 3d image.

See Harris corner detection 3d for a complete algorithm description.

Author
R. Abbal
Date
2016/08/02

Algorithm associated library :

IPSDKIPLFeatureDetection

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InImg3d [Input] 3d image for operation X
ipsdk::imaproc::attr::InOptGradStdDev [Input Optional] standard deviation used for gradient computation X
ipsdk::imaproc::attr::InOptGradientGaussianCoverage [Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing X
ipsdk::imaproc::attr::InOptCornerDetectionParams3d [Input Optional] parameters used during corner detection process X
ipsdk::imaproc::attr::InLocalExtremaConfig [Input] Attribute for local extrema calculation configuration 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::OutWk1Img [Output] Temporary working image for algorithm promoteUnary (_pOutWk1Img, _pInImg3d, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk2Img [Output] Temporary working image for algorithm promoteUnary (_pOutWk2Img, _pInImg3d, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk3Img [Output] Temporary working image for algorithm promoteUnary (_pOutWk3Img, _pInImg3d, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk4Img [Output] Temporary working image for algorithm promoteUnary (_pOutWk4Img, _pInImg3d, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk5Img [Output] Temporary working image for algorithm promoteUnary (_pOutWk5Img, _pInImg3d, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk6Img [Output] Temporary working image for algorithm promoteUnary (_pOutWk6Img, _pInImg3d, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutPIVoxels3d [Output] plan indexed collection of positions and intensities of 3d voxels ipsdk::imaproc::fromImageButVolume (_pOutPIVoxels3d, _pInImg3d)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchImagePlans (_pOutPIVoxels3d,_pInImg3d,eImagePlansMatchPolicy::eIPMP_CT) && 
ipsdk::imaproc::matchSize (_pInImg3d,_pOutWk1Img) && 
ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk2Img,_pOutWk3Img,_pOutWk4Img,_pOutWk5Img,_pOutWk6Img)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::fd::HarrisCorner3dLvl1::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::fd::HarrisCorner3dLvl1::retrieveProvider ( const ipsdk::core::BasePriority priority,
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: