deeplabcut-analysis-jupyter-scripts

While DLCAnalyzer and DLC Helper functions are great. They fail to accommodate a vast range of behavior investigator's needs. The Jupyter script provided here is meant for post processing/analyzing DeepLabCut (DLC) CSV files. The script allows user to filter data, calculate velocities, draw Region of Interest (ROI), and more.

https://github.com/farhanaugustine/deeplabcut-analysis-jupyter-scripts

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

While DLCAnalyzer and DLC Helper functions are great. They fail to accommodate a vast range of behavior investigator's needs. The Jupyter script provided here is meant for post processing/analyzing DeepLabCut (DLC) CSV files. The script allows user to filter data, calculate velocities, draw Region of Interest (ROI), and more.

Basic Info
  • Host: GitHub
  • Owner: farhanaugustine
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 508 KB
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 2
  • Open Issues: 0
  • Releases: 1
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

DOI

Designer1


Analysis of Mouse Movement Data


Video Tutorial and Walkthrough: Link


Overview

While DLCAnalyzer and DLC Helper functions are great. They fail to accommodate a vast range of behavior investigator's needs. The Jupyter script provided here is meant for post processing/analyzing DeepLabCut (DLC) CSV files. The script allows user to filter data, calculate velocities, draw Region of Interest (ROI), and more.

This document provides a summary of a Python script designed to analyze mouse movement data. The script is structured as a Jupyter Notebook and includes various functionalities such as loading data, defining regions of interest (ROIs), and calculating distances and velocities.

Package Requirements

The script requires the following Python packages: - pandas for data manipulation and analysis. - numpy for numerical operations. - scipy.signal for signal processing tasks. - matplotlib for plotting graphs. - matplotlib.widgets for interactive graph features.

Data Loading

The script loads a CSV file containing mouse movement data into a pandas DataFrame. This data is expected to have multiple header rows that define body parts and their corresponding x, y coordinates, and likelihood values.

Data Preparation

A dictionary called body_part_data is created to map body part names to their respective coordinate columns and likelihood values. This allows for easy access to each body part's data throughout the analysis.

Region of Interest (ROI) Definition

The script includes functionality for the user to define an ROI by drawing a rectangle on a plot of the data. The coordinates of the ROI are stored for further analysis.

Movement Analysis

The script calculates the distance moved by each body part, taking into account the likelihood of detection to filter out noise. It also calculates velocities using the Savitzky-Golay filter to smooth the data.

Output

The script outputs the following: - The total distance moved by each body part within the ROI. - The average velocity of each body part. - The total time each body part spent within the ROI. - Any detected jumps or significant movements between frames that exceed a predefined threshold.

Conclusion

The script is a comprehensive tool for analyzing mouse movement data, providing insights into the behavior and movement patterns of the subject. It is designed to be adaptable to different datasets and can be modified to suit specific analysis needs.


Please ensure that all the necessary data files are correctly located and that the required Python packages are installed before running the script. For detailed instructions on how to use each functionality, refer to the comments and documentation within the script itself. If you encounter any issues or have further questions, please consult the troubleshooting section or reach out for support.

Owner

  • Name: Farhan
  • Login: farhanaugustine
  • Kind: user
  • Location: Maryland
  • Company: University of Maryland Baltimore County

Citation (CITATION.cff)

Abstract: "While DLCAnalyzer and DLC Helper functions are great, they fail to accommodate a wide range of behavior investigators' needs. The Jupyter script provided here is meant for post-processing/analyzing DeepLabCut (DLC) CSV files. The script allows users to filter data, calculate velocities, draw Region of Interest (ROI), and more."
authors:
  - family-names: Augustine
    given-names: Farhan
    orcid: "https://orcid.org/0000-0002-8348-6039"
cff-version: 0.1.0
date-released: "02-12-2024"
identifiers:
  - description: "This is the collection of archived snapshots of the latest release versions of DeepLabCut-Analysis-Jupyter-Scripts."
    type: doi
    value: 10.5281/zenodo.10866995
  - description: "This is the archived snapshot of version 0.1.0 of the Jupyter script developed for DeepLabCut CSV file analysis."
    type: doi
    value: 10.5281/zenodo.10866995
keywords:
  - DeepLabCutAnalysis
  - AnimalBehaviorResearch
license: 
  - GPL-3.0
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/farhanaugustine/DeepLabCut-Analysis-Jupyter-Scripts"
title: "DeepLabCut-Analysis-Jupyter-Scripts"
version: 0.1.0

GitHub Events

Total
  • Watch event: 3
  • Fork event: 1
Last Year
  • Watch event: 3
  • Fork event: 1