ITK  4.8.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkParallelSparseFieldLevelSetImageFilter.h>

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

Detailed Description

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

This class implements a finite difference partial differential equation solver for evolving surfaces embedded in volumes as level-sets.

The ``sparse field'' approach to the level-set model is a logical extension of the classical narrow band technique, which seeks to minimize computational effort by restricting calculations to those pixels in a region of interest around the moving surface (the $k$-level curve). The sparse field method uses a narrow band that is exactly the width needed to calculate changes on the level curve for the next time step. Because the band of grid points under consideration is so sparse, this approach has several advantages: the algorithm does exactly the number of calculations needed to determine the next position of the $k$-level curve, and the distance transform around the level curve can be recomputed at each iteration.
The sparse field algorithm works by constructing a linked list of indices that are adjacent to the $k$-level set. These indices are called the ``active set''. The values at these active set indices define the position of the $k$-level curve. The active set indices are shifted to follow the distance transform embedding of the $k$-level curve as their values move in and out of a fixed numerical range about $k$. In this way, the active set is maintained as only those pixels adjacent to the evolving surface. Calculations are then done only at indices contained in the active set.
The city-block neighborhoods of the active set indices are maintained as separate lists called ``layers''. At each iteration, the values at the layers are reinitialized as the distance transform from the active set. The number of layers can be adjusted according to the footprint needed for the calculations on the level curve.
Briefly, the sparse field solver algorithm is as follows:
  1. For each active layer index $x_j$: Compute the change at $u_{x_j}$, the grid point in the embedding, based on local geometry and external forces and using a stable numerical scheme.
  2. For each active layer index $x_j$, add the change to the grid point value and redefine the active set indices and those of its layers based on any value changes which have moved outside of the numerical range allowed for the active set.
  3. Starting with the first layers adjacent to the active set and moving outwards, reconstruct the distance transform by setting values in the layers according to their neighbors. At the very outer layers, add or remove indices which have come into or moved out of the sparse field.
HOW TO USE THIS CLASS
Typically, this class should be subclassed with additional functionality for specific applications. It is possible, however to use this solver as a filter directly by instantiating it and supplying it with an appropriate LevelSetFunction object via the SetDifferenceFunction method. See the subclasses and their associated documentation for more information on using this class. Also see the FiniteDifferenceImageFilter documentation for a general overview of this class of solvers.
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. The input values will also be shifted by the $k$ isosurface value so that the algorithm only needs to consider the zero level set.
OUTPUTS
The output of the filter is the distance transform embedding of the isosurface as the zero level set. Values outside the surface will be negative and values inside the surface will be positive. The distance transform only holds for those indices in layers around the active layer. Elsewhere, the values are a fixed positive or negative that is one greater than the layer of greatest magnitude. In other words, if there are three layers, then inside values increase only to 4.0 and outside values only to -4.0.
PARAMETERS
The NumberOfLayers parameter controls the number of layers inside and outside of the active set (see description above). The sparse field will contain 2*NumberOfLayers+1 lists of indices: the active set and city block neighbors inside and outside the active set. It is important to specify enough layers to cover the footprint of your calculations. Curvature calculations in three dimensions, for example, require 3 layers. In two dimensions, a minimum of 2 layers is probably required. Higher order derivatives and other geometrical measures may require more layers. If too few layers are specified, then the calculations will pull values from the background, which may consist of arbitrary or random values.
The IsoSurfaceValue indicates which value in the input represents the interface of interest. By default, this value is zero. When the solver initializes, it will subtract the IsoSurfaceValue from all values, in the input, shifting the isosurface of interest to zero in the output.
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
Whitaker, Ross. A Level-Set Approach to 3D Reconstruction from Range Data. International Journal of Computer Vision. V. 29 No. 3, 203-231. 1998.
Sethian, J.A. Level Set Methods. Cambridge University Press. 1996.

Definition at line 249 of file itkParallelSparseFieldLevelSetImageFilter.h.

Classes

struct  ParallelSparseFieldLevelSetThreadStruct
 
struct  ThreadData
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::FiniteDifferenceFunctionType 
FiniteDifferenceFunctionType
 
