Skip to main content

OccupancyGridMap

Struct OccupancyGridMap 

Source
pub struct OccupancyGridMap {
    pub grid: Vec<Vec<f64>>,
    pub config: OccupancyGridConfig,
}
Expand description

Occupancy grid map stored as log-odds values.

The grid is indexed as grid[ix][iy] where ix is the column (x-axis) and iy is the row (y-axis). World coordinate (0, 0) maps to the centre of the grid.

Fields§

§grid: Vec<Vec<f64>>

Log-odds grid: grid[ix][iy].

§config: OccupancyGridConfig

Configuration used to build this map.

Implementations§

Source§

impl OccupancyGridMap

Source

pub fn new(config: OccupancyGridConfig) -> Self

Create a new occupancy grid initialised to config.prior_log_odds.

Source

pub fn update_with_scan( &mut self, robot_x: f64, robot_y: f64, robot_yaw: f64, scan_ranges: &[f64], angle_min: f64, angle_increment: f64, )

Update the map from a single 2-D laser scan.

§Parameters
  • robot_x, robot_y – robot position in world coordinates [m].
  • robot_yaw – robot heading [rad].
  • scan_ranges – measured ranges for each beam [m].
  • angle_min – angle of the first beam relative to the robot heading [rad].
  • angle_increment – angular step between consecutive beams [rad].
Source

pub fn get_probability(&self, ix: usize, iy: usize) -> f64

Convert a log-odds value at (ix, iy) to an occupancy probability.

Returns a value in [0, 1] via 1 - 1 / (1 + exp(l)).

Source

pub fn world_to_grid(&self, x: f64, y: f64) -> Option<(usize, usize)>

Convert world coordinates to grid indices.

Returns None when the point lies outside the grid.

Source

pub fn is_occupied(&self, ix: usize, iy: usize, threshold: f64) -> bool

Return true when the occupancy probability at (ix, iy) exceeds threshold.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V