ITK: itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage

template<class TInputImage, class TOutputImage>

typedef SmartPointer<const Self> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 236 of file itkSparseFieldLevelSetImageFilter.h.

template<class TOutputImage>

typedef DataObject::Pointer itk::ImageSource< TOutputImage >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::StatisticsImageFilter< TInputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceFunction<TOutputImage> itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::FiniteDifferenceFunctionType [inherited]

The value type of the time step. This is distinct from PixelType because PixelType may often be a vector value, while the TimeStep is a scalar value.

Reimplemented in itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, itk::DenseFiniteDifferenceImageFilter< TDeformationField, TDeformationField >, and itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >.

Definition at line 150 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputImageType::IndexType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IndexType

Reimplemented in itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >.

Definition at line 250 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef InputImageType::ConstPointer itk::InPlaceImageFilter< TInputImage, TOutputImage >::InputImageConstPointer [inherited]

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

Definition at line 84 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef InputImageType::PixelType itk::InPlaceImageFilter< TInputImage, TOutputImage >::InputImagePixelType [inherited]

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

Definition at line 86 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef InputImageType::Pointer itk::InPlaceImageFilter< TInputImage, TOutputImage >::InputImagePointer [inherited]

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

Definition at line 83 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef InputImageType::RegionType itk::InPlaceImageFilter< TInputImage, TOutputImage >::InputImageRegionType [inherited]

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

Definition at line 85 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InputImageType

Information derived from the image types.

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

Reimplemented in itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, and itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

Definition at line 245 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TInputImage, TOutputImage >::InputToOutputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 163 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef std::vector<LayerPointerType> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerListType

A type for a list of LayerPointerTypes

Definition at line 266 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ObjectStore<LayerNodeType> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerNodeStorageType

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

Definition at line 278 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SparseFieldLevelSetNode<IndexType> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerNodeType

Node type used in sparse field layer lists.

Definition at line 259 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef LayerType::Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerPointerType

Definition at line 263 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SparseFieldLayer<LayerNodeType> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerType

A list type used in the algorithm.

Reimplemented in itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >.

Definition at line 262 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef Superclass::OutputImagePixelType itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImagePixelType [inherited]

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 79 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef Superclass::OutputImagePointer itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImagePointer [inherited]

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 77 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

typedef Superclass::OutputImageRegionType itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType [inherited]

Superclass typedefs.

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

Definition at line 78 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::OutputImageType

Superclass typedefs.

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

Definition at line 249 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TInputImage, TOutputImage >::OutputToInputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 168 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage::PixelType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PixelType [inherited]

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

Reimplemented in itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, itk::DenseFiniteDifferenceImageFilter< TDeformationField, TDeformationField >, and itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >.

Definition at line 145 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SmartPointer<Self> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 235 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SparseFieldLevelSetImageFilter itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs

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

Definition at line 233 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef Image<StatusType, itkGetStaticConstMacro(ImageDimension)> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::StatusImageType

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

Definition at line 274 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef signed char itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::StatusType

Type used for storing status information

Definition at line 269 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceImageFilter<TInputImage, TOutputImage> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 234 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef Superclass::TimeStepType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::TimeStepType

Typedefs from the superclass

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

Reimplemented in itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, and itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

Definition at line 239 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef std::vector<ValueType> itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::UpdateBufferType

Container type used to store updates to the active layer.

Definition at line 281 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputImageType::ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ValueType

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

Definition at line 256 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

enum itk::FiniteDifferenceImageFilter::FilterStateType [inherited]

Enumerator:

UNINITIALIZED
INITIALIZED

Definition at line 153 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SparseFieldLevelSetImageFilter ( ) [protected]

