> ## Documentation Index
> Fetch the complete documentation index at: https://docs.generalrobotics.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Position

## 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**

```python theme={null}
Position.__init__(x: Union[float, List[float], np.ndarray], y: float = None, z: float = None)
```

Initialize a Position object.

<ResponseField name="Arguments">
  <ParamField query="x (Union[float, List[float], np.ndarray])" type="Union[float, List[float], np.ndarray]" required>
    x-coordinate value or 3-element array \[x, y, z]
  </ParamField>

  <ParamField query="y (float)" type="float">
    y-coordinate value. Defaults to None.
  </ParamField>

  <ParamField query="z (float)" type="float">
    z-coordinate value. Defaults to None.
  </ParamField>
</ResponseField>

<ResponseField name="Raises">
  <ParamField query="ValueError" type="">
    If the provided arguments don't match expected patterns
  </ParamField>
</ResponseField>

### x\_val

```python theme={null}
Position.x_val() -> float
```

*No docstring provided.*

<ResponseField name="Returns">
  <ResponseField name="returns" type="float" />
</ResponseField>

### x\_val

```python theme={null}
Position.x_val(value: float) -> None
```

*No docstring provided.*

<ResponseField name="Arguments">
  <ParamField query="value (float)" type="float" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="None" />
</ResponseField>

### y\_val

```python theme={null}
Position.y_val() -> float
```

*No docstring provided.*

<ResponseField name="Returns">
  <ResponseField name="returns" type="float" />
</ResponseField>

### y\_val

```python theme={null}
Position.y_val(value: float) -> None
```

*No docstring provided.*

<ResponseField name="Arguments">
  <ParamField query="value (float)" type="float" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="None" />
</ResponseField>

### z\_val

```python theme={null}
Position.z_val() -> float
```

*No docstring provided.*

<ResponseField name="Returns">
  <ResponseField name="returns" type="float" />
</ResponseField>

### z\_val

```python theme={null}
Position.z_val(value: float) -> None
```

*No docstring provided.*

<ResponseField name="Arguments">
  <ParamField query="value (float)" type="float" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="None" />
</ResponseField>

### to\_dict

```python theme={null}
Position.to_dict() -> dict
```

Serialize to dictionary for JSON transfer

<ResponseField name="Returns">
  <ResponseField name="returns" type="dict" />
</ResponseField>

### from\_dict

```python theme={null}
Position.from_dict(data: dict) -> 'Position'
```

Deserialize from dictionary

<ResponseField name="Arguments">
  <ParamField query="data (dict)" type="dict" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="'Position'" />
</ResponseField>