Skip to main content

Interface: LabelsData

Defined in: storage/labels.ts:21

Loaded label image data providing a tiled, multi-resolution integer raster

Each pixel value represents a label (segment) ID.

Extends​

Methods​

close()​

close(): void

Defined in: storage/base.ts:44

Releases all resources held by this data object

Returns​

void

Inherited from​

ItemsData.close

getHeight()​

getHeight(level?): number

Defined in: storage/labels.ts:34

Returns the full labels image height in pixels

Parameters​

level?​

number

Pyramid level (defaults to the highest resolution)

Returns​

number

getIds()​

getIds(): number[]

Defined in: storage/base.ts:55

Returns an array of item IDs

Returns​

number[]

Inherited from​

ItemsData.getIds

getLevelCount()​

getLevelCount(): number

Defined in: storage/labels.ts:37

Returns the number of pyramid levels

Returns​

number

getLevelScale()​

getLevelScale(level): number

Defined in: storage/labels.ts:45

Returns the scale factor for a given pyramid level relative to the highest resolution

Parameters​

level​

number

Pyramid level

Returns​

number

getNames()​

getNames(): string[] | undefined

Defined in: storage/base.ts:61

Returns the item names if available, otherwise undefined

Returns​

string[] | undefined

Inherited from​

ItemsData.getNames

getSize()​

getSize(): number

Defined in: storage/base.ts:58

Returns the total number of items

Returns​

number

Inherited from​

ItemsData.getSize

getTileHeight()​

getTileHeight(level): number

Defined in: storage/labels.ts:59

Returns the tile height for a given pyramid level

Parameters​

level​

number

Pyramid level

Returns​

number

getTileWidth()​

getTileWidth(level): number

Defined in: storage/labels.ts:52

Returns the tile width for a given pyramid level

Parameters​

level​

number

Pyramid level

Returns​

number

getWidth()​

getWidth(level?): number

Defined in: storage/labels.ts:27

Returns the full labels image width in pixels

Parameters​

level?​

number

Pyramid level (defaults to the highest resolution)

Returns​

number

loadTile()​

loadTile(level, x, y, options?): Promise<UintArray>

Defined in: storage/labels.ts:69

Loads a single tile as an unsigned integer array

Parameters​

level​

number

Pyramid level

x​

number

Tile column index

y​

number

Tile row index

options?​

Optional abort signal and progress callback

onProgress?​

ProgressCallback

signal?​

AbortSignal

Returns​

Promise<UintArray>