speckle-pattern


Namespeckle-pattern JSON
Version 1.3.2 PyPI version JSON
download
home_page
SummaryGenerate print-ready pattern images for DIC applications.
upload_time2022-12-13 12:16:25
maintainer
docs_urlNone
author
requires_python>=3.10
license
keywords computer vision dic speckle pattern
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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": "",
    "name": "speckle-pattern",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "computer vision,dic,speckle pattern",
    "author": "",
    "author_email": "\"Domen Gorjup, Janko Slavi\u010d, Miha Bolte\u017ear\" <janko.slavic@fs.uni-lj.si>",
    "download_url": "https://files.pythonhosted.org/packages/7f/6c/8020df80f9539d1f1e5730e5e842c2ddc6d23af7fcd01fe384aa9877ccda/speckle_pattern-1.3.2.tar.gz",
    "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": "",
    "summary": "Generate print-ready pattern images for DIC applications.",
    "version": "1.3.2",
    "split_keywords": [
        "computer vision",
        "dic",
        "speckle pattern"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d1b420ba656f3f58e35db9507e5169c1",
                "sha256": "8b7821dbd5223d3813d8a8e91ed6c60b0fd8df4e9c92a1492b006cd2f6d40567"
            },
            "downloads": -1,
            "filename": "speckle_pattern-1.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d1b420ba656f3f58e35db9507e5169c1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 6168,
            "upload_time": "2022-12-13T12:16:22",
            "upload_time_iso_8601": "2022-12-13T12:16:22.732543Z",
            "url": "https://files.pythonhosted.org/packages/dd/86/4ffe6b2cee0d5c17f4a96ade7b2958d7aa9d5f46da04b68e3f603f2e920a/speckle_pattern-1.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e27cc7882c9ccea6ad91001bd4a0723a",
                "sha256": "3ebed0886ae3c32ec49c12335d7fef09b418750bf537a2187153412bd0fa54f0"
            },
            "downloads": -1,
            "filename": "speckle_pattern-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "e27cc7882c9ccea6ad91001bd4a0723a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 605027,
            "upload_time": "2022-12-13T12:16:25",
            "upload_time_iso_8601": "2022-12-13T12:16:25.053567Z",
            "url": "https://files.pythonhosted.org/packages/7f/6c/8020df80f9539d1f1e5730e5e842c2ddc6d23af7fcd01fe384aa9877ccda/speckle_pattern-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-13 12:16:25",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "speckle-pattern"
}
        
Elapsed time: 0.01715s