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

regionprops: rename equivalent_diameter -> equivalent_diameter_area #4821

Closed
maxfrei750 opened this issue Jul 3, 2020 · 5 comments
Closed
Labels
📜 type: API Involves API change(s)
Milestone

Comments

@maxfrei750
Copy link
Contributor

There exists actually a whole variety of equivalent diameters. Therefore, IMHO, it would be nice to have a more specific name (e.g. equivalent_diameter_area).

@jni
Copy link
Member

jni commented Jul 5, 2020

Thanks @maxfrei750 !

Could you enumerate a few of the options? My impression is that this will not bring a big enough benefit to justify the API break unless we also provide others.

However, when we release 1.0 we will be changing quite a few things and this might be a good candidate for that update. I’ll tag it for that.

@jni jni added this to the 1.0 milestone Jul 5, 2020
@maxfrei750
Copy link
Contributor Author

Admittedly, the distinction is more important for the 3d objects:

  • surface area equivalent diameter
  • projection area equivalent diameter
  • volume equivalent diameter

than for 2d objects:

  • area equivalent diameter
  • perimeter equivalent diameter

@grlee77 grlee77 added the 📜 type: API Involves API change(s) label Jan 25, 2021
@grlee77 grlee77 added this to To Do in skimage2 API Jan 27, 2021
@mkcor
Copy link
Member

mkcor commented Feb 1, 2021

@maxfrei750 so, shouldn't the renaming be equivalent_diameter --> area_equivalent_diameter?

@maxfrei750
Copy link
Contributor Author

@mkcor We had a similar situation for feret_diameter_max vs. max_feret_diameter (see #4820). We ended up using the former, since then all Feret diameters are grouped together. I would make the same argument for equivalent_diameter_area. The "area" is more like an index.

@mkcor
Copy link
Member

mkcor commented Oct 20, 2021

Fixed by #5254

@mkcor mkcor closed this as completed Oct 20, 2021
@grlee77 grlee77 moved this from To Do to Done in skimage2 API Nov 5, 2021
@jarrodmillman jarrodmillman modified the milestones: 0.21, 0.20 Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 type: API Involves API change(s)
Projects
Development

No branches or pull requests

5 participants