Skip to main content
Version: dev-latest

MetriCal Command: Plex Get

Usage​

Plex Get - CLI Example
metrical plex get [OPTIONS] <SUBCOMMAND> [PLEX_OR_RESULTS_PATH]

Purpose​

metrical plex get retrieves a specific element from a Plex and prints detailed information about it. This is useful for inspecting a particular component's intrinsics, or verifying the extrinsics and synchronization values for a specific constraint.

For a high-level summary of all components, constraints, or formations in a Plex, use metrical plex list instead.

Output can be formatted as a human-readable table (pretty, the default) or as JSON (json).

Examples​

Inspect a specific camera component​

metrical plex get component /camera/1 input.json

Get a spatial constraint as JSON​

metrical plex get --format json spatial-constraint --from /camera/1 --to /imu input.json

Read from stdin​

cat input.json | metrical plex get temporal-constraint --from /camera/1 --to /imu

Options​

Global Arguments​

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

--format [FORMAT]​

Default: pretty

The format in which to print the output. Possible values:

  • pretty: Pretty-print the data as a human-readable table.
  • json: Serialize the data as JSON.

Subcommands​

component <IDENTIFIER>​

Gets and prints the details of a specific component in the Plex.

Arguments​

IDENTIFIER​

The component to retrieve. Accepts a topic name (e.g., /camera/1) or a UUID.

[PLEX_OR_RESULTS_PATH]​

The path to the input Plex. If omitted, MetriCal will read the Plex from stdin.

spatial-constraint (alias: spatial)​

Gets and prints the details of the spatial constraint between two components.

Options​

--from [FROM]​

The component whose coordinate frame we are transforming from. Accepts a topic name or UUID.

--to [TO]​

The component whose coordinate frame we are transforming into. Accepts a topic name or UUID.

[PLEX_OR_RESULTS_PATH]​

The path to the input Plex. If omitted, MetriCal will read the Plex from stdin.

temporal-constraint (alias: temporal)​

Gets and prints the details of the temporal constraint between two components.

Options​

--from [FROM]​

The component whose clock we are transforming from. Accepts a topic name or UUID.

--to [TO]​

The component whose clock we are transforming into. Accepts a topic name or UUID.

[PLEX_OR_RESULTS_PATH]​

The path to the input Plex. If omitted, MetriCal will read the Plex from stdin.