freesurfer-surface/tests/test_vertex.py

# freesurfer-surface - Read and Write Surface Files in Freesurfer’s TriangularSurface Format
#
# Copyright (C) 2020 Fabian Peter Hammerle <fabian@hammerle.me>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import numpy
import pytest

from freesurfer_surface import Vertex


def test_init():
    vertex = Vertex(-4.0, 0.5, 21.42)
    assert isinstance(vertex, numpy.ndarray)
    assert vertex.right == pytest.approx(-4.0)
    assert vertex.anterior == pytest.approx(0.5)
    assert vertex.superior == pytest.approx(21.42)


def test_init_kwargs():
    vertex = Vertex(right=-4.0, superior=21.42, anterior=0.5)
    assert vertex.right == pytest.approx(-4.0)
    assert vertex.anterior == pytest.approx(0.5)
    assert vertex.superior == pytest.approx(21.42)


def test_repr():
    vertex = Vertex(right=-4.0, superior=21.42, anterior=0.5)
    assert repr(vertex) == "Vertex(right=-4.0, anterior=0.5, superior=21.42)"


def test_add():
    assert Vertex(-1.5, 4, 2) + Vertex(2, -4.5, 3) == pytest.approx(
        Vertex(0.5, -0.5, 5)
    )


def test_mult():
    assert Vertex(-1.5, 4, 2) * -3 == pytest.approx(Vertex(4.5, -12, -6))


def test_vars():
    attrs = vars(Vertex(-1.5, 4, 2))
    assert len(attrs) == 3
    assert attrs["right"] == pytest.approx(-1.5)
    assert attrs["anterior"] == pytest.approx(4)
    assert attrs["superior"] == pytest.approx(2)


@pytest.mark.parametrize(
    ("vertex_a", "vertex_b", "expected_distance_mm"),
    [
        (Vertex(0, 0, 0), Vertex(0, 0, 0), 0),
        (Vertex(0, 0, 0), Vertex(1, 0, 0), 1),
        (Vertex(0, 0, 0), Vertex(0, 1, 0), 1),
        (Vertex(0, 0, 0), Vertex(0, 0, 1), 1),
        (Vertex(0, 0, 0), Vertex(1, 1, 0), 2 ** (1 / 2)),
        (Vertex(0, 0, 0), Vertex(1, 1, 1), 3 ** (1 / 2)),
        (Vertex(1, 2, 3), Vertex(2, 3, 4), 3 ** (1 / 2)),
        (Vertex(1, 2, 3), Vertex(5, 8, -1), (16 + 36 + 16) ** (1 / 2)),
        (Vertex(0, 0, 0), [Vertex(0, 0, 1), Vertex(0, 0, 2)], [1, 2]),
        (Vertex(0, 0, 0), (Vertex(0, 0, 1), Vertex(0, 0, 2)), [1, 2]),
        (Vertex(0, 0, 0), numpy.vstack((Vertex(0, 0, 1), Vertex(0, 0, 2))), [1, 2]),
        (
            Vertex(1, 2, 3),
            (Vertex(2, 3, 4), Vertex(3, 4, 5)),
            [3 ** (1 / 2), 12 ** (1 / 2)],
        ),
        (
            Vertex(1, 2, 3),
            (Vertex(2, 3, 4), Vertex(3, 4, 5), Vertex(3, 4, 6)),
            [3 ** (1 / 2), 12 ** (1 / 2), 17 ** (1 / 2)],
        ),
    ],
)
def test_distance(vertex_a, vertex_b, expected_distance_mm):
    assert vertex_a.distance_mm(vertex_b) == pytest.approx(expected_distance_mm)