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

#include <itkNarrowBandImageFilterBase.h>

Detailed Description

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

This class implements a multi-threaded finite difference image to image solver that can be applied to an arbitrary list of pixels.

This class is intended as a common base class for classical narrowband solvers and manifold solvers. This base class implements a common memory management and multi-threaded architecture for applying a finite difference function to a list of pixels in an image. The specifics of narrowband solvers such as re-initialization and the use of land-mines are not implemented.
INPUTS
This filter takes an itk::Image as input. The appropriate type of input image is entirely determined by the application. As a rule, however, the input type is immediately converted to the output type before processing. This is because the input is not assumed to be a real value type and must be converted to signed, real values for the calculations.
OUTPUTS
The output is an itk::Image and is the solution of the pde. The embedding of the interface may vary with the application, but the usual ITK convention is that it is the zero level set in the output image.
IMPORTANT!
Read the documentation for FiniteDifferenceImageFilter before attempting to use this filter. The solver requires that you specify a FiniteDifferenceFunction to use for calculations. This is set using the method SetDifferenceFunction in the parent class.
REFERENCES
Sethian, J.A. Level Set Methods. Cambridge University Press. 1996.

Definition at line 70 of file itkNarrowBandImageFilterBase.h.

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

Classes

struct  ThreadRegionType
 

Public Types

using BandNodeType = BandNode< IndexType, PixelType >
 
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename OutputImageType::IndexType
 
using NarrowBandIterator = typename NarrowBandType::Iterator
 
using NarrowBandPointer = typename NarrowBandType::Pointer
 
using NarrowBandType = NarrowBand< BandNodeType >
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename NarrowBandType::RegionType
 
using Self = NarrowBandImageFilterBase
 
using Superclass = FiniteDifferenceImageFilter< TInputImage, TOutputImage >
 
using ValueType = typename OutputImageType::ValueType
 
- Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using FiniteDifferenceFunctionType = FiniteDifferenceFunction< TOutputImage >
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType
 
using NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType
 
using PixelType = OutputPixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename FiniteDifferenceFunctionType::RadiusType
 
using Self = FiniteDifferenceImageFilter
 
using Superclass = InPlaceImageFilter< TInputImage, TOutputImage >
 
using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType
 
- Public Types inherited from itk::InPlaceImageFilter< 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 = InPlaceImageFilter
 
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

void CopyInputToOutput () override
 
virtual void CreateNarrowBand ()
 
float GetNarrowBandInnerRadius () const
 
float GetNarrowBandTotalRadius () const
 
void InsertNarrowBandNode (const IndexType &index)
 
void InsertNarrowBandNode (const IndexType &index, const PixelType &value, const signed char nodestate)
 
 itkOverrideGetNameOfClassMacro (NarrowBandImageFilterBase)
 
virtual void SetNarrowBand (NarrowBandType *ptr)
 
virtual void SetIsoSurfaceValue (ValueType _arg)
 
virtual ValueType GetIsoSurfaceValue () const
 
void InsertNarrowBandNode (const BandNodeType &node)
 
void SetNarrowBandTotalRadius (const float val)
 
void SetNarrowBandInnerRadius (const float val)
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const FiniteDifferenceFunctionType ::PointerGetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual bool GetIsInitialized ()
 
 itkOverrideGetNameOfClassMacro (FiniteDifferenceImageFilter)
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
virtual void SetIsInitialized (bool _arg)
 
void SetStateToInitialized ()
 
void SetStateToUninitialized ()
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
virtual const bool & GetUseImageSpacing () const
 
virtual void SetMaximumRMSError (double _arg)
 
virtual const double & GetMaximumRMSError () const
 
virtual void SetRMSChange (double _arg)
 
virtual const double & GetRMSChange () const
 
virtual void SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
 
 itkOverrideGetNameOfClassMacro (InPlaceImageFilter)
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
 itkOverrideGetNameOfClassMacro (ImageToImageFilter)
 
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)
 
 itkOverrideGetNameOfClassMacro (ImageSource)
 
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)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int ImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::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 ClearNarrowBand ()
 
void GenerateData () override
 
void GetSplitRegion (const vcl_size_t &i, ThreadRegionType &splitRegion)
 
void Initialize () override
 
void InitializeIteration () override
 
 NarrowBandImageFilterBase ()
 
void PostProcessOutput () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~NarrowBandImageFilterBase () override=default
 
- Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
 FiniteDifferenceImageFilter ()
 
void GenerateInputRequestedRegion () override
 
virtual bool Halt ()
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
virtual bool ThreadedHalt (void *)
 
 ~FiniteDifferenceImageFilter () override=default
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
- 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)
 
 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 BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
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 void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
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 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 &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~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 ()
 

Protected Attributes

ValueType m_IsoSurfaceValue {}
 
NarrowBandPointer m_NarrowBand {}
 
std::vector< RegionTypem_RegionList {}
 
IdentifierType m_ReinitializationFrequency {}
 
IdentifierType m_Step {}
 
bool m_Touched {}
 
BooleanStdVectorType m_TouchedForThread {}
 
- Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
IdentifierType m_ElapsedIterations {}
 
