photoelastimetry

Package for processing polarised images to measure stress in granular media.

Install

pip install photoelastimetry

CLI Tools

• image-to-stress
• image-to-retardation (quick first-branch optical inversion)
• stress-to-image
• demosaic-raw
• calibrate-photoelastimetry

Run --help on each command for usage.

For a quick retardation/direction map without stress fitting or fringe resolution:

image-to-retardation image.tiff
image-to-retardation image.tiff --bright-field bright.tiff --dark-field dark.tiff --format png

Defaults to circular illumination (--input-stokes 0 0 1) and float TIFF output in radians. PNGs are fixed-scale previews, one per colour and quantity. See input layouts, branch assumptions and field correction.

Documentation

• Full docs: https://benjym.github.io/photoelastimetry/
• User docs (workflows/config): docs/user/
• Developer docs (setup/tests/architecture): docs/developer/
• API reference: docs/reference/

Fastest Local Example

stress-to-image forward.json5
image-to-stress inverse.json5

For complete runnable examples, use docs/user/quickstart.md and workflow pages under docs/user/workflows/.

Development

pip install -e ".[dev,docs]"
pytest
mkdocs build --strict

Contributor guidance is maintained in docs/developer/.