tinyimg - v1.0.0
    Preparing search index...

    Interface PlanDecision

    What the planner decided, before any pixel was touched.

    interface PlanDecision {
        collapsed: number;
        colorStages: number;
        decoded: Extent;
        eliminated: number;
        estimateMs: number;
        kernels: string[];
        operations: number;
        output: Extent & { channels: number };
        passes: number;
        region: Rect;
        scale: number;
    }
    Index
    collapsed: number

    Operations a pair rule merged into another.

    colorStages: number

    Color stages the operations collapsed into.

    decoded: Extent

    Extent the decode produced.

    eliminated: number

    Operations an identity or annihilation rule removed.

    estimateMs: number

    What running this plan is expected to cost in milliseconds, before any encoder.

    An estimate and not a promise: the rates behind it were measured on one machine, and against real transforms it lands within about 20%. That is the accuracy the question needs when the question is whether work will fit inside a CPU limit, and it is not a substitute for measuring, which TinyImgModule.measure does.

    0 when the source header could not be read.

    kernels: string[]

    Special cases the planner took, by name.

    operations: number

    Operations left after the rewrites.

    output: Extent & { channels: number }

    Extent of the final image, and how many channels it carries.

    Type Declaration

    • channels: number

      Channels per pixel, 1 through 4.

    passes: number

    Fused passes the run will make.

    region: Rect

    The region of the source the decoder was asked for.

    scale: number

    The subsampling denominator the decoder was asked for: 1, 2, 4 or 8.