Class Stack

Index

Constructors

Properties

alpha bitDepth channels colorModel sameDimensions size

Methods

[iterator] clone filter getImage getImages getValue getValueByIndex histogram map maxImage meanImage medianImage minImage sum

Constructors

constructor

new Stack(images: Image[]): 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
- Defined in Stack.ts:54

Properties

`Readonly`alpha

alpha: boolean

Do the images have an alpha channel?

`Readonly`bitDepth

bitDepth: BitDepth

The bit depth of the images.

`Readonly`channels

channels: number

The number of channels of the images.

`Readonly`colorModel

colorModel: ImageColorModel

The color model of the images.

`Readonly`sameDimensions

sameDimensions: boolean

Whether all the images of the stack have the same dimensions.

`Readonly`size

size: number

The stack size.

Methods

[iterator]

"[iterator]"(): IterableIterator<Image>
Returns IterableIterator<Image>
- Defined in Stack.ts:65

clone

clone(): Stack
Clone a stack. The images are a copy of the original images.

Returns Stack
A new stack with the same images.
- Defined in Stack.ts:75

filter

filter(callback: (image: Image) => boolean): Stack
Filter the images in the stack.
Parameters
- callback: (image: Image) => boolean
  Function to decide which images to keep.
Returns Stack
New filtered stack.
- Defined in Stack.ts:201

getImage

getImage(index: number): Image
Get the image at the given index.
Parameters
- index: number
  The index of the image.
Returns Image
The image.
- Defined in Stack.ts:92

getImages

getImages(): Image[]
Get the images of the stack. Mainly for debugging purposes.

Returns Image[]
The images.
- Defined in Stack.ts:83

getValue

getValue(
    stackIndex: number,
    row: number,
    column: number,
    channel: number,
): 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.
- Defined in Stack.ts:104

getValueByIndex

getValueByIndex(stackIndex: number, index: number, channel: number): 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.
- Defined in Stack.ts:120

histogram

histogram(options?: HistogramOptions): 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.
- Defined in Stack.ts:178

map

map(callback: (image: Image) => Image): Stack
Map a function on all the images of the stack.
Parameters
- callback: (image: Image) => Image
  Function to apply on each image.
Returns Stack
New stack with the modified images.
- Defined in Stack.ts:192

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.
- Defined in Stack.ts:142

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.
- Defined in Stack.ts:160

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.
- Defined in Stack.ts:151

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.
- Defined in Stack.ts:133

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.
- Defined in Stack.ts:169