Add Conversion jobs

python_sdk/docs/specifications/cs_tiler.rst

@@ -0,0 +1,37 @@
+==================
+ContextScene Tiler
+==================
+
+The *ContextScene Tiler* job allows you to transform a part of a ContextScene to 3D Tiles for viewing purposes.
+
+.. contents:: Quick access
+   :local:
+   :depth: 2
+
+Examples
+========
+
+In this example, we will create a specification for submitting a ContextScene Tiler job tiling Cameras.
+
+.. literalinclude:: examples/cs_tiler_specs.py
+  :language: Python
+
+Classes
+=======
+
+.. currentmodule:: reality_capture.specifications.cs_tiler
+
+.. autopydantic_model:: ContextSceneTilerSpecificationsCreate
+
+.. autopydantic_model:: ContextSceneTilerSpecifications
+
+.. autopydantic_model:: CSTilerInputs
+    :model-show-json: False
+
+.. autopydantic_model:: CSTilerOptions
+    :model-show-json: False
+
+.. autoclass:: CSObject
+    :show-inheritance:
+    :members:
+    :undoc-members:

python_sdk/docs/specifications/examples/cs_tiler_specs.py

@@ -0,0 +1,7 @@
+from reality_capture.specifications.cs_tiler import (ContextSceneTilerSpecificationsCreate, CSTilerInputs,
+                                                     CSTilerOptions, CSObject)
+
+inputs = CSTilerInputs(scene="dbad181b-5079-4224-8561-96ad218bcfc9")
+options = CSTilerOptions(objectToTile=CSObject.CAMERAS)
+
+specs = ContextSceneTilerSpecificationsCreate(inputs=inputs, options=options)

python_sdk/docs/specifications/examples/mesh_sampling_specs.py

@@ -0,0 +1,7 @@
+from reality_capture.specifications.mesh_sampling import (MeshSamplingSpecificationsCreate, MeshSamplingInputs,
+                                                          MeshSamplingOptions, MeshSamplingFormat)
+
+inputs = MeshSamplingInputs(meshes=["dbad181b-5079-4224-8561-96ad218bcfc9", "ea881e3e-b0e3-4b23-bc3f-4ee8e9acdf61"])
+options = MeshSamplingOptions(outputFormat=MeshSamplingFormat.THREE_D_TILES_GLBC)
+
+specs = MeshSamplingSpecificationsCreate(inputs=inputs, options=options)

python_sdk/docs/specifications/examples/pc_conv_specs.py

@@ -0,0 +1,8 @@
+from reality_capture.specifications.point_cloud_conversion import (PointCloudConversionSpecificationsCreate,
+                                                                   PCConversionInputs, PCConversionOptions,
+                                                                   PCConversionFormat)
+
+inputs = PCConversionInputs(pointCloud="e3e12e4f-9fe0-4169-9571-41ecebd8c229")
+options = PCConversionOptions(format=PCConversionFormat.LAS)
+
+specs = PointCloudConversionSpecificationsCreate(inputs=inputs, options=options)

python_sdk/docs/specifications/examples/pc_optim_specs.py

@@ -0,0 +1,9 @@
+from reality_capture.specifications.point_cloud_optimization import (PCOptimizationSpecificationsCreate,
+                                                                     PCOptimizationFormat, PCOptimizationInputs,
+                                                                     PCOptimizationOptions)
+
+inputs = PCOptimizationInputs(pointClouds=["dbad181b-5079-4224-8561-96ad218bcfc9",
+                                           "ea881e3e-b0e3-4b23-bc3f-4ee8e9acdf61"])
+options = PCOptimizationOptions(outputFormat=PCOptimizationFormat.THREE_D_TILES_GLBC)
+
+specs = PCOptimizationSpecificationsCreate(inputs=inputs, options=options)

python_sdk/docs/specifications/examples/tm_optimization.py

