Metadata-Version: 2.1
Name: dipcoatimage-finitedepth-ifd
Version: 0.2.0
Summary: Measure finite depth dip coating roughness with integral Fréchet distance.
Author-email: Jisoo Song <jeesoo9595@snu.ac.kr>
License: BSD 2-Clause License
        
        Copyright 2024, Jisoo Song
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/dipcoat-image/finitedepth-ifd
Project-URL: source, https://github.com/dipcoat-image/finitedepth-ifd
Project-URL: documentation, https://dipcoatimage-finitedepth-ifd.readthedocs.io
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dipcoatimage-finitedepth >=2.0.5
Requires-Dist: curvesimilarities >=0.1.5
Requires-Dist: numpy <2
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: flake8-pyi ; extra == 'dev'
Requires-Dist: flake8-docstrings ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: docformatter ; extra == 'dev'
Requires-Dist: doc8 ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: dipcoatimage-finitedepth-ifd[doc] ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: numpydoc ; extra == 'doc'
Requires-Dist: pydata-sphinx-theme ; extra == 'doc'
Requires-Dist: matplotlib ; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

# DipCoatImage-FiniteDepth-IFD

[![License](https://img.shields.io/github/license/dipcoat-image/finitedepth-ifd)](https://github.com/dipcoat-image/finitedepth-ifd/blob/master/LICENSE)
[![CI](https://github.com/dipcoat-image/finitedepth-ifd/actions/workflows/ci.yml/badge.svg)](https://github.com/dipcoat-image/finitedepth-ifd/actions/workflows/ci.yml)
[![CD](https://github.com/dipcoat-image/finitedepth-ifd/actions/workflows/cd.yml/badge.svg)](https://github.com/dipcoat-image/finitedepth-ifd/actions/workflows/cd.yml)
[![Docs](https://readthedocs.org/projects/dipcoatimage-finitedepth-ifd/badge/?version=latest)](https://dipcoatimage-finitedepth-ifd.readthedocs.io/en/latest/?badge=latest)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/dipcoatimage-finitedepth-ifd.svg)](https://pypi.python.org/pypi/dipcoatimage-finitedepth-ifd/)
[![PyPI Version](https://img.shields.io/pypi/v/dipcoatimage-finitedepth-ifd.svg)](https://pypi.python.org/pypi/dipcoatimage-finitedepth-ifd/)

![Header image](https://dipcoatimage-finitedepth-ifd.readthedocs.io/en/latest/_images/plot-header.png)

A [DipCoatImage-FiniteDepth](https://pypi.org/project/dipcoatimage-finitedepth/) plugin to measure roughness with integral Fréchet distance.

## Usage

- Use `RectIfdRoughness` for substrate with rectangular cross section.
- Define your own class by subclassing `IfdRoughnessBase`.

Refer to the documentation for the API reference.

The command-line analysis is also applicable. An YAML example of the configuration file is:

```
data:
  ...
  layer:
    type: RectIfdRoughness
    parameters:
      roughness_type: "arithmetic"
      delta: 5.0
      opening_ksize: [1, 1]
      reconstruct_radius: 50
```

Refer to the DipCoatImage-FiniteDepth package for more information.

## Installation

DipCoatImage-FiniteDepth-IFD can be installed using `pip`.

```
$ pip install dipcoatimage-finitedepth-ifd
```

## Documentation

The manual can be found on Read the Docs:

> https://dipcoatimage-finitedepth-ifd.readthedocs.io

If you want to build the document yourself, get the source code and install with `[doc]` dependency. Then, go to `doc` directory and build the document.

The full command is (from the project root directory)

```
$ pip install .[doc]
$ cd doc
$ make html
```

Document will be generated in `build/html` directory. Open `index.html` to see the central page.
