Skip to content

Commit

Permalink
DOC: Note migration guide replacing CoordinateType with CoordRepType
Browse files Browse the repository at this point in the history
Added note about `CoordRepType` being replaced with `CoordinateType`.

Follow-up to:
- pull request InsightSoftwareConsortium#5006
commit a68b8f6
"ENH: FUTURE REMOVE `...CoordRepType` in favor of `...CoordinateType`"
- pull request InsightSoftwareConsortium#4997
commit e667fa3
"ENH: Deprecate (FUTURE REMOVE) CoordRepType in favor of CoordinateType"
  • Loading branch information
N-Dekker authored and hjmjohnson committed Dec 16, 2024
1 parent 12062e2 commit 44e7133
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Documentation/docs/migration_guides/itk_6_migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,11 @@ the region information properties of the original PointSet object. With previous
ITK versions, `PointSet::Clone()` did not copy any data. (It previously just
created a default-constructed PointSet object, like `PointSet::CreateAnother()`
does.)

For the sake of code readibility, a new `CoordinateType` alias is added for
each nested `CoordRepType` alias. The old `CoordRepType` aliases will still be
available with ITK 6.0, but it is recommended to use `CoordinateType` instead.
The `CoordRepType` aliases will be removed when `ITK_FUTURE_LEGACY_REMOVE` is
enabled. Similarly, `InputCoordinateType`, `OutputCoordinateType`, and
`ImagePointCoordinateType` replace `InputCoordRepType`, `OutputCoordRepType`,
and `ImagePointCoordRepType`, respectively.

0 comments on commit 44e7133

Please sign in to comment.