@@ -0,0 +1,9 @@
+from reality_capture.specifications.tile_map_optimization import (TileMapOptimizationSpecificationsCreate,
+                                                                  TileMapOptimizationInputs, TileMapOptimizationOptions,
+                                                                  TileMapOptimizationFormat)
+
+inputs = TileMapOptimizationInputs(tileMaps=["dbad181b-5079-4224-8561-96ad218bcfc9",
+                                             "ea881e3e-b0e3-4b23-bc3f-4ee8e9acdf61"])
+options = TileMapOptimizationOptions(format=TileMapOptimizationFormat.XYZ_TILE_MAP, backgroundColor="#000000")
+
+specs = TileMapOptimizationSpecificationsCreate(inputs=inputs, options=options)

python_sdk/docs/specifications/examples/vector_optim.py

@@ -0,0 +1,9 @@
+from reality_capture.specifications.vector_optimization import (VectorOptimizationSpecificationsCreate,
+                                                                VectorOptimizationInputs, VectorOptimizationOptions,
+                                                                VectorOptimizationFormat)
+
+inputs = VectorOptimizationInputs(vectors=["dbad181b-5079-4224-8561-96ad218bcfc9",
+                                           "ea881e3e-b0e3-4b23-bc3f-4ee8e9acdf61"])
+options = VectorOptimizationOptions(format=VectorOptimizationFormat.FEATURE_DB, featureClassDisplayName="Road")
+
+specs = VectorOptimizationSpecificationsCreate(inputs=inputs, options=options)

python_sdk/docs/specifications/index.rst

@@ -34,7 +34,12 @@ Specifications regroup all the settings used to create jobs with our APIs.
     eval_s3d
     eval_sortho
     clearance
-
+    pc_conversion
+    pc_optimization
+    mesh_sampling
+    tile_map_optimization
+    vector_optimization
+    cs_tiler
 
 Modeling
 ========
@@ -61,10 +66,15 @@ Analysis
 * :doc:`/specifications/eval_o2d`, :doc:`/specifications/eval_o3d`, :doc:`/specifications/eval_s2d`, :doc:`/specifications/eval_s3d` and :doc:`/specifications/eval_sortho` will compare a prediction to a reference for a specific detection.
 * :doc:`/specifications/clearance` uses a 3D model and a footprint to compute clearance information.
 
-.. Conversion
-.. ==========
+Conversion
+==========
 
-.. * :doc:`/specifications/point_cloud_conversion` will convert point clouds from one format to another.
+* :doc:`/specifications/pc_conversion` will convert a single point cloud from one format to another.
+* :doc:`/specifications/pc_optimization` will consolidate multiple point cloud to a given format.
+* :doc:`/specifications/mesh_sampling` will sample meshes and consolidate them to a given format.
+* :doc:`/specifications/tile_map_optimization` will consolidate tile maps to a given format.
+* :doc:`/specifications/vector_optimization` will consolidate vector data to a given format.
+* :doc:`/specifications/cs_tiler` will transform a ContextScene to a 3D Tile tileset.
 
 Utilities
 =========

python_sdk/docs/specifications/mesh_sampling.rst

@@ -0,0 +1,37 @@
+=============
+Mesh sampling
+=============
+
+The *mesh sampling* job takes one or multiple reality data meshes as an input and will sample and consolidate them into a single point cloud.
+
+.. contents:: Quick access
+   :local:
+   :depth: 2
+
+Examples
+========
+
+In this example, we create a specification for submitting a mesh sampling job to 3D Tiles format:
+
+.. literalinclude:: examples/mesh_sampling_specs.py
+  :language: Python
+
+Classes
+=======
+
+.. currentmodule:: reality_capture.specifications.mesh_sampling
+
+.. autopydantic_model:: MeshSamplingSpecificationsCreate
+
+.. autopydantic_model:: MeshSamplingSpecifications
+
+.. autopydantic_model:: MeshSamplingInputs
+    :model-show-json: False
+
+.. autopydantic_model:: MeshSamplingOptions
+    :model-show-json: False
+
+.. autoclass:: MeshSamplingFormat
+    :show-inheritance:
+    :members:
+    :undoc-members:

python_sdk/docs/specifications/pc_conversion.rst

