template<typename TInputImage, typename TFeatureImage, typename TOutputPixelType = float>
class itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >
Segments structures in images based on a user supplied edge potential map.
- IMPORTANT
- The SegmentationLevelSetImageFilter class and the ShapeDetectionLevelSetFunction class contain additional information necessary to gain full understanding of how to use this filter.
- OVERVIEW
- This class is a level set method segmentation filter. An initial contour is propagated outwards (or inwards) until it ''sticks'' to the shape boundaries. This is done by using a level set speed function based on a user supplied edge potential map. This approach for segmentation follows that of Malladi et al (1995) [75].
- INPUTS
- This filter requires two inputs. The first input is a initial level set. The initial level set is a real image which contains the initial contour/surface as the zero level set. For example, a signed distance function from the initial contour/surface is typically used. Note that for this algorithm the initial contour has to be wholly within (or wholly outside) the structure to be segmented.
- The second input is the feature image. For this filter, this is the edge potential map. General characteristics of an edge potential map is that it has values close to zero in regions near the edges and values close to one inside the shape itself. Typically, the edge potential map is compute from the image gradient, for example:
\[ g(I) = 1 / ( 1 + | (\nabla * G)(I)| ) \]
\[ g(I) = \exp^{-|(\nabla * G)(I)|} \]
where \( I \) is image intensity and \( (\nabla * G) \) is the derivative of Gaussian operator.
- See SegmentationLevelSetImageFilter and SparseFieldLevelSetImageFilter for more information on Inputs.
- PARAMETERS
- The PropagationScaling parameter can be used to switch from propagation outwards (POSITIVE scaling parameter) versus propagating inwards (NEGATIVE scaling parameter).
The smoothness of the resulting contour/surface can be adjusted using a combination of PropagationScaling and CurvatureScaling parameters. The larger the CurvatureScaling parameter, the smoother the resulting contour. The CurvatureScaling parameter should be non-negative for proper operation of this algorithm. To follow the implementation in Malladi et al paper, set the PropagationScaling to \(\pm 1.0\) and CurvatureScaling to \( \epsilon \).
Note that there is no advection term for this filter. Setting the advection scaling will have no effect.
- OUTPUTS
- The filter outputs a single, scalar, real-valued image. Negative values in the output image represent the inside of the segmented region and positive values in the image represent the outside of the segmented region. The zero crossings of the image correspond to the position of the propagating front.
- See SparseFieldLevelSetImageFilter and SegmentationLevelSetImageFilter for more information.
For algorithmic details see [75].
- See also
- SegmentationLevelSetImageFilter
-
ShapeDetectionLevelSetFunction
-
SparseFieldLevelSetImageFilter
- Examples
- Examples/Segmentation/ShapeDetectionLevelSetFilter.cxx.
Definition at line 101 of file itkShapeDetectionLevelSetImageFilter.h.
|
| virtual::itk::LightObject::Pointer | CreateAnother () const |
| |
| virtual const char * | GetNameOfClass () const |
| |
| void | GenerateAdvectionImage () |
| |
| void | GenerateSpeedImage () |
| |
| virtual const VectorImageType * | GetAdvectionImage () const |
| |
| virtual SegmentationFunctionType * | GetSegmentationFunction () |
| |
| virtual const SpeedImageType * | GetSpeedImage () const |
| |
| void | SetAdvectionImage (VectorImageType *v) |
| |
| void | SetFeatureScaling (ValueType v) |
| |
| void | SetInput2 (const FeatureImageType *input) |
| |
| virtual void | SetSegmentationFunction (SegmentationFunctionType *s) |
| |
| void | SetSpeedImage (SpeedImageType *s) |
| |
| void | UseMinimalCurvatureOff () |
| |
| void | UseMinimalCurvatureOn () |
| |
| void | SetMaximumIterations (unsigned int i) |
| |
| unsigned int | GetMaximumIterations () |
| |
| virtual void | SetFeatureImage (const FeatureImageType *f) |
| |
| | itkGetInputMacro (FeatureImage, FeatureImageType) |
| |
| | itkGetInputMacro (InitialImage, InputImageType) |
| |
| | itkSetInputMacro (InitialImage, InputImageType) |
| |
| void | SetUseNegativeFeaturesOn () |
| |
| void | SetUseNegativeFeaturesOff () |
| |
| void | SetUseNegativeFeatures (bool u) |
| |
| bool | GetUseNegativeFeatures () const |
| |
| virtual void | SetReverseExpansionDirection (bool _arg) |
| |
| virtual bool | GetReverseExpansionDirection () const |
| |
| virtual void | ReverseExpansionDirectionOn () |
| |
| virtual void | ReverseExpansionDirectionOff () |
| |
| virtual void | SetAutoGenerateSpeedAdvection (bool _arg) |
| |
| virtual bool | GetAutoGenerateSpeedAdvection () const |
| |
| virtual void | AutoGenerateSpeedAdvectionOn () |
| |
| virtual void | AutoGenerateSpeedAdvectionOff () |
| |
| void | SetPropagationScaling (ValueType v) |
| |
| ValueType | GetPropagationScaling () const |
| |
| void | SetAdvectionScaling (ValueType v) |
| |
| ValueType | GetAdvectionScaling () const |
| |
| void | SetCurvatureScaling (ValueType v) |
| |
| ValueType | GetCurvatureScaling () const |
| |
| void | SetUseMinimalCurvature (bool b) |
| |
| bool | GetUseMinimalCurvature () const |
| |
| void | SetMaximumCurvatureTimeStep (double n) |
| |
| double | GetMaximumCurvatureTimeStep () const |
| |
| void | SetMaximumPropagationTimeStep (double n) |
| |
| double | GetMaximumPropagationTimeStep () const |
| |
| virtual::itk::LightObject::Pointer | CreateAnother () const |
| |
| | itkVirtualSetMacro (NumberOfLayers, unsigned int) |
| |
| virtual unsigned int | GetNumberOfLayers () const |
| |
| virtual void | SetIsoSurfaceValue (ValueType _arg) |
| |
| virtual ValueType | GetIsoSurfaceValue () const |
| |
| virtual void | SetInterpolateSurfaceLocation (bool _arg) |
| |
| virtual bool | GetInterpolateSurfaceLocation () const |
| |
| void | InterpolateSurfaceLocationOn () |
| |
| void | InterpolateSurfaceLocationOff () |
| |
| virtual const FiniteDifferenceFunctionType::Pointer & | GetDifferenceFunction () const |
| |
| virtual const IdentifierType & | GetElapsedIterations () const |
| |
| virtual bool | GetIsInitialized () |
| |
| virtual void | SetDifferenceFunction (FiniteDifferenceFunctionType *_arg) |
| |
| virtual void | SetIsInitialized (bool _arg) |
| |
| void | SetStateToInitialized () |
| |
| void | SetStateToUninitialized () |
| |
| virtual void | SetNumberOfIterations (IdentifierType _arg) |
| |
| virtual const IdentifierType & | GetNumberOfIterations () const |
| |
| virtual void | SetUseImageSpacing (bool _arg) |
| |
| virtual void | UseImageSpacingOn () |
| |
| virtual void | UseImageSpacingOff () |
| |
| virtual const bool & | GetUseImageSpacing () const |
| |
| | itkVirtualSetMacro (MaximumRMSError, double) |
| |
| virtual const double & | GetMaximumRMSError () const |
| |
| virtual void | SetRMSChange (double _arg) |
| |
| | itkVirtualGetConstReferenceMacro (RMSChange, double) |
| |
| virtual void | SetManualReinitialization (bool _arg) |
| |
| virtual const bool & | GetManualReinitialization () const |
| |
| virtual void | ManualReinitializationOn () |
| |
| virtual void | ManualReinitializationOff () |
| |
| virtual bool | CanRunInPlace () const |
| |
| virtual void | SetInPlace (bool _arg) |
| |
| virtual bool | GetInPlace () const |
| |
| virtual void | InPlaceOn () |
| |
| virtual void | InPlaceOff () |
| |
| const InputImageType * | GetInput () const |
| |
| const InputImageType * | GetInput (unsigned int idx) const |
| |
| void | PopBackInput () override |
| |
| void | PopFrontInput () override |
| |
| virtual void | PushBackInput (const InputImageType *input) |
| |
| virtual void | PushFrontInput (const InputImageType *input) |
| |
| virtual void | SetInput (const InputImageType *input) |
| |
| virtual void | SetInput (unsigned int, const TInputImage *image) |
| |
| virtual void | SetCoordinateTolerance (double _arg) |
| |
| virtual double | GetCoordinateTolerance () const |
| |
| virtual void | SetDirectionTolerance (double _arg) |
| |
| virtual double | GetDirectionTolerance () const |
| |
| OutputImageType * | GetOutput (unsigned int idx) |
| |
| virtual void | GraftNthOutput (unsigned int idx, DataObject *graft) |
| |
| virtual void | GraftOutput (const DataObjectIdentifierType &key, DataObject *graft) |
| |
| virtual void | GraftOutput (DataObject *graft) |
| |
| OutputImageType * | GetOutput () |
| |
| const OutputImageType * | GetOutput () const |
| |
| ProcessObject::DataObjectPointer | MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override |
| |
| ProcessObject::DataObjectPointer | MakeOutput (const ProcessObject::DataObjectIdentifierType &) override |
| |
| virtual void | AbortGenerateDataOff () |
| |
| virtual void | AbortGenerateDataOn () |
| |
| virtual void | EnlargeOutputRequestedRegion (DataObject *output) |
| |
| virtual const bool & | GetAbortGenerateData () const |
| |
| DataObjectPointerArray | GetIndexedInputs () |
| |
| DataObjectPointerArray | GetIndexedOutputs () |
| |
| NameArray | GetInputNames () const |
| |
| DataObjectPointerArray | GetInputs () |
| |
| MultiThreaderBase * | GetMultiThreader () const |
| |
| DataObjectPointerArraySizeType | GetNumberOfIndexedInputs () const |
| |
| DataObjectPointerArraySizeType | GetNumberOfIndexedOutputs () const |
| |
| DataObjectPointerArraySizeType | GetNumberOfInputs () const |
| |
| DataObjectPointerArraySizeType | GetNumberOfOutputs () const |
| |
| virtual DataObjectPointerArraySizeType | GetNumberOfValidRequiredInputs () const |
| |
| NameArray | GetOutputNames () const |
| |
| DataObjectPointerArray | GetOutputs () |
| |
| virtual float | GetProgress () const |
| |
| NameArray | GetRequiredInputNames () const |
| |
| bool | HasInput (const DataObjectIdentifierType &key) const |
| |
| bool | HasOutput (const DataObjectIdentifierType &key) const |
| |
| void | IncrementProgress (float increment) |
| |
| virtual void | PrepareOutputs () |
| |
| virtual void | PropagateRequestedRegion (DataObject *output) |
| |
| virtual void | ResetPipeline () |
| |
| virtual void | SetAbortGenerateData (bool _arg) |
| |
| void | SetMultiThreader (MultiThreaderBase *threader) |
| |
| virtual void | Update () |
| |
| virtual void | UpdateLargestPossibleRegion () |
| |
| virtual void | UpdateOutputData (DataObject *output) |
| |
| virtual void | UpdateOutputInformation () |
| |
| void | UpdateProgress (float progress) |
| |
| virtual void | SetReleaseDataFlag (bool val) |
| |
| virtual bool | GetReleaseDataFlag () const |
| |
| void | ReleaseDataFlagOn () |
| |
| void | ReleaseDataFlagOff () |
| |
| virtual void | SetReleaseDataBeforeUpdateFlag (bool _arg) |
| |
| virtual const bool & | GetReleaseDataBeforeUpdateFlag () const |
| |
| virtual void | ReleaseDataBeforeUpdateFlagOn () |
| |
| virtual void | ReleaseDataBeforeUpdateFlagOff () |
| |
| | itkVirtualSetClampMacro (NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS) |
| |
| virtual const ThreadIdType & | GetNumberOfWorkUnits () const |
| |
| unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
| |
| unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
| |
| virtual void | DebugOff () const |
| |
| virtual void | DebugOn () const |
| |
| Command * | GetCommand (unsigned long tag) |
| |
| bool | GetDebug () const |
| |
| MetaDataDictionary & | GetMetaDataDictionary () |
| |
| const MetaDataDictionary & | GetMetaDataDictionary () const |
| |
| virtual ModifiedTimeType | GetMTime () const |
| |
| virtual const TimeStamp & | GetTimeStamp () const |
| |
| bool | HasObserver (const EventObject &event) const |
| |
| void | InvokeEvent (const EventObject &) |
| |
| void | InvokeEvent (const EventObject &) const |
| |
| virtual void | Modified () const |
| |
| void | Register () const override |
| |
| void | RemoveAllObservers () |
| |
| void | RemoveObserver (unsigned long tag) const |
| |
| void | SetDebug (bool debugFlag) const |
| |
| void | SetReferenceCount (int) override |
| |
| void | UnRegister () const noexcept override |
| |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| |
| void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
| |
| virtual void | SetObjectName (std::string _arg) |
| |
| virtual const std::string & | GetObjectName () const |
| |
| Pointer | Clone () const |
| |
| virtual void | Delete () |
| |
| virtual int | GetReferenceCount () const |
| |
| void | Print (std::ostream &os, Indent indent=0) const |
| |
|
| void | GenerateData () override |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| | ShapeDetectionLevelSetImageFilter () |
| |
| | ~ShapeDetectionLevelSetImageFilter () override=default |
| |
| void | InitializeIteration () override |
| |
| | SegmentationLevelSetImageFilter () |
| |
| | ~SegmentationLevelSetImageFilter () override=default |
| |
| void | AllocateUpdateBuffer () override |
| |
| void | ApplyUpdate (const TimeStepType &dt) override |
| |
| TimeStepType | CalculateChange () override |
| |
| virtual ValueType | CalculateUpdateValue (const IndexType &idx, 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 *UpList, LayerType *DownList) |
| |
| | ~SparseFieldLevelSetImageFilter () override=default |
| |
| virtual void | ApplyUpdate (const TimeStepType &dt)=0 |
| |
| | FiniteDifferenceImageFilter () |
| |
| void | GenerateInputRequestedRegion () override |
| |
| virtual bool | Halt () |
| |
| virtual TimeStepType | ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const |
| |
| virtual void | SetElapsedIterations (IdentifierType _arg) |
| |
| virtual bool | ThreadedHalt (void *threadInfo) |
| |
| | ~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) |
| |
| void | GenerateInputRequestedRegion () override |
| |
| | ImageToImageFilter () |
| |
| void | VerifyInputInformation () const override |
| |
| | ~ImageToImageFilter () override=default |
| |
| 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 ®ion, 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 | PushBackInput (const DataObject *input) |
| |
| virtual void | PushFrontInput (const DataObject *input) |
| |
| 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 idx, DataObject *input) |
| |
| virtual void | SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output) |
| |
| void | SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num) |
| |
| void | SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num) |
| |
| virtual void | SetNumberOfRequiredInputs (DataObjectPointerArraySizeType) |
| |
| virtual void | SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg) |
| |
| virtual void | SetOutput (const DataObjectIdentifierType &name, DataObject *output) |
| |
| virtual void | SetPrimaryInput (DataObject *object) |
| |
| virtual void | SetPrimaryOutput (DataObject *object) |
| |
| void | SetRequiredInputNames (const NameArray &) |
| |
| virtual void | VerifyPreconditions () 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 i) |
| |
| const DataObject * | GetOutput (DataObjectPointerArraySizeType i) const |
| |
| DataObject * | GetPrimaryOutput () |
| |
| const DataObject * | GetPrimaryOutput () const |
| |
| virtual bool | GetThreaderUpdateProgress () const |
| |
| virtual void | ThreaderUpdateProgressOn () |
| |
| virtual void | ThreaderUpdateProgressOff () |
| |
| virtual void | SetThreaderUpdateProgress (bool arg) |
| |
| | Object () |
| |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| |
| virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
| |
| | ~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 () |
| |