make_grid_coordinates#
- make_grid_coordinates(grid: str, bounds: tuple[int, int, int], increment_xy: float, increment_z: float) list[source]#
Get all coordinates within given bounding box for selected grid type.
- Parameters:
grid ({'rect', 'hex'}) – Type of grid.
bounds – Bounds in the x, y, and z directions.
increment_xy – Increment size in x/y directions.
increment_z – Increment size in z direction.
- Returns:
List of grid coordinates.
- make_rect_grid_coordinates(bounds: tuple[int, int, int], increment_xy: float, increment_z: float) list[source]#
Get list of bounded (x, y, z) coordinates for rect grid.
- Parameters:
bounds – Bounds in the x, y, and z directions.
increment_xy – Increment size in x/y directions.
increment_z – Increment size in z direction.
- Returns:
List of grid coordinates.
- make_hex_grid_coordinates(bounds: tuple[int, int, int], increment_xy: float, increment_z: float) list[source]#
Get list of bounded (x, y, z) coordinates for hex grid.
Coordinates are offset in sets of three z slices to form a face-centered cubic (FCC) packing.
- Parameters:
bounds – Bounds in the x, y, and z directions.
increment_xy – Increment size in x/y directions.
increment_z – Increment size in z direction.
- Returns:
List of grid coordinates.