API Reference
- Module ouster.sdk.bag
- 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.prod_line
SensorInfo.prod_pn
SensorInfo.sn
SensorInfo.status
SensorInfo.to_json_string()
SensorInfo.user_data
SensorInfo.w
DataFormat
SensorConfig
SensorConfig.accel_fsr
SensorConfig.azimuth_window
SensorConfig.columns_per_packet
SensorConfig.extra_options
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()
LidarScan.get_first_valid_column_timestamp()
LidarScan.get_first_valid_packet_timestamp()
LidarScan.get_last_valid_column()
LidarScan.get_last_valid_column_timestamp()
LidarScan.get_last_valid_packet_timestamp()
LidarScan.h
LidarScan.has_field()
LidarScan.measurement_id
LidarScan.packet_count
LidarScan.packet_timestamp
LidarScan.pose
LidarScan.sensor_info
LidarScan.shot_limiting()
LidarScan.shot_limiting_countdown
LidarScan.shutdown_countdown
LidarScan.status
LidarScan.thermal_shutdown()
LidarScan.timestamp
LidarScan.w
XYZLut()
destagger()
- Module ouster.sdk.core
ClippedScanSource
- Functions
- Classes
PacketSource
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.prod_line
SensorInfo.prod_pn
SensorInfo.sn
SensorInfo.status
SensorInfo.to_json_string()
SensorInfo.user_data
SensorInfo.w
ScanSource
ScanSource.__iter__()
ScanSource.clip()
ScanSource.close()
ScanSource.full_index
ScanSource.individual_index
ScanSource.is_indexed
ScanSource.is_live
ScanSource.mask()
ScanSource.metadata
ScanSource.reduce()
ScanSource.scans_num
ScanSource.sensor_info
ScanSource.sensors_count
ScanSource.single()
ScanSource.single_iter()
ScanSource.slice()
LidarScan
LidarScan.add_field()
LidarScan.alert_flags
LidarScan.complete()
LidarScan.del_field()
LidarScan.field()
LidarScan.field_class()
LidarScan.field_types
LidarScan.fields
LidarScan.frame_id
LidarScan.frame_status
LidarScan.get_first_valid_column()
LidarScan.get_first_valid_column_timestamp()
LidarScan.get_first_valid_packet_timestamp()
LidarScan.get_last_valid_column()
LidarScan.get_last_valid_column_timestamp()
LidarScan.get_last_valid_packet_timestamp()
LidarScan.h
LidarScan.has_field()
LidarScan.measurement_id
LidarScan.packet_count
LidarScan.packet_timestamp
LidarScan.pose
LidarScan.sensor_info
LidarScan.shot_limiting()
LidarScan.shot_limiting_countdown
LidarScan.shutdown_countdown
LidarScan.status
LidarScan.thermal_shutdown()
LidarScan.timestamp
LidarScan.w
ImuPacket
LidarPacket
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
Packets
FrameBorder
first_valid_column()
last_valid_column()
first_valid_column_ts()
first_valid_packet_ts()
last_valid_packet_ts()
last_valid_column_ts()
first_valid_column_pose()
last_valid_column_pose()
valid_packet_idxs()
poses_present()
BufferT
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
stagger()
destagger()
XYZLut()
XYZLutFloat()
packet_ts()
MaskedScanSource
collate_scans()
Scans
ReducedScanSource
clip()
filter_field()
filter_uv()
filter_xyz()
mask()
reduce_by_factor_metadata()
reduce_by_factor()
- Enums
- Module ouster.sdk.examples
- Module ouster.sdk.mapping
PoseOptimizer
validate_constraints_json()
KissLocalization
KissSlam
LocalizationConfig
LocalizationBackend
LocalizationEngine
Preprocessor
KissICP
SlamConfig
SlamBackend
SlamEngine
get_frame_ts_range()
get_frame_id_range()
get_total_frame_pts_and_ts()
write_interpolated_poses()
determine_voxel_size()
_make_ortho()
- Module ouster.sdk.open_source
- Module ouster.sdk.osf
- Module ouster.sdk.pcap
- Module ouster.sdk.sensor
- Module ouster.sdk.util
fov_vertical()
fov_horizontal()
img_aspect_ratio()
quaternion_to_rotation_matrix()
rotation_matrix_to_quaternion()
position_quaternion_to_transform()
resolve_extrinsics()
euler_to_rotation_matrix()
xyzrpy_to_matrix()
xyzq_to_matrix()
parse_extrinsics_from_string()
ForwardSlicer
resolve_metadata()
resolve_metadata_multi()
default_scan_fields()
tohex()
scan_to_packets()
terminator_packet()
packets_to_scan()
cut_raw32_words()
no_scipy()
normalize_vector()
exp_rot_vec()
log_rot_mat()
exp_pose6()
log_pose()
pose_interp()
traj_interp()
Poser
TrajectoryEvaluator
get_rot_matrix_to_align_to_gravity()
pose_scans()
load_kitti_poses()
make_kiss_traj_poses()
pose_scans_from_kitti()
progressbar()
- Module ouster.sdk.viz
AccumulatorBase
LidarScanVizAccumulators
LidarScanVizAccumulators.cycle_cloud_mode()
LidarScanVizAccumulators.cycle_cloud_palette()
LidarScanVizAccumulators.update_point_size()
LidarScanVizAccumulators.toggle_sensor()
LidarScanVizAccumulators.toggle_mode_accum()
LidarScanVizAccumulators.toggle_mode_map()
LidarScanVizAccumulators.toggle_mode_track()
LidarScanVizAccumulators.toggle_osd()
LidarScanVizAccumulators.osd_text()
LidarScanVizAccumulators.update()
LidarScanVizAccumulators.draw()
LidarScanVizAccumulatorsConfig
PointViz
PointViz.add()
PointViz.camera
PointViz.fps
PointViz.get_screenshot()
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.save_screenshot()
PointViz.target_display
PointViz.toggle_screen_recording()
PointViz.update()
PointViz.viewport_height
PointViz.viewport_width
PointViz.visible()
PointViz.window_height
PointViz.window_width
Cloud
Image
Cuboid
Label
WindowCtx
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
add_default_controls()
ImageMode
CloudMode
CloudPaletteItem
VizExtraMode
LidarScanViz
LidarScanViz.OsdState
LidarScanViz.FlagsMode
LidarScanViz.ImagesLayout
LidarScanViz.CameraMode
LidarScanViz.mouse_button_handler()
LidarScanViz.mouse_pos_handler()
LidarScanViz.frame_buffer_resize_handler()
LidarScanViz.metadata
LidarScanViz.osd_state
LidarScanViz.MAX_SENSOR_TOGGLE_KEYS
LidarScanViz.select_img_mode()
LidarScanViz.cycle_img_mode()
LidarScanViz.select_cloud_mode()
LidarScanViz.cycle_cloud_mode()
LidarScanViz.cycle_cloud_palette()
LidarScanViz.toggle_cloud()
LidarScanViz.toggle_sensor()
LidarScanViz.update_point_size()
LidarScanViz.update_image_size()
LidarScanViz.toggle_flip_images()
LidarScanViz.update_ring_size()
LidarScanViz.cicle_ring_line_width()
LidarScanViz.toggle_osd()
LidarScanViz.cycle_camera_mode()
LidarScanViz.update_flags_mode()
LidarScanViz.toggle_axis_markers()
LidarScanViz.scan
LidarScanViz.scan_num
LidarScanViz.update()
LidarScanViz.draw()
LidarScanViz.run()
LidarScanViz.print_key_bindings()
LidarScanViz.toggle_help()
push_point_viz_handler()
ls_show()
MapAccumulator
ImgModeItem
VizExtraMode
Palettes
Selection2d
SensorModel
LidarScanVizModel
LidarScanVizModel.metadata
LidarScanVizModel.update_cloud_palette_name()
LidarScanVizModel.update_cloud_palettes()
LidarScanVizModel.sorted_cloud_mode_names()
LidarScanVizModel.sorted_image_mode_names()
LidarScanVizModel.select_cloud_mode()
LidarScanVizModel.cycle_cloud_mode()
LidarScanVizModel.select_image_mode()
LidarScanVizModel.cycle_image_mode()
LidarScanVizModel.update()
LidarScanVizModel.clear_masks()
LidarScanVizModel.clear_aoi()
LidarScanVizModel.image_and_pixel_for_viewport_coordinate()
LidarScanVizModel.mouse_button_handler()
LidarScanVizModel.update_aoi()
LidarScanVizModel.mouse_pos_handler()
LidarScanVizModel.update_aoi_label()
LidarScanVizModel.flip_images()
LidarScanVizModel.toggle_flip_images()
LidarScanVizModel.update_image_size()
SensorClouds
ScansAccumulator
ScanRecord
Track
MultiTrack
TracksAccumulator
BoundMethod
push_point_viz_handler()
push_point_viz_fb_handler()
AxisWithLabel
FieldViewMode
ImageMode
CloudMode
ImageCloudMode
RingMode
SimpleMode
RGBMode
ReflMode
is_norm_reflectivity_mode()
LidarScanVizMode
CloudPaletteItem