Interface Album


public interface Album
Interface for interacting with the Album, an implicit Datastore that Micro-Manager uses as a "scratch pad" for image data. You can access the album via Studio.album() or Studio.getAlbum().
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addImage(Image image)
    Add the specified Image to the Album's datastore.
    boolean
    Add the specified Images to the Album's datastore.
    boolean
    Add the specified Images to the Album's datastore without passing them through the processor pipeline.
    boolean
    Add the specified Image to the Album's datastore without passing it through the processor pipeline.
    Return the Datastore that currently backs the Album.
  • Method Details

    • getDatastore

      Datastore getDatastore()
      Return the Datastore that currently backs the Album. If no images have ever been added to the Album, then this will be null. Otherwise, the Datastore may potentially be frozen, if the user has saved the Album and then not created a new one yet.
      Returns:
      The current Datastore for the Album.
    • addImage

      boolean addImage(Image image) throws IOException
      Add the specified Image to the Album's datastore. If no Datastore exists for the Album yet, or if the current Datastore is frozen, or if the channel has changed, then a new Datastore will be created, as well as a new DisplayWindow to go with it, and future additions will be sent to that Datastore. The channel name used for the image will be the current channel (i.e. the config setting for the config group set as the channel group), or "" if it does not exist.
      Parameters:
      image - The Image to add to the album
      Returns:
      True if a new Datastore and DisplayWindow were created as a side-effect of adding the image.
      Throws:
      IOException - these happen with disk-based stores
    • addImages

      boolean addImages(Collection<Image> images) throws IOException
      Add the specified Images to the Album's datastore. Equivalent to repeatedly calling addImage().
      Parameters:
      images - The Images to add to the album
      Returns:
      True if a new Datastore and DisplayWindow were created as a side-effect of adding the images.
      Throws:
      IOException - these happen with disk-based stores
    • addImageWithoutProcessing

      boolean addImageWithoutProcessing(Image image) throws IOException
      Add the specified Image to the Album's datastore without passing it through the processor pipeline. If no Datastore exists for the Album yet, or if the current Datastore is frozen, or if the channel has changed, then a new Datastore will be created, as well as a new DisplayWindow to go with it, and future additions will be sent to that Datastore. The channel name used for the image will be the current channel (i.e. the config setting for the config group set as the channel group), or "" if it does not exist.
      Parameters:
      image - The Image to add to the album
      Returns:
      True if a new Datastore and DisplayWindow were created as a side-effect of adding the image.
      Throws:
      IOException - these happen with disk-based stores
    • addImagesWithoutProcessing

      boolean addImagesWithoutProcessing(Collection<Image> images) throws IOException
      Add the specified Images to the Album's datastore without passing them through the processor pipeline. Equivalent to repeatedly calling addImageWithoutProcessing().
      Parameters:
      images - The Images to add to the album
      Returns:
      True if a new Datastore and DisplayWindow were created as a side-effect of adding the images.
      Throws:
      IOException - these happen with disk-based stores