Class DVIDVolumeChunkSource

Hierarchy

__type<VolumeChunkSourceParameters, {
prototype: __type<any, any>;
new (...args: any[]): __type<DVIDToken, typeof VolumeChunkSource>;
} & typeof VolumeChunkSource, this> & __type<DVIDToken, typeof VolumeChunkSource, this> & VolumeChunkSource<this>
- DVIDVolumeChunkSource

Constructors

constructor

new DVIDVolumeChunkSource(rpc: RPC, options: any): DVIDVolumeChunkSource
Parameters
- rpc: RPC
- options: any
Returns DVIDVolumeChunkSource
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).constructor
- Defined in src/neuroglancer/sliceview/volume/backend.ts:63

Properties

RPC_TYPE_ID

RPC_TYPE_ID: string

Should be set to a constant specifying the SharedObject type identifier on the prototype of final derived owner classes. It is not used on counterpart (non-owner) classes.

chunkConstructor

chunkConstructor: ChunkConstructor<SliceViewChunk>

chunkManager

chunkManager: ChunkManager

chunks

chunks: Map<string, SliceViewChunk>

credentialsProvider

credentialsProvider: CredentialsProvider<DVIDToken>

disposedStacks

disposedStacks: any

freeChunks

freeChunks: Chunk[] = ...

isOwner

isOwner: undefined | boolean

parameters

parameters: VolumeChunkSourceParameters

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

sourceQueueLevel

sourceQueueLevel: number = 0

sourceQueueLevel must be greater than the sourceQueueLevel of any ChunkSource whose download method depends on chunks from this source. A normal ChunkSource with no other dependencies should have a level of 0.

spec

spec: VolumeChunkSpecification

statistics

statistics: Float64Array = ...

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

Methods

addChunk

addChunk(chunk: Chunk): void
Adds the specified chunk to the chunk cache.

If the chunk cache was previously empty, also call this.addRef() to increment the reference count.
Parameters
- chunk: Chunk
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).addChunk
- Defined in src/neuroglancer/chunk_manager/backend.ts:288

addCounterpartRef

addCounterpartRef(): {
gen: number;
id: null | number;
}
Precondition: this.isOwner === true.

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): DVIDVolumeChunkSource
Returns DVIDVolumeChunkSource
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).addRef
- Defined in src/neuroglancer/util/disposable.ts:48

chunkStateChanged

chunkStateChanged(chunk: Chunk, oldState: ChunkState): void
Parameters
- chunk: Chunk
- oldState: ChunkState
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).chunkStateChanged
- Defined in src/neuroglancer/chunk_manager/backend.ts:337

computeChunkBounds

computeChunkBounds(chunk: VolumeChunk): Float32Array
Helper function for computing the voxel bounds of a chunk based on its chunkGridPosition.

This assumes that the grid of chunk positions starts at this.baseVoxelOffset. Chunks are clipped to lie within upperVoxelBound, but are not clipped to lie within lowerVoxelBound. (The frontend code currently cannot handle chunks clipped at their lower corner, and the chunk layout can generally be chosen so that lowerVoxelBound lies on a chunk boundary.)

This sets chunk.chunkDataSize to a copy of the returned chunkDataSize if it differs from this.spec.chunkDataSize; otherwise, it is set to this.spec.chunkDataSize.

Returns
A globally-allocated Vec3 containing the chunk corner position in voxel coordinates. The returned Vec3 will be invalidated by any subsequent call to this method, even on a different VolumeChunkSource instance.
Parameters
- chunk: VolumeChunk
Returns Float32Array
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).computeChunkBounds
- Defined in src/neuroglancer/sliceview/volume/backend.ts:85

counterpartRefCountReachedZero

counterpartRefCountReachedZero(generation: number): void
Precondition: this.isOwner === true.

This should be called when the counterpart's refCount is decremented and reaches zero.
Parameters
- generation: number
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

dispose

dispose(): void
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).disposed
- Defined in src/neuroglancer/util/disposable.ts:75

download

download(chunk: VolumeChunk, cancellationToken: CancellationToken): Promise<void>
Parameters
- chunk: VolumeChunk
- cancellationToken: CancellationToken
Returns Promise<void>
Overrides (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).download
- Defined in src/neuroglancer/datasource/dvid/backend.ts:92

getChunk

getChunk(chunkGridPosition: vec3): SliceViewChunk
Parameters
- chunkGridPosition: vec3
Returns SliceViewChunk
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).getChunk
- Defined in src/neuroglancer/sliceview/backend.ts:302
getChunk(chunkGridPosition: Float32Array): SliceViewChunk
Parameters
- chunkGridPosition: Float32Array
Returns SliceViewChunk
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).getChunk
- Defined in src/neuroglancer/sliceview/backend.ts:318

