Module org.bigdataviewer.core

Package bdv.util

Class AbstractSource<T extends net.imglib2.type.numeric.NumericType<T>>

java.lang.Object

bdv.util.AbstractSource<T>

All Implemented Interfaces:

Source<T>

Direct Known Subclasses:

RandomAccessibleIntervalMipmapSource, RandomAccessibleIntervalMipmapSource4D, RandomAccessibleIntervalSource, RandomAccessibleIntervalSource4D, RandomAccessibleSource, RandomAccessibleSource4D, VolatileSource

public abstract class AbstractSource<T extends net.imglib2.type.numeric.NumericType<T>>
extends Object
implements Source<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected DefaultInterpolators<T>	interpolators
protected String	name
protected T	type
protected mpicbg.spim.data.sequence.VoxelDimensions	voxelDimensions

Constructor Summary

Constructors

Constructor	Description
AbstractSource(Supplier<T> typeSupplier, String name)
AbstractSource(T type, String name)
AbstractSource(T type, String name, boolean doBoundingBoxCulling)
AbstractSource(T type, String name, mpicbg.spim.data.sequence.VoxelDimensions voxelDimensions)
AbstractSource(T type, String name, mpicbg.spim.data.sequence.VoxelDimensions voxelDimensions, boolean doBoundingBoxCulling)

Method Summary

Modifier and Type	Method	Description
boolean	doBoundingBoxCulling()	Whether this source participates in bounding box culling.
net.imglib2.RealRandomAccessible<? extends net.imglib2.type.mask.Masked<T>>	getInterpolatedMaskedSource(int t, int level, Interpolation method)	Get a Masked version of the 3D stack at timepoint index t, extended to infinity and interpolated.
net.imglib2.RealRandomAccessible<T>	getInterpolatedSource(int t, int level, Interpolation method)	Get the 3D stack at timepoint index t, extended to infinity and interpolated.
net.imglib2.RandomAccessibleInterval<? extends net.imglib2.type.mask.Masked<T>>	getMaskedSource(int t, int level)	Get a Masked version of the 3D stack at timepoint index t.
String	getName()	Get the name of the source.
int	getNumMipmapLevels()
T	getType()	Get an instance of the pixel type.
mpicbg.spim.data.sequence.VoxelDimensions	getVoxelDimensions()	Get voxel size and unit for this source.
boolean	isPresent(int t)	Is there a stack at timepoint index t?

Methods inherited from class java.lang.Object

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

Methods inherited from interface bdv.viewer.Source

getSource, getSourceTransform

Field Detail

type

protected final T extends net.imglib2.type.numeric.NumericType<T> type

name

protected final String name

voxelDimensions

protected final mpicbg.spim.data.sequence.VoxelDimensions voxelDimensions

interpolators

protected final DefaultInterpolators<T extends net.imglib2.type.numeric.NumericType<T>> interpolators

Constructor Detail

AbstractSource

public AbstractSource(T type,
                      String name,
                      mpicbg.spim.data.sequence.VoxelDimensions voxelDimensions,
                      boolean doBoundingBoxCulling)

AbstractSource

public AbstractSource(T type,
                      String name,
                      mpicbg.spim.data.sequence.VoxelDimensions voxelDimensions)

AbstractSource

public AbstractSource(T type,
                      String name)

AbstractSource

public AbstractSource(T type,
                      String name,
                      boolean doBoundingBoxCulling)

AbstractSource

public AbstractSource(Supplier<T> typeSupplier,
                      String name)

Method Detail

isPresent

public boolean isPresent(int t)

Description copied from interface: Source

Is there a stack at timepoint index t?

Specified by:

isPresent in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Parameters:

t - timepoint index

Returns:

true, if there is data for timepoint index t.

getType

public T getType()

Description copied from interface: Source

Get an instance of the pixel type.

Specified by:

getType in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Returns:

instance of pixel type.

getInterpolatedSource

public net.imglib2.RealRandomAccessible<T> getInterpolatedSource(int t,
                                                                 int level,
                                                                 Interpolation method)

Description copied from interface: Source

Get the 3D stack at timepoint index t, extended to infinity and interpolated.

Specified by:

getInterpolatedSource in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Parameters:

t - timepoint index

level - mipmap level

method - interpolation method to use

Returns:

the extended and interpolated stack.

getMaskedSource

public net.imglib2.RandomAccessibleInterval<? extends net.imglib2.type.mask.Masked<T>> getMaskedSource(int t,
                                                                                                       int level)

Description copied from interface: Source

Get a Masked version of the 3D stack at timepoint index t.

By default, this is just Source.getSource(int, int) augmented with a constant mask 1.0.

Specified by:

getMaskedSource in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Parameters:

t - timepoint index

level - mipmap level

Returns:

the masked stack

getInterpolatedMaskedSource

public net.imglib2.RealRandomAccessible<? extends net.imglib2.type.mask.Masked<T>> getInterpolatedMaskedSource(int t,
                                                                                                               int level,
                                                                                                               Interpolation method)

Description copied from interface: Source

Get a Masked version of the 3D stack at timepoint index t, extended to infinity and interpolated.

By default, this is just Source.getInterpolatedSource(int, int, bdv.viewer.Interpolation) augmented with a constant mask 1.0.

However, most sources should override this to extend Source.getMaskedSource(int, int) to infinity (with a 0 mask) and interpolate.

Specified by:

getInterpolatedMaskedSource in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Parameters:

t - timepoint index

level - mipmap level

method - interpolation method to use

Returns:

the extended and interpolated stack.

getName

public String getName()

Description copied from interface: Source

Get the name of the source.

Specified by:

getName in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Returns:

the name of the source.

getVoxelDimensions

public mpicbg.spim.data.sequence.VoxelDimensions getVoxelDimensions()

Description copied from interface: Source

Get voxel size and unit for this source. May return null.

Specified by:

getVoxelDimensions in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Returns:

voxel size and unit or null.

getNumMipmapLevels

public int getNumMipmapLevels()

Specified by:

getNumMipmapLevels in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

doBoundingBoxCulling

public boolean doBoundingBoxCulling()

Description copied from interface: Source

Whether this source participates in bounding box culling.

If true, then this source will only be rendered if its bounding box, i.e., the interval of Source.getSource(int, int), intersects the current screen area (when transformed to viewer coordinates).

If false, then this source will be always rendered (if it is set to be visible.)

Specified by:

doBoundingBoxCulling in interface Source<T extends net.imglib2.type.numeric.NumericType<T>>

Returns:

true, if this source participates in bounding box culling.