API Reference

• Module ouster.sdk.client
  • Core
    • ClientError
    • ClientTimeout
    • ClientOverflow
    • PacketSource
      • PacketSource.__iter__()
      • PacketSource.metadata
      • PacketSource.close()
    • Packets
      • Packets.metadata
      • Packets.__iter__()
      • Packets.close()
    • Sensor
      • Sensor.metadata
      • Sensor.write_metadata()
      • Sensor.__iter__()
      • Sensor.flush()
      • Sensor.close()
    • Scans
      • Scans.__iter__()
      • Scans.close()
      • Scans.metadata
      • Scans.is_live
      • Scans.is_seekable
      • Scans.is_indexed
      • Scans.field_types
      • Scans.fields
      • Scans.scans_num
      • Scans.slice()
      • Scans.clip()
      • Scans.reduce()
      • Scans.mask()
      • Scans.sample()
      • Scans.stream()
  • 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
      • DataFormat.column_window
      • DataFormat.columns_per_frame
      • DataFormat.columns_per_packet
      • DataFormat.fps
      • DataFormat.pixel_shift_by_row
      • DataFormat.pixels_per_column
      • DataFormat.udp_profile_imu
      • DataFormat.udp_profile_lidar
    • 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
      • LidarMode.MODE_1024x10
      • LidarMode.MODE_1024x20
      • LidarMode.MODE_2048x10
      • LidarMode.MODE_4096x5
      • LidarMode.MODE_512x10
      • LidarMode.MODE_512x20
      • LidarMode.MODE_UNKNOWN
      • LidarMode.MODE_UNSPEC
      • LidarMode.from_string()
      • LidarMode.name
      • LidarMode.value
      • LidarMode.values
    • TimestampMode
      • TimestampMode.TIME_FROM_INTERNAL_OSC
      • TimestampMode.TIME_FROM_PTP_1588
      • TimestampMode.TIME_FROM_SYNC_PULSE_IN
      • TimestampMode.TIME_FROM_UNSPEC
      • TimestampMode.UNKNOWN
      • TimestampMode.from_string()
      • TimestampMode.name
      • TimestampMode.value
      • TimestampMode.values
    • OperatingMode
      • OperatingMode.OPERATING_NORMAL
      • OperatingMode.OPERATING_STANDBY
      • OperatingMode.from_string()
      • OperatingMode.name
      • OperatingMode.value
      • OperatingMode.values
    • 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
      • Polarity.POLARITY_ACTIVE_HIGH
      • Polarity.POLARITY_ACTIVE_LOW
      • Polarity.from_string()
      • Polarity.name
      • Polarity.value
      • Polarity.values
    • NMEABaudRate
      • NMEABaudRate.BAUD_115200
      • NMEABaudRate.BAUD_9600
      • NMEABaudRate.from_string()
      • NMEABaudRate.name
      • NMEABaudRate.value
      • NMEABaudRate.values
    • 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
      • ValidatorIssues.critical
      • ValidatorIssues.information
      • ValidatorIssues.warning
    • ValidatorEntry
      • ValidatorEntry.get_msg()
      • ValidatorEntry.get_path()
    • ProductInfo
      • ProductInfo.beam_config
      • ProductInfo.beam_count
      • ProductInfo.form_factor
      • ProductInfo.full_product_info
      • ProductInfo.short_range
  • 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
      • ColHeader.TIMESTAMP
      • ColHeader.ENCODER_COUNT
      • ColHeader.MEASUREMENT_ID
      • ColHeader.STATUS
      • ColHeader.FRAME_ID
    • 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.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.pcap
  • record()
  • Pcap
    • Pcap.metadata
    • Pcap.ports
    • Pcap.reset()
    • Pcap.closed
    • Pcap.close()
