Advanced features

Follow this page for information regarding advanced features.

CLI Command Reference

Marso supports a Command Line Interface (CLI) for use in programmatic workflows where a GUI would be undesirable.

A number of subcommands are available for querying, creating, configuring, and executing jobs. These commands can be chained together into a single invocation as required.

Subcommands

logout       Logout from the current account
login        Login to an account
activate     Activate the current machine for processing with Marso
configure    Configure the application settings
status       Show current system status
models       Interact with available models and their details.
job          Manage jobs in the Marso Processing Service
queue        View and manage the processing queue

All sub-commnds can be run with initial options to control the console behaviour:

-q,--quiet      Suppress all terminal output
-v,--verbose    Enable Verbose logging
-V,--trace      Enable Trace logging

E.g. No console output, trace logs in the log file:

M-XR_Marso_CLI.exe -q -V login

Configure

M-XR_Marso_CLI configure --scratch-path <path> show

Sets the scratch directory for the current machine. This is where temporary files will be stored during processing. It is recommended that the scratch directory is on a drive with fast R/W speeds to improve processing times, and has 250 - 750GB of available space, depending on the resolution you wish to process at.

The show option displays the current configuration after it has been set.

Job

The job command is used to control jobs and has several subcommands:

list          List all available jobs
create        Create a new job
deactivate    Deactivate the currently active job
delete        Delete a job
activate      Activate the current job for use with future commands
lights        Set the lights for a job
exposure      Set the exposure for a job
prepare       Prepare Job for geometry solve
process       Execute Marso Processing for the Job
export        Export the textures predicted by a job

Some common command combinations are listed below.

---

Create a new job, set it as the currently active job for future commands, set the light system, and execute the prepare step to create images for photogrammetry.

M-XR_Marso_CLI.exe job create --name <name> --raw-folder <path> activate lights --add-light 0 0 0.2 prepare --file-type exr --output-path <path>

After this the job will have been created, and photogrammetry can be done with the files produced by prepare.

---

Set the exposure for a job. The job id must be specified if there is no active job.

M-XR_Marso_CLI.exe job exposure --calibration-raw-file <path> --distance <value> --grey-value <value>

---

Process a job. The job id must be specified if there is no active job.

M-XR_Marso_CLI.exe job process --abc <path> --st-map <path> -r <resolution> --models <model1> <model2>

---

Export the textures predicted by a job. The job id must be specified if there is no active job.

M-XR_Marso_CLI.exe job export --output-path <path> --file-type <file_type>

Export also has a list subcommand to list the available exports, as each model must be exported individually if the process stage was run with multiple models.

Previous runs of the job can also be re-exported by specifying the --previous-run option with the number from the list row.