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::filter::LaplacianDoG2dImgLvl1 Class Reference

Level 1 algorithm: laplacian algorithm of input 2d image using a difference of gaussian approximation. More...

#include <LaplacianDoG2dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::LaplacianDoG2dImgLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >

Public Member Functions

 ~LaplacianDoG2dImgLvl1 ()
 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::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::InStdDevget () const
 Getter for attribute InStdDev.
 
template<>
void set (const typename ipsdk::imaproc::attr::InStdDev::StorageType &value)
 Setter for attribute InStdDev.
 
template<>
const ipsdk::imaproc::attr::InOptStdDevFactorget () const
 Getter for attribute InOptStdDevFactor.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptStdDevFactor::StorageType &value)
 Setter for attribute InOptStdDevFactor.
 
template<>
const ipsdk::imaproc::attr::InOptSmoothingGaussianCoverageget () const
 Getter for attribute InOptSmoothingGaussianCoverage.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptSmoothingGaussianCoverage::StorageType &value)
 Setter for attribute InOptSmoothingGaussianCoverage.
 
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::OutWk1Imgget () const
 Getter for attribute OutWk1Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk1Img::StorageType &value)
 Setter for attribute OutWk1Img.
 
- 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< LaplacianDoG2dImgLvl1createProcessor ()
 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

 LaplacianDoG2dImgLvl1 ()
 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...
 
ipsdk::core::ExecResult preProcess ()
 method called before processing More...
 
processor::RetrievalResult provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult convolution (const core::BasePriority &priority, core::ActionProviderPtr &pProvider, const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::KernelXYPtr &pKernel, ipsdk::image::ImagePtr &pOutImg)
 
processor::RetrievalResult subtract (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
- 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

ipReal32 _excitatoryStdDev
 Standard deviations used for laplacian computation.
 
ipReal32 _inhibitoryStdDev
 
KernelXYPtr _pXAxisExcitatoryKernel
 Kernels for separable Gaussian smoothing.
 
KernelXYPtr _pYAxisExcitatoryKernel
 
KernelXYPtr _pXAxisInhibitoryKernel
 
KernelXYPtr _pYAxisInhibitoryKernel
 
ipsdk::image::Border2dPolicyPtr _pBorder2dPolicy
 Border Policy.
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg_pInImg
 
boost::shared_ptr< ipsdk::imaproc::attr::InStdDev_pInStdDev
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptStdDevFactor_pInOptStdDevFactor
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptSmoothingGaussianCoverage_pInOptSmoothingGaussianCoverage
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk1Img_pOutWk1Img
 
- 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: laplacian algorithm of input 2d image using a difference of gaussian approximation.

See Laplacian DoG 2d for a complete algorithm description.

Author
E.Noirfalise
Date
2014/12/17

Support GPU

Algorithm associated library :

IPSDKIPLFiltering

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InImg [Input] image for processing operation X
ipsdk::imaproc::attr::InStdDev [Input] standard deviation used for operation along all axis X
ipsdk::imaproc::attr::InOptStdDevFactor [Input Optional] factor applied on standard deviation for laplacian difference of gaussian computation X
ipsdk::imaproc::attr::InOptSmoothingGaussianCoverage [Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation ipsdk::imaproc::promoteUnary (_pOutImg, _pInImg, ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk1Img [Output] Temporary working image for algorithm ipsdk::imaproc::duplicateInOut (_pOutWk1Img, _pInImg)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInImg,_pOutImg) && 
ipsdk::imaproc::matchSizeAndType (_pInImg,_pOutWk1Img) && 
ipsdk::imaproc::noInSitu (_pInImg,_pOutWk1Img) && 
ipsdk::imaproc::noInSitu (_pOutImg,_pOutWk1Img)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::filter::LaplacianDoG2dImgLvl1::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::filter::LaplacianDoG2dImgLvl1::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

◆ preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::filter::LaplacianDoG2dImgLvl1::preProcess ( )
protected

method called before processing

Returns
execution result

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