== Menu ==

This tool is accessible via the 'Edit > Sensors > TLS/GBL > Create' menu.

== Description ==

Creates a Terrestrial Laser Scanner (TLS - also called a Ground Based Lidar = GBL) sensor entity attached to the selected cloud.

[[Image:Cc_create_gbl_sensor_dialog.jpg|frame|center|Edit > Sensor > Create > TLS sensor dialog (version 2.14)]]

The user must specify the main intrinsic and extrinsic parameters of the sensor (absolute position and orientation, angular steps, etc.).

''Notes:
- since version 2.5.6, angles are now expressed in degrees and [http://en.wikipedia.org/wiki/Aircraft_principal_axes aircraft] denominations (yaw/pitch) are used so as to make things clearer.
- since version 2.14, it is possible to manually set the scanner angular ranges
''

Clicking on the 'OK' button will create a new sensor object. A depth buffer is automatically generated and displayed by CloudCompare so as to let the user visually check the parameters. Note that the parent cloud of the sensor is used to create this depth buffer, considering the '''farthest point''' 'seen' by the scanner in any direction.

[[Image:Cc_gbl_sensor_depth_map.jpg|frame|center|GBL sensor depth map]]

By default the sensor object is added as a child of the selected cloud in the DB tree. It is also visible in the 3D view (warning: you may have to change its 'drawing scale' - see the sensor object properties - to view it correctly).

[[Image:Cc_gbl_sensor_in_3d_view.jpg|frame|center|GBL sensor object (as visible in the DB tree and in a 3D view]]

File:Cc create gbl sensor dialog.jpg

2025-12-13T08:40:12Z

Daniel: Daniel uploaded a new version of File:Cc create gbl sensor dialog.jpg

Sensors\Ground Based Lidar\Create

2025-12-13T08:27:20Z

Daniel: /* Description */

== Menu ==

This tool is accessible via the 'Edit > Sensors > TLS/GBL > Create' menu.

== Description ==

Creates a Terrestrial Laser Scanner (TLS - also called a Ground Based Lidar = GBL) sensor entity attached to the selected cloud.

[[Image:Cc_create_gbl_sensor_dialog.jpg|frame|center|Edit > Sensor > Create > GBL sensor dialog]]

The user must specify the main intrinsic and extrinsic parameters of the sensor (absolute position and orientation, angular steps, etc.).

''Notes:
- since version 2.5.6, angles are now expressed in degrees and [http://en.wikipedia.org/wiki/Aircraft_principal_axes aircraft] denominations (yaw/pitch) are used so as to make things clearer.
- since version 2.14, it is possible to manually set the scanner angular ranges
''

Clicking on the 'OK' button will create a new sensor object. A depth buffer is automatically generated and displayed by CloudCompare so as to let the user visually check the parameters. Note that the parent cloud of the sensor is used to create this depth buffer, considering the '''farthest point''' 'seen' by the scanner in any direction.

[[Image:Cc_gbl_sensor_depth_map.jpg|frame|center|GBL sensor depth map]]

By default the sensor object is added as a child of the selected cloud in the DB tree. It is also visible in the 3D view (warning: you may have to change its 'drawing scale' - see the sensor object properties - to view it correctly).

[[Image:Cc_gbl_sensor_in_3d_view.jpg|frame|center|GBL sensor object (as visible in the DB tree and in a 3D view]]

Sensors\Ground Based Lidar\Create

2025-12-13T08:25:37Z

Daniel: /* Description */

== Menu ==

This tool is accessible via the 'Edit > Sensors > TLS/GBL > Create' menu.

== Description ==

Creates a Terrestrial Laser Scanner (TLS - also called a Ground Based Lidar = GBL) sensor entity attached to the selected cloud.

[[Image:Cc_create_gbl_sensor_dialog.jpg|frame|center|Edit > Sensor > Create > GBL sensor dialog]]

The user must specify the main intrinsic and extrinsic parameters of the sensor (absolute position and orientation, angular steps, etc.).

''Note: since version 2.5.6, angles are now expressed in degrees and [http://en.wikipedia.org/wiki/Aircraft_principal_axes aircraft] denominations (yaw/pitch) are used so as to make things clearer.''

Clicking on the 'OK' button will create a new sensor object. A depth buffer is automatically generated and displayed by CloudCompare so as to let the user visually check the parameters. Note that the parent cloud of the sensor is used to create this depth buffer, considering the '''farthest point''' 'seen' by the scanner in any direction.

[[Image:Cc_gbl_sensor_depth_map.jpg|frame|center|GBL sensor depth map]]

By default the sensor object is added as a child of the selected cloud in the DB tree. It is also visible in the 3D view (warning: you may have to change its 'drawing scale' - see the sensor object properties - to view it correctly).

[[Image:Cc_gbl_sensor_in_3d_view.jpg|frame|center|GBL sensor object (as visible in the DB tree and in a 3D view]]

QCloudLayers (plugin)

2025-09-07T14:37:48Z

Daniel: /* Developer */

Cloud Layers is a plugin for CloudCompare to perform manual classification.

[[Image:QCloudLayers.jpg|center]]

= Basic workflow =

= Copyright =
WigginsTech [https://www.wigginstech.com/ https://www.wigginstech.com/]

= Initial developer =
Neurodat [https://neurodat.com/contact-us/ https://neurodat.com]

QCloudLayers (plugin)

2025-09-07T14:37:32Z

Daniel: /* Copyright */

Cloud Layers is a plugin for CloudCompare to perform manual classification.

[[Image:QCloudLayers.jpg|center]]

= Basic workflow =

= Copyright =
WigginsTech [https://www.wigginstech.com/ https://www.wigginstech.com/]

= Developer =
Neurodat [https://neurodat.com/contact-us/ https://neurodat.com]

QCloudLayers (plugin)

2025-09-07T14:37:08Z

Daniel: /* Copyright */

Cloud Layers is a plugin for CloudCompare to perform manual classification.

[[Image:QCloudLayers.jpg|center]]

= Basic workflow =

= Copyright =
WigginsTech [https://www.wigginstech.com/ https://www.wigginstech.com/]
Developer: [https://neurodat.com/contact-us/ Neurodat]

Command line mode

2025-09-04T20:13:55Z

Daniel: /* Available options (version 2.14.alpha) */

Since version 2.3, CloudCompare can be used in "command line" mode.

By default, this mode only opens a small console window, applies the requested actions, and eventually saves the result in a file in the same directory(ies) as the input file(s). Commands are applied in the order they are written (like a ''state machine'').

=Available options (version 2.14.alpha) =

{| cellpadding="10" style="text-align:left; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
!style="border-style: solid; border-width: 1px" ! scope="col" width="200" | Command
!style="border-style: solid; border-width: 1px"| Description
|-
|style="border-style: solid; border-width: 1px"| <code>-VERBOSITY [0-4]</code>
|style="border-style: solid; border-width: 1px"| ''sets the log verbosity level (0: verbose, 1: standard, 2: important, 3: warnings and errors only, 4: errors only)''
notes:
- to hide plugin loading logs, it should be set as first argument (even before -SILENT, in which case -SILENT can be the second argument)
- since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-SILENT</code>
|style="border-style: solid; border-width: 1px"| ''enables silent mode (no console will appear)''
Warning: must be first if required (or after -VERBOSITY).
|-
|style="border-style: solid; border-width: 1px"| <code>-O {filename}</code>
|style="border-style: solid; border-width: 1px"| ''opens a file''

If the file format is ASCII, optional settings are:
* <code>-SKIP {number of lines to skip}</code> If set, CC will automatically skip the specified number of lines
For all formats, optional settings are (version 2.5.6 and above):
* <code>-GLOBAL_SHIFT {AUTO} or {FIRST} or {x y z}</code>
** AUTO: CC will automatically determine the best Global Shift translation to preserve coordinates accuracy
** FIRST: CC will use the same parameters that were used for the first entity (i.e. the result of the first usage of the 'AUTO' option, or the first specified Global Shift vector (x,y,z)) - the FIRST option is available since v2.11

* Warnings:
** the GLOBAL_SHIFT option will be ignored for BIN files as they already contain their own GLOBAL_SHIFT values!
** the AUTO option won't reuse the global shift set for previous entities. Use the FIRST option instead.

Note: file type is automatically guessed from its extension.
|-
|style="border-style: solid; border-width: 1px"| <code>-COMMAND_FILE {base name}</code>
|style="border-style: solid; border-width: 1px"| '' loads commands from a file.''

Other commands after -COMMAND_FILE will run after all commands in the file have been processed.

See more information here: [https://github.com/CloudCompare/CloudCompare/pull/1909]

Notes:
* multiple lines allowed
* multiple arguments in each line allowed
* quoted arguments are handled
* whole (or half) line comments with '#' or '//' are supported.
* partial comments are supported: '/* my comment here */' (must be quoted with either single or double quote if it contains spaces)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SELECT_ENTITIES -{FIRST} {first count} -{LAST} {last count} {-ALL} {-NOT} {-REGEX} {regex pattern}</code>
|style="border-style: solid; border-width: 1px"| ''Selects some entities among all those loaded, before applying the subsequent commands.''

Sub-options are:
* -FIRST {count}: if set, first count of entities will be selected (optional). Example: xx.....
* -LAST {count}: if set, last count of entities will be selected (optional). Example: .....xx
* -ALL: if set, all entities will be selected (optional). It has higher priority than FIRST/LAST/REGEX. Example: xxxxxxx
* -REGEX {regex_pattern}: if set, all entities with matching names will be selected (optional). It has higher priority than FIRST/LAST. Example: x(merged)..x(merged)...
* -NOT: if set, all condition will be reversed (optional)
** -NOT -FIRST {count} -> all but first {count}. Example: ..xxxxx
** -NOT -LAST {count} -> all but last {count}. Example: xxxxx..
** -NOT -ALL -> none. Example: .......
** -NOT -REGEX matched -> regex not matched. Example: .(merged)xx.(merged)xxx
** special case: -NOT -FIRST c1 -LAST c2 -> all except first 'c1' AND last 'c2' entities. Example: ..xxx..
* -CLOUD: if set, only clouds will be selected (optional)
* -MESH: if set, only meshes will be selected (optional)

Notes:
* sub-options can be set in any order
* it is possible to use FIRST and LAST at the same time. Example: xx...xx
* if neither -CLOUD nor -MESH are set then both types of entities will be selected
* since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-MOMENT {radius}</code>
|style="border-style: solid; border-width: 1px"| ''Computes the 1st order moment for all loaded clouds with the specified radius.''

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-FEATURE {type} {radius}</code>
|style="border-style: solid; border-width: 1px"| ''Computes the geometric feature of type {type} for all loaded clouds with the specified radius:''

{type} can be one of the following:
* SUM_OF_EIGENVALUES
* OMNIVARIANCE
* EIGENTROPY
* ANISOTROPY
* PLANARITY
* LINEARITY
* PCA1
* PCA2
* SURFACE_VARIATION
* SPHERICITY
* VERTICALITY
* EIGENVALUE1
* EIGENVALUE2
* EIGENVALUE3

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-OCTREE_NORMALS {radius}</code>
|style="border-style: solid; border-width: 1px"| ''Computes the [[Normals%5CCompute | normals]] for all loaded clouds with the specified radius.''

Optional settings are:
* <code>-ORIENT {option}</code> to define an orientation hint
** PLUS_ZERO or PLUS_ORIGIN (v2.12+): normals will all point outwards the origin (0, 0, 0)
** MINUS_ZERO or MINUS_ORIGIN (v2.12+): normals will all point towards the origin (0, 0, 0)
** PLUS_BARYCENTER: normals will all point outwards the cloud barycenter
** MINUS_BARYCENTER: normals will all point towards the cloud barycenter
** PLUS_X: normals will all point towards +X (i.e. Nx >= 0)
** MINUS_X: normals will all point towards -X (i.e. Nx <= 0)
** PLUS_Y: normals will all point towards +Y (i.e. Ny >= 0)
** MINUS_Y: normals will all point towards -Y (i.e. Ny <= 0)
** PLUS_Z: normals will all point towards +Z (i.e. Nz >= 0)
** MINUS_Z: normals will all point towards -Z (i.e. Nz <= 0)
** PREVIOUS: normals will have the same orientation as the previous normals (if any)
** SENSOR_ORIGIN (v2.12+): use the associated sensor origin (if any)
* <code>-MODEL {local_model_type}</code> to specify a local model:
** {local_model_type} = LS / TRI / QUADRIC
* input ''radius'' can be replaced by 'auto' to let CC try to guess a possible value (since version 2.11)

Notes:
* default local model is 'QUADRIC'
* if you have files containing structured clouds (e.g. PTX, FARO, DP, etc.), it may be more efficient to use the 'COMPUTE_NORMALS' option (see below)
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-INVERT_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''Inverts the normals of the loaded entities (cloud or mesh, and per-vertex of per-triangle for meshes)''

Note: since version 2.12
|-
|style="border-style: solid; border-width: 1px"| <code>-COMPUTE_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''forces CC to compute normals at loading time (which is generally more robust) when importing files containing structured clouds (i.e. PTX, FARO and DP file for now). Normals are not computed by default.''

Note: must be placed before the '-O' option.
|-
|style="border-style: solid; border-width: 1px"| <code>-NORMALS_TO_SFS</code>
|style="border-style: solid; border-width: 1px"| ''Converts normal vectors to 3 scalar fields (Nx, Ny and Nz).''
Notes:
* since version 2.11 only
|-
|style="border-style: solid; border-width: 1px"| <code>-NORMALS_TO_DIP</code>
|style="border-style: solid; border-width: 1px"| ''Converts normal vectors to 2 'dip' and 'dip direction' scalar fields.''
Notes:
* since version 2.11 only
|-
|style="border-style: solid; border-width: 1px"| <code>-NORMALS_TO_HSV</code>
|style="border-style: solid; border-width: 1px"| ''Converts normal vectors to HSV colors.''
Notes:
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all normals from the loaded entities.''
|-
|style="border-style: solid; border-width: 1px"| <code>-ORIENT_NORMS_MST {number of neighbors}</code>
|style="border-style: solid; border-width: 1px"| ''[[Normals%5COrient_Normals_With_Minimum_Spanning_Tree | (Re)orient the normals]] of the loaded clouds with a Minimum Spanning Tree.''

Note: Clouds without normals are simply ignored.

|-
|style="border-style: solid; border-width: 1px"| <code>-MERGE_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''merges all loaded/generated clouds as one unique cloud.''

Notes:
- previous clouds are unloaded from memory.
- result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-MERGE_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''merges all loaded/generated meshes as one unique mesh.''

Notes:
- previous meshes are unloaded from memory.
- result is automatically saved by default (see the AUTO_SAVE command to change this). This option is available since version 2.9.
|-
|style="border-style: solid; border-width: 1px"| <code>-SS {algorithm} {parameter}</code>
|style="border-style: solid; border-width: 1px"| ''applies a [[Edit%5CSubsample | subsampling]] {algorithm} to the currently opened/generated cloud(s).''
{algorithm} can be RANDOM, SPATIAL or OCTREE.
Then, the expected {parameter} value depends on the chosen algorithm:
* RANDOM: number of randomly selected points
* SPATIAL: minimum distance between two points
* OCTREE: subdivision level (between 1 and 10 in the standard version)

Optional sub-options are (since version 2.13):
* -SS OCTREE NUMBER_OF_POINTS {number}: to subsample with the highest octree level for which the resulting point count won't exceed the given number of points
* -SS OCTREE NUMBER_OF_POINTS PERCENT {number}: to calculate NUMBER_OF_POINTS from PERCENT. PERCENT should be a decimal number between 0 and 100.
* -SS OCTREE CELL_SIZE {size}: to deduce the octree level from the given cell size.
* -SS RANDOM PERCENT {number}: to calculate the number of sampled points from PERCENT. PERCENT should be a decimal number between 0 and 100.
* -SS SPATIAL {fallback_step} USE_ACTIVE_SF {step_at_SF_min} {step_at_SF_max}: to use spatial step interpolation based on the active scalar field (the fallback step will be used if the active SF has only invalid values)

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* input clouds are now replaced by their subsampled version (since version 2.6.1)
|-
|style="border-style: solid; border-width: 1px"| <code>-EXTRACT_CC {octree level} {minimum number of points per component}</code>
|style="border-style: solid; border-width: 1px"| ''extracts the [[Label_Connected_Components | connected components]] from the currently opened/generated cloud(s).''
{octree level} should be between 1 and 21.

Notes:
* extracted components are automatically saved by default (see the AUTO_SAVE command to change this).
* input clouds are replaced by the extracted components
|-
|style="border-style: solid; border-width: 1px"| <code>-SAMPLE_MESH {method} {parameter}</code>
|style="border-style: solid; border-width: 1px"| ''[[Mesh%5CSample_points | samples points]] on the loaded mesh(es).''
For each mesh, a cloud will be generated (and will be added to the current loaded cloud set - i.e. further processing can be applied to this cloud).

{method} can be POINTS or DENSITY. Expected parameter is:
* POINTS: the corresponding number of points
* DENSITY: the corresponding surface density

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* this cloud can be used as input for cloud-to-cloud or cloud-to-mesh distances computation for instance.
|-
|style="border-style: solid; border-width: 1px"| <code>-EXTRACT_VERTICES</code>
|style="border-style: solid; border-width: 1px"| ''Extract the vertices of all loaded meshes as standalone point clouds. Note that this option is not yet activated! (sorry about that)''

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* the source mesh is discarded
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-C2C_DIST</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Cloud-to-Cloud_Distance | cloud-to-cloud distances]] on the two first loaded/generated clouds (1st = compared / 2nd = reference).''

Optional settings are:
* <code>-SPLIT_XYZ</code> If set, 3 additional scalar fields will be generated (displacement along the 3 dimensions)
* <code>-MAX_DIST {value}</code> to set a max distance above which CC won't have to search for a nearest neighbor (faster)
* <code>-OCTREE_LEVEL {value}</code> to manually set the octree subdivision level at which the computation will be performed
* <code>-MODEL {local_model_type} {neighborhood_type} {neighborhood_size}</code> to specify a local model:
** {local_model_type} = LS / TRI / HF
** {neighborhood_type} = KNN / SPHERE
** {neighborhood_size} = neighbor count (if KNN) or sphere radius (if SPHERE)
* <code>-MAX_TCOUNT {thread count}</code> to set the maximum number of threads to use
* <code>-SPLIT_XY_Z</code> to split the distance between the z component and the xy plane component (since version 2.13)

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* see below for more details
|-
|style="border-style: solid; border-width: 1px"| <code>-C2M_DIST</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Cloud-to-Mesh_Distance | Cloud-to-Mesh distances]] between the first loaded/generated cloud (compared) and the first loaded mesh (reference).''

Optional settings are:
* <code>-FLIP_NORMS</code> to consider that normal vectors point inside the matter and not outside
* <code>-MAX_DIST {value}</code> to set a max distance above which CC won't have to search for a nearest neighbor (faster)
* <code>-OCTREE_LEVEL {value}</code> to manually set the octree subdivision level at which the computation will be performed
* <code>-MAX_TCOUNT {thread count}</code> to set the maximum number of threads to use
* <code>-UNSIGNED</code> to compute unsigned distances (since version 2.13)
* <code>-SPLIT_XY_Z</code> to split the distance between the z component and the xy plane component (since version 2.13)

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* see below for more details
|-
|style="border-style: solid; border-width: 1px"| <code>-RASTERIZE -GRID_STEP {value}</code>
|style="border-style: solid; border-width: 1px"| ''[[Rasterize | Rasterizes]] the loaded clouds by projecting them inside a regular grid.''

Optional settings are:
* <code>-VERT_DIR {0/1/2}</code> to specify the projection dimension (0=X / 1=Y / 2=Z) - default is 2 (Z)
* <code>-PROJ {MIN/AVG/MAX}</code> to specify how the altitude of each cell is computed (minimum, average or maximum altitude of the projected points). Default is AVG (average)
* <code>-SF_PROJ {MIN/AVG/MAX}</code> to specify how the SF value(s) of each cell are computed (minimum, average or maximum of the projected points SF value(s)). Default is AVG (average)
* <code>-EMPTY_FILL {MIN_H/MAX_H/CUSTOM_H/INTERP/KRIGING}</code> to specify how empty cells should be filled:
** MIN_H = min height
** MAX_H = max height
** CUSTOM_H = custom value (warning: you must also set the CUSTOM_HEIGHT option - see below)
** INTERP = interpolate with Delaunay triangulation (warning: you may have to set the MAX_EDGE_LENGTH parameters as well - see below)
** KRIGING = interpolate with Kriging (since version 2.13)
Default behavior is 'leave cells empty'
* <code>-MAX_EDGE_LENGTH {value}</code> to specify a maximum triangle edge length for interpolation (to be used with -EMPTY_FILL INTERP - default value is 1.0) (since version 2.12)
* <code>-CUSTOM_HEIGHT {value}</code> to define the custom height filling value (if the '-EMPTY_FILL CUSTOM_H' strategy is used - see above - if not set, the EMPTY_FILL option will fall back to 'leave cells empty')
* <code>-KRIGING_KNN {number of neighbors}</code> to define the number of neighbors used for Kriging (if the '-EMPTY_FILL KRIGING' strategy is used - see above - default is 8) (since version 2.13)
* <code>-OUTPUT_CLOUD</code> to output the result as a cloud (this is the default option if no other output format is defined)
* <code>-OUTPUT_MESH</code> to output the result as a mesh
* <code>-OUTPUT_RASTER_Z</code> to output the result as a geotiff raster (only altitudes, no RGB)
* <code>-OUTPUT_RASTER_Z_AND_SF</code> to output the result as a geotiff raster (altitudes + all SFs by default, no RGB)
* <code>-OUTPUT_RASTER_RGB</code> to output the result as a geotiff raster (RGB)
* <code>-RESAMPLE</code> to resample the input cloud (only in combination with OUTPUT_CLOUD and/or OUTPUT_MESH)
Notes:
* if OUTPUT_CLOUD or OUTPUT_MESH is selected, the resulting entity will replace the original cloud in memory
|-
|style="border-style: solid; border-width: 1px"| <code>-VOLUME -GRID_STEP {grid step}</code>
|style="border-style: solid; border-width: 1px"| ''[[2.5D_Volume | 2.5D estimation of the volume]] between two point clouds (the first is the ceiling, the second is the ground by default).''

This tool outputs two files:
* the volume calculation report (named VolumeCalculationReport.txt and saved next to the first file)
* the 2.5D grid points with the 'height difference' as a scalar field and also as RGB colors (colors are generated with the default color scale of CC). The file is saved next to the previous one, and it has the same base name as the first file with '_HEIGHT_DIFFERENCE' appended at the end.

Optional settings are:
* <code>-VERT_DIR {0/1/2}</code> to specify the projection dimension (0=X / 1=Y / 2=Z) - default is 2 (Z)
* <code>-CONST_HEIGHT {value}</code> to use a constant height instead of the second cloud
* <code>-GROUND_IS_FIRST</code> to invert the clouds order
* <code>-OUTPUT_MESH</code> to output a mesh instead of a cloud

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* see below for more details
|-
|style="border-style: solid; border-width: 1px"| <code>-STAT_TEST {distrib} {distrib parameters} {p-value} {neighbors count}</code>
|style="border-style: solid; border-width: 1px"| ''applies a [[Local_Statistical_Test | local statistical test]] based on their active scalar field to all the of loaded/generated clouds.''
{distrib} can be GAUSS or WEIBULL. Expected distribution parameters are:
* GAUSS: the mean value and sigma
* WEIBULL: a, b and the shift value

Note: result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-COORD_TO_SF {dimension: X, Y or Z}</code>
|style="border-style: solid; border-width: 1px"| ''[[Scalar_fields%5CExport_coordinate(s)_to_SF(s) | exports the specified coordinate]] (dimension) to a scalar field.''

Note: creates a new scalar field (or overwrite any existing one with the same name) and sets it active.
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_TO_COORD {sf index or name} {dimension: X, Y or Z}</code>
|style="border-style: solid; border-width: 1px"| ''[[Scalar_fields%5CSet_SF_as_coordinate(s) | set the specified scalar field values as coordinate]] (dimension) of the loaded clouds.''

Notes:
* it is possible to use '-1' as index to designate the default/current scalar field
* since version 2.13.
|-
|style="border-style: solid; border-width: 1px"| <code>-NORM_TO_SF {X/Y/Z}</code>
|style="border-style: solid; border-width: 1px"| ''[[Normals%5CExport_normals_to_SF(s) | exports the specified normal components]] to scalar fields.''

{X/Y/Z} is any combination of X, Y and Z, such as 'XYZ', 'XZ' or 'Y'

Notes:
* example: CloudCompare -O myfile.bin -NORM_TO_SF XYZ (to extract a scalar field for each of the 3 components Nx, Ny and Nz)
* since version 2.14.
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_TO_NORM {SFxIndex} {SFyIndex} {SFzIndex}</code>
|style="border-style: solid; border-width: 1px"| ''[[Normals%5CSet_SF(s)_as_normal | set the specified scalar field values as normal components]] of the loaded clouds.''

{SFnIndex} can be a numerical index, a name or 'LAST', or -1 if the dimension should not be initialized from a SF (in which case it will be left at its previous value, or 0 if no normal was previously set)

Notes:
* example: CloudCompare -O myfile.bin -SF_TO_NORM 0 -1 1 (to set the first scalar field as Nx, nothing for Nz, and the second scalar field as Nz)
* since version 2.14.
|-
|style="border-style: solid; border-width: 1px"| <code>-COLOR_INTERP</code>
|style="border-style: solid; border-width: 1px"| ''[[Colors\Interpolate from another entity | Interpolates the colors]] from one cloud to the other cloud.''

Note: since version 2.13.
|-
|style="border-style: solid; border-width: 1px"| <code>-FILTER_SF {minVal} {maxVal}</code>
|style="border-style: solid; border-width: 1px"| ''[[Scalar_fields%5CFilter_by_Value | filters]] all the loaded/generated clouds (or meshes, since version 2.13) based on their active scalar field values.''

A new cloud (or new mesh) is created each time with only the points falling in the [minVal maxVal] interval.

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* input clouds are now replaced by their filtered version (since version 2.6.1) and likewise for meshes (since version 2.13)

You can use special words in place of numbers that CC will replace by the actual SF values:
* 'MIN' = min value
* 'DISP_MIN' = min displayed value
* 'SAT_MIN' = min saturation value
* 'MAX' = max value
* 'DISP_MAX' = max displayed value
* 'SAT_MAX' = max saturation value
* 'N_SIGMA_MIN {N}' = mean - N * standard deviation
* 'N_SIGMA_MAX {N}' = mean + N * standard deviation

|-
|style="border-style: solid; border-width: 1px"| <code>-DENSITY {sphere radius}</code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Density | density]] (inside a sphere around each point) on the currently opened/generated cloud(s).''

Optional setting:
* -TYPE {density_type}: to specify the type of density to compute. {density_type} can be KNN (nearest neighbors count), SURFACE (surface density) or VOLUME (volume density).

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-APPROX_DENSITY</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Density | approximate density]] on the currently opened/generated cloud(s).''

Optional setting:
* -TYPE {density_type}: to specify the type of density to compute. {density_type} can be KNN (nearest neighbors count), SURFACE (surface density) or VOLUME (volume density).

Notes:
* a new scalar field is created on each cloud.
* result is automatically saved.
|-
|style="border-style: solid; border-width: 1px"| <code>-ROUGH {kernel size} {-UP_DIR {x} {y} {z}} </code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Roughness | roughness]] with a given kernel size on the currently opened/generated cloud(s).''

Since version 2.13, optional parameter <code>-UP_DIR {x} {y} {z}</code> allows to specify a 'up direction' to sign roughness values.

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-CURV {type} {kernel size}</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Curvature | local curvature]] with a given kernel size on the currently opened/generated cloud(s).''
{type} can be MEAN, GAUSS or NORMAL_CHANGE (this last option stands for 'Normal change rate' and is only available in version 2.10 or later).

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_GRAD {euclidian}</code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Scalar_fields%5CGradient | gradient]] of the active scalar field (or the first one if none is active) on the currently opened/generated cloud(s).''
The {euclidian} option specifies whether the scalar field is 'euclidian' (TRUE) - typically like a distance field - or not (FALSE).

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-BEST_FIT_PLANE</code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Fit_Plane | best fitting plane]] on all loaded clouds.''

