base.py

from abc import abstractmethod
from typing import Tuple

import torch
import torch.nn as nn


class BaseRadianceField(nn.Module):
    """An abstract RadianceField class (supports both 2D and 3D).

    The key functions to be implemented are:
    - forward(positions, directions, masks): returns rgb and density.
    """

    def __init__(self, *args, **kwargs) -> None:
        super().__init__()

    @abstractmethod
    def forward(
        self,
        positions: torch.Tensor,
        directions: torch.Tensor = None,
        masks: torch.Tensor = None,
    ) -> Tuple[torch.Tensor, torch.Tensor]:
        """Returns {rgb, density}."""
        raise NotImplementedError()

    @abstractmethod
    def query_density(self, positions: torch.Tensor) -> torch.Tensor:
        """Returns {density}."""
        raise NotImplementedError()