Package gov.nih.mipav.model.algorithms.registration

Class AlgorithmRegBSpline.Options

  • Enclosing class:
    AlgorithmRegBSpline
    public static class AlgorithmRegBSpline.Options
extends java.lang.Object
    Data structure which contains the parameters or options used to perform a BSpline based registration of two images.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean bSubsample
      Boolean flag set to true to indicate whether the registration is performed to a subsampled target image.
      float fConvergenceLimit
      One iteration is defined such that all control points are moved once by gradient descent.
      float fGradientDescentMinimizeStepSize
      Size of step in sample units when locating the minimum of the gradient descent.
      int iBSplineDegree
      Degree of the BSpline basis functions.
      int iBSplineNumControlPoints
      Number of control points to use for the open/uniform BSpline basis functions.
      int iGradientDescentMinimizeMaxSteps
      Maximum number of steps to test when locating the minimum of the gradient descent.
      int iMaxIterations
      Maximum number of iterations to perform if convergence limit condition is still not satisfied.

    • Constructor Summary

      Constructors 
      Constructor Description
      Options()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setFromString​(java.lang.String kOptions, java.lang.String kDelim)
      DOCUMENT ME!
      java.lang.String toString​(java.lang.String kDelim)
      Convert the options to a delimeted text string.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • bSubsample

        public boolean bSubsample
        Boolean flag set to true to indicate whether the registration is performed to a subsampled target image. This may be used to speed up processing at some tradeoff for registration quality.

      • fConvergenceLimit

        public float fConvergenceLimit
        One iteration is defined such that all control points are moved once by gradient descent. The registration error before and after one iteration are compared and if the relative change is less than this limit, then the registration terminates.

      • fGradientDescentMinimizeStepSize

        public float fGradientDescentMinimizeStepSize
        Size of step in sample units when locating the minimum of the gradient descent.

      • iBSplineDegree

        public int iBSplineDegree
        Degree of the BSpline basis functions. Same for all dimensions.

      • iBSplineNumControlPoints

        public int iBSplineNumControlPoints
        Number of control points to use for the open/uniform BSpline basis functions. Same for all dimensions.

      • iGradientDescentMinimizeMaxSteps

        public int iGradientDescentMinimizeMaxSteps
        Maximum number of steps to test when locating the minimum of the gradient descent. Combined with the fGradientDescentMinimizeStepSize parameter, this determines the maximum distance from the current state to search for the minimum of the gradient descent.

      • iMaxIterations

        public int iMaxIterations
        Maximum number of iterations to perform if convergence limit condition is still not satisfied.

    • Constructor Detail

      • Options

        public Options()

    • Method Detail

      • setFromString

        public void setFromString​(java.lang.String kOptions,
                          java.lang.String kDelim)
                   throws TokenizerException
        DOCUMENT ME!
        Parameters:
        kOptions - String containing all of the options.
        kDelim - String to separate each parameter.
        Throws:
        TokenizerException - DOCUMENT ME!

      • toString

        public java.lang.String toString​(java.lang.String kDelim)
        Convert the options to a delimeted text string.
        Parameters:
        kDelim - String String to separate each parameter.
        Returns:
        String String which contains text representation of each option separated by the specified delimeter.