New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mismatch documentation and code SyNImageRegistrationMethod GaussianSmoothingVarianceForTheUpdateField default value #273

Open
N-Dekker opened this Issue Dec 6, 2018 · 2 comments

Comments

2 participants
@N-Dekker
Contributor

N-Dekker commented Dec 6, 2018

There appears a mismatch between documentation and the actual implementation of the default value for the SyNImageRegistrationMethod parameter GaussianSmoothingVarianceForTheUpdateField.

https://github.com/InsightSoftwareConsortium/ITK/blob/v5.0b01/Modules/Registration/RegistrationMethodsv4/include/itkSyNImageRegistrationMethod.h#L178 says:

  /**
   * Get/Set the Gaussian smoothing variance for the update field.
   * Default = 1.75.
   */
  itkSetMacro( GaussianSmoothingVarianceForTheUpdateField, RealType );
  itkGetConstReferenceMacro( GaussianSmoothingVarianceForTheUpdateField, RealType );

However, https://github.com/InsightSoftwareConsortium/ITK/blob/v5.0b01/Modules/Registration/RegistrationMethodsv4/include/itkSyNImageRegistrationMethod.hxx#L44 does, in the default-constructor of SyNImageRegistrationMethod:

  m_GaussianSmoothingVarianceForTheUpdateField( 3.0 ),

Do you think the documentation is incorrect, or should the code be fixed?

@ntustison Nick, what do you think?

Note that this mismatch was there already with the initial version (Jan 10, 2012): ec36185

@ntustison

This comment has been minimized.

Member

ntustison commented Dec 6, 2018

@N-Dekker Thanks. Yeah, it should be 3.0. I don't know where 1.75 came from.

@N-Dekker

This comment has been minimized.

Contributor

N-Dekker commented Dec 7, 2018

Thanks for your reply, @ntustison Now I see, it is actually 1.75 for two adaptor classes:

Both adaptors have their m_GaussianSmoothingVarianceForTheUpdateField initialized to 1.75. I hope that's just the way it was intended.

@hjmjohnson hjmjohnson added this to Low priority in Bug Triage Ordering Test Dec 8, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment