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

#include <slide.hpp>

Public Member Functions
int	getNumScenes () const
	The method returns number of Scene objects contained in the slide.

std::string	getFilePath () const
	The method returns a string which represents file path of the slide.

std::shared_ptr< Scene >	getScene (int index) const
	The method returns a Scene object by the scene index.

std::shared_ptr< Scene >	getSceneByName (const std::string &name) const
	The method returns a Scene object by the scene name.

const std::string &	getRawMetadata () const
	The method returns a string containing serialized metadata of the slide. More...

MetadataFormat	getMetadataFormat () const
	The method returns the format of the metadata returned by getRawMetadata.

const Metadata &	getMetadata () const
	returns metadata as a navigable tree. Built lazily on first call.

const std::list< std::string > &	getAuxImageNames () const
	The method returns list of names of auxiliary images contained in the slide. More...

virtual int	getNumAuxImages () const
	The method returns number of auxiliary images contained in the slide.

virtual std::shared_ptr< Scene >	getAuxImage (const std::string &sceneName) const
	Returns a Scene object that represents an auxiliary image with the supplied name. More...

std::string	toString () const
	The method returns a human readable description of the slide. More...

const std::string &	getDriverId () const
	The method returns the id of the image driver that opened the slide.

Friends
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...

Detailed Description

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

Slide class is an interface for accessing the information on a medical Slide class represents a medical slide. A medical slide is normally a is represented by a single file or folder. A slide may contain multiple images represented by the Scene class. Additionally a slide may contain a number of auxiliary images like labels, macro, etc. Objects of the class can be obtained by calling of slideio::openSlide() global function.

Member Function Documentation

◆ getAuxImage()

std::shared_ptr< Scene > Slide::getAuxImage ( const std::string & sceneName ) const

virtual

Returns a Scene object that represents an auxiliary image with the supplied name.

Parameters

sceneName : name of the auxiliary image. It must be contained in the list returned by getAuxImageNames method.

◆ getAuxImageNames()

const std::list< std::string > & Slide::getAuxImageNames ( ) const

The method returns list of names of auxiliary images contained in the slide.

Default: empty list.

◆ getRawMetadata()

const std::string & Slide::getRawMetadata ( ) const

The method returns a string containing serialized metadata of the slide.

Content of the string depends on image driver and may be plain text, xml or json formatted string. Default value is an empty string.

◆ toString()

std::string Slide::toString ( ) const

The method returns a human readable description of the slide.

The description contains the file path, the driver id, the metadata format, the number of scenes, the names of the auxiliary images and the beginning of the raw metadata. It is intended for logging and diagnostics; its layout is not part of the API.

Friends And Related Function Documentation

◆ openSlide

SLIDEIO_EXPORTS std::shared_ptr< Slide > openSlide	(	const std::string &	path,
		const std::string &	driver
	)

friend

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

Function for opening a slide file.