Python API reference#

This reference is generated from the installed library package and its public docstrings.

Drop-in compatibility wrapper for omni.isaac.IsaacSensorSchema.

Replicates the generated schema API using generic USD attribute access, so that existing callsites continue to work without changes.

class omni.isaac.IsaacSensorSchema.IsaacBaseSensor(prim: Prim)#

Bases: object

Compatibility wrapper for pxr::IsaacSensorIsaacBaseSensor.

Parameters:

prim – Prim or prim-like object to wrap.

CreateEnabledAttr(
value: Any = None,
) → Attribute#

Create the enabled bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateSensorPeriodAttr(
value: Any = None,
) → Attribute#

Create the sensorPeriod float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

Deprecated since version 6.2.0: Only used by the deprecated isaacsim.sensors.physx extension.

classmethod Define(
stage: Stage,
path: str,
) → IsaacBaseSensor#

Create the underlying prim on stage at path and return the wrapper.

Parameters:
  • stage – Stage that receives the new prim.

  • path – Path where the prim is defined.

Returns:

Wrapper bound to the defined prim.

GetEnabledAttr() → Attribute#

Return the enabled bool attribute (may be invalid if unauthored).

Returns:

Requested USD attribute.

GetPath() → Path#

Return the wrapped prim’s Sdf.Path.

Returns:

Wrapped prim path.

GetPrim() → Prim#

Return the wrapped USD prim.

Returns:

Wrapped USD prim.

GetSensorPeriodAttr() → Attribute#

Return the sensorPeriod float attribute.

Returns:

Requested USD attribute.

Deprecated since version 6.2.0: Only used by the deprecated isaacsim.sensors.physx extension.

class omni.isaac.IsaacSensorSchema.IsaacContactSensor(prim: Prim)#

Bases: IsaacBaseSensor

Compatibility wrapper for pxr::IsaacSensorIsaacContactSensor.

CreateColorAttr(
value: Any = None,
) → Attribute#

Create the color float4 attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateRadiusAttr(
value: Any = None,
) → Attribute#

Create the radius float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateThresholdAttr(
value: Any = None,
) → Attribute#

Create the threshold float2 attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

GetColorAttr() → Attribute#

Return the color float4 attribute (sensor debug draw color).

Returns:

Requested USD attribute.

GetRadiusAttr() → Attribute#

Return the radius float attribute (contact sphere radius).

Returns:

Requested USD attribute.

GetThresholdAttr() → Attribute#

Return the threshold float2 attribute (min, max contact threshold).

Returns:

Requested USD attribute.

class omni.isaac.IsaacSensorSchema.IsaacImuSensor(prim: Prim)#

Bases: IsaacBaseSensor

Compatibility wrapper for pxr::IsaacSensorIsaacImuSensor.

CreateAngularVelocityFilterWidthAttr(
value: Any = None,
) → Attribute#

Create the angularVelocityFilterWidth int attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateLinearAccelerationFilterWidthAttr(
value: Any = None,
) → Attribute#

Create the linearAccelerationFilterWidth int attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateOrientationFilterWidthAttr(
value: Any = None,
) → Attribute#

Create the orientationFilterWidth int attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

GetAngularVelocityFilterWidthAttr() → Attribute#

Return the angularVelocityFilterWidth int attribute.

Returns:

Requested USD attribute.

GetLinearAccelerationFilterWidthAttr() → Attribute#

Return the linearAccelerationFilterWidth int attribute.

Returns:

Requested USD attribute.

GetOrientationFilterWidthAttr() → Attribute#

Return the orientationFilterWidth int attribute.

Returns:

Requested USD attribute.

class omni.isaac.IsaacSensorSchema.IsaacLightBeamSensor(prim: Prim)#

Bases: IsaacBaseSensor

Compatibility wrapper for pxr::IsaacSensorIsaacLightBeamSensor.

Parameters:

prim – Prim or prim-like object to wrap.

Deprecated since version 6.2.0: Use IsaacRaycastSensor with isaacsim.sensors.experimental.physics instead.

CreateCurtainAxisAttr(
value: Any = None,
) → Attribute#

Create the curtainAxis float3 attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateCurtainLengthAttr(
value: Any = None,
) → Attribute#

Create the curtainLength float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateForwardAxisAttr(
value: Any = None,
) → Attribute#

Create the forwardAxis float3 attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateMaxRangeAttr(
value: Any = None,
) → Attribute#

