API Reference
- Module
ouster.sdk.client
- Core
- Metadata
SensorInfo
SensorInfo.beam_altitude_angles
SensorInfo.beam_azimuth_angles
SensorInfo.beam_to_lidar_transform
SensorInfo.build_date
SensorInfo.cal
SensorInfo.config
SensorInfo.extrinsic
SensorInfo.format
SensorInfo.from_default()
SensorInfo.fw_rev
SensorInfo.get_product_info()
SensorInfo.get_version()
SensorInfo.h
SensorInfo.has_fields_equal()
SensorInfo.image_rev
SensorInfo.imu_to_sensor_transform
SensorInfo.init_id
SensorInfo.lidar_origin_to_beam_origin_mm
SensorInfo.lidar_to_sensor_transform
SensorInfo.mode
SensorInfo.prod_line
SensorInfo.prod_pn
SensorInfo.sn
SensorInfo.status
SensorInfo.to_json_string()
SensorInfo.udp_port_imu
SensorInfo.udp_port_lidar
SensorInfo.user_data
SensorInfo.w
DataFormat
SensorConfig
SensorConfig.accel_fsr
SensorConfig.azimuth_window
SensorConfig.columns_per_packet
SensorConfig.gyro_fsr
SensorConfig.lidar_mode
SensorConfig.min_range_threshold_cm
SensorConfig.multipurpose_io_mode
SensorConfig.nmea_baud_rate
SensorConfig.nmea_ignore_valid_char
SensorConfig.nmea_in_polarity
SensorConfig.nmea_leap_seconds
SensorConfig.operating_mode
SensorConfig.phase_lock_enable
SensorConfig.phase_lock_offset
SensorConfig.return_order
SensorConfig.signal_multiplier
SensorConfig.sync_pulse_in_polarity
SensorConfig.sync_pulse_out_angle
SensorConfig.sync_pulse_out_frequency
SensorConfig.sync_pulse_out_polarity
SensorConfig.sync_pulse_out_pulse_width
SensorConfig.timestamp_mode
SensorConfig.udp_dest
SensorConfig.udp_port_imu
SensorConfig.udp_port_lidar
SensorConfig.udp_profile_imu
SensorConfig.udp_profile_lidar
get_config()
set_config()
LidarMode
TimestampMode
OperatingMode
MultipurposeIOMode
MultipurposeIOMode.MULTIPURPOSE_INPUT_NMEA_UART
MultipurposeIOMode.MULTIPURPOSE_OFF
MultipurposeIOMode.MULTIPURPOSE_OUTPUT_FROM_ENCODER_ANGLE
MultipurposeIOMode.MULTIPURPOSE_OUTPUT_FROM_INTERNAL_OSC
MultipurposeIOMode.MULTIPURPOSE_OUTPUT_FROM_PTP_1588
MultipurposeIOMode.MULTIPURPOSE_OUTPUT_FROM_SYNC_PULSE_IN
MultipurposeIOMode.from_string()
MultipurposeIOMode.name
MultipurposeIOMode.value
MultipurposeIOMode.values
Polarity
NMEABaudRate
UDPProfileLidar
UDPProfileLidar.PROFILE_LIDAR_FIVE_WORD_PIXEL
UDPProfileLidar.PROFILE_LIDAR_FUSA_RNG15_RFL8_NIR8_DUAL
UDPProfileLidar.PROFILE_LIDAR_LEGACY
UDPProfileLidar.PROFILE_LIDAR_RNG15_RFL8_NIR8
UDPProfileLidar.PROFILE_LIDAR_RNG19_RFL8_SIG16_NIR16
UDPProfileLidar.PROFILE_LIDAR_RNG19_RFL8_SIG16_NIR16_DUAL
UDPProfileLidar.PROFILE_LIDAR_UNKNOWN
UDPProfileLidar.from_string()
UDPProfileLidar.name
UDPProfileLidar.value
UDPProfileLidar.values
parse_and_validate_metadata()
ValidatorIssues
ValidatorEntry
ProductInfo
- Data
BufferT
Packet
ImuPacket
LidarPacket
ChanField
ChanField.RANGE
ChanField.RANGE2
ChanField.SIGNAL
ChanField.SIGNAL2
ChanField.REFLECTIVITY
ChanField.REFLECTIVITY2
ChanField.NEAR_IR
ChanField.FLAGS
ChanField.FLAGS2
ChanField.RAW_HEADERS
ChanField.RAW32_WORD1
ChanField.RAW32_WORD2
ChanField.RAW32_WORD3
ChanField.RAW32_WORD4
ChanField.RAW32_WORD5
ChanField.RAW32_WORD6
ChanField.RAW32_WORD7
ChanField.RAW32_WORD8
ChanField.RAW32_WORD9
ColHeader
LidarScan
LidarScan.add_field()
LidarScan.alert_flags
LidarScan.del_field()
LidarScan.field()
LidarScan.field_class()
LidarScan.field_types
LidarScan.fields
LidarScan.frame_id
LidarScan.frame_status
LidarScan.get_first_valid_column_timestamp()
LidarScan.get_first_valid_packet_timestamp()
LidarScan.h
LidarScan.has_field()
LidarScan.measurement_id
LidarScan.packet_count
LidarScan.packet_timestamp
LidarScan.pose
LidarScan.shot_limiting()
LidarScan.shot_limiting_countdown
LidarScan.shutdown_countdown
LidarScan.status
LidarScan.thermal_shutdown()
LidarScan.timestamp
LidarScan.w
XYZLut()
destagger()
- Module
ouster.sdk.pcap
- Module
ouster.sdk.viz
- Core
PointViz
PointViz.add()
PointViz.camera
PointViz.fps
PointViz.pop_frame_buffer_handler()
PointViz.pop_key_handler()
PointViz.pop_mouse_button_handler()
PointViz.pop_mouse_pos_handler()
PointViz.pop_scroll_handler()
PointViz.push_frame_buffer_handler()
PointViz.push_frame_buffer_resize_handler()
PointViz.push_key_handler()
PointViz.push_mouse_button_handler()
PointViz.push_mouse_pos_handler()
PointViz.push_scroll_handler()
PointViz.remove()
PointViz.run()
PointViz.run_once()
PointViz.running()
PointViz.target_display
PointViz.update()
PointViz.viewport_height
PointViz.viewport_width
PointViz.visible()
PointViz.window_height
PointViz.window_width
add_default_controls()
LidarScanViz
LidarScanViz.OsdState
LidarScanViz.FlagsMode
LidarScanViz.ImagesLayout
LidarScanViz.metadata
LidarScanViz.osd_state
LidarScanViz.cycle_img_mode()
LidarScanViz.cycle_cloud_mode()
LidarScanViz.cycle_cloud_palette()
LidarScanViz.toggle_cloud()
LidarScanViz.toggle_sensor()
LidarScanViz.update_point_size()
LidarScanViz.update_image_size()
LidarScanViz.update_ring_size()
LidarScanViz.cicle_ring_line_width()
LidarScanViz.toggle_osd()
LidarScanViz.toggle_camera_follow()
LidarScanViz.toggle_scan_axis()
LidarScanViz.scan
LidarScanViz.scan_num
LidarScanViz.update()
LidarScanViz.draw()
LidarScanViz.run()
SimpleViz
viz.spezia_palette
viz.calref_palette
- Visual Primitives
Camera
andTargetDisplay
Camera
Camera.dolly()
Camera.dolly_xy()
Camera.get_dolly()
Camera.get_fov()
Camera.get_pitch()
Camera.get_proj_offset()
Camera.get_target()
Camera.get_view_offset()
Camera.get_yaw()
Camera.is_orthographic()
Camera.pitch()
Camera.reset()
Camera.set_dolly()
Camera.set_fov()
Camera.set_orthographic()
Camera.set_pitch()
Camera.set_proj_offset()
Camera.set_target()
Camera.set_view_offset()
Camera.set_yaw()
Camera.yaw()
TargetDisplay
- Events
WindowCtx
- Viz Utils
- Core
- Module
ouster.sdk.examples
- Module
ouster.sdk.osf
- Low-Level API
- Reading
- Writing OSF files
- Common metadata entries
- Common streams
- High-Level API
- Low-Level API