typedef OutputImageType::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef std::vector
< LayerPointerType
LayerListType
 
typedef ObjectStore
< LayerNodeType
LayerNodeStorageType
 
typedef
ParallelSparseFieldLevelSetNode
< IndexType
LayerNodeType
 
typedef LayerType::Pointer LayerPointerType
 
typedef SparseFieldLayer
< LayerNodeType
LayerType
 
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef Offset
< itkGetStaticConstMacro(ImageDimension) > 
OffsetType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef
ParallelSparseFieldLevelSetImageFilter 
Self
 
typedef Image< StatusType,
itkGetStaticConstMacro(ImageDimension) > 
StatusImageType
 
typedef signed char StatusType
 
typedef
FiniteDifferenceImageFilter
< TInputImage, TOutputImage > 
Superclass
 
typedef OutputImageType::RegionType ThreadRegionType
 
typedef Superclass::TimeStepType TimeStepType
 
typedef OutputImageType::ValueType ValueType
 
- Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
FiniteDifferenceFunction
< TOutputImage > 
FiniteDifferenceFunctionType
 
typedef TInputImage InputImageType
 
typedef TInputImage::PixelType InputPixelType
 
typedef NumericTraits
< InputPixelType >::ValueType 
InputPixelValueType
 
typedef
FiniteDifferenceFunctionType::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef TOutputImage OutputImageType
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef NumericTraits
< OutputPixelType >::ValueType 
OutputPixelValueType
 
typedef OutputPixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
FiniteDifferenceFunctionType::RadiusType 
RadiusType
 
typedef FiniteDifferenceImageFilter Self
 
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 
typedef
FiniteDifferenceFunctionType::TimeStepType 
TimeStepType
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef InPlaceImageFilter Self
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
LayerPointerType GetActiveListForIndex (const IndexType index)
 
virtual const char * GetNameOfClass () const
 
 typedef (Concept::EqualityComparable< PixelType >) OutputEqualityComparableCheck
 
 typedef (Concept::Convertible< double, PixelType >) DoubleConvertibleToOutputCheck
 
 typedef (Concept::OStreamWritable< PixelType >) OutputOStreamWritableCheck
 
virtual void SetNumberOfLayers (StatusType _arg)
 
virtual StatusType GetNumberOfLayers () const
 
virtual void SetIsoSurfaceValue (ValueType _arg)
 
virtual ValueType GetIsoSurfaceValue () const
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const
FiniteDifferenceFunctionType::Pointer
GetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual bool GetIsInitialized ()
 
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 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 ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
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 (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
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 ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
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)
 
