4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 18:44:21 +08:00
nerfstudio/nerfactory/data/structs.py
2022-07-30 15:38:08 -07:00

156 lines
4.9 KiB
Python

# Copyright 2022 The Plenoptix Team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Dataset input structures.
"""
from dataclasses import dataclass
from typing import Dict, List, Optional, Union
import torch
from torchtyping import TensorType
from nerfactory.cameras.rays import RayBundle
@dataclass
class PointCloud:
"""Dataclass for a point cloud."""
xyz: TensorType["num_points", 3] = None
rgb: TensorType["num_points", 3] = None
@dataclass
class Semantics:
"""Dataclass for semantic labels."""
stuff_filenames: List[str]
stuff_classes: List[str]
thing_filenames: List[str]
thing_classes: List[str]
stuff_colors: torch.Tensor
thing_colors: torch.Tensor
@dataclass
class SceneBounds:
"""Data to represent the scene bounds.
Attributes:
aabb: axis-aligned bounding box.
aabb[0] is the minimum (x,y,z) point.
aabb[1] is the maximum (x,y,z) point.
"""
aabb: TensorType[2, 3] = None
def get_diagonal_length(self):
"""Returns the longest diagonal length."""
diff = self.aabb[1] - self.aabb[0]
length = torch.sqrt((diff**2).sum() + 1e-20)
return length
def get_center(self):
"""Returns the center of the box."""
diff = self.aabb[1] - self.aabb[0]
return self.aabb[0] + diff / 2.0
def get_centered_and_scaled_scene_bounds(self, scale_factor: Union[float, torch.Tensor] = 1.0):
"""Returns a new box that has been shifted and rescaled to be centered
about the origin."""
return SceneBounds(aabb=(self.aabb - self.get_center()) * scale_factor)
@staticmethod
def get_normalized_positions(positions: TensorType[..., 3], aabb: TensorType[2, 3]):
"""Return normalized positions in range [0, 1] based on the aabb axis-aligned bounding box.
Args:
positions: the xyz positions
aabb: the axis-aligned bounding box
Returns:
positions that are normalized into the range [0, 1].
"""
aabb_lengths = aabb[1] - aabb[0]
normalized_positions = (positions - aabb[0]) / aabb_lengths
return normalized_positions
def to_json(self) -> Dict:
"""Returns a json object from the Python object."""
return {"type": "aabb", "min_point": self.aabb[0].tolist(), "max_point": self.aabb[1].tolist()}
@staticmethod
def from_json(json_: Dict) -> "SceneBounds":
"""Returns the an instance of SceneBounds from a json dictionary."""
assert json_["type"] == "aabb"
aabb = torch.tensor([json_[0], json_[1]])
return SceneBounds(aabb=aabb)
@dataclass
class DatasetInputs:
"""Dataset inputs for the image dataset and the ray generator.
Args:
image_filenames: Filenames for the images.
...
"""
image_filenames: List[str]
intrinsics: torch.Tensor
camera_to_world: torch.Tensor
downscale_factor: int = 1
mask_filenames: Optional[List[str]] = None
depth_filenames: Optional[List[str]] = None
scene_bounds: SceneBounds = SceneBounds()
semantics: Optional[Semantics] = None
point_cloud: PointCloud = PointCloud()
alpha_color: Optional[TensorType[3]] = None
def check_inputs(self):
"""Check the inputs to make sure everything is okay."""
assert self.intrinsics.dtype == torch.float32
assert self.camera_to_world.dtype == torch.float32
def save_to_folder_name(self, data_directory: str):
"""Save the dataset inputs."""
raise NotImplementedError
def load_from_folder_name(self, data_directory: str):
"""Load the saved dataset inputs."""
raise NotImplementedError
def as_dict(self) -> dict:
"""Returns the dataclass as a dictionary."""
return vars(self)
@dataclass
class BaseDataContainer:
"""A container for data that is not specific to any dataset. It should be everything
needed by the renderer and loss calculation. Different datasets and models will probably
need to subclass from this differently, since different Field modules will require different
data.
Args:
rays (RayBundle): The rays for the image.
ground_truth_pixels (TensorType["num_pixels", 3]): The ground truth pixels for the image.
"""
rays: RayBundle # Raybundle and the cameras will be merged into one thing in a later PR
cameras: torch.Tensor
ground_truth_pixels: Optional[TensorType["num_pixels", 3]] = None