PMEAL / porespy

A set of tools for characterizing and analying 3D images of porous materials
https://porespy.org
MIT License
301 stars 98 forks source link

Adjust documentation or code for volume regionprop #979

Open hzwirnmann opened 2 months ago

hzwirnmann commented 2 months ago

Hello everyone,

in scikit-image, the "area" regionprop is the number of pixels times the pixel area: https://github.com/scikit-image/scikit-image/blob/v0.24.0/skimage/measure/_regionprops.py#L425 There is a separate property "num_pixels" that just counts the number of pixels.

This should be reflected in this package, i.e. either the documentation of "volume" should be adjusted ( https://github.com/PMEAL/porespy/blob/dev/src/porespy/metrics/_regionprops.py#L165 ) or the code itself ( https://github.com/PMEAL/porespy/blob/dev/src/porespy/metrics/_regionprops.py#L245 ).

Best wishes Henning