Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with description and installation instructions #7

Merged
merged 2 commits into from
Jan 26, 2022
Merged

Update readme with description and installation instructions #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b69c74c
Update readme with desription and installation instructions
rly Jan 26, 2022
a798150
Update README.md
rly Jan 26, 2022
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
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# ndx-pose Extension for NWB

This is a work in progress and not yet ready for public usage.
[![PyPI version](https://badge.fury.io/py/ndx-pose.svg)](https://badge.fury.io/py/ndx-pose)

ndx-pose is a standardized format for storing pose estimation data in NWB. It was developed initially to store the
output of [DeepLabCut](http://www.mackenziemathislab.org/deeplabcut) in NWB, but is also designed to store the output
of general pose estimation tools. Please post an issue or PR to suggest or add support for your favorite pose
estimation tool.

This extension consists of two new neurodata types:
- `PoseEstimationSeries` which stores the estimated positions (x, y) or (x, y, z) of a body part over time as well as
the confidence/likelihood of the estimated positions.
- `PoseEstimation` which stores the estimated position data (`PoseEstimationSeries`) for multiple body parts,
computed from the same video(s) with the same tool/algorithm.

## Installation

TBD
`pip install ndx-pose`

## Usage
```python
Expand Down