heavyedge-landmarks 1.0.0

Package to locate landmarks from edge profiles

HeavyEdge-Landmarks

Python package to locate landmarks from edge profiles.

Supports:

• Pseudo-landmark sampling.
• Mathematical landmark detection.
• Plateau fitting.

Usage

HeavyEdge-Landmarks provides functions to locate landmarks from multiple profiles.

A simple use case to locate 10 pseudo-landmarks:

from heavyedge import get_sample_path, ProfileData
from heavyedge_landmarks import pseudo_landmarks
with ProfileData(get_sample_path("Prep-Type2.h5")) as data:
    x = data.x()
    Ys, Ls, _ = data[:]
lm = pseudo_landmarks(x, Ys, Ls, 10)

Refer to the package documentation for more information.

Documentation

The manual can be found online:

https://heavyedge-landmarks.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:

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

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

Developing

Installation

For development features, you must install the package by pip install -e .[dev].

Testing

Run pytest command to perform unit test.