Skip to main content

​
Position

Inherits from: object A class to represent 3D cartesian position Attributes: x (float): x-coordinate value (meters) y (float): y-coordinate value (meters) z (float): z-coordinate value (meters)

​
init

Position.__init__(x: Union[float, List[float], np.ndarray], y: float = None, z: float = None)
Initialize a Position object.
​
Arguments
​
x (Union[float, List[float], np.ndarray])
Union[float, List[float], np.ndarray]
required
x-coordinate value or 3-element array [x, y, z]
​
y (float)
float
y-coordinate value. Defaults to None.
​
z (float)
float
z-coordinate value. Defaults to None.
​
Raises
​
ValueError
If the provided arguments don’t match expected patterns

​
x_val

Position.x_val() -> float
No docstring provided.
​
Returns
​
returns
float

​
x_val

Position.x_val(value: float) -> None
No docstring provided.
​
Arguments
​
value (float)
float
required
No description provided.
​
Returns
​
returns
None

​
y_val

Position.y_val() -> float
No docstring provided.
​
Returns
​
returns
float

​
y_val

Position.y_val(value: float) -> None
No docstring provided.
​
Arguments
​
value (float)
float
required
No description provided.
​
Returns
​
returns
None

​
z_val

Position.z_val() -> float
No docstring provided.
​
Returns
​
returns
float

​
z_val

Position.z_val(value: float) -> None
No docstring provided.
​
Arguments
​
value (float)
float
required
No description provided.
​
Returns
​
returns
None

​
to_dict

Position.to_dict() -> dict
Serialize to dictionary for JSON transfer
​
Returns
​
returns
dict

​
from_dict

Position.from_dict(data: dict) -> 'Position'
Deserialize from dictionary
​
Arguments
​
data (dict)
dict
required
No description provided.
​
Returns
​
returns
'Position'