void SetProgress (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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 Member Functions

static Pointer New ()
 
- 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 ()
 

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
static const unsigned int ImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void AllocateUpdateBuffer () override
 
void ApplyUpdate (const TimeStepType &) override
 
TimeStepType CalculateChange () override
 
virtual void CheckLoadBalance ()
 
void ClearInterNeighborNodeTransferBufferLayers (ThreadIdType ThreadId, unsigned int InOrOut, unsigned int BufferLayerNumber)
 
void ClearList (ThreadIdType ThreadId, LayerPointerType ListPtr)
 
void ComputeInitialThreadBoundaries ()
 
void ConstructActiveLayer ()
 
void ConstructLayer (const StatusType &from, const StatusType &to)
 
void CopyInputToOutput () override
 
void CopyInsertInterNeighborNodeTransferBufferLayers (ThreadIdType ThreadId, LayerPointerType InputList, unsigned int InOrOut, unsigned int BufferLayerNumber)
 
void CopyInsertList (ThreadIdType ThreadId, LayerPointerType FromListPtr, LayerPointerType ToListPtr)
 
void DeallocateData ()
 
virtual void GenerateData () override
 
unsigned int GetThreadNumber (unsigned int splitAxisValue)
 
void GetThreadRegionSplitByBoundary (ThreadIdType ThreadId, ThreadRegionType &ThreadRegion)
 
void GetThreadRegionSplitUniformly (ThreadIdType ThreadId, ThreadRegionType &ThreadRegion)
 
void Initialize () override
 
void InitializeActiveLayerValues ()
 
virtual void InitializeBackgroundPixels ()
 
void Iterate ()
 
 ParallelSparseFieldLevelSetImageFilter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
void ProcessStatusList (LayerType *InputList, const StatusType &ChangeToStatus, const StatusType &SearchForStatus, ThreadIdType ThreadId)
 
void PropagateAllLayerValues ()
 
void PropagateLayerValues (const StatusType &from, const StatusType &to, const StatusType &promote, unsigned int InOrOut)
 
void SignalNeighbor (unsigned int SemaphoreArrayNumber, ThreadIdType ThreadId)
 
void SignalNeighborsAndWait (ThreadIdType ThreadId)
 
void ThreadedAllocateData (ThreadIdType ThreadId)
 
virtual void ThreadedApplyUpdate (const TimeStepType &dt, ThreadIdType ThreadId)
 
virtual TimeStepType ThreadedCalculateChange (ThreadIdType ThreadId)
 
virtual ValueType ThreadedCalculateUpdateValue (const ThreadIdType, const IndexType, const TimeStepType &dt, const ValueType &value, const ValueType &change)
 
void ThreadedInitializeData (ThreadIdType ThreadId, const ThreadRegionType &ThreadRegion)
 
virtual void ThreadedInitializeIteration (ThreadIdType ThreadId)
 
virtual void ThreadedLoadBalance (ThreadIdType ThreadId)
 
void ThreadedPostProcessOutput (const ThreadRegionType &regionToProcess)
 
void ThreadedProcessFirstLayerStatusLists (unsigned int InputLayerNumber, unsigned int OutputLayerNumber, const StatusType &SearchForStatus, unsigned int InOrOut, unsigned int BufferLayerNumber, ThreadIdType ThreadId)
 
void ThreadedProcessOutsideList (unsigned int InputLayerNumber, const StatusType &ChangeToStatus, unsigned int InOrOut, unsigned int BufferLayerNumber, ThreadIdType ThreadId)
 
virtual void ThreadedProcessPixelEnteringActiveLayer (const IndexType &, const ValueType &, ThreadIdType)
 
void ThreadedProcessStatusList (unsigned int InputLayerNumber, unsigned int OutputLayerNumber, const StatusType &ChangeToStatus, const StatusType &SearchForStatus, unsigned int InOrOut, unsigned int BufferLayerNumber, ThreadIdType ThreadId)
 
void ThreadedPropagateLayerValues (const StatusType &from, const StatusType &to, const StatusType &promote, unsigned int InorOut, ThreadIdType ThreadId)
 
void ThreadedUpdateActiveLayerValues (const TimeStepType &dt, LayerType *StatusUpList, LayerType *StatusDownList, ThreadIdType ThreadId)
 
void WaitForAll ()
 
void WaitForNeighbor (unsigned int SemaphoreArrayNumber, ThreadIdType ThreadId)
 
 ~ParallelSparseFieldLevelSetImageFilter ()
 
- Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
 FiniteDifferenceImageFilter ()
 
virtual void GenerateInputRequestedRegion () override
 
virtual bool Halt ()
 
virtual void InitializeIteration ()
 
virtual void PostProcessOutput ()
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
virtual bool ThreadedHalt (void *)
 
virtual ~FiniteDifferenceImageFilter ()
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void AllocateOutputs () override
 
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()
 
virtual void ReleaseInputs () override
 
 ~InPlaceImageFilter ()
 
- 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 ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
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
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
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 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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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

static ITK_THREAD_RETURN_TYPE IterateThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Protected Attributes

Barrier::Pointer m_Barrier
 
unsigned int * m_Boundary
 
bool m_BoundaryChanged
 
double m_ConstantGradientValue
 
ThreadDatam_Data
 
int * m_GlobalZHistogram
 
bool m_InterpolateSurfaceLocation
 
ValueType m_IsoSurfaceValue
 
LayerNodeStorageType::Pointer m_LayerNodeStore
 
LayerListType m_Layers
 
unsigned int * m_MapZToThreadNumber
 
ParallelSparseFieldCityBlockNeighborList
< NeighborhoodIterator
< OutputImageType > > 
m_NeighborList
 
StatusType m_NumberOfLayers
 
ThreadIdType m_NumOfThreads
 
OutputImageType::Pointer m_OutputImage
 
OutputImageType::Pointer m_OutputImageTemp
 
OutputImageType::Pointer m_ShiftedImage
 
unsigned int m_SplitAxis
 
StatusImageType::Pointer m_StatusImage
 
StatusImageType::Pointer m_StatusImageTemp
 
bool m_Stop
 
int * m_ZCumulativeFrequency
 
unsigned int m_ZSize
 
- 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::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Static Protected Attributes

static StatusType m_StatusActiveChangingDown
 
static StatusType m_StatusActiveChangingUp
 
static StatusType m_StatusBoundaryPixel
 
static StatusType m_StatusChanging
 
static StatusType m_StatusNull
 
static ValueType m_ValueOne
 
static ValueType m_ValueZero
 

Private Member Functions

void operator= (const Self &)
 
 ParallelSparseFieldLevelSetImageFilter (const Self &)
 

Private Attributes

bool m_BoundsCheckingActive
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage >
typedef SmartPointer< const Self > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 258 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Superclass::FiniteDifferenceFunctionType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::FiniteDifferenceFunctionType

Definition at line 262 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef OutputImageType::IndexType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 275 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InputImageType

Information derived from the image types.

Definition at line 270 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef std::vector< LayerPointerType > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerListType

A type for a list of LayerPointerTypes

Definition at line 295 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef ObjectStore< LayerNodeType > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerNodeStorageType

Memory pre-allocator used to manage layer nodes in a multithreaded environment.

Definition at line 306 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef ParallelSparseFieldLevelSetNode< IndexType > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerNodeType

Node type used in parallel sparse field layer lists.

Definition at line 288 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef LayerType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerPointerType

Definition at line 292 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef SparseFieldLayer< LayerNodeType > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerType

A list type used in the algorithm.

Definition at line 291 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Superclass::NeighborhoodScalesType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::NeighborhoodScalesType

Definition at line 264 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Offset< itkGetStaticConstMacro(ImageDimension) > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::OffsetType

Definition at line 308 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 274 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef OutputImageType::PixelType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PixelType

Definition at line 279 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef SmartPointer< Self > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 257 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Superclass::RadiusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::RadiusType

Definition at line 263 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef ParallelSparseFieldLevelSetImageFilter itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs

Definition at line 255 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Image< StatusType, itkGetStaticConstMacro(ImageDimension) > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::StatusImageType

The type of the image used to index status information. Necessary for the internals of the algorithm.

Definition at line 302 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef signed char itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::StatusType

Type used for storing status information

Definition at line 298 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef FiniteDifferenceImageFilter< TInputImage, TOutputImage > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 256 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef OutputImageType::RegionType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadRegionType

Definition at line 281 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Superclass::TimeStepType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::TimeStepType

Typedefs from the superclass

Definition at line 261 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef OutputImageType::ValueType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ValueType

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

Definition at line 285 of file itkParallelSparseFieldLevelSetImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ParallelSparseFieldLevelSetImageFilter ( )
protected
template<typename TInputImage , typename TOutputImage >
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::~ParallelSparseFieldLevelSetImageFilter ( )
inlineprotected

Definition at line 346 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ParallelSparseFieldLevelSetImageFilter ( const Self )
private

Member Function Documentation

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )
inlineoverrideprotectedvirtual

Reserves memory in the update buffer

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 432 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType )
inlineoverrideprotectedvirtual

This method is not implemented or necessary for this solver

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 544 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
TimeStepType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CalculateChange ( )
inlineoverrideprotectedvirtual

This method is not implemented or necessary for this solver

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 551 of file itkParallelSparseFieldLevelSetImageFilter.h.

References itk::NumericTraits< T >::ZeroValue().

template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CheckLoadBalance ( )
protectedvirtual

Check if the load is fairly balanced among the threads. This is performed by just one thread while all other threads wait. This need NOT be performed every iteration because the level-set surface moves slowly and it is correct to believe that during an iteration the movement is small enough that the small gain obtained by load balancing (if any) does not warrant the overhead for calling this method. How often this is done is controlled by a parameter LOAD_BALANCE_ITERATION_FREQUENCY which is defined in the IterateThreaderCallback() function. A parameter that defines a degree of unbalancedness of the load among threads is MAX_PIXEL_DIFFERENCE_PERCENT which is defined in CheckLoadBalance().

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ClearInterNeighborNodeTransferBufferLayers ( ThreadIdType  ThreadId,
unsigned int  InOrOut,
unsigned int  BufferLayerNumber 
)
protected

Delete all nodes in a thread's own lists which its used to transfer nodes to neighboring threads.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ClearList ( ThreadIdType  ThreadId,
LayerPointerType  ListPtr 
)
protected

