""" Some ray datastructures. """ import random from dataclasses import dataclass from typing import Optional import torch from torchtyping import TensorType from pyrad.utils.misc import is_not_none @dataclass class PointSamples: """Samples in space. Args: positions (TensorType[..., 3]): XYZ locations directions (TensorType[..., 3]): Unit direction vector camera_indices (TensorType[..., 1]): Camera index valid_mask (TensorType[...]): Rays that are valid """ positions: TensorType[..., 3] directions: TensorType[..., 3] = None camera_indices: TensorType[..., 1] = None valid_mask: TensorType[...] = None def apply_masks(self) -> "PointSamples": """Use valid_mask to mask samples. Returns: PointSamples: New set of masked samples. """ if is_not_none(self.valid_mask): positions = self.positions[self.valid_mask] directions = self.directions[self.valid_mask] if is_not_none(self.directions) else self.directions camera_indices = ( self.camera_indices[self.valid_mask] if is_not_none(self.camera_indices) else self.camera_indices ) return PointSamples( positions=positions, directions=directions, camera_indices=camera_indices, ) return PointSamples( positions=self.positions, directions=self.directions, camera_indices=self.camera_indices, ) @dataclass class RaySamples: """Samples along a ray Args: positions (TensorType[..., 3]): XYZ locations directions (TensorType[..., 3]): Unit direction vector camera_indices (TensorType[..., 1]): Camera index valid_mask (TensorType[...]): Rays that are valid ts (TensorType[..., 1]): "time steps", distances along ray deltas )TensorType[..., 1]): "width" of each sample """ positions: TensorType[..., 3] directions: TensorType[..., 3] = None camera_indices: TensorType[..., 1] = None valid_mask: TensorType[...] = None ts: TensorType[..., 1] = None deltas: TensorType[..., 1] = None def to_point_samples(self) -> PointSamples: """Convert to PointSamples instance and return.""" # TODO: make this more interpretable return PointSamples( positions=self.positions, directions=self.directions, camera_indices=self.camera_indices, valid_mask=self.valid_mask, ) def get_weights(self, densities: TensorType[..., "num_samples", 1]) -> TensorType[..., "num_samples"]: """Return weights based on predicted densities Args: densities (TensorType[..., "num_samples", 1]): Predicted densities for samples along ray Returns: TensorType[..., "num_samples"]: Weights for each sample """ delta_density = self.deltas * densities[..., 0] alphas = 1 - torch.exp(-delta_density) # mip-nerf version of transmittance calculation: transmittance = torch.cumsum(delta_density[..., :-1], dim=-1) transmittance = torch.cat( [torch.zeros((*transmittance.shape[:1], 1)).to(densities.device), transmittance], axis=-1 ) transmittance = torch.exp(-transmittance) # [..., "num_samples"] # most nerf codebases do the following: # transmittance = torch.cat( # [torch.ones((*alphas.shape[:1], 1)).to(densities.device), 1.0 - alphas + 1e-10], dim=-1 # ) # transmittance = torch.cumprod(transmittance, dim=-1)[..., :-1] # [..., "num_samples"] weights = alphas * transmittance # [..., "num_samples"] return weights def set_valid_mask(self, valid_mask: TensorType[..., "num_samples"]) -> None: """Sets valid mask""" self.valid_mask = valid_mask @dataclass class RayBundle: """A bundle of ray parameters. Args: origins (TensorType[..., 3]): Ray origins (XYZ) directions (TensorType[..., 3]): Unit ray direction vector camera_indices (TensorType[..., 1]): Camera indices nears (TensorType[..., 1]): Distance along ray to start sampling fars (TensorType[..., 1]): Rays Distance along ray to stop sampling valid_mask (TensorType[...]): Rays that are valid """ origins: TensorType["num_rays", 3] directions: TensorType["num_rays", 3] camera_indices: Optional[TensorType["num_rays", 1]] = None nears: Optional[TensorType["num_rays"]] = None fars: Optional[TensorType["num_rays"]] = None valid_mask: Optional[TensorType["num_rays"]] = None def move_to_device(self, device: torch.device) -> None: """Move bundle data to a device. Args: device (torch.device): Device to move tensors to. """ self.origins = self.origins.to(device) self.directions = self.directions.to(device) if is_not_none(self.camera_indices): self.camera_indices = self.camera_indices.to(device) def set_camera_indices(self, camera_index: int) -> None: """Sets all of the the camera indices to a specific camera index. Args: camera_index (int): Camera index. """ self.camera_indices = torch.ones_like(self.origins[..., 0]).long() * camera_index def __len__(self): num_rays = torch.numel(self.origins) // self.origins.shape[-1] return num_rays def sample(self, num_rays: int) -> "RayBundle": """Returns a RayBundle as a subset of rays. Args: num_rays (int): Number of rays in output RayBundle Returns: RayBundle: RayBundle with subset of rays. """ assert num_rays <= len(self) indices = random.sample(range(len(self)), k=num_rays) return RayBundle( origins=self.origins[indices], directions=self.directions[indices], camera_indices=self.camera_indices[indices], ) def get_masked_ray_bundle(self, valid_mask: TensorType) -> "RayBundle": """Return a masked instance of the ray bundle. Args: valid_mask (TensorType): Mask of rays to keep. Returns: RayBundle: RayBundle of masked rays. """ return RayBundle( origins=self.origins[valid_mask], directions=self.directions[valid_mask], camera_indices=self.camera_indices[valid_mask] if is_not_none(self.camera_indices) else None, nears=self.nears[valid_mask] if is_not_none(self.nears) else None, fars=self.fars[valid_mask] if is_not_none(self.fars) else None, valid_mask=self.valid_mask[valid_mask] if is_not_none(self.valid_mask) else None, ) def get_row_major_sliced_ray_bundle(self, start_idx: int, end_idx: int) -> "RayBundle": """Flattens RayBundle and extracts chunk given start and end indicies. Args: start_idx (int): Start index of RayBundle chunk. end_idx (int): End index of RayBundle chunk. Returns: RayBundle: Flattened RayBundle with end_idx-start_idx rays. """ camera_indices = ( self.camera_indices.view(-1)[start_idx:end_idx] if not isinstance(self.camera_indices, type(None)) else None ) return RayBundle( origins=self.origins.view(-1, 3)[start_idx:end_idx], directions=self.directions.view(-1, 3)[start_idx:end_idx], camera_indices=camera_indices, ) def get_ray_samples(self, ts: TensorType[..., "num_samples"]) -> RaySamples: """Produces samples for each ray by projection points along the ray direction. Args: ts (TensorType[..., "num_samples"]): Distance from origin of sample points. Returns: RaySamples: Samples projected along ray. """ positions = self.origins[:, None] + ts[:, :, None] * self.directions[:, None] directions = self.directions.unsqueeze(1).repeat(1, positions.shape[1], 1) valid_mask = torch.ones_like(ts, dtype=torch.bool) dists = ts[..., 1:] - ts[..., :-1] dists = torch.cat([dists, dists[..., -1:]], -1) # [N_rays, N_samples] deltas = dists * torch.norm(self.directions[..., None, :], dim=-1) if is_not_none(self.camera_indices): camera_indices = self.camera_indices.unsqueeze(1).repeat(1, positions.shape[1]) else: camera_indices = None ray_samples = RaySamples( positions=positions, directions=directions, camera_indices=camera_indices, valid_mask=valid_mask, ts=ts, deltas=deltas, ) return ray_samples