Publish pyopf (#14)

Co-authored-by: pix4d_concourse_developers <[email protected]>

CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [Unreleased]
+
+### Added
+### Changed
+### Fixed
+### Removed
+
+## 1.4.0
+
+### Added
+
+- Added the functionality for `opf2nerf` to output the `avg_pos` and `scale` when using with `--nerfstudio`.
+- Added the original resources to the metadata of resolved project items.
+
+### Fixed
+
+- Version check for compatibility.
+
 ## 1.3.1
 
 ### Fixed

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pyopf"
-version = "1.3.1"
+version = "1.4.0"
 description = "Python library for I/O and manipulation of projects under the Open Photogrammetry Format (OPF)"
 authors = [
     "Pix4D",

src/opf_tools/opf2nerf/converter.py

@@ -174,14 +174,9 @@ def rescale_position(
     transforms_train: dict,
     transforms_test: dict,
     avg_pos: np.ndarray,
-    max_pos: np.ndarray,
-    min_pos: np.ndarray,
-    cam_aabb_size: float,
+    scale: float,
 ) -> None:
     """Rescale and center so all cameras fit in a cube bounding box of edge length cam_aabb_size centered in [0, 0, 0]."""
-    scale = np.max(max_pos - min_pos)
-    scale /= cam_aabb_size
-
     for transforms in [transforms_train, transforms_test]:
         for frame in transforms["frames"]:
             transform_matrix = np.asarray(frame["transform_matrix"])
@@ -250,13 +245,20 @@ def generate_nerf_transforms(
         pbar.set_postfix_str(os.path.basename(image_path) + "->" + assigned_msg)
 
     avg_pos /= len(project.calibration.calibrated_cameras.cameras)
+    scale = np.max(max_pos - min_pos) / user_config["camera_aabb_size"]
+
+    if user_config["nerfstudio"]:
+        # if the conversion is under nerfstudio format, the average positions
+        # of the cameras & scale of the scene are saved in the transforms.json
+        # file to transform back to the original coordinates.
+        transforms_train["avg_pos"] = avg_pos.tolist()
+        transforms_train["scale"] = scale
+
     rescale_position(
         transforms_train,
         transforms_test,
         avg_pos,
-        max_pos,
-        min_pos,
-        user_config["camera_aabb_size"],
+        scale,
     )
 
     return transforms_train, transforms_test

src/pyopf/VersionInfo.py

@@ -82,10 +82,14 @@ def parse(cls, version: str):
         return cls(major, minor, prerelease)
 
     def compatible_with(self, other):
-        if self.major != other.major or self.prerelease != other.prerelease:
+        # self is the version of the file we read
+        # other is the version of the reader code
+        if self.major != other.major:
             return False
         if self.major > 0:
-            if self.prerelease is not None and self.minor != other.minor:
+            if other.prerelease is not None and (
+                self.minor != other.minor or self.prerelease != other.prerelease
+            ):
                 return False
         elif self.major == 0 and self.minor != other.minor:
             return False

src/pyopf/project/metadata.py

@@ -4,7 +4,13 @@
 
 from ..VersionInfo import VersionInfo
 from ..versions import FormatVersion
-from .project import Generator, ProjectItem, ProjectItemType, ProjectSource
+from .project import (
+    Generator,
+    ProjectItem,
+    ProjectItemType,
+    ProjectResource,
+    ProjectSource,
+)
 
 
 class Sources:
@@ -20,6 +26,7 @@ class Metadata:
     name: Optional[str] = None
     labels: Optional[list[str]] = None
     sources: Union[list[ProjectSource], Sources] = field(default_factory=list)
+    resources: list[ProjectResource] = field(default_factory=list)
     """The object sources. This may contain an object with named attributes
     pointing to the sources or a list of ProjectSources"""
 
@@ -31,6 +38,7 @@ def from_item(item: ProjectItem) -> "Metadata":
             type=item.type,
             labels=item.labels,
             sources=item.sources,
+            resources=item.resources,
         )
 
     def raw_sources(self) -> list[ProjectSource]: