Command line interfaces

NAPS – Hybrid tracking using SLEAP and ArUco tags

usage: naps-track [-h] --slp-path SLP_PATH [--h5-path H5_PATH] --video-path
                  VIDEO_PATH --tag-node-name TAG_NODE_NAME --start-frame
                  START_FRAME --end-frame END_FRAME
                  [--half-rolling-window-size HALF_ROLLING_WINDOW_SIZE]
                  --aruco-marker-set ARUCO_MARKER_SET
                  [--aruco-marker-subset ARUCO_MARKER_SUBSET [ARUCO_MARKER_SUBSET ...]]
                  [--aruco-crop-size ARUCO_CROP_SIZE]
                  [--aruco-adaptive-thresh-win-size-min ADAPTIVETHRESHWINSIZEMIN]
                  [--aruco-adaptive-thresh-win-size-max ADAPTIVETHRESHWINSIZEMAX]
                  [--aruco-adaptive-thresh-win-size-step ADAPTIVETHRESHWINSIZESTEP]
                  [--aruco-adaptive-thresh-constant ADAPTIVETHRESHCONSTANT]
                  [--aruco-perspective-rm-ignored-margin PERSPECTIVEREMOVEIGNOREDMARGINPERCELL]
                  [--aruco-error-correction-rate ERRORCORRECTIONRATE]
                  [--output-path OUTPUT_PATH]

Named Arguments

--slp-path

The filepath of the SLEAP (.slp or .h5) file to pull coordinates from. This should correspond with the input video file

--h5-path

The filepath of the analysis h5 file to pull coordinates from. This should correspond with the input video file and slp file

--video-path

The filepath of the video used with SLEAP

--tag-node-name

The ArUco tag SLEAP node name

Default: “tag”

--start-frame

The zero-based fully-closed frame to begin NAPS assignment

--end-frame

The zero-based fully-closed frame to stop NAPS assignment

--half-rolling-window-size

Specifies the number of flanking frames (prior and subsequent) required in the rolling window for Hungarian matching a frame

Default: 5

--aruco-marker-set

The ArUco markers used in the video

--aruco-marker-subset

The ArUco markers used in the video

--aruco-crop-size

The number of pixels horizontally and vertically around the aruco SLEAP node to identify the marker

Default: 50

--aruco-adaptive-thresh-win-size-min

Specifies the value for adaptiveThreshWinSizeMin

Default: 10

--aruco-adaptive-thresh-win-size-max

Specifies the value for adaptiveThreshWinSizeMax

Default: 30

--aruco-adaptive-thresh-win-size-step

Specifies the value for adaptiveThreshWinSizeStep

Default: 12

--aruco-adaptive-thresh-constant

Specifies the value for adaptiveThreshConstant

Default: 3

--aruco-perspective-rm-ignored-margin

Specifies the value for perspectiveRemoveIgnoredMarginPerCell

Default: 0.13

--aruco-error-correction-rate

Specifies the value for errorCorrectionRate

Default: 1

--output-path

Output path of the resulting SLEAP analysis file.

Default: “output.analysis.h5”