Skip to content
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

Name of FastMarching 'Base' filters #3757

Open
HaaPut opened this issue Nov 22, 2022 · 0 comments
Open

Name of FastMarching 'Base' filters #3757

HaaPut opened this issue Nov 22, 2022 · 0 comments
Labels
type:Style Style changes: no logic impact (indentation, comments, naming)

Comments

@HaaPut
Copy link
Contributor

HaaPut commented Nov 22, 2022

Description

I am not sure if this is the right place to ask this, but here it is anyway. Why is itkFastMarchingImageFilterBase named such? When I read 'itk...Base.h' I assume that it is (maybe) an abstract class from which itkFastMarchingFilter is derived, but surprisingly neither of these two assumptions are true! Am I the only one who finds this confusing?

The Fast marching module essentially implements the Fast Marching algorithm. There are 2 different implementations of the algorithm in the module. First one (lets call this one 'regular') is implemented in classes itkFastMarchingImageFilter etc. and the second more generalizable implementation (lets call it 'base') in classes itkFastMarchingBase and its subclasses. The 'base' implementation essentially implements the same algorithms expect that it works with generic 'nodes' instead of just voxels of images. As a consequence, we have an itkFastMarchingImageFilterBase and an itkFastMarchingQuadMeshFilterBase and others which are sub-classes of the more generic 'base' version. The 'regular' classes on the other hand are subclass of ImageToImageFilter, so only work for images.
What is not clear to me is the reason for naming the generic implementation 'base'.

Expected coding style

I propose to rename all the fast marching 'Base' classes to something more appropriate. Perhaps something like 'itkFastMarchingImageDomainFilter' , ...QuadMeshDomainFilter.., etc. unless I am missing something here.

Versions

5.2.1

edit: expanded description

@HaaPut HaaPut added the type:Style Style changes: no logic impact (indentation, comments, naming) label Nov 22, 2022
@hjmjohnson hjmjohnson added this to the ITK 6.0 Beta 1 milestone Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Style Style changes: no logic impact (indentation, comments, naming)
Projects
None yet
Development

No branches or pull requests

2 participants