ProgressiveRetrieveImages

A progressive loader is given some number of images to load, and calls a success or failure callback some number of times in some ordering, possibly calling back multiple times. This allows the progressive loader to be configured for different setups and to return render results for various images.

When used by the a stack viewport, the progressive loader can return multiple representations to the viewport, replacing earlier/more lossy versions with better ones.

When used by a streaming loader, the progressive loader can change the ordering of the rendering to retrieve high priority images first, and the lower priority images later to provide a complete final rendering.

Requests are held in a queue, such that subsequent requests for a given image can be cancelled or ensured to be not initiated until the higher priority image sets have been completed.

This loader is also used for the base streamimg image volume, configured with a minimal interleaved load order, combined with filling nearby volume slices on load, resulting in much faster initial apparent display.

The loader will load images from existing cached images, cached volumes, and from other nearby images or one or more calls to back end services.

@param

the set of images to load. For a volume, these should be ordered from top to bottom.

@param

has success and failure callbacks to listen for image deliver events, and may have a getTargetOptions to get information on the retrieve

@param

is a set of retrieve options to use

Implements

• IImagesLoader
• IRetrieveConfiguration

Index

Constructors

• constructor

Properties

• retrieveOptions
• stages
• createProgressive
• interleavedRetrieveStages
• sequentialRetrieveStages
• singleRetrieveStages

Methods

• loadImages

Constructors

constructor

• new ProgressiveRetrieveImages(imageRetrieveConfiguration: IRetrieveConfiguration): ProgressiveRetrieveImages

• Parameters

  • imageRetrieveConfiguration: IRetrieveConfiguration

  Returns ProgressiveRetrieveImages

Properties

retrieveOptions

retrieveOptions: Record<string, RetrieveOptions>

Implementation of IRetrieveConfiguration.retrieveOptions

stages

stages: RetrieveStage[]

Implementation of IRetrieveConfiguration.stages

publicstaticcreateProgressive

createProgressive: (configuration: IRetrieveConfiguration) => ProgressiveRetrieveImages = createProgressive

Type declaration

• • (configuration: IRetrieveConfiguration): ProgressiveRetrieveImages

  • Parameters

    • configuration: IRetrieveConfiguration

    Returns ProgressiveRetrieveImages

publicstaticinterleavedRetrieveStages

interleavedRetrieveStages: { stages: RetrieveStage[] } = ...

Type declaration

• stages: RetrieveStage[]

publicstaticsequentialRetrieveStages

sequentialRetrieveStages: { stages: RetrieveStage[] } = ...

Type declaration

• stages: RetrieveStage[]

publicstaticsingleRetrieveStages

singleRetrieveStages: { stages: RetrieveStage[] } = ...

Type declaration

• stages: RetrieveStage[]

Methods

publicloadImages

• loadImages(imageIds: string[], listener: ImageLoadListener): Promise<any>

• Implementation of IImagesLoader.loadImages

  Parameters

  • imageIds: string[]

  • listener: ImageLoadListener

  Returns Promise<any>