Classes
class	CVScene
	class CVScene represents a base class for opencv based representations of raster images contained in a medical slide. More...

class	CVSlide
	CVSlide is an base class for representation of medical slide. More...

class	ImageDriverManager
	Class ImageDriverManager keeps overview over specific image format drivers. Allows opening a slide with a specific driver. More...

class	LevelInfo
	Description of a single level of the internal image pyramid of a scene. More...

class	Metadata
	Read-only tree view over slide/scene metadata. More...

struct	PHTLevel
	One zoom level of a philips tiff pyramid: the tiff directory holding the raster and the level number the philips metadata assigns to it. The level number is needed on its own because it cannot be recovered from the directory: philips pads every level up to a whole number of tiles, so two consecutive levels may end up with the same stored width (levels 8 and 9 of Philips-2.tiff are both 512). More...

class	Scene
	Scene class represents a raster image contained in a slide. More...

class	Slide
	Slide class is an interface for accessing the information on a medical slide. More...

Enumerations
enum class	Compression { Unknown , Uncompressed , Jpeg , JpegXR , Png , Jpeg2000 , LZW , HuffmanRL , CCITT_T4 , CCITT_T6 , JpegOld , Zlib , JBIG85 , JBIG43 , NextRLE , PackBits , ThunderScanRLE , RasterPadding , RLE_LW , RLE_HC , RLE_BL , PKZIP , KodakDCS , JBIG , NikonNEF , JBIG2 , GIF , BIGGIF , RLE , BMP , JpegLossless , VP8 }
	raster data compression enum More...

enum class	HexColorFormat

Functions
SLIDEIO_EXPORTS std::shared_ptr< Slide >	openSlide (const std::string &path, const std::string &driver="")
	The function returns a smart pointer to an object of Slide class. More...

SLIDEIO_EXPORTS std::vector< std::string >	getDriverIDs ()
	Returns a list of available driver ids.

SLIDEIO_EXPORTS void	setLogLevel (const std::string &level)
	Sets the log level for the library.

SLIDEIO_EXPORTS std::string	getVersion ()
	returns version of the library.

Detailed Description

slideio: main Slideio namespace

Enumeration Type Documentation

strong

raster data compression enum

Enumerator
Unknown	Unknown compression.
Uncompressed	Uncompressed data.
Jpeg	JPEG compression.
JpegXR	JPEG XR compression.
Png	PNG compression.
Jpeg2000	JPEG 2000 compression.
LZW	Lempel - Ziv - Welch universal lossless data compression algorithm.
HuffmanRL	RL-Huffman encoding.
CCITT_T4	CCITT T.4 2-Dimensional compression.
CCITT_T6	CCITT T.6 2-Dimensional compression.
JpegOld	Old JPEG compression algorithm.
Zlib	zlib looseless data compression
NextRLE	NeXT 2-bit RLE image compression scheme.
JBIG	JBIG early lossless image compression.
GIF	gif image compression
RLE	Run-length encoding.

strong

Enum representing different color format types

std::shared_ptr< slideio::Slide > slideio::openSlide	(	const std::string &	path,
		const std::string &	driver = `""`
	)

The function returns a smart pointer to an object of Slide class.

Function for opening a slide file.

Parameters

path	: path of the file/folder that contains the slide.
driver	: id of image driver, as returned by getDriverIDs(). An empty string or "AUTO" selects the driver by the content of the file. The function throws an exception if the id is unknown or if no driver accepts the file.