ITK  5.4.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkHessianToObjectnessMeasureImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >

A filter to enhance M-dimensional objects in N-dimensional images.

The objectness measure is a generalization of Frangi's vesselness measure, which is based on the analysis of the Hessian eigen system. The filter can enhance blob-like structures (M=0), vessel-like structures (M=1), 2D plate-like structures (M=2), hyper-plate-like structures (M=3) in N-dimensional images, with M<N. The filter takes an image of a Hessian pixels ( SymmetricSecondRankTensor pixels pixels ) and produces an enhanced image. The Hessian input image can be produced using itk::HessianRecursiveGaussianImageFilter.

References
Frangi, AF, Niessen, WJ, Vincken, KL, & Viergever, MA (1998). Multiscale Vessel Enhancement Filtering. In Wells, WM, Colchester, A, & Delp, S, Editors, MICCAI '98 Medical Image Computing and Computer-Assisted Intervention, Lecture Notes in Computer Science, pages 130-137, Springer Verlag, 1998.

Additional information can be from in the Insight Journal: https://www.insight-journal.org/browse/publication/175

Author
Luca Antiga Ph.D. Medical Imaging Unit, Bioengineering Department, Mario Negri Institute, Italy.
See also
MultiScaleHessianBasedMeasureImageFilter
Hessian3DToVesselnessMeasureImageFilter
HessianRecursiveGaussianImageFilter
SymmetricEigenAnalysisImageFilter
SymmetricSecondRankTensor
Examples
SphinxExamples/src/Nonunit/Review/SegmentBloodVesselsWithMultiScaleHessianBasedMeasure/Code.cxx.

Definition at line 61 of file itkHessianToObjectnessMeasureImageFilter.h.

+ Inheritance diagram for itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >:

Classes

struct  AbsLessCompare
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using EigenValueArrayType = itk::FixedArray< EigenValueType, Self::ImageDimension >
 
using EigenValueType = double
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputPixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = HessianToObjectnessMeasureImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual void SetAlpha (double _arg)
 
virtual double GetAlpha () const
 
virtual void SetBeta (double _arg)
 
virtual double GetBeta () const
 
virtual void SetGamma (double _arg)
 
virtual double GetGamma () const
 
virtual void SetScaleObjectnessMeasure (bool _arg)
 
virtual bool GetScaleObjectnessMeasure () const
 
virtual void ScaleObjectnessMeasureOn ()
 
virtual void SetObjectDimension (unsigned int _arg)
 
virtual unsigned int GetObjectDimension () const
 
virtual void SetBrightObject (bool _arg)
 
virtual bool GetBrightObject () const
 
virtual void BrightObjectOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
 HessianToObjectnessMeasureImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyPreconditions () ITKv5_CONST override
 
 ~HessianToObjectnessMeasureImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

double m_Alpha { 0.5 }
 
double m_Beta { 0.5 }
 
bool m_BrightObject { true }
 
double m_Gamma { 5.0 }
 
unsigned int m_ObjectDimension { 1 }
 
bool m_ScaleObjectnessMeasure { true }
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading {}
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 70 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ EigenValueArrayType

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::EigenValueArrayType = itk::FixedArray<EigenValueType, Self::ImageDimension>

Definition at line 82 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ EigenValueType

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::EigenValueType = double

Definition at line 81 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Definition at line 74 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 76 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 75 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 69 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::Self = HessianToObjectnessMeasureImageFilter

Standard class type aliases.

Definition at line 67 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 68 of file itkHessianToObjectnessMeasureImageFilter.h.

Constructor & Destructor Documentation

◆ HessianToObjectnessMeasureImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::HessianToObjectnessMeasureImageFilter ( )
protected

◆ ~HessianToObjectnessMeasureImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::~HessianToObjectnessMeasureImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ BrightObjectOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::BrightObjectOn ( )
virtual

Enhance bright structures on a dark background if true, the opposite if false. Default is "On" (equivalent to vesselness).

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetAlpha()

template<typename TInputImage , typename TOutputImage >
virtual double itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetAlpha ( ) const
virtual