@@ -0,0 +1,38 @@
+======================
+Point cloud conversion
+======================
+
+The *point cloud conversion* job takes a reality data point cloud as an input and will convert it in the selected format.
+Should multiple point clouds be present in the reality data, each point cloud will be converted to a different file.
+
+.. contents:: Quick access
+   :local:
+   :depth: 2
+
+Examples
+========
+
+In this example, we create a specification for submitting a point cloud conversion job to LAS format:
+
+.. literalinclude:: examples/pc_conv_specs.py
+  :language: Python
+
+Classes
+=======
+
+.. currentmodule:: reality_capture.specifications.point_cloud_conversion
+
+.. autopydantic_model:: PointCloudConversionSpecificationsCreate
+
+.. autopydantic_model:: PointCloudConversionSpecifications
+
+.. autopydantic_model:: PCConversionInputs
+    :model-show-json: False
+
+.. autopydantic_model:: PCConversionOptions
+    :model-show-json: False
+
+.. autoclass:: PCConversionFormat
+    :show-inheritance:
+    :members:
+    :undoc-members:

python_sdk/docs/specifications/pc_optimization.rst

@@ -0,0 +1,37 @@
+========================
+Point cloud optimization
+========================
+
+The *point cloud optimization* job takes one or multiple reality data point cloud as an input and will consolidate them into a single point cloud.
+
+.. contents:: Quick access
+   :local:
+   :depth: 2
+
+Examples
+========
+
+In this example, we create a specification for submitting a point cloud optimization job to 3D Tiles format:
+
+.. literalinclude:: examples/pc_optim_specs.py
+  :language: Python
+
+Classes
+=======
+
+.. currentmodule:: reality_capture.specifications.point_cloud_optimization
+
+.. autopydantic_model:: PCOptimizationSpecificationsCreate
+
+.. autopydantic_model:: PCOptimizationSpecifications
+
+.. autopydantic_model:: PCOptimizationInputs
+    :model-show-json: False
+
+.. autopydantic_model:: PCOptimizationOptions
+    :model-show-json: False
+
+.. autoclass:: PCOptimizationFormat
+    :show-inheritance:
+    :members:
+    :undoc-members:

python_sdk/docs/specifications/tile_map_optimization.rst

@@ -0,0 +1,42 @@
+=====================
+Tile map optimization
+=====================
+
+The *tile map optimization* job takes one or multiple reality data tile maps as an input and will consolidate them into a single tile map.
+
+.. contents:: Quick access
+   :local:
+   :depth: 2
+
+Examples
+========
+
+In this example, we create a specification for submitting a tile map optimization job to XYZ format:
+
+.. literalinclude:: examples/tm_optimization.py
+  :language: Python
+
+Classes
+=======
+
+.. currentmodule:: reality_capture.specifications.tile_map_optimization
+
+.. autopydantic_model:: TileMapOptimizationSpecificationsCreate
+
+.. autopydantic_model:: TileMapOptimizationSpecifications
+
+.. autopydantic_model:: TileMapOptimizationInputs
+    :model-show-json: False
+
+.. autopydantic_model:: TileMapOptimizationOptions
+    :model-show-json: False
+
+.. autoclass:: TileMapOptimizationFormat
+    :show-inheritance:
+    :members:
+    :undoc-members:
+
+.. autoclass:: TileMapImageFormat
+    :show-inheritance:
+    :members:
+    :undoc-members:

python_sdk/docs/specifications/vector_optimization.rst

@@ -0,0 +1,37 @@
+===================
+Vector optimization
+===================
+
+The *vector optimization* job takes one or multiple reality data vectors as an input and will consolidate them into a vector data.
+
+.. contents:: Quick access
+   :local:
+   :depth: 2
+
+Examples
+========
+
+In this example, we create a specification for submitting a vector optimization job to the Bentley Feature Database:
+
+.. literalinclude:: examples/vector_optim.py
+  :language: Python
+
+Classes
+=======
+
+.. currentmodule:: reality_capture.specifications.vector_optimization
+
+.. autopydantic_model:: VectorOptimizationSpecificationsCreate
+
+.. autopydantic_model:: VectorOptimizationSpecifications
+
+.. autopydantic_model:: VectorOptimizationInputs
+    :model-show-json: False
+
+.. autopydantic_model:: VectorOptimizationOptions
+    :model-show-json: False
+
+.. autoclass:: VectorOptimizationFormat
+    :show-inheritance:
+    :members:
+    :undoc-members: