Skip to main content
Version: dev-latest

Spec New

Usage​

Spec New - CLI Example
metrical spec new [OPTIONS]
Spec New - Manifest Example
command = "spec-new"
output = "{{auto}}"

Purpose​

metrical spec new creates a new system specification template file. The template is written in JSONC (JSON with comments) and includes example values for all three top-level sections (camera_bases, camera_field_of_view, and mechanical_layout), with inline comments explaining each field.

This is the fastest way to get started with a system specification. Edit the generated file to match your sensor rig, then pass it to metrical plex learn via the -S flag.

Examples​

Create a template and edit it​

metrical spec new -o my_spec.jsonc
# Edit my_spec.jsonc to match your sensor rig, then:
metrical plex learn -S my_spec.jsonc --dataset data.mcap -m '*camera*:opencv-radtan' -o plex.json

Use the default output path​

metrical spec new
# Creates system_spec.jsonc in the current directory

Options​

Global Arguments​

As with every command, all global arguments are supported (though not all may be used).

-o, --output [OUTPUT]​

The path to write the new system specification template. Defaults to system_spec.jsonc.

The command will fail if the output file already exists; it will not overwrite an existing file.