Class OpenSlideOptions

java.lang.Object
qupath.lib.images.servers.openslide.OpenSlideOptions
public class OpenSlideOptions extends Object
Helper class to store options related to how image servers using OpenSlide should be created.

Note that these options can result in different arguments being used when images are added to a project, but they should not modify images that are opened from previous projects.

  • Method Details

    • setApplyIccProfiles

      public void setApplyIccProfiles(boolean doApply)
      Optionally request that images read using OpenSlide are modified using embedded ICC profiles, where available. The default is false.
      Parameters:
      doApply - true if the ICC profile should be applied, false otherwise

    • doApplyIccProfiles

      public boolean doApplyIccProfiles()
      Query whether ICC profiles should be applied by default when new image servers are created. The default is false.
      Returns:
      true if ICC profiles should be used, false otherwise

    • setCropBoundingBox

      public void setCropBoundingBox(boolean doCrop)
      Control whether OpenSlide images are cropped to the stored bounding box. The default is true.

      If false, some images (e.g. mrxs, svs) may have a large amount of empty padding, and have a size that does not match the size returned by other libraries (e.g. Bio-Formats).

      Parameters:
      doCrop - true if images should be cropped to their stored bounding box, false otherwise

    • doCropBoundingBox

      public boolean doCropBoundingBox()
      Query whether OpenSlide images should be cropped to the stored bounding box. The default is true.
      Returns:
      true if images should be cropped to their stored bounding box, false otherwise

    • getInstance

      public static OpenSlideOptions getInstance()
      Get the main (singleton) instance of the options.
      Returns: