Merge pull request #7 from VolumeGraphics/mixed_project_support

Add mixed project support, unify different project types

Author: hxgn-jk

README.md

@@ -45,6 +45,8 @@ that point into a [vg-data] folder using the same name as the .xvgi file will be
 the [vg-data] folder next to the .xvgi file when it is loaded. Organizing and referencing data this way ensures that
 .xvgi files and their associated [vg-data] folder can be moved and copied around easily.
 
+![Image](docs/images/folder_and_file.png)
+
 # Using .xvgi files
 VG software products starting from 2025.1 version are able to load these files, and support their use in
  * Open
@@ -63,9 +65,6 @@ data.
 > myVGL can not open .xvgi files. A licensed application needs to be used to turn the .xvgi file into a .vgl file, which
 > can then be viewed in myVGL in the usual way.
 
-
-![Image](docs/images/folder_and_file.png)
-
 # Requirements
 
 Requires Python 3.9 or newer.

examples/manual_setup/manual_setup.py

@@ -4,10 +4,14 @@
 import shutil
 from pathlib import Path
 
-from vg_nde_sdk.projects import VolumeProjectDescription
+from vg_nde_sdk.projects import ProjectDescription
 from vg_nde_sdk.sections import (
     ComponentInfoSection,
     ManufacturerInfoSection,
+    MeshFormat,
+    MeshSection,
+    MeshSectionHolder,
+    MeshUnit,
     ScanInfoSection,
     Vector3f,
     Vector3i,
@@ -19,6 +23,7 @@
     VolumeSection,
     VolumeSectionHolder,
 )
+from vg_nde_sdk.sections.mesh import MeshMetaInfoContainer
 from vg_nde_sdk.serializers import xvgi
 
 THIS_DIR = Path(__file__).parent
@@ -37,6 +42,12 @@ def main():
         volumeFilePath,
     )
 
+    meshFilePath = targetVGDataFolderPath / "engine.stl"
+    shutil.copy(
+        os.path.dirname(os.path.abspath(__file__)) + "\\..\\meshes\\data\\engine.stl",
+        meshFilePath,
+    )
+
     block_section = VolumeFileSection(
         FileName=volumeFilePath,
         FileFileFormat=VolumeFileFormat.Gzip,
@@ -67,7 +78,7 @@ def main():
         ),
     )
 
