libCZI
Reading and Writing CZI documents made easy
libCZI::ISingleChannelPyramidLayerTileAccessor Class Referenceabstract

#include <libCZI_Compositor.h>

Inheritance diagram for libCZI::ISingleChannelPyramidLayerTileAccessor:
libCZI::IAccessor

Classes

struct  Options
 Options used for this accessor. More...
 
struct  PyramidLayerInfo
 

Public Member Functions

virtual std::shared_ptr< libCZI::IBitmapDataGet (const libCZI::IntRect &roi, const libCZI::IDimCoordinate *planeCoordinate, const PyramidLayerInfo &pyramidInfo, const libCZI::ISingleChannelPyramidLayerTileAccessor::Options *pOptions)=0
 
virtual std::shared_ptr< libCZI::IBitmapDataGet (libCZI::PixelType pixeltype, const libCZI::IntRect &roi, const libCZI::IDimCoordinate *planeCoordinate, const PyramidLayerInfo &pyramidInfo, const libCZI::ISingleChannelPyramidLayerTileAccessor::Options *pOptions)=0
 
virtual void Get (libCZI::IBitmapData *pDest, int xPos, int yPos, const IDimCoordinate *planeCoordinate, const PyramidLayerInfo &pyramidInfo, const Options *pOptions)=0
 Copy the composite to the specified bitmap. More...
 

Detailed Description

Interface for single-channel-pyramidlayer tile accessors. It allows to directly address the pyramid-layer it operates on. This accessor creates a multi-tile composite of a single channel (and a single plane) from a specified pyramid-layer.

Member Function Documentation

◆ Get() [1/3]

virtual std::shared_ptr<libCZI::IBitmapData> libCZI::ISingleChannelPyramidLayerTileAccessor::Get ( const libCZI::IntRect roi,
const libCZI::IDimCoordinate planeCoordinate,
const PyramidLayerInfo pyramidInfo,
const libCZI::ISingleChannelPyramidLayerTileAccessor::Options pOptions 
)
pure virtual

Gets the tile composite of the specified plane and the specified ROI and the specified pyramid-layer. The pixeltype is determined by examining the first subblock found in the specified plane (which is an arbitrary subblock). A newly allocated bitmap is returned.

Parameters
roiThe ROI.
planeCoordinateThe plane coordinate.
pyramidInfoInformation describing the pyramid-layer.
pOptionsOptions for controlling the operation.
Returns
A std::shared_ptr<libCZI::IBitmapData>

◆ Get() [2/3]

virtual void libCZI::ISingleChannelPyramidLayerTileAccessor::Get ( libCZI::IBitmapData pDest,
int  xPos,
int  yPos,
const IDimCoordinate planeCoordinate,
const PyramidLayerInfo pyramidInfo,
const Options pOptions 
)
pure virtual

Copy the composite to the specified bitmap.

Parameters
[out]pDestThe destination bitmap (also defining the width and height)
xPosThe x-position.
yPosThe y-position.
planeCoordinateThe plane coordinate.
pyramidInfoInformation describing the pyramid-layer.
pOptionsOptions for controlling the operation.

◆ Get() [3/3]

virtual std::shared_ptr<libCZI::IBitmapData> libCZI::ISingleChannelPyramidLayerTileAccessor::Get ( libCZI::PixelType  pixeltype,
const libCZI::IntRect roi,
const libCZI::IDimCoordinate planeCoordinate,
const PyramidLayerInfo pyramidInfo,
const libCZI::ISingleChannelPyramidLayerTileAccessor::Options pOptions 
)
pure virtual

Gets the tile composite of the specified plane and the specified ROI and the specified pyramid-layer.

Parameters
pixeltypeThe pixeltype (of the destination bitmap).
roiThe ROI.
planeCoordinateThe plane coordinate.
pyramidInfoInformation describing the pyramid-layer.
pOptionsOptions for controlling the operation.
Returns
A std::shared_ptr<libCZI::IBitmapData>

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