4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 10:34:29 +08:00
nerfstudio/nerfactory/models/modules/ray_generator.py
evonneng d50c71ac43
update docstrings and random cleanups (#387)
* fixing docstrings and small nits; up to fileds

* finished adding and fixing docstrings
2022-09-10 23:09:44 -07:00

55 lines
1.8 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.
"""
Ray generator.
"""
from torch import nn
from torchtyping import TensorType
from nerfactory.cameras.cameras import Cameras
from nerfactory.cameras.rays import RayBundle
class RayGenerator(nn.Module):
"""torch.nn Module for generating rays.
This class will store the intrinsics and extrinsics parameters of the cameras.
Args:
cameras: Camera objects containing camera info
"""
def __init__(self, cameras: Cameras) -> None:
super().__init__()
self.cameras = cameras
self.image_coords = nn.Parameter(cameras.get_image_coords(), requires_grad=False)
def forward(self, ray_indices: TensorType["num_rays", 3]) -> RayBundle:
"""Index into the cameras to generate the rays.
Args:
ray_indices: Contains camera, row, and col indicies for target rays.
"""
c = ray_indices[:, 0] # camera indices
y = ray_indices[:, 1] # row indices
x = ray_indices[:, 2] # col indices
coords = self.image_coords[y, x]
ray_bundle = self.cameras.generate_rays(
camera_indices=c,
coords=coords,
)
ray_bundle.camera_indices = c[..., None] # ["num_rays",1]
return ray_bundle