openlifu.bf.focal_patterns.wheel.Wheel

class openlifu.bf.focal_patterns.wheel.Wheel(target_pressure: Annotated[float, OpenLIFUFieldData(name='Target pressure', description='Target pressure of the focal pattern in given units')] = 1.0, units: Annotated[str, OpenLIFUFieldData(name='Pressure units', description='Pressure units')] = 'Pa', center: Annotated[bool, OpenLIFUFieldData(name='Include center point?', description='Whether to include the center for the wheel pattern')] = True, num_spokes: Annotated[int, OpenLIFUFieldData(name='Number of spokes', description='Number of spokes in the wheel pattern')] = 4, spoke_radius: Annotated[float, OpenLIFUFieldData(name='Spoke radius', description='Radius of the spokes in the wheel pattern')] = 1.0, distance_units: Annotated[str, OpenLIFUFieldData(name='Units', description='Units of the wheel pattern parameters')] = 'mm')

Bases: FocalPattern

Class for representing a wheel pattern

center: Annotated[bool, OpenLIFUFieldData(name='Include center point?', description='Whether to include the center for the wheel pattern')] = True

Whether to include the center for the wheel pattern

distance_units: Annotated[str, OpenLIFUFieldData(name='Units', description='Units of the wheel pattern parameters')] = 'mm'

Units of the wheel pattern parameters

get_targets(target: Point)

Get the targets of the focal pattern

Parameters:

target – Target point of the focal pattern

Returns:

List of target points

num_foci() → int

Get the number of foci in the focal pattern

Returns:

Number of foci

num_spokes: Annotated[int, OpenLIFUFieldData(name='Number of spokes', description='Number of spokes in the wheel pattern')] = 4

Number of spokes in the wheel pattern

spoke_radius: Annotated[float, OpenLIFUFieldData(name='Spoke radius', description='Radius of the spokes in the wheel pattern')] = 1.0

Radius of the spokes in the wheel pattern

to_table() → DataFrame

Get a table of the focal pattern parameters

Returns:

Pandas DataFrame of the focal pattern parameters