Set/Get Alpha, the weight corresponding to R_A (the ratio of the smallest eigenvalue that has to be large to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

◆ GetBeta()

template<typename TInputImage , typename TOutputImage >
virtual double itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetBeta ( ) const
virtual

Set/Get Beta, the weight corresponding to R_B (the ratio of the largest eigenvalue that has to be small to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

◆ GetBrightObject()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetBrightObject ( ) const
virtual

Enhance bright structures on a dark background if true, the opposite if false. Default is "On" (equivalent to vesselness).

◆ GetGamma()

template<typename TInputImage , typename TOutputImage >
virtual double itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetGamma ( ) const
virtual

Set/Get Gamma, the weight corresponding to S (the Frobenius norm of the Hessian matrix, or second-order structureness)

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
const char* itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetObjectDimension()

template<typename TInputImage , typename TOutputImage >
virtual unsigned int itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetObjectDimension ( ) const
virtual

Set/Get the dimensionality of the object (0: points (blobs), 1: lines (vessels), 2: planes (plate-like structures), 3: hyper-planes. ObjectDimension must be smaller than ImageDimension.

◆ GetScaleObjectnessMeasure()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::GetScaleObjectnessMeasure ( ) const
virtual

Toggle scaling the objectness measure with the magnitude of the largest absolute eigenvalue

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ ScaleObjectnessMeasureOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::ScaleObjectnessMeasureOn ( )
virtual

Toggle scaling the objectness measure with the magnitude of the largest absolute eigenvalue

◆ SetAlpha()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::SetAlpha ( double  _arg)
virtual

Set/Get Alpha, the weight corresponding to R_A (the ratio of the smallest eigenvalue that has to be large to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

◆ SetBeta()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::SetBeta ( double  _arg)
virtual

Set/Get Beta, the weight corresponding to R_B (the ratio of the largest eigenvalue that has to be small to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

◆ SetBrightObject()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::SetBrightObject ( bool  _arg)
virtual

Enhance bright structures on a dark background if true, the opposite if false. Default is "On" (equivalent to vesselness).

◆ SetGamma()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::SetGamma ( double  _arg)
virtual

Set/Get Gamma, the weight corresponding to S (the Frobenius norm of the Hessian matrix, or second-order structureness)

◆ SetObjectDimension()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::SetObjectDimension ( unsigned int  _arg)
virtual

Set/Get the dimensionality of the object (0: points (blobs), 1: lines (vessels), 2: planes (plate-like structures), 3: hyper-planes. ObjectDimension must be smaller than ImageDimension.

◆ SetScaleObjectnessMeasure()

template<typename TInputImage , typename TOutputImage >
virtual void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::SetScaleObjectnessMeasure ( bool  _arg)
virtual

Toggle scaling the objectness measure with the magnitude of the largest absolute eigenvalue

◆ VerifyPreconditions()

template<typename TInputImage , typename TOutputImage >
void itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::VerifyPreconditions ( )
overrideprotectedvirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation() is propagated to the inputs.

The ProcessObject's implementation verifies that the m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::ImageDimension = InputImageType::ImageDimension
staticconstexpr

Image dimension

Definition at line 79 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ m_Alpha

template<typename TInputImage , typename TOutputImage >
double itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::m_Alpha { 0.5 }
private

Definition at line 164 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ m_Beta

template<typename TInputImage , typename TOutputImage >
double itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::m_Beta { 0.5 }
private

Definition at line 165 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ m_BrightObject

template<typename TInputImage , typename TOutputImage >
bool itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::m_BrightObject { true }
private

Definition at line 168 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ m_Gamma

template<typename TInputImage , typename TOutputImage >
double itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::m_Gamma { 5.0 }
private

Definition at line 166 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ m_ObjectDimension

template<typename TInputImage , typename TOutputImage >
unsigned int itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::m_ObjectDimension { 1 }
private

Definition at line 167 of file itkHessianToObjectnessMeasureImageFilter.h.

◆ m_ScaleObjectnessMeasure

template<typename TInputImage , typename TOutputImage >
bool itk::HessianToObjectnessMeasureImageFilter< TInputImage, TOutputImage >::m_ScaleObjectnessMeasure { true }
private

Definition at line 169 of file itkHessianToObjectnessMeasureImageFilter.h.


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