Skip to content

Analysis Module

cjgabrie edited this page Oct 20, 2026 · 11 revisions

Analysis Module

The Analysis Module imports tracking, prepares cleaned tracking and metrics, optionally applies spatial or temporal filters, runs selected classifiers, and saves results beside the source data.

Before you start

Review Prepare Inputs. Select the correct tracking type, enter a pixels-per-centimeter calibration, and choose the classifiers and smoothing options appropriate for the recording.

BehaviorDEPOT v1.7 analysis module settings

Single-session workflow

  1. Launch BehaviorDEPOTv1.7 from MATLAB's Apps tab.
  2. Select classifier rows to run. Use Edit only when you need to change classifier parameters from their defaults.
  3. Under Options, set the calibration, likelihood cutoff, smoothing method and span, and Hampel correction as needed.
  4. Optionally enable custom ROIs, cue-event filtering, and output plots.
  5. Choose Single session, then start analysis and select the tracking file and video.
  6. In the registration window, map each detected tracking label to a known body part. Named parts are unique; use Other for additional points. Review the prefilled mapping before confirming.
  7. Draw and name any requested ROIs. Complete every ROI before continuing.
  8. Review results in <video-stem>_analyzed beside the video.

Register tracked parts

The registration window displays an example tracking frame beside the mapping controls. Assign each detected label to the matching known part, then select Confirm Mapping. A named known part can be selected only once; select Other for an additional or unrecognized point.

Tracked-part registration with preview and detected-to-known part mapping

Draw custom ROIs

When custom ROIs are enabled, draw and name each region in the integrated ROI window. Use Redraw ROI or Delete Current ROI before confirming if a region needs correction.

First custom ROI drawn and named Platform

For multiple ROIs, the window retains previously completed regions while you draw and name the next one.

Second custom ROI added while the first ROI remains visible

Batch-session workflow

  1. Prepare the folder layout described in Inputs.
  2. Choose Batch process and start analysis.
  3. Select the batch root folder.
  4. Complete keypoint registration and ROI prompts for the first session.
  5. When prompted, choose whether later sessions reuse ROI names and limits, names only, or neither. Choose whether cue names should be reused.
  6. Review the output folder created inside each session folder.

When the first session's registration is complete, choose whether later batch sessions should reuse the same tracked-part mapping.

Prompt to reuse a tracked-part mapping for later batch sessions

For custom ROIs, choose whether to reuse both ROI names and limits, reuse names only, or define new ROIs for later sessions.

Prompt to reuse ROI names and limits for later batch sessions

Optional filters and plots

  • Custom ROIs report the intersection of selected behavior and named spatial regions.
  • Cue files report behavior relative to frame-locked events.
  • Spatial, spatiotemporal, and behavior-location plots are optional visual summaries; they do not alter classifier output.

When prompted after selecting cue filtering, enter a concise name for the time-locked event.

Cue-event name prompt

Common workflow decisions

Use a single analysis to test tracking, calibration, mappings, and parameters. Use batch processing only after a representative single session produces the expected result. See Help & Troubleshooting for input and dialog problems.

Clone this wiki locally