getDecoder

getDecoder(params: any): ((chunk: VolumeChunk, cancellationToken: CancellationToken, response: ArrayBuffer) => Promise<void>)
Parameters
- params: any
Returns ((chunk: VolumeChunk, cancellationToken: CancellationToken, response: ArrayBuffer) => Promise<void>)
- - (chunk: VolumeChunk, cancellationToken: CancellationToken, response: ArrayBuffer): Promise<void>
  - Parameters
    - chunk: VolumeChunk
    - cancellationToken: CancellationToken
    - response: ArrayBuffer
    Returns Promise<void>
- Defined in src/neuroglancer/datasource/dvid/backend.ts:138

getNewChunk_

getNewChunk_<T>(chunkType: ChunkConstructor<T>): T
Type Parameters
- T extends Chunk<T>
Parameters
- chunkType: ChunkConstructor<T>
Returns T
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).getNewChunk_
- Defined in src/neuroglancer/chunk_manager/backend.ts:268

getPath

getPath(chunkPosition: Float32Array, chunkDataSize: Uint32Array): string
Parameters
- chunkPosition: Float32Array
- chunkDataSize: Uint32Array
Returns string
- Defined in src/neuroglancer/datasource/dvid/backend.ts:116

initializeCounterpart

initializeCounterpart(rpc: RPC, options?: any): void
Parameters
- rpc: RPC
- options: any = {}
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).initializeCounterpart
- Defined in src/neuroglancer/worker_rpc.ts:182

initializeSharedObject

initializeSharedObject(rpc: RPC, rpcId?: number): void
Parameters
- rpc: RPC
- rpcId: number = ...
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

`Protected` ownerDispose

ownerDispose(): void
Precondition: this.isOwner === true.

Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).refCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:203

registerCancellable

registerCancellable<T>(cancellable: T): T
Type Parameters
- T extends {
  cancel: (() => void);
  }
Parameters
- cancellable: T
Returns T
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerChunkListener

registerChunkListener(key: string, listener: ChunkStateListener): boolean
Parameters
- key: string
- listener: ChunkStateListener
Returns boolean
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).registerChunkListener
- Defined in src/neuroglancer/chunk_manager/backend.ts:312

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).registerDisposer
- Defined in src/neuroglancer/util/disposable.ts:76

registerEventListener

registerEventListener(target: EventTarget, type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- target: EventTarget
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

removeChunk

removeChunk(chunk: Chunk): void
Remove the specified chunk from the chunk cache.

If the chunk cache becomes empty, also call this.dispose() to decrement the reference count.
Parameters
- chunk: Chunk
Returns void
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).removeChunk
- Defined in src/neuroglancer/chunk_manager/backend.ts:302

unregisterChunkListener

unregisterChunkListener(key: string, listener: ChunkStateListener): boolean
Parameters
- key: string
- listener: ChunkStateListener
Returns boolean
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).unregisterChunkListener
- Defined in src/neuroglancer/chunk_manager/backend.ts:321

unregisterDisposer

unregisterDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (DVIDSource(VolumeChunkSource, VolumeChunkSourceParameters)).unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

Class DVIDVolumeChunkSource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPC

options: any

Returns DVIDVolumeChunkSource

Properties

RPC_TYPE_ID

chunkConstructor

chunkManager

chunks

credentialsProvider

disposedStacks

freeChunks

isOwner

parameters

refCount

referencedGeneration

rpc

rpcId

sourceQueueLevel

spec

statistics

unreferencedGeneration

wasDisposed

Methods

addChunk

Parameters

chunk: Chunk

Returns void

addCounterpartRef

Returns { gen: number; id: null | number; }

gen: number

id: null | number

addRef

Returns DVIDVolumeChunkSource

chunkStateChanged

Parameters

chunk: Chunk

oldState: ChunkState

Returns void

computeChunkBounds

Returns

Parameters

chunk: VolumeChunk

Returns Float32Array

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

dispose

Returns void

disposed

Returns void

download

Parameters

chunk: VolumeChunk

cancellationToken: CancellationToken

Returns Promise<void>

getChunk

Parameters

chunkGridPosition: vec3

Returns SliceViewChunk

Parameters

chunkGridPosition: Float32Array

Returns SliceViewChunk

getDecoder

Parameters

params: any

Returns ((chunk: VolumeChunk, cancellationToken: CancellationToken, response: ArrayBuffer) => Promise<void>)

Parameters

chunk: VolumeChunk

cancellationToken: CancellationToken

response: ArrayBuffer

Returns {
gen: number;
id: null | number;
}

`Protected` ownerDispose

`Protected` refCountReachedZero

T extends {
cancel: (() => void);
}

`Optional` options: boolean | AddEventListenerOptions