From 47459f4be7a8f5672ffb21be99094fcbd9adac93 Mon Sep 17 00:00:00 2001
From: Matt Tancik <tancik@berkeley.edu>
Date: Wed, 30 Mar 2022 13:39:41 -0700
Subject: [PATCH] add encoding boilerplate

---
 nerf/encodings.py | 57 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 nerf/encodings.py

diff --git a/nerf/encodings.py b/nerf/encodings.py
new file mode 100644
index 000000000..e89cd60cc
--- /dev/null
+++ b/nerf/encodings.py
@@ -0,0 +1,57 @@
+"""
+Encoding functions
+"""
+from torch import nn
+from torchtyping import TensorType
+
+
+class Encoding(nn.Module):
+    """Encode an input tensor. Intended to be subclassed"""
+
+    def encode(self, in_tensor: TensorType[..., "input_dim"]) -> TensorType[..., "output_dim"]:
+        """Encodes an input tensor.
+
+        Args:
+            x (TensorType[..., "input_dim"]): Input tensor to be encoded
+
+        Returns:
+            TensorType[..., "output_dim"]: A encoded input tensor
+        """
+        raise NotImplementedError
+
+    def forward(self, in_tensor: TensorType[..., "input_dim"]) -> TensorType[..., "output_dim"]:
+        """Call forward"""
+        return self.encode(in_tensor)
+
+
+class RFFEncoding(Encoding):
+    """Random Fourier Feature encoding"""
+    def encode(self, in_tensor: TensorType[..., "input_dim"]) -> TensorType[..., "output_dim"]:
+        """Encodes an input tensor.
+
+        Args:
+            x (TensorType[..., "input_dim"]): Input tensor to be encoded
+
+        Returns:
+            TensorType[..., "output_dim"]: A encoded input tensor
+        """
+        raise NotImplementedError
+
+
+class HashEncoding(Encoding):
+    """Hash encoding"""
+    def encode(self, in_tensor: TensorType[..., "input_dim"]) -> TensorType[..., "output_dim"]:
+        """Encodes an input tensor.
+
+        Args:
+            x (TensorType[..., "input_dim"]): Input tensor to be encoded
+
+        Returns:
+            TensorType[..., "output_dim"]: A encoded input tensor
+        """
+        raise NotImplementedError
+
+encodings_dict = {
+    "RFF": RFFEncoding,
+    "hash": HashEncoding,
+}
\ No newline at end of file