Delete all nodes in the List

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ComputeInitialThreadBoundaries ( )
protected

This performs the initial load distribution among the threads. Every thread gets a slab of the data to work on. The slabs created along a specific dimension. Load balancing is performed along the greatest numbered dimension (i.e. the 3rd dimension in the 3D case and the 2nd dimension in the 2D case). During the initializing of the sparse field layer an histogram is computed that stores the number of nodes in the active set for each index along the chosen dimension. This histogram is used to divide the work "equally" among threads so that each thread approximately get the same number of nodes to process.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstructActiveLayer ( )
protected

Constructs the active layer and initialize the first layers inside and outside of the active layer. The active layer defines the position of the zero level set by its values, which are constrained within a range around zero.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstructLayer ( const StatusType from,
const StatusType to 
)
protected

Initializes a layer of the sparse field using a previously initialized layer. Builds the list of nodes in m_Layer[to] using m_Layer[from]. Marks values in the m_StatusImage.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( )
overrideprotectedvirtual

Copies the input to the output image. Processing occurs on the output image, so the data type of the output image determines the precision of the calculations (i.e. double or float). This method overrides the parent class method to do some additional processing.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CopyInsertInterNeighborNodeTransferBufferLayers ( ThreadIdType  ThreadId,
LayerPointerType  InputList,
unsigned int  InOrOut,
unsigned int  BufferLayerNumber 
)
protected

Make a copy of the nodes given to one thread by its neighbors to process and insert them into the thread's own list.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CopyInsertList ( ThreadIdType  ThreadId,
LayerPointerType  FromListPtr,
LayerPointerType  ToListPtr 
)
protected

Make a copy of the nodes in the FromList and insert them into the ToList.

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::DeallocateData ( )
protected

Delete the data and synchronization primitives used by the threads during iterations.

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

The RMS change calculated from each update. Can be used by a subclass to determine halting criteria. Valid only for the previous iteration, not during the current iteration. Calculated in ApplyUpdate. Reimplement the GenerateData() function from FiniteDifferenceImageFilter for more effective multithreading

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

template<typename TInputImage , typename TOutputImage >
LayerPointerType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetActiveListForIndex ( const IndexType  index)
inline
template<typename TInputImage , typename TOutputImage >
virtual ValueType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetIsoSurfaceValue ( ) const
virtual

Set/Get the value of the isosurface to use in the input image.

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

Run-time type information (and related methods).

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

template<typename TInputImage , typename TOutputImage >
virtual StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetNumberOfLayers ( ) const
virtual

Set/Get the number of layers to use in the sparse field. Argument is the number of layers on ONE side of the active layer, so the total layers in the sparse field is 2 * NumberOfLayers + 1

template<typename TInputImage , typename TOutputImage >
unsigned int itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetThreadNumber ( unsigned int  splitAxisValue)
protected
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetThreadRegionSplitByBoundary ( ThreadIdType  ThreadId,
ThreadRegionType ThreadRegion 
)
protected

Obtain a thread's region split as per the load balancing is done.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetThreadRegionSplitUniformly ( ThreadIdType  ThreadId,
ThreadRegionType ThreadRegion 
)
protected

Split the volume uniformly along the chosen dimension for post processing the output.

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

