freesurfer-surface/tests/test_polygonal_circuit.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 pytest

from freesurfer_surface import PolygonalCircuit, Vertex


def test_init_tuple():
    circuit = PolygonalCircuit((1, 2, 3, 5))
    assert circuit.vertex_indices == (1, 2, 3, 5)


def test_init_list():
    circuit = PolygonalCircuit([1, 2, 3, 5])
    assert circuit.vertex_indices == (1, 2, 3, 5)


def test_init_iterator():
    circuit = PolygonalCircuit(iter([1, 2, 3, 5]))
    assert circuit.vertex_indices == (1, 2, 3, 5)


def test_init_invalid_type():
    with pytest.raises(Exception):
        PolygonalCircuit((0, 1, 2.0))
    with pytest.raises(Exception):
        PolygonalCircuit((Vertex(2, 3, 4),))
    with pytest.raises(Exception):
        PolygonalCircuit((0, 1, Vertex(2, 3, 4)))


@pytest.mark.parametrize(
    ("source_vertex_indices", "expected_vertex_indices"),
    [
        ((1,), (1,)),
        ((1, 2), (1, 2)),
        ((2, 1), (1, 2)),
        ((1, 2, 3), (1, 2, 3)),
        ((2, 3, 1), (1, 2, 3)),
        ((3, 1, 2), (1, 2, 3)),
        ((1, 3, 2), (1, 2, 3)),
        ((2, 1, 3), (1, 2, 3)),
        ((3, 2, 1), (1, 2, 3)),
        ((1, 2, 3, 5), (1, 2, 3, 5)),
        ((2, 3, 5, 1), (1, 2, 3, 5)),
        ((3, 5, 1, 2), (1, 2, 3, 5)),
        ((2, 1, 5, 3), (1, 2, 3, 5)),
        ((5, 3, 2, 1), (1, 2, 3, 5)),
    ],
)
def test__normalize(source_vertex_indices, expected_vertex_indices):
    # pylint: disable=protected-access
    circuit = PolygonalCircuit(source_vertex_indices)
    assert expected_vertex_indices == circuit._normalize()._vertex_indices


def test_eq():
    assert PolygonalCircuit((0, 1)) == PolygonalCircuit((0, 1))
    assert PolygonalCircuit((0, 1)) == PolygonalCircuit((1, 0))
    assert PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((0, 1, 2))
    assert PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((1, 2, 0))
    assert PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((2, 0, 1))
    # pylint: disable=unneeded-not
    assert not PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((0, 1, 4))
    assert not PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((0, 4, 2))
    assert not PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((4, 1, 2))


def test_eq_reverse():
    assert PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((2, 1, 0))
    assert PolygonalCircuit((0, 1, 2)) == PolygonalCircuit((0, 2, 1))
    assert PolygonalCircuit((0, 1, 2, 4)) == PolygonalCircuit((4, 2, 1, 0))
    assert PolygonalCircuit((0, 1, 2, 4)) == PolygonalCircuit((1, 0, 4, 2))


def test_hash():
    assert hash(PolygonalCircuit((0, 1, 2))) == hash(PolygonalCircuit((0, 1, 2)))
    assert hash(PolygonalCircuit((0, 1, 2))) == hash(PolygonalCircuit((1, 2, 0)))
    assert hash(PolygonalCircuit((0, 1, 2))) == hash(PolygonalCircuit((2, 0, 1)))
    assert hash(PolygonalCircuit((0, 1, 2))) != hash(PolygonalCircuit((0, 1, 4)))
    assert hash(PolygonalCircuit((0, 1, 2))) != hash(PolygonalCircuit((0, 4, 2)))
    assert hash(PolygonalCircuit((0, 1, 2))) != hash(PolygonalCircuit((4, 1, 2)))


def test_hash_reverse():
    assert hash(PolygonalCircuit((0, 1, 2))) == hash(PolygonalCircuit((2, 1, 0)))
    assert hash(PolygonalCircuit((0, 1, 2))) == hash(PolygonalCircuit((0, 2, 1)))
    assert hash(PolygonalCircuit((0, 1, 2, 4))) == hash(PolygonalCircuit((4, 2, 1, 0)))
    assert hash(PolygonalCircuit((0, 1, 2, 4))) == hash(PolygonalCircuit((1, 0, 4, 2)))
    assert hash(PolygonalCircuit((0, 1, 2, 4))) != hash(PolygonalCircuit((1, 4, 0, 2)))


def test_adjacent_vertex_indices_1():
    chain = PolygonalCircuit((0, 1, 4, 8))
    singles = list(chain.adjacent_vertex_indices(1))
    assert len(singles) == 4
    assert singles[0] == (0,)
    assert singles[1] == (1,)
    assert singles[2] == (4,)
    assert singles[3] == (8,)


def test_adjacent_vertex_indices_2():
    chain = PolygonalCircuit((0, 1, 4, 8))
    pairs = list(chain.adjacent_vertex_indices(2))
    assert len(pairs) == 4
    assert pairs[0] == (0, 1)
    assert pairs[1] == (1, 4)
    assert pairs[2] == (4, 8)
    assert pairs[3] == (8, 0)


def test_adjacent_vertex_indices_3():
    chain = PolygonalCircuit((0, 1, 4, 8))
    triplets = list(chain.adjacent_vertex_indices(3))
    assert len(triplets) == 4
    assert triplets[0] == (0, 1, 4)
    assert triplets[1] == (1, 4, 8)
    assert triplets[2] == (4, 8, 0)
    assert triplets[3] == (8, 0, 1)


def test_adjacent_vertex_indices_4():
    chain = PolygonalCircuit((0, 1, 4, 8))
    quadruples = list(chain.adjacent_vertex_indices(4))
    assert len(quadruples) == 4
    assert quadruples[0] == (0, 1, 4, 8)
    assert quadruples[1] == (1, 4, 8, 0)
    assert quadruples[2] == (4, 8, 0, 1)
    assert quadruples[3] == (8, 0, 1, 4)


def test_adjacent_vertex_indices_5():
    chain = PolygonalCircuit((0, 1, 4, 8))
    quintuples = list(chain.adjacent_vertex_indices(5))
    assert len(quintuples) == 4
    assert quintuples[0] == (0, 1, 4, 8, 0)
    assert quintuples[1] == (1, 4, 8, 0, 1)
    assert quintuples[2] == (4, 8, 0, 1, 4)
    assert quintuples[3] == (8, 0, 1, 4, 8)