Optional settings are:
* -MAKE_HORIZ: will actually transform the loaded cloud(s) so as to make them 'horizontal'
* -KEEP_LOADED: to keep the resulting plane(s) in memory as mesh(es)

Notes:
* resulting planes are automatically saved
* if MAKE_HORIZ is defined, result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-APPLY_TRANS {-APPLY_TO_GLOBAL {FORCE}} {-INVERSE} {filename}</code>
|style="border-style: solid; border-width: 1px"| ''applies a 4x4 transformation matrix to the loaded entities (clouds or meshes). The matrix is read from a simple text file with the matrix rows on each line (4 values per lines, 4 lines).''

Sub-options are:
* -INVERSE: to invert the transformation before applying it (since version 2.13)
* -APPLY_TO_GLOBAL {FORCE}: to apply the transformation to the global coordinates instead of the local coordinates (since version 2.13)
** warning: the Global Shift might be automatically adjusted to preserve accuracy (and small local coordinates)
** by default, the Global Shift won't be automatically adjusted if the local coordinates are already large.
** Use 'FORCE' after -APPLY_TO_GLOBAL to force CC to adjust the Global Shift in any case.

Notes:
* each entity will be replaced in memory by its transformed version
* resulting entities are automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-MATCH_CENTERS</code>
|style="border-style: solid; border-width: 1px"| ''makes all the (bounding-box) centers of the loaded entities match. All the entities will move relatively to the first one (clouds are always considered first if clouds and meshes are loaded).''

Note: result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-DELAUNAY</code>
|style="border-style: solid; border-width: 1px"| ''[[Mesh%5CDelaunay_2.5D_(XY_plane) | Triangulates]] the loaded clouds with 2.5D Delaunay triangulation. The triangulation is done in the (XY) plane by default.''

Optional settings are:
* -AA: to triangulate the points in the (XY) plane (default behavior).
* -BEST_FIT: to [[Mesh%5CDelaunay_2.5D_(best_fit_plane) | triangulate the points in their best fit plane]]
* -MAX_EDGE_LENGTH {length}: to remove the triangles with edges longer than a given threshold

Notes:
* the resulting 'mesh' entity is automatically saved (see the AUTO_SAVE command to change this).
* the clouds are automatically removed (from the 'loaded clouds' set).
|-
|style="border-style: solid; border-width: 1px"| <code>-FLIP_TRI</code>
|style="border-style: solid; border-width: 1px"| ''Flips the order of the triangle vertices of all opened meshes (since version 2.13).''

Notes:
* the updated mesh entities are automatically saved (see the AUTO_SAVE command to change this).
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-ICP</code>
|style="border-style: solid; border-width: 1px"| ''[[ICP | Iterative Closest Point]] registration procedure.''

Optional settings are:
* -REFERENCE_IS_FIRST: by default the ICP registration process will take the first loaded entity as 'data' and the second as 'model' (clouds are always considered first). If you use this option their respective role will be inverted.
* -MIN_ERROR_DIFF: to specify the min. error difference between two steps (default = 1e-6)
* -ITER: to specify the number of iterations (in which case the 'MIN_ERROR_DIFF' option will be ignored)
* -OVERLAP: to specify the percentage of (final) overlap (integer number between 10 and 100 - default = 100)
* -ADJUST_SCALE: to enable the ICP registration with adaptive scale
* -RANDOM_SAMPLING_LIMIT: to specify the number of points randomly sampled at each iteration (default = 20 000)
* -FARTHEST_REMOVAL: to enable the ''research'' option that ignores points with the highest distances at each iteration
* -DATA_SF_AS_WEIGHTS + {SF index or name}: to use a given scalar field as weights on the 'data' entity (index starts from 0 - the 'LAST' keyword can be used)
* -MODEL_SF_AS_WEIGHTS + {SF index or name}: to use a given scalar field as weights on the 'model' entity (index starts from 0 - the 'LAST' keyword can be used)
* -ROT + {'XYZ' or 'X' or 'Y' or 'Z' or 'NONE'}: to constrain the rotation around a given axis (or no rotation at all) (since version 2.11)
* -SKIP_TX, -SKIP_TY and/or -SKIP_TZ to prevent the entities from moving along X, Y and/or Z (since version 2.13)

Notes:
* the 'data' entity in its final position is automatically saved (see the AUTO_SAVE command to change this).
* the corresponding transformation matrix is automatically saved in a separate text file (always).
* the name of the weight scalar fields can be used only since version 2.13 (only the SF index was accepted in previous versions)
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field (to be used with DATA_SF_AS_WEIGHTS or MODEL_SF_AS_WEIGHTS)
|-
|style="border-style: solid; border-width: 1px"| <code>-CROP {Xmin:Ymin:Zmin:Xmax:Ymax:Zmax}</code>
|style="border-style: solid; border-width: 1px"| ''[[Crop | Crops]] all loaded clouds inside or outside a given box.''

