Skip to content

converters

Commonly used conversion functions.

list_to_vector4(float_list)

Convert a list of floats to a Vector4.

Parameters:

Name Type Description Default
float_list list[float | int]

List of floats.

 required

Returns:

Type Description
Vector4

First four elements of the list as a Vector4 padded with zeros if necessary.
Source code in src/ephys_link/utils/converters.py 
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
def list_to_vector4(float_list: list[float | int]) -> Vector4:
    """Convert a list of floats to a [Vector4][vbl_aquarium.models.unity.Vector4].

    Args:
        float_list: List of floats.

    Returns:
        First four elements of the list as a Vector4 padded with zeros if necessary.
    """

    def get_element(this_array: list[float | int], index: int) -> float:
        """Safely get an element from an array.

        Return 0 if the index is out of bounds.

        Args:
            this_array: Array to get the element from.
            index: Index to get.

        Returns:
            Element at the index or 0 if the index is out of bounds.
        """
        try:
            return this_array[index]
        except IndexError:
            return 0.0

    return Vector4(
        x=get_element(float_list, 0),
        y=get_element(float_list, 1),
        z=get_element(float_list, 2),
        w=get_element(float_list, 3),
    )

scalar_mm_to_um(mm)

Convert scalar values of millimeters to micrometers.

Parameters:

Name Type Description Default
mm float

Scalar value in millimeters.

 required

Returns:

Type Description
float

Scalar value in micrometers.
Source code in src/ephys_link/utils/converters.py 
 6
 7
 8
 9
10
11
12
13
14
15
def scalar_mm_to_um(mm: float) -> float:
    """Convert scalar values of millimeters to micrometers.

    Args:
        mm: Scalar value in millimeters.

    Returns:
        Scalar value in micrometers.
    """
    return mm * 1_000

um_to_mm(um)

Convert micrometers to millimeters.

Parameters:

Name Type Description Default
um Vector4

Length in micrometers.

 required

Returns:

Type Description
Vector4

Length in millimeters.
Source code in src/ephys_link/utils/converters.py 
30
31
32
33
34
35
36
37
38
39
def um_to_mm(um: Vector4) -> Vector4:
    """Convert micrometers to millimeters.

    Args:
        um: Length in micrometers.

    Returns:
        Length in millimeters.
    """
    return um / 1_000

vector4_to_array(vector4)

Convert a Vector4 to a list of floats.

Parameters:

Name Type Description Default
vector4 Vector4

Vector4 to convert.

 required

Returns:

Type Description
list[float]

List of floats.
Source code in src/ephys_link/utils/converters.py 
42
43
44
45
46
47
48
49
50
51
def vector4_to_array(vector4: Vector4) -> list[float]:
    """Convert a [Vector4][vbl_aquarium.models.unity.Vector4] to a list of floats.

    Args:
        vector4: [Vector4][vbl_aquarium.models.unity.Vector4] to convert.

    Returns:
        List of floats.
    """
    return [vector4.x, vector4.y, vector4.z, vector4.w]

vector_mm_to_um(mm)

Convert vector values of millimeters to micrometers.

Parameters:

Name Type Description Default
mm Vector4

Vector in millimeters.

 required

Returns:

Type Description
Vector4

Vector in micrometers.
Source code in src/ephys_link/utils/converters.py 
18
19
20
21
22
23
24
25
26
27
def vector_mm_to_um(mm: Vector4) -> Vector4:
    """Convert vector values of millimeters to micrometers.

    Args:
        mm: Vector in millimeters.

    Returns:
        Vector in micrometers.
    """
    return mm * 1_000