CLI Parameter List

Umbra optimization can be configured using various parameters. Parameters generally affect output quality and size, as well as optimization speed. Setting the parameters is discussed in API documentation

All parameters specifying sizes or distances are in meters. The units-to-meters parameter should be specified if the input scene is not using meters.

A parameter may be specified multiple times, with the last time overriding any previous ones.

Some parameters act as shorthand notations for a more complex set of parameters (content-profile in particular). Specifying any of the settings modified by such parameter set individually will override the one specified by the parameter set, regardless of order in which they were specified.

We recommend first-time users to start by specifying content-profile, units-to-meters and feature-size. The parameters are listed roughly in order of importance.

Scene input parameters

Use one to define the location of your scene repository for umbrafication

Parameter	Type	Description
--input-sha1	String	SHA1-identifier of a scene. Use as the input if you have already uploaded your original content to Umbra Cloud.
--input-obj	String	Path to a single OBJ file or a folder containing multiple OBJ files (including subfolders).
--input-xyz	String	Path to a single XYZ file or a folder containing multiple XYZ files (including subfolders).
--input-las	String	Path to a single LAS file or a folder containing multiple LAS files (including subfolders).
--input-geojson	String	Path to a GeoJSON annotation file.
--input-empty	String	Empty scene.

Scene import parameters

Parameter	Type	Default	Description
--obj-split-width	Float	none	Split .obj on import
--xyz-field-string	String	"x y z intensity red green blue"	Tells importer how to interpret values in xyz files.
--las-utm-zone	String		Specify that LAS is georeferenced in some UTM zone
--import-zIsUp	Bool	false	Enable if your content has Z as the up-axis.
--import-right-handed	Bool	false	Enable if your content is defined in right-handed coordinates
--import-origin	Vec3f	none	Defines custom origin for the imported data. Format is expected to be 3 values, ie. "0 0 0".
--import-rgb-range	Float	1	The highest value RGB color channels can take.

Cloud computation parameters

Parameter	Type	Description
--api-key	String	Your Umbra API key. Find it from https://umbra.io.
--scene-name	String	Name for the imported scene. Enclose in "".
--append	Bool	Append

Generic parameters

Parameter	Type	Default	Description
--wait-completion	Bool	false	Have the command line tool report the umbrafication progress. Otherwise, follow the progress at https://umbra.io.

Scene properties

Parameter	Type	Default	Description
--content-profile	String	"unknown"	Sets reasonable default parameters for a specific type of content. Must be one of "dcc" "scanned" or "unknown".
--units-to-meters	Float	1.0	Ratio for converting input scene units to meters. For example, if your scene is in feet, a value of 0.3048 will work as intended.

Computation properties

Computation controls

Parameter	Type	Default	Description
--feature-size	float	none	The smallest feature in metric units that should be distinguishable in the umbrafied content.
--geo-transform-helmert	double[7]	none	Add georeferencing using cx,cx,cy,s,rx,ry,rz Helmert transform, scale is 1 + s / 1000000, rotation is in radians.
--geo-transform-matrix	double[16]	none	Add georeferencing using 4x4 matrix.
--backface-removal	bool	false	Attempt to remove backfacing triangles.
--hdr-output	bool	false	Forces 32-bit floating point rgba diffuse texture, overriding any other settings for diffuse format.
--texel-ratio	float	1.0	Ratio of texture feature size to geometry feature size.
--vertex-normals	bool	true	Toggles output of vertex normals and tangents.

Precomputed ambient occlusion

Parameter	Type	Default	Description
--ao	bool	false	Toggles ambient occlusion baking.
--ao-distance	float	0.5	Set maximum distance at which ambient occlusion tries to find occluders. Should be small in relation to input scene size.
--ao-intensity	float	1.0	Intensity multiplier for ambient occlusion effect. 0 is equivalent to disabling ambient occlusion, while 1.0 is the recommended maximum.

Toggles for texture generation

Parameter	Type	Default	Description
--texture-diffuse	bool	true	Toggles diffuse texture generation.
--texture-metaindex	bool	true	Toggles metadata texture generation. Does nothing when no metadata is provided with input.
--texture-metalgloss	bool	true	Toggles metalgloss texture generation.
--texture-normal	bool	true	Toggles normal texture generation.

Point cloud controls

Parameter	Type	Default	Description
--point-cloud-compute-features	bool	false	Computes geometric point features in addition to normals. Used for debug XYZ export.
--point-cloud-connect-radius	float	0.25	Largest distance over which holes in point clouds can be patched. Large values may result in artifacts and are slower to optimize.
--point-cloud-filter-radius	float	-1.0	Normal estimation radius. Point cloud is quantized to 1/16 of this distance. Default: 4 * point-cloud-connect-radius.
--point-cloud-outlier-removal-strength	float	0.01	Aggressiveness of sparse outlier removal. Ranges from 0 to 1, where 0 turns it off. This is dependent on connect radius.
--point-cloud-vertex-normal-radius	float	-1.0	Search distance for vertex normal estimation for point clouds. Default: 4 * point-cloud-connect-radius.