sksurgerycore.utilities.validate_matrix module

Various validation routines for checking matrices.

sksurgerycore.utilities.validate_matrix.validate_camera_matrix(matrix)

Validates that a matrix is a camera (intrinsic) matrix.

1. Is a numpy array
2. Is 2D
3. Has 3 rows
4. Has 3 columns

Parameters:matrix – camera matrix Raises:TypeError, ValueError if not Returns:True

sksurgerycore.utilities.validate_matrix.validate_distortion_coefficients(matrix)

Validates that a matrix is a set of OpenCV style distortion coefficients.

1. Is a numpy array
2. Is 2D
3. Has 1 row
4. Has either 4, 5, 8, 12 or 14 columns

Parameters:matrix – set of distortion coefficients Raises:TypeError, ValueError if not Returns:True

sksurgerycore.utilities.validate_matrix.validate_rigid_matrix(matrix)

Validates that a matrix is a 4x4 rigid transform.

Parameters:matrix – rigid transform Raises:TypeError, ValueError if not Returns:True

sksurgerycore.utilities.validate_matrix.validate_rotation_matrix(matrix)

Validates that a matrix is rotation matrix.

1. Is a numpy array
2. Is 2D
3. Has 3 rows
4. Has 3 columns
5. Is orthogonal, i.e., transpose(matrix) * matrix = identity matrix.
6. Is its determinant positive (+1) (c.f., it is a reflection matrix (improper rotation) if the determinant is negative (-1))

Parameters:matrix – rotation matrix Raises:TypeError, ValueError if not Returns:True

sksurgerycore.utilities.validate_matrix.validate_translation_column_vector(matrix)

Validates that a translation matrix is a column vector.

1. Is numpy array
2. Is 2D
3. Has 3 rows
4. Has 1 column

Parameters:matrix – translation matrix Raises:TypeError, ValueError if not Returns:True