bool m_IsInitialized {}
 
bool m_ManualReinitialization {}
 
double m_MaximumRMSError {}
 
IdentifierType m_NumberOfIterations {}
 
double m_RMSChange {}
 
- 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 {}
 

Private Member Functions

void AllocateUpdateBuffer () override
 
void ApplyUpdate (const TimeStepType &) override
 
TimeStepType CalculateChange () override
 
virtual void ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
virtual TimeStepType ThreadedCalculateChange (const ThreadRegionType &regionToProcess)
 

Additional Inherited Members

- 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 ()
 
- 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)
 

Member Typedef Documentation

◆ BandNodeType

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::BandNodeType = BandNode<IndexType, PixelType>

This is the storage type for the nodes on the narrow band.

Definition at line 108 of file itkNarrowBandImageFilterBase.h.

◆ ConstPointer

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

Definition at line 79 of file itkNarrowBandImageFilterBase.h.

◆ IndexType

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

The index type for the output image.

Definition at line 101 of file itkNarrowBandImageFilterBase.h.

◆ NarrowBandIterator

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandIterator = typename NarrowBandType::Iterator

Definition at line 114 of file itkNarrowBandImageFilterBase.h.

◆ NarrowBandPointer

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandPointer = typename NarrowBandType::Pointer

Definition at line 112 of file itkNarrowBandImageFilterBase.h.

◆ NarrowBandType

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandType = NarrowBand<BandNodeType>

The list type for storing the narrow band.

Definition at line 111 of file itkNarrowBandImageFilterBase.h.

◆ Pointer

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

Definition at line 78 of file itkNarrowBandImageFilterBase.h.

◆ RegionType

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::RegionType = typename NarrowBandType::RegionType

Definition at line 113 of file itkNarrowBandImageFilterBase.h.

◆ Self

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

Standard class type aliases

Definition at line 76 of file itkNarrowBandImageFilterBase.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Superclass = FiniteDifferenceImageFilter<TInputImage, TOutputImage>

Definition at line 77 of file itkNarrowBandImageFilterBase.h.

◆ ValueType

template<typename TInputImage, typename TOutputImage>
using itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ValueType = typename OutputImageType::ValueType

The data type used in numerical computations. Derived from the output image type.

Definition at line 105 of file itkNarrowBandImageFilterBase.h.

Constructor & Destructor Documentation

◆ NarrowBandImageFilterBase()

template<typename TInputImage, typename TOutputImage>
itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandImageFilterBase ( )
inlineprotected

Definition at line 223 of file itkNarrowBandImageFilterBase.h.

◆ ~NarrowBandImageFilterBase()

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

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )
inlineoverrideprivatevirtual

This method allocates a temporary update container in the subclass.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 312 of file itkNarrowBandImageFilterBase.h.

◆ ApplyUpdate()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType dt)
inlineoverrideprivatevirtual

This method is defined by a subclass to apply changes to the output from an update buffer and a time step value "dt".

Parameters
dtTime step value.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 322 of file itkNarrowBandImageFilterBase.h.

◆ CalculateChange()

template<typename TInputImage, typename TOutputImage>
TimeStepType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CalculateChange ( )
inlineoverrideprivatevirtual

This method is defined by a subclass to populate an update buffer with changes for the pixels in the output. It returns a time step value to be used for the update.

Returns
A time step to use in updating the output with the changes calculated from this method.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 332 of file itkNarrowBandImageFilterBase.h.

◆ ClearNarrowBand()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ClearNarrowBand ( )
protected

◆ CopyInputToOutput()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CopyInputToOutput ( )
overridevirtual

This method can be defined in subclasses as needed to copy the input to the output. See DenseFiniteDifferenceImageFilter for an implementation.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ CreateNarrowBand()

template<typename TInputImage, typename TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CreateNarrowBand ( )
inlinevirtual

This is the virtual method called by Initialize to set the band of operation. It is left to the subclasses to define this functionality. This function can make use of above InsertNarrowBandNode function to create a band.

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >.

Definition at line 206 of file itkNarrowBandImageFilterBase.h.

◆ GenerateData()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

This is the default, high-level algorithm for calculating finite difference solutions. It calls virtual methods in its subclasses to implement the major steps of the algorithm.

This method is a thread implementation of the iterative scheme implemented in itkFiniteDifferenceImageFilter::GenerateData. It relies on ThreadedApplyUpdate and ThreadedCalculateChange to update the solution at every iteration.

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

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >.

◆ GetIsoSurfaceValue()

template<typename TInputImage, typename TOutputImage>
virtual ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetIsoSurfaceValue ( ) const
virtual

Set/Get IsoSurfaceValue to use in the input image

◆ GetNarrowBandInnerRadius()

template<typename TInputImage, typename TOutputImage>
float itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNarrowBandInnerRadius ( ) const
inline

Get the narrow band inner radius.

Definition at line 195 of file itkNarrowBandImageFilterBase.h.

◆ GetNarrowBandTotalRadius()

template<typename TInputImage, typename TOutputImage>
float itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNarrowBandTotalRadius ( ) const
inline

Get the narrow band total radius.

