dipcoatimage-finitedepth-ifd 0.1.1

Measure finite depth dip coating roughness with integral Fréchet distance.

DipCoatImage-FiniteDepth-IFD

A 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.