template<class TInputImage, class TOutputImage>

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::~SparseFieldLevelSetImageFilter ( ) [protected]

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AfterThreadedGenerateData ( ) [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 254 of file itkImageSource.h.

template<class TInputImage, class TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::AllocateOutputs ( ) [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( ) [protected, virtual]

Reserves memory in the update buffer. Called before each iteration.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( TimeStepType dt ) [protected, pure virtual, inherited]

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

Parameters:

dt

Time step value.

Implemented in itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( TimeStepType dt ) [protected]

Applies the update buffer values to the active layer and reconstructs the sparse field layers for the next iteration.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::BeforeThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 242 of file itkImageSource.h.

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

template<class TInputImage, class TOutputImage>

TimeStepType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CalculateChange ( ) [protected, virtual]

Traverses the active layer list and calculates the change at these indicies to be applied in the current iteration.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CalculateUpdateValue	(	const IndexType &	,
		const TimeStepType &	dt,
		const ValueType &	value,
		const ValueType &	change
	)			`[inline, protected, virtual]`

This function 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 336 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

template<class TInputImage, class TOutputImage = TInputImage>

bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::CanRunInPlace ( ) const [inline, inherited]

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true.

Definition at line 108 of file itkInPlaceImageFilter.h.

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< 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<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstructLayer	(	StatusType	from,
		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<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( ) [protected, virtual]

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 >.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual, inherited]

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.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

FiniteDifferenceImageFilter needs a larger input requested region than the output requested region. As such, we need to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

: The filter will ask for a padded region to perform its neighborhood calculations. If no such region is available, the boundaries will be handled as described in the FiniteDifferenceFunction defined by the subclass.

See also:: ProcessObject::GenerateInputRequestedRegion()

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

Reimplemented in itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

virtual void itk::ProcessObject::GenerateOutputInformation ( ) [protected, virtual, inherited]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

virtual void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual, inherited]

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>, and itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class TInputImage, class TOutputImage>

virtual const FiniteDifferenceFunctionType ::Pointer& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetDifferenceFunction ( ) const [virtual, inherited]

This method returns a pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns:: A FiniteDifferenceObject pointer.

template<class TInputImage, class TOutputImage>

virtual const unsigned int& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetElapsedIterations ( ) [virtual, inherited]

Get the number of elapsed iterations of the filter.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

template<class TInputImage, class TOutputImage = TInputImage>

virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetInPlace ( ) [virtual, inherited]

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

template<class TInputImage, class TOutputImage>

const InputImageType* itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( unsigned int idx ) [inherited]

Method used internally for getting an input.

Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage>

const InputImageType* itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput ( void ) [inherited]

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

virtual bool itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetInterpolateSurfaceLocation ( ) [virtual]

template<class TInputImage, class TOutputImage>

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetIsoSurfaceValue ( ) [virtual]

template<class TInputImage, class TOutputImage>

virtual const bool& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetManualReinitialization ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual const double& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetMaximumRMSError ( ) [virtual, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

virtual const char* itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

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

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

virtual const unsigned int& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetNumberOfIterations ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual unsigned int itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetNumberOfLayers ( ) [virtual]

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

Definition at line 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

template<class TOutputImage>

OutputImageType* itk::ImageSource< TOutputImage >::GetOutput ( unsigned int idx ) [inherited]

Method used internally for getting an output.

Reimplemented from itk::ProcessObject.

template<class TOutputImage>

OutputImageType* itk::ImageSource< TOutputImage >::GetOutput ( void ) [inherited]

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual const double& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetRMSChange ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual const FilterStateType& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetState ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual const bool& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetValueOne ( ) const [protected, virtual]

template<class TInputImage, class TOutputImage>

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetValueZero ( ) const [protected, virtual]

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

Graft the specified data object onto this ProcessObject's idx'th output. This is the similar to GraftOutput method except is allows you specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * output ) [virtual, inherited]

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

template<class TInputImage, class TOutputImage>

virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Halt ( ) [protected, virtual, inherited]

This method returns true when the current iterative solution of the equation has met the criteria to stop solving. Defined by a subclass.

Reimplemented in itk::AnisotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::IsotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >, and itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Initialize ( ) [protected, virtual]

Constructs the sparse field layers and initializes their values.

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

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues ( ) [protected]

Initializes the values of the active layer set.

template<class TInputImage, class TOutputImage>

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeBackgroundPixels ( ) [protected, virtual]

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<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InitializeIteration ( ) [inline, protected, virtual, inherited]

This method is optionally defined by a subclass and is called immediately prior to each iterative CalculateChange-ApplyUpdate cycle. It can be used to set global variables needed for the next iteration (ie. average gradient magnitude of the image in anisotropic diffusion functions), or otherwise prepare for the next iteration.

Definition at line 300 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceOff ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceOn ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InterpolateSurfaceLocationOff ( ) [inline]

Definition at line 311 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InterpolateSurfaceLocationOn ( ) [inline]

See Get/SetInterpolateSurfaceLocation

Definition at line 309 of file itkSparseFieldLevelSetImageFilter.h.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TInputImage, class TOutputImage = TInputImage>

itk::InPlaceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro	(	OutputImageDimension	,
		unsigned	int,
		TOutputImage::ImageDimension
	)			`[inherited]`

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

template<class TInputImage, class TOutputImage = TInputImage>

itk::InPlaceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned	int,
		TInputImage::ImageDimension
	)			`[inherited]`

