Class ImageDataSetStructure

  • All Implemented Interfaces:
    java.io.Serializable

    public class ImageDataSetStructure
    extends java.lang.Object
    implements java.io.Serializable
    Information about images needed in HCS/Microscopy. Does not contain information about datasets entities and their metadata.
    See Also:
    Serialized Form
    • Constructor Detail

      • ImageDataSetStructure

        public ImageDataSetStructure()
    • Method Detail

      • getTileRowsNumber

        public int getTileRowsNumber()
      • getTileColumnsNumber

        public int getTileColumnsNumber()
      • getChannels

        public java.util.List<Channel> getChannels()
      • getImageStorageConfiguraton

        public ImageStorageConfiguraton getImageStorageConfiguraton()
        Returns:
        image storage configuration for this dataset or null if the global configuration of the storage processor should be used.
      • areThumbnailsGenerated

        public boolean areThumbnailsGenerated()
      • setTileGeometry

        public void setTileGeometry​(int tileRowsNumber,
                                    int tileColumnsNumber)
        Sets location of the tile (a.k.a. filed or side) on the 'well matrix'.
      • setImages

        public void setImages​(java.util.List<ImageFileInfo> images)
        Sets detailed description of the images in the dataset.
      • setChannels

        public void setChannels​(java.util.List<Channel> channels)
        Sets all channels available in the dataset.
      • setChannels

        public void setChannels​(java.util.List<Channel> channels,
                                java.util.List<ChannelColorComponent> channelColorComponents)
        Use this method if channels are encoded in color components of one image (or in other words: each image contains merged channels). For each channel you have to specify the corresponding color component of the image.
      • setImageStorageConfiguraton

        public void setImageStorageConfiguraton​(ImageStorageConfiguraton imageStorageConfiguratonOrNull)
        Allows to configure various image storage parameters. Set to null if the configuration of the storage processor should be used.
      • isValid

        public boolean isValid()
        are all necessary fields filled?
      • validateImageRepresentationGenerationParameters

        public void validateImageRepresentationGenerationParameters​(ImageDataSetInformation imageDataSetInformation)
        Verify that the requested image representation formats are valid.
        Throws:
        ch.systemsx.cisd.common.exceptions.UserFailureException - Thrown if the requested image representations are not valid.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object