Class FastMarchingBaseImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.FastMarchingBaseImageFilter
Apply the Fast Marching method to solve an Eikonal equation on an
image.
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 nullptr, 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 is an approximate distance function from the initial alive
points.
There are two ways to specify the output image information
(LargestPossibleRegion, Spacing, Origin):
it is copied directly from the input speed image
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 nullptr or if the OverrideOutputInformation is
set to true, the output information is set from user specified
parameters. These parameters can be specified using methods
FastMarchingImageFilterBase::SetOutputRegion() ,
FastMarchingImageFilterBase::SetOutputSpacing() ,
FastMarchingImageFilterBase::SetOutputDirection() ,
FastMarchingImageFilterBase::SetOutputOrigin() .
Else the output information is copied from the input speed image.
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.
For an alternative implementation, see itk::FastMarchingImageFilter .
TTraits
traits
See:
FastMarchingImageFilter
ImageFastMarchingTraits
ImageFastMarchingTraits2
itk::simple::FastMarchingBase for the procedural interface
itk::FastMarchingImageFilterBase for the Doxygen on the original ITK class.
C++ includes: sitkFastMarchingBaseImageFilter.h
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class -
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn -
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::FastMarchingBaseImageFilter::FastMarchingBaseImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedFastMarchingBaseImageFilter(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddTrialPoint(VectorUInt32 point) Self& itk::simple::FastMarchingBaseImageFilter::AddTrialPoint(std::vector< unsigned int > point) Add TrialPoints point.voidSelf& itk::simple::FastMarchingBaseImageFilter::ClearTrialPoints() Remove all TrialPoints points.voiddelete()virtual itk::simple::FastMarchingBaseImageFilter::~FastMarchingBaseImageFilter() DestructorImage itk::simple::FastMarchingBaseImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected voidfinalize()protected static longstd::vector<double> itk::simple::FastMarchingBaseImageFilter::GetInitialTrialValues() constgetName()std::string itk::simple::FastMarchingBaseImageFilter::GetName() const Name of this classdoubledouble itk::simple::FastMarchingBaseImageFilter::GetNormalizationFactor() const Set/Get the Normalization Factor for the Speed Image .doubledouble itk::simple::FastMarchingBaseImageFilter::GetStoppingValue() const Get the Fast Marching algorithm Stopping Value.TopologyCheckType itk::simple::FastMarchingBaseImageFilter::GetTopologyCheck() conststd::vector< std::vector< unsigned int > > itk::simple::FastMarchingBaseImageFilter::GetTrialPoints() const Get the container of Trial Points representing the initial front.voidsetInitialTrialValues(VectorDouble InitialTrialValues) Self& itk::simple::FastMarchingBaseImageFilter::SetInitialTrialValues(std::vector< double > InitialTrialValues) Set the initial seed values for corresponding trial point.voidsetNormalizationFactor(double NormalizationFactor) Self& itk::simple::FastMarchingBaseImageFilter::SetNormalizationFactor(double NormalizationFactor) Set/Get the Normalization Factor for the Speed Image .voidsetStoppingValue(double StoppingValue) Self& itk::simple::FastMarchingBaseImageFilter::SetStoppingValue(double StoppingValue) Set the Fast Marching algorithm Stopping Value.voidsetTopologyCheck(FastMarchingBaseImageFilter.TopologyCheckType TopologyCheck) Self& itk::simple::FastMarchingBaseImageFilter::SetTopologyCheck(TopologyCheckType TopologyCheck)voidsetTrialPoints(VectorUIntList TrialPoints) Self& itk::simple::FastMarchingBaseImageFilter::SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints) Set the container of Trial Points representing the initial front.protected static longtoString()std::string itk::simple::FastMarchingBaseImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObject
abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
-
Constructor Details
-
FastMarchingBaseImageFilter
protected FastMarchingBaseImageFilter(long cPtr, boolean cMemoryOwn) -
FastMarchingBaseImageFilter
public FastMarchingBaseImageFilter()itk::simple::FastMarchingBaseImageFilter::FastMarchingBaseImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalizein classImageFilter
-
delete
public void delete()virtual itk::simple::FastMarchingBaseImageFilter::~FastMarchingBaseImageFilter() Destructor- Overrides:
deletein classImageFilter
-
setTrialPoints
Self& itk::simple::FastMarchingBaseImageFilter::SetTrialPoints(std::vector< std::vector< unsigned int > > TrialPoints) Set the container of Trial Points representing the initial front. Trial points are represented as a VectorContainer of LevelSetNodes. -
getTrialPoints
std::vector< std::vector< unsigned int > > itk::simple::FastMarchingBaseImageFilter::GetTrialPoints() const Get the container of Trial Points representing the initial front. -
addTrialPoint
Self& itk::simple::FastMarchingBaseImageFilter::AddTrialPoint(std::vector< unsigned int > point) Add TrialPoints point. -
clearTrialPoints
public void clearTrialPoints()Self& itk::simple::FastMarchingBaseImageFilter::ClearTrialPoints() Remove all TrialPoints points. -
setNormalizationFactor
public void setNormalizationFactor(double NormalizationFactor) Self& itk::simple::FastMarchingBaseImageFilter::SetNormalizationFactor(double NormalizationFactor) Set/Get the Normalization Factor for the Speed Image . The values in the Speed Image is divided by this factor. This allows the use of images with integer pixel types to represent the speed. -
getNormalizationFactor
public double getNormalizationFactor()double itk::simple::FastMarchingBaseImageFilter::GetNormalizationFactor() const Set/Get the Normalization Factor for the Speed Image . The values in the Speed Image is divided by this factor. This allows the use of images with integer pixel types to represent the speed. -
setStoppingValue
public void setStoppingValue(double StoppingValue) Self& itk::simple::FastMarchingBaseImageFilter::SetStoppingValue(double StoppingValue) 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. -
getStoppingValue
public double getStoppingValue()double itk::simple::FastMarchingBaseImageFilter::GetStoppingValue() const Get the Fast Marching algorithm Stopping Value. -
setTopologyCheck
Self& itk::simple::FastMarchingBaseImageFilter::SetTopologyCheck(TopologyCheckType TopologyCheck) -
getTopologyCheck
TopologyCheckType itk::simple::FastMarchingBaseImageFilter::GetTopologyCheck() const -
setInitialTrialValues
Self& itk::simple::FastMarchingBaseImageFilter::SetInitialTrialValues(std::vector< double > InitialTrialValues) Set the initial seed values for corresponding trial point. -
getInitialTrialValues
std::vector<double> itk::simple::FastMarchingBaseImageFilter::GetInitialTrialValues() const -
getName
std::string itk::simple::FastMarchingBaseImageFilter::GetName() const Name of this class- Overrides:
getNamein classProcessObject
-
toString
std::string itk::simple::FastMarchingBaseImageFilter::ToString() const Print ourselves out- Overrides:
toStringin classProcessObject
-
execute
-