slideio::CVSlide Class Reference

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

#include <cvslide.hpp>

Inherited by slideio::AFISlide, slideio::CZISlide, slideio::DCMSlide, slideio::GDALSlide, slideio::NDPISlide, slideio::PKESlide, slideio::SCNSlide, slideio::SVSSlide, slideio::ZVISlide, slideio::ometiff::OTSlide, and slideio::vsi::VSISlide.

Public Member Functions
virtual int	getNumScenes () const =0
	The method returns number of Scene objects contained in the slide.
virtual std::string	getFilePath () const =0
	The method returns a string which represents file path of the slide.
virtual const std::string &	getRawMetadata () const
	The method returns a string containing serialized metadata of the slide. More...
virtual std::shared_ptr< CVScene >	getScene (int index) const =0
	The method returns a CVScene object by the scene index.
virtual std::shared_ptr< CVScene >	getSceneByName (const std::string &name)
	The method returns a CVScene object by the scene name.
virtual 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< CVScene >	getAuxImage (const std::string &sceneName) const
	Returns a slideio::CVScene object that represents an auxiliary image with the supplied name. More...
virtual MetadataFormat	getMetadataFormat () const
	The method returns a string containing serialized metadata of the slide. More...
void	setDriverId (const std::string &driverId)
	The method sets driver id of the slide.
const std::string &	getDriverId () const
	The method returns driver id of the slide.
std::string	toString () const
	The method returns a string containing serialized metadata of the slide.

Static Public Member Functions
static MetadataFormat	recognizeMetadataFormat (const std::string &metadata)
	The method returns format of a string passed as a parameter.

Detailed Description

CVSlide is an base class for representation of medical slide.

Child classes of the CVSlide class are format specific representations of the medical slide. The class provides access to a slide structure, internal images and metadata. Each slide contains at least one image represented by slideio::CVScene class. A slide may contain multiple auxiliary images such as labels, macros, bar-codes, etc. Object of the child classes are created by classes derived from slideio::ImageDriver class and cannot be created directly;

Member Function Documentation

getAuxImage()

std::shared_ptr< CVScene > CVSlide::getAuxImage ( const std::string &  sceneName ) const

virtual

Returns a slideio::CVScene 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()

virtual const std::list< std::string > & slideio::CVSlide::getAuxImageNames ( ) const

inlinevirtual

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

Default: empty list.

getMetadataFormat()

virtual MetadataFormat slideio::CVSlide::getMetadataFormat ( ) const

inlinevirtual

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

Content of the string depends on image driver and may be plain text.

getRawMetadata()

virtual const std::string & slideio::CVSlide::getRawMetadata ( ) const

inlinevirtual

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.

---

The documentation for this class was generated from the following files:

• src/slideio/core/cvslide.hpp
• src/slideio/core/cvslide.cpp