Skip to main content

ktch is a python package for model-based morphometrics.

Project description

ktch - A Python package for model-based morphometrics

PyPI version Anaconda-Server Badge codecov License Python

ktch is a Python package for model-based morphometrics with scikit-learn compatible APIs.

Overview

ktch implements the following morphometric analysis methods:

  • Landmark-based methods: Generalized Procrustes Analysis (GPA) with curve/surface semilandmark sliding, thin-plate spline interpolation
  • Harmonic-based methods: Elliptic Fourier Analysis (EFA) for 2D/3D closed curves, spherical harmonic analysis (SPHARM) and disk harmonic analysis (DHA) for surfaces
  • Theoretical morphological models of coiling: Raup's model and the growing tube model
  • File I/O: Support for standard morphometric file formats (TPS, CHC, SPHARM-PDM)
  • Datasets: Built-in example datasets for learning and testing
  • Visualization: TPS deformation grids, PCA variance plots (with optional plot extra)

All analysis classes follow the scikit-learn API (fit, transform, fit_transform), so you can plug them into your existing pipelines.

Installation

Python >= 3.11 is required.

From PyPI

pip install ktch

From conda-forge

conda install -c conda-forge ktch

Optional dependencies

Via PyPI:

pip install ktch[plot]  # matplotlib, plotly, seaborn for visualization
pip install ktch[data]  # pooch for remote dataset downloads

Via conda-forge:

conda install -c conda-forge ktch-plot  # matplotlib, plotly, seaborn for visualization
conda install -c conda-forge ktch-data  # pooch for remote dataset downloads
conda install -c conda-forge ktch-all   # all optional dependencies

Development installation

git clone https://github.com/noshita/ktch.git
cd ktch
uv sync

Quick start

Elliptic Fourier Analysis on 2D outlines

from sklearn.decomposition import PCA

from ktch.datasets import load_outline_mosquito_wings
from ktch.harmonic import EllipticFourierAnalysis

# Load outline data (126 specimens, 100 points, 2D)
data = load_outline_mosquito_wings()
coords = data.coords

# Elliptic Fourier Analysis
efa = EllipticFourierAnalysis(n_harmonics=20)
coeffs = efa.fit_transform(coords)

# PCA on EFA coefficients
pca = PCA(n_components=5)
pc_scores = pca.fit_transform(coeffs)

Documentation

See doc.ktch.dev for full documentation:

  • Tutorials: Step-by-step guides for GPA, EFA, spherical harmonics, and more
  • How-to guides: Task-oriented recipes for data loading, visualization, and pipeline integration
  • Explanation: Theoretical background on morphometric methods
  • API reference: Complete API documentation

Contributing

Bug reports and feature requests are welcome via GitHub Issues.

See CONTRIBUTING.md for development setup and conventions.

License

ktch is licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ktch-0.10.0.tar.gz (722.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ktch-0.10.0-py3-none-any.whl (744.1 kB view details)

Uploaded Python 3

File details

Details for the file ktch-0.10.0.tar.gz.

File metadata

  • Download URL: ktch-0.10.0.tar.gz
  • Upload date:
  • Size: 722.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for ktch-0.10.0.tar.gz
Algorithm Hash digest
SHA256 3a12d4b14bfed05c576fd520206ba71ed750a49a52ac32d9345aa203f4e7e9c3
MD5 5d304efc3d766d03123f1c477298f97b
BLAKE2b-256 4899587ed9067a1b1fdb4fb59c7f8f811476a4e0b8b505088f32e0cb685df2fb

See more details on using hashes here.

File details

Details for the file ktch-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: ktch-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 744.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for ktch-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41e381f367c05197523113166add48603fe8ac4d71c10df72f44b91a58d22574
MD5 e13a06e2a24adbf496b76531c01a1221
BLAKE2b-256 b9cbdd340647624c1621374b207bba2335e0824dd0a5a18e92506ec95074a18d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page