Struct FlowField 

pub struct FlowField {
    pub vectors: Vec<FlowVector>,
    pub width: usize,
    pub height: usize,
}

A dense optical flow field over a regular block grid.

Fields

vectors: Vec<FlowVector>

Row-major vector storage (block_rows × block_cols).

width: usize

Frame width in pixels.

height: usize

Frame height in pixels.

Implementations

impl FlowField

pub fn new(width: usize, height: usize, block_size: usize) -> Self

Create a new zeroed flow field for a frame of the given dimensions.

pub fn block_cols(&self, block_size: usize) -> usize

Number of block columns stored in this field.

pub fn block_rows(&self, block_size: usize) -> usize

Number of block rows stored in this field.

pub fn at(&self, x: usize, y: usize) -> &FlowVector

Return a reference to the flow vector at block column x, block row y.

Panics

Panics if the index is out of bounds.

pub fn average_magnitude(&self) -> f32

Arithmetic mean of the magnitudes of all flow vectors.

Returns 0.0 if the field is empty.

pub fn dominant_direction(&self) -> FlowVector

Return a single FlowVector representing the arithmetic mean of all vectors (the dominant translation direction).

Trait Implementations

impl Clone for FlowField

fn clone(&self) -> FlowField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowField

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

Formats the value using the given formatter.