Stats messages

When a processing task finishes, PIX4Dengine SDK emits a stats message that describes what ran and (on success) task-specific options or results. Every message includes a shared header. Successful runs may add further properties for that module or task.

All stats messages are anonymous. They carry algorithm and runtime data only (task options, outcomes, hardware counters, and similar). They are not linked to user accounts and are not intended to identify or trace individual users.

On cancelled or error, only the header is sent (no task-specific fields).

The tables below list the properties currently sent. Nested algorithm payloads (metrics / analytics) are noted where algorithms forward them as objects; their internal keys are owned by the underlying algorithms and are expanded here in examples only. That detail is technical and is intended for R&D when analysing (typically newly released) algorithm changes.

Common header

These properties are included with every stats message.

property	type	example	comments
product	string	Vortex	Hardcoded platform internal name
task_name	string	calibrate, densification, gen_mesh, …	Processing function name
module_name	string	calib, dense, ortho, gsplat, …	Module name
module_version	string or null	0.7.0	Module version
software_version	string	2.18.0	PIX4Dengine SDK package release version
processing_time	number	654.2	Elapsed task processing time
processing_status	string	success, cancelled, error	Final status of the task
physical_cpu_count	number	8	Number of physical CPU cores on the host
logical_cpu_count	number	16	Number of logical CPUs on the host
ram	number	32	Host RAM in GiB
operating_system	string	Windows, Linux	OS family name of the host
client_application	string	engine2	Internal hardcoded value for the PIX4Dengine SDK

Calibration

Modules: calib, fastalgo.

Tasks: calibrate, reoptimize.

Settings-only fields (calib_pipeline, calib_option_image_scale, calib_use_rig_matching, calib_use_itps) are sent when the call uses calib.Settings.

property	type	example	comments
camera_model_names	list of string	[FC300X_3.6_4000x3000, …]	Project’s camera model identifiers
gcp_count	number or null	5	Project’s number of GCPs
mean_gsd	number or null	0.01595	Calculated mean GSD
calibrated_image_count	number	396	Number of successfully calibrated images
calibrated_image_percentage	number	99.31	Percentage of input images that calibrated successfully
calib_median_matches_per_camera	number or null	5681.0	Median number of matches per camera
calib_mean_relative_difference_sensor_params	number or null	0.43	Relative difference between initial and optimized sensor parameters
calib_pipeline	string	scalable, low_texture_planar, …	Calibration pipeline type selection setting
calib_option_image_scale	number	1.0	Setting image scale
calib_use_rig_matching	bool	false	Rig usage identifier
calib_use_itps	bool	false	ITP usage identifier
calibration_metrics	object	n/a	Metrics object from calibration (see example keys below)
sensor_metrics	list of object	n/a	List of sensor metric objects from calibration
band_names	string	Green_NIR_RedEdge_Red	Underscore-separated sanitised bandNames values from sensor_metrics

Example keys in calibration include meanProjectionError, trackCount, hasDepth, etc.

Orthomosaic

Modules: ortho, fastalgo.

Tasks: gen_orthomosaic, gen_tiled_orthomosaic.

property	type	example	comments
ortho_option_fill_occlusion_holes	bool	true	Setting ortho.Settings.fill_occlusion_holes
ortho_option_pipeline	string	FAST, DEGHOST, FULL	Setting ortho.Settings.pipeline
ortho_option_capture_pattern	string	NADIR, OBLIQUE	Setting ortho.Settings.capture_pattern
ortho_option_tile_size	number	512	Configuration ortho.Settings.tile_size
ortho_option_radiometry_weather_condition	string	CLEAR_SKY, OVERCAST…	Setting for radiometry processing
sensor_layout_used	string or null	Red, Green, Blue	Text of the sensor_layout passed by the caller. null when the argument is omitted or None

DSM

Module: dsm.

Tasks: gen_dsm, gen_tiled_dsm.

property	type	example	comments
dsm_option_resolution	number	0.023	Setting dsm.Settings.resolution
dsm_option_max_tile_size	number	1024	Setting dsm.Settings.max_tile_size
dsm_option_method	string	Triangulation, IDW	Setting dsm.Settings.method

DTM

Module: dsm (there is no separate dtm module).

Tasks: gen_dtm, gen_tiled_dtm.

