SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::StochasticFractalDimensionImageFilter Class Reference

This filter computes the stochastic fractal dimension of the input image. More...

#include <sitkStochasticFractalDimensionImageFilter.h>

+ Inheritance diagram for itk::simple::StochasticFractalDimensionImageFilter:
+ Collaboration diagram for itk::simple::StochasticFractalDimensionImageFilter:

Detailed Description

This filter computes the stochastic fractal dimension of the input image.

The methodology is based on Mandelbrot's fractal theory and the concept of fractional Brownian motion and yields images which have been used for classification and edge enhancement.

This class which is templated over the input and output images as well as a mask image type. The input is a scalar image, an optional neighborhood radius (default = 2), and an optional mask. The mask can be specified to decrease computation time since, as the authors point out, calculation is time-consuming.

This filter was contributed by Nick Tustison and James Gee from the PICSL lab, at the University of Pennsylvania as an paper to the Insight Journal:

"Stochastic Fractal Dimension Image" https://doi.org/10.54294/ne109t

Author
Nick Tustison
See also
itk::simple::StochasticFractalDimension for the procedural interface
itk::StochasticFractalDimensionImageFilter for the Doxygen on the original ITK class.

Definition at line 49 of file sitkStochasticFractalDimensionImageFilter.h.

Public Types

using PixelIDTypeList = RealPixelIDTypeList
 
using Self = StochasticFractalDimensionImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image)
 
Image Execute (const Image &image, const Image &maskImage)
 
std::string GetName () const
 
std::vector< unsigned int > GetNeighborhoodRadius () const
 
SelfSetNeighborhoodRadius (std::vector< unsigned int > NeighborhoodRadius)
 
SelfSetNeighborhoodRadius (unsigned int value)
 
 StochasticFractalDimensionImageFilter ()
 
std::string ToString () const
 
virtual ~StochasticFractalDimensionImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image *image, const Image *maskImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *maskImage)
 

Private Attributes

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_NeighborhoodRadius {std::vector<unsigned int>(3, 2u)}
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::StochasticFractalDimensionImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage )
private

Setup for member function dispatching

Definition at line 93 of file sitkStochasticFractalDimensionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkStochasticFractalDimensionImageFilter.h.

◆ Self

Definition at line 51 of file sitkStochasticFractalDimensionImageFilter.h.

Constructor & Destructor Documentation

◆ ~StochasticFractalDimensionImageFilter()

virtual itk::simple::StochasticFractalDimensionImageFilter::~StochasticFractalDimensionImageFilter ( )
virtual

Destructor

◆ StochasticFractalDimensionImageFilter()

itk::simple::StochasticFractalDimensionImageFilter::StochasticFractalDimensionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::StochasticFractalDimensionImageFilter::Execute ( const Image image)

◆ Execute() [2/2]

Image itk::simple::StochasticFractalDimensionImageFilter::Execute ( const Image image,
const Image maskImage 
)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::StochasticFractalDimensionImageFilter::ExecuteInternal ( const Image image,
const Image maskImage 
)
private

◆ GetName()

std::string itk::simple::StochasticFractalDimensionImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 78 of file sitkStochasticFractalDimensionImageFilter.h.

◆ GetNeighborhoodRadius()

std::vector<unsigned int> itk::simple::StochasticFractalDimensionImageFilter::GetNeighborhoodRadius ( ) const
inline

Manhattan radius used for evaluating the fractal dimension.

Definition at line 75 of file sitkStochasticFractalDimensionImageFilter.h.

◆ SetNeighborhoodRadius() [1/2]

Self& itk::simple::StochasticFractalDimensionImageFilter::SetNeighborhoodRadius ( std::vector< unsigned int >  NeighborhoodRadius)
inline

Manhattan radius used for evaluating the fractal dimension.

Definition at line 67 of file sitkStochasticFractalDimensionImageFilter.h.

◆ SetNeighborhoodRadius() [2/2]

Self& itk::simple::StochasticFractalDimensionImageFilter::SetNeighborhoodRadius ( unsigned int  value)
inline

Set the values of the NeighborhoodRadius vector all to value

Definition at line 70 of file sitkStochasticFractalDimensionImageFilter.h.

◆ ToString()

std::string itk::simple::StochasticFractalDimensionImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 97 of file sitkStochasticFractalDimensionImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::StochasticFractalDimensionImageFilter::m_MemberFactory
private

Definition at line 99 of file sitkStochasticFractalDimensionImageFilter.h.

◆ m_NeighborhoodRadius

std::vector<unsigned int> itk::simple::StochasticFractalDimensionImageFilter::m_NeighborhoodRadius {std::vector<unsigned int>(3, 2u)}
private

Definition at line 102 of file sitkStochasticFractalDimensionImageFilter.h.


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