Skip to content

Commit 0acccf9

Browse files
DOC: TerminationValue and note on early termination
Even though ArrivalFunctionToPathFilter is mentioned, the importance of its TerminationValue should be stretched even in the docs of itkSpeedFunctionToPathFilter. Furthermore, it might help others to note that the path finding can end earlier than expected.
1 parent 8df8922 commit 0acccf9

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

include/itkSpeedFunctionToPathFilter.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ namespace itk
3232
* For each end- and way-point, a Fast Marching arrival function is
3333
* computed. The minimal path is extracted for each segment and
3434
* concatenated to obtain the total path between the start- and
35-
* end-points, while passing near the given way-points.
35+
* end-points, while passing near the given way-points
36+
* (according to the TerminationValue of ArrivalFunctionToPathFilter).
3637
*
3738
* The user must provide the following:
3839
* 1. A real-valued speed function as the filter input
@@ -46,6 +47,8 @@ namespace itk
4647
* with default settings. Other suitable optimizers include
4748
* GradientDescentOptimizer and IterateNeighborhoodOptimizer.
4849
* See itkArrivalFunctionToPathFilter.h for more details.
50+
* Note, that the path finding terminates early if the optimizer
51+
* runs out of the image bounds, possibly depending on the speed function.
4952
*
5053
* This filter is based on the methods described in:
5154
* [1] J. Sethian. Level Set Methods and Fast Marching Methods, chapter 20.

0 commit comments

Comments
 (0)