Skip to content

Commit

Permalink
DOC: Refine ExhausiveOptimizer documentation
Browse files Browse the repository at this point in the history
Provide expanded description of the ExhaustiveOptimizer
parameter space bounds settings.
  • Loading branch information
hjmjohnson committed Mar 3, 2024
1 parent 604fb3b commit f7c54f8
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
11 changes: 8 additions & 3 deletions Modules/Numerics/Optimizers/include/itkExhaustiveOptimizer.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,14 @@ namespace itk
* of [0.5 1 4] along with a step length of 2 will cause the optimizer
* to search the metric space on a grid with x,y,z spacing of [1 2 8].
*
* Physical dimensions of the grid are influenced by both the scales and
* the number of steps along each dimension, a side of the region is
* stepLength*(2*numberOfSteps[d]+1)*scaling[d].
* The number of samples for each dimension of the parameter grid are
* influenced by both the scales and the number of steps along each
* dimension:
*
* parameter_samples[d] = stepLength*(2*numberOfSteps[d]+1)*scaling[d]
*
* start_parameter[d] = - stepLength * scaling[d] * numberOfSteps[d]
* end_parameter[d] = + stepLength * scaling[d] * numberOfSteps[d]
*
* \ingroup Numerics Optimizers
* \ingroup ITKOptimizers
Expand Down
11 changes: 8 additions & 3 deletions Modules/Numerics/Optimizersv4/include/itkExhaustiveOptimizerv4.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,14 @@ namespace itk
* of [0.5 1 4] along with a step length of 2 will cause the optimizer
* to search the metric space on a grid with x,y,z spacing of [1 2 8].
*
* Physical dimensions of the grid are influenced by both the scales and
* the number of steps along each dimension, a side of the region is
* stepLength*(2*numberOfSteps[d]+1)*scaling[d].
* The number of samples for each dimension of the parameter grid are
* influenced by both the scales and the number of steps along each
* dimension:
*
* parameter_samples[d] = stepLength*(2*numberOfSteps[d]+1)*scaling[d]
*
* start_parameter[d] = - stepLength * scaling[d] * numberOfSteps[d]
* end_parameter[d] = + stepLength * scaling[d] * numberOfSteps[d]
*
* \ingroup ITKOptimizersv4
*/
Expand Down

0 comments on commit f7c54f8

Please sign in to comment.