Interface MatchRequest

Serializable decoded pixels and the immutable reference snapshot for one job.

interface MatchRequest {
    options?: Partial<MatchOptions>;
    query: PixelImage;
    queryRegion?: Region;
    reference: ReferenceSnapshot;
}

Index

Properties

options? query queryRegion? reference

Properties

`Optional`options

options?: Partial<MatchOptions>

Overrides merged with DEFAULT_MATCH_OPTIONS before validation/execution.

query

query: PixelImage

Full normalized upload, even when queryRegion selects only its plan area.

`Optional`queryRegion

queryRegion?: Region

Optional rectangle defining the plan being located; full image by default.

reference

reference: ReferenceSnapshot

Frozen selected-area reference; search never extends beyond this snapshot.