Skip to content

geotrax visualize

Overlay extracted tracks on the video.

usage: geotrax visualize [-h] [--cfg CFG] [--set KEY=VALUE] [--output-folder OUTPUT_FOLDER]
                         [--log-path LOG_PATH] [--verbose] [--model MODEL [MODEL ...]]
                         [--class-names ID=NAME|FILE [ID=NAME|FILE ...]] [--save | --no-save | -s]
                         [--show | --no-show | -sh] [--viz-mode MODE [MODE ...]]
                         [--plot-trajectories | --no-plot-trajectories | -pt]
                         [--plot-delay PLOT_DELAY] [--show-conf | --no-show-conf | -sc]
                         [--show-lanes | --no-show-lanes | -sl]
                         [--show-class-names | --no-show-class-names | -scn]
                         [--hide-labels | --no-hide-labels | -hl]
                         [--hide-tracks | --no-hide-tracks | -ht]
                         [--hide-speed | --no-hide-speed | -hs] [--speed-unit {km/h,mi/h}]
                         [--speed-deadzone SPEED_DEADZONE]
                         [--class-filter CLASS_FILTER [CLASS_FILTER ...]]
                         [--tail-length TAIL_LENGTH] [--line-width LINE_WIDTH]
                         [--heading-smoothing HEADING_SMOOTHING]
                         [--heading-min-speed HEADING_MIN_SPEED]
                         [--edge-clip-margin EDGE_CLIP_MARGIN]
                         [--edge-clip-smoothing EDGE_CLIP_SMOOTHING]
                         [--cut-frame-left CUT_FRAME_LEFT] [--cut-frame-right CUT_FRAME_RIGHT]
                         source

Tracking Results Visualization

Positional arguments

Argument Value Config key Description
source Path to the input video file.

Optional arguments

Argument Value Config key Description
--cfg, -c CFG Pipeline config: a bundled preset name (default, confident, lenient, stable) or a path to a custom config file. Run 'geotrax config show' to list presets or 'geotrax config copy' to customize.
--set, -st KEY=VALUE Override a pipeline config value for this run; repeat for more than one, e.g. --set conf=0.35 --set iou=0.6. KEY is a dotted path ('ultralytics.conf') or any unambiguous tail of one ('conf'); an ambiguous or unknown key is an error that lists the candidates. VALUE is read with YAML rules, so true/null/0.35/[0,1,2] all mean what they do in the config file. Use the dedicated flag instead where one exists (it validates its input); passing both for the same key is an error.
--output-folder, -of OUTPUT_FOLDER output.folder Root folder for pipeline outputs. A bare name (e.g. 'results') creates a sub-folder next to each input video; an absolute path is used as-is for all inputs in a batch (not recommended when video filenames are not unique across the batch — outputs may overwrite each other). Also sets the base under which plots/ is created. Defaults to cfg -> output -> folder, historical default: 'results'.
--log-path, -lp LOG_PATH Where to write detailed logs: a directory (an auto-named <stage><timestamp><pid>.log file is created inside it, so concurrent or later runs never share a file) or a full file path ending in .log or .txt (any other new path is created as a directory). Defaults to a platform-specific log directory.
--verbose, -v Also show INFO messages on the console (default: warnings and key notices only).
--model, -m MODEL [MODEL ...] extraction.model Detection model used to resolve vehicle class names: a local path OR an 'hf://<org>/<repo>/<path/to/file>.pt' reference. Defaults to cfg -> extraction -> model.
--class-names, -cn ID=NAME|FILE [ID=NAME|FILE ...] extraction.class_rename Class-id -> name mapping: a .yaml/.json file or inline ID=NAME pairs (e.g. -cn 0=car 1=bus). Defaults to cfg -> extraction -> class_rename, then model names.

Visualization arguments

