ImageCache

All Superinterfaces:

TaggedImageStorage
```
public interface ImageCache
extends TaggedImageStorage
```
An interface, implemented by MMImageCache. See also TaggedImageStorage. The ImageCache is expected to use another TaggedImageStorage for actual storage. It contains various helper functions for interrogating the stored data set.

Field Summary
- Fields inherited from interface org.micromanager.api.TaggedImageStorage
  storagePluginName

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addImageCacheListener(ImageCacheListener l)` Adds the provided cache listener.
`int`	`getBitDepth()` Returns the bit depth of all images in the image cache.
`java.util.Set<java.lang.String>`	`getChangingKeys()` Get a list of keys that are not identical for every TaggedImage.
`java.awt.Color`	`getChannelColor(int channelIndex)` Returns the preferred display color for a channel, specified by channelIndex.
`double`	`getChannelGamma(int channelIndex)` Returns the gamma for the channel display.
`int`	`getChannelHistogramMax(int channelIndex)` Returns the preferred maximum value for the channel's histogram.
`int`	`getChannelMax(int channelIndex)` Gets the maximum intensity value for a channel display (typically shown as full intensity color).
`int`	`getChannelMin(int channelIndex)` Gets the minimum intensity value for a channel display (typically shown as black).
`java.lang.String`	`getChannelName(int channelIndex)` Returns the name of a channel specified by channelIndex.
`org.json.JSONObject`	`getChannelSetting(int channel)` Returns a JSONObject with channel settings for the channel whose index is the argument.
`java.lang.String`	`getComment()` Gets the overall comment string for this data set.
`int`	`getDisplayMode()` Returns the display mode used by the CompositeImage (composite, color, or grayscale)
`mmcorej.TaggedImage`	`getImage(int channel, int slice, int frame, int position)` Return the TaggedImage at the specified coordinates, or null if that image does not exist.
`ImageCacheListener[]`	`getImageCacheListeners()` Gets a list of image cache listeners.
`java.lang.String`	`getImageComment(org.json.JSONObject tags)` Returns the image comment for a particular image.
`boolean`	`getIsOpen()` Return true if the ImageCache is still valid, false otherwise.
`org.json.JSONObject`	`getLastImageTags()` Returns the image tags for the last received image.
`int`	`getNumDisplayChannels()` Returns the number of channels in the ImageCache.
`java.lang.String`	`getPixelType()` Returns the pixel type for images in this image cache.
`void`	`removeImageCacheListener(ImageCacheListener l)` Removes an imageCacheListener so that it will no longer be notified of relevant events.
`void`	`saveAs(TaggedImageStorage newImageFileManager)` Save a new copy of a TaggedImage data set, stored in a TaggedImageStorage object.
`void`	`saveAs(TaggedImageStorage newImageFileManager, boolean moveToNewStorage)` Save a new copy of a TaggedImage data set, stored in a TaggedImageStorage object.
`void`	`setChannelColor(int channel, int rgb)` Sets the preferred display color for a channel
`void`	`setComment(java.lang.String text)` Set the data set's comment string for this image cache.
`void`	`setImageComment(java.lang.String comment, org.json.JSONObject tags)` Set the comment string for an individual image.
`void`	`storeChannelDisplaySettings(int channelIndex, int min, int max, double gamma, int histMax, int displayMode)` Store the display settings for a particular channel.

Methods inherited from interface org.micromanager.api.TaggedImageStorage
close, finished, getDataSetSize, getDiskLocation, getDisplayAndComments, getImageTags, getSummaryMetadata, imageKeys, isFinished, lastAcquiredFrame, putImage, setDisplayAndComments, setSummaryMetadata, writeDisplaySettings

- Method Detail
  - addImageCacheListener
```
void addImageCacheListener(ImageCacheListener l)
```
    Adds the provided cache listener. The listener will be notified whenever an image is added or finished() has been called.
  - getChangingKeys
```
java.util.Set<java.lang.String> getChangingKeys()
```
    Get a list of keys that are not identical for every TaggedImage. The Set returns changes over time as new images are loaded or received.
  - getComment
```
java.lang.String getComment()
```
    Gets the overall comment string for this data set.
  - getImageCacheListeners
```
ImageCacheListener[] getImageCacheListeners()
```
    Gets a list of image cache listeners.
  - getLastImageTags
```
org.json.JSONObject getLastImageTags()
```
    Returns the image tags for the last received image.
  - removeImageCacheListener
```
void removeImageCacheListener(ImageCacheListener l)
```
    Removes an imageCacheListener so that it will no longer be notified of relevant events.
  - saveAs
```
void saveAs(TaggedImageStorage newImageFileManager)
```
    Save a new copy of a TaggedImage data set, stored in a TaggedImageStorage object. The new data set will be used by this cache in the future.
  - saveAs
```
void saveAs(TaggedImageStorage newImageFileManager,
            boolean moveToNewStorage)
