[Insight-developers] ITKv4 Module Names

[Bill Lorensen]

A couple of suggestions: (not requirements :-) )

Usually in ITK and VTK we capitalize acronyms within the toolkit (not
within the Utilities section). In fact, the class names for things
like bmp are itkBMP...

To be consistent with the class names, should the following be changed?
ITK/IO/bmp -> ITK/IO/BMP
ITK/IO/gipl -> GIPL
ITK/IO/ipl -> IPL
ITK/IO/jpeg -> JPEG
ITK/IO/nifti -> NIFTI
ITK/IO/nrrd -> NRRD
ITK/IO/png -> PNG

And also:
ITK/Registration/PdeDeformableRegistration ->
ITK/Registration/PDEDeformableRegistration

ITK/Segmentation/RegionGrowingKlm ITK/Segmentation/RegionGrowingKLM
or maybe the later should be
ITK/Segmentation/KLMRegionGrowing

The question here is where does the adjective go, prefix or suffix.
Most seem to be prefix.

Another question, should the ITK/Registrtion subdirectories include
Registration in there names:
ITK/Registration/FEMRegistration - ITK/Registration/FEM
ITK/Registration/PdeDeformableRegistration - ITK/Registration/PDEDeformable
ITK/Registration/RegistrationCommon - ITK/Registration/Common

My guess is that the current names are needed if the directory
structure is flattened? Or that it makes sense to have directory names
that match the module names.

Bill


On Thu, Feb 10, 2011 at 9:20 AM, Brad King <brad.king at kitware.com> wrote:
> Hi Folks,
>
> After debate with Bill Lorensen in the "ITKv4 Modularization Plan" thread:
>
>  http://www.itk.org/mailman/private/insight-developers/2011-February/017095.html
>
> about the module names, we looked into a new layout and naming that is closer
> to existing ITK conventions.  I updated the CMake code that implements the
> module infrastructure to make module names and locations totally independent.
>
> Please see the attached file for the proposed names and layout.  For example,
> the line
>
> itk-anisotropic-smoothing  ITK-AnisotropicSmoothing  ITK/Filtering/AnisotropicSmoothing
>
> proposes to rename the itk-anisotropic-smoothing to ITK-AnisotropicSmoothing and
> relocate its source tree position from
>
>  modules/itk-anisotropic-smoothing
>
> to
>
>  ITK/Filtering/AnisotropicSmoothing
>
> Note that the "Filtering" directory diverges from the previous flat layout
> We still treat the modules logically as a flat set but just organize the
> source directory structure a bit.  Future re-organization of the directory
> layout will not require any code changes.  The CMake code simply globs for
> modules with
>
>  <top>/*/*/itk-module.cmake
>  <top>/*/*/*/itk-module.cmake
>
> which allows up to two levels of grouping.  The first level is always
> just "ITK/" for our modules but others that merge ITK into their source
> can add "MyCompany/" modules too.
>
> The attached file is just a rough draft.  I need help with choosing the
> final CamelCase appearance of each module name.  Also, it doesn't account
> for a couple of new modules that were added in the last day or 2 but
> I think the idea is clear.
>
> Comments?
> -Brad
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://kitware.com/products/protraining.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-developers
>
>