Optional settings are:
* -OUTSIDE: if defined only the points falling outside the input box will be kept (instead of inside by default).

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* each cloud will be replaced in memory by its cropped version (since version 2.11, the cloud is removed from memory if it's totally cropped out)
|-
|style="border-style: solid; border-width: 1px"| <code>-CROP2D {ortho_dim} {-GLOBAL_SHIFT + options} {n:number of vertices} X1 Y1 X2 Y2 ... Xn Yn {-OUTSIDE}</code>
|style="border-style: solid; border-width: 1px"| ''Crops all loaded clouds inside or outisde a given 2D polyline. Cropping is done in a plane defined by its orthogonal dimension: X, Y or Z (i.e. coordinates along this dimension will be ignored).''

Since version 2.14, it is possible to set a Global Shift when importing the 2D vertices. It uses the same syntax as the -O option (see the -O -GLOBAL_SHIFT option).

Warning, after setting the dimension, CloudCompare will expect the 2D vertices in the following order:
* ortho_dim = X --> YZ
* ortho_dim = Y --> ZX
* ortho_dim = Z --> XY

Since version 2.14:
* ortho_dim = Xflip --> ZY
* ortho_dim = Yflip --> XZ
* ortho_dim = Zflip --> YX

Optional settings are:
* -OUTSIDE: if defined (after the coordinates of the vertices) only the points falling outside the input polyline will be kept (instead of inside by default)

Note:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* each cloud will be replaced in memory by its cropped version

|-
|style="border-style: solid; border-width: 1px"| <code>-CROSS_SECTION {XML parameters file}</code>
|style="border-style: solid; border-width: 1px"| ''[[Cross_Section | Extracts one or multiple sections]] from the clouds or meshes.''

Either the loaded clouds and/or meshes (see the -O option) can be used otherwise CC can load one or several files from a specified folder (use the 'FilePath' key).

See [http://www.cloudcompare.org/doc/cross_section_params.xml] for an example of XML parameter file.

Note:
* output sections for meshes are 'clean' (i.e. triangles on the cutting borders are re-meshed)
* output sections are automatically saved in sub-folders (they are not kept in memory)

|-
|style="border-style: solid; border-width: 1px"| <code>-SOR {number of neighbors} {sigma multiplier}</code>
|style="border-style: solid; border-width: 1px"| ''applies the [[SOR_filter | SOR (Statistical Outlier Removal) filter]] to the loaded cloud(s).''
For each cloud, a new one will be generated (and will replace the origin cloud).

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-NOISE KNN/RADIUS {value 1} REL/ABS {value 2} {RIP}</code>
|style="border-style: solid; border-width: 1px"| ''applies the [[Noise_filter | Noise filter]] to the loaded cloud(s).''
For each cloud, a new one will be generated (and will replace the origin cloud).

Value 1: the caller has to choose between KNN (number of neighbors) or RADIUS (spherical neighborhood)
Value 2: the caller has to choose between REL (multiplier of the local error standard deviation) or ABS (absolute error)
RIP: Remove Isolated Points (optional)

Example: '-NOISE RADIUS 0.5 REL 1.0 RIP'

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RDP {min distance between points}</code>
|style="border-style: solid; border-width: 1px"| ''applies the [[Remove_duplicate_points | Remove duplicate points]] tool to the loaded cloud(s).''
For each cloud, a new one will be generated (and will replace the origin cloud).

The minimum distance between points (to not consider them as duplicate) can be set. Otherwise a very small value is used by default.

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-DEBUG</code>
|style="border-style: solid; border-width: 1px"| ''display various pieces of information to help one debug and tweak the command line.''

Note:
* can be placed at different positions
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RENAME_ENTITIES {base name}</code>
|style="border-style: solid; border-width: 1px"| ''rename all loaded entities (clouds or meshes) with the provided base name.''
A numerical suffix is automatically added if multiple entities are loaded.

Note:
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_ARITHMETIC {SF index or name} {operation} {option}</code>
|style="border-style: solid; border-width: 1px"| ''applies [[Scalar_fields%5CArithmetic | operations]] to a given scalar field of the loaded cloud/mesh.''

SF2 = operation(SF)

The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Supported operations are:
* sqrt (square root)
* pow2
* pow3
* exp
* log
* log10
* cos
* sin
* tan
* acos
* asin
* atan
* int (integer part)
* inverse
* abs (since version 2.13)

Optional settings are:
* <code>-IN_PLACE</code> to apply the operation in place, without creating a new SF (since version 2.13)

Notes:
* the updated cloud/mesh is automatically saved (see the AUTO_SAVE command to change this)
* a new scalar field is created
* the SF name can only be used since version 2.13
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_OP {SF index or name} {operation} {value} </code>
|style="border-style: solid; border-width: 1px"| ''applies an [[Scalar_fields%5CArithmetic | arithmetic operation]] to a given scalar field of the loaded cloud/mesh and with a given scalar value.''

SF = SF (+,-,*,/) VALUE
or
SF = 'SET' VALUE (since version 2.13)

The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Supported operations are:
* add
* sub
* mult
* div
* set (since v2.13)

Notes:
* the updated cloud/mesh is automatically saved (see the AUTO_SAVE command to change this)
* the modification is done in place (i.e. the scalar field is directly modified)
* the SF name can be used since version 2.13 only
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_OP_SF {SF1 index or name} {operation} {SF2 index or name} </code>
|style="border-style: solid; border-width: 1px"| ''applies an [[Scalar_fields%5CArithmetic | arithmetic operation]] to two scalar fields of the loaded cloud/mesh.''

SF = SF1 (+,-,*,/) SF2

The scalar-field indexes start from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Supported operations are:
* add
* sub
* mult
* div
* min
* max

Notes:
* the updated cloud/mesh is automatically saved (see the AUTO_SAVE command to change this)
* the modification is done in place (i.e. the scalar field is directly modified)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_INTERP {SF index} {-DEST-IS_FIRST} </code>
|style="border-style: solid; border-width: 1px"| ''applies the [[Scalar_fields%5CInterpolate_from_another_entity | SF Interpolate from another entity]] algorithm to a given scalar field of the 2 first loaded clouds''

By default the first cloud will be considered as the source cloud (with the designated scalar field) and the second cloud is the destination cloud. Use the sub-option -DEST-IS_FIRST to invert their roles.
The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Warning: for now the command line will always use the same options:
* interpolation method: nearest neighbors
* interpolation algorithm: normal distribution
* radius = 1% of the destination cloud bounding-box
* sigma = 40% of the radius

Notes
* the updated cloud is not automatically saved! (use the SAVE_CLOUDS command to do it)
* it is possible to use '-1' as index to designate the default/current scalar field
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_ADD_CONST {SF name} {value} </code>
|style="border-style: solid; border-width: 1px"| ''adds a constant scalar field (with the specified value for all scalar values) to the loaded clouds''

Notes
* updated clouds are automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RENAME_SF {SF index or name} {new name}</code>
|style="border-style: solid; border-width: 1px"| ''renames a given scalar field of the loaded clouds/meshes.''

The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* the SF name can only be used since version 2.13
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-CBANDING {dim} {freq}</code>
|style="border-style: solid; border-width: 1px"| ''Applies [[Colors%5CHeight_Ramp | color banding]] to all loaded entities (clouds and meshes). The user must specify the dimension (dim = X, Y or Z) and the frequency (in Hz, as an integer).''

Note:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEVELS {bands} {input range min} {input range max} {output range min} {output range max}</code>
|style="border-style: solid; border-width: 1px"| ''Applies [[Colors%5CLevels | color levels]] to all loaded entities (clouds and meshes).

The caller must specify:
* the color bands (can be any mix of 'R', 'G' and 'B' - ex: 'G' or 'RB' or 'RGB')
* the input range (typically where most of the color information lies, ex: 40 210)
* the output range (typically: 0 255)

Note:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_COLOR_SCALE {filename}</code>
|style="border-style: solid; border-width: 1px"| ''Loads a color scale from a XML file (generated with the [[Scalar_fields%5CColor_Scales_Manager | Color Scales Manager]]). The loaded color scale is then applied to the active scalar field of all loaded clouds (and all loaded meshes since version 2.13).''

Note:
* it may be necessary to explicitly set the active scalar field with the SET_ACTIVE_SF command
* since version 2.10 only

|-
|style="border-style: solid; border-width: 1px"| <code>-SF_CONVERT_TO_RGB {TRUE/FALSE}</code>
|style="border-style: solid; border-width: 1px"| ''Converts the active scalar field to RGB colors. The user must explicitly specify whether the previously existing colors (if any) should be mixed with the new ones (TRUE) or overwritten (FALSE).''

Note:
* it may be necessary to explicitly set the active scalar field with the SET_ACTIVE_SF command
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RGB_CONVERT_TO_SF</code>
|style="border-style: solid; border-width: 1px"| ''Converts the RGB colors to 5 scalar fields in the following order: Red, Green, Blue, Alpha and Composite.''

Note:
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-M3C2 {parameters_file}</code>
|style="border-style: solid; border-width: 1px"| ''Calls the [[M3C2_(plugin) | M3C2]] plugin (if available) on the two first loaded clouds. If a 3rd cloud is loaded, it will be used a core points. The first time, the parameters file can be created with the GUI tool (use the 'Save parameters to file' button in the bottom-left corner of the M3C2 dialog = the floppy icon). It can then be edited easily.''

Note:
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-CSF {filename}</code>
|style="border-style: solid; border-width: 1px"| ''Runs the [[ CSF_(plugin) | Cloth Simulation Filter (CSF) plugin]]''

Options are:
* '-SCENES [scene]' name of the scene options are:
** 'SLOPE'
** 'RELIEF'
** 'FLAT'
* '-PROC_SLOPE' (turns on slope post processing for disconnected terrain)
* '-CLOTH_RESOLUTION [value]' (double value of cloth resolution [ex. 0.5])
* '-MAX_ITERATION [value]' (integer value of max iterations [ex. 500])
* '-CLASS_THRESHOLD [value]' (double value of classification threshold [ex. 0.5])
* '-EXPORT_GROUND' (exports the ground as a .bin file)
* '-EXPORT_OFFGROUND' (exports the off-ground as a .bin file)

Note:
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-CANUPO_CLASSIFY {classifier.prm}</code>
|style="border-style: solid; border-width: 1px"| ''Calls a [[CANUPO_(plugin) | CANUPO]] classifier (if the plugin is available) on the loaded clouds. You'll need a trained classifier (.prm file)''

Optional settings are:
* USE_CONFIDENCE {threshold}
** threshold must be between 0 and 1
** use the 'SET_ACTIVE_SF' after loading a cloud to set the active scalar field if you want it to be used to refine the classification

Note:
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-PCV</code>
|style="border-style: solid; border-width: 1px"| ''Runs the [[ ShadeVis (plugin) | PCV plugin]] (also known as ambient occlusion or ShadeVis)''

Optional settings are:
* -N_RAYS [value]: number of rays
* -IS_CLOSED: Tells PCV that the mesh is watertight. This accelerates processing.
* -180: Rays only come from the "northern hemisphere" (northern means +Z)
* -RESOLUTION: OpenGL context resolution

Note:
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RANSAC</code>
|style="border-style: solid; border-width: 1px"| ''Runs the [[ RANSAC_Shape_Detection_(plugin) | Ransac Shape Detection plugin]]''

Options are:
* 'EPSILON_ABSOLUTE' (Max distance to primitive)
* 'EPSILON_PERCENTAGE_OF_SCALE' (Max distance to primitive as a percentage of cloud scale 0.0-1.0 exclusive)
* 'BITMAP_EPSILON_PERCENTAGE_OF_SCALE' (Sampling resolution as a percentage of cloud scale 0.0-1.0 exclusive)
* 'BITMAP_EPSILON_ABSOLUTE' (Sampling resolution)
* 'SUPPORT_POINTS' (Min Support points per primitive)
* 'MAX_NORMAL_DEV' (Max normal deviation from the ideal shape normal vector [in Degrees])
* 'PROBABILITY' (Probability that no better candidate was overlooked during sampling, lower the better!)
* 'OUT_CLOUD_DIR' (path to save detected shapes clouds to, current dir if unspecified)
* 'OUT_MESH_DIR' (path to save detected shapes meshes to, current dir if unspecified)
* 'OUT_PAIR_DIR' (path to save detected shapes clouds & meshes to, current dir if unspecified)
* 'OUT_GROUP_DIR' (path to save all shapes and primitives to as a single file, current dir if unspecified)
* 'OUTPUT_INDIVIDUAL_SUBCLOUDS' (specify to output detected shapes clouds)
* 'OUTPUT_INDIVIDUAL_PRIMITIVES' (specify to output detected shapes meshes)
* 'OUTPUT_INDIVIDUAL_PAIRED_CLOUD_PRIMITIVE' (specify to output detected shapes clouds & meshes)
* 'OUTPUT_GROUPED' (specify to output all detected shapes clouds & meshes as single file)
* 'ENABLE_PRIMITIVE' (each shape listed after this option will be searched for )
** 'PLANE'
** 'SPHERE'
**'CYLINDER'
**'CONE'
**'TORUS'

Notes:
* since version 2.11 only
|-
|style="border-style: solid; border-width: 1px"| <code>-C_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for clouds. Format can be one of the following: ASC, BIN, PLY, LAS, E57, VTK, PCD, SOI, PN, PV.''

Optional settings are:
* -PREC [precision]: to specify the numerical output precision (for ASCII files only). ''precision'' is a positive integer (default = 12).
* -SEP [separator]: to specify the separator character (for ASCII files only). ''separator'' can be one of the following string: SPACE, SEMICOLON, COMMA or TAB (default = SPACE).
* -ADD_HEADER: to add a header with each column's name to the saved file (for ASCII files only).
* -ADD_PTS_COUNT: to add the number of points at the beginning of the saved file (for ASCII files only).
* -EXT [extension]: to specify the file extension (typically different from the default one for the chosen format)
* -NO_LABEL: to prevent creating/loading 2D labels from ASCII files in case text columns are present in the file (since version 2.13.2)

'''WARNING: the ADD_HEADER and ADD_PTS_COUNT options are broken in the 2.6.2 version. Use a newer version instead.'''
|-
|style="border-style: solid; border-width: 1px"| <code>-M_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for meshes. Format can be one of the following: BIN, OBJ, PLY, STL, VTK, MA, FBX.''

Optional settings are:
* -EXT [extension]: to specify the file extension (typically different from the default one for the chosen format)
|-
|style="border-style: solid; border-width: 1px"| <code>-H_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for groups (hierarchy objects). Mostly the BIN format, but other formats that support a collection of objects might be elligible.''

Note:
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-FBX -EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for FBX meshes. Must be specified in addition to M_EXPORT_FMT if FBX format is chosen. Format can be one of the following: FBX_binary, FBX_ascii, FBX_encrypted, FBX_6.0_binary, FBX_6.0_ascii, FBX_6.0_encrypted.''

Notes:
* if the input format is not supported by the current implementation, a list of available formats will be output in the console.
* the option was "-FBX_EXPORT_FMT" in version 2.10 and earlier
|-
|style="border-style: solid; border-width: 1px"| <code>-PLY_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for PLY files. Format can be one of the following: ASCII, BINARY_BE (big endian) or BINARY_LE (little endian).''

Note: default output format is binary (LE/BE depending on the current OS)
|-
|style="border-style: solid; border-width: 1px"| <code>-NO_TIMESTAMP</code>
|style="border-style: solid; border-width: 1px"| ''to prevent CC from generating an automatic suffix (timestamp) for output file name (warning: this make the name of an output file predictable but if the file already exists it will be overwritten).''
|-
|style="border-style: solid; border-width: 1px"| <code>-BUNDLER_IMPORT {filename}</code>
|style="border-style: solid; border-width: 1px"| ''imports a Snavely's Bundler file.''

Bundler import through the command line is mainly meant to generate ortho-rectified versions of input images directly on disk.
Optional settings are:
* -ALT_KEYPOINTS [filename]: load alternative keypoints from file ''filename''
* -SCALE_FACTOR [value]: sets image scale factor that has been used during keypoints generation
* -COLOR_DTM [vertices count]: generates colored vertices of a pseudo-DTM with approximately 'vertices count' elements (in command line mode, vertices are automatically saved to 'colored_dtm_vertices.bin' next to ortho-rectified images)
* -UNDISTORT: enables images undistortion

Note: see below for more details.
|-
|style="border-style: solid; border-width: 1px"| <code>-SET_GLOBAL_SHIFT {x} {y} {z} {-KEEP_ORIG_FIXED}</code>
|style="border-style: solid; border-width: 1px"| ''Overrides the Global Shift information for all loaded entities.''

Use the sub-option -KEEP_ORIG_FIXED to maintain the global coordinates unchanged. This will in effect translate the points in the local coordinate system (a warning may be issued if the resulting coordinates are too big).

Note: since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-DROP_GLOBAL_SHIFT</code>
|style="border-style: solid; border-width: 1px"| ''Removes the Global Shift information from all loaded entities.''

Note:
* equivalent to using '-SET_GLOBAL_SHIFT 0 0 0'
|-
|style="border-style: solid; border-width: 1px"| <code>-SET_ACTIVE_SF {SF index or 'SF name'}</code>
|style="border-style: solid; border-width: 1px"| ''Sets the active scalar field index or name (same for all loaded clouds).''

Notes:
* scalar field indexes start at 0 ('-1' means 'no SF enabled')
* the SF name must be surrounded by simple quotes (e.g. 'Point Source Id')
* designing the SF by its name is only possible since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_ALL_SFS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all scalar fields (from all loaded clouds or meshes).

Note:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_SF {index}</code>
|style="border-style: solid; border-width: 1px"| ''Removes the scalar field at the specified index (from all loaded clouds or meshes).

Notes:
* if no SF is found at this index, a simple warning will be issued (no error will be triggered).
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* since version 2.12
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_RGB</code>
|style="border-style: solid; border-width: 1px"| ''Removes colors (from all loaded clouds or meshes).

Notes:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''Removes normals (from all loaded clouds or meshes, per vertex or per faces).

Notes:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_SCAN_GRIDS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all scan grids (from all loaded clouds or meshes).

Note:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* available since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_SENSORS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all sensors (both TLS and cameras, directly under clouds, meshes or mesh vertices).

Note:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* available since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-COMPRESS_FWF</code>
|style="border-style: solid; border-width: 1px"| ''compresses FWF data associated to all clouds in memory (waveform support)''
|-
|style="border-style: solid; border-width: 1px"| <code>-AUTO_SAVE {''ON/OFF''}</code>
|style="border-style: solid; border-width: 1px"| ''Enables (''ON'') or disables (''OFF'') automatic backup of clouds and meshes at each step (you'll have to manually call ''-SAVE_CLOUDS'' or ''-SAVE_MESHES'' at the right time/position in your command).''
|-
|style="border-style: solid; border-width: 1px"| <code>-PCD_OUTPUT_FORMAT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Sets the default PCD file output format.''
Format can be:
* COMPRESSED_BINARY
* BINARY
* ASCII

Notes:
* since version 2.14 only
* when using the binary and ASCII formats, the output filename may be scrambled if non standard characters are present.
* this option must be placed before any PCD file is saved
|-
|style="border-style: solid; border-width: 1px"| <code>-SAVE_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''Saves all currently loaded clouds (note that this is not necessary by default as all modified or newly generated cloud are automatically saved).''
Optional settings are:
* ALL_AT_ONCE: saves all clouds in a single file (the current output format must support it!)
* FILE "file1.xxx file2.yyy ..." : to specify the output filename(s) of the clouds (use quotes if multiple names or names with space characters) [since version 2.10]
|-
|style="border-style: solid; border-width: 1px"| <code>-SAVE_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''Saves all currently loaded meshes (note that this is not necessary by default as all modified or newly generated meshes are automatically saved).''
Optional settings are:
* ALL_AT_ONCE: saves all meshes in a single file (the current output format must support it!)
* FILE "file1.xxx file2.yyy ..." : to specify the output filename(s) of the clouds (use quotes if multiple names or names with space characters) [since version 2.10]
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR</code>
|style="border-style: solid; border-width: 1px"| ''closes all currently loaded entities.''
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''closes all currently loaded clouds.''
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''closes all currently loaded meshes.''
|-
|style="border-style: solid; border-width: 1px"| <code>-POP_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''removes the last loaded or generated cloud.''
|-
|style="border-style: solid; border-width: 1px"| <code>-POP_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''removes the last loaded or generated mesh.''
|-
|style="border-style: solid; border-width: 1px"| <code>-LOG_FILE {filename}</code>
|style="border-style: solid; border-width: 1px"| ''logs all command output messages in a given file.''
|-
|style="border-style: solid; border-width: 1px"| <code>-FWF_O {filename}</code>
|style="border-style: solid; border-width: 1px"| ''opens a LAS 1.3/1.4 file (waveform support) [Windows version only]''

* Note: this is deprecated (or at least useless) with version 2.13 as the new LAS I/O plugin now natively handles FWF data on all platforms.
|-
|style="border-style: solid; border-width: 1px"| <code>-FWF_SAVE_CLOUDS {filename}</code>
|style="border-style: solid; border-width: 1px"| ''saves all clouds in memory a LAS 1.3/1.4 files (waveform support) [Windows version only]''

* Note: this is deprecated (or at least useless) with version 2.13 as the new LAS I/O plugin now natively handles FWF data on all platforms.
|-
|}

=Example 0=

:<code>CloudCompare -O -GLOBAL_SHIFT AUTO mylargecoordinatescloud.las -C_EXPORT_FMT LAS -SS SPATIAL 0.1</code>

This will open file ''mylargecoordinatescloud.las'' with an automatic Global Shift (to avoid issues with large coordinates), then set the export format to be LAS as well (otherwise the CloudCompare BIN format is used by default) and eventually it applies some spatial subsampling with a 0.1 step (= 0.1 meter, assuming the LAS file coordinates are in meters). The output file will be ''mylargecoordinatescloud_SPATIAL_SUBSAMPLED_YYYY-MM-DD_HHhMM.las''.

=Example 1=

:<code>CloudCompare -O ''myhugecloud.bin'' -SS SPATIAL 0.1</code>
This will open file ''myhugecloud.bin'' then apply spatial subsampling with a 0.1 step (e.g. in meters). The output file will be ''myhugecloud_SPATIAL_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin''.

=Example 2=
:<code>CloudCompare -O ''myhugecloud1.bin'' -SS SPATIAL 0.1 -O 'myhugecloud2.bin' -SS RANDOM 1000000 -CLEAR_ALL -O 'myhugecloud3.bin' -SS OCTREE 9</code>
This will open file ''myhugecloud1.bin'' then apply spatial subsampling with a 0.1 step (e.g. in meters). 
Then it will open file ''myhugecloud2.bin'' and apply to '''both files''' random subsampling (1 000 000 points each). 
Then it will close the two first files. 
Eventually it will open file ''myhugecloud3.bin'' and apply octree based subsampling (level 9).

The output files will be: ''myhugecloud1_SPATIAL_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin'', ''myhugecloud1_RANDOM_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin'', ''myhugecloud2_RANDOM_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin'' and ''myhugecloud3_OCTREE_level_9_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin''

=Cloud-to-cloud distance=

:<code>CloudCompare -o cloud1.bin -o cloud2.asc -c2c_dist -split_xyz -model HF SPHERE 50.0</code>
CC will load ''cloud1.bin'' and ''cloud2.asc'', then compute the distance from cloud1 (''compared'') relatively to cloud2 (''reference'') with a height function (''quadric'') computed on all the neighbors falling in a sphere of radius 50.0 around each point of ''cloud1''. On output a file ''cloud1_C2C_DIST_YYYY-MM-DD_HHhMM.bin'' will be generated (with the resulting distances as first scalar field and the 3 components of the corresponding displacement vector along X, Y and Z as additional scalar fields).

Note: this cloud stays in memory and can be processed further (with -FILTER_SF for instance).

=Cloud-to-mesh distance=

:<code>CloudCompare -o cloud1.bin -o mesh.obj -c2m_dist</code>
CC will load ''cloud1.bin'' and ''mesh.obj'', then compute the distance from cloud1 (''compared'') relatively to mesh (''reference''). On output a file ''cloud1_C2M_DIST_YYYY-MM-DD_HHhMM.bin'' will be generated (with the resulting distances as scalar field).

Note: this cloud stays in memory and can be processed further (with -FILTER_SF for instance).

=Cycling over files in a folder (Windows)=
<blockquote>
set local EnableDelayedExpansion 
set Compared=C:\MY_FIRST_PATH 
set Reference=E:\MY_SECOND_PATH 
for %%f in ( "%Reference%"\* ) do ("C:\Program Files\CloudCompare\cloudcompare.exe" -SILENT -C_EXPORT_FMT LAS -O %Compared%\%%~nxf -O %Reference%\%%~nxf -c2c_dist -MAX_DIST 1 -FILTER_SF 1 1 -SOR 8 2) 
</blockquote>

=Bundler import=

:<code>CloudCompare -BUNDLER_IMPORT bundle.out -COLOR_DTM 1000000</code>
This will generate all ortho-rectified versions of the images declared in 'bundle.out', as well as the colored vertices of a pseudo-DTM constructed from the keypoints.

=(Mesh) format conversion=

:<code>CloudCompare -M_EXPORT_FMT FBX -FBX -EXPORT_FMT FBX_binary -O Foot.ply -NO_TIMESTAMP -SAVE_MESHES</code>
This will open the file named 'Foot.ply' then save it in FBX binary format (same base filename, without any decoration: i.e. ''Foot.fbx'')

Command line mode

2025-07-13T19:14:12Z

Daniel: /* Available options (version 2.14.alpha) */

Since version 2.3, CloudCompare can be used in "command line" mode.

By default, this mode only opens a small console window, applies the requested actions, and eventually saves the result in a file in the same directory(ies) as the input file(s). Commands are applied in the order they are written (like a ''state machine'').

=Available options (version 2.14.alpha) =

{| cellpadding="10" style="text-align:left; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
!style="border-style: solid; border-width: 1px" ! scope="col" width="200" | Command
!style="border-style: solid; border-width: 1px"| Description
|-
|style="border-style: solid; border-width: 1px"| <code>-VERBOSITY [0-4]</code>
|style="border-style: solid; border-width: 1px"| ''sets the log verbosity level (0: verbose, 1: standard, 2: important, 3: warnings and errors only, 4: errors only)''
notes:
- to hide plugin loading logs, it should be set as first argument (even before -SILENT, in which case -SILENT can be the second argument)
- since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-SILENT</code>
|style="border-style: solid; border-width: 1px"| ''enables silent mode (no console will appear)''
Warning: must be first if required (or after -VERBOSITY).
|-
|style="border-style: solid; border-width: 1px"| <code>-O {filename}</code>
|style="border-style: solid; border-width: 1px"| ''opens a file''

If the file format is ASCII, optional settings are:
* <code>-SKIP {number of lines to skip}</code> If set, CC will automatically skip the specified number of lines
For all formats, optional settings are (version 2.5.6 and above):
* <code>-GLOBAL_SHIFT {AUTO} or {FIRST} or {x y z}</code>
** AUTO: CC will automatically determine the best Global Shift translation to preserve coordinates accuracy
** FIRST: CC will use the same parameters that were used for the first entity (i.e. the result of the first usage of the 'AUTO' option, or the first specified Global Shift vector (x,y,z)) - the FIRST option is available since v2.11

* Warnings:
** the GLOBAL_SHIFT option will be ignored for BIN files as they already contain their own GLOBAL_SHIFT values!
** the AUTO option won't reuse the global shift set for previous entities. Use the FIRST option instead.

Note: file type is automatically guessed from its extension.
|-
|style="border-style: solid; border-width: 1px"| <code>-COMMAND_FILE {base name}</code>
|style="border-style: solid; border-width: 1px"| '' loads commands from a file.''

Other commands after -COMMAND_FILE will run after all commands in the file have been processed.

See more information here: [https://github.com/CloudCompare/CloudCompare/pull/1909]

Notes:
* multiple lines allowed
* multiple arguments in each line allowed
* quoted arguments are handled
* whole (or half) line comments with '#' or '//' are supported.
* partial comments are supported: '/* my comment here */' (must be quoted with either single or double quote if it contains spaces)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SELECT_ENTITIES -{FIRST} {first count} -{LAST} {last count} {-ALL} {-NOT} {-REGEX} {regex pattern}</code>
|style="border-style: solid; border-width: 1px"| ''Selects some entities among all those loaded, before applying the subsequent commands.''

Sub-options are:
* -FIRST {count}: if set, first count of entities will be selected (optional). Example: xx.....
* -LAST {count}: if set, last count of entities will be selected (optional). Example: .....xx
* -ALL: if set, all entities will be selected (optional). It has higher priority than FIRST/LAST/REGEX. Example: xxxxxxx
* -REGEX {regex_pattern}: if set, all entities with matching names will be selected (optional). It has higher priority than FIRST/LAST. Example: x(merged)..x(merged)...
* -NOT: if set, all condition will be reversed (optional)
** -NOT -FIRST {count} -> all but first {count}. Example: ..xxxxx
** -NOT -LAST {count} -> all but last {count}. Example: xxxxx..
** -NOT -ALL -> none. Example: .......
** -NOT -REGEX matched -> regex not matched. Example: .(merged)xx.(merged)xxx
** special case: -NOT -FIRST c1 -LAST c2 -> all except first 'c1' AND last 'c2' entities. Example: ..xxx..
* -CLOUD: if set, only clouds will be selected (optional)
* -MESH: if set, only meshes will be selected (optional)

Notes:
* sub-options can be set in any order
* it is possible to use FIRST and LAST at the same time. Example: xx...xx
* if neither -CLOUD nor -MESH are set then both types of entities will be selected
* since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-MOMENT {radius}</code>
|style="border-style: solid; border-width: 1px"| ''Computes the 1st order moment for all loaded clouds with the specified radius.''

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-FEATURE {type} {radius}</code>
|style="border-style: solid; border-width: 1px"| ''Computes the geometric feature of type {type} for all loaded clouds with the specified radius:''

{type} can be one of the following:
* SUM_OF_EIGENVALUES
* OMNIVARIANCE
* EIGENTROPY
* ANISOTROPY
* PLANARITY
* LINEARITY
* PCA1
* PCA2
* SURFACE_VARIATION
* SPHERICITY
* VERTICALITY
* EIGENVALUE1
* EIGENVALUE2
* EIGENVALUE3

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-OCTREE_NORMALS {radius}</code>
|style="border-style: solid; border-width: 1px"| ''Computes the [[Normals%5CCompute | normals]] for all loaded clouds with the specified radius.''

Optional settings are:
* <code>-ORIENT {option}</code> to define an orientation hint
** PLUS_ZERO or PLUS_ORIGIN (v2.12+): normals will all point outwards the origin (0, 0, 0)
** MINUS_ZERO or MINUS_ORIGIN (v2.12+): normals will all point towards the origin (0, 0, 0)
** PLUS_BARYCENTER: normals will all point outwards the cloud barycenter
** MINUS_BARYCENTER: normals will all point towards the cloud barycenter
** PLUS_X: normals will all point towards +X (i.e. Nx >= 0)
** MINUS_X: normals will all point towards -X (i.e. Nx <= 0)
** PLUS_Y: normals will all point towards +Y (i.e. Ny >= 0)
** MINUS_Y: normals will all point towards -Y (i.e. Ny <= 0)
** PLUS_Z: normals will all point towards +Z (i.e. Nz >= 0)
** MINUS_Z: normals will all point towards -Z (i.e. Nz <= 0)
** PREVIOUS: normals will have the same orientation as the previous normals (if any)
** SENSOR_ORIGIN (v2.12+): use the associated sensor origin (if any)
* <code>-MODEL {local_model_type}</code> to specify a local model:
** {local_model_type} = LS / TRI / QUADRIC
* input ''radius'' can be replaced by 'auto' to let CC try to guess a possible value (since version 2.11)

Notes:
* default local model is 'QUADRIC'
* if you have files containing structured clouds (e.g. PTX, FARO, DP, etc.), it may be more efficient to use the 'COMPUTE_NORMALS' option (see below)
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-INVERT_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''Inverts the normals of the loaded entities (cloud or mesh, and per-vertex of per-triangle for meshes)''

Note: since version 2.12
|-
|style="border-style: solid; border-width: 1px"| <code>-COMPUTE_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''forces CC to compute normals at loading time (which is generally more robust) when importing files containing structured clouds (i.e. PTX, FARO and DP file for now). Normals are not computed by default.''

Note: must be placed before the '-O' option.
|-
|style="border-style: solid; border-width: 1px"| <code>-NORMALS_TO_SFS</code>
|style="border-style: solid; border-width: 1px"| ''Converts normal vectors to 3 scalar fields (Nx, Ny and Nz).''
Notes:
* since version 2.11 only
|-
|style="border-style: solid; border-width: 1px"| <code>-NORMALS_TO_DIP</code>
|style="border-style: solid; border-width: 1px"| ''Converts normal vectors to 2 'dip' and 'dip direction' scalar fields.''
Notes:
* since version 2.11 only
|-
|style="border-style: solid; border-width: 1px"| <code>-NORMALS_TO_HSV</code>
|style="border-style: solid; border-width: 1px"| ''Converts normal vectors to HSV colors.''
Notes:
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all normals from the loaded entities.''
|-
|style="border-style: solid; border-width: 1px"| <code>-ORIENT_NORMS_MST {number of neighbors}</code>
|style="border-style: solid; border-width: 1px"| ''[[Normals%5COrient_Normals_With_Minimum_Spanning_Tree | (Re)orient the normals]] of the loaded clouds with a Minimum Spanning Tree.''

Note: Clouds without normals are simply ignored.

|-
|style="border-style: solid; border-width: 1px"| <code>-MERGE_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''merges all loaded/generated clouds as one unique cloud.''

Notes:
- previous clouds are unloaded from memory.
- result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-MERGE_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''merges all loaded/generated meshes as one unique mesh.''

Notes:
- previous meshes are unloaded from memory.
- result is automatically saved by default (see the AUTO_SAVE command to change this). This option is available since version 2.9.
|-
|style="border-style: solid; border-width: 1px"| <code>-SS {algorithm} {parameter}</code>
|style="border-style: solid; border-width: 1px"| ''applies a [[Edit%5CSubsample | subsampling]] {algorithm} to the currently opened/generated cloud(s).''
{algorithm} can be RANDOM, SPATIAL or OCTREE.
Then, the expected {parameter} value depends on the chosen algorithm:
* RANDOM: number of randomly selected points
* SPATIAL: minimum distance between two points
* OCTREE: subdivision level (between 1 and 10 in the standard version)

Optional sub-options are (since version 2.13):
* -SS OCTREE NUMBER_OF_POINTS {number}: to subsample with the highest octree level for which the resulting point count won't exceed the given number of points
* -SS OCTREE NUMBER_OF_POINTS PERCENT {number}: to calculate NUMBER_OF_POINTS from PERCENT. PERCENT should be a decimal number between 0 and 100.
* -SS OCTREE CELL_SIZE {size}: to deduce the octree level from the given cell size.
* -SS RANDOM PERCENT {number}: to calculate the number of sampled points from PERCENT. PERCENT should be a decimal number between 0 and 100.
* -SS SPATIAL {fallback_step} USE_ACTIVE_SF {step_at_SF_min} {step_at_SF_max}: to use spatial step interpolation based on the active scalar field (the fallback step will be used if the active SF has only invalid values)

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* input clouds are now replaced by their subsampled version (since version 2.6.1)
|-
|style="border-style: solid; border-width: 1px"| <code>-EXTRACT_CC {octree level} {minimum number of points per component}</code>
|style="border-style: solid; border-width: 1px"| ''extracts the [[Label_Connected_Components | connected components]] from the currently opened/generated cloud(s).''
{octree level} should be between 1 and 21.

Notes:
* extracted components are automatically saved by default (see the AUTO_SAVE command to change this).
* input clouds are replaced by the extracted components
|-
|style="border-style: solid; border-width: 1px"| <code>-SAMPLE_MESH {method} {parameter}</code>
|style="border-style: solid; border-width: 1px"| ''[[Mesh%5CSample_points | samples points]] on the loaded mesh(es).''
For each mesh, a cloud will be generated (and will be added to the current loaded cloud set - i.e. further processing can be applied to this cloud).

{method} can be POINTS or DENSITY. Expected parameter is:
* POINTS: the corresponding number of points
* DENSITY: the corresponding surface density

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* this cloud can be used as input for cloud-to-cloud or cloud-to-mesh distances computation for instance.
|-
|style="border-style: solid; border-width: 1px"| <code>-EXTRACT_VERTICES</code>
|style="border-style: solid; border-width: 1px"| ''Extract the vertices of all loaded meshes as standalone point clouds. Note that this option is not yet activated! (sorry about that)''

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* the source mesh is discarded
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-C2C_DIST</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Cloud-to-Cloud_Distance | cloud-to-cloud distances]] on the two first loaded/generated clouds (1st = compared / 2nd = reference).''

Optional settings are:
* <code>-SPLIT_XYZ</code> If set, 3 additional scalar fields will be generated (displacement along the 3 dimensions)
* <code>-MAX_DIST {value}</code> to set a max distance above which CC won't have to search for a nearest neighbor (faster)
* <code>-OCTREE_LEVEL {value}</code> to manually set the octree subdivision level at which the computation will be performed
* <code>-MODEL {local_model_type} {neighborhood_type} {neighborhood_size}</code> to specify a local model:
** {local_model_type} = LS / TRI / HF
** {neighborhood_type} = KNN / SPHERE
** {neighborhood_size} = neighbor count (if KNN) or sphere radius (if SPHERE)
* <code>-MAX_TCOUNT {thread count}</code> to set the maximum number of threads to use
* <code>-SPLIT_XY_Z</code> to split the distance between the z component and the xy plane component (since version 2.13)

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* see below for more details
|-
|style="border-style: solid; border-width: 1px"| <code>-C2M_DIST</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Cloud-to-Mesh_Distance | Cloud-to-Mesh distances]] between the first loaded/generated cloud (compared) and the first loaded mesh (reference).''