Constructs the sparse field layers and initializes their values. Also creates data structures that are NOT local to a thread.

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

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues ( )
protected

Initializes the values of the active layer set.

template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeBackgroundPixels ( )
protectedvirtual

This method pre-processes pixels inside and outside the sparse field layers. The default is to set them to positive and negative values, respectively. This is not necessary as part of the calculations, but produces a more intuitive output for the user.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Iterate ( )
protected

This method calculates the change and does the update, i.e. one iteration of this iterative solver. A barrier class is used to synchronize execution and keep the CalculateChange and ApplyUpdate sections from executing simultaneously.

template<typename TInputImage , typename TOutputImage >
static ITK_THREAD_RETURN_TYPE itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback ( void *  arg)
staticprotected
template<typename TInputImage , typename TOutputImage >
static Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< 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 >.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ProcessStatusList ( LayerType InputList,
const StatusType ChangeToStatus,
const StatusType SearchForStatus,
ThreadIdType  ThreadId 
)
protected
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PropagateAllLayerValues ( )
protected

Adjusts the values associated with all the index layers of the sparse field by propagating out one layer at a time from the active set. This method also takes care of deleting nodes from the layers which have been marked in the status image as having been moved to other layers.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PropagateLayerValues ( const StatusType from,
const StatusType to,
const StatusType promote,
unsigned int  InOrOut 
)
protected

Adjusts the values in a single layer "to" using values in a neighboring layer "from". The list of indices in "to" are traversed and assigned new values appropriately. Any indices in "to" without neighbors in "from" are moved into the "promote" layer (or deleted if "promote" is greater than the number of layers). "InOrOut" == 1 indicates this propagation is inwards (more negative). "InOrOut" == 0 indicates this propagation is outwards (more positive).

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

Set/Get the value of the isosurface to use in the input image.

template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SetNumberOfLayers ( StatusType  _arg)
virtual

Set/Get the number of layers to use in the sparse field. Argument is the number of layers on ONE side of the active layer, so the total layers in the sparse field is 2 * NumberOfLayers + 1

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SignalNeighbor ( unsigned int  SemaphoreArrayNumber,
ThreadIdType  ThreadId 
)
protected
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SignalNeighborsAndWait ( ThreadIdType  ThreadId)
protected
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedAllocateData ( ThreadIdType  ThreadId)
protected

Each thread allocates and initializes the data it will use by itself. This maintains the memory locality of data w.r.t. the thread in a shared memory environment.

template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedApplyUpdate ( const TimeStepType dt,
ThreadIdType  ThreadId 
)
protectedvirtual

Does the actual work of updating the output from the UpdateContainer over an output region supplied by the multithreading mechanism.

template<typename TInputImage , typename TOutputImage >
virtual TimeStepType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedCalculateChange ( ThreadIdType  ThreadId)
protectedvirtual

This method does the actual work of calculating change over a region supplied by the multithreading mechanism.

template<typename TInputImage , typename TOutputImage >
virtual ValueType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedCalculateUpdateValue ( const ThreadIdType  ,
const IndexType  ,
const TimeStepType dt,
const ValueType value,
const ValueType change 
)
inlineprotectedvirtual

This method allows a subclass to override the way in which updates to output values are applied during each iteration. The default simply follows the standard finite difference scheme of scaling the change by the timestep and adding to the value of the previous iteration.

Definition at line 526 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedInitializeData ( ThreadIdType  ThreadId,
const ThreadRegionType ThreadRegion 
)
protected
template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedInitializeIteration ( ThreadIdType  ThreadId)
protectedvirtual

If child classes need an entry point to the start of every iteration step they can override this method. This method is defined but empty in this class.

template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedLoadBalance ( ThreadIdType  ThreadId)
protectedvirtual

Redistribute an load among the threads to obtain a more balanced load distribution. This is performed in parallel by all the threads.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedPostProcessOutput ( const ThreadRegionType regionToProcess)
protected

