Skip to content
Snippets Groups Projects
Commit be1a625d authored by Nils Kroell's avatar Nils Kroell
Browse files

Fix #92.

parent d63bf070
No related branches found
No related tags found
1 merge request!41Development
Pipeline #1082161 passed with warnings
![imea logo](https://git.rwth-aachen.de/ants/sensorlab/imea/raw/master/media/imea.png "imea logo")
![imea logo](https://git.rwth-aachen.de/ants/sensorlab/imea/raw/main/media/imea.png "imea logo")
[![status](https://joss.theoj.org/papers/b34442455601ccd0b474b814c417a531/status.svg)](https://joss.theoj.org/papers/b34442455601ccd0b474b814c417a531)
[![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/imea/)
[![PyPI version shields.io](https://img.shields.io/pypi/v/imea.svg)](https://pypi.python.org/pypi/imea/)
......@@ -82,7 +82,7 @@ Unit tests are available in the [tests](./tests) folder. To execute the tests wi
```
## Usage
You can use [`imea`](https://git.rwth-aachen.de/ants/sensorlab/imea) either to extract 2D shape measurements from 2D binary images or to extract 2D as well as 3D shape measurements from grayscale images (heightmaps). Under the folder [**demo**](https://git.rwth-aachen.de/ants/sensorlab/imea/-/tree/master/demo) you can find two Jupyter notebooks that demonstrate the usage of [`imea`](https://git.rwth-aachen.de/ants/sensorlab/imea), as well as several [**example images**](https://git.rwth-aachen.de/ants/sensorlab/imea/-/tree/master/demo/example_imgs).
You can use [`imea`](https://git.rwth-aachen.de/ants/sensorlab/imea) either to extract 2D shape measurements from 2D binary images or to extract 2D as well as 3D shape measurements from grayscale images (heightmaps). Under the folder [**demo**](https://git.rwth-aachen.de/ants/sensorlab/imea/-/tree/main/demo) you can find two Jupyter notebooks that demonstrate the usage of [`imea`](https://git.rwth-aachen.de/ants/sensorlab/imea), as well as several [**example images**](https://git.rwth-aachen.de/ants/sensorlab/imea/-/tree/main/demo/example_imgs).
### 2D measurements
For 2D shape measurements insert a binary image `bw` and the spatial resolution in xy-direction (`spatial_resolution_xy`) in [mm/px] into the function `extract_df_2d`:
......@@ -131,7 +131,7 @@ If you miss any 2D or 3D shape measurement feel free to open an issue providing
### 2D shape measurements
Currently, 53 twodimensional shape measurements are implemented in [`imea`](https://git.rwth-aachen.de/ants/sensorlab/imea), as shown in the tables below. According to DIN ISO 9276-6 these are structured in macro-, meso- and microdescriptors as well as statistical lengths, as illustrated below.
![macro-, meso- and micromeasurements](https://git.rwth-aachen.de/ants/sensorlab/imea/raw/master/media/macro_meso_micro_measurements.png "macro-, meso- and micromeasurements")
![macro-, meso- and micromeasurements](https://git.rwth-aachen.de/ants/sensorlab/imea/raw/main/media/macro_meso_micro_measurements.png "macro-, meso- and micromeasurements")
#### Macro measurements (`imea.measure_2d.macro`)
Macrodescriptors represent the overall, external shape of a particle. The following macrodescriptors are currently available in [`imea`](https://git.rwth-aachen.de/ants/sensorlab/imea):
......
......@@ -12,7 +12,7 @@ setuptools.setup(
name='imea',
license="MIT",
description='imea is an open source Python package for extracting 2D and 3D shape measurements from images.',
version='v0.3.4',
version='v0.3.5',
long_description=README,
long_description_content_type='text/markdown',
url='https://git.rwth-aachen.de/ants/sensorlab/imea',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment