Reconstruction Commands

Reconstruction Commands

These commands can be used to calculate models and perform coloring and texturing.

Examples

The following examples demonstrate how to perform model calculations from the command line.

We’ll start with a simple script that illustrates the use of the first two reconstruction region commands.

RealityScan.exe -addFolder %MyPath%\Images\ -align -setReconstructionRegionAuto -exportReconstructionRegion %MyPath%\myBox.rsbox -quit

After the basic alignment, the reconstruction region will be set automatically and exported to a file.

If you want to use a custom reconstruction region, you can first export it from the application by selecting MESH & COLOR → Export → Reconstruction Region, then modify the values and parameters inside the resulting .rsbox file.

The following script opens an aligned project, selects the largest component, imports a reconstruction region, and calculates models in preview, normal, and high detail.

RealityScan.exe -load %MyPath%\AlignedProject.rsproj -selectMaximalComponent -setReconstructionRegion %MyPath%\myBox.rsbox -calculatePreviewModel -calculateNormalModel -calculateHighModel -save %MyPath%\NewProject.rsproj -quit

In batch scripting, you can use the caret (^) to break a line and continue the command sequence on the next line, allowing the CLI to process it as a single command. The multiline script performs the same actions as the one-line version, but it’s easier to read and organized into logical parts.

RealityScan.exe -load %MyPath%\AlignedProject.rsproj ^
-selectMaximalComponent -setReconstructionRegion %MyPath%\myBox.rsbox ^
-calculatePreviewModel ^
-calculateNormalModel ^
-calculateHighModel ^
-save %MyPath%\NewProject.rsproj -quit

Set Reconstruction Region on Control Points

You can use the -setReconstructionRegionOnCPs command to define a reconstruction region based on control points.

At least three control points are required to use this command. The first two control points define the region’s width, while the third defines its length, forming the base plane of the reconstruction region.

The region’s height can be specified either by adding a fourth control point or by entering a height value (in the coordinate system’s units). This value may also be negative.

RealityScan.exe -delegateTo * -setReconRegionOnCPs CP1 CP2 CP3 50

This example creates a reconstruction region using control points CP1, CP2, and CP3, with a height of 50 in the coordinate system’s units.

The order of the control points in the command determines the axes of the reconstruction region. The region always follows a right-handed coordinate system, where the origin is placed at the first control point, and the X-axis starts at the origin and passes through the second control point.

Scale Reconstruction Region

The reconstruction region can be scaled along its axes using the -scaleReconstructionRegion command, either by specifying absolute values or by applying multiplication factors. You can also define the scaling reference point, either the origin or the center.

By default, the command scales the reconstruction region from its center and based on absolute values.

RealityScan.exe -delegateTo * -scaleReconstructionRegion 1.1 1.1 1.2 center factor

This example scales the reconstruction region from its center using the specified factors. The X and Y axes are multiplied by 1.1, and the Z axis is multiplied by 1.2.  

Move Reconstruction Region

To move the reconstruction region, use the -moveReconstructionRegion command.

RealityScan.exe -delegateTo * -moveReconstructionRegion 10 10 10

This will move the reconstruction region by 10 units (defined by the coordinate system) along all axes.

Rotate Reconstruction Region

The reconstruction region can be rotated using the -rotateReconstructionRegion command. All defined parameters for this command are specified in degrees.  

RealityScan.exe -delegateTo * -rotateReconstructionRegion 45 45 45

This example rotates the reconstruction region by 45 degrees around all axes, causing the axes themselves to rotate as well.  

Offset Reconstruction Region

Offset the reconstruction region using the -offsetReconstructionRegion command by specifying relative values that act as multipliers of the region’s side lengths.  

RealityScan.exe -delegateTo * -offsetReconstructionRegion 1 2 0.5

This example offsets the reconstruction region along its axes as follows:

• X axis: by one length of its depth

• Y axis: by two lengths of its width

• Z axis: by half of its height

These values are applied relative to the reconstruction region’s own XYZ axes.

Precomputation of Depth Maps

To accelerate model computation across multiple computers, you can precompute depth maps using the PrecomputeDepthmaps setting:  

RealityScan.exe -set "PrecomputeDepthmaps=true"

When set to true, the preview, normal, or high command will precompute only the depth maps, which are stored in the application cache, and no model will be created.

When set to the default value false, the preview, normal, or high command performs as usual: depth maps are computed a,nd a model is generated. However, if the depth maps have already been precomputed and stored in the cache, the computation step is skipped and only the model creation process is executed.  

This approach is particularly useful for maximizing GPU/CPU utilization when processing multiple assets of similar size, such as a batch of full-body scans.  

For optimal performance, you can set up two machines:

• One with multiple powerful GPUs but a standard CPU

• One with a powerful CPU but a standard GPU

Install RealityScan on both machines, and run these two pipelines in parallel for efficient processing.

• GPU-PC, Dataset (i+1): Align → Enable Precompute Depth Maps → Compute Model → Save → Move the project and cache to CPU-PC:

  Command Line

  RealityScan.exe -addFolder "C:\MyFolder_on_GPU-PC\Images\"^
  -align^
  -set "PrecomputeDepthmaps=true"^
  -calculateNormalModel^
  -save "C:\MyFolder_on_GPU-PC\Project.rsproj" -quit

  Copy full snippet(5 lines long)

  • Move Project.rsproj from C:\MyFolder_on_GPU-PC to C:\MyFolder_on_CPU-PC, and move the cache to C:\MyFolder_on_CPU-PC\Cache.  

• CPU-PC, Dataset (i): Load → Import Cache → Disable Precompute Depth Maps → Compute Model → Export:  

  Command Line

  RealityScan.exe -load "C:\MyFolder_on_CPU-PC\Project.rsproj"^
  -importCache "C:\MyFolder_on_CPU-PC\Cache\"^
  -set "PrecomputeDepthmaps=false"^
  -calculateNormalModel^
  -exportModel "Model 1" "C:\MyFolder_on_CPU-PC\Model.obj" "C:\MyFolder_on_CPU-PC\params.xml"^
  -save "C:\MyFolder_on_CPU-PC\Project_Model.rsproj" -quit

  Copy full snippet(6 lines long)

Continue Model Calculation

If a model computation is interrupted (for example, due to a crash or a manual pause), you can resume it using the -continueModelCalculation command. To use this command after a crash, auto-save mode must be enabled beforehand.

The command scans your project for unfinished models and resumes the first one it finds. Models are searched from the last component to the first, and within each component from the last model to the first.

Example (when paused):

RealityScan.exe -load project.rsproj -continueModelCalculation

When pausing a calculation, you can choose not to pause it temporarily, leaving the model in a partially computed state. The following example continues the calculation of that model, provided the loaded project was saved before closing.  

Example (after a crash):

RealityScan.exe -load project.rsproj recoverAutosave -continueModelCalculation

As mentioned above, auto save mode must be enabled to use this command. When enabled, you can include the optional recoverAutosave parameter with the -load command. This allows RealityScan to scan for and resume any unfinished model