Module `pymskt.utils.testing`

Expand source code

from typing import Optional
from numpy.testing import assert_allclose
import SimpleITK as sitk
import pymskt as mskt
from vtk.util.numpy_support import vtk_to_numpy
import vtk

def assert_images_same(image1, image2):
    """
    Helper function to assert that 2 SimpleITK images are the same. 

    Parameters
    ----------
    image1 : SimpleITK.Image
        Version 1 of the image. 
    image2 : SimpleITK.Image
        Version 2 of the image. 
    """    
    image1_array = sitk.GetArrayFromImage(image1)
    image2_array = sitk.GetArrayFromImage(image2)

    assert_allclose(image1_array, image2_array)
    assert image1.GetOrigin() == image2.GetOrigin()
    assert image1.GetSpacing() == image2.GetSpacing()
    assert image1.GetDirection() == image2.GetDirection()

def assert_mesh_coordinates_same(mesh1, mesh2, rtol=1e-4):
    """
    Helper function to assert that 2 vtkPolyData meshes points are the same. 

    Parameters
    ----------
    mesh1 : vtk.vtkPolyData
        Version 1 of the mesh
    mesh2 : vtk.vtkPolyData
        Version 2 of the mesh
    """

    mesh1_pts = mskt.mesh.get_mesh_physical_point_coords(mesh1)
    mesh2_pts = mskt.mesh.get_mesh_physical_point_coords(mesh2)

    assert_allclose(mesh1_pts, mesh2_pts, rtol=rtol)

def assert_mesh_scalars_same(mesh1, mesh2, scalarname, scalarname2=None, rtol=1e-4):
    """
    Helper function to assert that the scalars on 2 vtkPolyData meshes as the same. 

    Parameters
    ----------
    mesh1 : vtk.vtkPolyData
        Version 1 of the mesh
    mesh2 : vtk.vtkPolyData
        Version 2 of the mesh
    scalarname : str
        String of the name associated with the scalars we are comparing
    scalarname2 : str, optional
        String of the name associated with the scalars on the second mesh. 
        This is only needed if the second mesh scarals have a different name than the first. 
    """
    if scalarname2 is None:
        scalarname2 = scalarname
    scalars1 = vtk_to_numpy(mesh1.GetPointData().GetArray(scalarname))
    scalars2 = vtk_to_numpy(mesh2.GetPointData().GetArray(scalarname2))

    assert_allclose(scalars1, scalars2, rtol=rtol)

Functions

def assert_images_same(image1, image2)

Helper function to assert that 2 SimpleITK images are the same.

Parameters

image1 : SimpleITK.Image: Version 1 of the image.
image2 : SimpleITK.Image: Version 2 of the image.

Expand source code

def assert_images_same(image1, image2):
    """
    Helper function to assert that 2 SimpleITK images are the same. 

    Parameters
    ----------
    image1 : SimpleITK.Image
        Version 1 of the image. 
    image2 : SimpleITK.Image
        Version 2 of the image. 
    """    
    image1_array = sitk.GetArrayFromImage(image1)
    image2_array = sitk.GetArrayFromImage(image2)

    assert_allclose(image1_array, image2_array)
    assert image1.GetOrigin() == image2.GetOrigin()
    assert image1.GetSpacing() == image2.GetSpacing()
    assert image1.GetDirection() == image2.GetDirection()

def assert_mesh_coordinates_same(mesh1, mesh2, rtol=0.0001)

Helper function to assert that 2 vtkPolyData meshes points are the same.

Parameters

mesh1 : vtk.vtkPolyData: Version 1 of the mesh
mesh2 : vtk.vtkPolyData: Version 2 of the mesh

Expand source code

def assert_mesh_coordinates_same(mesh1, mesh2, rtol=1e-4):
    """
    Helper function to assert that 2 vtkPolyData meshes points are the same. 

    Parameters
    ----------
    mesh1 : vtk.vtkPolyData
        Version 1 of the mesh
    mesh2 : vtk.vtkPolyData
        Version 2 of the mesh
    """

    mesh1_pts = mskt.mesh.get_mesh_physical_point_coords(mesh1)
    mesh2_pts = mskt.mesh.get_mesh_physical_point_coords(mesh2)

    assert_allclose(mesh1_pts, mesh2_pts, rtol=rtol)

def assert_mesh_scalars_same(mesh1, mesh2, scalarname, scalarname2=None, rtol=0.0001)

Helper function to assert that the scalars on 2 vtkPolyData meshes as the same.

Parameters

mesh1 : vtk.vtkPolyData: Version 1 of the mesh
mesh2 : vtk.vtkPolyData: Version 2 of the mesh
scalarname : str: String of the name associated with the scalars we are comparing
scalarname2 : str, optional: String of the name associated with the scalars on the second mesh. This is only needed if the second mesh scarals have a different name than the first.

Expand source code

def assert_mesh_scalars_same(mesh1, mesh2, scalarname, scalarname2=None, rtol=1e-4):
    """
    Helper function to assert that the scalars on 2 vtkPolyData meshes as the same. 

    Parameters
    ----------
    mesh1 : vtk.vtkPolyData
        Version 1 of the mesh
    mesh2 : vtk.vtkPolyData
        Version 2 of the mesh
    scalarname : str
        String of the name associated with the scalars we are comparing
    scalarname2 : str, optional
        String of the name associated with the scalars on the second mesh. 
        This is only needed if the second mesh scarals have a different name than the first. 
    """
    if scalarname2 is None:
        scalarname2 = scalarname
    scalars1 = vtk_to_numpy(mesh1.GetPointData().GetArray(scalarname))
    scalars2 = vtk_to_numpy(mesh2.GetPointData().GetArray(scalarname2))

    assert_allclose(scalars1, scalars2, rtol=rtol)