Class Pipeline

constructor

• new Pipeline(ops?: readonly OpSpec[]): Pipeline

  Use pipeline() or Pipeline.fromJSON().

  Parameters

  • ops: readonly OpSpec[] = []

  Returns Pipeline

Readonlyops

margin

• get margin(): number

  Pixels of context the pipeline needs around each part of a picture: when a tile is run with this many pixels of its neighbours on every side (and the margin is cropped off afterwards), it matches the same area of the whole picture run at once, so tile seams cannot show. 0 unless the pipeline has sharpen steps.

  Returns number

isIdentity

• get isIdentity(): boolean

  True when no step changes the image (an empty pipeline, or every step at its neutral value).

  Returns boolean

needsStats

• get needsStats(): boolean

  True when the pipeline has autoStretch steps that still need statistics.

  Returns boolean

StaticfromJSON

• fromJSON(json: string | PipelineJSON): Pipeline

  Restores a pipeline saved with toJSON() (object or JSON string).

  Parameters

  • json: string | PipelineJSON

  Returns Pipeline

add

• add(op: OpSpec): Pipeline

  Returns a new pipeline with op appended. Pipelines are immutable.

  Parameters

  • op: OpSpec

  Returns Pipeline

brightness

• brightness(amount: number): Pipeline

  Brightness, -1 to 1.

  Parameters

  • amount: number

  Returns Pipeline

contrast

• contrast(amount: number): Pipeline

  Contrast, -1 to 1.

  Parameters

  • amount: number

  Returns Pipeline

exposure

• exposure(ev: number): Pipeline

  Exposure in EV stops, -10 to 10.

  Parameters

  • ev: number

  Returns Pipeline

gamma

• gamma(value: number): Pipeline

  Gamma, 0.1 to 10.

  Parameters

  • value: number

  Returns Pipeline

saturation

• saturation(amount: number): Pipeline

  Saturation, -1 to 1. No effect on monochrome images.

  Parameters

  • amount: number

  Returns Pipeline

temperature

• temperature(amount: number): Pipeline

  Color temperature, -1 (cool) to 1 (warm). No effect on monochrome images.

  Parameters

  • amount: number

  Returns Pipeline

tint

• tint(amount: number): Pipeline

  Tint, -1 (green) to 1 (magenta): the color axis temperature does not cover. No effect on monochrome images.

  Parameters

  • amount: number

  Returns Pipeline

whiteBalance

• whiteBalance(gray: WhiteBalanceOptions): Pipeline

  White balance from a gray point: gray is the color (sRGB-encoded, 0-1) of something that should be neutral, for example from sampleColor on the image. Put it first so it sees the colors of the original image. No effect on monochrome images.

  Parameters

  • gray: WhiteBalanceOptions

  Returns Pipeline

shadows

• shadows(amount: number): Pipeline

  Shadows, -1 (darker) to 1 (lifted): moves dark tones, leaving black, white and highlights almost unchanged.

  Parameters

  • amount: number

  Returns Pipeline

highlights

• highlights(amount: number): Pipeline

  Highlights, -1 (recovered, darker) to 1 (brighter): moves light tones, leaving black, white and shadows almost unchanged.

  Parameters

  • amount: number

  Returns Pipeline

curve

• curve(options: CurveOptions): Pipeline

  Tone curve (see CurveOptions): points [input, output] on the sRGB 0-1 scale joined by a smooth curve, for all channels and per channel.

  Parameters

  • options: CurveOptions

  Returns Pipeline

  Example

  pipeline().curve({ points: [[0.25, 0.2], [0.75, 0.8]] }); // gentle S curve: more contrast
  Copy

levels

• levels(params: LevelsOptions): Pipeline

  Levels (black/white points 0-1, midtone gamma).

  Parameters

  • params: LevelsOptions

  Returns Pipeline

stretch

• stretch(params: StretchOptions): Pipeline

  Stretches the range black..white (sRGB-encoded, one number or [R, G, B]) to full black..white.

  Parameters

  • params: StretchOptions

  Returns Pipeline