Definition at line 175 of file itkNarrowBandImageFilterBase.h.

◆ GetSplitRegion()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetSplitRegion ( const vcl_size_t &  i,
ThreadRegionType splitRegion 
)
protected

This function returns a single region (of the narrow band list) for use in multi-threading

◆ Initialize()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Initialize ( )
overrideprotectedvirtual

This function clears the existing narrow band, calls CreateNarrowBand to create a band, and calls the SplitRegions function of NarrowBand to pre-partition the band for multi-threading.

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

◆ InitializeIteration()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InitializeIteration ( )
overrideprotectedvirtual

This method check the narrow band state each iteration and reinitialize the narrow band if it is appropriate calling CreateNarrowBand and SplitRegions to pre-partition the band for multi-threading.

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

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >.

◆ InsertNarrowBandNode() [1/3]

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const BandNodeType node)
inline

Root Mean Square Change between successive iterations This function is used to insert a pixel index into the narrow band The entire narrow band can be constructed using this method. Usually, however, the narrow band is initialized and reinitialized automatically by the subclass.

Definition at line 129 of file itkNarrowBandImageFilterBase.h.

◆ InsertNarrowBandNode() [2/3]

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const IndexType index)
inline

Definition at line 137 of file itkNarrowBandImageFilterBase.h.

◆ InsertNarrowBandNode() [3/3]

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const IndexType index,
const PixelType value,
const signed char  nodestate 
)
inline

Definition at line 147 of file itkNarrowBandImageFilterBase.h.

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage, typename TOutputImage>
itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::itkOverrideGetNameOfClassMacro ( NarrowBandImageFilterBase< TInputImage, TOutputImage >  )

Run-time type information (and related methods)

◆ PostProcessOutput()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::PostProcessOutput ( )
overrideprotectedvirtual

This method allows deallocation of data and further post processing

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

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< 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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >.

◆ SetIsoSurfaceValue()

template<typename TInputImage, typename TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetIsoSurfaceValue ( ValueType  _arg)
virtual

Set/Get IsoSurfaceValue to use in the input image

◆ SetNarrowBand()

template<typename TInputImage, typename TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand ( NarrowBandType ptr)
inlinevirtual

Definition at line 210 of file itkNarrowBandImageFilterBase.h.

◆ SetNarrowBandInnerRadius()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius ( const float  val)
inline

Set the narrow band inner radius. The inner radius is the safe are where the level set can be computed. The default value is 1.

Definition at line 183 of file itkNarrowBandImageFilterBase.h.

◆ SetNarrowBandTotalRadius()

template<typename TInputImage, typename TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius ( const float  val)
inline

Set the narrow band total radius. The narrow band width will be twice this value (positive and negative distance to the zero level set). The default value is 3.

Definition at line 163 of file itkNarrowBandImageFilterBase.h.

◆ ThreadedApplyUpdate()

template<typename TInputImage, typename TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ThreadedApplyUpdate ( const TimeStepType dt,
const ThreadRegionType regionToProcess,
ThreadIdType  threadId 
)
privatevirtual

This method applies changes from the m_NarrowBand to the output using the ThreadedApplyUpdate() method and a multithreading mechanism. "dt" is the time step to use for the update of each pixel.

◆ ThreadedCalculateChange()

template<typename TInputImage, typename TOutputImage>
virtual TimeStepType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ThreadedCalculateChange ( const ThreadRegionType regionToProcess)
privatevirtual

This method populates m_NarrowBand with changes for each pixel in the output using the ThreadedCalculateChange() method and a multithreading mechanism. Returns value is a time step to be used for the update.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TOutputImage>
constexpr unsigned int itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Definition at line 91 of file itkNarrowBandImageFilterBase.h.

◆ m_IsoSurfaceValue

template<typename TInputImage, typename TOutputImage>
ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_IsoSurfaceValue {}
protected

Definition at line 303 of file itkNarrowBandImageFilterBase.h.

◆ m_NarrowBand

template<typename TInputImage, typename TOutputImage>
NarrowBandPointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_NarrowBand {}
protected

Definition at line 238 of file itkNarrowBandImageFilterBase.h.

◆ m_RegionList

template<typename TInputImage, typename TOutputImage>
std::vector<RegionType> itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_RegionList {}
protected

A list of subregions of the narrowband which are passed to each thread for parallel processing.

Definition at line 255 of file itkNarrowBandImageFilterBase.h.

◆ m_ReinitializationFrequency

template<typename TInputImage, typename TOutputImage>
IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_ReinitializationFrequency {}
protected

Definition at line 296 of file itkNarrowBandImageFilterBase.h.

◆ m_Step

template<typename TInputImage, typename TOutputImage>
IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Step {}
protected

Definition at line 297 of file itkNarrowBandImageFilterBase.h.

◆ m_Touched

template<typename TInputImage, typename TOutputImage>
bool itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Touched {}
protected

Definition at line 299 of file itkNarrowBandImageFilterBase.h.

◆ m_TouchedForThread

template<typename TInputImage, typename TOutputImage>
BooleanStdVectorType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_TouchedForThread {}
protected

Definition at line 301 of file itkNarrowBandImageFilterBase.h.


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