Argument Value Config key Description
--save, --no-save, -s visualization.save Save the annotated output video to file. Defaults to cfg -> visualization -> save.
--show, --no-show, -sh visualization.show Open a live preview window during processing. Defaults to cfg -> visualization -> show.
--viz-mode, -vm 0 | 1 | 2 | 3 | 4 visualization.viz_mode Frame source(s) for annotation: 0=original, 1=stabilized, 2=reference frame, 3=rotated boxes on the original frame, 4=rotated boxes on the stabilized frame (3 and 4 rotate each box to the vehicle's per-frame heading; both require stabilization). Accepts multiple values, e.g. "--viz-mode 0 1 4" renders one video per mode. Defaults to cfg -> visualization -> viz_mode.
--plot-trajectories, --no-plot-trajectories, -pt visualization.plot_trajectories Overlay trajectory positions on the first frame. Defaults to cfg -> visualization -> plot_trajectories.
--plot-delay, -pd PLOT_DELAY visualization.plot_delay Number of frames to display the trajectory overlay; only relevant when --plot-trajectories is enabled. Defaults to cfg -> visualization -> plot_delay.
--show-conf, --no-show-conf, -sc visualization.show_conf Include detection confidence in bounding-box labels. Defaults to cfg -> visualization -> show_conf.
--show-lanes, --no-show-lanes, -sl visualization.show_lanes Include lane ID in bounding-box labels. Defaults to cfg -> visualization -> show_lanes.
--show-class-names, --no-show-class-names, -scn visualization.show_class_names Include vehicle class name in bounding-box labels. Defaults to cfg -> visualization -> show_class_names.
--hide-labels, --no-hide-labels, -hl visualization.hide_labels Suppress all label text overlays. Defaults to cfg -> visualization -> hide_labels.
--hide-tracks, --no-hide-tracks, -ht visualization.hide_tracks Suppress track tail lines. Defaults to cfg -> visualization -> hide_tracks.
--hide-speed, --no-hide-speed, -hs visualization.hide_speed Suppress speed values in labels. Defaults to cfg -> visualization -> hide_speed.
--speed-unit, -su km/h | mi/h visualization.speed_unit Speed display unit: km/h or mi/h. Defaults to cfg -> visualization -> speed_unit.
--speed-deadzone, -sdz SPEED_DEADZONE visualization.speed_deadzone Floor displayed speeds at or below this value (in the chosen speed unit) to 0, hiding stationary-vehicle jitter; 0 disables. Defaults to cfg -> visualization -> speed_deadzone.
--class-filter, -cf CLASS_FILTER [CLASS_FILTER ...] visualization.class_filter Vehicle class IDs to exclude from visualization (e.g., -cf 1 2). Defaults to cfg -> visualization -> class_filter.
--tail-length, -tl TAIL_LENGTH visualization.tail_length Number of past positions drawn as a fading track trail [frames]; [1, inf). Defaults to cfg -> visualization -> tail_length.
--line-width, -lw LINE_WIDTH visualization.line_width Bounding-box and track stroke width [px]; [1, inf). Defaults to cfg -> visualization -> line_width.
--heading-smoothing, -hsm HEADING_SMOOTHING visualization.heading_smoothing (modes 3, 4) Gaussian smoothing window [frames] for the per-frame heading; larger = steadier, slower to follow turns. Defaults to cfg -> visualization -> heading_smoothing.
--heading-min-speed, -hms HEADING_MIN_SPEED visualization.heading_min_speed (modes 3, 4) Minimum smoothed pixel speed [px/frame] for a reliable heading; below this the heading is held from the last reliable frame. Defaults to cfg -> visualization -> heading_min_speed.
--edge-clip-margin, -ecm EDGE_CLIP_MARGIN visualization.edge_clip_margin (modes 3, 4) Distance [px] within which a detection box is treated as touching a frame edge, triggering clipping of the oriented box to the visible part (absorbs HBB inaccuracy). Defaults to cfg -> visualization -> edge_clip_margin.
--edge-clip-smoothing, -ecs EDGE_CLIP_SMOOTHING visualization.edge_clip_smoothing (modes 3, 4) Gaussian window [frames] for smoothing the clip rectangle of edge-touching boxes; larger = steadier shape as the vehicle exits, 0 disables. Defaults to cfg -> visualization -> edge_clip_smoothing.
--cut-frame-left, -cfl CUT_FRAME_LEFT processing.cut_frame_left Skip the first N frames. Defaults to cfg -> processing -> cut_frame_left.
--cut-frame-right, -cfr CUT_FRAME_RIGHT processing.cut_frame_right Stop processing after this frame. Defaults to cfg -> processing -> cut_frame_right.