Visitar URL original
Add Cookbook recipe: fish swimming kinematics from DeepLabCut by Denny-Hwang · Pull Request #3398 · DeepLabCut/DeepLabCut · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
move fish kinematics recipe to dlc-utils community contributions
  • Loading branch information
deruyter92 committed Nov 4, 2026
commit 3c67316991d6bde848b416819a2ef7835d808869
2 changes: 1 addition & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ parts:
- file: docs/recipes/io
- file: docs/recipes/nn
- file: docs/recipes/post
- file: docs/recipes/fish_swimming_kinematics
- file: docs/recipes/BatchProcessing
- file: docs/recipes/DLCMethods
- file: docs/recipes/ClusteringNapari
Expand All @@ -119,6 +118,7 @@ parts:
- file: docs/dlc-utils/index
sections:
- file: docs/dlc-utils/XROMM/usage
- file: docs/dlc-utils/fish_kinematics/usage

- caption: Project & Community
chapters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ deeplabcut:
ignore: false
---

(file:fish-swimming-kinematics)=

# Deriving fish swimming kinematics and choosing a reliable observation duration

> Contributed by [@Denny-Hwang](https://github.com/Denny-Hwang)

This recipe shows how to turn DeepLabCut pose tracks of a swimming fish into
common **swimming-kinematics metrics** — tail-beat frequency, swimming speed,
body curvature, and a day/night (diel) index — and how to decide **how long you
Expand Down Expand Up @@ -205,4 +209,4 @@ environment), but the workflow that produces them is general.
Method adapted from Hwang et al. (2026), *Ecological Informatics* 95, 103760
([DOI](https://doi.org/10.1016/j.ecoinf.2026.103760),
[reference code](https://github.com/Denny-Hwang/FishML_Observation_to_Replication)).
Please also [cite DeepLabCut](../citation.md).
Please also [cite DeepLabCut](../../citation.md).
10 changes: 10 additions & 0 deletions docs/dlc-utils/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ In that local layout, `XROMM_DLCTools` uses the optional `dlc` dependency group

See {ref}`file:xamalab-dlc-integration` for the local integration notes and exact commands.

## Fish swimming kinematics and reliable observation duration

> Contributed by [@Denny-Hwang](https://github.com/Denny-Hwang)

Derive swimming-kinematics metrics (tail-beat frequency, swimming speed, body curvature, and a day/night index) from single-animal DeepLabCut pose tracks of fish, and use the Spearman–Brown reliability formula to estimate how long you need to record before each metric is stable. Adapted from Hwang et al. (2026), *Ecological Informatics* 95, 103760.

- [Reference code: `FishML_Observation_to_Replication`](https://github.com/Denny-Hwang/FishML_Observation_to_Replication)

See {ref}`file:fish-swimming-kinematics` for the full recipe.

## Using your DLC outputs, loading, simple ROI analysis, visualization examples

### Time spent of a body part in a particular region of interest (ROI)
Expand Down
Loading