Report Mode

Purpose

• Generate the report from a plex or the output file of a calibration.

Usage

metrical report [OPTIONS] <PLEX_OR_RESULTS_PATH>

Concepts

The Report command is primarily used to re-generate the full report from a calibration output. It will also print any provided plex file in a human-readable format.

If an origin and secondary component are provided, then MetriCal will extract the relevant component and constraint data between those two items. Origin will act as the origin for any constraints. This is useful for a gut-check of a calibration parameter or two.

If you need to reformat a plex into something more convenient for your application, use Shape command instead.

Examples

Print a plex in a human-readable format

metrical report $PLEX

Generate a report using the output file from a calibration

metrical calibrate -o $RESULTS $DATA $INIT_PLEX $OBJ
metrical report $RESULTS

Print the constraints between two components in a human-readable format

metrical report -a ir_one -b ir_two $PLEX

Arguments

[PLEX_OR_RESULTS_PATH]

The path to the input plex. This can be a MetriCal results JSON or a plex JSON.

Options

Universal Options

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

-a, --origin [ORIGIN]

The origin component, if provided. Must have a secondary component option as well.

-b, --secondary [SECONDARY]

The secondary component, if provided. Must have an origin component option as well.