Enum MotionCompensationMode 

#[non_exhaustive]
pub enum MotionCompensationMode {
    None,
    Mvtools {
        blksize: u32,
        overlap: u32,
        search_radius: u32,
        pyramid_levels: u32,
        estimation: MotionEstimation,
    },
}

How motion compensation is set up for a denoise pass.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

Motion compensation is off, and no extra buffers are allocated.

Mvtools

An estimator inspired by MVTools tracks each block, and the neighbouring frames are shifted toward the centre frame at denoise time.

Fields

blksize: u32

The side length of each motion-search block, in pixels at the finest pyramid level.

overlap: u32

How many pixels neighbouring blocks overlap.

This has to be strictly below blksize, so the step between blocks stays positive.

Anything above 0 leaves room for the raised-cosine blend in the compensate step, which currently uses a winner-takes-all rule instead.

search_radius: u32

The search radius in pixels at the finest pyramid level.

The coarse pass uses the same radius on a half-size image, so its real reach is twice as far.

pyramid_levels: u32

How many levels the pyramid has.

1 means a single full-resolution search. 2 adds a half-size coarse pass that seeds the fine one. The maximum is [MAX_PYRAMID_LEVELS].

estimation: MotionEstimation

How motion toward each temporal neighbour is estimated.

Auto, the default, picks a strategy from the temporal radius and is what callers normally want. Naming Direct or Chained is mostly useful for pinning one strategy in tests and benches.

Implementations

impl MotionCompensationMode

pub fn mvtools_default() -> Self

Builds an Mvtools mode from the library defaults.

This pins estimation to Direct rather than the field’s own Auto default, so it never switches to Chained at larger temporal radii the way an Auto configuration would.

pub fn validate(&self) -> Result<(), Error>

Rejects parameter combinations the kernels cannot honour.

Trait Implementations

impl Clone for MotionCompensationMode

fn clone(&self) -> MotionCompensationMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MotionCompensationMode

impl Debug for MotionCompensationMode

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

Formats the value using the given formatter.

impl Default for MotionCompensationMode

fn default() -> MotionCompensationMode

Returns the “default value” for a type.

impl From<MotionSearch> for MotionCompensationMode

fn from(search: MotionSearch) -> Self

Converts to this type from the input type.

impl PartialEq for MotionCompensationMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MotionCompensationMode