Optional settings are:
* <code>-FLIP_NORMS</code> to consider that normal vectors point inside the matter and not outside
* <code>-MAX_DIST {value}</code> to set a max distance above which CC won't have to search for a nearest neighbor (faster)
* <code>-OCTREE_LEVEL {value}</code> to manually set the octree subdivision level at which the computation will be performed
* <code>-MAX_TCOUNT {thread count}</code> to set the maximum number of threads to use
* <code>-UNSIGNED</code> to compute unsigned distances (since version 2.13)
* <code>-SPLIT_XY_Z</code> to split the distance between the z component and the xy plane component (since version 2.13)

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* see below for more details
|-
|style="border-style: solid; border-width: 1px"| <code>-RASTERIZE -GRID_STEP {value}</code>
|style="border-style: solid; border-width: 1px"| ''[[Rasterize | Rasterizes]] the loaded clouds by projecting them inside a regular grid.''

Optional settings are:
* <code>-VERT_DIR {0/1/2}</code> to specify the projection dimension (0=X / 1=Y / 2=Z) - default is 2 (Z)
* <code>-PROJ {MIN/AVG/MAX}</code> to specify how the altitude of each cell is computed (minimum, average or maximum altitude of the projected points). Default is AVG (average)
* <code>-SF_PROJ {MIN/AVG/MAX}</code> to specify how the SF value(s) of each cell are computed (minimum, average or maximum of the projected points SF value(s)). Default is AVG (average)
* <code>-EMPTY_FILL {MIN_H/MAX_H/CUSTOM_H/INTERP/KRIGING}</code> to specify how empty cells should be filled:
** MIN_H = min height
** MAX_H = max height
** CUSTOM_H = custom value (warning: you must also set the CUSTOM_HEIGHT option - see below)
** INTERP = interpolate with Delaunay triangulation (warning: you may have to set the MAX_EDGE_LENGTH parameters as well - see below)
** KRIGING = interpolate with Kriging (since version 2.13)
Default behavior is 'leave cells empty'
* <code>-MAX_EDGE_LENGTH {value}</code> to specify a maximum triangle edge length for interpolation (to be used with -EMPTY_FILL INTERP - default value is 1.0) (since version 2.12)
* <code>-CUSTOM_HEIGHT {value}</code> to define the custom height filling value (if the '-EMPTY_FILL CUSTOM_H' strategy is used - see above - if not set, the EMPTY_FILL option will fall back to 'leave cells empty')
* <code>-KRIGING_KNN {number of neighbors}</code> to define the number of neighbors used for Kriging (if the '-EMPTY_FILL KRIGING' strategy is used - see above - default is 8) (since version 2.13)
* <code>-OUTPUT_CLOUD</code> to output the result as a cloud (this is the default option if no other output format is defined)
* <code>-OUTPUT_MESH</code> to output the result as a mesh
* <code>-OUTPUT_RASTER_Z</code> to output the result as a geotiff raster (only altitudes, no RGB)
* <code>-OUTPUT_RASTER_Z_AND_SF</code> to output the result as a geotiff raster (altitudes + all SFs by default, no RGB)
* <code>-OUTPUT_RASTER_RGB</code> to output the result as a geotiff raster (RGB)
* <code>-RESAMPLE</code> to resample the input cloud (only in combination with OUTPUT_CLOUD and/or OUTPUT_MESH)
Notes:
* if OUTPUT_CLOUD or OUTPUT_MESH is selected, the resulting entity will replace the original cloud in memory
|-
|style="border-style: solid; border-width: 1px"| <code>-VOLUME -GRID_STEP {grid step}</code>
|style="border-style: solid; border-width: 1px"| ''[[2.5D_Volume | 2.5D estimation of the volume]] between two point clouds (the first is the ceiling, the second is the ground by default).''

This tool outputs two files:
* the volume calculation report (named VolumeCalculationReport.txt and saved next to the first file)
* the 2.5D grid points with the 'height difference' as a scalar field and also as RGB colors (colors are generated with the default color scale of CC). The file is saved next to the previous one, and it has the same base name as the first file with '_HEIGHT_DIFFERENCE' appended at the end.

Optional settings are:
* <code>-VERT_DIR {0/1/2}</code> to specify the projection dimension (0=X / 1=Y / 2=Z) - default is 2 (Z)
* <code>-CONST_HEIGHT {value}</code> to use a constant height instead of the second cloud
* <code>-GROUND_IS_FIRST</code> to invert the clouds order
* <code>-OUTPUT_MESH</code> to output a mesh instead of a cloud

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* see below for more details
|-
|style="border-style: solid; border-width: 1px"| <code>-STAT_TEST {distrib} {distrib parameters} {p-value} {neighbors count}</code>
|style="border-style: solid; border-width: 1px"| ''applies a [[Local_Statistical_Test | local statistical test]] based on their active scalar field to all the of loaded/generated clouds.''
{distrib} can be GAUSS or WEIBULL. Expected distribution parameters are:
* GAUSS: the mean value and sigma
* WEIBULL: a, b and the shift value

Note: result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-COORD_TO_SF {dimension: X, Y or Z}</code>
|style="border-style: solid; border-width: 1px"| ''[[Scalar_fields%5CExport_coordinate(s)_to_SF(s) | exports the specified coordinate]] (dimension) to a scalar field.''

Note: creates a new scalar field (or overwrite any existing one with the same name) and sets it active.
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_TO_COORD {sf index or name} {dimension: X, Y or Z}</code>
|style="border-style: solid; border-width: 1px"| ''[[Scalar_fields%5CSet_SF_as_coordinate(s) | set the specified scalar field values as coordinate]] (dimension) of the loaded clouds.''

Notes:
* it is possible to use '-1' as index to designate the default/current scalar field
* since version 2.13.
|-
|style="border-style: solid; border-width: 1px"| <code>-COLOR_INTERP</code>
|style="border-style: solid; border-width: 1px"| ''[[Colors\Interpolate from another entity | Interpolates the colors]] from one cloud to the other cloud.''

Note: since version 2.13.
|-
|style="border-style: solid; border-width: 1px"| <code>-FILTER_SF {minVal} {maxVal}</code>
|style="border-style: solid; border-width: 1px"| ''[[Scalar_fields%5CFilter_by_Value | filters]] all the loaded/generated clouds (or meshes, since version 2.13) based on their active scalar field values.''

A new cloud (or new mesh) is created each time with only the points falling in the [minVal maxVal] interval.

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this).
* input clouds are now replaced by their filtered version (since version 2.6.1) and likewise for meshes (since version 2.13)

You can use special words in place of numbers that CC will replace by the actual SF values:
* 'MIN' = min value
* 'DISP_MIN' = min displayed value
* 'SAT_MIN' = min saturation value
* 'MAX' = max value
* 'DISP_MAX' = max displayed value
* 'SAT_MAX' = max saturation value
* 'N_SIGMA_MIN {N}' = mean - N * standard deviation
* 'N_SIGMA_MAX {N}' = mean + N * standard deviation

|-
|style="border-style: solid; border-width: 1px"| <code>-DENSITY {sphere radius}</code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Density | density]] (inside a sphere around each point) on the currently opened/generated cloud(s).''

Optional setting:
* -TYPE {density_type}: to specify the type of density to compute. {density_type} can be KNN (nearest neighbors count), SURFACE (surface density) or VOLUME (volume density).

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-APPROX_DENSITY</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Density | approximate density]] on the currently opened/generated cloud(s).''

Optional setting:
* -TYPE {density_type}: to specify the type of density to compute. {density_type} can be KNN (nearest neighbors count), SURFACE (surface density) or VOLUME (volume density).

Notes:
* a new scalar field is created on each cloud.
* result is automatically saved.
|-
|style="border-style: solid; border-width: 1px"| <code>-ROUGH {kernel size} {-UP_DIR {x} {y} {z}} </code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Roughness | roughness]] with a given kernel size on the currently opened/generated cloud(s).''

