Enum DiffmapWeighting 

#[non_exhaustive]
pub enum DiffmapWeighting {
    Trained,
    Balanced,
    Custom([f32; 3]),
}

Channel weighting scheme for combining per-channel SSIM error into the final diffmap.

The diffmap computes SSIM error independently on each XYB channel. This enum controls how those three per-channel error values are combined into a single per-pixel value.

Which to use

• Trained — best for encoder quant loops. Matches the trained model’s view of what matters: almost pure luminance.
• Balanced — useful for visualization or when you want color errors to be visible in the map even if the model doesn’t weight them heavily at full resolution.
• Custom — full control. Weights are normalized to sum to 1.0.

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.

Trained

Per-scale weights derived from the profile’s trained SSIM feature weights. Each scale gets its own channel weights (SSIM features per channel, normalized) and a blend weight proportional to the total weight mass at that scale.

For the default profile (v0.1), scale 0 (full res) contributes ~6% of the blend, while scales 1-3 contribute ~28-35% each. At scale 0, channel weights are Y-dominant (~99.3% luminance). At coarser scales, color channels gain more influence.

Automatically tracks the profile passed to crate::Zensim::new.

Balanced

Moderate Y-dominant weights with visible color contribution: [0.15, 0.70, 0.15] (X, Y, B).

Useful for visualization or when you want the diffmap to show color distortion even though the trained model doesn’t weight it heavily for SSIM at scale 0.

Custom([f32; 3])

Custom weights [X, Y, B]. Automatically normalized to sum to 1.0. All values must be non-negative.

Trait Implementations

impl Clone for DiffmapWeighting

fn clone(&self) -> DiffmapWeighting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiffmapWeighting

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

Formats the value using the given formatter.

impl Default for DiffmapWeighting

fn default() -> Self

Defaults to Trained.

impl From<DiffmapWeighting> for DiffmapOptions

fn from(w: DiffmapWeighting) -> Self

Converts to this type from the input type.

impl Copy for DiffmapWeighting