Skip to main content

CompressionConfig

Struct CompressionConfig 

Source
pub struct CompressionConfig {
    pub encoding: EncodingOptions,
    pub compression: CompressionOption,
    pub resolution: Option<f32>,
}
Expand description

Controls how a PointCloud2Msg is encoded and compressed.

Use the smart constructors for common cases, or build one manually for custom per-field resolution control via CompressionConfig::with_resolution.

§Examples

use cloudini::ros::CompressionConfig;

// 1 mm lossy + ZSTD (typical Lidar geometry)
let cfg = CompressionConfig::lossy_zstd(0.001);

// 1 cm lossy + LZ4 (real-time, slightly larger files)
let cfg = CompressionConfig::lossy_lz4(0.01);

// lossless XOR-encoding + ZSTD (preserves every float bit)
let cfg = CompressionConfig::lossless_zstd();

Fields§

§encoding: EncodingOptions

Field-level encoding algorithm.

§compression: CompressionOption

Block compression applied after field encoding.

§resolution: Option<f32>

Quantisation step for all float fields (None → copy verbatim / XOR lossless).

Implementations§

Source§

impl CompressionConfig

Source

pub fn lossy_zstd(resolution: f32) -> Self

Lossy float quantisation + ZSTD block compression.

resolution is the quantisation step (e.g. 0.001 for 1 mm precision). Maximum per-component error is resolution / 2.

Source

pub fn lossy_lz4(resolution: f32) -> Self

Lossy float quantisation + LZ4 block compression.

Faster than Self::lossy_zstd at the cost of a slightly larger output.

Source

pub fn lossless_zstd() -> Self

Lossless XOR encoding (Float64) + ZSTD block compression.

Every float bit is preserved exactly. Use when downstream algorithms are sensitive to floating-point rounding (e.g. ICP, odometry).

Source

pub fn lossless_lz4() -> Self

Lossless XOR encoding (Float64) + LZ4 block compression.

Source

pub fn with_resolution(self, resolution: f32) -> Self

Override the quantisation resolution after construction.

Useful to start from a preset and then fine-tune:

use cloudini::ros::CompressionConfig;
let cfg = CompressionConfig::lossy_zstd(0.001).with_resolution(0.005);

Trait Implementations§

Source§

impl Clone for CompressionConfig

Source§

fn clone(&self) -> CompressionConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompressionConfig

Source§

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

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

impl Default for CompressionConfig

Source§

fn default() -> Self

Default: 1 mm lossy + ZSTD — good for most Lidar workloads.

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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, 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.