CatmaidImageLoader (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.AbstractViewerSetupImgLoader<ARGBType,VolatileARGBType>
- - bdv.img.catmaid.CatmaidImageLoader

All Implemented Interfaces:

ViewerImgLoader, ViewerSetupImgLoader<ARGBType,VolatileARGBType>, BasicImgLoader, BasicMultiResolutionImgLoader, BasicMultiResolutionSetupImgLoader<ARGBType>, BasicSetupImgLoader<ARGBType>
```
public class CatmaidImageLoader
extends AbstractViewerSetupImgLoader<ARGBType,VolatileARGBType>
implements ViewerImgLoader
```

Field Summary
- Fields inherited from class bdv.AbstractViewerSetupImgLoader
  type, volatileType

Constructor Summary

Constructors
Constructor and Description
`CatmaidImageLoader(long width, long height, long depth, double zScale, int numScales, String urlFormat, int tileWidth, int tileHeight)`
`CatmaidImageLoader(long width, long height, long depth, double zScale, int numScales, String urlFormat, int tileWidth, int tileHeight, boolean topLeft)`
`CatmaidImageLoader(long width, long height, long depth, double zScale, int numScales, String urlFormat, int tileWidth, int tileHeight, int blockWidth, int blockHeight)`
`CatmaidImageLoader(long width, long height, long depth, double zScale, int numScales, String urlFormat, int tileWidth, int tileHeight, int blockWidth, int blockHeight, boolean topLeft)`
`CatmaidImageLoader(long width, long height, long depth, double zScale, String urlFormat, int tileWidth, int tileHeight, int[][] blockDimensions)`
`CatmaidImageLoader(long width, long height, long depth, double zScale, String urlFormat, int tileWidth, int tileHeight, int[][] blockDimensions, boolean topLeft)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VolatileGlobalCellCache`	`getCacheControl()`
`RandomAccessibleInterval<ARGBType>`	`getImage(int timepointId, int level, ImgLoaderHint... hints)` Get the image at the specified timepoint and resolution level.
`double[][]`	`getMipmapResolutions()` Get the sub-sampling factors, indexed by resolution level and dimension.
`AffineTransform3D[]`	`getMipmapTransforms()` Get the transformation from coordinates of the sub-sampled image of a a resolution level to coordinates of the full resolution image.
`static int`	`getNumScales(long width, long height, long tileWidth, long tileHeight)`
`ViewerSetupImgLoader<?,?>`	`getSetupImgLoader(int setupId)` Get the `BasicMultiResolutionSetupImgLoader` for the specified view setup.
`RandomAccessibleInterval<VolatileARGBType>`	`getVolatileImage(int timepointId, int level, ImgLoaderHint... hints)`
`int`	`numMipmapLevels()` Get number of resolution levels.
`protected <T extends NativeType<T>> VolatileCachedCellImg<T,VolatileIntArray>`	`prepareCachedImage(int timepointId, int setupId, int level, LoadingStrategy loadingStrategy, T type)` Create a `VolatileCachedCellImg` backed by the cache.
`void`	`setCache(VolatileGlobalCellCache cache)`

Methods inherited from class bdv.AbstractViewerSetupImgLoader
getImage, getImageType, getVolatileImageType

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

Constructor Detail

CatmaidImageLoader

public CatmaidImageLoader(long width,
                          long height,
                          long depth,
                          double zScale,
                          String urlFormat,
                          int tileWidth,
                          int tileHeight,
                          int[][] blockDimensions,
                          boolean topLeft)

CatmaidImageLoader

public CatmaidImageLoader(long width,
                          long height,
                          long depth,
                          double zScale,
                          String urlFormat,
                          int tileWidth,
                          int tileHeight,
                          int[][] blockDimensions)

CatmaidImageLoader

public CatmaidImageLoader(long width,
                          long height,
                          long depth,
                          double zScale,
                          int numScales,
                          String urlFormat,
                          int tileWidth,
                          int tileHeight,
                          int blockWidth,
                          int blockHeight,
                          boolean topLeft)

CatmaidImageLoader

public CatmaidImageLoader(long width,
                          long height,
                          long depth,
                          double zScale,
                          int numScales,
                          String urlFormat,
                          int tileWidth,
                          int tileHeight,
                          int blockWidth,
                          int blockHeight)

CatmaidImageLoader

public CatmaidImageLoader(long width,
                          long height,
                          long depth,
                          double zScale,
                          int numScales,
                          String urlFormat,
                          int tileWidth,
                          int tileHeight,
                          boolean topLeft)

CatmaidImageLoader

public CatmaidImageLoader(long width,
                          long height,
                          long depth,
                          double zScale,
                          int numScales,
                          String urlFormat,
                          int tileWidth,
                          int tileHeight)

Method Detail
- getNumScales
```
public static final int getNumScales(long width,
                                     long height,
                                     long tileWidth,
                                     long tileHeight)
```
- prepareCachedImage
```
protected <T extends NativeType<T>> VolatileCachedCellImg<T,VolatileIntArray> prepareCachedImage(int timepointId,
                                                                                                 int setupId,
                                                                                                 int level,
                                                                                                 LoadingStrategy loadingStrategy,
                                                                                                 T type)
```
  Create a VolatileCachedCellImg backed by the cache. The type should be either ARGBType and VolatileARGBType.
- getCacheControl
```
public VolatileGlobalCellCache getCacheControl()
```
  Specified by:
  
  getCacheControl in interface ViewerImgLoader
- getSetupImgLoader
```
public ViewerSetupImgLoader<?,?> getSetupImgLoader(int setupId)
```
  Description copied from interface: BasicMultiResolutionImgLoader
  
  Get the BasicMultiResolutionSetupImgLoader for the specified view setup.
  
  Specified by:
  
  getSetupImgLoader in interface ViewerImgLoader
  
  Specified by:
  
  getSetupImgLoader in interface BasicImgLoader
  
  Specified by:
  
  getSetupImgLoader in interface BasicMultiResolutionImgLoader
  
  Parameters:
  
  setupId - view setup for which to get the BasicMultiResolutionSetupImgLoader.
  
  Returns:
  
  BasicMultiResolutionSetupImgLoader for the specified view setup.
- getImage
```
public RandomAccessibleInterval<ARGBType> getImage(int timepointId,
                                                   int level,
                                                   ImgLoaderHint... hints)
```
  Description copied from interface: BasicMultiResolutionSetupImgLoader
  
  Get the image at the specified timepoint and resolution level.
  The returned image has pixel type T (an instance of T may be obtained by BasicSetupImgLoader.getImageType()).
  
  Specified by:
  
  getImage in interface BasicMultiResolutionSetupImgLoader<ARGBType>
  
  Parameters:
  
  timepointId - timepoint for which to retrieve the image.
  
  level - resolution level for which to retrieve the image.
  
  hints - optional hints regarding how to load the image.
  
  Returns:
  
  image of type T.
- getVolatileImage
```
public RandomAccessibleInterval<VolatileARGBType> getVolatileImage(int timepointId,
                                                                   int level,
                                                                   ImgLoaderHint... hints)
```
  Specified by:
  
  getVolatileImage in interface ViewerSetupImgLoader<ARGBType,VolatileARGBType>
- getMipmapResolutions
```
public double[][] getMipmapResolutions()
```
  Description copied from interface: BasicMultiResolutionSetupImgLoader
  
  Get the sub-sampling factors, indexed by resolution level and dimension. For example, a sub-sampling factor of 2 means the respective resolution level is scaled by 0.5 in the respective dimension.
  
  Specified by:
  
  getMipmapResolutions in interface BasicMultiResolutionSetupImgLoader<ARGBType>
  
  Returns:
  
  sub-sampling factors, indexed by resolution level and dimension.
- getMipmapTransforms
```
public AffineTransform3D[] getMipmapTransforms()
```
  Description copied from interface: BasicMultiResolutionSetupImgLoader
  
  Get the transformation from coordinates of the sub-sampled image of a a resolution level to coordinates of the full resolution image. The array of transforms is indexed by resolution level.
  
  Specified by:
  
  getMipmapTransforms in interface BasicMultiResolutionSetupImgLoader<ARGBType>
  
  Returns:
  
  array with one transformation for each mipmap level.
- numMipmapLevels
```
public int numMipmapLevels()
```
  Description copied from interface: BasicMultiResolutionSetupImgLoader
  
  Get number of resolution levels.
  
  Specified by:
  
  numMipmapLevels in interface BasicMultiResolutionSetupImgLoader<ARGBType>
  
  Returns:
  
  number of resolution levels.
- setCache
```
public void setCache(VolatileGlobalCellCache cache)
```

Class CatmaidImageLoader

Field Summary

Fields inherited from class bdv.AbstractViewerSetupImgLoader

Constructor Summary

Method Summary

Methods inherited from class bdv.AbstractViewerSetupImgLoader

Methods inherited from class java.lang.Object

Constructor Detail

CatmaidImageLoader

CatmaidImageLoader

CatmaidImageLoader

CatmaidImageLoader

CatmaidImageLoader

CatmaidImageLoader

Method Detail

getNumScales

prepareCachedImage

getCacheControl

getSetupImgLoader

getImage

getVolatileImage

getMipmapResolutions

getMipmapTransforms

numMipmapLevels

setCache