openlifu.geo.Point

class openlifu.geo.Point(position: "Annotated[np.ndarray, OpenLIFUFieldData('Position', '3D position of the point in the provided units')]" = <factory>, id: "Annotated[str, OpenLIFUFieldData('Point ID', 'Unique identifier for the point')]" = 'point', name: "Annotated[str, OpenLIFUFieldData('Point name', 'Name of the point')]" = 'Point', color: "Annotated[Any, OpenLIFUFieldData('Color (RGB)', 'RGB color of the point')]" = (1.0, 0.0, 0.0), radius: "Annotated[float, OpenLIFUFieldData('Radius', 'Radius for rendering the point in the provided units')]" = 1.0, dims: "Annotated[Tuple[str, str, str], OpenLIFUFieldData('Dimensions', 'Names of the axes of the coordinate system being used')]" = ('x', 'y', 'z'), units: "Annotated[str, OpenLIFUFieldData('Units', 'Units for the point')]" = 'mm')[source]

Bases: object

color: Annotated[Any, OpenLIFUFieldData(name='Color (RGB)', description='RGB color of the point')] = (1.0, 0.0, 0.0)

RGB color of the point

dims: Annotated[Tuple[str, str, str], OpenLIFUFieldData(name='Dimensions', description='Names of the axes of the coordinate system being used')] = ('x', 'y', 'z')

Names of the axes of the coordinate system being used

static from_dict(point_data: Dict)[source]

Create a Point object from a dictionary.

static from_json(json_string: str) → Point[source]

Load a Point from a json string

id: Annotated[str, OpenLIFUFieldData(name='Point ID', description='Unique identifier for the point')] = 'point'

Unique identifier for the point

name: Annotated[str, OpenLIFUFieldData(name='Point name', description='Name of the point')] = 'Point'

Name of the point

position: Annotated[ndarray, OpenLIFUFieldData(name='Position', description='3D position of the point in the provided units')]

3D position of the point in the provided units

radius: Annotated[float, OpenLIFUFieldData(name='Radius', description='Radius for rendering the point in the provided units')] = 1.0

Radius for rendering the point in the provided units

to_json(compact: bool) → str[source]

Serialize a Point to a json string

Parameters:

compact – if enabled then the string is compact (not pretty). Disable for pretty.

Returns: A json string representing the complete Point object.

units: Annotated[str, OpenLIFUFieldData(name='Units', description='Units for the point')] = 'mm'

Units for the point