Main Parameters

There are certain parameters that can be set to configure the execution of the VisualHull program. To run the program, you can enter following line into your shell/cmd:

./src/main.py <json parameter file>

or if that does not work, try:

python3 ./src/main.py <json parameter file>

Make sure your current working directory is that of the git-project folder.

The argument <json parameter file> has to be given for every run or else the program cannot execute.

In this file you can set your parameters just as you want.

If you have no clue how to create such a file, you can see the examples as reference or even use the template examples/parameters.json file and start from there.

Here is a list of the main parameters implemented:

• verbose
• multithreading
• output_filename
• fill
• visualize
• silhouettes
  • Silhouette Parameter: filename
  • Silhouette Parameter: pixel_size
  • Silhouette Parameter: position
  • Silhouette Parameter: rotation
  • Silhouette Parameter: dark_spot
  • Silhouette Parameter: light_spot
  • Silhouette Parameter: perspective
  • Silhouette Parameter: fov
  • Silhouette Parameter: sensor_size
  • Silhouette Parameter: focal_length
  • Silhouette Parameter: near
  • Silhouette Parameter: far
• voxel_grid
  • VoxelGrid Parameter: by_size
  • VoxelGrid Parameter: voxels_x, voxels_y, and voxels_z
  • VoxelGrid Parameter: width, height, and depth
  • VoxelGrid Parameter: voxel_size
  • VoxelGrid Parameter: centered
  • VoxelGrid Parameter: position
  • VoxelGrid Parameter: rotation

verbose

• Type: Boolean (true or false)
• Default value: false

If this parameter is set to true, the execution of the VisualHull program will print out progress steps that are finished to stdout.

multithreading

• Type: Boolean (true or false)
• Default value: true

This parameter will determine whether to run parallelizable steps of the program in separate threads. If you have multiple cpu cores, this might save you some execution time.

output_filename

• Type: String or null
• Default value: null

If this parameter is kept empty or set to null, the program won’t save the resulting 3D model after execution.

Else it will save the result in the given file in the Wavefront .obj format.

fill

• Type: Boolean (true or false)
• Default value: false

This parameter decides whether to fill in voxels that will not be visible, because they are blocked by neighboring voxels, into the output file.

Generally speaking, if fill is set to true, the output file will be bigger (if there are enclosed voxels) even though these voxels are not relevant from the outside of the model.

visualize

• Type: Boolean (true or false)
• Default value: true

This parameter decides, whether to show a window that shows and rotates the resulting visual hull after creation.

silhouettes

• Type: Array of Silhouettes
• Default value: []

This array collects all silhouettes, each with their own parameters.

The parameters for each silhouette are described on the next page: Silhouette Parameters

voxel_grid

• Type: VoxelGrid (dict/map in JSON)
• Default value: {}

This map/object contains parameters that describe the VoxelGrid which will be the canvas for the resulting 3D model.

The parameters for the VoxelGrid are described here: VoxelGrid Parameters

Improve this page