org.micromanager.ndviewer.api

Interface NDViewerDataSource

public interface NDViewerDataSource

Interface for a source of image data. This data can be multi-resolution, though this isn't required

Author:

henrypinkard

Method Summary

Modifier and Type	Method and Description
void	close() Called when viewer is closing
int[]	getBounds() The minimal and maximal pixel coordinates of the image to be viewed
String	getDiskLocation() Path to where the data is stored on disk, if applicable
int	getImageBitDepth(HashMap<String,Object> axesPositions) Get the bits per pixel of image with the given axes positions
mmcorej.TaggedImage	getImageForDisplay(HashMap<String,Object> axes, int resolutionindex, double xOffset, double yOffset, int imageWidth, int imageHeight) Retrieve image with the given parameters so it can be displayed
Set<HashMap<String,Object>>	getImageKeys() Get the axes of all available images in this dataset
int	getMaxResolutionIndex() Index of the log 2 biggest downsample factor in the pyramid 0 is full resolution, 1 is downsampled by 2x, 2 is downsampled by 4x, etc For a non-multi resolution source, should pass 0
void	increaseMaxResolutionLevel(int newMaxResolutionLevel) Viewer will be viewing at this res index, so make sure it exists

Method Detail

getBounds

int[] getBounds()

The minimal and maximal pixel coordinates of the image to be viewed

Returns:

4 element array x_min, y_min, x_max, y_max

getImageForDisplay

mmcorej.TaggedImage getImageForDisplay(HashMap<String,Object> axes,
                                       int resolutionindex,
                                       double xOffset,
                                       double yOffset,
                                       int imageWidth,
                                       int imageHeight)

Retrieve image with the given parameters so it can be displayed

Parameters:

axes - Map of axes to indices (e.g. "z": 0, "t": 1) (Note: no position needed for channels as this is automatically inferred

resolutionindex - Index in level of multiresolution pyramid. (0 is full resolution, 1 is downsampled by 2x, 2 is downsampled by 4x, etc

xOffset - leftmost pixel at the requested resolution

yOffset - rightmost pixel at the requested resolution

imageWidth - pixel width of the image at the requested resolution

imageHeight - pixel height of the image at the requested resolution

Returns:

getImageKeys

Set<HashMap<String,Object>> getImageKeys()

Get the axes of all available images in this dataset

Returns:

getMaxResolutionIndex

int getMaxResolutionIndex()

Index of the log 2 biggest downsample factor in the pyramid 0 is full resolution, 1 is downsampled by 2x, 2 is downsampled by 4x, etc For a non-multi resolution source, should pass 0

Returns:

increaseMaxResolutionLevel

void increaseMaxResolutionLevel(int newMaxResolutionLevel)

Viewer will be viewing at this res index, so make sure it exists

Parameters:

newMaxResolutionLevel -

getDiskLocation

String getDiskLocation()

Path to where the data is stored on disk, if applicable

Returns:

close

void close()

Called when viewer is closing

getImageBitDepth

int getImageBitDepth(HashMap<String,Object> axesPositions)

Get the bits per pixel of image with the given axes positions

Parameters:

axesPositions -

Returns: