Generate print-ready images of a random speckle pattern for DIC applications.
#### Installation
This package is hosted on PyPI. Install it using `pip`:
```pip install speckle_pattern```
#### Example speckle pattern
```python
from speckle_pattern import generate_and_save
image_height = 50 # mm
image_width = 100 # mm
speckle_diameter = 3 # mm
dpi = 200
save_path = 'example.jpg'
generate_and_save(image_height, image_width, dpi, speckle_diameter, save_path)
```
<p align='center'><img src='example.jpg' width=400 alt='random speckle'/></p>
#### More speckle generation options
```python
from speckle_pattern import generate_and_save
image_height = 50 # mm
image_width = 100 # mm
speckle_diameter = 7.5 # mm
dpi = 150
save_path = 'example2.tiff'
size_randomness = 0.9 # set higher for more speckle size variety
position_randomness = 2.5 # set higher for more speckle position variety
speckle_blur = 0. # sigma of smothing Gaussian kernel
grid_step = 2. # approximate grid step, in terms of speckle diameter `D`
generate_and_save(
image_height,
image_width,
dpi,
speckle_diameter,
save_path,
size_randomness=size_randomness,
position_randomness=position_randomness,
speckle_blur=speckle_blur,
grid_step=grid_step,
)
```
<p align='center'><img src='example2.jpg' width=400 alt='random speckle 2'/></p>
#### Example line pattern
```python
from speckle_pattern import generate_lines
image_height = 50 # mm
image_width = 100 # mm
line_width = 5 # mm
orientation = 'vertical'
dpi = 200
save_path = f'example_lines_{orientation}.jpg'
generate_lines(image_height, image_width, dpi, line_width, save_path)
```
<p align='center'><img src='example_lines_vertical.jpg' width=400 alt='vertical lines'/></p>
#### Example checkerboard pattern
```python
from speckle_pattern import generate_checkerboard
image_height = 50 # mm
image_width = 100 # mm
line_width = 4 # mm
dpi = 200
save_path = f'example_checkerboard.jpg'
generate_checkerboard(image_height, image_width, dpi, line_width=line_width, path=save_path)
```
<p align='center'><img src='example_checkerboard.jpg' width=400 alt='checkerboard'/></p>
### Authors
- [Domen Gorjup](http://ladisk.si/?what=incfl&flnm=gorjup.php)
- [Janko Slavič](http://ladisk.si/?what=incfl&flnm=slavic.php)
- [Miha Boltežar](http://ladisk.si/?what=incfl&flnm=boltezar.php)
Raw data
{
"_id": null,
"home_page": null,
"name": "speckle-pattern",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "computer vision, dic, speckle pattern",
"author": null,
"author_email": "\"Domen Gorjup, Janko Slavi\u010d, Miha Bolte\u017ear\" <janko.slavic@fs.uni-lj.si>",
"download_url": null,
"platform": null,
"description": "Generate print-ready images of a random speckle pattern for DIC applications.\n\n#### Installation\n\nThis package is hosted on PyPI. Install it using `pip`:\n\n```pip install speckle_pattern```\n\n\n#### Example speckle pattern\n\n```python\nfrom speckle_pattern import generate_and_save\n\nimage_height = 50 # mm\nimage_width = 100 # mm\nspeckle_diameter = 3 # mm\ndpi = 200\nsave_path = 'example.jpg'\n\ngenerate_and_save(image_height, image_width, dpi, speckle_diameter, save_path)\n```\n\n<p align='center'><img src='example.jpg' width=400 alt='random speckle'/></p>\n\n\n#### More speckle generation options\n\n```python\nfrom speckle_pattern import generate_and_save\n\nimage_height = 50 # mm\nimage_width = 100 # mm\nspeckle_diameter = 7.5 # mm\ndpi = 150\nsave_path = 'example2.tiff'\n\nsize_randomness = 0.9 # set higher for more speckle size variety\nposition_randomness = 2.5 # set higher for more speckle position variety\nspeckle_blur = 0. # sigma of smothing Gaussian kernel\ngrid_step = 2. # approximate grid step, in terms of speckle diameter `D`\n\ngenerate_and_save(\n image_height, \n image_width, \n dpi, \n speckle_diameter, \n save_path,\n size_randomness=size_randomness,\n position_randomness=position_randomness,\n speckle_blur=speckle_blur,\n grid_step=grid_step,\n )\n```\n\n<p align='center'><img src='example2.jpg' width=400 alt='random speckle 2'/></p>\n\n#### Example line pattern\n\n```python\nfrom speckle_pattern import generate_lines\n\nimage_height = 50 # mm\nimage_width = 100 # mm\nline_width = 5 # mm\norientation = 'vertical'\ndpi = 200\nsave_path = f'example_lines_{orientation}.jpg'\n\ngenerate_lines(image_height, image_width, dpi, line_width, save_path)\n```\n\n<p align='center'><img src='example_lines_vertical.jpg' width=400 alt='vertical lines'/></p>\n\n#### Example checkerboard pattern\n\n```python\nfrom speckle_pattern import generate_checkerboard\n\nimage_height = 50 # mm\nimage_width = 100 # mm\nline_width = 4 # mm\ndpi = 200\nsave_path = f'example_checkerboard.jpg'\n\ngenerate_checkerboard(image_height, image_width, dpi, line_width=line_width, path=save_path)\n```\n\n<p align='center'><img src='example_checkerboard.jpg' width=400 alt='checkerboard'/></p>\n\n### Authors\n\n- [Domen Gorjup](http://ladisk.si/?what=incfl&flnm=gorjup.php)\n- [Janko Slavi\u010d](http://ladisk.si/?what=incfl&flnm=slavic.php)\n- [Miha Bolte\u017ear](http://ladisk.si/?what=incfl&flnm=boltezar.php)",
"bugtrack_url": null,
"license": null,
"summary": "Generate print-ready pattern images for DIC applications.",
"version": "1.3.3",
"project_urls": {
"Bug Tracker": "https://github.com/ladisk/speckle_pattern/issues",
"Homepage": "https://github.com/ladisk/speckle_pattern"
},
"split_keywords": [
"computer vision",
" dic",
" speckle pattern"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a305564e3840d5fdc2bc4ba89345a3514dbee67572305369af4f63bca58ac714",
"md5": "6c53d7e78422bc220cda1fa0a88374f1",
"sha256": "1b70ed695feea3947e392c8c6334591ce7c17d1acbe00d4826c0ed4488e8112f"
},
"downloads": -1,
"filename": "speckle_pattern-1.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c53d7e78422bc220cda1fa0a88374f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6706,
"upload_time": "2025-07-17T06:41:45",
"upload_time_iso_8601": "2025-07-17T06:41:45.705469Z",
"url": "https://files.pythonhosted.org/packages/a3/05/564e3840d5fdc2bc4ba89345a3514dbee67572305369af4f63bca58ac714/speckle_pattern-1.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 06:41:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladisk",
"github_project": "speckle_pattern",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "speckle-pattern"
}
JSON