Since version 2.13, optional parameter <code>-UP_DIR {x} {y} {z}</code> allows to specify a 'up direction' to sign roughness values.

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-CURV {type} {kernel size}</code>
|style="border-style: solid; border-width: 1px"| ''computes [[Curvature | local curvature]] with a given kernel size on the currently opened/generated cloud(s).''
{type} can be MEAN, GAUSS or NORMAL_CHANGE (this last option stands for 'Normal change rate' and is only available in version 2.10 or later).

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_GRAD {euclidian}</code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Scalar_fields%5CGradient | gradient]] of the active scalar field (or the first one if none is active) on the currently opened/generated cloud(s).''
The {euclidian} option specifies whether the scalar field is 'euclidian' (TRUE) - typically like a distance field - or not (FALSE).

Notes:
* a new scalar field is created on each cloud
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-BEST_FIT_PLANE</code>
|style="border-style: solid; border-width: 1px"| ''computes the [[Fit_Plane | best fitting plane]] on all loaded clouds.''

Optional settings are:
* -MAKE_HORIZ: will actually transform the loaded cloud(s) so as to make them 'horizontal'
* -KEEP_LOADED: to keep the resulting plane(s) in memory as mesh(es)

Notes:
* resulting planes are automatically saved
* if MAKE_HORIZ is defined, result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-APPLY_TRANS {-APPLY_TO_GLOBAL {FORCE}} {-INVERSE} {filename}</code>
|style="border-style: solid; border-width: 1px"| ''applies a 4x4 transformation matrix to the loaded entities (clouds or meshes). The matrix is read from a simple text file with the matrix rows on each line (4 values per lines, 4 lines).''

Sub-options are:
* -INVERSE: to invert the transformation before applying it (since version 2.13)
* -APPLY_TO_GLOBAL {FORCE}: to apply the transformation to the global coordinates instead of the local coordinates (since version 2.13)
** warning: the Global Shift might be automatically adjusted to preserve accuracy (and small local coordinates)
** by default, the Global Shift won't be automatically adjusted if the local coordinates are already large.
** Use 'FORCE' after -APPLY_TO_GLOBAL to force CC to adjust the Global Shift in any case.

Notes:
* each entity will be replaced in memory by its transformed version
* resulting entities are automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-MATCH_CENTERS</code>
|style="border-style: solid; border-width: 1px"| ''makes all the (bounding-box) centers of the loaded entities match. All the entities will move relatively to the first one (clouds are always considered first if clouds and meshes are loaded).''

Note: result is automatically saved by default (see the AUTO_SAVE command to change this).
|-
|style="border-style: solid; border-width: 1px"| <code>-DELAUNAY</code>
|style="border-style: solid; border-width: 1px"| ''[[Mesh%5CDelaunay_2.5D_(XY_plane) | Triangulates]] the loaded clouds with 2.5D Delaunay triangulation. The triangulation is done in the (XY) plane by default.''

Optional settings are:
* -AA: to triangulate the points in the (XY) plane (default behavior).
* -BEST_FIT: to [[Mesh%5CDelaunay_2.5D_(best_fit_plane) | triangulate the points in their best fit plane]]
* -MAX_EDGE_LENGTH {length}: to remove the triangles with edges longer than a given threshold

Notes:
* the resulting 'mesh' entity is automatically saved (see the AUTO_SAVE command to change this).
* the clouds are automatically removed (from the 'loaded clouds' set).
|-
|style="border-style: solid; border-width: 1px"| <code>-FLIP_TRI</code>
|style="border-style: solid; border-width: 1px"| ''Flips the order of the triangle vertices of all opened meshes (since version 2.13).''

Notes:
* the updated mesh entities are automatically saved (see the AUTO_SAVE command to change this).
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-ICP</code>
|style="border-style: solid; border-width: 1px"| ''[[ICP | Iterative Closest Point]] registration procedure.''

Optional settings are:
* -REFERENCE_IS_FIRST: by default the ICP registration process will take the first loaded entity as 'data' and the second as 'model' (clouds are always considered first). If you use this option their respective role will be inverted.
* -MIN_ERROR_DIFF: to specify the min. error difference between two steps (default = 1e-6)
* -ITER: to specify the number of iterations (in which case the 'MIN_ERROR_DIFF' option will be ignored)
* -OVERLAP: to specify the percentage of (final) overlap (integer number between 10 and 100 - default = 100)
* -ADJUST_SCALE: to enable the ICP registration with adaptive scale
* -RANDOM_SAMPLING_LIMIT: to specify the number of points randomly sampled at each iteration (default = 20 000)
* -FARTHEST_REMOVAL: to enable the ''research'' option that ignores points with the highest distances at each iteration
* -DATA_SF_AS_WEIGHTS + {SF index or name}: to use a given scalar field as weights on the 'data' entity (index starts from 0 - the 'LAST' keyword can be used)
* -MODEL_SF_AS_WEIGHTS + {SF index or name}: to use a given scalar field as weights on the 'model' entity (index starts from 0 - the 'LAST' keyword can be used)
* -ROT + {'XYZ' or 'X' or 'Y' or 'Z' or 'NONE'}: to constrain the rotation around a given axis (or no rotation at all) (since version 2.11)
* -SKIP_TX, -SKIP_TY and/or -SKIP_TZ to prevent the entities from moving along X, Y and/or Z (since version 2.13)

Notes:
* the 'data' entity in its final position is automatically saved (see the AUTO_SAVE command to change this).
* the corresponding transformation matrix is automatically saved in a separate text file (always).
* the name of the weight scalar fields can be used only since version 2.13 (only the SF index was accepted in previous versions)
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field (to be used with DATA_SF_AS_WEIGHTS or MODEL_SF_AS_WEIGHTS)
|-
|style="border-style: solid; border-width: 1px"| <code>-CROP {Xmin:Ymin:Zmin:Xmax:Ymax:Zmax}</code>
|style="border-style: solid; border-width: 1px"| ''[[Crop | Crops]] all loaded clouds inside or outside a given box.''