autoStretch

• autoStretch(options?: AutoStretchOptions): Pipeline

  Automatic stretch (dynamic range adjustment). The range comes from the pixel distribution of the image as it reaches this step, ignoring transparent pixels. run takes the statistics from the image it is given; for tiles, collect statistics over the area you show and call resolve.

  Parameters

  • Optionaloptions: AutoStretchOptions

  Returns Pipeline

sharpen

• sharpen(options?: SharpenOptions): Pipeline

  Sharpens with an unsharp mask (see SharpenOptions). Run on its own image, the result is the same whether or not it is split across workers. For tiles of a larger picture, give each tile Pipeline.margin pixels of its neighbours so the tile edges do not show.

  Parameters

  • Optionaloptions: SharpenOptions

  Returns Pipeline

set

• set<
      N extends
          | "saturation"
          | "brightness"
          | "contrast"
          | "exposure"
          | "gamma"
          | "temperature"
          | "tint"
          | "whiteBalance"
          | "shadows"
          | "highlights"
          | "curve"
          | "levels"
          | "stretch"
          | "autoStretch"
          | "sharpen",
  >(
      op: N,
      params: number | StepOptions[N],
  ): Pipeline

  Returns a pipeline with step op set to params: the first step of that kind is updated in place (parameters not given keep their values), or the step is appended when the pipeline has none. Made for controls: each slider sets its own step without rebuilding the chain.

  Steps with one main value (brightness, contrast, exposure, gamma, saturation, temperature, sharpen, ...) also take that value as a number; OpInfo.value names it.

  Type Parameters

  • N extends
        | "saturation"
        | "brightness"
        | "contrast"
        | "exposure"
        | "gamma"
        | "temperature"
        | "tint"
        | "whiteBalance"
        | "shadows"
        | "highlights"
        | "curve"
        | "levels"
        | "stretch"
        | "autoStretch"
        | "sharpen"

  Parameters

  • op: N
  • params: number | StepOptions[N]

  Returns Pipeline

  Example

  let p = pipeline().exposure(0).contrast(0).sharpen({ amount: 0 });
  p = p.set('contrast', 0.3);                // same as { amount: 0.3 }
  p = p.set('sharpen', { radius: 2 });       // amount stays 0
  p = p.set('levels', { inBlack: 0.05 });    // appended: there was no levels step
  Copy

get

