Skip to main content

OccupancyGrid

Struct OccupancyGrid 

Source
pub struct OccupancyGrid {
    pub resolution: f32,
    pub width: u32,
    pub height: u32,
    pub origin: Pose,
    pub cells: Vec<i8>,
}
Expand description

A 2-D occupancy costmap — std/nav/v1/OccupancyGrid, row-major.

Fields§

§resolution: f32

The size of one cell, in metres.

§width: u32

The grid’s width in cells.

§height: u32

The grid’s height in cells.

§origin: Pose

The pose of cell (0, 0).

§cells: Vec<i8>

width * height occupancy values, row-major: -1 unknown, 0..=100 the occupancy probability as a percentage.

Implementations§

Source§

impl OccupancyGrid

Source

pub fn new( resolution: f32, width: u32, height: u32, origin: Pose, cells: Vec<i8>, ) -> Result<Self>

A grid whose cell count matches its dimensions.

§Errors

DataError::ChildLengthMismatch when cells.len() != width * height.

Source

pub fn cell_at(&self, x: u32, y: u32) -> Option<i8>

The occupancy at (x, y), or None outside the grid.

Source

pub fn check_dimensions(&self) -> Result<()>

Checks that the cell count matches the declared dimensions.

§Errors

DataError::ChildLengthMismatch.

Source

pub fn layout() -> DataType

The columnar layout of this type.

Trait Implementations§

Source§

impl AstrsMessage for OccupancyGrid

Source§

const URN: &'static str = "std/nav/v1/OccupancyGrid"

The type URN this message’s columnar layout is declared against (blueprint §24.3), e.g. "std/vision/v1/Detections".
Source§

fn data_type() -> DataType

The columnar layout AstrsMessage::to_record_batch produces and AstrsMessage::from_record_batch expects.
Source§

fn to_record_batch(&self) -> Result<RecordBatch>

Encodes one message into a one-row RecordBatch (blueprint §6.1’s “one record batch per message”). Read more
Source§

fn from_record_batch(batch: &RecordBatch) -> Result<Self>

Decodes one message from a one-row RecordBatch. Read more
Source§

fn schema() -> Schema

The single-column Schema wrapping AstrsMessage::data_type under crate::DATA_COLUMN (blueprint §6.1).
Source§

fn type_urn() -> Result<TypeUrn, TypeUrnError>

Source§

impl Clone for OccupancyGrid

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OccupancyGrid

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OccupancyGrid

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl FromPayload for OccupancyGrid

Source§

fn from_batch(batch: &RecordBatch) -> Result<Self>

Reads the value from a decoded payload batch. Read more
Source§

impl PartialEq for OccupancyGrid

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OccupancyGrid

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more