template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>
class itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >
A base class which defines the API for implementing a special class of image segmentation filters using level set methods.
- OVERVIEW
- This object defines the framework for a class of segmentation filters which use level set methods. These filters work by constructing a "feature image" onto which the evolving level set locks as it moves. In the feature image, values that are close to zero are associated with object boundaries. An original (or preprocessed) image is given to the filter as the feature image and a seed for the level set is given as the input of the filter. The seed is converted into a level set embedding which propagates according to the features calculated from the original image.
- TEMPLATE PARAMETERS
- There are two required and one optional template parameter for these filters.
TInputImage is the image type of the initial model you will input to the filter using SetInput() or SetInitialImage().
TFeatureImage is the image type of the image from which the filter will calculate the speed term for segmentation (see INPUTS).
TOutputPixelType is the data type used for the output image phi, the implicit level set image. This should really only ever be set as float (default) or double.
- INPUTS
- The input to any subclass of this filter is the seed image for the initial level set embedding. As with other subclasses of the SparseLevelSetImageFilter, the type of the input image is is not important. The (RequestedRegion) size of the seed image must, however, match the (RequestedRegion) size of the feature image.
You must identify the initial front (surface) in the input image. You do this by specifying its isovalue through the method SetIsoSurfaceValue(float f). The algorithm will then initialize its solution using the front represented by value f. Note that the front is always represented by isosurface zero in the output and not the isosurface you specified for the input. This is because, for simplicity, the filter will shift your input image so that the active front has zero values.
- Depending on the particular application and filter that you are using, the feature image should be preprocessed with some type of noise reduction filtering. The feature image input can be of any type, but it will be cast to floating point before calculations are done.
- OUTPUTS
- The output of any subclass of this filter is a level set embedding as described in SparseFieldLevelSetImageFilter. The zero crossings of the output image give the pixels closest to the level set boundary. By ITK convention, NEGATIVE values are pixels INSIDE the segmented region and POSITIVE values are pixels OUTSIDE the segmented region.
- PARAMETERS
- The MaximumRMSChange parameter is used to determine when the solution has converged. A lower value will result in a tighter-fitting solution, but will require more computations. Too low a value could put the solver into an infinite loop unless a reasonable NumberOfIterations parameter is set. Values should always be greater than 0.0 and less than 1.0.
- The NumberOfIterations parameter can be used to halt the solution after a specified number of iterations, overriding the MaximumRMSChange halting criteria.
- The standard convention for ITK level-set segmentation filters is that POSITIVE propagation (speed) and advection terms cause the surface to EXPAND while negative terms cause the surface to CONTRACT. When the ReverseExpansionDirection parameter is set to TRUE (on), it tells the function object to reverse the standard ITK convention so that NEGATIVE terms cause EXPANSION and positive terms cause CONTRACTION.
This parameter can be safely changed as appropriate for a particular application or data set to achieve the desired behavior.
- The FeatureScaling parameter controls the magnitude of the features calculated for use in the level set propagation and advection speeds. This value simply sets both parameters to equal values at once. Some filters may only use on of these two terms and this method is a generic way to set either or both without having to know which is in use.
- The CurvatureScaling parameter controls the magnitude of the curvature values which are calculated on the evolving isophote. This is important in controlling the relative effect of curvature in the calculation. Default value is 1.0. Higher values relative to the other level set equation terms (propagation and advection) will give a smoother result.
- The PropagationScaling parameter controls the scaling of the scalar propagation (speed) term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.
- The AdvectionScaling parameter controls the scaling of the vector advection field term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.
- Warning
- This is an abstract class. It is not intended to be instantiated by itself. Instead, you should use the derived classes. This is the reason why the New() operator (itkNewMacro) is missing from the class API.
- See LevelSetFunction for more information.
Definition at line 146 of file itkSegmentationLevelSetImageFilter.h.
|
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | FeatureImageType = TFeatureImage |
| |
| using | IndexType = typename Superclass::IndexType |
| |
| using | InputImageType = typename Superclass::InputImageType |
| |
| using | OutputImageType = Image< TOutputPixelType, Self::InputImageDimension > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | SegmentationFunctionType = SegmentationLevelSetFunction< OutputImageType, FeatureImageType > |
| |
| using | Self = SegmentationLevelSetImageFilter |
| |
| using | SpeedImageType = typename SegmentationFunctionType::ImageType |
| |
| using | Superclass = SparseFieldLevelSetImageFilter< TInputImage, OutputImageType > |
| |
| using | TimeStepType = typename Superclass::TimeStepType |
| |
| using | ValueType = typename Superclass::ValueType |
| |
| using | VectorImageType = typename SegmentationFunctionType::VectorImageType |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | IndexType = typename OutputImageType::IndexType |
| |
| using | InputImageType = TInputImage |
| |
| using | LayerListType = std::vector< LayerPointerType > |
| |
| using | LayerNodeStorageType = ObjectStore< LayerNodeType > |
| |
| using | LayerNodeType = SparseFieldLevelSetNode< IndexType > |
| |
| using | LayerPointerType = typename LayerType::Pointer |
| |
| using | LayerType = SparseFieldLayer< LayerNodeType > |
| |
| using | NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType |
| |
| using | OutputImageType = Image< TOutputPixelType, TInputImage::ImageDimension > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | RadiusType = typename Superclass::RadiusType |
| |
| using | Self = SparseFieldLevelSetImageFilter |
| |
| using | StatusImageType = Image< StatusType, Self::ImageDimension > |
| |
| using | StatusType = signed char |
| |
| using | Superclass = FiniteDifferenceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > > |
| |
| using | TimeStepType = typename Superclass::TimeStepType |
| |
| using | UpdateBufferType = std::vector< ValueType > |
| |
| using | ValueType = typename OutputImageType::ValueType |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | FiniteDifferenceFunctionType = FiniteDifferenceFunction< Image< TOutputPixelType, TInputImage::ImageDimension > > |
| |
| using | InputImageType = TInputImage |
| |
| using | InputPixelType = typename TInputImage::PixelType |
| |
| using | InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType |
| |
| using | NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType |
| |
| using | OutputImageType = Image< TOutputPixelType, TInputImage::ImageDimension > |
| |
| using | OutputPixelType = typename Image< TOutputPixelType, TInputImage::ImageDimension >::PixelType |
| |
| using | OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType |
| |
| using | PixelType = OutputPixelType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | RadiusType = typename FiniteDifferenceFunctionType::RadiusType |
| |
| using | Self = FiniteDifferenceImageFilter |
| |
| using | Superclass = InPlaceImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > > |
| |
| using | TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | InputImageConstPointer = typename InputImageType::ConstPointer |
| |
| using | InputImagePixelType = typename InputImageType::PixelType |
| |
| using | InputImagePointer = typename InputImageType::Pointer |
| |
| using | InputImageRegionType = typename InputImageType::RegionType |
| |
| using | InputImageType = TInputImage |
| |
| using | OutputImagePixelType = typename Superclass::OutputImagePixelType |
| |
| using | OutputImagePointer = typename Superclass::OutputImagePointer |
| |
| using | OutputImageRegionType = typename Superclass::OutputImageRegionType |
| |
| using | OutputImageType = typename Superclass::OutputImageType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = InPlaceImageFilter |
| |
| using | Superclass = ImageToImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > > |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | InputImageConstPointer = typename InputImageType::ConstPointer |
| |
| using | InputImagePixelType = typename InputImageType::PixelType |
| |
| using | InputImagePointer = typename InputImageType::Pointer |
| |
| using | InputImageRegionType = typename InputImageType::RegionType |
| |
| using | InputImageType = TInputImage |
| |
| using | OutputImagePixelType = typename Superclass::OutputImagePixelType |
| |
| using | OutputImageRegionType = typename Superclass::OutputImageRegionType |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = ImageToImageFilter |
| |
| using | Superclass = ImageSource< Image< TOutputPixelType, TInputImage::ImageDimension > > |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | DataObjectIdentifierType = Superclass::DataObjectIdentifierType |
| |
| using | DataObjectPointer = DataObject::Pointer |
| |
| using | DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType |
| |
| using | OutputImagePixelType = typename OutputImageType::PixelType |
| |
| using | OutputImagePointer = typename OutputImageType::Pointer |
| |
| using | OutputImageRegionType = typename OutputImageType::RegionType |
| |
| using | OutputImageType = Image< TOutputPixelType, TInputImage::ImageDimension > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = ImageSource |
| |
| using | Superclass = ProcessObject |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | DataObjectIdentifierType = DataObject::DataObjectIdentifierType |
| |
| using | DataObjectPointer = DataObject::Pointer |
| |
| using | DataObjectPointerArray = std::vector< DataObjectPointer > |
| |
| using | DataObjectPointerArraySizeType = DataObjectPointerArray::size_type |
| |
| using | MultiThreaderType = MultiThreaderBase |
| |
| using | NameArray = std::vector< DataObjectIdentifierType > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = ProcessObject |
| |
| using | Superclass = Object |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = Object |
| |
| using | Superclass = LightObject |
| |
| using | ConstPointer = SmartPointer< const Self > |
| |
| using | Pointer = SmartPointer< Self > |
| |
| using | Self = LightObject |
| |
|
| void | GenerateData () override |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| | SegmentationLevelSetImageFilter () |
| |
| | ~SegmentationLevelSetImageFilter () override=default |
| |
|
| void | InitializeIteration () override |
| |
| void | AllocateUpdateBuffer () override |
| |
| void | ApplyUpdate (const TimeStepType &dt) override |
| |
| TimeStepType | CalculateChange () override |
| |
| virtual ValueType | CalculateUpdateValue (const IndexType &, const TimeStepType &dt, const ValueType &value, const ValueType &change) |
| |
| void | ConstructActiveLayer () |
| |
| void | ConstructLayer (StatusType from, StatusType to) |
| |
| void | CopyInputToOutput () override |
| |
| virtual ValueType | GetValueOne () const |
| |
| virtual ValueType | GetValueZero () const |
| |
| void | Initialize () override |
| |
| void | InitializeActiveLayerValues () |
| |
| virtual void | InitializeBackgroundPixels () |
| |
| void | PostProcessOutput () override |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| void | ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus) |
| |
| void | ProcessStatusList (LayerType *InputList, LayerType *OutputList, StatusType ChangeToStatus, StatusType SearchForStatus) |
| |
| void | PropagateAllLayerValues () |
| |
| void | PropagateLayerValues (StatusType from, StatusType to, StatusType promote, int InOrOut) |
| |
| | SparseFieldLevelSetImageFilter () |
| |
| void | UpdateActiveLayerValues (TimeStepType dt, LayerType *StatusUpList, LayerType *StatusDownList) |
| |
| | ~SparseFieldLevelSetImageFilter () override=default |
| |
| | FiniteDifferenceImageFilter () |
| |
| void | GenerateData () override |
| |
| void | GenerateInputRequestedRegion () override |
| |
| virtual bool | Halt () |
| |
| virtual TimeStepType | ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const |
| |
| virtual void | SetElapsedIterations (IdentifierType _arg) |
| |
| virtual bool | ThreadedHalt (void *) |
| |
| | ~FiniteDifferenceImageFilter () override=default |
| |
| void | AllocateOutputs () override |
| |
| virtual bool | GetRunningInPlace () const |
| |
| | InPlaceImageFilter ()=default |
| |
| void | ReleaseInputs () override |
| |
| | ~InPlaceImageFilter () override=default |
| |
| virtual void | CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion) |
| |
| virtual void | CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion) |
| |
| | ImageToImageFilter () |
| |
| void | VerifyInputInformation () ITKv5_CONST override |
| |
| | ~ImageToImageFilter () override |
| |
| void | PushBackInput (const DataObject *input) override |
| |
| void | PushFrontInput (const DataObject *input) override |
| |
| virtual void | AfterThreadedGenerateData () |
| |
| virtual void | BeforeThreadedGenerateData () |
| |
| void | ClassicMultiThread (ThreadFunctionType callbackFunction) |
| |
virtual const
ImageRegionSplitterBase * | GetImageRegionSplitter () const |
| |
| | ImageSource () |
| |
| virtual unsigned int | SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion) |
| |
| | ~ImageSource () override=default |
| |
| virtual void | ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) |
| |
| virtual void | DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) |
| |
| virtual bool | GetDynamicMultiThreading () const |
| |
| virtual void | SetDynamicMultiThreading (bool _arg) |
| |
| virtual void | DynamicMultiThreadingOn () |
| |
| virtual void | DynamicMultiThreadingOff () |
| |
| virtual void | AddInput (DataObject *input) |
| |
| void | AddOptionalInputName (const DataObjectIdentifierType &) |
| |
| void | AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx) |
| |
| virtual void | AddOutput (DataObject *output) |
| |
| bool | AddRequiredInputName (const DataObjectIdentifierType &) |
| |
| bool | AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx) |
| |
| virtual void | CacheInputReleaseDataFlags () |
| |
| virtual void | GenerateOutputInformation () |
| |
| virtual void | GenerateOutputRequestedRegion (DataObject *output) |
| |
| DataObject * | GetInput (const DataObjectIdentifierType &key) |
| |
| const DataObject * | GetInput (const DataObjectIdentifierType &key) const |
| |
virtual const
DataObjectPointerArraySizeType & | GetNumberOfRequiredInputs () const |
| |
virtual const
DataObjectPointerArraySizeType & | GetNumberOfRequiredOutputs () const |
| |
| bool | IsIndexedInputName (const DataObjectIdentifierType &) const |
| |
| bool | IsIndexedOutputName (const DataObjectIdentifierType &) const |
| |
| bool | IsRequiredInputName (const DataObjectIdentifierType &) const |
| |
| DataObjectPointerArraySizeType | MakeIndexFromInputName (const DataObjectIdentifierType &name) const |
| |
| DataObjectPointerArraySizeType | MakeIndexFromOutputName (const DataObjectIdentifierType &name) const |
| |
| DataObjectIdentifierType | MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const |
| |
| DataObjectIdentifierType | MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const |
| |
| | ProcessObject () |
| |
| virtual void | PropagateResetPipeline () |
| |
| virtual void | RemoveInput (const DataObjectIdentifierType &key) |
| |
| virtual void | RemoveInput (DataObjectPointerArraySizeType) |
| |
| virtual void | RemoveOutput (const DataObjectIdentifierType &key) |
| |
| virtual void | RemoveOutput (DataObjectPointerArraySizeType idx) |
| |
| bool | RemoveRequiredInputName (const DataObjectIdentifierType &) |
| |
| virtual void | RestoreInputReleaseDataFlags () |
| |
| virtual void | SetInput (const DataObjectIdentifierType &key, DataObject *input) |
| |
| virtual void | SetNthInput (DataObjectPointerArraySizeType num, DataObject *input) |
| |
| virtual void | SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output) |
| |
| void | SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num) |
| |
| void | SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num) |
| |
| virtual void | SetNumberOfRequiredInputs (DataObjectPointerArraySizeType) |
| |
| virtual void | SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg) |
| |
| virtual void | SetOutput (const DataObjectIdentifierType &key, DataObject *output) |
| |
| virtual void | SetPrimaryInput (DataObject *input) |
| |
| virtual void | SetPrimaryOutput (DataObject *output) |
| |
| void | SetRequiredInputNames (const NameArray &) |
| |
| virtual void | VerifyPreconditions () ITKv5_CONST |
| |
| | ~ProcessObject () override |
| |
| DataObject * | GetInput (DataObjectPointerArraySizeType idx) |
| |
| const DataObject * | GetInput (DataObjectPointerArraySizeType idx) const |
| |
| DataObject * | GetPrimaryInput () |
| |
| const DataObject * | GetPrimaryInput () const |
| |
| virtual void | SetPrimaryInputName (const DataObjectIdentifierType &key) |
| |
| virtual const char * | GetPrimaryInputName () const |
| |
| DataObject * | GetOutput (const DataObjectIdentifierType &key) |
| |
| const DataObject * | GetOutput (const DataObjectIdentifierType &key) const |
| |
| virtual void | SetPrimaryOutputName (const DataObjectIdentifierType &key) |
| |
| virtual const char * | GetPrimaryOutputName () const |
| |
| DataObject * | GetOutput (DataObjectPointerArraySizeType idx) |
| |
| const DataObject * | GetOutput (DataObjectPointerArraySizeType idx) const |
| |
| DataObject * | GetPrimaryOutput () |
| |
| const DataObject * | GetPrimaryOutput () const |
| |
| | Object () |
| |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| |
| virtual void | SetTimeStamp (const TimeStamp &time) |
| |
| | ~Object () override |
| |
| virtual LightObject::Pointer | InternalClone () const |
| |
| | LightObject () |
| |
| virtual void | PrintHeader (std::ostream &os, Indent indent) const |
| |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| |
| virtual | ~LightObject () |
| |
Inheritance diagram for itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:
1.8.5