Optional settings are:
* -OUTSIDE: if defined only the points falling outside the input box will be kept (instead of inside by default).

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* each cloud will be replaced in memory by its cropped version (since version 2.11, the cloud is removed from memory if it's totally cropped out)
|-
|style="border-style: solid; border-width: 1px"| <code>-CROP2D {ortho_dim} {-GLOBAL_SHIFT + options} {n:number of vertices} X1 Y1 X2 Y2 ... Xn Yn {-OUTSIDE}</code>
|style="border-style: solid; border-width: 1px"| ''Crops all loaded clouds inside or outisde a given 2D polyline. Cropping is done in a plane defined by its orthogonal dimension: X, Y or Z (i.e. coordinates along this dimension will be ignored).''

Since version 2.14, it is possible to set a Global Shift when importing the 2D vertices. It uses the same syntax as the -O option (see the -O -GLOBAL_SHIFT option).

Warning, after setting the dimension, CloudCompare will expect the 2D vertices in the following order:
* ortho_dim = X --> YZ
* ortho_dim = Y --> ZX
* ortho_dim = Z --> XY

Since version 2.14:
* ortho_dim = Xflip --> ZY
* ortho_dim = Yflip --> XZ
* ortho_dim = Zflip --> YX

Optional settings are:
* -OUTSIDE: if defined (after the coordinates of the vertices) only the points falling outside the input polyline will be kept (instead of inside by default)

Note:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* each cloud will be replaced in memory by its cropped version

|-
|style="border-style: solid; border-width: 1px"| <code>-CROSS_SECTION {XML parameters file}</code>
|style="border-style: solid; border-width: 1px"| ''[[Cross_Section | Extracts one or multiple sections]] from the clouds or meshes.''

Either the loaded clouds and/or meshes (see the -O option) can be used otherwise CC can load one or several files from a specified folder (use the 'FilePath' key).

See [http://www.cloudcompare.org/doc/cross_section_params.xml] for an example of XML parameter file.

Note:
* output sections for meshes are 'clean' (i.e. triangles on the cutting borders are re-meshed)
* output sections are automatically saved in sub-folders (they are not kept in memory)

|-
|style="border-style: solid; border-width: 1px"| <code>-SOR {number of neighbors} {sigma multiplier}</code>
|style="border-style: solid; border-width: 1px"| ''applies the [[SOR_filter | SOR (Statistical Outlier Removal) filter]] to the loaded cloud(s).''
For each cloud, a new one will be generated (and will replace the origin cloud).

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-NOISE KNN/RADIUS {value 1} REL/ABS {value 2} {RIP}</code>
|style="border-style: solid; border-width: 1px"| ''applies the [[Noise_filter | Noise filter]] to the loaded cloud(s).''
For each cloud, a new one will be generated (and will replace the origin cloud).

Value 1: the caller has to choose between KNN (number of neighbors) or RADIUS (spherical neighborhood)
Value 2: the caller has to choose between REL (multiplier of the local error standard deviation) or ABS (absolute error)
RIP: Remove Isolated Points (optional)

Example: '-NOISE RADIUS 0.5 REL 1.0 RIP'

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RDP {min distance between points}</code>
|style="border-style: solid; border-width: 1px"| ''applies the [[Remove_duplicate_points | Remove duplicate points]] tool to the loaded cloud(s).''
For each cloud, a new one will be generated (and will replace the origin cloud).

The minimum distance between points (to not consider them as duplicate) can be set. Otherwise a very small value is used by default.

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-DEBUG</code>
|style="border-style: solid; border-width: 1px"| ''display various pieces of information to help one debug and tweak the command line.''

Note:
* can be placed at different positions
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RENAME_ENTITIES {base name}</code>
|style="border-style: solid; border-width: 1px"| ''rename all loaded entities (clouds or meshes) with the provided base name.''
A numerical suffix is automatically added if multiple entities are loaded.

Note:
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_ARITHMETIC {SF index or name} {operation} {option}</code>
|style="border-style: solid; border-width: 1px"| ''applies [[Scalar_fields%5CArithmetic | operations]] to a given scalar field of the loaded cloud/mesh.''

SF2 = operation(SF)

The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Supported operations are:
* sqrt (square root)
* pow2
* pow3
* exp
* log
* log10
* cos
* sin
* tan
* acos
* asin
* atan
* int (integer part)
* inverse
* abs (since version 2.13)

Optional settings are:
* <code>-IN_PLACE</code> to apply the operation in place, without creating a new SF (since version 2.13)

Notes:
* the updated cloud/mesh is automatically saved (see the AUTO_SAVE command to change this)
* a new scalar field is created
* the SF name can only be used since version 2.13
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_OP {SF index or name} {operation} {value} </code>
|style="border-style: solid; border-width: 1px"| ''applies an [[Scalar_fields%5CArithmetic | arithmetic operation]] to a given scalar field of the loaded cloud/mesh and with a given scalar value.''

SF = SF (+,-,*,/) VALUE
or
SF = 'SET' VALUE (since version 2.13)

The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Supported operations are:
* add
* sub
* mult
* div
* set (since v2.13)

Notes:
* the updated cloud/mesh is automatically saved (see the AUTO_SAVE command to change this)
* the modification is done in place (i.e. the scalar field is directly modified)
* the SF name can be used since version 2.13 only
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_OP_SF {SF1 index or name} {operation} {SF2 index or name} </code>
|style="border-style: solid; border-width: 1px"| ''applies an [[Scalar_fields%5CArithmetic | arithmetic operation]] to two scalar fields of the loaded cloud/mesh.''

SF = SF1 (+,-,*,/) SF2

The scalar-field indexes start from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Supported operations are:
* add
* sub
* mult
* div
* min
* max

Notes:
* the updated cloud/mesh is automatically saved (see the AUTO_SAVE command to change this)
* the modification is done in place (i.e. the scalar field is directly modified)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_INTERP {SF index} {-DEST-IS_FIRST} </code>
|style="border-style: solid; border-width: 1px"| ''applies the [[Scalar_fields%5CInterpolate_from_another_entity | SF Interpolate from another entity]] algorithm to a given scalar field of the 2 first loaded clouds''

By default the first cloud will be considered as the source cloud (with the designated scalar field) and the second cloud is the destination cloud. Use the sub-option -DEST-IS_FIRST to invert their roles.
The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Warning: for now the command line will always use the same options:
* interpolation method: nearest neighbors
* interpolation algorithm: normal distribution
* radius = 1% of the destination cloud bounding-box
* sigma = 40% of the radius

Notes
* the updated cloud is not automatically saved! (use the SAVE_CLOUDS command to do it)
* it is possible to use '-1' as index to designate the default/current scalar field
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_ADD_CONST {SF name} {value} </code>
|style="border-style: solid; border-width: 1px"| ''adds a constant scalar field (with the specified value for all scalar values) to the loaded clouds''

Notes
* updated clouds are automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RENAME_SF {SF index or name} {new name}</code>
|style="border-style: solid; border-width: 1px"| ''renames a given scalar field of the loaded clouds/meshes.''

The scalar-field index starts from 0. The user can use the keyword 'LAST' to designate the last scalar field.

Notes:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* the SF name can only be used since version 2.13
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-CBANDING {dim} {freq}</code>
|style="border-style: solid; border-width: 1px"| ''Applies [[Colors%5CHeight_Ramp | color banding]] to all loaded entities (clouds and meshes). The user must specify the dimension (dim = X, Y or Z) and the frequency (in Hz, as an integer).''

Note:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEVELS {bands} {input range min} {input range max} {output range min} {output range max}</code>
|style="border-style: solid; border-width: 1px"| ''Applies [[Colors%5CLevels | color levels]] to all loaded entities (clouds and meshes).

The caller must specify:
* the color bands (can be any mix of 'R', 'G' and 'B' - ex: 'G' or 'RB' or 'RGB')
* the input range (typically where most of the color information lies, ex: 40 210)
* the output range (typically: 0 255)

Note:
* result is automatically saved by default (see the AUTO_SAVE command to change this)
* since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-SF_COLOR_SCALE {filename}</code>
|style="border-style: solid; border-width: 1px"| ''Loads a color scale from a XML file (generated with the [[Scalar_fields%5CColor_Scales_Manager | Color Scales Manager]]). The loaded color scale is then applied to the active scalar field of all loaded clouds (and all loaded meshes since version 2.13).''

Note:
* it may be necessary to explicitly set the active scalar field with the SET_ACTIVE_SF command
* since version 2.10 only

|-
|style="border-style: solid; border-width: 1px"| <code>-SF_CONVERT_TO_RGB {TRUE/FALSE}</code>
|style="border-style: solid; border-width: 1px"| ''Converts the active scalar field to RGB colors. The user must explicitly specify whether the previously existing colors (if any) should be mixed with the new ones (TRUE) or overwritten (FALSE).''

Note:
* it may be necessary to explicitly set the active scalar field with the SET_ACTIVE_SF command
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RGB_CONVERT_TO_SF</code>
|style="border-style: solid; border-width: 1px"| ''Converts the RGB colors to 5 scalar fields in the following order: Red, Green, Blue, Alpha and Composite.''

Note:
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-M3C2 {parameters_file}</code>
|style="border-style: solid; border-width: 1px"| ''Calls the [[M3C2_(plugin) | M3C2]] plugin (if available) on the two first loaded clouds. If a 3rd cloud is loaded, it will be used a core points. The first time, the parameters file can be created with the GUI tool (use the 'Save parameters to file' button in the bottom-left corner of the M3C2 dialog = the floppy icon). It can then be edited easily.''

Note:
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-CSF {filename}</code>
|style="border-style: solid; border-width: 1px"| ''Runs the [[ CSF_(plugin) | Cloth Simulation Filter (CSF) plugin]]''

Options are:
* '-SCENES [scene]' name of the scene options are:
** 'SLOPE'
** 'RELIEF'
** 'FLAT'
* '-PROC_SLOPE' (turns on slope post processing for disconnected terrain)
* '-CLOTH_RESOLUTION [value]' (double value of cloth resolution [ex. 0.5])
* '-MAX_ITERATION [value]' (integer value of max iterations [ex. 500])
* '-CLASS_THRESHOLD [value]' (double value of classification threshold [ex. 0.5])
* '-EXPORT_GROUND' (exports the ground as a .bin file)
* '-EXPORT_OFFGROUND' (exports the off-ground as a .bin file)

Note:
* since version 2.12 only
|-
|style="border-style: solid; border-width: 1px"| <code>-CANUPO_CLASSIFY {classifier.prm}</code>
|style="border-style: solid; border-width: 1px"| ''Calls a [[CANUPO_(plugin) | CANUPO]] classifier (if the plugin is available) on the loaded clouds. You'll need a trained classifier (.prm file)''

Optional settings are:
* USE_CONFIDENCE {threshold}
** threshold must be between 0 and 1
** use the 'SET_ACTIVE_SF' after loading a cloud to set the active scalar field if you want it to be used to refine the classification

Note:
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-PCV</code>
|style="border-style: solid; border-width: 1px"| ''Runs the [[ ShadeVis (plugin) | PCV plugin]] (also known as ambient occlusion or ShadeVis)''

Optional settings are:
* -N_RAYS [value]: number of rays
* -IS_CLOSED: Tells PCV that the mesh is watertight. This accelerates processing.
* -180: Rays only come from the "northern hemisphere" (northern means +Z)
* -RESOLUTION: OpenGL context resolution

Note:
* since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-RANSAC</code>
|style="border-style: solid; border-width: 1px"| ''Runs the [[ RANSAC_Shape_Detection_(plugin) | Ransac Shape Detection plugin]]''

Options are:
* 'EPSILON_ABSOLUTE' (Max distance to primitive)
* 'EPSILON_PERCENTAGE_OF_SCALE' (Max distance to primitive as a percentage of cloud scale 0.0-1.0 exclusive)
* 'BITMAP_EPSILON_PERCENTAGE_OF_SCALE' (Sampling resolution as a percentage of cloud scale 0.0-1.0 exclusive)
* 'BITMAP_EPSILON_ABSOLUTE' (Sampling resolution)
* 'SUPPORT_POINTS' (Min Support points per primitive)
* 'MAX_NORMAL_DEV' (Max normal deviation from the ideal shape normal vector [in Degrees])
* 'PROBABILITY' (Probability that no better candidate was overlooked during sampling, lower the better!)
* 'OUT_CLOUD_DIR' (path to save detected shapes clouds to, current dir if unspecified)
* 'OUT_MESH_DIR' (path to save detected shapes meshes to, current dir if unspecified)
* 'OUT_PAIR_DIR' (path to save detected shapes clouds & meshes to, current dir if unspecified)
* 'OUT_GROUP_DIR' (path to save all shapes and primitives to as a single file, current dir if unspecified)
* 'OUTPUT_INDIVIDUAL_SUBCLOUDS' (specify to output detected shapes clouds)
* 'OUTPUT_INDIVIDUAL_PRIMITIVES' (specify to output detected shapes meshes)
* 'OUTPUT_INDIVIDUAL_PAIRED_CLOUD_PRIMITIVE' (specify to output detected shapes clouds & meshes)
* 'OUTPUT_GROUPED' (specify to output all detected shapes clouds & meshes as single file)
* 'ENABLE_PRIMITIVE' (each shape listed after this option will be searched for )
** 'PLANE'
** 'SPHERE'
**'CYLINDER'
**'CONE'
**'TORUS'

Notes:
* since version 2.11 only
|-
|style="border-style: solid; border-width: 1px"| <code>-C_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for clouds. Format can be one of the following: ASC, BIN, PLY, LAS, E57, VTK, PCD, SOI, PN, PV.''

Optional settings are:
* -PREC [precision]: to specify the numerical output precision (for ASCII files only). ''precision'' is a positive integer (default = 12).
* -SEP [separator]: to specify the separator character (for ASCII files only). ''separator'' can be one of the following string: SPACE, SEMICOLON, COMMA or TAB (default = SPACE).
* -ADD_HEADER: to add a header with each column's name to the saved file (for ASCII files only).
* -ADD_PTS_COUNT: to add the number of points at the beginning of the saved file (for ASCII files only).
* -EXT [extension]: to specify the file extension (typically different from the default one for the chosen format)
* -NO_LABEL: to prevent creating/loading 2D labels from ASCII files in case text columns are present in the file (since version 2.13.2)

'''WARNING: the ADD_HEADER and ADD_PTS_COUNT options are broken in the 2.6.2 version. Use a newer version instead.'''
|-
|style="border-style: solid; border-width: 1px"| <code>-M_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for meshes. Format can be one of the following: BIN, OBJ, PLY, STL, VTK, MA, FBX.''

Optional settings are:
* -EXT [extension]: to specify the file extension (typically different from the default one for the chosen format)
|-
|style="border-style: solid; border-width: 1px"| <code>-H_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for groups (hierarchy objects). Mostly the BIN format, but other formats that support a collection of objects might be elligible.''

Note:
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-FBX -EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for FBX meshes. Must be specified in addition to M_EXPORT_FMT if FBX format is chosen. Format can be one of the following: FBX_binary, FBX_ascii, FBX_encrypted, FBX_6.0_binary, FBX_6.0_ascii, FBX_6.0_encrypted.''

Notes:
* if the input format is not supported by the current implementation, a list of available formats will be output in the console.
* the option was "-FBX_EXPORT_FMT" in version 2.10 and earlier
|-
|style="border-style: solid; border-width: 1px"| <code>-PLY_EXPORT_FMT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Specifies the default output format for PLY files. Format can be one of the following: ASCII, BINARY_BE (big endian) or BINARY_LE (little endian).''

Note: default output format is binary (LE/BE depending on the current OS)
|-
|style="border-style: solid; border-width: 1px"| <code>-NO_TIMESTAMP</code>
|style="border-style: solid; border-width: 1px"| ''to prevent CC from generating an automatic suffix (timestamp) for output file name (warning: this make the name of an output file predictable but if the file already exists it will be overwritten).''
|-
|style="border-style: solid; border-width: 1px"| <code>-BUNDLER_IMPORT {filename}</code>
|style="border-style: solid; border-width: 1px"| ''imports a Snavely's Bundler file.''

Bundler import through the command line is mainly meant to generate ortho-rectified versions of input images directly on disk.
Optional settings are:
* -ALT_KEYPOINTS [filename]: load alternative keypoints from file ''filename''
* -SCALE_FACTOR [value]: sets image scale factor that has been used during keypoints generation
* -COLOR_DTM [vertices count]: generates colored vertices of a pseudo-DTM with approximately 'vertices count' elements (in command line mode, vertices are automatically saved to 'colored_dtm_vertices.bin' next to ortho-rectified images)
* -UNDISTORT: enables images undistortion

Note: see below for more details.
|-
|style="border-style: solid; border-width: 1px"| <code>-SET_GLOBAL_SHIFT {x} {y} {z} {-KEEP_ORIG_FIXED}</code>
|style="border-style: solid; border-width: 1px"| ''Overrides the Global Shift information for all loaded entities.''

Use the sub-option -KEEP_ORIG_FIXED to maintain the global coordinates unchanged. This will in effect translate the points in the local coordinate system (a warning may be issued if the resulting coordinates are too big).

Note: since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-DROP_GLOBAL_SHIFT</code>
|style="border-style: solid; border-width: 1px"| ''Removes the Global Shift information from all loaded entities.''

Note:
* equivalent to using '-SET_GLOBAL_SHIFT 0 0 0'
|-
|style="border-style: solid; border-width: 1px"| <code>-SET_ACTIVE_SF {SF index or 'SF name'}</code>
|style="border-style: solid; border-width: 1px"| ''Sets the active scalar field index or name (same for all loaded clouds).''

Notes:
* scalar field indexes start at 0 ('-1' means 'no SF enabled')
* the SF name must be surrounded by simple quotes (e.g. 'Point Source Id')
* designing the SF by its name is only possible since version 2.13
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_ALL_SFS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all scalar fields (from all loaded clouds or meshes).

Note:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_SF {index}</code>
|style="border-style: solid; border-width: 1px"| ''Removes the scalar field at the specified index (from all loaded clouds or meshes).

Notes:
* if no SF is found at this index, a simple warning will be issued (no error will be triggered).
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* since version 2.12
* since version 2.13, it is possible to use '-1' as index to designate the default/current scalar field
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_RGB</code>
|style="border-style: solid; border-width: 1px"| ''Removes colors (from all loaded clouds or meshes).

Notes:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_NORMALS</code>
|style="border-style: solid; border-width: 1px"| ''Removes normals (from all loaded clouds or meshes, per vertex or per faces).

Notes:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* since version 2.11
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_SCAN_GRIDS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all scan grids (from all loaded clouds or meshes).

Note:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* available since version 2.10 only
|-
|style="border-style: solid; border-width: 1px"| <code>-REMOVE_SENSORS</code>
|style="border-style: solid; border-width: 1px"| ''Removes all sensors (both TLS and cameras, directly under clouds, meshes or mesh vertices).

Note:
* entities are not automatically saved after this command (you can use -SAVE_CLOUDS or -SAVE_MESHES explicitly)
* available since version 2.13 only
|-
|style="border-style: solid; border-width: 1px"| <code>-COMPRESS_FWF</code>
|style="border-style: solid; border-width: 1px"| ''compresses FWF data associated to all clouds in memory (waveform support)''
|-
|style="border-style: solid; border-width: 1px"| <code>-AUTO_SAVE {''ON/OFF''}</code>
|style="border-style: solid; border-width: 1px"| ''Enables (''ON'') or disables (''OFF'') automatic backup of clouds and meshes at each step (you'll have to manually call ''-SAVE_CLOUDS'' or ''-SAVE_MESHES'' at the right time/position in your command).''
|-
|style="border-style: solid; border-width: 1px"| <code>-PCD_OUTPUT_FORMAT {format}</code>
|style="border-style: solid; border-width: 1px"| ''Sets the default PCD file output format.''
Format can be:
* COMPRESSED_BINARY
* BINARY
* ASCII

Notes:
* since version 2.14 only
* when using the binary and ASCII formats, the output filename may be scrambled if non standard characters are present.
* this option must be placed before any PCD file is saved
|-
|style="border-style: solid; border-width: 1px"| <code>-SAVE_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''Saves all currently loaded clouds (note that this is not necessary by default as all modified or newly generated cloud are automatically saved).''
Optional settings are:
* ALL_AT_ONCE: saves all clouds in a single file (the current output format must support it!)
* FILE "file1.xxx file2.yyy ..." : to specify the output filename(s) of the clouds (use quotes if multiple names or names with space characters) [since version 2.10]
|-
|style="border-style: solid; border-width: 1px"| <code>-SAVE_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''Saves all currently loaded meshes (note that this is not necessary by default as all modified or newly generated meshes are automatically saved).''
Optional settings are:
* ALL_AT_ONCE: saves all meshes in a single file (the current output format must support it!)
* FILE "file1.xxx file2.yyy ..." : to specify the output filename(s) of the clouds (use quotes if multiple names or names with space characters) [since version 2.10]
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR</code>
|style="border-style: solid; border-width: 1px"| ''closes all currently loaded entities.''
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''closes all currently loaded clouds.''
|-
|style="border-style: solid; border-width: 1px"| <code>-CLEAR_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''closes all currently loaded meshes.''
|-
|style="border-style: solid; border-width: 1px"| <code>-POP_CLOUDS</code>
|style="border-style: solid; border-width: 1px"| ''removes the last loaded or generated cloud.''
|-
|style="border-style: solid; border-width: 1px"| <code>-POP_MESHES</code>
|style="border-style: solid; border-width: 1px"| ''removes the last loaded or generated mesh.''
|-
|style="border-style: solid; border-width: 1px"| <code>-LOG_FILE {filename}</code>
|style="border-style: solid; border-width: 1px"| ''logs all command output messages in a given file.''
|-
|style="border-style: solid; border-width: 1px"| <code>-FWF_O {filename}</code>
|style="border-style: solid; border-width: 1px"| ''opens a LAS 1.3/1.4 file (waveform support) [Windows version only]''

* Note: this is deprecated (or at least useless) with version 2.13 as the new LAS I/O plugin now natively handles FWF data on all platforms.
|-
|style="border-style: solid; border-width: 1px"| <code>-FWF_SAVE_CLOUDS {filename}</code>
|style="border-style: solid; border-width: 1px"| ''saves all clouds in memory a LAS 1.3/1.4 files (waveform support) [Windows version only]''

* Note: this is deprecated (or at least useless) with version 2.13 as the new LAS I/O plugin now natively handles FWF data on all platforms.
|-
|}

=Example 0=

:<code>CloudCompare -O -GLOBAL_SHIFT AUTO mylargecoordinatescloud.las -C_EXPORT_FMT LAS -SS SPATIAL 0.1</code>

This will open file ''mylargecoordinatescloud.las'' with an automatic Global Shift (to avoid issues with large coordinates), then set the export format to be LAS as well (otherwise the CloudCompare BIN format is used by default) and eventually it applies some spatial subsampling with a 0.1 step (= 0.1 meter, assuming the LAS file coordinates are in meters). The output file will be ''mylargecoordinatescloud_SPATIAL_SUBSAMPLED_YYYY-MM-DD_HHhMM.las''.

=Example 1=

:<code>CloudCompare -O ''myhugecloud.bin'' -SS SPATIAL 0.1</code>
This will open file ''myhugecloud.bin'' then apply spatial subsampling with a 0.1 step (e.g. in meters). The output file will be ''myhugecloud_SPATIAL_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin''.

=Example 2=
:<code>CloudCompare -O ''myhugecloud1.bin'' -SS SPATIAL 0.1 -O 'myhugecloud2.bin' -SS RANDOM 1000000 -CLEAR_ALL -O 'myhugecloud3.bin' -SS OCTREE 9</code>
This will open file ''myhugecloud1.bin'' then apply spatial subsampling with a 0.1 step (e.g. in meters). 
Then it will open file ''myhugecloud2.bin'' and apply to '''both files''' random subsampling (1 000 000 points each). 
Then it will close the two first files. 
Eventually it will open file ''myhugecloud3.bin'' and apply octree based subsampling (level 9).

The output files will be: ''myhugecloud1_SPATIAL_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin'', ''myhugecloud1_RANDOM_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin'', ''myhugecloud2_RANDOM_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin'' and ''myhugecloud3_OCTREE_level_9_SUBSAMPLED_YYYY-MM-DD_HHhMM.bin''

=Cloud-to-cloud distance=

:<code>CloudCompare -o cloud1.bin -o cloud2.asc -c2c_dist -split_xyz -model HF SPHERE 50.0</code>
CC will load ''cloud1.bin'' and ''cloud2.asc'', then compute the distance from cloud1 (''compared'') relatively to cloud2 (''reference'') with a height function (''quadric'') computed on all the neighbors falling in a sphere of radius 50.0 around each point of ''cloud1''. On output a file ''cloud1_C2C_DIST_YYYY-MM-DD_HHhMM.bin'' will be generated (with the resulting distances as first scalar field and the 3 components of the corresponding displacement vector along X, Y and Z as additional scalar fields).

Note: this cloud stays in memory and can be processed further (with -FILTER_SF for instance).

=Cloud-to-mesh distance=

:<code>CloudCompare -o cloud1.bin -o mesh.obj -c2m_dist</code>
CC will load ''cloud1.bin'' and ''mesh.obj'', then compute the distance from cloud1 (''compared'') relatively to mesh (''reference''). On output a file ''cloud1_C2M_DIST_YYYY-MM-DD_HHhMM.bin'' will be generated (with the resulting distances as scalar field).

Note: this cloud stays in memory and can be processed further (with -FILTER_SF for instance).

=Cycling over files in a folder (Windows)=
<blockquote>
set local EnableDelayedExpansion 
set Compared=C:\MY_FIRST_PATH 
set Reference=E:\MY_SECOND_PATH 
for %%f in ( "%Reference%"\* ) do ("C:\Program Files\CloudCompare\cloudcompare.exe" -SILENT -C_EXPORT_FMT LAS -O %Compared%\%%~nxf -O %Reference%\%%~nxf -c2c_dist -MAX_DIST 1 -FILTER_SF 1 1 -SOR 8 2) 
</blockquote>

=Bundler import=

:<code>CloudCompare -BUNDLER_IMPORT bundle.out -COLOR_DTM 1000000</code>
This will generate all ortho-rectified versions of the images declared in 'bundle.out', as well as the colored vertices of a pseudo-DTM constructed from the keypoints.

=(Mesh) format conversion=

:<code>CloudCompare -M_EXPORT_FMT FBX -FBX -EXPORT_FMT FBX_binary -O Foot.ply -NO_TIMESTAMP -SAVE_MESHES</code>
This will open the file named 'Foot.ply' then save it in FBX binary format (same base filename, without any decoration: i.e. ''Foot.fbx'')

Methods

2025-06-03T18:26:55Z

Daniel: /* Menus */

[[pl:Funkcje w menu]]

= Menus =

Here are described all the methods of CloudCompare in the order they appear in the menu.

''(version: 2.14.alpha)''

== File ==

* [[Open]] [[File:ccOpen_small.png]]
* Open Recent... (''open recent files'')
* [[Save]] [[File:ccSave_small.png]]
* [[Global Shift settings]]
* [[Primitive Factory | Primitive factory]] [[File:DbMiscGeomSymbol.png]]
* [[mouse3D | 3D mouse > Enable]] [[Image:3dconnexion_logo.jpg]]
* [[Gamepad | Gamepad > Enable]] [[Image:Gamepad.png|16px]]
* Close all (''close all loaded entities'')
* Quit (''should be pretty clear!'')

== Edit ==
* [[Clone]] [[Image:CcClone.png]]
* [[Merge]] [[Image:CcMerge.png]]
* [[Edit\Subsample | Subsample]] [[Image:CcSampleCloud.png]]
* [[Apply Transformation | Apply transformation]]
* [[Multiply/Scale]]
* [[Interactive Transformation Tool | Translate/Rotate]] [[Image:CCMoveIcon.png]]
* [[Interactive Segmentation Tool | Segment]] [[File:CCSegmentIcon.png]]
* [[Crop]]
* [[Edit global shift and scale]]
* [[Toggle (menu) | Toggle (recursive) submenu]]
* Delete (''delete the selected entities'')

=== Colors ===
* [[Colors\Set Unique | Set unique]] [[File:TypeRgbCcolor.png]]
* [[Colors\From Scalar fields | From Scalar fields]]
* [[Colors\Colorize | Colorize]]
* [[Colors\Levels | Levels]]
* [[Colors\Height Ramp | Height ramp]]
* [[Colors\Convert to grey scale | Convert to grey scale]]
* [[Colors\Convert to Scalar Field | Convert to scalar field]]
* [[Colors\Interpolate from another entity | Interpolate from another entity]]
* [[Colors\Enhance with intensities | Enhance with intensities]]
* [[Colors\Bilateral filter | Bilateral filter]]
* [[Colors\Gaussian filter | Gaussian filter]]
* [[Colors\Mean filter | Mean filter]]
* [[Colors\Median filter | Median filter]]
* Clear (''remove the color field of the selected entities'')

=== Normals ===
* [[Normals\Compute | Compute]] [[File:TypeNormal.png]]
* [[Normals\Invert | Invert]]
* [[Normals\Orient Normals With Minimum Spanning Tree | Orient normals > With Minimum Spanning Tree]]
* [[Normals\Orient Normals With Fast Marching | Orient normals > with Fast Marching]]
* [[Normals\Convert to HSV | Convert to > HSV colors]]
* [[Normals\Convert to Dip and Dip direction SFs | Convert to > Dip & Dip direction SFs]]
* [[Normals\Export normals to SF(s) | Export normals to SF(s)]]
* [[Normals\Set SF(s) as normal | Set SF(s) as normal]]
* Clear (''remove normals from the selected entities'')

=== Octree ===
* [[Octree\Compute | Compute]] [[File:OctreeSymbol.png]]
* [[Octree\Resample | Resample]]

=== Grid ===
* [[Grid\Delete | Delete scan grids]]
* [[Grid\Mesh | Mesh scan grids]]

=== Cloud ===
* [[Cloud\Create single point cloud | Create single point cloud]]
* [[Cloud\Paste from clipboard | Paste from clipboard]]

=== Mesh ===
* [[Mesh\Delaunay_2.5D_(XY_plane) | Delaunay 2.5D (XY plane)]]
* [[Mesh\Delaunay_2.5D_(best_fit_plane) | Delaunay 2.5D (best fit plane)]]
* [[Mesh\Surface between two polylines | Surface between two polylines]]
* [[Mesh\Mesh scan grids | Mesh scan grids]]
* [[Mesh\Convert texture/material to RGB | Convert texture/material to RGB]] [[File:TypeRgbCcolor.png]]
* [[Mesh\Sample points | Sample points]] [[File:CCSamplePointsIcon.png]]
* [[Mesh\Smooth (Laplacian) | Smooth (Laplacian)]]
* [[Mesh\Subdivide | Subdivide]]
* [[Mesh\Flip triangles | Flip triangles]]
* [[Mesh\Measure surface | Measure surface]]
* [[Mesh\Measure volume | Measure volume]]
* [[Mesh\Flag vertices | Flag vertices by type]]
==== Mesh \ Scalar field ====
* [[Mesh\Scalar field\Smooth | Smooth]]
* [[Mesh\Scalar field\Enhance | Enhance]]

=== Polyline ===
* [[Polyline\Sample points | Sample points]]

=== Plane ===
* [[Plane\Edit and Create | Create]]
* [[Fit Plane | Fit]]
* [[Plane\Edit and Create | Edit]]
* [[Plane\Flip | Flip]]
* [[Plane\Compare | Compare]]

=== Sensors ===
* [[Sensors\Edit| Edit]]
==== Sensors \ TLS/GBL [[Image:SensorSymbol.png]] ====
* [[Sensors\Ground Based Lidar\Create | Create]]
* [[Sensors\Ground Based Lidar\Show Depth Buffer | Creat/show Depth Buffer]]
* [[Sensors\Ground Based Lidar\Export Depth Buffer | Export Depth Buffer]]
* [[Sensors\Ground Based Lidar\Compute Points Visibility With Depth Buffer | Compute points visibility (with depth buffer)]]

==== Sensors \ Camera Sensor [[Image:DbCamSensorSymbol.png]] ====
* [[Sensors\Camera Sensor\Create | Create]]
* [[Sensors\Camera Sensor\Project uncertainty | Project uncertainty]]
* [[Sensors\Camera Sensor\Compute points visibility (with octree) | Compute points visibility (with octree)]]
==== Sensors \ Other ====
* [[Sensors\View from sensor | View from sensor]] [[Image:DbViewportSymbol.png]]
* [[Sensors\Compute ranges | Compute Ranges]]
* [[Sensors\Compute scattering angles | Compute Scattering Angles]]

=== Scalar fields ===
* [[Scalar fields\Show histogram | Show histogram]] [[Image:CcHistogram.png]]
* [[Scalar fields\Compute statistical parameters | Compute stat. params]] [[Image:CcComputeStat.png]]
* [[Scalar fields\Gradient | Gradient]] [[Image:CcGradient.png]]
* [[Scalar fields\Gaussian filter | Gaussian filter]] [[Image:CcGaussianFilter.png]]
* [[Scalar fields\Bilateral filter | Bilateral filter]] [[Image:CcBilateralFilter.png]]
* [[Scalar fields\Filter by Value | Filter by Value]] [[Image:CcFilterByValue.png]]
* [[Scalar fields\Convert to RGB | Convert to RGB]] [[Image:TypeRgbCcolor.png]]
* [[Scalar fields\Convert to random RGB | Convert to random RGB]]
* [[Scalar fields\Rename | Rename]]
* [[Scalar fields\Add constant SF | Add constant SF]] [[Image:CcAddConstSF.png]]
* [[Scalar fields\Add classification SF | Add classification SF]] [[Image:CcAddConstSF.png]]
* [[Scalar fields\Add point indexes as SF | Add point indexes as SF]]
* [[Scalar fields\Export coordinate(s) to SF(s) | Export coordinate(s) to SF(s)]]
* [[Scalar fields\Set SF as coordinate(s) | Set SF as coordinate(s)]]
* [[Normals\Export normals to SF(s) | Export normals to SF(s)]]
* [[Normals\Set SF(s) as normal | Set SF(s) as normal]]
* [[Scalar fields\Interpolate from another entity | Interpolate from another entity]]
* [[Scalar fields\Split cloud (integer values) | Split cloud (integer values)]]
* [[Scalar fields\Arithmetic | Arithmetic]] [[Image:CcSfArithmetic.png]]
* [[Scalar fields\Color Scales Manager | Color Scales Manager]] [[Image:TypeSF.png]]
* Delete [[Image:CcDeleteSF.png]] (deletes the active scalar field of the selected entities)
* Delete all (!) (deletes all scalar fields of the selected entities)

=== Waveform ===
* [[Waveform\2D Waveform viewer | 2D Waveform viewer]]
* [[Waveform\Compress FWF data | Compress FWF data]]

== Tools ==

* [[Level]] [[Image:CcLevel small.png]]
* [[Point Picking]] [[Image:CcPointPicking_small.png]]
* [[Point list picking]] [[Image:CcPointListPicking_small.png]]
* [[Trace polyline]] [[Image:CcTracePolyline.png]]

=== Clean ===
* [[SOR filter]]
* [[Noise filter]]

=== Projection ===
* [[Unroll]]
* [[Rasterize | Rasterize (and contour plot)]] [[Image:CcGrid_small.png]]
* [[Contour plot to mesh | Contour plot (polylines) to mesh]]
* [[Scalar fields\Export coordinate(s) to SF(s) | Export coordinate(s) to SF(s)]]
* [[Mesh\Surface between two polylines | Create surface between two polylines]]

=== Registration ===
* [[Match bounding box centers | Match bounding-box centers]]
* [[Match scales]]
* [[Align | Align (point pairs picking)]] [[File:Cc_pointPairAlignIcon.png‎]]
* [[ICP | Fine registration (ICP)]] [[File:CCRegisterIcon.png‎]]
* [[Registration\Move bounding-box ... to origin | Move bounding-box center to origin]]
* [[Registration\Move bounding-box ... to origin | Move bounding-box min corner to origin]]
* [[Registration\Move bounding-box ... to origin | Move bounding-box max corner to origin]]

=== Distances ===
* [[Cloud-to-Cloud_Distance | Cloud/Cloud Dist.]] [[File:CloudCloudDistanceIcon.png‎]]
* [[Cloud-to-Mesh Distance | Cloud/Mesh Dist]] [[File:CloudMeshDistanceIcon.png]]
* [[Cloud-to-Primitive Distance | Cloud/Primitive Dist]]
* [[Closest Point Set]]

=== Volume ===
* [[2.5D Volume | Compute 2.5D volume]]

=== Statistics ===
* [[Local Statistical Test]] [[Image:CcStatTest.png]]
* [[Compute Stat Params | Compute stat. params (active SF)]] [[File:CcComputeStat.png]]

=== Segmentation ===
* [[Label Connected Components | Label Connected Comp.]] [[Image:CcCCExtract.png]]
* [[Cross Section]] [[Image:CcClippingBox_small.png]]
* [[Extract Sections]] / Unfold [[Image:DbPolylineSymbol.png]]

=== Fit ===
* [[Fit Plane | Plane ]]
* [[Fit Sphere | Sphere ]]
* [[Fit 2D Polygon | 2D Polygon (facet) ]]
* [[Fit Quadric | 2.5D Quadric ]]

=== Batch export ===
* [[Export cloud info]]
* [[Export plane info]]

=== Other ===
* [[Compute geometric features]] (v2.10+)
* [[Density]] (v2.9)
* [[Curvature]] (v2.9)
* [[Roughness]] (v2.9)
* [[Remove duplicate points]]

== Display ==
* [[Full screen]] [[Image:CcFullScreen_small.png]]
* [[Full screen (3D view)]] [[Image:CcFullScreen_small.png]]
* [[Refresh]] [[Image:SmallReset.png]]
* [[Toggle Centered Perspective]] [[Image:CcCenteredPerspective_small.png]]
* [[Toggle Viewer Based Perspective]] [[Image:CcViewerBasedPerspective_small.png]]
* [[Show cursor coordinates]]
* [[Lock rotation about vert. axis]]
* [[Enter bubble-view mode]]
* [[Camera link]]
* [[Render to File]]
* [[Display\Display settings | Display options]] [[Image:CcSettings.png]]
* [[Display\Camera settings | Camera settings]] [[Image:Camera.png]]
* [[Display\Save viewport as object | Save viewport as object]] [[Image:DbViewportSymbol.png]]
* [[Display\Adjust zoom | Adjust zoom]]
* [[Display\Test Frame Rate | Test Frame Rate]]

=== Lights ===
* [[Display\Lights\Toggle Sun Light | Toggle Sun Light]]
* [[Display\Lights\Toggle Custom Light | Toggle Custom Light]]

=== Shaders & Filters ===
* [[Display\Shaders and Filters\Remove filter | Remove filter]]
* ''dynamically loaded shaders & filters'': [[Plugin qEDL | qEDL]], [[Plugin qSSAO | qSSAO]], etc.

=== Active scalar field ===
* [[Display\Active scalar field\Toggle color scale | Toggle color scale]]
* [[Display\Active scalar field\Show previous SF | Show previous SF]]
* [[Display\Active scalar field\Show next SF | Show next SF]]

=== Other ===
* [[Console]] [[Image:CcConsole_small.png]]
* [[Toolbars]]
* Language Translation > ... ''(below should appear the available and potentially partially supported languages)''
* [[Display\Reset all GUI elements | Reset all GUI elements]]

== Plugins ==
''Dynamic content (depends on the current version/platform)''.

Go to the [[Plugins]] section for the full list.

== 3D Views ==
* New
* Close
* Close All
* Tile
* Cascade
* Next
* Previous

== Help ==
* [[Help menu | Help]]
* [[About menu | About ...]]
* [[About Plugins menu| About Plugins ...]]
* Enable Qt warnings in Console ''(for obvious debug purposes ;)''

Lock rotation about vert. axis

2025-05-11T16:54:38Z

Daniel: /* Description */

= Menu =

This method is accessible via the 'Display > Lock rotation about vert. axis' menu.

Alternatively you can use the ''L'' shortcut.

= Description =

This method simply locks the camera rotation around the vertical (Z) axis (in the active 3D view).

When activated a '[ROTATION LOCKED]' message will appear in the top part of the 3D view:
[[Image:Cc_rotation_locked.jpg|center]]

Simply call this method again (or use the ''L'' shortcut) to disable this mode.

Since version 2.14.alpha (May 11th), this method will now work as a proper 'turntable' mode.

Colors\Gaussian filter

2025-05-10T06:52:25Z

Daniel:

== Menu / Icon ==

This tool is accessible via the 'Edit > Colors > Gaussian filter' [[Image:CcGaussianFilter.png]] menu.

== Description ==

Smooths Colors by applying a spatial [http://en.wikipedia.org/wiki/Gaussian_filter Gaussian filter] to each color component (Red,Green,Blue) individually.

== parameters ==
*'''kernel size''': radius of a sphere around each point inside which nearest neighbors will be extracted to compute the mean value. The bigger this radius, the stronger the filter will be (and the slower the computation...).
*'''color threshold''': if all 3 color components of a point are below the threshold value or above '255 - threshold', then this color will not be used in the computation.
**Example: if threshold = 2, rgb(0,0,0) is excluded, rgb(2,2,2) is excluded, rgb(253,253,253) is excluded, rgb(255,255,255) is excluded, but rgb(100,255,255) is included.

{| class="wikitable"
|[[Image:Color filters No filter.jpeg|frameless|default alignment|No filter]]
|[[Image:Color filters Gaussian filter.jpeg|frameless|default alignment|Gaussian filter]]
|[[Image:Color filters Bilateral filter.jpeg|frameless|default alignment|Bilateral filter]]
|[[Image:Color filters Mean filter.jpeg|frameless|default alignment|Mean filter]]
|[[Image:Color filters Median filter.jpeg|frameless|default alignment|Median filter]]
|-
|No Filter
|Edit > colors > [[Colors\Gaussian filter | Gaussian filter]]
|Edit > colors > [[Colors\Bilateral filter | Bilateral filter]]
|Edit > colors > [[Colors\Mean filter | Mean filter]]
|Edit > colors > [[Colors\Median filter | Median filter]]
|}

Note: the original colors will be overwritten. If you want to preserve original colors, use Edit > Colors > [[Colors\Convert to Scalar Field | Convert to scalar field]]

Colors\Gaussian filter

2025-05-10T06:51:41Z

Daniel: /* parameters */

== Menu / Icon ==

This tool is accessible via the 'Edit > Colors > Gaussian filter' [[Image:CcGaussianFilter.png]] menu.

== Description ==

Smooths Colors by applying a spatial [http://en.wikipedia.org/wiki/Gaussian_filter Gaussian filter] to each color component (Red,Green,Blue) individually.

== parameters ==
*'''kernel size''': radius of a sphere around each point inside which nearest neighbors will be extracted to compute the mean value. The bigger this radius, the stronger the filter will be (and the slower the computation...).
*'''color threshold''': if a all color components of a point are below the threshold value, or above '255 - threshold', then this color will not be used in the computation.
**Example: if threshold = 2, rgb(0,0,0) is excluded, rgb(2,2,2) is excluded, rgb(253,253,253) is excluded, rgb(255,255,255) is excluded, but rgb(100,255,255) is included.

{| class="wikitable"
|[[Image:Color filters No filter.jpeg|frameless|default alignment|No filter]]
|[[Image:Color filters Gaussian filter.jpeg|frameless|default alignment|Gaussian filter]]
|[[Image:Color filters Bilateral filter.jpeg|frameless|default alignment|Bilateral filter]]
|[[Image:Color filters Mean filter.jpeg|frameless|default alignment|Mean filter]]
|[[Image:Color filters Median filter.jpeg|frameless|default alignment|Median filter]]
|-
|No Filter
|Edit > colors > [[Colors\Gaussian filter | Gaussian filter]]
|Edit > colors > [[Colors\Bilateral filter | Bilateral filter]]
|Edit > colors > [[Colors\Mean filter | Mean filter]]
|Edit > colors > [[Colors\Median filter | Median filter]]
|}

Note: the original colors will be overwritten. If you want to preserve original colors, use Edit > Colors > [[Colors\Convert to Scalar Field | Convert to scalar field]]

BIN

2025-02-14T18:15:51Z

Daniel:

'''Description of the BIN V1 file format'''

(See the BinFilter class as an example of C++ code for reading/writing BIN files)

Warning: this is the old version that was coming with version 1 of CloudCompare!

The new BIN format is the serialization of CC's structures in memory and is too complex to detail. Consider using the SBF (Simplified BIN Format) format instead: [[SBF]]

== Header & data ==

{| cellpadding="10" style="text-align:center; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
!style="border-style: solid; border-width: 1px"| Description
!style="border-style: solid; border-width: 1px"| Type
!style="border-style: solid; border-width: 1px"| Size (bits)
!style="border-style: solid; border-width: 1px"| Expected value
|-
|style="border-style: solid; border-width: 1px"| Number of clouds
|style="border-style: solid; border-width: 1px"| unsigned integer
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"| generally <100
|-
|style="border-style: solid; border-width: 1px"| ... for each cloud ...
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Number of points
|style="border-style: solid; border-width: 1px"| unsigned integer
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"| up to 4.294.967.296 :)
|-
|style="border-style: solid; border-width: 1px"| Flags
|style="border-style: solid; border-width: 1px"| unsigned char
|style="border-style: solid; border-width: 1px"| 8
|style="border-style: solid; border-width: 1px"| See description below
|-
|style="border-style: solid; border-width: 1px"| ... if cloud name flag is ON ...
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Cloud name
|style="border-style: solid; border-width: 1px"| unsigned char [array]
|style="border-style: solid; border-width: 1px"| ?
|style="border-style: solid; border-width: 1px"| cloud name stops at the first byte equal to 0
|-
|style="border-style: solid; border-width: 1px"| ... for each point ...
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| X
|style="border-style: solid; border-width: 1px"| float
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Y
|style="border-style: solid; border-width: 1px"| float
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Z
|style="border-style: solid; border-width: 1px"| float
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| ... if color flag is ON ...
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Red
|style="border-style: solid; border-width: 1px"| unsigned char
|style="border-style: solid; border-width: 1px"| 8
|style="border-style: solid; border-width: 1px"| 0-255
|-
|style="border-style: solid; border-width: 1px"| Green
|style="border-style: solid; border-width: 1px"| unsigned char
|style="border-style: solid; border-width: 1px"| 8
|style="border-style: solid; border-width: 1px"| 0-255
|-
|style="border-style: solid; border-width: 1px"| Blue
|style="border-style: solid; border-width: 1px"| unsigned char
|style="border-style: solid; border-width: 1px"| 8
|style="border-style: solid; border-width: 1px"| 0-255
|-
|style="border-style: solid; border-width: 1px"| ... if normal flag is ON ...
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Nx
|style="border-style: solid; border-width: 1px"| float
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"| [-1.0;1.0]
|-
|style="border-style: solid; border-width: 1px"| Ny
|style="border-style: solid; border-width: 1px"| float
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"| [-1.0;1.0]
|-
|style="border-style: solid; border-width: 1px"| Nz
|style="border-style: solid; border-width: 1px"| float
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"| [-1.0;1.0]
|-
|style="border-style: solid; border-width: 1px"| ... if scalar field flag is ON ...
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| Scalar value
|style="border-style: solid; border-width: 1px"| double
|style="border-style: solid; border-width: 1px"| 64
|style="border-style: solid; border-width: 1px"|
|}

== Flags ==

{| cellpadding="10" style="text-align:center; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
|-
!style="border-style: solid; border-width: 1px"| Bit
!style="border-style: solid; border-width: 1px"| Decimal value
!style="border-style: solid; border-width: 1px"| Description
|-
|style="border-style: solid; border-width: 1px"| 1
|style="border-style: solid; border-width: 1px"| 1
|style="border-style: solid; border-width: 1px"| always ON
|-
|style="border-style: solid; border-width: 1px"| 2
|style="border-style: solid; border-width: 1px"| 2
|style="border-style: solid; border-width: 1px"| colors
|-
|style="border-style: solid; border-width: 1px"| 3
|style="border-style: solid; border-width: 1px"| 4
|style="border-style: solid; border-width: 1px"| normals
|-
|style="border-style: solid; border-width: 1px"| 4
|style="border-style: solid; border-width: 1px"| 8
|style="border-style: solid; border-width: 1px"| scalar field
|-
|style="border-style: solid; border-width: 1px"| 5
|style="border-style: solid; border-width: 1px"| 16
|style="border-style: solid; border-width: 1px"| cloud name
|-
|style="border-style: solid; border-width: 1px"| 6
|style="border-style: solid; border-width: 1px"| 32
|style="border-style: solid; border-width: 1px"| Ignored
|-
|style="border-style: solid; border-width: 1px"| 7
|style="border-style: solid; border-width: 1px"| 64
|style="border-style: solid; border-width: 1px"| Ignored
|-
|style="border-style: solid; border-width: 1px"| 8
|style="border-style: solid; border-width: 1px"| 128
|style="border-style: solid; border-width: 1px"| Ignored
|}

Methods

2025-02-07T06:55:53Z

Daniel: /* Colors */

[[pl:Funkcje w menu]]

= Menus =

Here are described all the methods of CloudCompare in the order they appear in the menu.

''(version: 2.11)''

== File ==

* [[Open]] [[File:ccOpen_small.png]]
* Open Recent... (''open recent files'')
* [[Save]] [[File:ccSave_small.png]]
* [[Global Shift settings]]
* [[Primitive Factory | Primitive factory]] [[File:DbMiscGeomSymbol.png]]
* [[mouse3D | 3D mouse > Enable]] [[Image:3dconnexion_logo.jpg]]
* [[Gamepad | Gamepad > Enable]] [[Image:Gamepad.png|16px]]
* Close all (''close all loaded entities'')
* Quit (''should be pretty clear!'')

== Edit ==
* [[Clone]] [[Image:CcClone.png]]
* [[Merge]] [[Image:CcMerge.png]]
* [[Edit\Subsample | Subsample]] [[Image:CcSampleCloud.png]]
* [[Apply Transformation | Apply transformation]]
* [[Multiply/Scale]]
* [[Interactive Transformation Tool | Translate/Rotate]] [[Image:CCMoveIcon.png]]
* [[Interactive Segmentation Tool | Segment]] [[File:CCSegmentIcon.png]]
* [[Crop]]
* [[Edit global shift and scale]]
* [[Toggle (menu) | Toggle (recursive) submenu]]
* Delete (''delete the selected entities'')

=== Colors ===
* [[Colors\Set Unique | Set unique]] [[File:TypeRgbCcolor.png]]
* [[Colors\From Scalar fields | From Scalar fields]]
* [[Colors\Colorize | Colorize]]
* [[Colors\Levels | Levels]]
* [[Colors\Height Ramp | Height ramp]]
* [[Colors\Convert to grey scale | Convert to grey scale]]
* [[Colors\Convert to Scalar Field | Convert to scalar field]]
* [[Colors\Interpolate from another entity | Interpolate from another entity]]
* [[Colors\Enhance with intensities | Enhance with intensities]]
* [[Colors\Bilateral filter | Bilateral filter]]
* [[Colors\Gaussian filter | Gaussian filter]]
* [[Colors\Mean filter | Mean filter]]
* [[Colors\Median filter | Median filter]]
* Clear (''remove the color field of the selected entities'')

=== Normals ===
* [[Normals\Compute | Compute]] [[File:TypeNormal.png]]
* [[Normals\Invert | Invert]]
* [[Normals\Orient Normals With Minimum Spanning Tree | Orient normals > With Minimum Spanning Tree]]
* [[Normals\Orient Normals With Fast Marching | Orient normals > with Fast Marching]]
* [[Normals\Convert to HSV | Convert to > HSV colors]]
* [[Normals\Convert to Dip and Dip direction SFs | Convert to > Dip & Dip direction SFs]]
* [[Normals\Export normals to SF(s) | Export normals to SF(s)]]
* [[Normals\Set SF(s) as normal | Set SF(s) as normal]]
* Clear (''remove normals from the selected entities'')

=== Octree ===
* [[Octree\Compute | Compute]] [[File:OctreeSymbol.png]]
* [[Octree\Resample | Resample]]

=== Grid ===
* [[Grid\Delete | Delete scan grids]]
* [[Grid\Mesh | Mesh scan grids]]

=== Cloud ===
* [[Cloud\Create single point cloud | Create single point cloud]]
* [[Cloud\Paste from clipboard | Paste from clipboard]]

=== Mesh ===
* [[Mesh\Delaunay_2.5D_(XY_plane) | Delaunay 2.5D (XY plane)]]
* [[Mesh\Delaunay_2.5D_(best_fit_plane) | Delaunay 2.5D (best fit plane)]]
* [[Mesh\Surface between two polylines | Surface between two polylines]]
* [[Mesh\Mesh scan grids | Mesh scan grids]]
* [[Mesh\Convert texture/material to RGB | Convert texture/material to RGB]] [[File:TypeRgbCcolor.png]]
* [[Mesh\Sample points | Sample points]] [[File:CCSamplePointsIcon.png]]
* [[Mesh\Smooth (Laplacian) | Smooth (Laplacian)]]
* [[Mesh\Subdivide | Subdivide]]
* [[Mesh\Flip triangles | Flip triangles]]
* [[Mesh\Measure surface | Measure surface]]
* [[Mesh\Measure volume | Measure volume]]
* [[Mesh\Flag vertices | Flag vertices by type]]
==== Mesh \ Scalar field ====
* [[Mesh\Scalar field\Smooth | Smooth]]
* [[Mesh\Scalar field\Enhance | Enhance]]

=== Polyline ===
* [[Polyline\Sample points | Sample points]]

=== Plane ===
* [[Plane\Edit and Create | Create]]
* [[Fit Plane | Fit]]
* [[Plane\Edit and Create | Edit]]
* [[Plane\Flip | Flip]]
* [[Plane\Compare | Compare]]

=== Sensors ===
* [[Sensors\Edit| Edit]]
==== Sensors \ TLS/GBL [[Image:SensorSymbol.png]] ====
* [[Sensors\Ground Based Lidar\Create | Create]]
* [[Sensors\Ground Based Lidar\Show Depth Buffer | Creat/show Depth Buffer]]
* [[Sensors\Ground Based Lidar\Export Depth Buffer | Export Depth Buffer]]
* [[Sensors\Ground Based Lidar\Compute Points Visibility With Depth Buffer | Compute points visibility (with depth buffer)]]

==== Sensors \ Camera Sensor [[Image:DbCamSensorSymbol.png]] ====
* [[Sensors\Camera Sensor\Create | Create]]
* [[Sensors\Camera Sensor\Project uncertainty | Project uncertainty]]
* [[Sensors\Camera Sensor\Compute points visibility (with octree) | Compute points visibility (with octree)]]
==== Sensors \ Other ====
* [[Sensors\View from sensor | View from sensor]] [[Image:DbViewportSymbol.png]]
* [[Sensors\Compute ranges | Compute Ranges]]
* [[Sensors\Compute scattering angles | Compute Scattering Angles]]

=== Scalar fields ===
* [[Scalar fields\Show histogram | Show histogram]] [[Image:CcHistogram.png]]
* [[Scalar fields\Compute statistical parameters | Compute stat. params]] [[Image:CcComputeStat.png]]
* [[Scalar fields\Gradient | Gradient]] [[Image:CcGradient.png]]
* [[Scalar fields\Gaussian filter | Gaussian filter]] [[Image:CcGaussianFilter.png]]
* [[Scalar fields\Bilateral filter | Bilateral filter]] [[Image:CcBilateralFilter.png]]
* [[Scalar fields\Filter by Value | Filter by Value]] [[Image:CcFilterByValue.png]]
* [[Scalar fields\Convert to RGB | Convert to RGB]] [[Image:TypeRgbCcolor.png]]
* [[Scalar fields\Convert to random RGB | Convert to random RGB]]
* [[Scalar fields\Rename | Rename]]
* [[Scalar fields\Add constant SF | Add constant SF]] [[Image:CcAddConstSF.png]]
* [[Scalar fields\Add classification SF | Add classification SF]] [[Image:CcAddConstSF.png]]
* [[Scalar fields\Add point indexes as SF | Add point indexes as SF]]
* [[Scalar fields\Export coordinate(s) to SF(s) | Export coordinate(s) to SF(s)]]
* [[Scalar fields\Set SF as coordinate(s) | Set SF as coordinate(s)]]
* [[Normals\Export normals to SF(s) | Export normals to SF(s)]]
* [[Normals\Set SF(s) as normal | Set SF(s) as normal]]
* [[Scalar fields\Interpolate from another entity | Interpolate from another entity]]
* [[Scalar fields\Split cloud (integer values) | Split cloud (integer values)]]
* [[Scalar fields\Arithmetic | Arithmetic]] [[Image:CcSfArithmetic.png]]
* [[Scalar fields\Color Scales Manager | Color Scales Manager]] [[Image:TypeSF.png]]
* Delete [[Image:CcDeleteSF.png]] (deletes the active scalar field of the selected entities)
* Delete all (!) (deletes all scalar fields of the selected entities)

=== Waveform ===
* [[Waveform\2D Waveform viewer | 2D Waveform viewer]]
* [[Waveform\Compress FWF data | Compress FWF data]]

== Tools ==

* [[Level]] [[Image:CcLevel small.png]]
* [[Point Picking]] [[Image:CcPointPicking_small.png]]
* [[Point list picking]] [[Image:CcPointListPicking_small.png]]
* [[Trace polyline]] [[Image:CcTracePolyline.png]]

=== Clean ===
* [[SOR filter]]
* [[Noise filter]]

=== Projection ===
* [[Unroll]]
* [[Rasterize | Rasterize (and contour plot)]] [[Image:CcGrid_small.png]]
* [[Contour plot to mesh | Contour plot (polylines) to mesh]]
* [[Scalar fields\Export coordinate(s) to SF(s) | Export coordinate(s) to SF(s)]]
* [[Mesh\Surface between two polylines | Create surface between two polylines]]

=== Registration ===
* [[Match bounding box centers | Match bounding-box centers]]
* [[Match scales]]
* [[Align | Align (point pairs picking)]] [[File:Cc_pointPairAlignIcon.png‎]]
* [[ICP | Fine registration (ICP)]] [[File:CCRegisterIcon.png‎]]
* [[Registration\Move bounding-box ... to origin | Move bounding-box center to origin]]
* [[Registration\Move bounding-box ... to origin | Move bounding-box min corner to origin]]
* [[Registration\Move bounding-box ... to origin | Move bounding-box max corner to origin]]

=== Distances ===
* [[Cloud-to-Cloud_Distance | Cloud/Cloud Dist.]] [[File:CloudCloudDistanceIcon.png‎]]
* [[Cloud-to-Mesh Distance | Cloud/Mesh Dist]] [[File:CloudMeshDistanceIcon.png]]
* [[Cloud-to-Primitive Distance | Cloud/Primitive Dist]]
* [[Closest Point Set]]

=== Volume ===
* [[2.5D Volume | Compute 2.5D volume]]

=== Statistics ===
* [[Local Statistical Test]] [[Image:CcStatTest.png]]
* [[Compute Stat Params | Compute stat. params (active SF)]] [[File:CcComputeStat.png]]

=== Segmentation ===
* [[Label Connected Components | Label Connected Comp.]] [[Image:CcCCExtract.png]]
* [[Cross Section]] [[Image:CcClippingBox_small.png]]
* [[Extract Sections]] / Unfold [[Image:DbPolylineSymbol.png]]

=== Fit ===
* [[Fit Plane | Plane ]]
* [[Fit Sphere | Sphere ]]
* [[Fit 2D Polygon | 2D Polygon (facet) ]]
* [[Fit Quadric | 2.5D Quadric ]]

=== Batch export ===
* [[Export cloud info]]
* [[Export plane info]]

=== Other ===
* [[Compute geometric features]] (v2.10+)
* [[Density]] (v2.9)
* [[Curvature]] (v2.9)
* [[Roughness]] (v2.9)
* [[Remove duplicate points]]

== Display ==
* [[Full screen]] [[Image:CcFullScreen_small.png]]
* [[Full screen (3D view)]] [[Image:CcFullScreen_small.png]]
* [[Refresh]] [[Image:SmallReset.png]]
* [[Toggle Centered Perspective]] [[Image:CcCenteredPerspective_small.png]]
* [[Toggle Viewer Based Perspective]] [[Image:CcViewerBasedPerspective_small.png]]
* [[Show cursor coordinates]]
* [[Lock rotation about vert. axis]]
* [[Enter bubble-view mode]]
* [[Camera link]]
* [[Render to File]]
* [[Display\Display settings | Display options]] [[Image:CcSettings.png]]
* [[Display\Camera settings | Camera settings]] [[Image:Camera.png]]
* [[Display\Save viewport as object | Save viewport as object]] [[Image:DbViewportSymbol.png]]
* [[Display\Adjust zoom | Adjust zoom]]
* [[Display\Test Frame Rate | Test Frame Rate]]

=== Lights ===
* [[Display\Lights\Toggle Sun Light | Toggle Sun Light]]
* [[Display\Lights\Toggle Custom Light | Toggle Custom Light]]

=== Shaders & Filters ===
* [[Display\Shaders and Filters\Remove filter | Remove filter]]
* ''dynamically loaded shaders & filters'': [[Plugin qEDL | qEDL]], [[Plugin qSSAO | qSSAO]], etc.

=== Active scalar field ===
* [[Display\Active scalar field\Toggle color scale | Toggle color scale]]
* [[Display\Active scalar field\Show previous SF | Show previous SF]]
* [[Display\Active scalar field\Show next SF | Show next SF]]

=== Other ===
* [[Console]] [[Image:CcConsole_small.png]]
* [[Toolbars]]
* Language Translation > ... ''(below should appear the available and potentially partially supported languages)''
* [[Display\Reset all GUI elements | Reset all GUI elements]]

== Plugins ==
''Dynamic content (depends on the current version/platform)''.

Go to the [[Plugins]] section for the full list.

== 3D Views ==
* New
* Close
* Close All
* Tile
* Cascade
* Next
* Previous

== Help ==
* [[Help menu | Help]]
* [[About menu | About ...]]
* [[About Plugins menu| About Plugins ...]]
* Enable Qt warnings in Console ''(for obvious debug purposes ;)''

Unroll

2025-02-06T15:47:04Z

Daniel:

== Menu ==

This tool is accessible via the 'Tools > Projection > Unroll' menu.

== Description ==

This method 'unrolls' a point cloud from a cylindrical (or conical) shape onto a plane:

[[Image:Cc_unroll_input.jpg|frame|center|Cylindrical shape to unroll]]
[[Image:Cc_unroll_result.jpg|frame|center|Cylindrical shape unrolled]]
[[Image:Cc_unroll_cone_example.jpg|frame|center|Unrolled cone]]

== Procedure ==

Select a single cloud then start this tool.

=== Cylinder ===

[[Image:Cc_unroll_cylinder_dialog.jpg|frame|center|'Unroll cylinder' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z, or a custom 3D axis)
* cylinder radius
* optionally a point on the axis (''otherwise CloudCompare can try to guess it by computing the gravity center of the point cloud'')
* since version 2.11, it is also possible to specify the angular range. By default it's [0-360], but you can input any angular value, and even multiple revolutions.

Most of these parameters can be populated by choosing an existing cylinder primitive already loaded in the database.

[[Image:Unroll_angles.JPG|frame|center|'Unroll angular zero and sign' dialog]]

=== Cone ===

Since version 2.9, this method unrolls a cone in a way that preserves surfaces (as if the cone was 'rolling' on a planar surface).
And since version 2.13, a sub-option 'Projection' allows to choose the type of conical projection among:
* Conical
* Cylindrical (fixed radius)
** this mode corresponds to the old 'Cone' unrolling mode in version 2.8 and prior. It unrolls a cone-shaped cloud as if it was a cylinder, by first 'straightening' the cone walls.
* Cylindrical (adaptive radius)

[[Image:Cc_unroll_cone_dialog.jpg|frame|center|'Unroll cone' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z or a custom 3D axis)
* half angle (this is the ''aperture'' angle at the cone apex) in degrees
* the cone apex position in 3D
* span ratio
* start and stop angles

Most of these parameters can be populated by choosing an existing cone primitive already loaded in the database.

== Export deviation scalar field ==

A checkbox named 'Export deviation scalar field' allows to compute for each point its radial distance to the theoretical unrolling shape (cylinder or cone). A new scalar field will be added to the output cloud.

== Output unrolled cloud in an arbitrary coordinate system ==

Since version 2.13, it is now possible to output the unrolled cloud in an arbitrary coordinate system:
* X: unroll angle
* Y: distance to primitive
* Z: longitude

Unroll

2025-02-06T15:45:07Z

Daniel: /* Cone */

== Menu ==

This tool is accessible via the 'Tools > Projection > Unroll' menu.

== Description ==

This method 'unrolls' a point cloud from a cylindrical (or conical) shape onto a plane:

[[Image:Cc_unroll_input.jpg|frame|center|Cylindrical shape to unroll]]
[[Image:Cc_unroll_result.jpg|frame|center|Cylindrical shape unrolled]]
[[Image:Cc_unroll_cone_example.jpg|frame|center|Unrolled cone]]

Since version 2.13, it is now possible to:
* define a custom 3D axis
* init the unrolling parameters with an existing cylinder or cone entity present in the database
* output the unrolled cloud in an arbitrary coordinate system

== Procedure ==

Select a single cloud then start this tool.

=== Cylinder ===

[[Image:Cc_unroll_cylinder_dialog.jpg|frame|center|'Unroll cylinder' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z, or a custom 3D axis)
* cylinder radius
* optionally a point on the axis (''otherwise CloudCompare can try to guess it by computing the gravity center of the point cloud'')
* since version 2.11, it is also possible to specify the angular range. By default it's [0-360], but you can input any angular value, and even multiple revolutions.

Most of these parameters can be populated by choosing an existing cylinder primitive already loaded in the database.

[[Image:Unroll_angles.JPG|frame|center|'Unroll angular zero and sign' dialog]]

=== Cone ===

Since version 2.9, this method unrolls a cone in a way that preserves surfaces (as if the cone was 'rolling' on a planar surface).
And since version 2.13, a sub-option 'Projection' allows to choose the type of conical projection among:
* Conical
* Cylindrical (fixed radius)
** this mode corresponds to the old 'Cone' unrolling mode in version 2.8 and prior. It unrolls a cone-shaped cloud as if it was a cylinder, by first 'straightening' the cone walls.
* Cylindrical (adaptive radius)

[[Image:Cc_unroll_cone_dialog.jpg|frame|center|'Unroll cone' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z or a custom 3D axis)
* half angle (this is the ''aperture'' angle at the cone apex) in degrees
* the cone apex position in 3D
* span ratio
* start and stop angles

Most of these parameters can be populated by choosing an existing cone primitive already loaded in the database.

=== Straightened cone ===

This mode was corresponding to the 'Cone' unrolling mode in version 2.8 and prior.

This method unrolls a cone-shaped cloud as if it was a cylinder, by first 'straightening' the cone walls.

[[Image:Cc_unroll_straightened_cone_dialog.jpg|frame|center|'Unroll straightened cone' dialog]]

To unroll a straightened conical shape, the parameters are:
* axis of revolution (X, Y or Z)
* half angle (this is the ''aperture'' angle at the cone apex - in degrees)
* the cone apex position
* the base radius of the 'straightened' cone (= cylinder)

== Export deviation scalar field ==

A checkbox named 'Export deviation scalar field' allows to compute for each point its radial distance to the theoretical unrolling shape (cylinder or cone). A new scalar field will be added to the output cloud.

Unroll

2025-02-06T15:43:58Z

Daniel: /* Cylinder */

== Menu ==

This tool is accessible via the 'Tools > Projection > Unroll' menu.

== Description ==

This method 'unrolls' a point cloud from a cylindrical (or conical) shape onto a plane:

[[Image:Cc_unroll_input.jpg|frame|center|Cylindrical shape to unroll]]
[[Image:Cc_unroll_result.jpg|frame|center|Cylindrical shape unrolled]]
[[Image:Cc_unroll_cone_example.jpg|frame|center|Unrolled cone]]

Since version 2.13, it is now possible to:
* define a custom 3D axis
* init the unrolling parameters with an existing cylinder or cone entity present in the database
* output the unrolled cloud in an arbitrary coordinate system

== Procedure ==

Select a single cloud then start this tool.

=== Cylinder ===

[[Image:Cc_unroll_cylinder_dialog.jpg|frame|center|'Unroll cylinder' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z, or a custom 3D axis)
* cylinder radius
* optionally a point on the axis (''otherwise CloudCompare can try to guess it by computing the gravity center of the point cloud'')
* since version 2.11, it is also possible to specify the angular range. By default it's [0-360], but you can input any angular value, and even multiple revolutions.

Most of these parameters can be populated by choosing an existing cylinder primitive already loaded in the database.

[[Image:Unroll_angles.JPG|frame|center|'Unroll angular zero and sign' dialog]]

=== Cone ===

Since version 2.9, this method unrolls a cone in a way that preserves surfaces (as if the cone was 'rolling' on a planar surface).
And since version 2.13, a sub-option 'Projection' allows to choose the type of conical projection among:
* Conical
* Cylindrical (fixed radius)
* Cylindrical (adaptive radius)

[[Image:Cc_unroll_cone_dialog.jpg|frame|center|'Unroll cone' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z or a custom 3D axis)
* half angle (this is the ''aperture'' angle at the cone apex) in degrees
* the cone apex position in 3D
* span ratio
* start and stop angles

Most of these parameters can be populated by choosing an existing cone primitive already loaded in the database.

=== Straightened cone ===

This mode was corresponding to the 'Cone' unrolling mode in version 2.8 and prior.

This method unrolls a cone-shaped cloud as if it was a cylinder, by first 'straightening' the cone walls.

[[Image:Cc_unroll_straightened_cone_dialog.jpg|frame|center|'Unroll straightened cone' dialog]]

To unroll a straightened conical shape, the parameters are:
* axis of revolution (X, Y or Z)
* half angle (this is the ''aperture'' angle at the cone apex - in degrees)
* the cone apex position
* the base radius of the 'straightened' cone (= cylinder)

== Export deviation scalar field ==

A checkbox named 'Export deviation scalar field' allows to compute for each point its radial distance to the theoretical unrolling shape (cylinder or cone). A new scalar field will be added to the output cloud.

Unroll

2025-02-06T15:42:29Z

Daniel: /* Cone */

== Menu ==

This tool is accessible via the 'Tools > Projection > Unroll' menu.

== Description ==

This method 'unrolls' a point cloud from a cylindrical (or conical) shape onto a plane:

[[Image:Cc_unroll_input.jpg|frame|center|Cylindrical shape to unroll]]
[[Image:Cc_unroll_result.jpg|frame|center|Cylindrical shape unrolled]]
[[Image:Cc_unroll_cone_example.jpg|frame|center|Unrolled cone]]

Since version 2.13, it is now possible to:
* define a custom 3D axis
* init the unrolling parameters with an existing cylinder or cone entity present in the database
* output the unrolled cloud in an arbitrary coordinate system

== Procedure ==

Select a single cloud then start this tool.

=== Cylinder ===

[[Image:Cc_unroll_cylinder_dialog.jpg|frame|center|'Unroll cylinder' dialog]]

To unroll a cylindrical shape, the parameters are:
* axis of revolution (X, Y or Z)
* cylinder radius
* optionally a point on the axis (''otherwise CloudCompare can try to guess it by computing the gravity center of the point cloud'')
* since version 2.11, it is also possible to specify the angular range. By default it's [0-360], but you can input any angular value, and even multiple revolutions.

[[Image:Unroll_angles.JPG|frame|center|'Unroll angular zero and sign' dialog]]

=== Cone ===

Since version 2.9, this method unrolls a cone in a way that preserves surfaces (as if the cone was 'rolling' on a planar surface).
And since version 2.13, a sub-option 'Projection' allows to choose the type of conical projection among:
* Conical
* Cylindrical (fixed radius)
* Cylindrical (adaptive radius)

[[Image:Cc_unroll_cone_dialog.jpg|frame|center|'Unroll cone' dialog]]

Main parameters are:
* axis of revolution (X, Y, Z or a custom 3D axis)
* half angle (this is the ''aperture'' angle at the cone apex) in degrees
* the cone apex position in 3D
* span ratio
* start and stop angles

Most of these parameters can be populated by choosing an existing cone primitive already loaded in the database.

=== Straightened cone ===

This mode was corresponding to the 'Cone' unrolling mode in version 2.8 and prior.

This method unrolls a cone-shaped cloud as if it was a cylinder, by first 'straightening' the cone walls.

[[Image:Cc_unroll_straightened_cone_dialog.jpg|frame|center|'Unroll straightened cone' dialog]]

To unroll a straightened conical shape, the parameters are:
* axis of revolution (X, Y or Z)
* half angle (this is the ''aperture'' angle at the cone apex - in degrees)
* the cone apex position
* the base radius of the 'straightened' cone (= cylinder)

== Export deviation scalar field ==

A checkbox named 'Export deviation scalar field' allows to compute for each point its radial distance to the theoretical unrolling shape (cylinder or cone). A new scalar field will be added to the output cloud.

File:Cc unroll cone dialog.jpg

2025-02-06T15:38:46Z

Daniel: Daniel uploaded a new version of File:Cc unroll cone dialog.jpg

2024-02-13T19:25:05Z

Daniel: