hoa_tools.types

Common types used across the library.

ArrayCoordinate pydantic-model

Bases: BaseModel

A single coordinate in array space.

Fields:

• x (int)
• y (int)
• z (int)

x pydantic-field

x: int

y pydantic-field

y: int

z pydantic-field

z: int

to_physical_coordinate

to_physical_coordinate(*, voxel_size: float) -> PhysicalCoordinate

Given a voxel size, convert this array coordinate to a physical coordinate.

PhysicalCoordinate pydantic-model

Bases: BaseModel

A single coordinate in physical space.

Fields:

• x (float)
• y (float)
• z (float)

x pydantic-field

x: float

y pydantic-field

y: float

z pydantic-field

z: float

to_array_coordinate

to_array_coordinate(*, voxel_size: float) -> ArrayCoordinate

Given a voxel size, convert this physical coordinate to an array coordinate.

transform

transform(t: Transform) -> Self

Transform this coordinate.

Notes

The transform is applied in zyx order.