Class OMEPyramidStore

All Implemented Interfaces:
IMetadata, IPyramidStore, MetadataRetrieve, MetadataStore, OMEXMLMetadata, BaseMetadata, IMetadata, MetadataRetrieve, MetadataStore, OMEXMLMetadata

public class OMEPyramidStore extends OMEXMLMetadataImpl implements IPyramidStore
Extension of OMEXMLMetadataImpl that allows for pyramid resolution storage and retrieval.
  • Field Details

  • Constructor Details

    • OMEPyramidStore

      public OMEPyramidStore()
  • Method Details

    • dumpXML

      public String dumpXML()
      Specified by:
      dumpXML in interface OMEXMLMetadata
      Overrides:
      dumpXML in class OMEXMLMetadataImpl
    • setRoot

      public void setRoot(MetadataRoot root)
      Specified by:
      setRoot in interface MetadataStore
      Overrides:
      setRoot in class OMEXMLMetadataImpl
    • setResolutionSizeX

      public void setResolutionSizeX(PositiveInteger sizeX, int image, int resolution)
      Description copied from interface: IPyramidStore
      Define the image width in pixels of the given pyramid resolution. Both width and height must be defined for each desired resolution.
      Specified by:
      setResolutionSizeX in interface IPyramidStore
      Parameters:
      sizeX - the image width in pixels
      image - the Image (series) index
      resolution - the resolution index; expected to be greater than 0 as the largest resolution is defined by the Image itself.
      See Also:
    • setResolutionSizeY

      public void setResolutionSizeY(PositiveInteger sizeY, int image, int resolution)
      Description copied from interface: IPyramidStore
      Define the image height in pixels of the given pyramid resolution. Both width and height must be defined for each desired resolution.
      Specified by:
      setResolutionSizeY in interface IPyramidStore
      Parameters:
      sizeY - the image height in pixels
      image - the Image (series) index
      resolution - the resolution index; expected to be greater than 0 as the largest resolution is defined by the Image itself.
      See Also:
    • getResolutionCount

      public int getResolutionCount(int image)
      Description copied from interface: IPyramidStore
      Retrieve the number of pyramid resolutions defined for the given Image.
      Specified by:
      getResolutionCount in interface IPyramidStore
      Parameters:
      image - the Image (series) index
      Returns:
      the number of valid pyramid resolutions, including the largest resolution; expected to be positive if the Image index is valid.
    • getResolutionSizeX

      public PositiveInteger getResolutionSizeX(int image, int resolution)
      Description copied from interface: IPyramidStore
      Retrieve the image width in pixels of the given pyramid resolution.
      Specified by:
      getResolutionSizeX in interface IPyramidStore
      Parameters:
      image - the Image (series) index
      resolution - the resolution index; expected to be greater than 0 as the largest resolution is defined by the Image itself.
      Returns:
      the width in pixels, or null if either index is invalid
    • getResolutionSizeY

      public PositiveInteger getResolutionSizeY(int image, int resolution)
      Description copied from interface: IPyramidStore
      Retrieve the image height in pixels of the given pyramid resolution.
      Specified by:
      getResolutionSizeY in interface IPyramidStore
      Parameters:
      image - the Image (series) index
      resolution - the resolution index; expected to be greater than 0 as the largest resolution is defined by the Image itself.
      Returns:
      the height in pixels, or null if either index is invalid