Class BrainmapsVolumeChunkSource

Hierarchy

__type<VolumeSourceParameters, {
    prototype: __type<any, any>;
    encodeOptions(options: WithCredentialsOptions): any;
    new (...args: any[]): __type<OAuth2Credentials, typeof VolumeChunkSource>;
} & typeof VolumeChunkSource, this> & __type<OAuth2Credentials, typeof VolumeChunkSource, this> & VolumeChunkSource<this>
- BrainmapsVolumeChunkSource

Constructors

constructor

new BrainmapsVolumeChunkSource(chunkManager: ChunkManager, options: {
spec: VolumeChunkSpecification;
}): BrainmapsVolumeChunkSource
Parameters
- chunkManager: ChunkManager
- options: {
  spec: VolumeChunkSpecification;
  }
  - spec: VolumeChunkSpecification
Returns BrainmapsVolumeChunkSource
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).constructor
- Defined in src/neuroglancer/sliceview/volume/frontend.ts:155

Properties

OPTIONS

OPTIONS: SliceViewChunkSourceOptions<VolumeChunkSpecification> & {
credentialsProvider: CredentialsProvider<OAuth2Credentials>;
} & {
parameters: VolumeSourceParameters;
}

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.

chunkFormatHandler

chunkFormatHandler: ChunkFormatHandler

chunkManager

chunkManager: ChunkManager

chunks

chunks: Map<string, VolumeChunk>

credentialsProvider

credentialsProvider: CredentialsProvider<OAuth2Credentials>

disposedStacks

disposedStacks: any

immediateChunkUpdates

immediateChunkUpdates: boolean = false

If set to true, chunk updates will be applied to this source immediately, rather than queueing them. Sources that dynamically update chunks and need to ensure a consistent order of processing relative to other messages between the frontend and worker should set this to true.

isOwner

isOwner: undefined | boolean

key

key: any

parameters

parameters: VolumeSourceParameters

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

spec

spec: VolumeChunkSpecification

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

Accessors

chunkFormat

get chunkFormat(): ChunkFormat
Returns ChunkFormat
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).chunkFormat
- Defined in src/neuroglancer/sliceview/volume/frontend.ts:175

gl

get gl(): GL
Returns GL
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).gl
- Defined in src/neuroglancer/chunk_manager/frontend.ts:372

Methods

addChunk

addChunk(key: string, chunk: Chunk): void
Parameters
- key: string
- chunk: Chunk
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).addChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:384

addCounterpartRef

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

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): BrainmapsVolumeChunkSource
Returns BrainmapsVolumeChunkSource
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).addRef
- Defined in src/neuroglancer/util/disposable.ts:48

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 (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

deleteChunk

deleteChunk(key: string): void
Parameters
- key: string
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).deleteChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:376

dispose

dispose(): void
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).disposed
- Defined in src/neuroglancer/util/disposable.ts:75

getChunk

getChunk(x: any): VolumeChunk
Parameters
- x: any
Returns VolumeChunk
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).getChunk
- Defined in src/neuroglancer/sliceview/volume/frontend.ts:221

getValueAt

getValueAt(chunkPosition: Float32Array, channelAccess: ChunkChannelAccessParameters): any
Parameters
- chunkPosition: Float32Array
- channelAccess: ChunkChannelAccessParameters
Returns any
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).getValueAt
- Defined in src/neuroglancer/sliceview/volume/frontend.ts:179

initializeCounterpart

initializeCounterpart(rpc: RPC, options: any): void
Parameters
- rpc: RPC
- options: any
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).initializeCounterpart
- Defined in src/neuroglancer/chunk_manager/frontend.ts:423

initializeSharedObject

initializeSharedObject(rpc: RPC, rpcId?: number): void
Parameters
- rpc: RPC
- rpcId: number = ...
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

invalidateCache

invalidateCache(): void
Invalidates the chunk cache. Operates asynchronously.

Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).invalidateCache
- Defined in src/neuroglancer/chunk_manager/frontend.ts:398

`Protected` ownerDispose

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

Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).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 (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).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 (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

unregisterDisposer

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

`Static` encodeOptions

encodeOptions(options: WithParametersOptions): any
Parameters
- options: WithParametersOptions
Returns any
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).encodeOptions
- Defined in src/neuroglancer/chunk_manager/frontend.ts:427
encodeOptions(options: WithCredentialsOptions): any
Parameters
- options: WithCredentialsOptions
Returns any
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).encodeOptions
- Defined in src/neuroglancer/credentials_provider/chunk_source_frontend.ts:67
encodeOptions(options: SliceViewChunkSourceOptions<SliceViewChunkSpecification<Uint32Array | Float32Array>>): any
Parameters
- options: SliceViewChunkSourceOptions<SliceViewChunkSpecification<Uint32Array | Float32Array>>
Returns any
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).encodeOptions
- Defined in src/neuroglancer/sliceview/frontend.ts:470

`Static` encodeSpec

encodeSpec(spec: SliceViewChunkSpecification<Uint32Array | Float32Array>): {
    baseVoxelOffset: number[];
    chunkDataSize: number[];
    compressedSegmentationBlockSize: undefined | number[];
    dataType: DataType;
    lowerVoxelBound: number[];
    upperVoxelBound: number[];
}
Parameters
- spec: SliceViewChunkSpecification<Uint32Array | Float32Array>
Returns {
    baseVoxelOffset: number[];
    chunkDataSize: number[];
    compressedSegmentationBlockSize: undefined | number[];
    dataType: DataType;
    lowerVoxelBound: number[];
    upperVoxelBound: number[];
}
- baseVoxelOffset: number[]
- chunkDataSize: number[]
- compressedSegmentationBlockSize: undefined | number[]
- dataType: DataType
- lowerVoxelBound: number[]
- upperVoxelBound: number[]
Inherited from (WithParameters( WithCredentialsProvider<OAuth2Credentials>()(VolumeChunkSource), VolumeSourceParameters)).encodeSpec
- Defined in src/neuroglancer/sliceview/volume/frontend.ts:164

Class BrainmapsVolumeChunkSource

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

chunkManager: ChunkManager

options: { spec: VolumeChunkSpecification; }

spec: VolumeChunkSpecification

Returns BrainmapsVolumeChunkSource

Properties

OPTIONS

RPC_TYPE_ID

chunkFormatHandler

chunkManager

chunks

credentialsProvider

disposedStacks

immediateChunkUpdates

isOwner

key

parameters

refCount

referencedGeneration

rpc

rpcId

spec

unreferencedGeneration

wasDisposed

Accessors

chunkFormat

Returns ChunkFormat

gl

Returns GL

Methods

addChunk

Parameters

key: string

chunk: Chunk

Returns void

addCounterpartRef

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

gen: number

id: null | number

addRef

Returns BrainmapsVolumeChunkSource

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

deleteChunk

Parameters

key: string

Returns void

dispose

Returns void

disposed

Returns void

getChunk

Parameters

x: any

Returns VolumeChunk

getValueAt

Parameters

chunkPosition: Float32Array

channelAccess: ChunkChannelAccessParameters

Returns any

initializeCounterpart

Parameters

rpc: RPC

options: any

Returns void

initializeSharedObject

Parameters

rpc: RPC

rpcId: number = ...

options: {
spec: VolumeChunkSpecification;
}

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

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Static` encodeOptions

`Static` encodeSpec

Returns {
baseVoxelOffset: number[];
chunkDataSize: number[];
compressedSegmentationBlockSize: undefined | number[];
dataType: DataType;
lowerVoxelBound: number[];
upperVoxelBound: number[];
}