IMU sensor#

gs.sensors.IMU reports accelerometer, gyroscope, and magnetometer readings from a link, for robot state estimation. For usage, the noise model, and a worked state-estimation loop, see the IMU sensing guide.

API reference#

class genesis.options.sensors.options.IMU(*, history_length: int = 0, delay: float = 0.0, jitter: float = 0.0, draw_debug: bool = False, entity_idx: int = -1, resolution: tuple[float, ...] | float = 0.0, bias: tuple[float, ...] | float = 0.0, noise: tuple[float, ...] | float = 0.0, random_walk: tuple[float, ...] | float = 0.0, link_idx_local: int = 0, pos_offset: tuple[float, float, float] = (0.0, 0.0, 0.0), euler_offset: tuple[float, float, float] = (0.0, 0.0, 0.0), acc_resolution: tuple[float, float, float] = 0.0, acc_cross_axis_coupling: tuple[tuple[float, float, float], tuple[float, float, float], tuple[float, float, float]] | tuple[float, float, float] | float = 0.0, acc_noise: tuple[float, float, float] = 0.0, acc_bias: tuple[float, float, float] = 0.0, acc_random_walk: tuple[float, float, float] = 0.0, gyro_resolution: tuple[float, float, float] = 0.0, gyro_cross_axis_coupling: tuple[tuple[float, float, float], tuple[float, float, float], tuple[float, float, float]] | tuple[float, float, float] | float = 0.0, gyro_noise: tuple[float, float, float] = 0.0, gyro_bias: tuple[float, float, float] = 0.0, gyro_random_walk: tuple[float, float, float] = 0.0, mag_resolution: tuple[float, float, float] = 0.0, mag_cross_axis_coupling: tuple[tuple[float, float, float], tuple[float, float, float], tuple[float, float, float]] | tuple[float, float, float] | float = 0.0, mag_noise: tuple[float, float, float] = 0.0, mag_bias: tuple[float, float, float] = 0.0, mag_random_walk: tuple[float, float, float] = 0.0, magnetic_field: tuple[float, float, float] = (0.0, 0.0, 0.5), debug_acc_color: tuple[float, float, float, float] = (1.0, 0.0, 0.0, 0.6), debug_acc_scale: float = 0.01, debug_gyro_color: tuple[float, float, float, float] = (0.0, 1.0, 0.0, 0.6), debug_gyro_scale: float = 0.01, debug_mag_color: tuple[float, float, float, float] = (0.0, 0.0, 1.0, 0.6), debug_mag_scale: float = 0.5) → None[source]#

IMU sensor returns the linear acceleration (accelerometer) and angular velocity (gyroscope) of the associated entity link.

Parameters:

  • acc_resolution (float, optional) – The measurement resolution of the accelerometer (smallest increment of change in the sensor reading). Default is 0.0, which means no quantization is applied.

  • acc_cross_axis_coupling (float | array-like[float, float, float] | array-like with shape (3,3)) – Accelerometer axes alignment as a 3x3 rotation matrix, where diagonal elements represent alignment (0.0 to 1.0) for each axis, and off-diagonal elements account for cross-axis misalignment effects. - If a scalar is provided (float), all off-diagonal elements are set to the scalar value. - If a 3-element vector is provided (array-like[float, float, float]), off-diagonal elements are set. - If a full 3x3 matrix is provided, it is used directly.

  • acc_bias (array-like[float, float, float]) – The constant additive bias for each axis of the accelerometer.

  • acc_noise (array-like[float, float, float]) – The standard deviation of the white noise for each axis of the accelerometer.

  • acc_random_walk (array-like[float, float, float]) – The standard deviation of the random walk, which acts as accumulated bias drift.

  • gyro_resolution (float, optional) – The measurement resolution of the gyroscope (smallest increment of change in the sensor reading). Default is 0.0, which means no quantization is applied.

  • gyro_cross_axis_coupling (float | array-like[float, float, float] | array-like with shape (3,3)) – Gyroscope axes alignment as a 3x3 rotation matrix, similar to acc_cross_axis_coupling.

  • gyro_bias (array-like[float, float, float]) – The constant additive bias for each axis of the gyroscope.

  • gyro_noise (array-like[float, float, float]) – The standard deviation of the white noise for each axis of the gyroscope.

  • gyro_random_walk (array-like[float, float, float]) – The standard deviation of the bias drift for each axis of the gyroscope.

  • mag_resolution (float, optional) – The measurement resolution of the magnetometer (smallest increment of change in the sensor reading). Default is 0.0, which means no quantization is applied.

  • mag_cross_axis_coupling (float | array-like[float, float, float] | array-like with shape (3,3)) – Magnetometer axes alignment as a 3x3 rotation matrix, similar to acc_cross_axis_coupling.

  • mag_bias (array-like[float, float, float]) – The constant additive bias for each axis of the magnetometer.

  • mag_noise (array-like[float, float, float]) – The standard deviation of the white noise for each axis of the gyroscope.

  • mag_random_walk (array-like[float, float, float]) – The standard deviation of the bias drift for each axis of the magnetometer.

  • debug_acc_color (array-like[float, float, float, float], optional) – The rgba color of the debug acceleration arrow. Defaults to (1.0, 0.0, 0.0, 0.6).

  • debug_acc_scale (float, optional) – The scale factor for the debug acceleration arrow. Defaults to 0.01.

  • debug_gyro_color (array-like[float, float, float, float], optional) – The rgba color of the debug gyroscope arrow. Defaults to (0.0, 1.0, 0.0, 0.6).

  • debug_gyro_scale (float, optional) – The scale factor for the debug gyroscope arrow. Defaults to 0.01.

  • debug_mag_color (array-like[float, float, float, float], optional) – The rgba color of the debug magnetometer arrow. Defaults to (0.0, 0.0, 1.0, 0.6).

  • debug_mag_scale (float, optional) – The scale factor for the debug magnetometer arrow. Defaults to 0.01.

class genesis.engine.sensors.imu.IMUReturnType(lin_acc, ang_vel, mag)[source]#
class genesis.engine.sensors.imu.IMUSensor(options: IMU, idx: int, shared_context, shared_metadata: IMUSharedMetadata, manager: SensorManager)[source]#

Bases: RigidSensorMixin[IMUSharedMetadata], SimpleSensor[IMU, None, IMUSharedMetadata, IMUReturnType]

set_acc_cross_axis_coupling(cross_axis_coupling: tuple[tuple[float, float, float], tuple[float, float, float], tuple[float, float, float]] | tuple[float, float, float] | float, envs_idx=None)[source]#
set_gyro_cross_axis_coupling(cross_axis_coupling: tuple[tuple[float, float, float], tuple[float, float, float], tuple[float, float, float]] | tuple[float, float, float] | float, envs_idx=None)[source]#
set_mag_cross_axis_coupling(cross_axis_coupling: tuple[tuple[float, float, float], tuple[float, float, float], tuple[float, float, float]] | tuple[float, float, float] | float, envs_idx=None)[source]#
build()[source]#

Initialize all shared metadata needed to update all IMU sensors.

See also#

  • Sensors: sensor overview.

  • IMU: IMU usage, noise modeling, and state estimation.

  • Contact sensors: contact and force sensing.