Struct DenoiserOptions 

pub struct DenoiserOptions {
    pub channel_mode: ChannelMode,
    pub mode: DenoisingMode,
    pub algorithm: Algorithm,
    pub prefilter: Option<PrefilterMode>,
    pub motion_compensation: MotionCompensationMode,
    pub nlm: Option<NlmTuning>,
}

User-facing denoiser configuration. Build with DenoiserOptions::builder().

Fields

channel_mode: ChannelMode

Which channels of the frame to denoise.

mode: DenoisingMode

Spatial-only or temporal denoising.

algorithm: Algorithm

Algorithm variant. Nlmeans is the fast default. NlmeansHq adapts weighting to the noise level, measured automatically per frame unless HqParams::sigma_override pins a fixed value. Its default strength multiplier is also different, and adapts to the temporal radius and the plane being denoised, see [crate::nlmeans::hq_default_strength].

prefilter: Option<PrefilterMode>

Reference clip source for NLM weight computation. None (the default) uses no prefilter for either algorithm. Set PrefilterMode::NlmSpatial explicitly to opt into the NLM spatial pilot.

motion_compensation: MotionCompensationMode

Motion-compensation mode for temporal denoising. None disables MC; Mvtools warps temporal neighbours into spatial alignment with the centre frame before NLM weighting. Only takes effect when mode is Temporal { .. }.

nlm: Option<NlmTuning>

Override NLM tuning (search/patch radius, strength, self-weight). None uses the defaults baked into [NlmParams].

Implementations

impl DenoiserOptions

pub fn builder() -> DenoiserOptionsBuilder

Create an instance of DenoiserOptions using the builder syntax

Trait Implementations

impl Clone for DenoiserOptions

fn clone(&self) -> DenoiserOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DenoiserOptions

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

Formats the value using the given formatter.