Skip to content

CLI Parameters

Simon edited this page Mar 25, 2021 · 21 revisions

CLI Parameters

Default pipeline:

aliceVision_cameraInit -> aliceVision_featureExtraction -> aliceVision_imageMatching -> aliceVision_featureMatching -> aliceVision_incrementalSfM -> aliceVision_prepareDenseScene -> aliceVision_depthMapEstimation -> aliceVision_depthMapFiltering -> aliceVision_meshing -> aliceVision_depthMapFiltering -> aliceVision_texturing

Help information is provided when running the nodes without parameters.

AliceVision Meshroom CLI

It is recommended to use Meshroom (https://github.com/alicevision/meshroom/releases) as it includes the following (cli) tools:

meshroom_photogrammetry

Loads all available nodes. Loads the default graph, you only need to provide --input or --inputImages. You can override specific node settings.

  • meshroom_photogrammetry: "--save" does not disable the computation so you can save your batch reconstruction project and open it later interactively in Meshroom. Additionnal --compute option if you need only to create a Meshroom project file from this command line.
  • meshroom -h / --help": command line documentation
  • meshroom: "--pipeline" option to override the default pipeline with your own project file. It also supports an environment variable MESHROOM_DEFAULT_PIPELINE.
  • meshroom_photogrammetry: "--paramOverrides NODE.param=value" allows to set a parameter directly from the command line.

Example (enable GPU in FE): --paramOverrides FeatureExtraction:forceCpuExtraction=0

meshroom_compute

Loads all available nodes. Here you can use a graph file. If you create the file via the Meshroom GUI, you may need to modify paths within the mg file.

positional arguments:

GRAPHFILE.mg Filepath to a graph file.

optional arguments:

-h, --help show this help message and exit
--node NODE_NAME
  Process the node. It will generate an error if the dependencies are not already computed.
--toNode NODE_NAME
  Process the node with its dependencies.
--forceStatus Force computation if the status is RUNNING or SUBMITTED.
--forceCompute Compute in all cases even if already computed.
--extern Use this option when you compute externally after submission to a render farm from meshroom.
--cache FOLDER Override the cache folder

-i,--iteration ITERATION Number of iterations

Clone this wiki locally