org.micromanager.api

Interface TaggedImageStorage

All Known Subinterfaces:

ImageCache

public interface TaggedImageStorage

This interface is implemented by TaggedImageStorage classes. Implementing classes will store images (in RAM, on disk, or otherwise) whenever they arrive via putImage, and will return stored images when they are requested by getImage. Each image is expected to be mapped to four indices: channel, slice, frame, and position.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	storagePluginName

Method Summary

Modifier and Type	Method and Description
void	close() Disposes of the tagged images from memory -- images will only be stored in disk.
void	finished() Call this function when no more images are expected Finishes writing the metadata file and closes it.
long	getDataSetSize()
java.lang.String	getDiskLocation()
org.json.JSONObject	getDisplayAndComments()
mmcorej.TaggedImage	getImage(int channelIndex, int sliceIndex, int frameIndex, int positionIndex)
org.json.JSONObject	getImageTags(int channelIndex, int sliceIndex, int frameIndex, int positionIndex)
org.json.JSONObject	getSummaryMetadata()
java.util.Set<java.lang.String>	imageKeys()
boolean	isFinished()
int	lastAcquiredFrame()
void	putImage(mmcorej.TaggedImage taggedImage)
void	setDisplayAndComments(org.json.JSONObject settings)
void	setSummaryMetadata(org.json.JSONObject md)
void	writeDisplaySettings()

Field Detail

storagePluginName

static final java.lang.String storagePluginName

Method Detail

getImage

mmcorej.TaggedImage getImage(int channelIndex,
                             int sliceIndex,
                             int frameIndex,
                             int positionIndex)

getImageTags

org.json.JSONObject getImageTags(int channelIndex,
                                 int sliceIndex,
                                 int frameIndex,
                                 int positionIndex)

putImage

void putImage(mmcorej.TaggedImage taggedImage)
       throws org.micromanager.utils.MMException,
              java.io.IOException

Throws:

org.micromanager.utils.MMException

java.io.IOException

imageKeys

java.util.Set<java.lang.String> imageKeys()

finished

void finished()

Call this function when no more images are expected Finishes writing the metadata file and closes it. After calling this function, the imagestorage is read-only

isFinished

boolean isFinished()

setSummaryMetadata

void setSummaryMetadata(org.json.JSONObject md)

getSummaryMetadata

org.json.JSONObject getSummaryMetadata()

setDisplayAndComments

void setDisplayAndComments(org.json.JSONObject settings)

getDisplayAndComments

org.json.JSONObject getDisplayAndComments()

close

void close()

Disposes of the tagged images from memory -- images will only be stored in disk.

getDiskLocation

java.lang.String getDiskLocation()

lastAcquiredFrame

int lastAcquiredFrame()

getDataSetSize

long getDataSetSize()

writeDisplaySettings

void writeDisplaySettings()