Logo
  • SDK DOCS
  • Download

Table of Contents

  • Installation
    • Prerequisites
    • Pre-install dependencies
      • Linux/Ubuntu 26.04
      • Windows
    • Installation steps
    • DJI Thermal SDK
  • User Guide
    • Introduction
    • Concepts: Data model, algorithms, utilities, exporters
      • Photogrammetric Processing Algorithms
        • Core Processing
        • More Processing
      • PIX4Dengine SDK data model
        • dmodel: OPF compatible data model
        • pix4dvortex specific data model
      • Utilities
        • Logging
        • Progress callbacks
        • Stop functions
  • Glossary
  • Release notes
    • Release 2026.10 - semantic version 2.21.1
      • What’s new
      • Bug fixes
    • Internal release 2.21.0
      • What’s new
        • Thermal image processing
        • Documentation
        • Miscellaneous
      • Changes
    • Internal release 2.20.0
      • What’s new
        • Settings and templates
        • DSM/DTM/orthomosaic functions
        • Mesh
        • Gaussian splatting
        • Documentation
        • Quality report
        • Miscellaneous
      • Changes
      • Bug fixes
    • Internal release 2.19.0
      • What’s new
    • Internal release 2.18.0
      • What’s new
        • Quality report
        • Callbacks
        • New collection of DSM/DTM/orthomosaic functions
        • Geoid models
        • Documentation
      • Changes
      • Bug fixes
    • Release 2026.05 - semantic version 2.17.0
      • What’s new
        • Calibration and Matching
        • Gaussian splatting
        • Region of interest
        • Miscellaneous
      • Changes
      • Bug fixes
    • Internal release 2.16.1
      • Fixed
    • Internal release 2.16.0
      • What’s new
      • Changes
      • Bug fixes
    • Internal release 2.15.3
      • What’s new
      • Changes
      • Bug fixes
    • Internal release 2.15.2
      • Changes
      • Bug fixes
    • Internal release 2.15.1
      • Changes
    • Internal release 2.15.0
      • What’s new
      • Changes
      • Bug fixes
    • Release 2025.05 - semantic version 2.14.0
      • What’s new
      • Changes
      • Bug Fixes
    • Internal release 2.13.0
    • Internal release 2.12.1
      • What’s new
      • Bug Fixes
    • Internal release 2.11.0
      • What’s new
    • Internal release 2.10.0
      • What’s new
      • Changes
      • Bug Fixes
    • Internal release 2.9.1
      • What’s new
    • Release 2024.09 - semantic version 2.9.0
      • What’s new
      • Changes
      • Bug Fixes
    • Internal release 2.8.0
      • What’s new
    • Internal release 2.7.0
      • What’s new
      • Bug Fixes
      • Changes
    • Release 2024.04 - semantic version 2.6.0
      • What’s new
      • Bug fixes
    • Internal release 2.5.0
      • What’s new
      • Changes
      • Bug fixes
    • Internal release 2.4.1
      • Bug fixes
    • Internal release 2.4.0
      • What’s new
      • Bug fixes
    • Internal release 2.3.0
      • What’s new
      • Bug fixes
    • Release 2023.09 - semantic version 2.2.0
      • What’s new
      • Bug fixes
    • Internal release 2.1.1
      • What’s new
      • Bug fixes
    • Release 2023.06 - semantic version 2.1.0
      • What’s new
      • Changes
      • Bug fixes
    • Release 2023.05 - semantic version 2.0.0
      • What’s new
  • Known Issues
  • Limitations
  • Supported Environments
    • Linux
    • Windows
    • Additional GPU requirements for Gaussian splatting
  • API Reference
    • Authentication
      • is_logged_in()
      • login()
      • logout()
    • Data Model
      • OPF data model
        • BandInformation
        • BaseToCanonical
        • CRS
        • CalibratedCamera
        • CalibratedCameras
        • CalibratedControlPoint
        • CalibratedControlPoints
        • CalibratedITP
        • CalibratedIntersectionTiePoints
        • CalibratedRigRelatives
        • CalibratedSensor
        • Calibration
        • Camera
        • CameraList
        • CameraOptimizationHints
        • CaptureElement
        • Constraints
        • DynamicPixelRange
        • Edge
        • Features
        • FisheyeInternals
        • GCP
        • GLTFGSplat
        • GLTFPointCloud
        • GPSBias
        • Geolocation
        • ITP
        • ITPMarkCreationMethod
        • InputCameras
        • InputControlPoints
        • InputRigRelatives
        • IntersectionTiePoints
        • MTP
        • Mark
        • MarkWithSegments
        • Matches
        • OmegaPhiKappa
        • Orientation
        • OriginalMatches
        • PerspectiveInternals
        • ProjectedCameras
        • ProjectedCapture
        • ProjectedControlPoints
        • ProjectedGCP
        • ProjectedGeolocation
        • ProjectedOrientation
        • ProjectedRigTranslation
        • ProjectedSensor
        • RigRelativeRotation
        • RigRelativeTranslation
        • RigidTransform
        • ScaleConstraint
        • SceneRefFrame
        • SegmentGraph2D
        • SegmentGraphs2D
        • SensorElement
        • SphericalInternals
        • StaticPixelRange
        • Vertex
        • YawPitchRoll
        • WeatherCondition
        • OpticalRadiometricCorrectionType
        • ThermalParameter
        • _SurfaceModelMesh
        • _RadiometryInputs
        • _RadiometrySettings
      • pix4dvortex data model
    • Core Processing
      • Input and Calibrated Cameras
        • DepthConfidenceInfo
        • DepthInfo
        • GeoCoordinates
        • GeoRotation
        • GeoTag
        • InputCameras
        • ProjectedCameras
        • RigGeometry
        • RigRelativePositionAndRotation
        • Settings
        • UIDGen
        • make_input_cameras()
        • version()
        • _RadiometryData
      • Camera Calibration
        • ReoptSettings
        • calibrate()
        • reoptimize()
        • version()
        • Settings
        • TEMPLATES
        • _CalibratedScene
        • CalibrationType
        • ImagePairSettings
        • MatchingAlgorithm
        • OptimExtType
        • OptimIntType
      • Point Cloud Densification
        • densification()
        • version()
        • MAX_GPU_MEM
        • MAX_RAM
        • Settings
        • TEMPLATES
        • PointCloud
      • DSM/DTM
        • DTMSettings
        • Settings
        • gen_dsm()
        • gen_dtm()
        • gen_tiled_dsm()
        • gen_tiled_dtm()
        • version()
        • Rigidity
      • Orthomosaic
        • gen_orthomosaic()
        • gen_tiled_orthomosaic()
        • get_sensor_layouts()
        • version()
        • Settings
        • TEMPLATES
        • Pipeline
        • CapturePattern
        • SensorLayout
      • 3D Mesh
        • gen_mesh()
        • gen_mesh_geometry()
        • gen_mesh_texture()
        • gen_textured_mesh_lod()
        • version()
        • SCALABLE_MESH_TEMPLATES
        • ScalableSettings
        • Settings
        • TEMPLATES
        • TextureSettings
        • TEMPLATES
        • LODSettings
        • _Texture
        • _MeshGeom
        • _MeshLOD
      • Fast calibration and Orthomosaic generation
        • calibrate()
        • gen_orthomosaic()
        • gen_tiled_orthomosaic()
        • version()
      • Gaussian Splatting
        • RasterSettings
        • gen_gs()
        • gen_gs_dsm()
        • version()
        • Settings
        • TEMPLATES
        • Presets
        • GaussianSplatting
    • More Processing
      • AutoGCP
        • AutogcpError
        • Settings
        • detect_gcp_marks()
        • version()
      • Depth Processing
        • DepthCompletionSettings
        • MergeSettings
        • densify()
        • gen_pcl()
        • pcl_merge()
        • version()
        • Settings
        • ConfidenceLevel
      • Sky and Water Segmentation
        • gen_segment_masks()
        • version()
        • Settings
        • MaskingType
        • Mode
      • Point Cloud Alignment
        • alignment()
        • version()
      • Point Cloud Transformation
        • transform()
      • Index Calculation
        • compute_custom_index()
        • get_custom_index_band_names()
    • Exports
      • Cesium
        • version()
        • write_mesh()
        • write_pcl()
      • FBX
        • export_levels_face_count()
        • version()
        • write_mesh()
        • Settings
      • GeoTIFF
        • to_cog()
        • write_geotiff()
        • write_geotiff_tile()
        • write_geotiff_view()
        • Settings
        • Compression
      • LAS
        • write_pcl()
        • LasVersion
      • OBJ
        • version()
        • write_mesh()
        • Settings
        • TextureFmt
      • PLY
        • write_gsplat()
      • SLPK
        • version()
        • write_mesh()
        • write_pcl()
      • OPF (experimental)
        • ProjectWriter
        • ProjectReader
        • package_project()
    • Utilities
      • General utilities
        • collect_hw_info()
        • collect_stats()
        • hash_id()
        • hw_info()
        • path_to_url()
        • sha256()
        • task_info()
        • timestamp()
        • url_to_path()
      • Processing utilities
        • StopProcessing
        • Resources
      • Geometry
        • Box
        • Polygon2D
        • Roi2D
        • Roi3D
        • make_roi()
      • Spatial reference systems
        • BaseToCanonCnv
        • CanonToBaseCnv
        • CoordinateConverter
        • SpatialReference
        • get_scene_ref_frame()
        • srs_from_code()
        • srs_from_epsg()
        • version()
        • wkt_from_code()
        • wkt_from_epsg()
        • WktExportOptions
        • WktConvention
      • Calibration IO
        • unpack_camera_params()
  • Advanced topics
    • Control Points
      • Checkpoint vs Control Point
      • Definitions
        • Control point
        • Summary
        • MTP
        • GCP
  • OPF documentation for main dmodel types
  • Reference catalog
    • Capture practices
      • Thermal
      • Multispectral
    • Starter settings
      • 2D survey
      • 3D survey and 3D structure
      • Thermal IR
      • Multispectral and Ag RGB
      • PIX4Dcatch
    • Processing templates
      • Camera calibration
      • Point cloud densification
      • Orthomosaic
      • Gaussian splatting
      • Scalable 3D mesh
    • Supported Geoid Models
    • Stats messages
      • Common header
      • Calibration
      • Orthomosaic
      • DSM
      • DTM
      • Densification
      • Depth fusion
      • Point cloud alignment
      • Mesh texture
      • Scalable mesh
      • Standard mesh (header only)
      • Gaussian splatting
      • Gaussian splatting rasters
      • Sky segmentation
      • Exports
      • AutoGCP
      • Index map
      • OPF project I/O
pix4dvortex
  • PIX4Dengine SDK /
  • Version 2.21.1 /
  • None

© Copyright 2026 PIX4D SA.