```
    Save a new copy of a TaggedImage data set, stored in a TaggedImageStorage object. The data set will be use by this cache in the future if moveToNewStorage is true.
  - getIsOpen
```
boolean getIsOpen()
```
    Return true if the ImageCache is still valid, false otherwise.
  - setComment
```
void setComment(java.lang.String text)
```
    Set the data set's comment string for this image cache.
  - setImageComment
```
void setImageComment(java.lang.String comment,
                     org.json.JSONObject tags)
```
    Set the comment string for an individual image. The image is specified by indices given in tags.
  - getImageComment
```
java.lang.String getImageComment(org.json.JSONObject tags)
```
    Returns the image comment for a particular image. The image is specified by indices given in tags.
  - storeChannelDisplaySettings
```
void storeChannelDisplaySettings(int channelIndex,
                                 int min,
                                 int max,
                                 double gamma,
                                 int histMax,
                                 int displayMode)
```
    Store the display settings for a particular channel.
    
    Parameters:
    
    channelIndex - - The channel index for which settings are being specified
    
    min - - The minimum display intensity value (shown as black)
    
    max - - The maximum display intensity value (shown as full-intensity color)
    
    gamma - - The gamma value (curvature of the value-to-display curve)
    
    histMax - - The preferred maximum value at which the histogram is displayed.
    
    displayMode - - Composite, Color, or Gray-scale
  - getChannelSetting
```
org.json.JSONObject getChannelSetting(int channel)
```
    Returns a JSONObject with channel settings for the channel whose index is the argument.
  - getBitDepth
```
int getBitDepth()
```
    Returns the bit depth of all images in the image cache.
  - getDisplayMode
```
int getDisplayMode()
```
    Returns the display mode used by the CompositeImage (composite, color, or grayscale)
  - getChannelColor
```
java.awt.Color getChannelColor(int channelIndex)
```
    Returns the preferred display color for a channel, specified by channelIndex.
  - setChannelColor
```
void setChannelColor(int channel,
                     int rgb)
```
    Sets the preferred display color for a channel
    
    Parameters:
    
    channel - - The channel index
    
    rgb - - A 6-byte integer specifying the color: e.g., 0xFFFFFF is white.
  - getChannelName
```
java.lang.String getChannelName(int channelIndex)
```
    Returns the name of a channel specified by channelIndex.
  - getChannelMin
```
int getChannelMin(int channelIndex)
```
    Gets the minimum intensity value for a channel display (typically shown as black).
  - getChannelMax
```
int getChannelMax(int channelIndex)
```
    Gets the maximum intensity value for a channel display (typically shown as full intensity color).
  - getChannelGamma
```
double getChannelGamma(int channelIndex)
```
    Returns the gamma for the channel display.
  - getChannelHistogramMax
```
int getChannelHistogramMax(int channelIndex)
```
    Returns the preferred maximum value for the channel's histogram.
  - getNumDisplayChannels
```
int getNumDisplayChannels()
```
    Returns the number of channels in the ImageCache. More channels may appear if more images are received with new channel indices.
  - getPixelType
```
java.lang.String getPixelType()
```
    Returns the pixel type for images in this image cache.
  - getImage
```
mmcorej.TaggedImage getImage(int channel,
                             int slice,
                             int frame,
                             int position)
```
    Return the TaggedImage at the specified coordinates, or null if that image does not exist.
    
    Specified by:
    
    getImage in interface TaggedImageStorage

Interface ImageCache

Field Summary

Fields inherited from interface org.micromanager.api.TaggedImageStorage

Method Summary

Methods inherited from interface org.micromanager.api.TaggedImageStorage

Method Detail

addImageCacheListener

getChangingKeys

getComment

getImageCacheListeners

getLastImageTags

removeImageCacheListener

saveAs

saveAs

getIsOpen

setComment

setImageComment

getImageComment

storeChannelDisplaySettings

getChannelSetting

getBitDepth

getDisplayMode

getChannelColor

setChannelColor

getChannelName

getChannelMin

getChannelMax

getChannelGamma

getChannelHistogramMax

getNumDisplayChannels

getPixelType

getImage