-    project = VolumeProjectDescription(
+    project = ProjectDescription(
         volumes=VolumeSectionHolder(
             [
                 VolumeSection(
@@ -78,6 +89,16 @@ def main():
                 )
             ]
         ),
+        meshes=MeshSectionHolder(
+            [
+                MeshSection(
+                    FileName=meshFilePath,
+                    MeshFormat=MeshFormat.STL,
+                    MeshUnit=MeshUnit.Millimeter,
+                    MetaInfo=MeshMetaInfoContainer(),
+                )
+            ]
+        ),
     )
 
     writer = xvgi.XVGIWriter()

tests/serializers/xvgi/test_vge_mesh.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from vg_nde_sdk.projects import MeshProjectDescription
+from vg_nde_sdk.projects import ProjectDescription
 from vg_nde_sdk.sections import (
     MeshFormat,
     MeshSection,
@@ -16,8 +16,8 @@
 
 
 @pytest.fixture()
-def mesh_project_description(tmpdir: Path) -> MeshProjectDescription:
-    return MeshProjectDescription(
+def mesh_project_description(tmpdir: Path) -> ProjectDescription:
+    return ProjectDescription(
         meshes=MeshSectionHolder(
             [
                 MeshSection(FileName=Path("data/vgcube/cubeMesh.stl")),
@@ -41,7 +41,7 @@ def mesh_project_description(tmpdir: Path) -> MeshProjectDescription:
 
 
 def test_serialize_mesh_project(
-    mesh_project_description: MeshProjectDescription, tmpdir: Path
+    mesh_project_description: ProjectDescription, tmpdir: Path
 ):
     # GIVEN a mesh and a serializer
     writer = XVGIWriter()
@@ -54,7 +54,7 @@ def test_serialize_mesh_project(
 
 
 def test_serialize_mesh_project_to_file(
-    mesh_project_description: MeshProjectDescription, tmpdir: Path
+    mesh_project_description: ProjectDescription, tmpdir: Path
 ):
     # GIVEN a mesh and a serializer
     output_dir = Path(tmpdir, "output")

tests/serializers/xvgi/test_vge_reconstruction.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from vg_nde_sdk.projects import ReconstructionProjectDescription
+from vg_nde_sdk.projects import ProjectDescription
 from vg_nde_sdk.sections import (
     ComponentInfoSection,
     ManufacturerInfoSection,
@@ -57,8 +57,8 @@
 @pytest.fixture()
 def reconstruction_project_description(
     tmpdir: Path,
-) -> ReconstructionProjectDescription:
-    project = ReconstructionProjectDescription(
+) -> ProjectDescription:
+    project = ProjectDescription(
         reconstructions=ReconstructionSectionHolder(
             reconstructions=[
                 ReconstructionSection(
@@ -240,7 +240,7 @@ def reconstruction_project_description(
 
 
 def test_serialize_reconstruction_project(
-    reconstruction_project_description: ReconstructionProjectDescription, tmpdir: Path
+    reconstruction_project_description: ProjectDescription, tmpdir: Path
 ):
     # GIVEN a project and a serializer
     writer = XVGIWriter()
@@ -253,7 +253,7 @@ def test_serialize_reconstruction_project(
 
 
 def test_serialize_reconstruction_project_to_file(
-    reconstruction_project_description: ReconstructionProjectDescription, tmpdir: Path
+    reconstruction_project_description: ProjectDescription, tmpdir: Path
 ):
     # GIVEN a project and a serializer
     output_dir = Path(tmpdir, "output")

tests/serializers/xvgi/test_vge_volume.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from vg_nde_sdk.projects import VolumeProjectDescription
+from vg_nde_sdk.projects import ProjectDescription
 from vg_nde_sdk.sections import (
     ComponentInfoSection,
     ManufacturerInfoSection,
@@ -19,8 +19,8 @@
 
 
 @pytest.fixture()
-def volume_project_description(tmpdir: Path) -> VolumeProjectDescription:
-    project = VolumeProjectDescription(
+def volume_project_description(tmpdir: Path) -> ProjectDescription:
+    project = ProjectDescription(
         volumes=VolumeSectionHolder(
             [
                 VolumeSection(
@@ -81,7 +81,7 @@ def volume_project_description(tmpdir: Path) -> VolumeProjectDescription:
 
 
 def test_serialize_volume_project(
-    volume_project_description: VolumeProjectDescription, tmpdir: Path
+    volume_project_description: ProjectDescription, tmpdir: Path
 ):
     # GIVEN a volume and a serializer
     writer = XVGIWriter()
@@ -94,7 +94,7 @@ def test_serialize_volume_project(
 
 
 def test_serialize_volume_project_to_file(
-    volume_project_description: VolumeProjectDescription, tmpdir: Path
+    volume_project_description: ProjectDescription, tmpdir: Path
 ):
     # GIVEN a volume and a serializer
     output_dir = Path(tmpdir, "output")

vg_nde_sdk/__init__.py

@@ -1,8 +1,7 @@
 """Project generation SDK."""
 
-from .projects import (
-    ReconstructionProjectDescription,
-    VolumeProjectDescription,
+from .projects import ProjectDescription
+from .projecttools import (
     make_mesh_project,
     make_reconstruction_project_from_projections,
     make_volume_project_from_block,

vg_nde_sdk/projects/__init__.py

@@ -1,5 +1,3 @@
 """Project types."""
 
-from .mesh import *  # noqa
-from .reconstruction import *  # noqa
-from .volume import *  # noqa
+from .project import ProjectDescription

vg_nde_sdk/projects/project.py

@@ -0,0 +1,22 @@
+"""Volume project description."""
+
+from dataclasses import dataclass, field
+
+from vg_nde_sdk.sections import (
+    MeshSectionHolder,
+    ReconstructionSectionHolder,
+    VersionSection,
+    VolumeSectionHolder,
+)
+
+
+@dataclass
+class ProjectDescription:
+    """Mixed project description."""
+
+    version: VersionSection = field(default_factory=VersionSection)
+    volumes: VolumeSectionHolder = field(default_factory=VolumeSectionHolder)
+    meshes: MeshSectionHolder = field(default_factory=MeshSectionHolder)
+    reconstructions: ReconstructionSectionHolder = field(
+        default_factory=ReconstructionSectionHolder
+    )

vg_nde_sdk/projecttools/__init__.py

@@ -0,0 +1,5 @@
+"""Project tools."""
+
+from .mesh import make_mesh_project
+from .reconstruction import make_reconstruction_project_from_projections
+from .volume import make_volume_project_from_block, make_volume_project_from_slices

vg_nde_sdk/projects/mesh.py vg_nde_sdk/projecttools/mesh.pyvg_nde_sdk/projects/mesh.py renamed to vg_nde_sdk/projecttools/mesh.py

@@ -1,40 +1,31 @@
 """Volume project description."""
 
-from dataclasses import dataclass, field
 from pathlib import Path
 
+from vg_nde_sdk.projects import ProjectDescription
 from vg_nde_sdk.sections import (
     ComponentInfoSection,
     MeshFormat,
     MeshSection,
     MeshSectionHolder,
     MeshUnit,
     Vector3f,
-    VersionSection,
 )
 from vg_nde_sdk.sections.mesh import MeshMetaInfoContainer
 
 
-@dataclass
-class MeshProjectDescription:
-    """Volume project description."""
-
-    version: VersionSection = field(default_factory=VersionSection)
-    meshes: MeshSectionHolder = field(default_factory=MeshSectionHolder)
-
-
 def make_mesh_project(
     mesh: Path,
     mesh_format: MeshFormat,
     mesh_unit: MeshUnit,
     mesh_info: ComponentInfoSection,
     mesh_translation: Vector3f = Vector3f(0, 0, 0),  # noqa: B008
     mesh_rotation: Vector3f = Vector3f(0, 0, 0),  # noqa: B008
-) -> MeshProjectDescription:
+) -> ProjectDescription:
     """Generate minimal volume project description for a slice stack."""
     meta_infos = MeshMetaInfoContainer(ComponentInfo=mesh_info)
 
-    project = MeshProjectDescription(
+    project = ProjectDescription(
         meshes=MeshSectionHolder(
             [
                 MeshSection(