Class: NVZarrHelper
Defined in: nvimage/zarr/NVZarrHelper.ts:142
Properties
| Property | Type | Default value | Defined in |
|---|---|---|---|
centerAtDragStart | object | null | nvimage/zarr/NVZarrHelper.ts:183 |
centerAtDragStart.x | number | undefined | nvimage/zarr/NVZarrHelper.ts:183 |
centerAtDragStart.y | number | undefined | nvimage/zarr/NVZarrHelper.ts:183 |
centerAtDragStart.z | number | undefined | nvimage/zarr/NVZarrHelper.ts:183 |
onAllChunksLoaded? | () => void | undefined | nvimage/zarr/NVZarrHelper.ts:186 |
onChunksUpdated? | () => void | undefined | nvimage/zarr/NVZarrHelper.ts:185 |
Methods
beginDrag()
beginDrag(): void;
Defined in: nvimage/zarr/NVZarrHelper.ts:518
Returns
void
clearCache()
clearCache(): void;
Defined in: nvimage/zarr/NVZarrHelper.ts:1034
Returns
void
endDrag()
endDrag(): void;
Defined in: nvimage/zarr/NVZarrHelper.ts:522
Returns
void
getLevelDims()
getLevelDims(): object;
Defined in: nvimage/zarr/NVZarrHelper.ts:594
Returns
object
| Name | Type | Defined in |
|---|---|---|
depth | number | nvimage/zarr/NVZarrHelper.ts:594 |
height | number | nvimage/zarr/NVZarrHelper.ts:594 |
width | number | nvimage/zarr/NVZarrHelper.ts:594 |
getPyramidInfo()
getPyramidInfo(): ZarrPyramidInfo;
Defined in: nvimage/zarr/NVZarrHelper.ts:586
Returns
getPyramidLevel()
getPyramidLevel(): number;
Defined in: nvimage/zarr/NVZarrHelper.ts:590
Returns
number
getViewportState()
getViewportState(): object;
Defined in: nvimage/zarr/NVZarrHelper.ts:577
Returns
object
| Name | Type | Defined in |
|---|---|---|
centerX | number | nvimage/zarr/NVZarrHelper.ts:577 |
centerY | number | nvimage/zarr/NVZarrHelper.ts:577 |
centerZ | number | nvimage/zarr/NVZarrHelper.ts:577 |
level | number | nvimage/zarr/NVZarrHelper.ts:577 |
getVolumeDims()
getVolumeDims(): object;
Defined in: nvimage/zarr/NVZarrHelper.ts:598
Returns
object
| Name | Type | Defined in |
|---|---|---|
depth | number | nvimage/zarr/NVZarrHelper.ts:598 |
height | number | nvimage/zarr/NVZarrHelper.ts:598 |
width | number | nvimage/zarr/NVZarrHelper.ts:598 |
getWorldOffset()
getWorldOffset(): [number, number, number];
Defined in: nvimage/zarr/NVZarrHelper.ts:602
Returns
[number, number, number]
loadInitialChunks()
loadInitialChunks(): Promise<void>;
Defined in: nvimage/zarr/NVZarrHelper.ts:269
Returns
Promise<void>
mmToLevelCoords()
mmToLevelCoords(
mmX: number,
mmY: number,
mmZ: number): object;
Defined in: nvimage/zarr/NVZarrHelper.ts:648
Convert physical (mm) coordinates back to real zarr level pixel coordinates. Inverts the affine: levelPixel = (mm - OME_translation) / scale
Parameters
| Parameter | Type |
|---|---|
mmX | number |
mmY | number |
mmZ | number |
Returns
object
| Name | Type | Defined in |
|---|---|---|
depth | number | nvimage/zarr/NVZarrHelper.ts:655 |
height | number | nvimage/zarr/NVZarrHelper.ts:654 |
level | number | nvimage/zarr/NVZarrHelper.ts:656 |
levelDims | object | nvimage/zarr/NVZarrHelper.ts:657 |
levelDims.depth | number | nvimage/zarr/NVZarrHelper.ts:657 |
levelDims.height | number | nvimage/zarr/NVZarrHelper.ts:657 |
levelDims.width | number | nvimage/zarr/NVZarrHelper.ts:657 |
width | number | nvimage/zarr/NVZarrHelper.ts:653 |
panBy()
panBy(
dx: number,
dy: number,
dz: number): Promise<void>;
Defined in: nvimage/zarr/NVZarrHelper.ts:526
Parameters
| Parameter | Type | Default value |
|---|---|---|
dx | number | undefined |
dy | number | undefined |
dz | number | 0 |
Returns
Promise<void>
panTo()
panTo(
newCenterX: number,
newCenterY: number,
newCenterZ?: number): Promise<void>;
Defined in: nvimage/zarr/NVZarrHelper.ts:535
Parameters
| Parameter | Type |
|---|---|
newCenterX | number |
newCenterY | number |
newCenterZ? | number |
Returns
Promise<void>
refresh()
refresh(): Promise<void>;
Defined in: nvimage/zarr/NVZarrHelper.ts:1038
Returns
Promise<void>
setPyramidLevel()
setPyramidLevel(level: number): Promise<void>;
Defined in: nvimage/zarr/NVZarrHelper.ts:556
Parameters
| Parameter | Type |
|---|---|
level | number |
Returns
Promise<void>
setWorldCenter()
setWorldCenter(targetMM: [number, number, number]): void;
Defined in: nvimage/zarr/NVZarrHelper.ts:611
Set the world-space offset so the full level's center maps to targetMM in world space. Computes the native physical center of the zarr level, then sets worldOffsetMM so that center aligns with targetMM. Also centers the viewport on the level center.
Parameters
| Parameter | Type |
|---|---|
targetMM | [number, number, number] |
Returns
void
create()
static create(
hostImage: NVImage,
url: string,
options: NVZarrHelperOptions): Promise<NVZarrHelper>;
Defined in: nvimage/zarr/NVZarrHelper.ts:208
Parameters
| Parameter | Type |
|---|---|
hostImage | NVImage |
url | string |
options | NVZarrHelperOptions |
Returns
Promise<NVZarrHelper>