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

#include <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 FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType
 
using IndexType = typename OutputImageType::IndexType
 
using InputImageType = typename Superclass::InputImageType
 
using NarrowBandIterator = typename NarrowBandType::Iterator
 
using NarrowBandPointer = typename NarrowBandType::Pointer
 
using NarrowBandType = NarrowBand< BandNodeType >
 
using OutputImageType = typename Superclass::OutputImageType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename NarrowBandType::RegionType
 
using Self = NarrowBandImageFilterBase
 
using Superclass = FiniteDifferenceImageFilter< TInputImage, TOutputImage >
 
using TimeStepType = typename Superclass::TimeStepType
 
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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
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

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const FiniteDifferenceFunctionType ::PointerGetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
virtual void UseImageSpacingOff ()
 
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 ()
 
virtual void ManualReinitializationOff ()
 
virtual void SetIsInitialized (bool _arg)
 
virtual bool GetIsInitialized ()
 
void SetStateToUninitialized ()
 
void SetStateToInitialized ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
virtual bool CanRunInPlace () const
 
- 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 *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
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 ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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
 
NarrowBandPointer m_NarrowBand
 
std::vector< RegionTypem_RegionList
 
IdentifierType m_ReinitializationFrequency
 
IdentifierType m_Step
 
bool m_Touched
 
std::vector< bool > m_TouchedForThread
 
ValueType m_IsoSurfaceValue
 
virtual void SetIsoSurfaceValue (ValueType _arg)
 
virtual ValueType GetIsoSurfaceValue () const
 
void InsertNarrowBandNode (const BandNodeType &node)
 
void InsertNarrowBandNode (const IndexType &index)
 
void InsertNarrowBandNode (const IndexType &index, const PixelType &value, const signed char &nodestate)
 
void SetNarrowBandTotalRadius (const float &val)
 
float GetNarrowBandTotalRadius () const
 
void SetNarrowBandInnerRadius (const float &val)
 
float GetNarrowBandInnerRadius () const
 
virtual void CreateNarrowBand ()
 
virtual void SetNarrowBand (NarrowBandType *ptr)
 
void CopyInputToOutput () override
 
 NarrowBandImageFilterBase ()
 
 ~NarrowBandImageFilterBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GetSplitRegion (const vcl_size_t &i, ThreadRegionType &splitRegion)
 
void Initialize () override
 
void InitializeIteration () override
 
void PostProcessOutput () override
 
void ClearNarrowBand ()
 
void GenerateData () override
 
void AllocateUpdateBuffer () override
 
virtual void ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
void ApplyUpdate (const TimeStepType &) override
 
virtual TimeStepType ThreadedCalculateChange (const ThreadRegionType &regionToProcess)
 
TimeStepType CalculateChange () override
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- 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 >
 
- Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
 FiniteDifferenceImageFilter ()
 
 ~FiniteDifferenceImageFilter () override=default
 
void GenerateInputRequestedRegion () override
 
virtual bool Halt ()
 
virtual bool ThreadedHalt (void *)
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
void ReleaseInputs () override
 
virtual bool GetRunningInPlace () const
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- 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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
bool m_IsInitialized
 
IdentifierType m_NumberOfIterations
 
IdentifierType m_ElapsedIterations
 
bool m_ManualReinitialization
 
double m_RMSChange
 
double m_MaximumRMSError
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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 69 of file itkNarrowBandImageFilterBase.h.

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 107 of file itkNarrowBandImageFilterBase.h.

◆ ConstPointer

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

Definition at line 78 of file itkNarrowBandImageFilterBase.h.

◆ FiniteDifferenceFunctionType

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

Definition at line 86 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 100 of file itkNarrowBandImageFilterBase.h.

◆ InputImageType

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

Typedefs from the superclass

Definition at line 84 of file itkNarrowBandImageFilterBase.h.

◆ NarrowBandIterator

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

Definition at line 113 of file itkNarrowBandImageFilterBase.h.

◆ NarrowBandPointer

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

Definition at line 111 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 110 of file itkNarrowBandImageFilterBase.h.

◆ OutputImageType

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

Definition at line 85 of file itkNarrowBandImageFilterBase.h.

◆ PixelType

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

The pixel type of the output image will be used in computations. Inherited from the superclass.

Definition at line 94 of file itkNarrowBandImageFilterBase.h.

◆ Pointer

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

Definition at line 77 of file itkNarrowBandImageFilterBase.h.

◆ RegionType

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

Definition at line 112 of file itkNarrowBandImageFilterBase.h.

◆ Self

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

Standard class type aliases

Definition at line 75 of file itkNarrowBandImageFilterBase.h.

◆ Superclass

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

Definition at line 76 of file itkNarrowBandImageFilterBase.h.

◆ TimeStepType

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

The value type of a time step. Inherited from the superclass.

Definition at line 97 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 104 of file itkNarrowBandImageFilterBase.h.

Constructor & Destructor Documentation

◆ NarrowBandImageFilterBase()

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

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

Definition at line 222 of file itkNarrowBandImageFilterBase.h.

◆ ~NarrowBandImageFilterBase()

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

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

Member Function Documentation

◆ AllocateUpdateBuffer()

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

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

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 311 of file itkNarrowBandImageFilterBase.h.

◆ ApplyUpdate()

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

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

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 321 of file itkNarrowBandImageFilterBase.h.

◆ CalculateChange()

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

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

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 331 of file itkNarrowBandImageFilterBase.h.

◆ ClearNarrowBand()

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

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

◆ CopyInputToOutput()

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

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

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 >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage ::ImageDimension > >.

Definition at line 205 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 >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, 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

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

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage>
virtual const char* itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

◆ GetNarrowBandInnerRadius()

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

Get the narrow band inner radius.

Definition at line 194 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 174 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

◆ 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 128 of file itkNarrowBandImageFilterBase.h.

◆ InsertNarrowBandNode() [2/3]

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

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

Definition at line 136 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

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

Definition at line 146 of file itkNarrowBandImageFilterBase.h.

◆ 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

◆ 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

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

Definition at line 209 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 182 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 162 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 90 of file itkNarrowBandImageFilterBase.h.

◆ m_IsoSurfaceValue

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

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

Definition at line 302 of file itkNarrowBandImageFilterBase.h.

◆ m_NarrowBand

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

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

Definition at line 237 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 254 of file itkNarrowBandImageFilterBase.h.

◆ m_ReinitializationFrequency

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

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

Definition at line 295 of file itkNarrowBandImageFilterBase.h.

◆ m_Step

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

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

Definition at line 296 of file itkNarrowBandImageFilterBase.h.

◆ m_Touched

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

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

Definition at line 298 of file itkNarrowBandImageFilterBase.h.

◆ m_TouchedForThread

template<typename TInputImage, typename TOutputImage>
std::vector<bool> itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_TouchedForThread
protected

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

Definition at line 300 of file itkNarrowBandImageFilterBase.h.


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