synchronizers

Index

Functions

• createCameraPositionSynchronizer
• createImageSliceSynchronizer
• createPresentationViewSynchronizer
• createSlabThicknessSynchronizer
• createStackImageSynchronizer
• createVOISynchronizer
• createZoomPanSynchronizer

Functions

createCameraPositionSynchronizer

• createCameraPositionSynchronizer(synchronizerName: string): Synchronizer

• A helper that creates a new Synchronizer which listens to the CAMERA_MODIFIED rendering event and calls the cameraSyncCallback.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  Returns Synchronizer

  A new Synchronizer instance.

createImageSliceSynchronizer

• createImageSliceSynchronizer(synchronizerName: string): Synchronizer

• A helper that creates a new Synchronizer which listens to the STACK_NEW_IMAGE rendering event and calls the ImageSliceSyncCallback.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  Returns Synchronizer

  A new Synchronizer instance.

createPresentationViewSynchronizer

• createPresentationViewSynchronizer(synchronizerName: string, options?: ViewPresentation): Synchronizer

• A helper that creates a new Synchronizer which listens to the CAMERA_MODIFIED rendering event and calls the cameraSyncCallback based on presentation view values and not based on absolute camera positions.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  • optionaloptions: ViewPresentation

  Returns Synchronizer

  A new Synchronizer instance.

createSlabThicknessSynchronizer

• createSlabThicknessSynchronizer(synchronizerName: string): Synchronizer

• A helper that creates a new Synchronizer which listens to the CAMERA_MODIFIED rendering event and calls the cameraSyncCallback based on presentation view values and not based on absolute camera positions.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  Returns Synchronizer

  A new Synchronizer instance.

createStackImageSynchronizer

• createStackImageSynchronizer(synchronizerName: string): Synchronizer

• A helper that creates a new Synchronizer which listens to the STACK_NEW_IMAGE rendering event and calls the ImageSliceSyncCallback.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  Returns Synchronizer

  A new Synchronizer instance.

createVOISynchronizer

• createVOISynchronizer(synchronizerName: string, options: VOISynchronizerOptions): Synchronizer

• A helper that creates a new Synchronizer which listens to the VOI_MODIFIED rendering event and calls the voiSyncCallback.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  • options: VOISynchronizerOptions

    The options for the synchronizer. By default the voi synchronizer will also sync the invert state of the volume, but this can be disabled by setting syncInvertState to false.

  Returns Synchronizer

  A new Synchronizer instance.

createZoomPanSynchronizer

• createZoomPanSynchronizer(synchronizerName: string): Synchronizer

• A helper that creates a new Synchronizer which listens to the CAMERA_MODIFIED rendering event and calls the cameraSyncCallback.

  ---

  Parameters

  • synchronizerName: string

    The name of the synchronizer.

  Returns Synchronizer

  A new Synchronizer instance.