Class Stack

constructor

• new Stack(images): Stack

• Create a new stack from an array of images. The images must have the same bit depth and color model.

  Parameters

  • images: Image[]

    Array of images from which to create the stack.

  Returns Stack

Readonly alpha

Readonly bitDepth

Readonly channels

Readonly colorModel

Readonly sameDimensions

Readonly size

[iterator]

• [iterator](): IterableIterator<Image>

• Returns IterableIterator<Image>

clone

• clone(): Stack

• Clone a stack. The images are a copy of the original images.

  Returns Stack

  A new stack with the same images.

filter

• filter(callback): Stack

• Filter the images in the stack.

  Parameters

  • callback: ((image) => boolean)

    Function to decide which images to keep.

    • • (image): boolean

      • Parameters

        • image: Image

        Returns boolean

  Returns Stack

  New filtered stack.

getImage

• getImage(index): Image

• Get the image at the given index.

  Parameters

  • index: number

    The index of the image.

  Returns Image

  The image.

getImages

• getImages(): Image[]

• Get the images of the stack. Mainly for debugging purposes.

  Returns Image[]

  The images.

getValue

• getValue(stackIndex, row, column, channel): number

• Get a value from an image of the stack.

  Parameters

  • stackIndex: number

    Index of the image in the stack.

  • row: number

    Row index of the pixel.

  • column: number

    Column index of the pixel.

  • channel: number

    The channel to retrieve.

  Returns number

  The value at the given position.

getValueByIndex

• getValueByIndex(stackIndex, index, channel): number

• Get a value from an image of the stack. Specify the pixel position using its index.

  Parameters

  • stackIndex: number

    Index of the image in the stack.

  • index: number

    The index of the pixel.

  • channel: number

    The channel to retrieve.

  Returns number

  The value at the given position.

histogram

• histogram(options?): Uint32Array

• Get the sum of all the histograms of the stack's images. If no channel is specified in the options, the images must be GREY.

  Parameters

  • options: HistogramOptions = {}

    Histogram options.

  Returns Uint32Array

  The histogram of the stack.

map

• map(callback): Stack

• Map a function on all the images of the stack.

  Parameters

  • callback: ((image) => Image)

    Function to apply on each image.

    • • (image): Image

      • Parameters

        • image: Image

        Returns Image

  Returns Stack

  New stack with the modified images.

maxImage

• maxImage(): Image

• Return the image containing the maximum values of all the images in the stack for each pixel. All the images must have the same dimensions.

  Returns Image

  The maximum image.

meanImage

• meanImage(): Image

• Return the image containing the average values of all the images in the stack for each pixel. All the images must have the same dimensions.

  Returns Image

  The mean image.

medianImage

• medianImage(): Image

• Return the image containing the median values of all the images in the stack for each pixel. All the images must have the same dimensions.

  Returns Image

  The median image.

minImage

• minImage(): Image

• Return the image containing the minimum values of all the images in the stack for each pixel. All the images must have the same dimensions.

  Returns Image

  The minimum image.

sum

• sum(): Image

• Return a 16 bits depth image containing the sum values of all the images in the stack for each pixel.

  Returns Image

  The sum image.