ImageDimension constants

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

Reimplemented in itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >, itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >, itk::RelabelComponentImageFilter< TInputImage, TOutputImage >, itk::NaryFunctorImageFilter< TInputImage, TOutputImage, itk::Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >, and itk::NaryFunctorImageFilter< TInputImage, TOutputImage, itk::Functor::Maximum1< TInputImage::PixelType, TInputImage::PixelType > >.

template<class TInputImage, class TOutputImage>

itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		OutputImageType::ImageDimension
	)			`[inherited]`

Dimensionality of input and output data is assumed to be the same.

template<class TInputImage, class TOutputImage>

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		TOutputImage::ImageDimension
	)

template<class TOutputImage>

virtual DataObjectPointer itk::ImageSource< TOutputImage >::MakeOutput ( unsigned int idx ) [virtual, inherited]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Reimplemented in itk::EigenAnalysis2DImageFilter< TInputImage, TEigenValueImage, TEigenVectorImage >, itk::MinimumMaximumImageFilter< TInputImage >, and itk::StatisticsImageFilter< TInputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ManualReinitializationOff ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ManualReinitializationOn ( ) [virtual, inherited]

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputImage, class TOutputImage>

static Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput ( ) [virtual, inherited]

Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::PopFrontInput ( ) [virtual, inherited]

Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage>

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PostProcessOutput ( ) [protected, virtual]

This method packages the output(s) into a consistent format. The default implementation produces a volume with the final solution values in the sparse field, and inside and outside values elsewhere as appropriate.

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

virtual void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TInputImage, class TOutputImage>

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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 >.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ProcessOutsideList	(	LayerType *	OutsideList,
		StatusType	ChangeToStatus
	)			`[protected]`

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ProcessStatusList	(	LayerType *	InputList,
		LayerType *	OutputList,
		StatusType	ChangeToStatus,
		StatusType	SearchForStatus
	)			`[protected]`

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< 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<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PropagateLayerValues	(	StatusType	from,
		StatusType	to,
		StatusType	promote,
		int	InOrOut
	)			`[protected]`

Adjusts the values in a single layer "to" using values in a neighboring layer "from". The list of indicies in "to" are traversed and assigned new values appropriately. Any indicies 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" == 2 indicates this propagation is outwards (more positive).

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented in itk::VTKImageImport< TOutputImage >.

virtual void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

template<class TInputImage, class TOutputImage>

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput ( const DataObject * input ) [inline, protected, virtual, inherited]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 250 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput ( const InputImageType * image ) [virtual, inherited]

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

template<class TInputImage, class TOutputImage>

void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput ( const DataObject * input ) [inline, protected, virtual, inherited]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 252 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput ( const InputImageType * image ) [virtual, inherited]

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, inherited]

void itk::ProcessObject::ReleaseDataFlagOff ( ) [inline, inherited]

Definition at line 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

Definition at line 256 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs ( ) [protected, virtual, inherited]

InPlaceImageFilter may transfer ownership of the input bulk data to the output object. Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See also:: ProcessObject::ReleaseInputs()

Reimplemented from itk::ProcessObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

virtual void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::ProcessObject::RemoveOutput ( DataObject * output ) [protected, virtual, inherited]

virtual void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

template<class TInputImage, class TOutputImage>

