Class ImageMetadata

  • Direct Known Subclasses:
    ImageMetadata

    public class ImageMetadata
    extends java.lang.Object
    Store well, channel and tile number to which an image belongs. Optionally stores timepoint/depth-scan/image series number.
    • Constructor Detail

      • ImageMetadata

        public ImageMetadata()
    • Method Detail

      • getChannelCode

        public java.lang.String getChannelCode()
      • setChannelCode

        public void setChannelCode​(java.lang.String channelCode)
        Sets channel code.
      • getTileNumber

        public int getTileNumber()
      • setTileNumber

        public void setTileNumber​(int tileNumber)
        Sets tile number. It should start from 1.
      • getWell

        public java.lang.String getWell()
      • setWell

        public void setWell​(java.lang.String well)
        Sets well code (example: "A1")
      • setTimepoint

        public void setTimepoint​(java.lang.Float value)
        Sets the timepoint of the image. Optional.
      • setDepth

        public void setDepth​(java.lang.Float value)
        Sets the depth at which the image has been scanned. Optional.
      • setSeriesNumber

        public void setSeriesNumber​(java.lang.Integer value)
        Sets the integer series number of the image. Optional. Used to order images when there are no time or depth dimentions but there is a series of images for one well, channel and tile. Can be also used together with time and depth dimention.
      • setImageIdentifier

        public void setImageIdentifier​(ImageIdentifier imageIdentifier)
        Sets the id of the image inside a container image file format. This is optional and not needed for image files which contain only one image.
      • tryGetTimepoint

        public java.lang.Float tryGetTimepoint()
      • tryGetDepth

        public java.lang.Float tryGetDepth()
      • tryGetSeriesNumber

        public java.lang.Integer tryGetSeriesNumber()
      • ensureValid

        public void ensureValid​(boolean isMicroscopy)
        Validates that tile number, channel and well (if argument is false) have been specified.
        Throws:
        java.lang.IllegalStateException - if the object is not valid.
      • toString

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