waterlinkedsonar
C++ client library for the Water Linked Sonar 3D-15
Loading...
Searching...
No Matches
Public Attributes | List of all members
waterlinked::sonar::RangeImageView Struct Reference

Per-pixel distance to the strongest reflection. More...

#include <waterlinkedsonar/messages.hpp>

Public Attributes

MessageHeader header
 
float speed_of_sound {0.0F}
 Configured speed of sound in m/s.
 
float range {0.0F}
 Configured maximum range in meters.
 
std::uint32_t frequency {0}
 Imaging frequency in Hz.
 
std::uint32_t width {0}
 Pixels per row.
 
std::uint32_t height {0}
 Rows.
 
float fov_horizontal {0.0F}
 Degrees.
 
float fov_vertical {0.0F}
 Degrees.
 
float image_pixel_scale {0.0F}
 Multiply a pixel value by this to obtain distance in meters.
 
Span< const std::uint32_t > image_pixel_data
 Row-major, width * height entries holding 16-bit values; 0 means no data.
 

Detailed Description

Per-pixel distance to the strongest reflection.

A view into decoder-owned storage, valid until the next rip::Decoder::decode() call on the decoder that produced it. In Receiver callbacks, valid for the duration of the callback. Copy any data kept longer.

Member Data Documentation

◆ fov_horizontal

float waterlinked::sonar::RangeImageView::fov_horizontal {0.0F}

Degrees.

◆ fov_vertical

float waterlinked::sonar::RangeImageView::fov_vertical {0.0F}

Degrees.

◆ frequency

std::uint32_t waterlinked::sonar::RangeImageView::frequency {0}

Imaging frequency in Hz.

◆ header

MessageHeader waterlinked::sonar::RangeImageView::header

◆ height

std::uint32_t waterlinked::sonar::RangeImageView::height {0}

Rows.

◆ image_pixel_data

Span<const std::uint32_t> waterlinked::sonar::RangeImageView::image_pixel_data

Row-major, width * height entries holding 16-bit values; 0 means no data.

◆ image_pixel_scale

float waterlinked::sonar::RangeImageView::image_pixel_scale {0.0F}

Multiply a pixel value by this to obtain distance in meters.

◆ range

float waterlinked::sonar::RangeImageView::range {0.0F}

Configured maximum range in meters.

◆ speed_of_sound

float waterlinked::sonar::RangeImageView::speed_of_sound {0.0F}

Configured speed of sound in m/s.

◆ width

std::uint32_t waterlinked::sonar::RangeImageView::width {0}

Pixels per row.


The documentation for this struct was generated from the following file: