Package org.anchoranalysis.image.core.stack

Class ImageMetadata

Object
ImageMetadata
public class ImageMetadata extends Object
Information about an image, but not about the intensity or content of image voxels.

The metadata always assumes a single batch of identically-sized images. If more than one series of images exist, these are considered as having separate metadata.

Author:
Owen Feehan

  • Constructor Details

    • ImageMetadata

      public ImageMetadata(Dimensions dimensions, int numberChannels, int numberFrames, int numberSeries, boolean rgb, int bitDepthPerChannel, ImageFileAttributes fileAttributes, Optional<ZonedDateTime> acquisitionTime, Optional<ImageLocation> location, Optional<ImagePyramidMetadata> pyramid)
      Creates a new ImageMetadata instance.
      Parameters:
      dimensions - The dimensions of the image.
      numberChannels - The number of channels in the image.
      numberFrames - The number of frames (separate images representing different points in a time-series) in the image.
      numberSeries - The number of separate images stored in the file.

      Pyramid image files should ideally attempt to present themselves as a single element in the series, but this depends on the driver.

      rgb - Whether the image is RGB or not.
      bitDepthPerChannel - The number of bits in memory to describe each voxel's intensity, per channel.
      fileAttributes - Attributes associated with the file on the file-system.
      acquisitionTime - A timestamp, if available, of when the image was first physically created by the camera/device.
      location - Metadata describing the geographic location where the image was captured.
      pyramid - Metadata to describe an image pyramid, if it exists.

      If multiple pyramids exist, the metadata items are extracted for the pyramid considered most important.

  • Method Details

    • getDimensions

      public Dimensions getDimensions()
      The dimensions of the image.

    • getNumberChannels

      public int getNumberChannels()
      The number of channels in the image.

    • getNumberFrames

      public int getNumberFrames()
      The number of frames (separate images representing different points in a time-series) in the image.

    • getNumberSeries

      public int getNumberSeries()
      The number of separate images stored in the file.

      Pyramid image files should ideally attempt to present themselves as a single element in the series, but this depends on the driver.

    • isRgb

      public boolean isRgb()
      Whether the image is RGB or not.

    • getBitDepthPerChannel

      public int getBitDepthPerChannel()
      The number of bits in memory to describe each voxel's intensity, per channel.

    • getFileAttributes

      public ImageFileAttributes getFileAttributes()
      Attributes associated with the file on the file-system.

    • getAcquisitionTime

      public Optional<ZonedDateTime> getAcquisitionTime()
      A timestamp, if available, of when the image was first physically created by the camera/device.

    • getLocation

      public Optional<ImageLocation> getLocation()
      Metadata describing the geographic location where the image was captured.

    • getPyramid

      public Optional<ImagePyramidMetadata> getPyramid()
      Metadata to describe an image pyramid, if it exists.

      If multiple pyramids exist, the metadata items are extracted for the pyramid considered most important.