Create the maxRange float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateMinRangeAttr(
value: Any = None,
) → Attribute#

Create the minRange float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateNumRaysAttr(
value: Any = None,
) → Attribute#

Create the numRays int attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

GetCurtainAxisAttr() → Attribute#

Return the curtainAxis float3 attribute (curtain spread direction).

Returns:

Requested USD attribute.

GetCurtainLengthAttr() → Attribute#

Return the curtainLength float attribute (extent of the light curtain).

Returns:

Requested USD attribute.

GetForwardAxisAttr() → Attribute#

Return the forwardAxis float3 attribute (principal ray direction).

Returns:

Requested USD attribute.

GetMaxRangeAttr() → Attribute#

Return the maxRange float attribute (far clip of the sensor).

Returns:

Requested USD attribute.

GetMinRangeAttr() → Attribute#

Return the minRange float attribute (near clip of the sensor).

Returns:

Requested USD attribute.

GetNumRaysAttr() → Attribute#

Return the numRays int attribute (number of rays cast per frame).

Returns:

Requested USD attribute.

class omni.isaac.IsaacSensorSchema.IsaacRaycastSensor(prim: Prim)#

Bases: IsaacBaseSensor

Compatibility wrapper for pxr::IsaacSensorIsaacRaycastSensor.

CreateMaxRangeAttr(
value: Any = None,
) → Attribute#

Create the maxRange float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateMinRangeAttr(
value: Any = None,
) → Attribute#

Create the minRange float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateNumRaysAttr(
value: Any = None,
) → Attribute#

Create the numRays uint attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateOutputFrameOfReferenceAttr(
value: Any = None,
) → Attribute#

Create the outputFrameOfReference token attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateRayDirectionsAttr(
value: Any = None,
) → Attribute#

Create the rayDirections float3 array attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateRayOriginsAttr(
value: Any = None,
) → Attribute#

Create the rayOrigins float3 array attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateRayTimeOffsetsAttr(
value: Any = None,
) → Attribute#

Create the rayTimeOffsets float array attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateReportHitPrimPathsAttr(
value: Any = None,
) → Attribute#

Create the reportHitPrimPaths bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

GetMaxRangeAttr() → Attribute#

Return the maxRange float attribute (far clip of the sensor).

Returns:

Requested USD attribute.

GetMinRangeAttr() → Attribute#

Return the minRange float attribute (near clip of the sensor).

Returns:

Requested USD attribute.

GetNumRaysAttr() → Attribute#

Return the numRays uint attribute (number of rays cast per frame).

Returns:

Requested USD attribute.

GetOutputFrameOfReferenceAttr() → Attribute#

Return the outputFrameOfReference token attribute (output coordinate frame).

Returns:

Requested USD attribute.

GetRayDirectionsAttr() → Attribute#

Return the rayDirections float3 array attribute (per-ray direction vectors).

Returns:

Requested USD attribute.

GetRayOriginsAttr() → Attribute#

Return the rayOrigins float3 array attribute (per-ray origin points).

Returns:

Requested USD attribute.

GetRayTimeOffsetsAttr() → Attribute#

Return the rayTimeOffsets float array attribute (per-ray sub-frame time offsets).

Returns:

Requested USD attribute.

GetReportHitPrimPathsAttr() → Attribute#

Return the reportHitPrimPaths bool attribute (emit hit prim paths in output).

Returns:

Requested USD attribute.

class omni.isaac.IsaacSensorSchema.IsaacRtxLidarSensorAPI(prim: Prim)#

Bases: _APISchemaWrapper

Compatibility wrapper for pxr::IsaacSensorIsaacRtxLidarSensorAPI.

class omni.isaac.IsaacSensorSchema.IsaacRtxRadarSensorAPI(prim: Prim)#

Bases: _APISchemaWrapper

Compatibility wrapper for pxr::IsaacSensorIsaacRtxRadarSensorAPI.

Drop-in compatibility wrapper for omni.isaac.RangeSensorSchema.

Deprecated since version 6.2.0: The RangeSensor, Lidar, and Generic schemas are deprecated. Use IsaacRaycastSensor with isaacsim.sensors.experimental.physics or isaacsim.sensors.experimental.rtx instead.

class omni.isaac.RangeSensorSchema.Generic(prim: Prim)#

Bases: RangeSensor

Compatibility wrapper for pxr::RangeSensorGeneric.

CreateSamplingRateAttr(
value: Any = None,
) → Attribute#

