Module org.bigdataviewer.core
Package bdv.util

Class BdvOptions

  • public class BdvOptions
extends Object
    Optional parameters for BdvFunctions.
    Author:
    Tobias Pietzsch <tobias.pietzsch@gmail.com>

    • Constructor Detail

      • BdvOptions

        public BdvOptions()

    • Method Detail

      • preferredSize

        public BdvOptions preferredSize​(int w,
                                int h)
        Set preferred size of ViewerPanel canvas. (This does not include the time slider).

      • screenScales

        public BdvOptions screenScales​(double[] s)
        Set the number and scale factors for scaled screen images.
        Parameters:
        s - Scale factors from the viewer canvas to screen images of different resolutions. A scale factor of 1 means 1 pixel in the screen image is displayed as 1 pixel on the canvas, a scale factor of 0.5 means 1 pixel in the screen image is displayed as 2 pixel on the canvas, etc.
        See Also:
        MultiResolutionRenderer

      • targetRenderNanos

        public BdvOptions targetRenderNanos​(long t)
        Set target rendering time in nanoseconds.
        Parameters:
        t - Target rendering time in nanoseconds. The rendering time for the coarsest rendered scale should be below this threshold.
        See Also:
        MultiResolutionRenderer

      • numRenderingThreads

        public BdvOptions numRenderingThreads​(int n)
        Set how many threads to use for rendering.
        Parameters:
        n - How many threads to use for rendering.
        See Also:
        MultiResolutionRenderer

      • numSourceGroups

        public BdvOptions numSourceGroups​(int n)
        Set how many source groups there are initially.
        Parameters:
        n - How many source groups to create initially.

      • inputTriggerConfig

        public BdvOptions inputTriggerConfig​(org.scijava.ui.behaviour.io.InputTriggerConfig c)
        Set the InputTriggerConfig from which keyboard and mouse action mapping is loaded.

        Note that this will override the managed InputTriggerConfig, that is, modifying the keymap through the preferences dialog will have no effect.

        Parameters:
        c - the InputTriggerConfig from which keyboard and mouse action mapping is loaded

      • keymapManager

        public BdvOptions keymapManager​(KeymapManager keymapManager)
        Set the KeymapManager to share keymap settings with other BigDataViewer windows.

        This can be used to link multiple BigDataViewer windows such that they use (and modify) the same Keymap, shortcuts and mouse gestures.

      • appearanceManager

        public BdvOptions appearanceManager​(AppearanceManager appearanceManager)
        Set the AppearanceManager to share appearance settings with other BigDataViewer windows.

        This can be used to link multiple BigDataViewer windows such that they use (and modify) the same Appearance settings, e.g., LookAndFeel, scalebar overlay settings, etc.

      • frameTitle

        public BdvOptions frameTitle​(String title)
        Set the title of the BigDataViewer window.
        Parameters:
        title - the window title.

      • sourceTransform

        public BdvOptions sourceTransform​(double... calibration)
        Set the transform of the BdvSource to be created to account for the given calibration (scaling of the source axes).
        Parameters:
        calibration - the source calibration (scaling of the source axes).

      • is2D

        public BdvOptions is2D()
        Set up the BigDataViewer for 2D navigation. TODO: add more detailed explanation
        Returns:

      • axisOrder

        public BdvOptions axisOrder​(AxisOrder axisOrder)
        Specified when adding a stack. Describes how the axes of the stack are ordered.
        Parameters:
        axisOrder - the axis order of a stack to add.

      • addTo

        public BdvOptions addTo​(Bdv bdv)
        When showing content using one of the BdvFunctions methods, this option can be given to specify that the content should be added to an existing window. (All BdvFunctions methods return an instance of Bdv that can be used that way).
        Parameters:
        bdv - to which viewer should the content be added.