Iris::SlideOpenInfo Struct Reference

Parameters required to create an Iris::Slide WSI file handle. More...

#include <IrisTypes.hpp>

Public Types
enum	: uint8_t { SLIDE_OPEN_UNDEFINED , SLIDE_OPEN_LOCAL , SLIDE_OPEN_NETWORK }

Public Attributes
enum Iris::SlideOpenInfo:: { ... }	type = SLIDE_OPEN_UNDEFINED
union {
LocalSlideOpenInfo   local
	Information for opening a file on the local machine.
NetworkSlideOpenInfo   network
	Information for opening a network hosted file.
};
size_t	capacity = 1000
	This is the default slide cache capacity.

Detailed Description

Parameters required to create an Iris::Slide WSI file handle.

This parameter structure is a wrapped union of either a local slide file open information struct or a network hosted slide file open information struct. To allow the system to access the correct union member, a type enumeration must also be defined prior to passing this information stucture to the calling method Iris::create_slide(const SlideOpenInfo&) or Iris::viewer_open_slide(const Viewer&, const SlideOpenInfo&)

Optional parameters that can be used to optimize performance characteristics are also included in the struct. Some are used interally by the Iris rendering engine, and these are invoked when using Iris::viewer_open_slide(const Viewer&, const SlideOpenInfo&) rather than the more generic Iris::create_slide(const SlideOpenInfo&), so the former should be preferred when available.

Member Data Documentation

capacity

size_t Iris::SlideOpenInfo::capacity = 1000

This is the default slide cache capacity.

The capacity determines the number of allowed cached tiles. This is the primary way in which Iris consumes RAM. Greater values cache more in-memory decompressed tile data for greater performance. Less require more pulls from disk (which is slower) The default 1000 for RGBA images consumes 2 GB of RAM.

---

The documentation for this struct was generated from the following file:

• src/IrisTypes.hpp