virtual TimeStepType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ResolveTimeStep	(	const TimeStepType *	timeStepList,
		const bool *	valid,
		int	size
	)			`[protected, virtual, inherited]`

Virtual method for resolving a single time step from a set of time steps returned from processing threads.

Returns:: Time step (dt) for the iteration update based on a list of time steps generated from the threaded calculated change method (one for each region processed).

Parameters:

	timeStepList	The set of time changes compiled from all the threaded calls to ThreadedGenerateData.
	valid	The set of flags indicating which of "list" elements are valid
	size	The size of "list" and "valid"

The default is to return the minimum value in the list.

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( ) [protected, virtual, inherited]

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetDifferenceFunction ( FiniteDifferenceFunctionType * _arg ) [virtual, inherited]

This method sets the pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns:: A FiniteDifferenceObject pointer.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetElapsedIterations ( unsigned int _arg ) [protected, virtual, inherited]

Set the number of elapsed iterations of the filter.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TInputImage, class TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::SetInPlace ( bool _arg ) [virtual, inherited]

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput	(	unsigned	int,
		const TInputImage *	image
	)			`[virtual, inherited]`

Reimplemented in itk::WatershedImageFilter< TInputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput ( const InputImageType * image ) [virtual, inherited]

Set/Get the image input of this process object.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SetInterpolateSurfaceLocation ( bool _arg ) [virtual]

Get the RMS change calculated in the PREVIOUS iteration. This value is the square root of the average square of the change value of all pixels updated during the previous iteration. Get/Set the value of the InterpolateSurfaceLocation flag. This flag tells the solver whether or not to interpolate for the surface location when calculating change at a voxel location. Turned on by default. Some applications may not use this value and can safely turn the flag off.

template<class TInputImage, class TOutputImage>

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SetIsoSurfaceValue ( ValueType _arg ) [virtual]

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

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetManualReinitialization ( bool _arg ) [virtual, inherited]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetMaximumRMSError ( double _arg ) [virtual, inherited]

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

