OpenConnectomeImageLoader (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.AbstractViewerSetupImgLoader<UnsignedByteType,VolatileUnsignedByteType>
- - bdv.img.openconnectome.OpenConnectomeImageLoader

All Implemented Interfaces:

ViewerImgLoader, ViewerSetupImgLoader<UnsignedByteType,VolatileUnsignedByteType>, BasicImgLoader, BasicMultiResolutionImgLoader, BasicMultiResolutionSetupImgLoader<UnsignedByteType>, BasicSetupImgLoader<UnsignedByteType>
```
public class OpenConnectomeImageLoader
extends AbstractViewerSetupImgLoader<UnsignedByteType,VolatileUnsignedByteType>
implements ViewerImgLoader
```

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

Constructor Summary

Constructors
Constructor and Description

OpenConnectomeImageLoader(String baseUrl, String token, String mode)

Constructors
Constructor and Description
`OpenConnectomeImageLoader(String baseUrl, String token, String mode)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OpenConnectomeTokenInfo`	`fetchTokenInfo(String baseUrl, String token)` Fetch information for a token from an OpenConnectome volume cutout service, e.g.
`static String[]`	`fetchTokenList(String baseUrl)` Fetch the list of public tokens from an OpenConnectome volume cutout service, e.g.
`CacheControl`	`getCacheControl()`
`RandomAccessibleInterval<UnsignedByteType>`	`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.
`ViewerSetupImgLoader<?,?>`	`getSetupImgLoader(int setupId)` Get the `BasicMultiResolutionSetupImgLoader` for the specified view setup.
`RandomAccessibleInterval<VolatileUnsignedByteType>`	`getVolatileImage(int timepointId, int level, ImgLoaderHint... hints)`
`int`	`numMipmapLevels()` Get number of resolution levels.
`protected <T extends NativeType<T>> VolatileCachedCellImg<T,VolatileByteArray>`	`prepareCachedImage(int timepointId, int setupId, int level, LoadingStrategy loadingStrategy, T type)` Create a `VolatileCachedCellImg` backed by the cache.
`static OpenConnectomeTokenInfo`	`tryFetchTokenInfo(String baseUrl, String token, int maxNumTrials)` Try to fetch information for a token from an OpenConnectome volume cutout service, e.g.
`static String[]`	`tryFetchTokenList(String baseUrl, int maxNumTrials)` Try to fetch the list of public tokens from an OpenConnectome volume cutout service, e.g.

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
  - OpenConnectomeImageLoader
```
public OpenConnectomeImageLoader(String baseUrl,
                                 String token,
                                 String mode)
```
- Method Detail
  - fetchTokenList
```
public static final String[] fetchTokenList(String baseUrl)
                                     throws com.google.gson.JsonSyntaxException,
                                            com.google.gson.JsonIOException,
                                            IOException
```
    Fetch the list of public tokens from an OpenConnectome volume cutout service, e.g. "http://openconnecto.me/ocp/ca/public_tokens/".
    
    Parameters:
    
    baseUrl - e.g. "http://openconnecto.me/ocp/ca"
    
    Returns:
    
    a list of Strings
    
    Throws:
    
    com.google.gson.JsonSyntaxException
    
    com.google.gson.JsonIOException
    
    IOException
  - fetchTokenInfo
```
public static final OpenConnectomeTokenInfo fetchTokenInfo(String baseUrl,
                                                           String token)
                                                    throws com.google.gson.JsonSyntaxException,
                                                           com.google.gson.JsonIOException,
                                                           IOException
```
    Fetch information for a token from an OpenConnectome volume cutout service, e.g. "http://openconnecto.me/ocp/ca/<token>/info/".
    
    Parameters:
    
    baseUrl - e.g. "http://openconnecto.me/ocp/ca"
    
    token - the token whose information is desired
    
    Returns:
    
    an OpenConnectomeTokenInfo instance that carries the token information
    
    Throws:
    
    com.google.gson.JsonSyntaxException
    
    com.google.gson.JsonIOException
    
    IOException
  - tryFetchTokenList
```
public static final String[] tryFetchTokenList(String baseUrl,
                                               int maxNumTrials)
```
    Try to fetch the list of public tokens from an OpenConnectome volume cutout service, e.g. "http://openconnecto.me/ocp/ca/public_tokens/".
    
    Parameters:
    
    baseUrl - e.g. "http://openconnecto.me/ocp/ca"
    
    maxNumTrials - the maximum number of trials
    
    Returns:
    
    a list of Strings or null if maxNumTrials were executed without success
  - tryFetchTokenInfo
```
public static final OpenConnectomeTokenInfo tryFetchTokenInfo(String baseUrl,
                                                              String token,
                                                              int maxNumTrials)
```
    Try to fetch information for a token from an OpenConnectome volume cutout service, e.g. "http://openconnecto.me/ocp/ca/<token>/info/".
    
    Parameters:
    
    baseUrl - e.g. "http://openconnecto.me/ocp/ca"
    
    token -
    
    maxNumTrials -
    
    Returns:
    
    an OpenConnectomeTokenInfo instance that carries the token information or null if maxNumTrials were executed without success
  - getImage
```
public RandomAccessibleInterval<UnsignedByteType> 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<UnsignedByteType>
    
    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<VolatileUnsignedByteType> getVolatileImage(int timepointId,
                                                                           int level,
                                                                           ImgLoaderHint... hints)
```
    Specified by:
    
    getVolatileImage in interface ViewerSetupImgLoader<UnsignedByteType,VolatileUnsignedByteType>
  - 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<UnsignedByteType>
    
    Returns:
    
    sub-sampling factors, indexed by resolution level and dimension.
  - numMipmapLevels
```
public int numMipmapLevels()
```
    Description copied from interface: BasicMultiResolutionSetupImgLoader
    
    Get number of resolution levels.
    
    Specified by:
    
    numMipmapLevels in interface BasicMultiResolutionSetupImgLoader<UnsignedByteType>
    
    Returns:
    
    number of resolution levels.
  - 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<UnsignedByteType>
    
    Returns:
    
    array with one transformation for each mipmap level.
  - prepareCachedImage
```
protected <T extends NativeType<T>> VolatileCachedCellImg<T,VolatileByteArray> 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 CacheControl 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.

Class OpenConnectomeImageLoader

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

OpenConnectomeImageLoader

Method Detail

fetchTokenList

fetchTokenInfo

tryFetchTokenList

tryFetchTokenInfo

getImage

getVolatileImage

getMipmapResolutions

numMipmapLevels

getMipmapTransforms

prepareCachedImage

getCacheControl

getSetupImgLoader