Georeferencing API
    Preparing search index...

    Type Alias EngineRequest

    EngineRequest:
        | EncodeRequest
        | { file: File; kind: "inspect" }
        | { file: File; kind: "normalize"; metadata: ImageMetadata }
        | {
            gcps: Gcp[];
            kind: "fit";
            metadata: ImageMetadata;
            model: Model;
            workingCrs: string;
        }
        | {
            file: File;
            fit: Fit;
            kind: "render";
            metadata: ImageMetadata;
            output: OutputSettings;
            preview: boolean;
            workingCrs: string;
        }

    Worker operation discriminated by kind. Inspect reads identity and preview; normalize creates a full-resolution PNG; fit converts GCP target CRSs; render warps pixels and delegates optional encoding to plugin workers.

    Type Declaration

    • EncodeRequest
    • { file: File; kind: "inspect" }
      • file: File

        Original local image bytes, retained independently of the document.

      • kind: "inspect"

        Operation discriminator selecting inspection, normalization, fitting or rendering.

    • { file: File; kind: "normalize"; metadata: ImageMetadata }
      • file: File

        Original local image bytes, retained independently of the document.

      • kind: "normalize"

        Operation discriminator selecting inspection, normalization, fitting or rendering.

      • metadata: ImageMetadata

        Previously inspected identity and canonical image dimensions for these bytes.

    • {
          gcps: Gcp[];
          kind: "fit";
          metadata: ImageMetadata;
          model: Model;
          workingCrs: string;
      }
      • gcps: Gcp[]

        Paired points; each target is projected from its declared CRS before fitting.

      • kind: "fit"

        Operation discriminator selecting inspection, normalization, fitting or rendering.

      • metadata: ImageMetadata

        Previously inspected identity and canonical image dimensions for these bytes.

      • model: Model

        Exact requested model; there is no model substitution.

      • workingCrs: string

        CRS for fitting and evaluating transformation coordinates.

    • {
          file: File;
          fit: Fit;
          kind: "render";
          metadata: ImageMetadata;
          output: OutputSettings;
          preview: boolean;
          workingCrs: string;
      }
      • file: File

        Original local image bytes, retained independently of the document.

      • fit: Fit

        Validated fit in the declared working CRS for this image/alignment.

      • kind: "render"

        Operation discriminator selecting inspection, normalization, fitting or rendering.

      • metadata: ImageMetadata

        Previously inspected identity and canonical image dimensions for these bytes.

      • output: OutputSettings

        Explicit output CRS, bounds, resolution and encoding settings.

      • preview: boolean

        True for a reduced-resolution preview; false for raw full-resolution pixels. Encoding is a separate plugin job.

      • workingCrs: string

        CRS for fitting and evaluating transformation coordinates.