Assign background pixels INSIDE the sparse field layers to a new level set with value less than the innermost layer. Assign background pixels OUTSIDE the sparse field layers to a new level set with value greater than the outermost layer.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedProcessFirstLayerStatusLists ( unsigned int  InputLayerNumber,
unsigned int  OutputLayerNumber,
const StatusType SearchForStatus,
unsigned int  InOrOut,
unsigned int  BufferLayerNumber,
ThreadIdType  ThreadId 
)
protected

Performs two tasks. The situation here is that ThreadedProcessStatusList has been called just once after the active layer values have been updated and the UpLists and DownLists formed. Some nodes are now moving into the active layer. The two tasks performed are:

  1. modify the status-image like it is performed by the ThreadedProcessStatusList.
  2. Update the values in the output-image for those nodes that are moving IN the active layer.
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedProcessOutsideList ( unsigned int  InputLayerNumber,
const StatusType ChangeToStatus,
unsigned int  InOrOut,
unsigned int  BufferLayerNumber,
ThreadIdType  ThreadId 
)
protected

Push each index in the input list into its appropriate status layer (ChangeToStatus) and ... ... update the status image value at that index

template<typename TInputImage , typename TOutputImage >
virtual void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedProcessPixelEnteringActiveLayer ( const IndexType ,
const ValueType ,
ThreadIdType   
)
protectedvirtual
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedProcessStatusList ( unsigned int  InputLayerNumber,
unsigned int  OutputLayerNumber,
const StatusType ChangeToStatus,
const StatusType SearchForStatus,
unsigned int  InOrOut,
unsigned int  BufferLayerNumber,
ThreadIdType  ThreadId 
)
protected

Push each index in the input list into its appropriate status layer (ChangeToStatus) and update the status image value at that index. Also examine the neighbors of the index, (with status SearchForStatus) to determine which need to go onto the output list.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedPropagateLayerValues ( const StatusType from,
const StatusType to,
const StatusType promote,
unsigned int  InorOut,
ThreadIdType  ThreadId 
)
protected
template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ThreadedUpdateActiveLayerValues ( const TimeStepType dt,
LayerType StatusUpList,
LayerType StatusDownList,
ThreadIdType  ThreadId 
)
protected
  1. Updates the values (in the output-image) of the nodes in the active layer that are moving OUT of the active layer. These values are used in the ThreadedProcessFirstLayerStatusLists() method to assign values for new nodes that are moving IN the active layer.
    1. This function also constructs the up/down lists for nodes that are moving out of the active layer.
template<typename TInputImage , typename TOutputImage >
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::typedef ( Concept::EqualityComparable< PixelType )

This class requires OutputEqualityComparableCheck in the form of ( Concept::EqualityComparable< PixelType > )

template<typename TInputImage , typename TOutputImage >
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< double, PixelType )

This class requires DoubleConvertibleToOutputCheck in the form of ( Concept::Convertible< double, PixelType > )

template<typename TInputImage , typename TOutputImage >
itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::typedef ( Concept::OStreamWritable< PixelType )

This class requires OutputOStreamWritableCheck in the form of ( Concept::OStreamWritable< PixelType > )

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::WaitForAll ( )
protected

Thread synchronization methods.

template<typename TInputImage , typename TOutputImage >
void itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::WaitForNeighbor ( unsigned int  SemaphoreArrayNumber,
ThreadIdType  ThreadId 
)
protected

Member Data Documentation

template<typename TInputImage , typename TOutputImage >
const unsigned int itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
static

Definition at line 277 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
Barrier::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_Barrier
protected

A global barrier used for synchronization between all threads.

Definition at line 714 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
unsigned int* itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_Boundary
protected

The boundaries defining thread regions

Definition at line 700 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
bool itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_BoundaryChanged
protected

A boolean variable stating if the boundaries had been changed during CheckLoadBalance()

Definition at line 697 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
bool itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_BoundsCheckingActive
private

This flag is true when methods need to check boundary conditions and false when methods do not need to check for boundary conditions.

Definition at line 788 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
double itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ConstantGradientValue
protected

The constant gradient to maintain between isosurfaces in the spare-field of the level-set image. This value defaults to 1.0

Definition at line 355 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ThreadData* itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_Data
protected