Protected methods for setting inputs. Subclasses make use of them for setting input.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::SetInputImage(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >::SetInputSegmentTable(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetReferenceImage(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

Protected methods for setting outputs. Subclasses make use of them for getting output.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< TInputImage >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::SetOutputImage(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< TInputImage >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetNumberOfIterations ( unsigned int _arg ) [virtual, inherited]

Set/Get the number of iterations that the filter will run.

template<class TInputImage, class TOutputImage>

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SetNumberOfLayers ( unsigned int _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

Reimplemented in itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

Get/Set the number of threads to create when executing.

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetRMSChange ( double _arg ) [virtual, inherited]

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetState ( FilterStateType _arg ) [virtual, inherited]

Set/Get the state of the filter.

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetStateToInitialized ( ) [inline, inherited]

Set the state of the filter to INITIALIZED

Definition at line 195 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetStateToUninitialized ( ) [inline, inherited]

Set the state of the filter to UNINITIALIZED

Definition at line 201 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetUseImageSpacing ( bool _arg ) [virtual, inherited]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOff.

template<class TOutputImage>

virtual int itk::ImageSource< TOutputImage >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)			`[protected, virtual, inherited]`

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, virtual, inherited]`

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

See also:: GenerateData(), SplitRequestedRegion()

template<class TInputImage, class TOutputImage>

virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ThreadedHalt ( void * ) [inline, protected, virtual, inherited]

This method is similar to Halt(), and its default implementation in this class is simply to call Halt(). However, this method takes as a parameter a void pointer to the MultiThreader::ThreadInfoStruct structure. If you override this method instead of overriding Halt, you will be able to get the current thread ID and handle the Halt method accordingly. This is useful if you are doing a lot of processing in Halt that you don't want parallelized. Notice that ThreadedHalt is only called by the multithreaded filters, so you still should implement Halt, just in case a non-threaded filter is used.

Definition at line 285 of file itkFiniteDifferenceImageFilter.h.

template<class TOutputImage>

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TOutputImage >::ThreaderCallback ( void * arg ) [static, protected, inherited]

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::Update ( ) [virtual, inherited]

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::UpdateActiveLayerValues	(	TimeStepType	dt,
		LayerType *	StatusUpList,
		LayerType *	StatusDownList
	)			`[protected]`

Updates the active layer values using m_UpdateBuffer. Also creates an "up" and "down" list for promotion/demotion of indicies leaving the active set.

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

virtual void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateOutputInformation ( ) [virtual, inherited]

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented in itk::watershed::Segmenter< TInputImage >, and itk::VTKImageImport< TOutputImage >.

void itk::ProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::UseImageSpacingOff ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::UseImageSpacingOn ( ) [virtual, inherited]

template<class TInputImage, class TOutputImage>

double itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ConstantGradientValue [static, protected]

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

Definition at line 426 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

bool itk::SparseFieldLevelSetImageFilter< 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 492 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_IsoSurfaceValue [protected]

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

Definition at line 477 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

LayerNodeStorageType::Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_LayerNodeStore [protected]

Storage for layer node objects.

Definition at line 474 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

LayerListType itk::SparseFieldLevelSetImageFilter< 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

Definition at line 463 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

double itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_MaximumRMSError [protected, inherited]

Definition at line 330 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

SparseFieldCityBlockNeighborList<NeighborhoodIterator<OutputImageType> > itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_NeighborList [protected]

Connectivity information for examining neighbor pixels.

Definition at line 418 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

unsigned int itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_NumberOfIterations [protected, inherited]

The maximum number of iterations this filter will run

Definition at line 327 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

unsigned int itk::SparseFieldLevelSetImageFilter< 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 468 of file itkSparseFieldLevelSetImageFilter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

template<class TInputImage, class TOutputImage>

double itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_RMSChange [protected, inherited]

Definition at line 329 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

OutputImageType::Pointer itk::SparseFieldLevelSetImageFilter< 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.

Definition at line 457 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusActiveChangingDown [static, protected]

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

Definition at line 444 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusActiveChangingUp [static, protected]

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

Definition at line 440 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusBoundaryPixel [static, protected]

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

Definition at line 448 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusChanging [static, protected]

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

Definition at line 436 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

StatusImageType::Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusImage [protected]

An image of status values used internally by the algorithm.

Definition at line 471 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusNull [static, protected]

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

Definition at line 452 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

UpdateBufferType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_UpdateBuffer [protected]

The update buffer used to store change values computed in CalculateChange.

Definition at line 481 of file itkSparseFieldLevelSetImageFilter.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ValueOne [static, protected]

Multiplicative identity of the ValueType.

Definition at line 429 of file itkSparseFieldLevelSetImageFilter.h.

template<class TInputImage, class TOutputImage>

ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ValueZero [static, protected]

Additive identity of the ValueType.

Definition at line 432 of file itkSparseFieldLevelSetImageFilter.h.

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage > Class Template Reference

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
enum	FilterStateType { UNINITIALIZED = 0, INITIALIZED = 1 }
typedef FiniteDifferenceFunction< TOutputImage >	FiniteDifferenceFunctionType
typedef OutputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef std::vector< LayerPointerType >	LayerListType
typedef ObjectStore< LayerNodeType >	LayerNodeStorageType
typedef SparseFieldLevelSetNode< IndexType >	LayerNodeType
typedef LayerType::Pointer	LayerPointerType
typedef SparseFieldLayer< LayerNodeType >	LayerType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef TOutputImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef SparseFieldLevelSetImageFilter	Self
typedef Image< StatusType, itkGetStaticConstMacro(ImageDimension)>	StatusImageType
typedef signed char	StatusType
typedef FiniteDifferenceImageFilter< TInputImage, TOutputImage >	Superclass
typedef Superclass::TimeStepType	TimeStepType
typedef std::vector< ValueType >	UpdateBufferType
typedef OutputImageType::ValueType	ValueType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const
virtual const unsigned int &	GetElapsedIterations ()
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, OutputImageType::ImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	SetStateToInitialized ()
void	SetStateToUninitialized ()
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

bool	CanRunInPlace () const

virtual bool	GetInPlace ()
virtual void	InPlaceOff ()
virtual void	InPlaceOn ()
virtual void	SetInPlace (bool _arg)

const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetInput (const InputImageType *image)

virtual bool	GetInterpolateSurfaceLocation ()
virtual void	SetInterpolateSurfaceLocation (bool _arg)

virtual ValueType	GetIsoSurfaceValue ()
virtual void	SetIsoSurfaceValue (ValueType _arg)

virtual const bool &	GetManualReinitialization ()
virtual void	ManualReinitializationOff ()
virtual void	ManualReinitializationOn ()
virtual void	SetManualReinitialization (bool _arg)

virtual const double &	GetMaximumRMSError ()
virtual void	SetMaximumRMSError (double _arg)

virtual const unsigned int &	GetNumberOfIterations ()
virtual void	SetNumberOfIterations (unsigned int _arg)

virtual unsigned int	GetNumberOfLayers ()
virtual void	SetNumberOfLayers (unsigned int _arg)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
DataObjectPointerArray &	GetOutputs ()

virtual const int &	GetNumberOfThreads ()
virtual void	SetNumberOfThreads (int _arg)

OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput (void)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetReleaseDataFlag (bool flag)

virtual const double &	GetRMSChange ()
virtual void	SetRMSChange (double _arg)

virtual const FilterStateType &	GetState ()
virtual void	SetState (FilterStateType _arg)

virtual const bool &	GetUseImageSpacing ()
virtual void	SetUseImageSpacing (bool _arg)
virtual void	UseImageSpacingOff ()
virtual void	UseImageSpacingOn ()

void	InterpolateSurfaceLocationOff ()
void	InterpolateSurfaceLocationOn ()

	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)

virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType
Protected Member Functions
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
void	AllocateUpdateBuffer ()
virtual void	ApplyUpdate (TimeStepType dt)=0
void	ApplyUpdate (TimeStepType dt)
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
TimeStepType	CalculateChange ()
virtual ValueType	CalculateUpdateValue (const IndexType &, const TimeStepType &dt, const ValueType &value, const ValueType &change)
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	ConstructActiveLayer ()
void	ConstructLayer (StatusType from, StatusType to)
void	CopyInputToOutput ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual ValueType	GetValueOne () const
virtual ValueType	GetValueZero () const
virtual bool	Halt ()
void	Initialize ()
void	InitializeActiveLayerValues ()
virtual void	InitializeBackgroundPixels ()
virtual void	InitializeIteration ()
virtual void	PostProcessOutput ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)
void	ProcessStatusList (LayerType InputList, LayerType OutputList, StatusType ChangeToStatus, StatusType SearchForStatus)
void	PropagateAllLayerValues ()
void	PropagateLayerValues (StatusType from, StatusType to, StatusType promote, int InOrOut)
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual TimeStepType	ResolveTimeStep (const TimeStepType timeStepList, const bool valid, int size)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetElapsedIterations (unsigned int _arg)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
	SparseFieldLevelSetImageFilter ()
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual bool	ThreadedHalt (void *)
void	UpdateActiveLayerValues (TimeStepType dt, LayerType StatusUpList, LayerType StatusDownList)
	~SparseFieldLevelSetImageFilter ()

virtual void	AddInput (DataObject *input)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	AddOutput (DataObject *output)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

const DataObject *	GetInput (unsigned int idx) const

const DataObject *	GetOutput (unsigned int idx) const

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
bool	m_InterpolateSurfaceLocation
ValueType	m_IsoSurfaceValue
LayerNodeStorageType::Pointer	m_LayerNodeStore
LayerListType	m_Layers
double	m_MaximumRMSError
SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >	m_NeighborList
unsigned int	m_NumberOfIterations
unsigned int	m_NumberOfLayers
TimeStamp	m_OutputInformationMTime
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
double	m_RMSChange
OutputImageType::Pointer	m_ShiftedImage
StatusImageType::Pointer	m_StatusImage
UpdateBufferType	m_UpdateBuffer
bool	m_Updating
Static Protected Attributes
static double	m_ConstantGradientValue
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

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage > Class Template Reference

Detailed Description

template<class TInputImage, class TOutputImage> class itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage, class TOutputImage>
class itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >