bvv.vistools

Class BvvOptions

java.lang.Object

bvv.vistools.BvvOptions

public class BvvOptions
extends Object

Optional parameters for BdvFunctions.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BvvOptions.Values Read-only BvvOptions values.

Field Summary

Fields

Modifier and Type	Field and Description
BvvOptions.Values	values

Constructor Summary

Constructors

Constructor and Description
BvvOptions()

Method Summary

Modifier and Type	Method and Description
BvvOptions	addTo(Bvv bvv) When showing content using one of the BvvFunctions methods, this option can be given to specify that the content should be added to an existing window.
BvvOptions	axisOrder(bdv.util.AxisOrder axisOrder) Specified when adding a stack.
BvvOptions	cacheBlockSize(int s) Sets the GPU cache tile size.
BvvOptions	cacheBlockSize(int[] s) Sets the GPU cache tile size.
BvvOptions	dCam(double d) Sets the distance from the camera to the z=0 plane.
BvvOptions	dClip(double d)
BvvOptions	dClipFar(double d) Sets the visible distance from the z=0 plane away from the camera.
BvvOptions	dClipNear(double d) Sets the visible distance from the z=0 plane towards the camera.
BvvOptions	ditherWidth(int w) Sets the dither window width.
BvvOptions	frameTitle(String title) Set the title of the BigDataViewer window.
BvvOptions	inputTriggerConfig(org.scijava.ui.behaviour.io.InputTriggerConfig c) Set the InputTriggerConfig from which keyboard and mouse action mapping is loaded.
BvvOptions	maxAllowedStepInVoxels(double s)
BvvOptions	maxCacheSizeInMB(int s) Sets the max memory to use for the GPU cache texture in MB.
BvvOptions	maxRenderMillis(int t) Set target per-frame time in milliseconds.
BvvOptions	numDitherSamples(int n) Sets the number of dither samples.
BvvOptions	numSourceGroups(int n) Set how many source groups there are initially.
static BvvOptions	options() Create default BvvOptions.
BvvOptions	preferredSize(int w, int h) Set preferred size of ViewerPanel canvas.
BvvOptions	renderHeight(int h) Sets the height of offscreen canvas.
BvvOptions	renderWidth(int w) Sets the width of offscreen canvas.
BvvOptions	sourceTransform(net.imglib2.realtransform.AffineTransform3D t) Set the transform of the BdvSource to be created.
BvvOptions	sourceTransform(double... calibration) Set the transform of the BdvSource to be created to account for the given calibration (scaling of the source axes).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

values

public final BvvOptions.Values values

Constructor Detail

BvvOptions

public BvvOptions()

Method Detail

options

public static BvvOptions options()

Create default BvvOptions.

Returns:

default BvvOptions.

preferredSize

public BvvOptions preferredSize(int w,
                                int h)

Set preferred size of ViewerPanel canvas. (This does not include the time slider).

renderWidth

public BvvOptions renderWidth(int w)

Sets the width of offscreen canvas.

Parameters:

w - the width.

Returns:

this instance.

renderHeight

public BvvOptions renderHeight(int h)

Sets the height of offscreen canvas.

Parameters:

h - the height.

Returns:

this instance.

maxRenderMillis

public BvvOptions maxRenderMillis(int t)

Set target per-frame time in milliseconds.

Parameters:

t - Target rendering time in milliseconds.

ditherWidth

public BvvOptions ditherWidth(int w)

Sets the dither window width. E.g., w=3 means 3x3 dither window size.

Parameters:

w - dither window width.

Returns:

this instance.

numDitherSamples

public BvvOptions numDitherSamples(int n)

Sets the number of dither samples. Pixels are interpolated from this many nearest neighbors when dithering.

Parameters:

n - the number of dither samples.

Returns:

this instance.

cacheBlockSize

public BvvOptions cacheBlockSize(int[] s)

Sets the GPU cache tile size. (not padded)

Parameters:

s - the cache tile size.

Returns:

this instance

cacheBlockSize

public BvvOptions cacheBlockSize(int s)

Sets the GPU cache tile size. (not padded)

Parameters:

s - the cache tile size.

Returns:

this instance

maxCacheSizeInMB

public BvvOptions maxCacheSizeInMB(int s)

Sets the max memory to use for the GPU cache texture in MB. The size of the GPU cache texture will match this as close as possible with the given tile size.

Parameters:

s - the GPU cache size in MB.

Returns:

this instance.

dCam

public BvvOptions dCam(double d)

Sets the distance from the camera to the z=0 plane. In units of screen pixel width.

Parameters:

d - camera distance.

Returns:

this instance.

dClipNear

public BvvOptions dClipNear(double d)

Sets the visible distance from the z=0 plane towards the camera. In units of screen pixel width. (Should be smaller than camera distance.)

Parameters:

d - visible distance from z=0 towards camera.

Returns:

this instance.

dClipFar

public BvvOptions dClipFar(double d)

Sets the visible distance from the z=0 plane away from the camera. In units of screen pixel width.

Parameters:

d - visible distance from z=0 away from camera.

Returns:

this instance.

dClip

public BvvOptions dClip(double d)

maxAllowedStepInVoxels

public BvvOptions maxAllowedStepInVoxels(double s)

numSourceGroups

public BvvOptions numSourceGroups(int n)

Set how many source groups there are initially.

Parameters:

n - How many source groups to create initially.

inputTriggerConfig

public BvvOptions inputTriggerConfig(org.scijava.ui.behaviour.io.InputTriggerConfig c)

Set the InputTriggerConfig from which keyboard and mouse action mapping is loaded.

Parameters:

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

sourceTransform

public BvvOptions sourceTransform(net.imglib2.realtransform.AffineTransform3D t)

Set the transform of the BdvSource to be created.

Parameters:

t - the source transform.

frameTitle

public BvvOptions frameTitle(String title)

Set the title of the BigDataViewer window.

Parameters:

title - the window title.

sourceTransform

public BvvOptions 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).

axisOrder

public BvvOptions axisOrder(bdv.util.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 BvvOptions addTo(Bvv bvv)

When showing content using one of the BvvFunctions methods, this option can be given to specify that the content should be added to an existing window. (All BvvFunctions methods return an instance of Bvv that can be used that way).

Parameters:

bvv - to which viewer should the content be added.