Solve an Eikonal equation using Fast Marching. More...
#include <itkFastMarchingImageFilter.h>
Detailed Description
template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>
class itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
Solve an Eikonal equation using Fast Marching.
Fast marching solves an Eikonal equation where the speed is always non-negative and depends on the position only. Starting from an initial position on the front, fast marching systematically moves the front forward one grid point at a time.
Updates are preformed using an entropy satisfy scheme where only "upwind" neighborhoods are used. This implementation of Fast Marching uses a std::priority_queue to locate the next proper grid position to update.
Fast Marching sweeps through N grid points in (N log N) steps to obtain the arrival time value as the front propagates through the grid.
Implementation of this class is based on Chapter 8 of "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Second edition, 1999.
This class is templated over the level set image type and the speed image type. The initial front is specified by two containers: one containing the known points and one containing the trial points. Alive points are those that are already part of the object, and trial points are considered for inclusion. In order for the filter to evolve, at least some trial points must be specified. These can for instance be specified as the layer of pixels around the alive points.
The speed function can be specified as a speed image or a speed constant. The speed image is set using the method SetInput(). If the speed image is NULL, a constant speed function is used and is specified using method the SetSpeedConstant().
If the speed function is constant and of value one, fast marching results in an approximate distance function from the initial alive points. FastMarchingImageFilter is used in the ReinitializeLevelSetImageFilter object to create a signed distance function from the zero level set.
The algorithm can be terminated early by setting an appropriate stopping value. The algorithm terminates when the current arrival time being processed is greater than the stopping value.
There are two ways to specify the output image information ( LargestPossibleRegion, Spacing, Origin): (a) it is copied directly from the input speed image or (b) it is specified by the user. Default values are used if the user does not specify all the information.
The output information is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is set to true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
Possible Improvements: In the current implemenation, std::priority_queue only allows taking nodes out from the front and putting nodes in from the back. To update a value already on the heap, a new node is added to the heap. The defunct old node is left on the heap. When it is removed from the top, it will be recognized as invalid and not used. Future implementations can implement the heap in a different way allowing the values to be updated. This will generally require some sift-up and sift-down functions and an image of back-pointers going from the image to heap in order to locate the node which is to be updated.
- See also:
- LevelSetTypeDefault
Definition at line 104 of file itkFastMarchingImageFilter.h.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::ConstPointer |
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 112 of file itkFastMarchingImageFilter.h.
typedef DataObject::Pointer itk::ImageSource< TLevelSet >::DataObjectPointer [inherited] |
Smart Pointer type to a DataObject.
Reimplemented from itk::ProcessObject.
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.
| typedef Index<itkGetStaticConstMacro(SetDimension)> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::IndexType |
Index typedef support.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 160 of file itkFastMarchingImageFilter.h.
typedef InputImageType::ConstPointer itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputImageConstPointer [inherited] |
Definition at line 84 of file itkImageToImageFilter.h.
typedef InputImageType::PixelType itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputImagePixelType [inherited] |
Definition at line 86 of file itkImageToImageFilter.h.
typedef InputImageType::Pointer itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputImagePointer [inherited] |
Definition at line 83 of file itkImageToImageFilter.h.
typedef InputImageType::RegionType itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputImageRegionType [inherited] |
Definition at line 85 of file itkImageToImageFilter.h.
typedef TSpeedImage itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputImageType [inherited] |
Some convenient typedefs.
Definition at line 82 of file itkImageToImageFilter.h.
typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputToOutputRegionCopierType [protected, inherited] |
Typedef for the region copier function object that converts an input region to an output region.
Definition at line 164 of file itkImageToImageFilter.h.
typedef int itk::LightObject::InternalReferenceCountType [protected, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
Definition at line 139 of file itkLightObject.h.
| typedef LabelImageType::Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelImagePointer |
LabelImagePointer typedef support.
Definition at line 172 of file itkFastMarchingImageFilter.h.
| typedef Image<unsigned char, itkGetStaticConstMacro(SetDimension)> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelImageType |
LabelImage typedef support.
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 169 of file itkFastMarchingImageFilter.h.
| typedef LevelSetType::LevelSetImageType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetImageType |
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 122 of file itkFastMarchingImageFilter.h.
typedef LevelSetImageType::IndexType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetIndexType [protected] |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 326 of file itkFastMarchingImageFilter.h.
| typedef LevelSetType::LevelSetPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetPointer |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 123 of file itkFastMarchingImageFilter.h.
| typedef LevelSetTypeDefault<TLevelSet> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetType |
Typedef support of level set method types.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 118 of file itkFastMarchingImageFilter.h.
| typedef LevelSetType::NodeContainer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeContainer |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 126 of file itkFastMarchingImageFilter.h.
| typedef LevelSetType::NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeContainerPointer |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 127 of file itkFastMarchingImageFilter.h.
| typedef LevelSetType::NodeType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeType |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 125 of file itkFastMarchingImageFilter.h.
| typedef LevelSetImageType::DirectionType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputDirectionType |
Definition at line 131 of file itkFastMarchingImageFilter.h.
typedef Superclass::OutputImagePixelType itk::ImageToImageFilter< TSpeedImage , TLevelSet >::OutputImagePixelType [inherited] |
Reimplemented from itk::ImageSource< TLevelSet >.
Definition at line 79 of file itkImageToImageFilter.h.
typedef OutputImageType::Pointer itk::ImageSource< TLevelSet >::OutputImagePointer [inherited] |
Definition at line 69 of file itkImageSource.h.
typedef Superclass::OutputImageRegionType itk::ImageToImageFilter< TSpeedImage , TLevelSet >::OutputImageRegionType [inherited] |
Superclass typedefs.
Reimplemented from itk::ImageSource< TLevelSet >.
Definition at line 75 of file itkImageToImageFilter.h.
typedef TLevelSet itk::ImageSource< TLevelSet >::OutputImageType [inherited] |
Some convenient typedefs.
Definition at line 65 of file itkImageSource.h.
| typedef LevelSetImageType::PointType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputPointType |
Definition at line 132 of file itkFastMarchingImageFilter.h.
| typedef LevelSetImageType::RegionType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputRegionType |
Definition at line 129 of file itkFastMarchingImageFilter.h.
| typedef LevelSetImageType::SizeType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputSizeType |
Definition at line 128 of file itkFastMarchingImageFilter.h.
| typedef LevelSetImageType::SpacingType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputSpacingType |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 130 of file itkFastMarchingImageFilter.h.
typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TSpeedImage , TLevelSet >::OutputToInputRegionCopierType [protected, inherited] |
Typedef for the region copier function object that converts an output region to an input region.
Definition at line 169 of file itkImageToImageFilter.h.
| typedef LevelSetType::PixelType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::PixelType |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 124 of file itkFastMarchingImageFilter.h.
| typedef SmartPointer<Self> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Pointer |
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 111 of file itkFastMarchingImageFilter.h.
| typedef FastMarchingImageFilter itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Self |
Standard class typdedefs.
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 109 of file itkFastMarchingImageFilter.h.
| typedef SpeedImageType::ConstPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageConstPointer |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 150 of file itkFastMarchingImageFilter.h.
| typedef SpeedImageType::Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImagePointer |
SpeedImagePointer typedef support.
Definition at line 149 of file itkFastMarchingImageFilter.h.
| typedef TSpeedImage itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageType |
SpeedImage typedef support.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 146 of file itkFastMarchingImageFilter.h.
| typedef ImageSource<TLevelSet> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Superclass |
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 110 of file itkFastMarchingImageFilter.h.
Member Enumeration Documentation
| enum itk::FastMarchingImageFilter::LabelType |
Enum of Fast Marching algorithm point types. FarPoints represent far away points; TrialPoints represent points within a narrowband of the propagating front; and AlivePoints represent points which have already been processed.
Definition at line 166 of file itkFastMarchingImageFilter.h.
Constructor & Destructor Documentation
| itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter | ( | ) | [protected] |
| itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::~FastMarchingImageFilter | ( | ) | [inline, protected] |
Definition at line 299 of file itkFastMarchingImageFilter.h.
Member Function Documentation
| 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] |
Protected methods for setting inputs. Subclasses make use of them for setting input.
| 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
| unsigned long itk::Object::AddObserver | ( | const EventObject & | event, | |
| Command * | ||||
| ) | const [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] |
Protected methods for setting outputs. Subclasses make use of them for getting output.
| virtual void itk::ImageSource< TLevelSet >::AfterThreadedGenerateData | ( | void | ) | [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 265 of file itkImageSource.h.
| virtual void itk::ImageSource< TLevelSet >::AllocateOutputs | ( | ) | [protected, virtual, inherited] |
The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.
| virtual void itk::ImageSource< TLevelSet >::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 253 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().
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::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.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::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).
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::CollectPointsOff | ( | ) | [virtual] |
Get thConste Collect Points flag.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::CollectPointsOn | ( | ) | [virtual] |
Get thConste Collect Points flag.
| 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.
Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::CreateObjectFunction< T >, itk::TransformFactoryBase, itk::AnalyzeImageIOFactory, itk::BioRadImageIOFactory, itk::BMPImageIOFactory, itk::Brains2MaskImageIOFactory, itk::DICOMImageIO2Factory, itk::DicomImageIOFactory, itk::GDCMImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::GiplImageIOFactory, itk::JPEGImageIOFactory, itk::LSMImageIOFactory, itk::MetaImageIOFactory, itk::NiftiImageIOFactory, itk::NrrdImageIOFactory, itk::PNGImageIOFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::SiemensVisionImageIOFactory, itk::StimulateImageIOFactory, itk::TIFFImageIOFactory, itk::VTKImageIOFactory, itk::Bruker2DSEQImageIOFactory, itk::MatlabTransformIOFactory, itk::MINC2ImageIOFactory, itk::MRCImageIOFactory, itk::PhilipsRECImageIOFactory, itk::TxtTransformIOFactory, itk::VoxBoCUBImageIOFactory, itk::VTKImageIO2Factory, and itk::SpatialObjectFactoryBase.
| 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::FastMarchingImageFilter< TLevelSet, TSpeedImage >::EnlargeOutputRequestedRegion | ( | DataObject * | output | ) | [protected, virtual] |
Generate the output image meta information.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
| void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GenerateData | ( | void | ) | [protected, virtual] |
A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.
- See also:
- ThreadedGenerateData()
Reimplemented from itk::ImageSource< TLevelSet >.
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::GenerateInputRequestedRegion | ( | void | ) | [protected, virtual, inherited] |
What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.
This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.
- See also:
- ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()
Reimplemented from itk::ProcessObject.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GenerateOutputInformation | ( | ) | [protected, virtual] |
Generate the output image meta information.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
| 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< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.
| 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.
| NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetAlivePoints | ( | ) | [inline] |
Get the container of Alive Points representing the initial front.
Definition at line 184 of file itkFastMarchingImageFilter.h.
| virtual const bool& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetCollectPoints | ( | ) | [virtual] |
Get thConste Collect Points flag.
| 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.
| static bool itk::Object::GetGlobalWarningDisplay | ( | ) | [static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
| const InputImageType* itk::ImageToImageFilter< TSpeedImage , TLevelSet >::GetInput | ( | void | ) | [inherited] |
Set/Get the image input of this process object.
| const InputImageType* itk::ImageToImageFilter< TSpeedImage , TLevelSet >::GetInput | ( | unsigned int | idx | ) | [inherited] |
Set/Get the image input of this process object.
Reimplemented from itk::ProcessObject.
| const DataObject* itk::ProcessObject::GetInput | ( | unsigned int | idx | ) | const [protected, inherited] |
Method used internally for getting an input.
Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.
| 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.
| LabelImagePointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLabelImage | ( | ) | const [inline] |
Get the point type label image.
Definition at line 205 of file itkFastMarchingImageFilter.h.
| virtual const PixelType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLargeValue | ( | ) | [protected, virtual] |
Get Large Value. This value is used to represent the concept of infinity for the time assigned to pixels that have not been visited. This value is set by default to half the max() of the pixel type used to represent the time-crossing map.
| virtual const LevelSetIndexType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLastIndex | ( | ) | [protected, virtual] |
| MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | [inherited] |
- Returns:
- A reference to this objects MetaDataDictionary.
- Warning:
- This reference may be changed.
| const MetaDataDictionary& itk::Object::GetMetaDataDictionary | ( | void | ) | const [inherited] |
- Returns:
- A constant reference to this objects MetaDataDictionary.
| virtual unsigned long itk::Object::GetMTime | ( | ) | const [virtual, inherited] |
Return this objects modified time.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.
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.
| virtual const char* itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
| const AxisNodeType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNodeUsedInCalculation | ( | unsigned int | idx | ) | const [inline, protected] |
Definition at line 309 of file itkFastMarchingImageFilter.h.
| virtual double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNormalizationFactor | ( | ) | const [virtual] |
| 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.
| DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs | ( | ) | const [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 135 of file itkProcessObject.h.
| virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs | ( | ) | [protected, virtual, inherited] |
Protected methods for setting inputs. Subclasses make use of them for setting input.
| virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs | ( | ) | [protected, virtual, inherited] |
Protected methods for setting outputs. Subclasses make use of them for getting output.
| virtual const int& itk::ProcessObject::GetNumberOfThreads | ( | ) | [virtual, inherited] |
Get/Set the number of threads to create when executing.
Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().
| 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, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.
| OutputImageType* itk::ImageSource< TLevelSet >::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.
For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.
| OutputImageType* itk::ImageSource< TLevelSet >::GetOutput | ( | unsigned int | idx | ) | [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.
For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.
Reimplemented from itk::ProcessObject.
| const DataObject* itk::ProcessObject::GetOutput | ( | unsigned int | idx | ) | const [protected, inherited] |
Method used internally for getting an output.
| virtual const OutputDirectionType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputDirection | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual const OutputPointType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputOrigin | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual const OutputRegionType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputRegion | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| 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 OutputSizeType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputSize | ( | ) | const [inline, virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
Definition at line 268 of file itkFastMarchingImageFilter.h.
| virtual const OutputSpacingType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputSpacing | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual const bool& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOverrideOutputInformation | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetProcessedPoints | ( | ) | const [inline] |
Get the container of Processed Points. If the CollectPoints flag is set, the algorithm collects a container of all processed nodes. This is useful for defining creating Narrowbands for level set algorithms that supports narrow banding.
Definition at line 255 of file itkFastMarchingImageFilter.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.
Referenced by itk::XMLFilterWatcher::ShowProgress().
| virtual int itk::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 106 of file itkLightObject.h.
| virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag | ( | ) | [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 bool itk::ProcessObject::GetReleaseDataFlag | ( | ) | const [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.
| virtual const double& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetSpeedConstant | ( | ) | [virtual] |
Get the Speed Constant.
| virtual const LevelSetIndexType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetStartIndex | ( | ) | [protected, virtual] |
| virtual const double& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetStoppingValue | ( | ) | [virtual] |
Get the Fast Marching algorithm Stopping Value.
| NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetTrialPoints | ( | ) | [inline] |
Get the container of Trial Points representing the initial front.
Definition at line 199 of file itkFastMarchingImageFilter.h.
| static void itk::Object::GlobalWarningDisplayOff | ( | ) | [inline, static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Definition at line 100 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().
| static void itk::Object::GlobalWarningDisplayOn | ( | ) | [inline, static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Definition at line 98 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().
| virtual void itk::ImageSource< TLevelSet >::GraftNthOutput | ( | unsigned int | idx, | |
| DataObject * | output | |||
| ) | [virtual, inherited] |
Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to 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.
| virtual void itk::ImageSource< TLevelSet >::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).
| bool itk::Object::HasObserver | ( | const EventObject & | event | ) | const [inherited] |
Return true if an observer is registered for this event.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Initialize | ( | LevelSetImageType * | ) | [protected, virtual] |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
| void itk::Object::InvokeEvent | ( | const EventObject & | ) | [inherited] |
Call Execute on all the Commands observing this event id.
| 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.
| virtual DataObjectPointer itk::ImageSource< TLevelSet >::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.
| 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.
Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.
Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().
| static Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::Object.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OverrideOutputInformationOff | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OverrideOutputInformationOn | ( | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::PopBackInput | ( | ) | [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.
Reimplemented from itk::ProcessObject.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::PopFrontInput | ( | ) | [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.
Reimplemented from itk::ProcessObject.
| 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< 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] |
| void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::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::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| 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::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.
| virtual void itk::ProcessObject::PropagateResetPipeline | ( | ) | [protected, virtual, inherited] |
Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::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.
| void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::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 251 of file itkImageToImageFilter.h.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::PushFrontInput | ( | 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.
| void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::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 253 of file itkImageToImageFilter.h.
| 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] |
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::ReleaseDataBeforeUpdateFlagOn | ( | ) | [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.
| void itk::ProcessObject::ReleaseDataFlagOff | ( | ) | [inline, 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.
Definition at line 257 of file itkProcessObject.h.
| void itk::ProcessObject::ReleaseDataFlagOn | ( | ) | [inline, 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.
Definition at line 256 of file itkProcessObject.h.
| virtual void itk::ProcessObject::ReleaseInputs | ( | ) | [protected, virtual, inherited] |
A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.
- See also:
- InPlaceImageFilter::ReleaseInputs()
Reimplemented in itk::InPlaceImageFilter< TInputImage, TOutputImage >, itk::InPlaceLabelMapFilter< TInputImage >, itk::InPlaceImageFilter< TInputImage, TOutputImage >, itk::InPlaceImageFilter< TDeformationField, TDeformationField >, itk::InPlaceImageFilter< TInputImage1, Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >, itk::InPlaceImageFilter< TInputImage >, itk::InPlaceImageFilter< TInputImage, TSparseOutputImage >, itk::InPlaceImageFilter< TInputImage1, TOutputImage >, itk::InPlaceImageFilter< Image< TInputPixel1, NDimension >, Image< std::complex< TOutputPixel >, NDimension > >, itk::InPlaceImageFilter< TFeatureImage, TOutputImage >, itk::InPlaceImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, itk::InPlaceImageFilter< TLabelImage, TOutputImage >, itk::InPlaceImageFilter< FeatureImageType, ImageType >, itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >, itk::InPlaceImageFilter< TImage, TImage >, and itk::InPlaceLabelMapFilter< TImage >.
| void itk::Object::RemoveAllObservers | ( | ) | [inherited] |
Remove all observers .
| virtual void itk::ProcessObject::RemoveInput | ( | DataObject * | input | ) | [protected, virtual, inherited] |
Protected methods for setting inputs. Subclasses make use of them for setting input.
| 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] |
Protected methods for setting outputs. Subclasses make use of them for getting output.
| virtual void itk::ProcessObject::ResetPipeline | ( | ) | [virtual, inherited] |
| 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::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetAlivePoints | ( | NodeContainer * | points | ) | [inline] |
Set the container of Alive Points representing the initial front. Alive points are represented as a VectorContainer of LevelSetNodes.
Definition at line 176 of file itkFastMarchingImageFilter.h.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetCollectPoints | ( | bool | _arg | ) | [virtual] |
Set the Collect Points flag. Instrument the algorithm to collect a container of all nodes which it has visited. Useful for creating Narrowbands for level set algorithms that supports narrow banding.
| void itk::Object::SetDebug | ( | bool | debugFlag | ) | const [inherited] |
Set the value of the debug flag. A non-zero value turns debugging on.
| 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().
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::SetInput | ( | const InputImageType * | image | ) | [virtual, inherited] |
Set/Get the image input of this process object.
| virtual void itk::ImageToImageFilter< TSpeedImage , TLevelSet >::SetInput | ( | unsigned | int, | |
| const TSpeedImage * | image | |||
| ) | [virtual, inherited] |
Set/Get the image input of this process object.
| void itk::Object::SetMetaDataDictionary | ( | const MetaDataDictionary & | rhs | ) | [inherited] |
- Returns:
- Set the MetaDataDictionary
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetNormalizationFactor | ( | double | _arg | ) | [virtual] |
| 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.
Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.
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, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), 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< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().
| void itk::ProcessObject::SetNumberOfInputs | ( | unsigned int | num | ) | [protected, inherited] |
Called to allocate the input array. Copies old inputs.
| 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] |
Protected methods for setting inputs. Subclasses make use of them for setting input.
| virtual void itk::ProcessObject::SetNumberOfRequiredOutputs | ( | unsigned int | _arg | ) | [protected, virtual, inherited] |
Protected methods for setting outputs. Subclasses make use of them for getting output.
| virtual void itk::ProcessObject::SetNumberOfThreads | ( | int | _arg | ) | [virtual, inherited] |
Get/Set the number of threads to create when executing.
Reimplemented in itk::GradientMagnitudeRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::NonThreadedShrinkImageFilter< TInputImage, TOutputImage >, itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputDirection | ( | OutputDirectionType | _arg | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputOrigin | ( | OutputPointType | _arg | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputRegion | ( | OutputRegionType | _arg | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputSize | ( | const OutputSizeType & | size | ) | [inline, virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
Definition at line 266 of file itkFastMarchingImageFilter.h.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputSpacing | ( | OutputSpacingType | _arg | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOverrideOutputInformation | ( | bool | _arg | ) | [virtual] |
The output largeset possible, spacing and origin is computed as follows. If the speed image is NULL or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not NULL, the output information is copied from the input speed image.
| 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.
| void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetSpeedConstant | ( | double | value | ) | [inline] |
Set the Speed Constant. If the Speed Image is NULL, the SpeedConstant value is used for the whole level set. By default, the SpeedConstant is set to 1.0.
Definition at line 213 of file itkFastMarchingImageFilter.h.
| virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetStoppingValue | ( | double | _arg | ) | [virtual] |
Set the Fast Marching algorithm Stopping Value. The Fast Marching algorithm is terminated when the value of the smallest trial point is greater than the stopping value.
| void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetTrialPoints | ( | NodeContainer * | points | ) | [inline] |
Set the container of Trial Points representing the initial front. Trial points are represented as a VectorContainer of LevelSetNodes.
Definition at line 191 of file itkFastMarchingImageFilter.h.
| virtual int itk::ImageSource< TLevelSet >::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".
| virtual void itk::ImageSource< TLevelSet >::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()
| static ITK_THREAD_RETURN_TYPE itk::ImageSource< TLevelSet >::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 >.
| 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::FastMarchingImageFilter< TLevelSet, TSpeedImage >::UpdateNeighbors | ( | const IndexType & | index, | |
| const SpeedImageType * | , | |||
| LevelSetImageType * | ||||
| ) | [protected, virtual] |
Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
| 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 >, itk::VTKImageImport< TOutputImage >, and itk::watershed::Segmenter< InputImageType >.
| 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.
| virtual double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::UpdateValue | ( | const IndexType & | index, | |
| const SpeedImageType * | , | |||
| LevelSetImageType * | ||||
| ) | [protected, virtual] |
Member Data Documentation
const unsigned int itk::ImageToImageFilter< TSpeedImage , TLevelSet >::InputImageDimension [static, inherited] |
ImageDimension constants
Definition at line 90 of file itkImageToImageFilter.h.
OutputRegionType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_BufferedRegion [protected] |
Definition at line 323 of file itkFastMarchingImageFilter.h.
LevelSetIndexType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_LastIndex [protected] |
Definition at line 328 of file itkFastMarchingImageFilter.h.
TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited] |
Time when GenerateOutputInformation was last called.
Definition at line 431 of file itkProcessObject.h.
InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 144 of file itkLightObject.h.
SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 147 of file itkLightObject.h.
LevelSetIndexType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_StartIndex [protected] |
Definition at line 327 of file itkFastMarchingImageFilter.h.
bool itk::ProcessObject::m_Updating [protected, inherited] |
These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.
Definition at line 428 of file itkProcessObject.h.
const unsigned int itk::ImageToImageFilter< TSpeedImage , TLevelSet >::OutputImageDimension [static, inherited] |
ImageDimension constants
Reimplemented from itk::ImageSource< TLevelSet >.
Definition at line 92 of file itkImageToImageFilter.h.
const unsigned int itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetDimension = LevelSetType::SetDimension [static] |
Dimension of the level set and the speed image.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, and itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.
Definition at line 154 of file itkFastMarchingImageFilter.h.
const unsigned int itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageDimension = SpeedImageType::ImageDimension [static] |
Dimension of the level set and the speed image.
Definition at line 156 of file itkFastMarchingImageFilter.h.
The documentation for this class was generated from the following file:
