converter module

Conversion of a scene into a tiled, pyramidal SVS or OME-TIFF file, the same functionality the slideio-converter tool exposes. Headers are included as <slideio/converter/...>; link slideio::converter.

converter.hpp

Variables

const std::string DRIVER = "DRIVER"
namespace slideio

slideio: main Slideio namespace

namespace converter

Functions

void convertScene(std::shared_ptr<Scene> inputScene, ConverterParameters &parameters, const std::string &outputPath, int tileBatchSize, ConverterCallback cb = nullptr)

converterparameters.hpp

namespace slideio

slideio: main Slideio namespace

namespace converter

Enums

enum ImageFormat

Values:

enumerator Unknown
enumerator SVS
enumerator OME_TIFF
enum Encoding

Values:

enumerator UNKNOWN_ENCODING
enumerator JPEG
enumerator JPEG2000
enum Container

Values:

enumerator UNKNOWN_CONTAINER
enumerator TIFF_CONTAINER
class ContainerParameters
#include <slideio/converter/converterparameters.hpp>

Subclassed by slideio::converter::TIFFContainerParameters

Public Functions

inline Container getContainerType() const

Protected Functions

inline ContainerParameters(Container containerType)
virtual ~ContainerParameters() = default

Private Members

Container m_containerType
class ConverterParameters
#include <slideio/converter/converterparameters.hpp>

Subclassed by slideio::converter::OMETIFFConverterParameters, slideio::converter::SVSConverterParameters

Public Functions

ConverterParameters(ImageFormat format, Container containerType, Compression compression)
inline ConverterParameters()
ConverterParameters(const ConverterParameters &other)
ConverterParameters &operator=(const ConverterParameters &other)
virtual ~ConverterParameters() = default
inline ImageFormat getFormat() const
inline const Rect &getRect() const
inline void setRect(const Rect &rect)
inline void setSliceRange(const Range &range)
inline const Range &getSliceRange() const
inline void setChannelRange(const Range &range)
inline const Range &getChannelRange() const
inline void setTFrameRange(const Range &range)
inline const Range &getTFrameRange() const
Compression getEncoding() const
Container getContainerType() const
inline std::shared_ptr<EncodeParameters> getEncodeParameters()
inline std::shared_ptr<const EncodeParameters> getEncodeParameters() const
inline std::shared_ptr<ContainerParameters> getContainerParameters()
inline std::shared_ptr<const ContainerParameters> getContainerParameters() const
inline bool isValid() const
inline int getTileBatchSize() const
inline void setTileBatchSize(int batchSize)

Protected Attributes

ImageFormat m_format
Rect m_rect
Range m_sliceRange
Range m_channelRange
Range m_frameRange
int m_tileBatchSize
std::shared_ptr<EncodeParameters> m_encodeParameters
std::shared_ptr<ContainerParameters> m_containerParameters

Private Functions

void initialize()
void copyFrom(const ConverterParameters &other)
class OMETIFFConverterParameters : public slideio::converter::ConverterParameters
#include <slideio/converter/converterparameters.hpp>

Subclassed by slideio::converter::OMETIFFJp2KConverterParameters, slideio::converter::OMETIFFJpegConverterParameters

Public Functions

inline OMETIFFConverterParameters(Compression compression)
~OMETIFFConverterParameters() override = default
inline int getTileWidth() const
inline void setTileWidth(int tileWidth)
inline int getTileHeight() const
inline void setTileHeight(int tileHeight)
inline int getNumZoomLevels() const
inline void setNumZoomLevels(int numZoomLevels)
inline int getNumReadingThreads() const
inline void setNumReadingThreads(int numReadingThreads)
inline int getNumEncodingThreads() const
inline void setNumEncodingThreads(int numEncodingThreads)
class OMETIFFJp2KConverterParameters : public slideio::converter::OMETIFFConverterParameters
#include <slideio/converter/converterparameters.hpp>

Public Functions

inline OMETIFFJp2KConverterParameters()
~OMETIFFJp2KConverterParameters() override = default
inline void setCompressionRate(float rate)
inline float getCompressionRate() const
class OMETIFFJpegConverterParameters : public slideio::converter::OMETIFFConverterParameters
#include <slideio/converter/converterparameters.hpp>

Public Functions

inline OMETIFFJpegConverterParameters()
~OMETIFFJpegConverterParameters() override = default
inline void setQuality(int q)
inline int getQuality() const
class SVSConverterParameters : public slideio::converter::ConverterParameters
#include <slideio/converter/converterparameters.hpp>

Subclassed by slideio::converter::SVSJp2KConverterParameters, slideio::converter::SVSJpegConverterParameters

Public Functions

inline SVSConverterParameters(Compression compression)
~SVSConverterParameters() override = default
inline int getTileWidth() const
inline void setTileWidth(int tileWidth)
inline int getTileHeight() const
inline void setTileHeight(int tileHeight)
inline int getNumZoomLevels() const
inline void setNumZoomLevels(int numZoomLevels)
inline int getNumReadingThreads() const
inline void setNumReadingThreads(int numReadingThreads)
inline int getNumEncodingThreads() const
inline void setNumEncodingThreads(int numEncodingThreads)
class SVSJp2KConverterParameters : public slideio::converter::SVSConverterParameters
#include <slideio/converter/converterparameters.hpp>

Public Functions

inline SVSJp2KConverterParameters()
~SVSJp2KConverterParameters() override = default
inline void setCompressionRate(float rate)
inline float getCompressionRate() const
class SVSJpegConverterParameters : public slideio::converter::SVSConverterParameters
#include <slideio/converter/converterparameters.hpp>

Public Functions

inline SVSJpegConverterParameters()
~SVSJpegConverterParameters() override = default
inline void setQuality(int q)
inline int getQuality() const
class TIFFContainerParameters : public slideio::converter::ContainerParameters
#include <slideio/converter/converterparameters.hpp>

Public Functions

inline TIFFContainerParameters()
~TIFFContainerParameters() override = default
inline int getTileWidth() const
inline void setTileWidth(int tileWidth)
inline int getTileHeight() const
inline void setTileHeight(int tileHeight)
inline int getNumZoomLevels() const
inline void setNumZoomLevels(int numZoomLevels)
inline int getNumReadingThreads() const
inline void setNumReadingThreads(int numReadingThreads)
inline int getNumEncodingThreads() const
inline void setNumEncodingThreads(int numEncodingThreads)

Protected Attributes

int m_tileWidth
int m_tileHeight
int m_numZoomLevels
int m_numReadingThreads
int m_numEncodingThreads

convertercallback.hpp

namespace slideio

slideio: main Slideio namespace

namespace converter

Typedefs

typedef const std::function<void(int)> &ConverterCallback