Skip to content

DOC: Remove FEM registration content retired to the ITKFEM remote module#237

Merged
thewtex merged 3 commits into
InsightSoftwareConsortium:mainfrom
hjmjohnson:remove-fem-references
Jul 6, 2026
Merged

DOC: Remove FEM registration content retired to the ITKFEM remote module#237
thewtex merged 3 commits into
InsightSoftwareConsortium:mainfrom
hjmjohnson:remove-fem-references

Conversation

@hjmjohnson

Copy link
Copy Markdown
Member

Removes the Software Guide's coverage of the FEM (finite-element) deformable registration, which has been retired from ITK to the external ITKFEM remote module and no longer exists on ITK main. The guide's DeformableRegistration1 (FEM) reference was breaking builds against current ITK main; this makes the guide build cleanly against main again.

What's removed
  • The FEM-Based Image Registration subsection (DeformableRegistration1) from DesignAndFunctionality/DeformableRegistration.tex.
  • FiniteElementRegistrationParameters1.txt.
  • The three orphaned DeformableRegistration1 figures (checkerboard before/after and output).
  • Residual FEM mentions in the system-overview, spatial-objects, coding-style, installation, and introduction chapters.
  • A FEM sub-namespace example, replaced with an itk::Statistics example.

The non-FEM deformable examples (DeformableRegistration4 through 7: BSpline / Level-Set / Demons) are retained.

Validation

Built locally against current ITK main (-DITK_GIT_TAG=main): both ITKSoftwareGuide-Book1.pdf and -Book2.pdf produced with no fatal errors. git grep confirms no meaningful FEM references remain in the LaTeX sources.

The ITKFEM and ITKFEMRegistration modules were retired from the ITK
main tree to the InsightSoftwareConsortium/ITKFEM remote module
(ITK PR #6524, phase 1 of #6511). Remove the corresponding Software
Guide content:

- Remove the FEM-Based Image Registration subsection; it built from
  the deleted DeformableRegistration1 example and the FEM parameter
  file, both removed in #6524.
- Drop the FEM Framework architecture item, the FEM registration-type
  mention, and the finite-element package sentence from SystemOverview.
- Installation: FEM is no longer a built-in non-default module; use
  Module_ITKReview for that example.
- Remove FEM from the SpatialObject-type and Numerics-module lists.
The namespace coding-style example used itk::fem, which is retired to
the ITKFEM remote module. Use itk::Statistics, a durable in-tree
sub-namespace, so the example stays valid.
The DeformableRegistration1 figures (CheckerboardBefore, CheckerboardAfter,
and Output) were only referenced by the FEM-Based Image Registration
subsection removed in the prior commit. Drop the now-unused art.
@github-actions github-actions Bot added area:Introduction Issues affecting the Introduction part area:DesignAndFunctionality Issues affecting the Design And Functionality part area:Architecture Issues affecting the Architecture part area:Appendices Issues affecting the Appendices part language:LaTeX Changes to LaTeX code type:BookStyle Changes to book style files type:Documentation Documentation improvement or change labels Jul 6, 2026
@hjmjohnson hjmjohnson marked this pull request as ready for review July 6, 2026 11:48
@hjmjohnson hjmjohnson requested a review from dzenanz July 6, 2026 12:44
@thewtex thewtex merged commit 5d99f5a into InsightSoftwareConsortium:main Jul 6, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Appendices Issues affecting the Appendices part area:Architecture Issues affecting the Architecture part area:DesignAndFunctionality Issues affecting the Design And Functionality part area:Introduction Issues affecting the Introduction part language:LaTeX Changes to LaTeX code type:BookStyle Changes to book style files type:Documentation Documentation improvement or change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants