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::gtrans::Zoom3dImgLvl1 Class Reference

Level 1 algorithm for image 3d zoom algorithm. More...

#include <Zoom3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::gtrans::Zoom3dImgLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >

Public Member Functions

 ~Zoom3dImgLvl1 ()
 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::InZoomInterpolationMethodget () const
 Getter for attribute InZoomInterpolationMethod.
 
template<>
void set (const typename ipsdk::imaproc::attr::InZoomInterpolationMethod::StorageType &value)
 Setter for attribute InZoomInterpolationMethod.
 
template<>
const ipsdk::imaproc::attr::InOptOutputImg3dSizeget () const
 Getter for attribute InOptOutputImg3dSize.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptOutputImg3dSize::StorageType &value)
 Setter for attribute InOptOutputImg3dSize.
 
template<>
const ipsdk::imaproc::attr::InOptScaleFactor3dget () const
 Getter for attribute InOptScaleFactor3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptScaleFactor3d::StorageType &value)
 Setter for attribute InOptScaleFactor3d.
 
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::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< Zoom3dImgLvl1createProcessor ()
 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

 Zoom3dImgLvl1 ()
 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...
 
core::ExecResult postProcess ()
 method called after processing 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

ipReal64 _xScaleFactor
 
ipReal64 _yScaleFactor
 
ipReal64 _zScaleFactor
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg3d_pInImg3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InZoomInterpolationMethod_pInZoomInterpolationMethod
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptOutputImg3dSize_pInOptOutputImg3dSize
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptScaleFactor3d_pInOptScaleFactor3d
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
- 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 for image 3d zoom algorithm.

See 3d zoom for a complete algorithm description.

Author
H. Delestre
Date
2016/06/07

Algorithm associated library :

IPSDKIPLGeometricTransform

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InImg3d [Input] 3d image for operation X
ipsdk::imaproc::attr::InZoomInterpolationMethod [Input] interpolation method for image zoom algorithms X
ipsdk::imaproc::attr::InOptOutputImg3dSize [Input Optional] expected output image 7d size X
ipsdk::imaproc::attr::InOptScaleFactor3d [Input Optional] 3d scale factor X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation customOutput (_pOutImg, outputZoom3d(_pInImg3d,_pInOptScaleFactor3d,_pInOptOutputImg3dSize))

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::noInSitu (_pInImg3d,_pOutImg) && 
ipsdk::processor::If (
 ipsdk::processor::isSet (_pInOptOutputImg3dSize),
 ipsdk::processor::Not (
  ipsdk::processor::isSet (_pInOptScaleFactor3d)),
 ipsdk::processor::isSet (_pInOptScaleFactor3d)) && 
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_CT,_pInImg3d,_pOutImg) && 
ipsdk::imaproc::customImageProperty (_pOutImg,
 matchZoom3d (_pInImg3d,_pInOptScaleFactor3d,_pInOptOutputImg3dSize))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::gtrans::Zoom3dImgLvl1::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::gtrans::Zoom3dImgLvl1::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

◆ postProcess()

core::ExecResult ipsdk::imaproc::gtrans::Zoom3dImgLvl1::postProcess ( )
protected

method called after processing

Returns
execution result

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