Create the samplingRate int attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateStreamingAttr(
value: Any = None,
) → Attribute#

Create the streaming bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

GetSamplingRateAttr() → Attribute#

Return the samplingRate int attribute (samples per second).

Returns:

Requested USD attribute.

GetStreamingAttr() → Attribute#

Return the streaming bool attribute (continuous output toggle).

Returns:

Requested USD attribute.

class omni.isaac.RangeSensorSchema.Lidar(prim: Prim)#

Bases: RangeSensor

Compatibility wrapper for pxr::RangeSensorLidar.

CreateEnableSemanticsAttr(
value: Any = None,
) → Attribute#

Create the enableSemantics bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateHighLodAttr(
value: Any = None,
) → Attribute#

Create the highLod bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateHorizontalFovAttr(
value: Any = None,
) → Attribute#

Create the horizontalFov float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateHorizontalResolutionAttr(
value: Any = None,
) → Attribute#

Create the horizontalResolution float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateRotationRateAttr(
value: Any = None,
) → Attribute#

Create the rotationRate float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateVerticalFovAttr(
value: Any = None,
) → Attribute#

Create the verticalFov float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateVerticalResolutionAttr(
value: Any = None,
) → Attribute#

Create the verticalResolution float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateYawOffsetAttr(
value: Any = None,
) → Attribute#

Create the yawOffset float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

GetEnableSemanticsAttr() → Attribute#

Return the enableSemantics bool attribute (emit semantic labels).

Returns:

Requested USD attribute.

GetHighLodAttr() → Attribute#

Return the highLod bool attribute (high-resolution toggle).

Returns:

Requested USD attribute.

GetHorizontalFovAttr() → Attribute#

Return the horizontalFov float attribute (degrees).

Returns:

Requested USD attribute.

GetHorizontalResolutionAttr() → Attribute#

Return the horizontalResolution float attribute (degrees per sample).

Returns:

Requested USD attribute.

GetRotationRateAttr() → Attribute#

Return the rotationRate float attribute (revolutions per second).

Returns:

Requested USD attribute.

GetVerticalFovAttr() → Attribute#

Return the verticalFov float attribute (degrees).

Returns:

Requested USD attribute.

GetVerticalResolutionAttr() → Attribute#

Return the verticalResolution float attribute (degrees per sample).

Returns:

Requested USD attribute.

GetYawOffsetAttr() → Attribute#

Return the yawOffset float attribute (azimuthal starting angle).

Returns:

Requested USD attribute.

class omni.isaac.RangeSensorSchema.RangeSensor(prim: Prim)#

Bases: object

Compatibility wrapper for pxr::RangeSensorRangeSensor.

Parameters:

prim – Prim or prim-like object to wrap.

CreateDrawLinesAttr(
value: Any = None,
) → Attribute#

Create the drawLines bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateDrawPointsAttr(
value: Any = None,
) → Attribute#

Create the drawPoints bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateEnabledAttr(
value: Any = None,
) → Attribute#

Create the enabled bool attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateMaxRangeAttr(
value: Any = None,
) → Attribute#

Create the maxRange float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

CreateMinRangeAttr(
value: Any = None,
) → Attribute#

Create the minRange float attribute and optionally set value.

Parameters:

value – Value to set on the attribute.

Returns:

Created USD attribute.

classmethod Define(
stage: Stage,
path: str,
) → RangeSensor#

Create the underlying prim on stage at path and return the wrapper.

Parameters:
  • stage – Stage that receives the new prim.

  • path – Path where the prim is defined.

Returns:

Wrapper bound to the defined prim.

GetDrawLinesAttr() → Attribute#

Return the drawLines bool attribute (debug-draw rays).

Returns:

Requested USD attribute.

GetDrawPointsAttr() → Attribute#

Return the drawPoints bool attribute (debug-draw hit points).

Returns:

Requested USD attribute.

GetEnabledAttr() → Attribute#

Return the enabled bool attribute.

Returns:

Requested USD attribute.

GetMaxRangeAttr() → Attribute#

Return the maxRange float attribute (far clip).

Returns:

Requested USD attribute.

GetMinRangeAttr() → Attribute#

Return the minRange float attribute (near clip).

Returns:

Requested USD attribute.

GetPath() → Path#

Return the wrapped prim’s Sdf.Path.

Returns:

Wrapped prim path.

GetPrim() → Prim#

Return the wrapped USD prim.

Returns:

Wrapped USD prim.

Plugin registration helpers for robot schema modules.