BUG: Mark LabelGeometryImageFilter as deprecated

InsightSoftwareConsortium / ITK

Insight Toolkit (ITK) -- Official Repository. ITK builds on a proven, spatially-oriented architecture for processing, segmentation, and registration of scientific images in two, three, or more dimensions.

https://itk.org

Apache License 2.0

1.37k stars 660 forks source link

BUG: Mark LabelGeometryImageFilter as deprecated #4630

Closed blowekamp closed 2 months ago

blowekamp commented 2 months ago

The LabelGeometryImageFilter has known computational inefficiencies and bugs such as some attributes are not computed with respect to image geometry.

This class is currently in the Review module and is planned to be moved to the Compatibility group under the Deprecated module.

PR Checklist

[ ] No API changes were made (or the changes have been approved)
[ ] No major design changes were made (or the changes have been approved)
[ ] Added test (or behavior not changed)
[ ] Updated API documentation (or API not changed)
[ ] Added license to new files (if any)
[ ] Added Python wrapping to new files (if any) as described in ITK Software Guide Section 9.5
[ ] Added ITK examples for all new major features (if any)

Refer to the ITK Software Guide for further development details if necessary.

blowekamp commented 2 months ago

The intention is to produce a warning for the current up common release so that with ~~5.0~~ 6.0 the class can be moved to the deprecated module.

blowekamp commented 2 months ago

It does not look like the the ITKReview module has recently receive style changes.

dzenanz commented 2 months ago

Maybe because it is off by default?

dzenanz commented 2 months ago

Perhaps we should turn it on by default (low effort), of finish migration of content out of it and into other corresponding modules (high effort)?

gdevenyi commented 2 months ago

@ntustison @cookpa

blowekamp commented 2 months ago

Perhaps we should turn it on by default (low effort), of finish migration of content out of it and into other corresponding modules (high effort)?

I think turning it on by default may encourage more usage, and limit options available to the remaining classes. I Think the options for the classes in the Review module should be 1) Integrate in ITK proper after changes, 2) make a remote module 3) move to the Deprecate module.

blowekamp commented 2 months ago

@thewtex I see you tagged ITK6.0 beta with this PR. So what would be the scheduled to move this class the the ITK Deprecated module? ITK 7.0?

This filter is only in ITKReview, so perhaps less notification is needed?

thewtex commented 2 months ago

This filter is only in ITKReview, so perhaps less notification is needed?

ITKReview is relied on in practice, but it would be helpful to have it marked as deprecated if you would like to move to ITKDeprecated in ITK 6. Merged.