File size: 46,947 Bytes
853e22b |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 |
# Copyright (c) MONAI Consortium
# 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.
from __future__ import annotations
import warnings
from functools import lru_cache, partial
from types import ModuleType
from typing import Any, Iterable, Sequence
import numpy as np
import torch
from monai.config import NdarrayOrTensor, NdarrayTensor
from monai.transforms.croppad.dictionary import CropForegroundD
from monai.transforms.utils import distance_transform_edt as monai_distance_transform_edt
from monai.utils import (
MetricReduction,
convert_to_cupy,
convert_to_dst_type,
convert_to_numpy,
convert_to_tensor,
deprecated_arg,
deprecated_arg_default,
ensure_tuple_rep,
look_up_option,
optional_import,
)
binary_erosion, _ = optional_import("scipy.ndimage.morphology", name="binary_erosion")
distance_transform_edt, _ = optional_import("scipy.ndimage.morphology", name="distance_transform_edt")
distance_transform_cdt, _ = optional_import("scipy.ndimage.morphology", name="distance_transform_cdt")
__all__ = [
"ignore_background",
"do_metric_reduction",
"get_mask_edges",
"get_surface_distance",
"is_binary_tensor",
"remap_instance_id",
"prepare_spacing",
"get_code_to_measure_table",
]
def ignore_background(y_pred: NdarrayTensor, y: NdarrayTensor) -> tuple[NdarrayTensor, NdarrayTensor]:
"""
This function is used to remove background (the first channel) for `y_pred` and `y`.
Args:
y_pred: predictions. As for classification tasks,
`y_pred` should has the shape [BN] where N is larger than 1. As for segmentation tasks,
the shape should be [BNHW] or [BNHWD].
y: ground truth, the first dim is batch.
"""
y = y[:, 1:] if y.shape[1] > 1 else y # type: ignore[assignment]
y_pred = y_pred[:, 1:] if y_pred.shape[1] > 1 else y_pred # type: ignore[assignment]
return y_pred, y
def do_metric_reduction(
f: torch.Tensor, reduction: MetricReduction | str = MetricReduction.MEAN
) -> tuple[torch.Tensor | Any, torch.Tensor]:
"""
This function is to do the metric reduction for calculated `not-nan` metrics of each sample's each class.
The function also returns `not_nans`, which counts the number of not nans for the metric.
Args:
f: a tensor that contains the calculated metric scores per batch and
per class. The first two dims should be batch and class.
reduction: define the mode to reduce metrics, will only apply reduction on `not-nan` values,
available reduction modes: {``"none"``, ``"mean"``, ``"sum"``, ``"mean_batch"``, ``"sum_batch"``,
``"mean_channel"``, ``"sum_channel"``}, default to ``"mean"``.
if "none", return the input f tensor and not_nans.
Raises:
ValueError: When ``reduction`` is not one of
["mean", "sum", "mean_batch", "sum_batch", "mean_channel", "sum_channel" "none"].
"""
# some elements might be Nan (if ground truth y was missing (zeros))
# we need to account for it
nans = torch.isnan(f)
not_nans = ~nans
t_zero = torch.zeros(1, device=f.device, dtype=torch.float)
reduction = look_up_option(reduction, MetricReduction)
if reduction == MetricReduction.NONE:
return f, not_nans.float()
f[nans] = 0
if reduction == MetricReduction.MEAN:
# 2 steps, first, mean by channel (accounting for nans), then by batch
not_nans = not_nans.sum(dim=1).float()
f = torch.where(not_nans > 0, f.sum(dim=1).float() / not_nans, t_zero) # channel average
not_nans = (not_nans > 0).sum(dim=0).float()
f = torch.where(not_nans > 0, f.sum(dim=0).float() / not_nans, t_zero) # batch average
elif reduction == MetricReduction.SUM:
not_nans = not_nans.sum(dim=[0, 1]).float()
f = torch.sum(f, dim=[0, 1]) # sum over the batch and channel dims
elif reduction == MetricReduction.MEAN_BATCH:
not_nans = not_nans.sum(dim=0).float()
f = torch.where(not_nans > 0, f.sum(dim=0).float() / not_nans, t_zero) # batch average
elif reduction == MetricReduction.SUM_BATCH:
not_nans = not_nans.sum(dim=0).float()
f = f.sum(dim=0).float() # the batch sum
elif reduction == MetricReduction.MEAN_CHANNEL:
not_nans = not_nans.sum(dim=1).float()
f = torch.where(not_nans > 0, f.sum(dim=1).float() / not_nans, t_zero) # channel average
elif reduction == MetricReduction.SUM_CHANNEL:
not_nans = not_nans.sum(dim=1).float()
f = f.sum(dim=1).float() # the channel sum
elif reduction != MetricReduction.NONE:
raise ValueError(
f"Unsupported reduction: {reduction}, available options are "
'["mean", "sum", "mean_batch", "sum_batch", "mean_channel", "sum_channel" "none"].'
)
return f, not_nans
@deprecated_arg_default(
name="always_return_as_numpy", since="1.3.0", replaced="1.5.0", old_default=True, new_default=False
)
@deprecated_arg(
name="always_return_as_numpy",
since="1.5.0",
removed="1.7.0",
msg_suffix="The option is removed and the return type will always be equal to the input type.",
)
def get_mask_edges(
seg_pred: NdarrayOrTensor,
seg_gt: NdarrayOrTensor,
label_idx: int = 1,
crop: bool = True,
spacing: Sequence | None = None,
always_return_as_numpy: bool = True,
) -> tuple[NdarrayTensor, NdarrayTensor]:
"""
Compute edges from binary segmentation masks. This
function is helpful to further calculate metrics such as Average Surface
Distance and Hausdorff Distance.
The input images can be binary or labelfield images. If labelfield images
are supplied, they are converted to binary images using `label_idx`.
In order to improve the computing efficiency, before getting the edges,
the images can be cropped and only keep the foreground if not specifies
``crop = False``.
We require that images are the same size, and assume that they occupy the
same space (spacing, orientation, etc.).
Args:
seg_pred: the predicted binary or labelfield image.
seg_gt: the actual binary or labelfield image.
label_idx: for labelfield images, convert to binary with
`seg_pred = seg_pred == label_idx`.
crop: crop input images and only keep the foregrounds. In order to
maintain two inputs' shapes, here the bounding box is achieved
by ``(seg_pred | seg_gt)`` which represents the union set of two
images. Defaults to ``True``.
spacing: the input spacing. If not None, the subvoxel edges and areas will be computed.
otherwise `scipy`'s binary erosion is used to calculate the edges.
always_return_as_numpy: whether to a numpy array regardless of the input type.
If False, return the same type as inputs.
"""
# move in the funciton to avoid using all the GPUs
cucim_binary_erosion, has_cucim_binary_erosion = optional_import("cucim.skimage.morphology", name="binary_erosion")
if seg_pred.shape != seg_gt.shape:
raise ValueError(f"seg_pred and seg_gt should have same shapes, got {seg_pred.shape} and {seg_gt.shape}.")
converter: Any
lib: ModuleType
if isinstance(seg_pred, torch.Tensor) and not always_return_as_numpy:
converter = partial(convert_to_tensor, device=seg_pred.device)
lib = torch
else:
converter = convert_to_numpy
lib = np
use_cucim = (
spacing is None
and has_cucim_binary_erosion
and isinstance(seg_pred, torch.Tensor)
and seg_pred.device.type == "cuda"
)
# If not binary images, convert them
if seg_pred.dtype not in (bool, torch.bool):
seg_pred = seg_pred == label_idx
if seg_gt.dtype not in (bool, torch.bool):
seg_gt = seg_gt == label_idx
if crop:
or_vol = seg_pred | seg_gt
if not or_vol.any():
pred, gt = lib.zeros(seg_pred.shape, dtype=bool), lib.zeros(seg_gt.shape, dtype=bool)
return (pred, gt) if spacing is None else (pred, gt, pred, gt)
channel_first = [seg_pred[None], seg_gt[None], or_vol[None]]
if spacing is None and not use_cucim: # cpu only erosion
seg_pred, seg_gt, or_vol = convert_to_tensor(channel_first, device="cpu", dtype=bool)
else: # pytorch subvoxel, maybe on gpu, but croppad boolean values on GPU is not supported
seg_pred, seg_gt, or_vol = convert_to_tensor(channel_first, dtype=torch.float16)
cropper = CropForegroundD(
["pred", "gt"], source_key="src", margin=1, allow_smaller=False, start_coord_key=None, end_coord_key=None
)
cropped = cropper({"pred": seg_pred, "gt": seg_gt, "src": or_vol}) # type: ignore
seg_pred, seg_gt = cropped["pred"][0], cropped["gt"][0]
if spacing is None: # Do binary erosion and use XOR to get edges
if not use_cucim:
seg_pred, seg_gt = convert_to_numpy([seg_pred, seg_gt], dtype=bool)
edges_pred = binary_erosion(seg_pred) ^ seg_pred
edges_gt = binary_erosion(seg_gt) ^ seg_gt
else:
seg_pred, seg_gt = convert_to_cupy([seg_pred, seg_gt], dtype=bool) # type: ignore[arg-type]
edges_pred = cucim_binary_erosion(seg_pred) ^ seg_pred
edges_gt = cucim_binary_erosion(seg_gt) ^ seg_gt
return converter((edges_pred, edges_gt), dtype=bool) # type: ignore
code_to_area_table, k = get_code_to_measure_table(spacing, device=seg_pred.device) # type: ignore
spatial_dims = len(spacing)
conv = torch.nn.functional.conv3d if spatial_dims == 3 else torch.nn.functional.conv2d
vol = torch.stack([seg_pred[None], seg_gt[None]], dim=0).float() # type: ignore
code_pred, code_gt = conv(vol, k.to(vol))
# edges
all_ones = len(code_to_area_table) - 1
edges_pred = (code_pred != 0) & (code_pred != all_ones)
edges_gt = (code_gt != 0) & (code_gt != all_ones)
# areas of edges
areas_pred = torch.index_select(code_to_area_table, 0, code_pred.view(-1).int()).reshape(code_pred.shape)
areas_gt = torch.index_select(code_to_area_table, 0, code_gt.view(-1).int()).reshape(code_gt.shape)
ret = (edges_pred[0], edges_gt[0], areas_pred[0], areas_gt[0])
return converter(ret, wrap_sequence=False) # type: ignore
def get_surface_distance(
seg_pred: NdarrayOrTensor,
seg_gt: NdarrayOrTensor,
distance_metric: str = "euclidean",
spacing: int | float | np.ndarray | Sequence[int | float] | None = None,
) -> NdarrayOrTensor:
"""
This function is used to compute the surface distances from `seg_pred` to `seg_gt`.
Args:
seg_pred: the edge of the predictions.
seg_gt: the edge of the ground truth.
distance_metric: : [``"euclidean"``, ``"chessboard"``, ``"taxicab"``]
the metric used to compute surface distance. Defaults to ``"euclidean"``.
- ``"euclidean"``, uses Exact Euclidean distance transform.
- ``"chessboard"``, uses `chessboard` metric in chamfer type of transform.
- ``"taxicab"``, uses `taxicab` metric in chamfer type of transform.
spacing: spacing of pixel (or voxel). This parameter is relevant only if ``distance_metric`` is set to ``"euclidean"``.
Several input options are allowed:
(1) If a single number, isotropic spacing with that value is used.
(2) If a sequence of numbers, the length of the sequence must be equal to the image dimensions.
(3) If ``None``, spacing of unity is used. Defaults to ``None``.
Note:
If seg_pred or seg_gt is all 0, may result in nan/inf distance.
"""
lib: ModuleType = torch if isinstance(seg_pred, torch.Tensor) else np
if not seg_gt.any():
dis = np.inf * lib.ones_like(seg_gt, dtype=lib.float32)
else:
if not lib.any(seg_pred):
dis = np.inf * lib.ones_like(seg_gt, dtype=lib.float32)
dis = dis[seg_gt]
return convert_to_dst_type(dis, seg_pred, dtype=dis.dtype)[0]
if distance_metric == "euclidean":
dis = monai_distance_transform_edt((~seg_gt)[None, ...], sampling=spacing)[0] # type: ignore
elif distance_metric in {"chessboard", "taxicab"}:
dis = distance_transform_cdt(convert_to_numpy(~seg_gt), metric=distance_metric)
else:
raise ValueError(f"distance_metric {distance_metric} is not implemented.")
dis = convert_to_dst_type(dis, seg_pred, dtype=lib.float32)[0]
return dis[seg_pred] # type: ignore
def get_edge_surface_distance(
y_pred: torch.Tensor,
y: torch.Tensor,
distance_metric: str = "euclidean",
spacing: int | float | np.ndarray | Sequence[int | float] | None = None,
use_subvoxels: bool = False,
symmetric: bool = False,
class_index: int = -1,
) -> tuple[
tuple[torch.Tensor, torch.Tensor],
tuple[torch.Tensor, torch.Tensor] | tuple[torch.Tensor],
tuple[torch.Tensor, torch.Tensor] | tuple[()],
]:
"""
This function is used to compute the surface distance from `y_pred` to `y` using the edges of the masks.
Args:
y_pred: the predicted binary or labelfield image. Expected to be in format (H, W[, D]).
y: the actual binary or labelfield image. Expected to be in format (H, W[, D]).
distance_metric: : [``"euclidean"``, ``"chessboard"``, ``"taxicab"``]
See :py:func:`monai.metrics.utils.get_surface_distance`.
spacing: spacing of pixel (or voxel). This parameter is relevant only if ``distance_metric`` is set to ``"euclidean"``.
See :py:func:`monai.metrics.utils.get_surface_distance`.
use_subvoxels: whether to use subvoxel resolution (using the spacing).
This will return the areas of the edges.
symmetric: whether to compute the surface distance from `y_pred` to `y` and from `y` to `y_pred`.
class_index: The class-index used for context when warning about empty ground truth or prediction.
Returns:
(edges_pred, edges_gt), (distances_pred_to_gt, [distances_gt_to_pred]), (areas_pred, areas_gt) | tuple()
"""
edges_spacing = None
if use_subvoxels:
edges_spacing = spacing if spacing is not None else ([1] * len(y_pred.shape))
(edges_pred, edges_gt, *areas) = get_mask_edges(
y_pred, y, crop=True, spacing=edges_spacing, always_return_as_numpy=False
)
if not edges_gt.any():
warnings.warn(
f"the ground truth of class {class_index if class_index != -1 else 'Unknown'} is all 0,"
" this may result in nan/inf distance."
)
if not edges_pred.any():
warnings.warn(
f"the prediction of class {class_index if class_index != -1 else 'Unknown'} is all 0,"
" this may result in nan/inf distance."
)
distances: tuple[torch.Tensor, torch.Tensor] | tuple[torch.Tensor]
if symmetric:
distances = (
get_surface_distance(edges_pred, edges_gt, distance_metric, spacing),
get_surface_distance(edges_gt, edges_pred, distance_metric, spacing),
) # type: ignore
else:
distances = (get_surface_distance(edges_pred, edges_gt, distance_metric, spacing),) # type: ignore
return convert_to_tensor(((edges_pred, edges_gt), distances, tuple(areas)), device=y_pred.device) # type: ignore[no-any-return]
def is_binary_tensor(input: torch.Tensor, name: str) -> None:
"""Determines whether the input tensor is torch binary tensor or not.
Args:
input (torch.Tensor): tensor to validate.
name (str): name of the tensor being checked.
Raises:
ValueError: if `input` is not a PyTorch Tensor.
Note:
A warning message is printed, if the tensor is not binary.
"""
if not isinstance(input, torch.Tensor):
raise ValueError(f"{name} must be of type PyTorch Tensor.")
if not torch.all(input.byte() == input) or input.max() > 1 or input.min() < 0:
warnings.warn(f"{name} should be a binarized tensor.")
def remap_instance_id(pred: torch.Tensor, by_size: bool = False) -> torch.Tensor:
"""
This function is used to rename all instance id of `pred`, so that the id is
contiguous.
For example: all ids of the input can be [0, 1, 2] rather than [0, 2, 5].
This function is helpful for calculating metrics like Panoptic Quality (PQ).
The implementation refers to:
https://github.com/vqdang/hover_net
Args:
pred: segmentation predictions in the form of torch tensor. Each
value of the tensor should be an integer, and represents the prediction of its corresponding instance id.
by_size: if True, largest instance will be assigned a smaller id.
"""
pred_id: Iterable[Any] = list(pred.unique())
# the original implementation has the limitation that if there is no 0 in pred, error will happen
pred_id = [i for i in pred_id if i != 0]
if not pred_id:
return pred
if by_size:
instance_size = [(pred == instance_id).sum() for instance_id in pred_id]
pair_data = zip(pred_id, instance_size)
pair_list = sorted(pair_data, key=lambda x: x[1], reverse=True)
pred_id, _ = zip(*pair_list)
new_pred = torch.zeros_like(pred, dtype=torch.int)
for idx, instance_id in enumerate(pred_id):
new_pred[pred == instance_id] = idx + 1
return new_pred
def prepare_spacing(
spacing: int | float | np.ndarray | Sequence[int | float | np.ndarray | Sequence[int | float]] | None,
batch_size: int,
img_dim: int,
) -> Sequence[None | int | float | np.ndarray | Sequence[int | float]]:
"""
This function is used to prepare the `spacing` parameter to include batch dimension for the computation of
surface distance, hausdorff distance or surface dice.
An example with batch_size = 4 and img_dim = 3:
input spacing = None -> output spacing = [None, None, None, None]
input spacing = 0.8 -> output spacing = [0.8, 0.8, 0.8, 0.8]
input spacing = [0.8, 0.5, 0.9] -> output spacing = [[0.8, 0.5, 0.9], [0.8, 0.5, 0.9], [0.8, 0.5, 0.9], [0.8, 0.5, 0.9]]
input spacing = [0.8, 0.7, 1.2, 0.8] -> output spacing = [0.8, 0.7, 1.2, 0.8] (same as input)
An example with batch_size = 3 and img_dim = 3:
input spacing = [0.8, 0.5, 0.9] ->
output spacing = [[0.8, 0.5, 0.9], [0.8, 0.5, 0.9], [0.8, 0.5, 0.9], [0.8, 0.5, 0.9]]
Args:
spacing: can be a float, a sequence of length `img_dim`, or a sequence with length `batch_size`
that includes floats or sequences of length `img_dim`.
Raises:
ValueError: when `spacing` is a sequence of sequence, where the outer sequence length does not
equal `batch_size` or inner sequence length does not equal `img_dim`.
Returns:
spacing: a sequence with length `batch_size` that includes integers, floats or sequences of length `img_dim`.
"""
if spacing is None or isinstance(spacing, (int, float)):
return list([spacing] * batch_size)
if isinstance(spacing, (Sequence, np.ndarray)):
if any(not isinstance(s, type(spacing[0])) for s in list(spacing)):
raise ValueError(f"if `spacing` is a sequence, its elements should be of same type, got {spacing}.")
if isinstance(spacing[0], (Sequence, np.ndarray)):
if len(spacing) != batch_size:
raise ValueError(
"if `spacing` is a sequence of sequences, "
f"the outer sequence should have same length as batch size ({batch_size}), got {spacing}."
)
if any(len(s) != img_dim for s in list(spacing)):
raise ValueError(
"each element of `spacing` list should either have same length as"
f"image dim ({img_dim}), got {spacing}."
)
if not all(isinstance(i, (int, float)) for s in list(spacing) for i in list(s)):
raise ValueError(
f"if `spacing` is a sequence of sequences or 2D np.ndarray, "
f"the elements should be integers or floats, got {spacing}."
)
return list(spacing)
if isinstance(spacing[0], (int, float)):
if len(spacing) != img_dim:
raise ValueError(
f"if `spacing` is a sequence of numbers, "
f"it should have same length as image dim ({img_dim}), got {spacing}."
)
return [spacing for _ in range(batch_size)] # type: ignore
raise ValueError(f"`spacing` is a sequence of elements with unsupported type: {type(spacing[0])}")
raise ValueError(
f"`spacing` should either be a number, a sequence of numbers or a sequence of sequences, got {spacing}."
)
ENCODING_KERNEL = {2: [[8, 4], [2, 1]], 3: [[[128, 64], [32, 16]], [[8, 4], [2, 1]]]}
@lru_cache(maxsize=None)
def _get_neighbour_code_to_normals_table(device=None):
"""
returns a lookup table. For every binary neighbour code (2x2x2 neighbourhood = 8 neighbours = 8 bits = 256 codes)
it contains the surface normals of the triangles. The length of the normal vector encodes the surfel area.
Adapted from https://github.com/deepmind/surface-distance
created using the marching_cube algorithm see e.g. https://en.wikipedia.org/wiki/Marching_cubes
Args:
device: torch device to use for the table.
"""
zeros = [0.0, 0.0, 0.0]
ret = [
[zeros, zeros, zeros, zeros],
[[0.125, 0.125, 0.125], zeros, zeros, zeros],
[[-0.125, -0.125, 0.125], zeros, zeros, zeros],
[[-0.25, -0.25, 0.0], [0.25, 0.25, -0.0], zeros, zeros],
[[0.125, -0.125, 0.125], zeros, zeros, zeros],
[[-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], zeros, zeros],
[[0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[0.5, 0.0, -0.0], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125], zeros],
[[-0.125, 0.125, 0.125], zeros, zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, 0.125, 0.125], zeros, zeros],
[[-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], zeros, zeros],
[[0.5, 0.0, 0.0], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.25, -0.25, 0.0], [0.25, -0.25, 0.0], zeros, zeros],
[[0.5, 0.0, 0.0], [0.25, -0.25, 0.25], [-0.125, 0.125, -0.125], zeros],
[[-0.5, 0.0, 0.0], [-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[0.5, 0.0, 0.0], [0.5, 0.0, 0.0], zeros, zeros],
[[0.125, -0.125, -0.125], zeros, zeros, zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], zeros, zeros],
[[-0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.0, -0.5, 0.0], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125], zeros],
[[0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.0, 0.0, -0.5], [0.25, 0.25, 0.25], [-0.125, -0.125, -0.125], zeros],
[[-0.125, -0.125, 0.125], [0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros],
[[-0.125, -0.125, -0.125], [-0.25, -0.25, -0.25], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125]],
[[-0.125, 0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], [0.125, -0.125, -0.125], zeros],
[[0.125, 0.125, 0.125], [0.375, 0.375, 0.375], [0.0, -0.25, 0.25], [-0.25, 0.0, 0.25]],
[[0.125, -0.125, -0.125], [0.25, -0.25, 0.0], [0.25, -0.25, 0.0], zeros],
[[0.375, 0.375, 0.375], [0.0, 0.25, -0.25], [-0.125, -0.125, -0.125], [-0.25, 0.25, 0.0]],
[[-0.5, 0.0, 0.0], [-0.125, -0.125, -0.125], [-0.25, -0.25, -0.25], [0.125, 0.125, 0.125]],
[[-0.5, 0.0, 0.0], [-0.125, -0.125, -0.125], [-0.25, -0.25, -0.25], zeros],
[[0.125, -0.125, 0.125], zeros, zeros, zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.0, -0.25, 0.25], [0.0, 0.25, -0.25], zeros, zeros],
[[0.0, -0.5, 0.0], [0.125, 0.125, -0.125], [0.25, 0.25, -0.25], zeros],
[[0.125, -0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.125, -0.125, 0.125], [-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], zeros],
[[0.0, -0.25, 0.25], [0.0, 0.25, -0.25], [0.125, -0.125, 0.125], zeros],
[[-0.375, -0.375, 0.375], [-0.0, 0.25, 0.25], [0.125, 0.125, -0.125], [-0.25, -0.0, -0.25]],
[[-0.125, 0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [-0.125, 0.125, 0.125], zeros],
[[-0.0, 0.0, 0.5], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.25, 0.25, -0.25], [0.25, 0.25, -0.25], [0.125, 0.125, -0.125], [-0.125, -0.125, 0.125]],
[[0.125, -0.125, 0.125], [0.25, -0.25, 0.0], [0.25, -0.25, 0.0], zeros],
[[0.5, 0.0, 0.0], [0.25, -0.25, 0.25], [-0.125, 0.125, -0.125], [0.125, -0.125, 0.125]],
[[0.0, 0.25, -0.25], [0.375, -0.375, -0.375], [-0.125, 0.125, 0.125], [0.25, 0.25, 0.0]],
[[-0.5, 0.0, 0.0], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], zeros, zeros],
[[0.0, 0.5, 0.0], [-0.25, 0.25, 0.25], [0.125, -0.125, -0.125], zeros],
[[0.0, 0.5, 0.0], [0.125, -0.125, 0.125], [-0.25, 0.25, -0.25], zeros],
[[0.0, 0.5, 0.0], [0.0, -0.5, 0.0], zeros, zeros],
[[0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], [0.125, -0.125, 0.125], zeros],
[[-0.375, -0.375, -0.375], [-0.25, 0.0, 0.25], [-0.125, -0.125, -0.125], [-0.25, 0.25, 0.0]],
[[0.125, 0.125, 0.125], [0.0, -0.5, 0.0], [-0.25, -0.25, -0.25], [-0.125, -0.125, -0.125]],
[[0.0, -0.5, 0.0], [-0.25, -0.25, -0.25], [-0.125, -0.125, -0.125], zeros],
[[-0.125, 0.125, 0.125], [0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], zeros],
[[0.0, 0.5, 0.0], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125]],
[[-0.375, 0.375, -0.375], [-0.25, -0.25, 0.0], [-0.125, 0.125, -0.125], [-0.25, 0.0, 0.25]],
[[0.0, 0.5, 0.0], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125], zeros],
[[0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], [0.25, -0.25, 0.0], [0.25, -0.25, 0.0]],
[[-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], [-0.125, -0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], zeros],
[[-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], zeros, zeros],
[[-0.125, -0.125, 0.125], zeros, zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[-0.125, -0.125, 0.125], [-0.25, -0.25, 0.0], [0.25, 0.25, -0.0], zeros],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], zeros, zeros],
[[0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], zeros],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.375, -0.375, 0.375], [0.0, -0.25, -0.25], [-0.125, 0.125, -0.125], [0.25, 0.25, 0.0]],
[[-0.125, -0.125, 0.125], [-0.125, 0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], [-0.125, 0.125, 0.125], zeros],
[[-0.125, -0.125, 0.125], [-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], zeros],
[[0.5, 0.0, 0.0], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125]],
[[-0.0, 0.5, 0.0], [-0.25, 0.25, -0.25], [0.125, -0.125, 0.125], zeros],
[[-0.25, 0.25, -0.25], [-0.25, 0.25, -0.25], [-0.125, 0.125, -0.125], [-0.125, 0.125, -0.125]],
[[-0.25, 0.0, -0.25], [0.375, -0.375, -0.375], [0.0, 0.25, -0.25], [-0.125, 0.125, 0.125]],
[[0.5, 0.0, 0.0], [-0.25, 0.25, -0.25], [0.125, -0.125, 0.125], zeros],
[[-0.25, 0.0, 0.25], [0.25, 0.0, -0.25], zeros, zeros],
[[-0.0, 0.0, 0.5], [-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[-0.125, -0.125, 0.125], [-0.25, 0.0, 0.25], [0.25, 0.0, -0.25], zeros],
[[-0.25, -0.0, -0.25], [-0.375, 0.375, 0.375], [-0.25, -0.25, 0.0], [-0.125, 0.125, 0.125]],
[[0.0, 0.0, -0.5], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125], zeros],
[[-0.0, 0.0, 0.5], [0.0, 0.0, 0.5], zeros, zeros],
[[0.125, 0.125, 0.125], [0.125, 0.125, 0.125], [0.25, 0.25, 0.25], [0.0, 0.0, 0.5]],
[[0.125, 0.125, 0.125], [0.25, 0.25, 0.25], [0.0, 0.0, 0.5], zeros],
[[-0.25, 0.0, 0.25], [0.25, 0.0, -0.25], [-0.125, 0.125, 0.125], zeros],
[[-0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], [0.125, -0.125, 0.125]],
[[-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], [0.25, 0.0, -0.25]],
[[0.125, -0.125, 0.125], [0.25, 0.0, 0.25], [0.25, 0.0, 0.25], zeros],
[[0.25, 0.0, 0.25], [-0.375, -0.375, 0.375], [-0.25, 0.25, 0.0], [-0.125, -0.125, 0.125]],
[[-0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [0.25, 0.0, 0.25], [0.25, 0.0, 0.25], zeros],
[[0.25, 0.0, 0.25], [0.25, 0.0, 0.25], zeros, zeros],
[[-0.125, -0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, -0.125, 0.125], zeros],
[[-0.125, -0.125, 0.125], [0.0, -0.25, 0.25], [0.0, 0.25, -0.25], zeros],
[[0.0, -0.5, 0.0], [0.125, 0.125, -0.125], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125]],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], [0.125, -0.125, 0.125], zeros],
[[0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], [0.125, -0.125, 0.125]],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], [0.0, -0.25, 0.25], [0.0, 0.25, -0.25]],
[[0.0, 0.25, 0.25], [0.0, 0.25, 0.25], [0.125, -0.125, -0.125], zeros],
[[-0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], zeros],
[[-0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, 0.125, 0.125]],
[[-0.0, 0.0, 0.5], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125]],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros],
[[-0.0, 0.5, 0.0], [-0.25, 0.25, -0.25], [0.125, -0.125, 0.125], [0.125, -0.125, 0.125]],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], [0.125, 0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.5, 0.0, -0.0], [0.25, -0.25, -0.25], [0.125, -0.125, -0.125], zeros],
[[-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], [-0.25, 0.25, 0.25], [0.125, -0.125, -0.125]],
[[0.375, -0.375, 0.375], [0.0, 0.25, 0.25], [-0.125, 0.125, -0.125], [-0.25, 0.0, 0.25]],
[[0.0, -0.5, 0.0], [-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[-0.375, -0.375, 0.375], [0.25, -0.25, 0.0], [0.0, 0.25, 0.25], [-0.125, -0.125, 0.125]],
[[-0.125, 0.125, 0.125], [-0.25, 0.25, 0.25], [0.0, 0.0, 0.5], zeros],
[[0.125, 0.125, 0.125], [0.0, 0.25, 0.25], [0.0, 0.25, 0.25], zeros],
[[0.0, 0.25, 0.25], [0.0, 0.25, 0.25], zeros, zeros],
[[0.5, 0.0, -0.0], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125], [0.125, 0.125, 0.125]],
[[0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, 0.125, 0.125], zeros],
[[-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], [0.125, 0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[-0.25, -0.25, 0.0], [0.25, 0.25, -0.0], [0.125, 0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], [0.125, 0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], zeros, zeros, zeros],
[[0.125, 0.125, 0.125], zeros, zeros, zeros],
[[0.125, 0.125, 0.125], [0.125, 0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[-0.25, -0.25, 0.0], [0.25, 0.25, -0.0], [0.125, 0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], [0.125, 0.125, 0.125], zeros],
[[0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, 0.125, 0.125], zeros],
[[0.5, 0.0, -0.0], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125], [0.125, 0.125, 0.125]],
[[0.0, 0.25, 0.25], [0.0, 0.25, 0.25], zeros, zeros],
[[0.125, 0.125, 0.125], [0.0, 0.25, 0.25], [0.0, 0.25, 0.25], zeros],
[[-0.125, 0.125, 0.125], [-0.25, 0.25, 0.25], [0.0, 0.0, 0.5], zeros],
[[-0.375, -0.375, 0.375], [0.25, -0.25, 0.0], [0.0, 0.25, 0.25], [-0.125, -0.125, 0.125]],
[[0.0, -0.5, 0.0], [-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[0.375, -0.375, 0.375], [0.0, 0.25, 0.25], [-0.125, 0.125, -0.125], [-0.25, 0.0, 0.25]],
[[-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], [-0.25, 0.25, 0.25], [0.125, -0.125, -0.125]],
[[0.5, 0.0, -0.0], [0.25, -0.25, -0.25], [0.125, -0.125, -0.125], zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], [0.125, 0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros],
[[-0.0, 0.5, 0.0], [-0.25, 0.25, -0.25], [0.125, -0.125, 0.125], [0.125, -0.125, 0.125]],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros],
[[-0.0, 0.0, 0.5], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125]],
[[-0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, 0.125, 0.125]],
[[-0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], zeros],
[[0.0, 0.25, 0.25], [0.0, 0.25, 0.25], [0.125, -0.125, -0.125], zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], [0.0, 0.25, 0.25], [0.0, 0.25, 0.25]],
[[0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], [0.125, -0.125, 0.125]],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], [0.125, -0.125, 0.125], zeros],
[[0.0, -0.5, 0.0], [0.125, 0.125, -0.125], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125]],
[[-0.125, -0.125, 0.125], [0.0, -0.25, 0.25], [0.0, 0.25, -0.25], zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], [0.125, -0.125, 0.125], zeros],
[[-0.125, -0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.25, 0.0, 0.25], [0.25, 0.0, 0.25], zeros, zeros],
[[0.125, 0.125, 0.125], [0.25, 0.0, 0.25], [0.25, 0.0, 0.25], zeros],
[[-0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], zeros],
[[0.25, 0.0, 0.25], [-0.375, -0.375, 0.375], [-0.25, 0.25, 0.0], [-0.125, -0.125, 0.125]],
[[0.125, -0.125, 0.125], [0.25, 0.0, 0.25], [0.25, 0.0, 0.25], zeros],
[[-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], [0.25, 0.0, 0.25], [0.25, 0.0, 0.25]],
[[-0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], [0.125, -0.125, 0.125]],
[[-0.25, 0.0, 0.25], [0.25, 0.0, -0.25], [-0.125, 0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [0.25, 0.25, 0.25], [0.0, 0.0, 0.5], zeros],
[[0.125, 0.125, 0.125], [0.125, 0.125, 0.125], [0.25, 0.25, 0.25], [0.0, 0.0, 0.5]],
[[-0.0, 0.0, 0.5], [0.0, 0.0, 0.5], zeros, zeros],
[[0.0, 0.0, -0.5], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125], zeros],
[[-0.25, -0.0, -0.25], [-0.375, 0.375, 0.375], [-0.25, -0.25, 0.0], [-0.125, 0.125, 0.125]],
[[-0.125, -0.125, 0.125], [-0.25, 0.0, 0.25], [0.25, 0.0, -0.25], zeros],
[[-0.0, 0.0, 0.5], [-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[-0.25, 0.0, 0.25], [0.25, 0.0, -0.25], zeros, zeros],
[[0.5, 0.0, 0.0], [-0.25, 0.25, -0.25], [0.125, -0.125, 0.125], zeros],
[[-0.25, 0.0, -0.25], [0.375, -0.375, -0.375], [0.0, 0.25, -0.25], [-0.125, 0.125, 0.125]],
[[-0.25, 0.25, -0.25], [-0.25, 0.25, -0.25], [-0.125, 0.125, -0.125], [-0.125, 0.125, -0.125]],
[[-0.0, 0.5, 0.0], [-0.25, 0.25, -0.25], [0.125, -0.125, 0.125], zeros],
[[0.5, 0.0, 0.0], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125]],
[[-0.125, -0.125, 0.125], [-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], [-0.125, 0.125, 0.125], zeros],
[[-0.125, -0.125, 0.125], [-0.125, 0.125, 0.125], zeros, zeros],
[[0.375, -0.375, 0.375], [0.0, -0.25, -0.25], [-0.125, 0.125, -0.125], [0.25, 0.25, 0.0]],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.0, 0.0, 0.5], [0.25, -0.25, 0.25], [0.125, -0.125, 0.125], zeros],
[[0.0, -0.25, 0.25], [0.0, -0.25, 0.25], zeros, zeros],
[[-0.125, -0.125, 0.125], [-0.25, -0.25, 0.0], [0.25, 0.25, -0.0], zeros],
[[-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[-0.125, -0.125, 0.125], zeros, zeros, zeros],
[[-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], zeros, zeros],
[[0.125, 0.125, 0.125], [-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], zeros],
[[-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], [-0.125, -0.125, 0.125], zeros],
[[-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], [-0.25, -0.25, 0.0], [0.25, 0.25, -0.0]],
[[0.0, 0.5, 0.0], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125], zeros],
[[-0.375, 0.375, -0.375], [-0.25, -0.25, 0.0], [-0.125, 0.125, -0.125], [-0.25, 0.0, 0.25]],
[[0.0, 0.5, 0.0], [0.25, 0.25, -0.25], [-0.125, -0.125, 0.125], [-0.125, -0.125, 0.125]],
[[-0.125, 0.125, 0.125], [0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], zeros],
[[0.0, -0.5, 0.0], [-0.25, -0.25, -0.25], [-0.125, -0.125, -0.125], zeros],
[[0.125, 0.125, 0.125], [0.0, -0.5, 0.0], [-0.25, -0.25, -0.25], [-0.125, -0.125, -0.125]],
[[-0.375, -0.375, -0.375], [-0.25, 0.0, 0.25], [-0.125, -0.125, -0.125], [-0.25, 0.25, 0.0]],
[[0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], [0.125, -0.125, 0.125], zeros],
[[0.0, 0.5, 0.0], [0.0, -0.5, 0.0], zeros, zeros],
[[0.0, 0.5, 0.0], [0.125, -0.125, 0.125], [-0.25, 0.25, -0.25], zeros],
[[0.0, 0.5, 0.0], [-0.25, 0.25, 0.25], [0.125, -0.125, -0.125], zeros],
[[0.25, -0.25, 0.0], [-0.25, 0.25, 0.0], zeros, zeros],
[[-0.5, 0.0, 0.0], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.0, 0.25, -0.25], [0.375, -0.375, -0.375], [-0.125, 0.125, 0.125], [0.25, 0.25, 0.0]],
[[0.5, 0.0, 0.0], [0.25, -0.25, 0.25], [-0.125, 0.125, -0.125], [0.125, -0.125, 0.125]],
[[0.125, -0.125, 0.125], [0.25, -0.25, 0.0], [0.25, -0.25, 0.0], zeros],
[[0.25, 0.25, -0.25], [0.25, 0.25, -0.25], [0.125, 0.125, -0.125], [-0.125, -0.125, 0.125]],
[[-0.0, 0.0, 0.5], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], [-0.125, 0.125, 0.125], zeros],
[[-0.125, 0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[-0.375, -0.375, 0.375], [-0.0, 0.25, 0.25], [0.125, 0.125, -0.125], [-0.25, -0.0, -0.25]],
[[0.0, -0.25, 0.25], [0.0, 0.25, -0.25], [0.125, -0.125, 0.125], zeros],
[[0.125, -0.125, 0.125], [-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], zeros],
[[0.125, -0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.0, -0.5, 0.0], [0.125, 0.125, -0.125], [0.25, 0.25, -0.25], zeros],
[[0.0, -0.25, 0.25], [0.0, 0.25, -0.25], zeros, zeros],
[[0.125, 0.125, 0.125], [0.125, -0.125, 0.125], zeros, zeros],
[[0.125, -0.125, 0.125], zeros, zeros, zeros],
[[-0.5, 0.0, 0.0], [-0.125, -0.125, -0.125], [-0.25, -0.25, -0.25], zeros],
[[-0.5, 0.0, 0.0], [-0.125, -0.125, -0.125], [-0.25, -0.25, -0.25], [0.125, 0.125, 0.125]],
[[0.375, 0.375, 0.375], [0.0, 0.25, -0.25], [-0.125, -0.125, -0.125], [-0.25, 0.25, 0.0]],
[[0.125, -0.125, -0.125], [0.25, -0.25, 0.0], [0.25, -0.25, 0.0], zeros],
[[0.125, 0.125, 0.125], [0.375, 0.375, 0.375], [0.0, -0.25, 0.25], [-0.25, 0.0, 0.25]],
[[-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], [0.125, -0.125, -0.125], zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[-0.125, 0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[-0.125, -0.125, -0.125], [-0.25, -0.25, -0.25], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125]],
[[-0.125, -0.125, 0.125], [0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros],
[[0.0, 0.0, -0.5], [0.25, 0.25, 0.25], [-0.125, -0.125, -0.125], zeros],
[[0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.0, -0.5, 0.0], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125], zeros],
[[-0.125, -0.125, 0.125], [0.125, -0.125, -0.125], zeros, zeros],
[[0.0, -0.25, -0.25], [0.0, 0.25, 0.25], zeros, zeros],
[[0.125, -0.125, -0.125], zeros, zeros, zeros],
[[0.5, 0.0, 0.0], [0.5, 0.0, 0.0], zeros, zeros],
[[-0.5, 0.0, 0.0], [-0.25, 0.25, 0.25], [-0.125, 0.125, 0.125], zeros],
[[0.5, 0.0, 0.0], [0.25, -0.25, 0.25], [-0.125, 0.125, -0.125], zeros],
[[0.25, -0.25, 0.0], [0.25, -0.25, 0.0], zeros, zeros],
[[0.5, 0.0, 0.0], [-0.25, -0.25, 0.25], [-0.125, -0.125, 0.125], zeros],
[[-0.25, 0.0, 0.25], [-0.25, 0.0, 0.25], zeros, zeros],
[[0.125, 0.125, 0.125], [-0.125, 0.125, 0.125], zeros, zeros],
[[-0.125, 0.125, 0.125], zeros, zeros, zeros],
[[0.5, 0.0, -0.0], [0.25, 0.25, 0.25], [0.125, 0.125, 0.125], zeros],
[[0.125, -0.125, 0.125], [-0.125, -0.125, 0.125], zeros, zeros],
[[-0.25, -0.0, -0.25], [0.25, 0.0, 0.25], zeros, zeros],
[[0.125, 0.125, 0.125], zeros, zeros, zeros],
[[-0.25, -0.25, 0.0], [0.25, 0.25, -0.0], zeros, zeros],
[[0.125, 0.125, 0.125], zeros, zeros, zeros],
[[0.125, 0.125, 0.125], zeros, zeros, zeros],
[zeros, zeros, zeros, zeros],
]
return torch.as_tensor(ret, device=device)
def create_table_neighbour_code_to_surface_area(spacing_mm, device=None):
"""
Returns an array mapping neighbourhood code to the surface elements area.
Adapted from https://github.com/deepmind/surface-distance
Note that the normals encode the initial surface area. This function computes
the area corresponding to the given `spacing`.
Args:
spacing_mm: a sequence of 3 numbers. Voxel spacing along the first 3 spatial axes.
device: device to put the table on.
Returns:
An array of size 256, mapping neighbourhood code to the surface area.
ENCODING_KERNEL[3] which is the kernel used to compute the neighbourhood code.
"""
spacing_mm = ensure_tuple_rep(spacing_mm, 3)
# compute the area for all 256 possible surface elements given a 2x2x2 neighbourhood according to the spacing_mm
c = _get_neighbour_code_to_normals_table(device)
s = torch.as_tensor(
[[[spacing_mm[1] * spacing_mm[2], spacing_mm[0] * spacing_mm[2], spacing_mm[0] * spacing_mm[1]]]],
device=device,
dtype=c.dtype,
)
norm = torch.linalg.norm(c * s, dim=-1)
neighbour_code_to_surface_area = norm.sum(-1)
return neighbour_code_to_surface_area, torch.as_tensor([[ENCODING_KERNEL[3]]], device=device)
def create_table_neighbour_code_to_contour_length(spacing_mm, device=None):
"""
Returns an array mapping neighbourhood code to the contour length.
Adapted from https://github.com/deepmind/surface-distance
In 2D, each point has 4 neighbors. Thus, are 16 configurations. A
configuration is encoded with '1' meaning "inside the object" and '0' "outside
the object". For example,
"0101" and "1010" both encode an edge along the first spatial axis with length spacing[0] mm;
"0011" and "1100" both encode an edge along the second spatial axis with length spacing[1] mm.
Args:
spacing_mm: 2-element list-like structure. Pixel spacing along the 1st and 2nd spatial axes.
device: device to put the table on.
Returns:
A 16-element array mapping neighbourhood code to the contour length.
ENCODING_KERNEL[2] which is the kernel used to compute the neighbourhood code.
"""
spacing_mm = ensure_tuple_rep(spacing_mm, 2)
first, second = spacing_mm # spacing along the first and second spatial dimension respectively
diag = 0.5 * np.linalg.norm(spacing_mm)
neighbour_code_to_contour_length = np.zeros([16], dtype=diag.dtype)
neighbour_code_to_contour_length[int("0001", 2)] = diag
neighbour_code_to_contour_length[int("0010", 2)] = diag
neighbour_code_to_contour_length[int("0011", 2)] = second
neighbour_code_to_contour_length[int("0100", 2)] = diag
neighbour_code_to_contour_length[int("0101", 2)] = first
neighbour_code_to_contour_length[int("0110", 2)] = 2 * diag
neighbour_code_to_contour_length[int("0111", 2)] = diag
neighbour_code_to_contour_length[int("1000", 2)] = diag
neighbour_code_to_contour_length[int("1001", 2)] = 2 * diag
neighbour_code_to_contour_length[int("1010", 2)] = first
neighbour_code_to_contour_length[int("1011", 2)] = diag
neighbour_code_to_contour_length[int("1100", 2)] = second
neighbour_code_to_contour_length[int("1101", 2)] = diag
neighbour_code_to_contour_length[int("1110", 2)] = diag
neighbour_code_to_contour_length = convert_to_tensor(neighbour_code_to_contour_length, device=device)
return neighbour_code_to_contour_length, torch.as_tensor([[ENCODING_KERNEL[2]]], device=device)
def get_code_to_measure_table(spacing, device=None):
"""
returns a table mapping neighbourhood code to the surface area or contour length.
Args:
spacing: a sequence of 2 or 3 numbers, indicating the spacing in the spatial dimensions.
device: device to put the table on.
"""
spatial_dims = len(spacing)
spacing = ensure_tuple_rep(spacing, look_up_option(spatial_dims, (2, 3)))
if spatial_dims == 2:
return create_table_neighbour_code_to_contour_length(spacing, device)
return create_table_neighbour_code_to_surface_area(spacing, device)
|