• get<
      N extends
          | "saturation"
          | "brightness"
          | "contrast"
          | "exposure"
          | "gamma"
          | "temperature"
          | "tint"
          | "whiteBalance"
          | "shadows"
          | "highlights"
          | "curve"
          | "levels"
          | "stretch"
          | "autoStretch"
          | "sharpen",
  >(
      op: N,
  ):
      | Extract<{ op: "brightness"; amount: number }, { op: N }>
      | Extract<{ op: "contrast"; amount: number }, { op: N }>
      | Extract<{ op: "exposure"; ev: number }, { op: N }>
      | Extract<{ op: "gamma"; gamma: number }, { op: N }>
      | Extract<{ op: "saturation"; amount: number }, { op: N }>
      | Extract<{ op: "temperature"; amount: number }, { op: N }>
      | Extract<{ op: "tint"; amount: number }, { op: N }>
      | Extract<
          { op: "whiteBalance" } & Required<WhiteBalanceOptions>,
          { op: N },
      >
      | Extract<{ op: "shadows"; amount: number }, { op: N }>
      | Extract<{ op: "highlights"; amount: number }, { op: N }>
      | Extract<
          {
              op: "curve";
              points: CurvePoint[];
              red: CurvePoint[];
              green: CurvePoint[];
              blue: CurvePoint[];
          },
          { op: N },
      >
      | Extract<{ op: "levels" } & Required<LevelsOptions>, { op: N }>
      | Extract<{ op: "stretch"; black: RGBValues; white: RGBValues }, { op: N }>
      | Extract<{ op: "autoStretch" } & Required<AutoStretchOptions>, { op: N }>
      | Extract<{ op: "sharpen" } & Required<SharpenOptions>, { op: N }>
      | undefined

  The first step of kind op, with its normalized parameters, or undefined when there is none.

  Type Parameters

  • N extends
        | "saturation"
        | "brightness"
        | "contrast"
        | "exposure"
        | "gamma"
        | "temperature"
        | "tint"
        | "whiteBalance"
        | "shadows"
        | "highlights"
        | "curve"
        | "levels"
        | "stretch"
        | "autoStretch"
        | "sharpen"

  Parameters

  • op: N

  Returns
      | Extract<{ op: "brightness"; amount: number }, { op: N }>
      | Extract<{ op: "contrast"; amount: number }, { op: N }>
      | Extract<{ op: "exposure"; ev: number }, { op: N }>
      | Extract<{ op: "gamma"; gamma: number }, { op: N }>
      | Extract<{ op: "saturation"; amount: number }, { op: N }>
      | Extract<{ op: "temperature"; amount: number }, { op: N }>
      | Extract<{ op: "tint"; amount: number }, { op: N }>
      | Extract<
          { op: "whiteBalance" } & Required<WhiteBalanceOptions>,
          { op: N },
      >
      | Extract<{ op: "shadows"; amount: number }, { op: N }>
      | Extract<{ op: "highlights"; amount: number }, { op: N }>
      | Extract<
          {
              op: "curve";
              points: CurvePoint[];
              red: CurvePoint[];
              green: CurvePoint[];
              blue: CurvePoint[];
          },
          { op: N },
      >
      | Extract<{ op: "levels" } & Required<LevelsOptions>, { op: N }>
      | Extract<{ op: "stretch"; black: RGBValues; white: RGBValues }, { op: N }>
      | Extract<{ op: "autoStretch" } & Required<AutoStretchOptions>, { op: N }>
      | Extract<{ op: "sharpen" } & Required<SharpenOptions>, { op: N }>
      | undefined

remove

• remove(
      op:
          | "saturation"
          | "brightness"
          | "contrast"
          | "exposure"
          | "gamma"
          | "temperature"
          | "tint"
          | "whiteBalance"
          | "shadows"
          | "highlights"
          | "curve"
          | "levels"
          | "stretch"
          | "autoStretch"
          | "sharpen",
  ): Pipeline

  Returns a pipeline without any step of kind op.

  Parameters

  • op:
        | "saturation"
        | "brightness"
        | "contrast"
        | "exposure"
        | "gamma"
        | "temperature"
        | "tint"
        | "whiteBalance"
        | "shadows"
        | "highlights"
        | "curve"
        | "levels"
        | "stretch"
        | "autoStretch"
        | "sharpen"

  Returns Pipeline

scaled

• scaled(factor: number): Pipeline

  The same correction for the image shrunk by factor (0.5 = half the width and height): pixel distances (the sharpen radius) are scaled with it, so a preview on a smaller copy looks like the full-size result.

  Parameters

  • factor: number

  Returns Pipeline

resolve

• resolve(stats: Histogram | null): Pipeline

  Returns a pipeline with every autoStretch replaced by a fixed stretch computed from stats, the histogram of the image (or of the area of a tiled image) it will run on. Every image run through the result gets the same range. With null, autoStretch steps are removed.

  Parameters

  • stats: Histogram | null

  Returns Pipeline

toJSON

• toJSON(): PipelineJSON

  Serializable form of the steps, for saving presets. Restore with Pipeline.fromJSON.

  Returns PipelineJSON

runSync

• runSync(image: ImageDataLike, options?: ColorOptions): ImageData

  Runs synchronously on the calling thread.

  Parameters

  • image: ImageDataLike
  • options: ColorOptions = {}

  Returns ImageData

run

• run<O extends RunOptions | undefined = undefined>(
      input: ImageInput,
      options?: O,
  ): Promise<RunResult<O>>

  Runs on any supported input and returns the requested output type.

  Type Parameters

  • O extends RunOptions | undefined = undefined

  Parameters

  • input: ImageInput
  • Optionaloptions: O

  Returns Promise<RunResult<O>>