An array storing the individual (local) data structures for each thread.

Definition at line 766 of file itkParallelSparseFieldLevelSetImageFilter.h.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetActiveListForIndex().

template<typename TInputImage , typename TOutputImage >
int* itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_GlobalZHistogram
protected

Histogram of number of pixels in each Z plane for the entire 3D volume

Definition at line 703 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
bool itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_InterpolateSurfaceLocation
protected

This flag tells the solver whether or not to interpolate for the actual surface location when calculating change at each active layer node. By default this is turned on. Subclasses which do not sample propagation (speed), advection, or curvature terms should turn this flag off.

Definition at line 776 of file itkParallelSparseFieldLevelSetImageFilter.h.

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

The value in the input which represents the isosurface of interest.

Definition at line 414 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
LayerNodeStorageType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_LayerNodeStore
protected

Storage for layer node objects.

Definition at line 411 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
LayerListType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_Layers
protected

An array which contains all of the layers needed in the sparse field. Layers are organized as follows: m_Layer[0] = active layer, m_Layer[i:odd] = inside layer (i+1)/2, m_Layer[i:even] = outside layer i/2. This is used only during the initialization of the level set.

Definition at line 393 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
unsigned int* itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_MapZToThreadNumber
protected

The mapping from a z-value to the thread in whose region the z-value lies

Definition at line 707 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ParallelSparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > > itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_NeighborList
protected

Connectivity information for examining neighbor pixels.

Definition at line 351 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_NumberOfLayers
protected

The number of layers to use in the sparse field. Sparse field will consist of m_NumberOfLayers layers on both sides of a single active layer. This active layer is the interface of interest, i.e. the zero level set.

Definition at line 399 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ThreadIdType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_NumOfThreads
protected

For debugging. Writes the active layer set (grid-points closest to evolving interface) to a file. The number of threads to use.

Definition at line 687 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
OutputImageType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_OutputImage
protected

Definition at line 403 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
OutputImageType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_OutputImageTemp
protected

Definition at line 408 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
OutputImageType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ShiftedImage
protected

This image is a copy of the input with m_IsoSurfaceValue subtracted from each pixel. This way we only need to consider the zero level set in our calculations. Makes the implementation easier and more efficient. This is used only during the initialization of the level set.

Definition at line 387 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
unsigned int itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_SplitAxis
protected

The dimension along which to distribute the load.

Definition at line 690 of file itkParallelSparseFieldLevelSetImageFilter.h.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetActiveListForIndex().

template<typename TInputImage , typename TOutputImage >
StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusActiveChangingDown
staticprotected

Special status value which indicates a pending change to a more negative sparse field.

Definition at line 369 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusActiveChangingUp
staticprotected

Special status value which indicates a pending change to a more positive sparse field.

Definition at line 365 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusBoundaryPixel
staticprotected

Special status value which indicates a pixel is on the boundary of the image

Definition at line 381 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusChanging
staticprotected

Special status value which indicates pending change to another sparse field layer.

Definition at line 377 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusImageType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusImage
protected

An image of status values used internally by the algorithm.

Definition at line 402 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusImageType::Pointer itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusImageTemp
protected

Images used temporarily during the initialization of the thread data structures.

Definition at line 407 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
StatusType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusNull
staticprotected

Special status value used as a default for indices which have no meaningful status.

Definition at line 373 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
bool itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_Stop
protected

Used to check if there are too few pixels remaining. If yes, then we can stop iterating.

Definition at line 770 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ValueType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ValueOne
staticprotected

Multiplicative identity of the ValueType.

Definition at line 358 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ValueType itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ValueZero
staticprotected

Additive identity of the ValueType.

Definition at line 361 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
int* itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ZCumulativeFrequency
protected

Cumulative frequency of number of pixels in each Z plane for the entire 3D volume

Definition at line 711 of file itkParallelSparseFieldLevelSetImageFilter.h.

template<typename TInputImage , typename TOutputImage >
unsigned int itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ZSize
protected

The length of the dimension along which to distribute the load.

Definition at line 693 of file itkParallelSparseFieldLevelSetImageFilter.h.


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