• 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_axis_markers()
      • LidarScanViz.scan
      • LidarScanViz.scan_num
      • LidarScanViz.update()
      • LidarScanViz.draw()
      • LidarScanViz.run()
    • SimpleViz
      • SimpleViz.toggle_pause()
      • SimpleViz.seek_relative()
      • SimpleViz.modify_rate()
      • SimpleViz.toggle_osd()
      • SimpleViz.scans_per_sec
      • SimpleViz.run()
    • viz.spezia_palette
    • viz.calref_palette
  • Visual Primitives
    • Cloud for 3D Point Cloud
      • Cloud
        • Cloud.cols
        • Cloud.set_column_poses()
        • Cloud.set_key()
        • Cloud.set_mask()
        • Cloud.set_palette()
        • Cloud.set_point_size()
        • Cloud.set_pose()
        • Cloud.set_range()
        • Cloud.set_xyz()
        • Cloud.size
    • Image for 2D image
      • Image
        • Image.clear_palette()
        • Image.image_pixel_to_window_coordinates()
        • Image.pixel_size()
        • Image.set_hshift()
        • Image.set_image()
        • Image.set_mask()
        • Image.set_palette()
        • Image.set_position()
        • Image.window_coordinates_to_image_pixel()
    • Cuboid for 3D enclosure
      • Cuboid
        • Cuboid.set_rgba()
        • Cuboid.set_transform()
    • Label for 2D and 3D text
      • Label
        • Label.set_position()
        • Label.set_rgba()
        • Label.set_scale()
        • Label.set_text()
  • Camera and TargetDisplay
    • 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
      • TargetDisplay.enable_rings()
      • TargetDisplay.set_ring_line_width()
      • TargetDisplay.set_ring_size()
  • Events WindowCtx
    • WindowCtx
      • WindowCtx.aspect_ratio()
      • WindowCtx.lbutton_down
      • WindowCtx.mbutton_down
      • WindowCtx.mouse_x
      • WindowCtx.mouse_y
      • WindowCtx.normalized_coordinates()
      • WindowCtx.viewport_height
      • WindowCtx.viewport_width
      • WindowCtx.window_height
      • WindowCtx.window_width
  • Viz Utils
    • AxisWithLabel
      • AxisWithLabel.enabled
      • AxisWithLabel.enable()
      • AxisWithLabel.disable()
      • AxisWithLabel.toggle()
      • AxisWithLabel.pose
      • AxisWithLabel.label
      • AxisWithLabel.update()
• Module ouster.sdk.examples
  • Client Examples ouster.sdk.examples.client
    • configure_dual_returns()
    • configure_sensor_params()
    • fetch_metadata()
    • filter_3d_by_range_and_azimuth()
    • live_plot_reflectivity()
    • plot_xyz_points()
    • record_pcap()
  • PCAP Examples ouster.sdk.examples.pcap
    • pcap_3d_one_scan()
    • pcap_display_xyz_points()
    • pcap_to_las()
    • pcap_to_pcd()
    • pcap_to_ply()
    • pcap_query_scan()
    • pcap_read_packets()
    • main()
  • Open3D Examples ouster.sdk.examples.open3d
  • Examples PointViz ouster.sdk.examples.viz
    • make_checker_board()
    • main()
  • Reference Code ouster.sdk.examples.reference
    • xyz_proj_beam_to_sensor_transform()
    • xyz_proj_origin_to_origin_mm()
    • destagger()
• Module ouster.sdk.osf
  • Low-Level API
    • Writing OSF files
      • Writer to create OSF file
        • Writer
          • Writer.add_metadata()
          • Writer.add_sensor()
          • Writer.close()
          • Writer.filename()
          • Writer.is_closed()
          • Writer.meta_store
          • Writer.metadata_id()
          • Writer.save()
          • Writer.save_message()
          • Writer.sensor_info()
          • Writer.sensor_info_count()
          • Writer.set_metadata_id()
  • High-Level API
    • osf.Scans just read LidarScan objects from a file
      • Scans
        • Scans.__iter__()
        • Scans.withTs()
        • Scans.close()
        • Scans.metadata
        • Scans.is_live
        • Scans.is_seekable
        • Scans.is_indexed
        • Scans.field_types
        • Scans.fields
        • Scans.scans_num
        • Scans.slice()
        • Scans.clip()
        • Scans.reduce()
        • Scans.mask()