Below you can find a list of command-line interface commands that can be used to run processes in RealityCapture. More information about command-line interface as well as the examples of scripts can be found in the application Help.
The list of CLI commands is relevant for version 1.2.0.16813 Tarasque. Command-line interface is supported in ENTERPRISE license and PPI mode.
Licenses
The following commands and examples in this section can be used for activation of the standard licenses or using the PPI version of RealityCapture.
| Command Name |
Required |
Optional Parameter | Description |
|---|---|---|---|
|
getLicense |
pin|pinCertificateFile |
Get PPI licenses for all images in the scene. Both pin and its pinCertificateFile can be generated here. |
|
|
activate |
activationToken |
Activate a license using an activation token (activationToken) generated in your MY account at our webpage - section Licenses. The license will be activated and renewed with a 3-day period. You can disable the automatic activation renewal using -set "appLicenseAutoRenew=false". Example: Realitycapture.exe –activate 9002677B0FBF8BA63E720835391BBB75A18 |
|
|
importLicense |
mylicense.rclicense |
Import input licenses stored in the filename.rclicense file. The file may contain one or more licenses. All of them will be imported to the system. The application will use them instead of contacting the licensing server if licenses for all used inputs are contained. Otherwise the licensing server is contacted. For example: Realitycapture.exe –importLicense "c:\licenses\mylicense.rclicense" |
|
|
exportLicense |
mylicense.rclicense |
true/false |
Use this command to export all currently imported licenses. By exporting licenses, you store the rights to process inputs. This typically means offline, free-of-charge processing of the same inputs or a subset of these inputs in the future. Use the optional parameter set to true if you wish to append the exported license to the existing mylicense.rclicense file. The default value is false. For example: Realitycapture.exe –exportLicense "c:\licenses\mylicense.rclicense" |
Project and Images
These commands let you control the current project, the application itself and add images.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
|
headless |
Hides user interface. When using command line to operate RealityCapture its user interface always shows up. This mode offers a possibility to hide the interface. Icon in the Windows taskbar’s system tray will show up instead. | ||
|
newScene |
Create a new empty scene. | ||
| load | MyProject.rcproj |
recoverAutosave|deleteAutosave |
Load an existing project from the MyProject.rcproj file. Use optional parameters to define the action if there is an autosaved file present for this project. Using recoverAutosave will open the autosaved project, while deleteAutosave will delete the autosaved project and load the original one. |
| save | MyProject.rcproj | Save the current project to its original location or save as MyProject.rcproj. | |
| add | imageName | Add an image or image list. | |
| addFolder | folderName | Add all images in the specified folder. In order to include also subdirectories, use command set with a key appIncSubdirs as follows: -set "appIncSubdirs=true". | |
| importVideo | videoFileName extractedVideoFramesLocation jumpsLength |
Import frames extracted from a video (videoFileName including the path). The frames are extracted into a folder (extractedVideoFramesLocation) using an interval between frames defined by the jumpsLength (in seconds). | |
|
importLeicaBlk3D |
fileName |
Import image sequence with .cmi extension (fileName including path) captured by Leica BLK3D. |
|
| importLaserScan | laserscanName | params.xml | Add a laser scan or a laser-scan list using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Laser Scan Import dialog. |
| importLaserScanFolder | folderName | params.xml | Add all laser scans in the specified folder using settings from the params.xml file. You can export these settings from the application in the Laser Scan Import dialog. |
| importHDRimages | fileName|folderName|imageList | params.xml |
Import HDR image (imageName), list of images (imageList) or all images from a folder (folderName) using the current settings or the settings from params.xml. You can export these settings from the application in the 16-bit/HDR Images Import dialog. |
| importImageSelection | fileName | Select some scene images and/or laser scans listed in a file (filename including the path). | |
|
selectImage |
imagePath|regexp |
Select a specified image (imagePath) or images defined by regular expression (regexp). |
|
|
selectAllImages |
Select all images in the project. |
||
|
deselectAllImages |
Deselect all images in the project. |
||
|
invertImageSelection |
Invert the current image selection. |
||
| importCache | folderName | Import resource cache data from a specified folder. | |
| clearCache | Clear the application cache. You must save the project before clearing the application cache. | ||
| execRCCMD | Commands.rccmd | Execute commands listed in the .rccmd file. You can find the instructions on how to write the file in the section Commands Outside Command Prompt in the application Help. | |
| quit | Quit the application. |
Commands for Selected Images
The following ones enable you to set some preferences for further processing of images.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
| setFeatureSource | 0|1|2 | Define a feature source mode for the selected images: 0 – Merge using overlaps, 1 – Use component features, 2 – Use all image features. |
|
| enableAlignment | true|false | Enable/disable selected images in the registration process. | |
| enableMeshing | true|false | Enable/disable selected images in the model computation/meshing. | |
| enableTexturingAndColoring | true|false | Enable/disable selected images during the coloring and texture calculation. | |
| setWeightInTexturing | <0,1> | Set weight for selected images during the coloring and texture calculation. | |
| enableColorNormalizationReference | true|false | Set selected images as color reference in the color normalization process. Colors for these images will not be changed. | |
| enableColorNormalization | true|false | Enable or disable selected images in the color normalization process. | |
| setDownscaleForDepthMaps | integer | Set a downscale factor for depth-map computation for the selected images. | |
| enableInComponent | true|false | Enable selected images in meshing and continue. Applicable only for the registered images. | |
| lockPoseForContinue | true|false | Set relative camera pose unchanged for the selected images during the next registration. Applicable only for the registered images. | |
| setPriorCalibrationGroup | number | Set a prior calibration group for the selected images: -1 - do not group, another number - group into the same calibration group. |
|
| setPriorLensGroup | number | Set a prior lens group for the selected images. Using -1 means do not group, any other number means to group the selected images into the same distortion group. |
Delegate commands
You can use these commands to delegate actions to a certain RealityCapture instance. You can find out more about delegation of commands in the application Help under Delegation of Commands.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
| setInstanceName | instanceName | Assign a name to a RealityCapture instance. Find more information on how to use this command in the section Delegation of Commands in the application Help. | |
| delegateTo | instanceName|* | Delegate a command or a sequence of commands to a specific instance of RealityCapture (instanceName) or to the first available instance (using the * symbol as a parameter). | |
| waitCompleted | instanceName|* | Pause execution of other commands until the current process is finished in a specified instance of RealityCapture (instanceName) or in the first available instance (using the * as a parameter). | |
| getStatus | instanceName|* | Return the progress status of a running process in a specified instance of RealityCapture (instanceName) or in the first available instance (using the * symbol as a parameter). | |
| pauseInstance | instanceName|* | Pause a currently running process in a specified instance of RealityCapture (instanceName) or in the first available instance (using the * symbol as a parameter). | |
| unpauseInstance | instanceName|* | Unpause a currently paused process in a specified instance of RealityCapture (instanceName) or in the first available instance (using the * symbol as a parameter). | |
| abortInstance | instanceName|* | Abort a currently running process in a specified instance of RealityCapture (instanceName) or in the first available instance (using the * symbol as a parameter). | |
|
queryScenePrice |
queryScenePrice|* |
inputsRemaining |
Check the amount of credits needed (and price in USD) for your inputs to be licensed in a specified instance of RealityCapture (instanceName) or in the first available instance (using the * symbol as a parameter). You can choose which information you want to see by using certain optional parameters. |
Alignment Commands
The following commands can be used to calculate camera poses and calibration, and to handle components and control points.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
| align | Align images using the current settings. | ||
| draft | Align images in the draft mode using the current settings. | ||
| update | Update all components and models by a rigid transformation to fit the actual constraints and control points. | ||
| detectFeatures | Run feature detection according to the alignment settings. Detected features will be saved in the application cache. | ||
|
mergeComponents |
Merge already created components. When using this command, no new images are added to the existing components. |
||
| exportXMP | params.xml | Export camera metadata of components created in the last alignment in the XMP format using the current settings or the settings from params.xml file (optional parameter). You can export this file from the XMP metadata export dialog. The components must fulfil the condition defined by the command setMinComponentSize. NOTE: XMP files are stored in the same folder as the respective images. |
|
| exportXMPForSelectedComponent | Export camera metadata of a selected component in XMP format using the current settings. An example available in the paragraph 'Metadata (XMP) Export Settings' below. NOTE: XMP files are stored in the same folder as the respective images. |
||
| importComponent | component.rcalign | Import a component from the component.rcalign file. | |
| exportLatestComponent | folderName | Export components created in the last alignment as RealityCapture Alignment Components (.rcalign) into a specified folder. The components must fulfil the condition defined by the command setMinComponentSize. | |
| setMinComponentSize | size | Specify the minimal component size for export when using the exportLatestComponents and exportXMP commands. The default value is 5. | |
| exportSelectedComponent | folderName | Export a selected component into a folder (folderName including the path) as RealityCapture Alignment Component (.rcalign). | |
| exportRegistration | fileName | params.xml | Export registration to a specified file using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Export Registration dialog. |
| exportUndistortedImages | folderName | params.xml | Export undistorted images into a specified folder using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Export Registration dialog. |
| exportSparsePointCloud | fileName | params.xml | Export 3D tie points (a sparse point cloud) into a specified file (fileName including the path and format extension) using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application within the Export Point Cloud dialog. |
| selectComponent | componentName | Select a component with the specified name (componentName) for further processing. | |
| selectMaximalComponent | Select the largest component for further processing. | ||
| selectComponentWithLeastReprojectionError | Select the component with the smallest reprojection error, based on the calculated Mean error [pixels], for further processing. | ||
| renameSelectedComponent | newComponentName | Rename the currently selected component. | |
| deleteSelectedComponent | Delete the currently selected component. | ||
| importFlightLog | flFileName | params.xml | Import a flight log using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Import Flight Log dialog. |
| importGroundControlPoints | gcpFileName | params.xml | Import ground control points using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Export Ground Control Points dialog. |
| importControlPointsMeasurements | cpmFileName | params.xml | Import measurements of control points (CPs) using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Export Control Points Measurements dialog. |
| exportGroundControlPoints | gcpFileName | params.xml | Export ground control points using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Export Ground Control dialog. |
| exportControlPointsMeasurements | cpmFileName | params.xml | Export measurements of control points using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Export Control Points Measurements dialog when pressing the Shift key together with the button Control Points in the Export part of the Alignment tab. |
| defineDistance | PointNameA PointNameB distance | constraintName | Define a distance constraint between two control points. If constraintName is not defined, distance name is created automatically. Alternatively, you can load distance constraint from a file (see below). |
| defineDistance | fileName | params.xml | Import a distance constraint from a file (filename including path) using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the application in the Import Distance Definitions dialog. The list of supported formats distancedefinitions.xml can be found in the installation folder. |
| detectMarkers | params.xml | Detect markers in images using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the Detect Markers tool in the application. |
Reconstruction Commands
These commands can be used to calculate models, perform coloring and texturing.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
| resetGround | Set the ground plane back to its original orientation and position. | ||
| setGroundPlaneFromReconstructionRegion | Automatically center a model using a reconstruction region into the middle of the grid, adjusting both rotation and transformation. | ||
| setReconstructionRegionAuto | Set a reconstruction region automatically. | ||
| setReconstructionRegion | box.rcbox | Import a reconstruction region from the box.rcbox file. | |
|
setReconstructionRegionOnCPs |
controlPoint |
Set a reconstruction region on existing control points. Three control points define the base of the region and the height of the region is defined by the fourth control point or by entering the height value. |
|
|
scaleReconstructionRegion |
scaleX |
origin|center absolute|factor |
Scale the reconstruction region in each axis (scaleX, scaleY, and scaleZ). Scale parameters can be treated either as absolute values (absolute) or scale factors (factor) from the center of the region (center) or its origin (origin) defined by the first control point when using setReconstructionRegionOnCPs command. Default values are "absolute" and "center". |
|
moveReconstructionRegion |
moveX |
Move the reconstruction region along the region's axes. The values are in the coordinate system’s units. |
|
|
rotateReconstructionRegion |
rotateX |
Rotate reconstruction region around its axes. All values are in degrees. |
|
| exportReconstructionRegion | box.rcbox | Export a reconstruction region to the box.rcbox file. | |
| calculatePreviewModel | Calculate 3D mesh in the preview quality. | ||
| calculateNormalModel | Calculate 3D mesh in the normal quality. | ||
| calculateHighModel | Calculate 3D mesh in the highest quality. | ||
|
continueModelCalculation |
If model calculation was paused, or if there was a crash, it is possible to continue calculation using this command. |
Model Tools
When you have successfully created a model, you can use these tools to process it further by means of the command line.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
| selectModel | modelName | Select a model with the specified name (modelName). | |
| deleteSelectedModel | Delete the currently selected model. | ||
| duplicateSelectedModel | Duplicate the selected model (including textures). | ||
| renameSelectedModel | newModelName | Rename the currently selected model. | |
| correctColors | layerName | Run color correction for all layers or a specified layer (layerName) in the selected component. | |
| unwrap | params.xml | Calculate unwrap of a model using the current settings or the settings from the params.xml (optional parameter). You can export these settings from the Unwrap tool in the application. | |
| calculateTexture | Calculate texture using the current settings. | ||
| reprojectTexture | sourceModel resultModel | params.xml | Reproject texture from a textured model (sourceModel) to an unwrapped model (resultModel) using the current settings or the settings from the params.xml file (optional parameter). sourceModel and resultModel are model names from the application. You can export these settings from the Texture Reprojection tool in the application. |
| calculateVertexColors | Calculate coloring using the current settings. | ||
| calculatePreviewVertexColors | Calculate draft coloring using the current settings. | ||
| simplify | targetTriangleCount or params.xml | Simplify a selected model using the current settings (use it without any parameters) to the selected triangle count (targetTriangleCount) or using the settings from the params.xml file. You can export these settings using the Simplify Tool in the application. | |
| smooth | params.xml | Smooth a selected model using the current settings or the settings from the params.xml file. You can export these settings from the Smoothing tool in the application. | |
| closeHoles | maxEdgesCount | Close model holes using the current settings or a specified maximal number of edges (maxEdgesCount). | |
| cleanModel | Clean the selected model: remove non-manifold edges and vertices, close small holes, etc. | ||
| selectTrianglesInsideReconReg | Select triangles inside the reconstruction region. | ||
| selectTrianglesOutsideReconReg | Select triangles outside the reconstruction region. | ||
| selectMarginalTriangles | Select triangles that are enclosing the volume but are not part of the current reconstruction. | ||
| selectLargeTrianglesAbs | edgeSizeThreshold | Select triangles with edge length larger than the threshold (edgeSizeThreshold). | |
| selectLargeTrianglesRel | edgeSizeThreshold | Select triangles with an edge length larger than the threshold (edgeSizeThreshold) multiplied by average edge length. | |
| selectLargestModelComponent | Select triangles that belong to the largest connected component of the model. | ||
| invertTrianglesSelection | Invert a selection of triangles. | ||
| deselectModelTriangles | Deselect all model triangles. | ||
| removeSelectedTriangles | Create a new model with selected triangles left out (the same behavior as achieved with the Filter Selection tool). | ||
|
dtmClassify |
params.xml |
Classify vertices of the selected model into pre-defined classes using the current settings or the settings from the params.xml file (optional parameter). You can export these settings from the AI Classify tool in the application. |
|
| exportModel | modelName fileName params.xml | Export a model (modelName from the project) as a file (fileName including path and file extension) using the settings from the params.xml file. You can export this file from the Export model dialog. | |
| exportSelectedModel | fileName params.xml | Export a selected model as a file (fileName including the path and file extension) using the settings from the params.xml file. You can export this file from the Export model dialog. | |
| importModel | fileName | Import a model from a file (fileName including path). | |
| calculateOrthoProjection | params.rcortho | Calculate an orthographic projection using settings from the params.rcortho file. Instructions on how to obtain the file can be found in the section CLI Parametric files of Ortho Projections in the application Help. | |
| selectOrthoProjection | orthoName | Select an orthographic projection with the specified name (orthoName). | |
| exportOrthoProjection | fileName params.xml | Export selected orthographic projection (image, DSM or DTM) into a file (fileName including the path and the file extension) using settings from the params.xml file. You can export the parameters file from the Export Ortho Photo, Export Digital Surface Model and Export Digital Terrain Model dialog. | |
| calculateCrossSections | step axis | Calculate Cross Sections either using current settings, or by setting the axis (local axis of reconstruction region) and the step between each cross section. | |
| exportCrossSections | fileName | params.xml | Export selected cross sections as a file (fileName including path and file extension) using the current settings or the settings from the params.xml (optional parameter).You can export the file from the Export Cross Sections dialog. |
| renameCrossSections | crossSectionsName | Rename selected cross sections. | |
| selectCrossSections | crossSectionsName | Select cross sections by name. | |
| computeContours | params.xml | Compute contours for the selected Ortho using the current settings or the settings from the params.xml file (optional parameter).You can export these settings from the Contours Tool in the application. | |
| exportContours | fileName | params.xml | Export selected contours as a file (fileName including path and file extension) using the current settings or the settings from the params.xml (optional parameter).You can export the file from the Export Contours dialog. |
| renameContours | contoursName | Rename selected contours. | |
| selectContours | contoursName | Select contours by name. | |
| exportShapes | fileName | params.xml | Export selected shapes as a file (fileName including path and file extension .json) using the current settings or the settings from the params.xml (optional parameter).You can export the file from the Export Shapes dialog. |
| importShapesToSelectedOrtho | fileName mosaicing|measurements | Import shapes from a file (fileName including path and file extension) to the selected ortho. Choose a type of either mosaicing or measurements. | |
| importShapesToOrtho | fileName orthoProjectionName mosaicing|measurements | Import shapes from a file (fileName including path and file extension) to ortho (orthoProjectionName). Choose a type of either mosaicing or measurements. | |
| selectShape | shapeName | Select shape by name. | |
| addShapeToSelection | shapeName | Add a shape to the current selection by name. | |
| exportReport | outputFileName templateFileName | Export a report into a file (outputFileName including the path and the .html extension) using a template (templateFileName including the path). The default templates are stored in the installation folder\Reports. | |
| shareReport | projectName templateFileName | Upload a report to cloud using Overview or Map Report template (templateFileName including the path). Report will be uploaded with projectName and you can find it here. The default templates are stored in the installation folder\Reports. | |
| exportDepthAndMask | folderName params.xml | Export depth maps and/or masks for the selected images. If folderName and params.xml are not specified, results are stored along with the original images using the current settings. You can export the settings file from the application in the Export Depth Maps and Masks dialog. | |
|
exportLod |
fileName |
params.xml |
Export the selected model as a linear Level-of-Detail model into a file (fileName including path and file extension) using the current settings or the settings from the params.xml (optional parameter). You can export the file from the Export LoD dialog. |
|
export3dTiles |
fileName |
params.xml |
Export the selected model as a hierarchical Level-of-Detail model into a .json file (fileName including path and file extension) using the current settings or the settings from the params.xml (optional parameter). You can export the file from the Export LoD dialog after selecting Cesium 3D Tiles (.json) file format. |
| exportSTMap | folderName params.xml | Export ST maps for the selected images. If folderName and params.xml are not specified, results are stored along with the original images using the current settings. You can export the settings file from the application in the Export Registration dialog. |
Settings' and Error-handling Commands
You can use these commands to alter settings and behavior of the application.
| Command Name | Required Parameter | Optional Parameter | Description |
|---|---|---|---|
| set | "key=value" | Set an application state variable. | |
| silent | crashReportPath | Set a location for storing crash reports. The application will store reports here instead of showing the upload wizard. | |
| writeProgress | fileName timeout | Write a progress change into a specified file (fileName including the path) during a defined period of time (timeout in seconds). More about the file structure can be found in the section Error-handling Commands in the application Help. | |
| stdConsole | Enable console redirection to the application standard output. When used, you will see the application console content mirrored also in the standard Windows console. This also enables further redirections for CLI purposes. | ||
| disableOnlineCommunication | Disable any online communication (updates, license renewal, etc.). | ||
| importGlobalSettings | settings.rcconfig | Import application global settings from the settings.rcconfig file. | |
| exportGlobalSettings | settings.rcconfig | Export application global settings to the settings.rcconfig file. | |
| setProjectCoordinateSystem | authority:id | Set a project coordinate system defined by an authority, and its ID (can be found in a specific database, e.g. epsg.xml and local.xml). | |
| setOutputCoordinateSystem | authority:id | Set an output coordinate system defined by an authority, and its ID (can be found in a specific database, e.g. epsg.xml and local.xml). |
Comments
0 comments