WarpedSource (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.img.WarpedSource<T>

All Implemented Interfaces:: MipmapOrdering, Source<T>

public class WarpedSource<T>
extends Object
implements Source<T>, MipmapOrdering

Nested Class Summary
- Nested classes/interfaces inherited from interface bdv.viewer.render.MipmapOrdering
  MipmapOrdering.Level, MipmapOrdering.MipmapHints, MipmapOrdering.PrefetchOrderComparator, MipmapOrdering.RenderOrderComparator

Field Summary
- Fields inherited from interface bdv.viewer.render.MipmapOrdering
  prefetchOrderComparator, renderOrderComparator

Constructor Summary

Constructors
Constructor and Description
`WarpedSource(Source<T> source, String name)`
`WarpedSource(Source<T> source, String name, Supplier<Boolean> doBoundingBoxCulling)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`doBoundingBoxCulling()` Whether this source participates in bounding box culling.
`RealRandomAccessible<T>`	`getInterpolatedSource(int t, int level, Interpolation method)` Get the 3D stack at timepoint index t, extended to infinity and interpolated.
`MipmapOrdering.MipmapHints`	`getMipmapHints(AffineTransform3D screenTransform, int timepoint, int previousTimepoint)` Evaluate mipmap levels such that they can be ordered for rendering and/or prefetching.
`String`	`getName()` Get the name of the source.
`int`	`getNumMipmapLevels()`
`RandomAccessibleInterval<T>`	`getSource(int t, int level)` Get the 3D stack at timepoint index t.
`void`	`getSourceTransform(int t, int level, AffineTransform3D transform)` Get the transform from the `source` at the given timepoint index and mipmap level into the global coordinate system.
`RealTransform`	`getTransform()`
`T`	`getType()` Get an instance of the pixel type.
`VoxelDimensions`	`getVoxelDimensions()` Get voxel size and unit for this source.
`Source<T>`	`getWrappedSource()`
`boolean`	`isPresent(int t)` Is there a stack at timepoint index t?
`boolean`	`isTransformed()`
`void`	`setIsTransformed(boolean isTransformed)`
`void`	`updateTransform(RealTransform xfm)`
`static <T> SourceAndConverter<T>`	`wrap(SourceAndConverter<T> wrap, String name, int ndims)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WarpedSource
```
public WarpedSource(Source<T> source,
                    String name)
```
  - WarpedSource
```
public WarpedSource(Source<T> source,
                    String name,
                    Supplier<Boolean> doBoundingBoxCulling)
```
- Method Detail
  - wrap
```
public static <T> SourceAndConverter<T> wrap(SourceAndConverter<T> wrap,
                                             String name,
                                             int ndims)
```
  - 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>
    
    Parameters:
    
    t - timepoint index
    
    Returns:
    
    true, if there is data for timepoint index 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>
    
    Returns:
    
    true, if this source participates in bounding box culling.
  - updateTransform
```
public void updateTransform(RealTransform xfm)
```
  - setIsTransformed
```
public void setIsTransformed(boolean isTransformed)
```
  - isTransformed
```
public boolean isTransformed()
```
  - getWrappedSource
```
public Source<T> getWrappedSource()
```
  - getSource
```
public RandomAccessibleInterval<T> getSource(int t,
                                             int level)
```
    Description copied from interface: Source
    
    Get the 3D stack at timepoint index t.
    
    Specified by:
    
    getSource in interface Source<T>
    
    Parameters:
    
    t - timepoint index
    
    level - mipmap level
    
    Returns:
    
    the stack.
  - getInterpolatedSource
```
public 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>
    
    Parameters:
    
    t - timepoint index
    
    level - mipmap level
    
    method - interpolation method to use
    
    Returns:
    
    the extended and interpolated stack.
  - getSourceTransform
```
public void getSourceTransform(int t,
                               int level,
                               AffineTransform3D transform)
```
    Description copied from interface: Source
    
    Get the transform from the source at the given timepoint index and mipmap level into the global coordinate system.
    
    Specified by:
    
    getSourceTransform in interface Source<T>
    
    Parameters:
    
    t - timepoint index
    
    level - mipmap level
    
    transform - is set to the source-to-global transform, that transforms source coordinates into the global coordinates
  - getTransform
```
public RealTransform getTransform()
```
  - getType
```
public T getType()
```
    Description copied from interface: Source
    
    Get an instance of the pixel type.
    
    Specified by:
    
    getType in interface Source<T>
    
    Returns:
    
    instance of pixel type.
  - getName
```
public String getName()
```
    Description copied from interface: Source
    
    Get the name of the source.
    
    Specified by:
    
    getName in interface Source<T>
    
    Returns:
    
    the name of the source.
  - getVoxelDimensions
```
public 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>
    
    Returns:
    
    voxel size and unit or null.
  - getNumMipmapLevels
```
public int getNumMipmapLevels()
```
    Specified by:
    
    getNumMipmapLevels in interface Source<T>
  - getMipmapHints
```
public MipmapOrdering.MipmapHints getMipmapHints(AffineTransform3D screenTransform,
                                                 int timepoint,
                                                 int previousTimepoint)
```
    Description copied from interface: MipmapOrdering
    
    Evaluate mipmap levels such that they can be ordered for rendering and/or prefetching.
    
    Specified by:
    
    getMipmapHints in interface MipmapOrdering
    
    Parameters:
    
    screenTransform - transforms screen coordinates to global coordinates.
    
    timepoint - current timepoint index
    
    previousTimepoint - previous timepoint index

Class WarpedSource<T>

Nested Class Summary

Nested classes/interfaces inherited from interface bdv.viewer.render.MipmapOrdering

Field Summary

Fields inherited from interface bdv.viewer.render.MipmapOrdering

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WarpedSource

WarpedSource

Method Detail

wrap

isPresent

doBoundingBoxCulling

updateTransform

setIsTransformed

isTransformed

getWrappedSource

getSource

getInterpolatedSource

getSourceTransform

getTransform

getType

getName

getVoxelDimensions

getNumMipmapLevels

getMipmapHints