property	type	example	comments
dsm_option_resolution	number	0.023	Setting from the nested DSM settings
dsm_option_max_tile_size	number	1024	Setting from the nested DSM settings
dsm_option_method	string	Triangulation, IDW	Setting from the nested DSM settings
dtm_option_rigidity	string	Low, Medium, High	Setting cloth rigidity for DTM generation

Densification

Module: dense.

Task: densification.

property	type	example	comments
dense_option_image_scale	number	1	Setting dense.Settings.image_scale
dense_option_point_density	number	2	Setting dense.Settings.point_density
dense_option_limit_depth	bool	false	Setting dense.Settings.limit_depth
dense_option_min_no_match	number	3	Setting dense.Settings.min_no_match
dense_option_multi_scale	bool	true	Setting dense.Settings.multi_scale
dense_option_window_size	number	7	Setting dense.Settings.window_size
processing_output_point_cloud_points	number	22850234	Generated number of points in the densified point cloud

Depth fusion

Module: depth.

Task: pcl_merge.

property	type	example	comments
processing_output_point_cloud_points	number	89374650	Generated number of points in the merged point cloud

Point cloud alignment

Module: pcalign.

Task: alignment.

property	type	example	comments
processing_output_alignment_quality	string	AVERAGE, GOOD…	Reported point cloud alignment quality

Mesh texture

Module: mesh.

Task: gen_mesh_texture.

property	type	example	comments
mesh_option_outlier_threshold	number	0.356	Outlier threshold used for texturing (legacy mesh)

Scalable mesh

Module: mesh.

Task: gen_mesh.

property	type	example	comments
mesh_option_preset	string	CATCH, NADIR, OBLIQUE	Scalable mesh preset name
mesh_option_preview	bool	false	Preview mode flag from scalable mesh settings
mesh_option_deghost	bool	false	Deghost flag from scalable mesh settings

Standard mesh (header only)

Module: mesh.

Tasks: gen_mesh_geometry, gen_textured_mesh_lod.

These tasks send the common header only.

Gaussian splatting

Module: gsplat.

Task: gen_gs.

Additional gsplat_option_* keys may appear if present in gsplat.Settings.to_dict().

property	type	example	comments
gsplat_option_preset	string	DRONE, TERRESTRIAL…	Selected Gaussian splatting preset
gsplat_option_compute_point_cloud	bool	true	Point cloud generation indicator
gsplat_option_compute_depth_maps	bool	true	Depth map generation indicator
gsplat_algo_payload	object	n/a	Metrics object from gsplat (see example keys below)

Example keys in gsplat_algo_payload include version, n_splits, gpu_max_reserved_bytes, etc.

Gaussian splatting rasters

Module: gsplat.

Task: gen_gs_rasters.

property	type	example	comments
gsplat_raster_algo_payload	object	n/a	Metrics object from gsplat (see example keys below)

Example keys in gsplat_raster_algo_payload include gs_model_size, n_tiles_dsm_ortho_x_y, invalid_pixels_ratio, etc.

Sky segmentation

Module: skyseg.

Task: gen_segment_masks.

property	type	example	comments
skyseg_option_masking_type	string	sky, water…	Mask classes
skyseg_option_fast_exclusion	bool	false	Exclusion mode usage
analytics	object	n/a	Metrics object from skyseg module (see example keys below)

Example keys in analytics include N_IMAGES, TOTAL_TIME_SEC, SEMANTIC_CLASSES, etc.

Exports

Modules: obj, cesium, slpk, ply, fbx.

Tasks include write_mesh, write_pcl, and write_gsplat (and related writer entry points). Each writer adds:

property	type	example	comments
export_format	string	OBJ, CESIUM, SLPK, PLY, FBX	Used 3D export formats

Typical task_name / export_format pairs:

• obj.write_mesh → OBJ

• cesium.write_mesh / cesium.write_pcl → CESIUM

• slpk.write_mesh / slpk.write_pcl → SLPK

• ply.write_gsplat → PLY

• fbx.write_mesh → FBX

AutoGCP

Module: autogcp.

Task: detect_gcp_marks.

This task sends the common header only.

Index map

Module: indexmap.

Task: compute_custom_index.

This task sends the common header only.

OPF project I/O

Module: _project.

Tasks: opf_project_reader, opf_project_writer.

These tasks send the common header only (with the task_name values above).