#include <libCZI_Compositor.h>

Inheritance diagram for libCZI::ISingleChannelTileAccessor:

Classes
struct	Options
	Options for controlling the composition operation. More...

Public Member Functions
virtual std::shared_ptr< libCZI::IBitmapData >	Get (const libCZI::IntRectAndFrameOfReference &roi, const IDimCoordinate planeCoordinate, const Options pOptions)=0

virtual std::shared_ptr< libCZI::IBitmapData >	Get (libCZI::PixelType pixeltype, const libCZI::IntRectAndFrameOfReference &roi, const IDimCoordinate planeCoordinate, const Options pOptions)=0

virtual void	Get (libCZI::IBitmapData pDest, const IntPointAndFrameOfReference &position, const IDimCoordinate planeCoordinate, const Options *pOptions)=0

std::shared_ptr< libCZI::IBitmapData >	Get (int xPos, int yPos, int width, int height, const IDimCoordinate planeCoordinate, const Options pOptions)

std::shared_ptr< libCZI::IBitmapData >	Get (libCZI::PixelType pixeltype, int xPos, int yPos, int width, int height, const IDimCoordinate planeCoordinate, const Options pOptions)

std::shared_ptr< libCZI::IBitmapData >	Get (const libCZI::IntRect &roi, const IDimCoordinate planeCoordinate, const Options pOptions)

std::shared_ptr< libCZI::IBitmapData >	Get (libCZI::PixelType pixeltype, const libCZI::IntRect &roi, const IDimCoordinate planeCoordinate, const Options pOptions)

void	Get (libCZI::IBitmapData pDest, int xPos, int yPos, const IDimCoordinate planeCoordinate, const Options *pOptions)

Detailed Description

This accessor creates a multi-tile composite of a single channel (and a single plane). The accessor will request all tiles that intersect with the specified ROI and are on the specified plane and create a composite as shown here:

The resulting output bitmap will look like this:

This accessor only operates on pyramid layer 0 - i.e. only sub-blocks with logical_size = physical_size will be considered. If the flag "drawTileBorder" is set, then the tiles will be sorted by their M-index (tiles with higher M-index are placed 'on top').
The pixel type of the output bitmap is either specified as an argument or it is automatically determined. In the latter case the first sub-block found on the specified plane is examined for its pixeltype, and this pixeltype is used.
The pixels in the output bitmap get converted from the source pixels (if their pixeltypes differ).

Member Function Documentation

◆ Get() [1/8]

std::shared_ptr< libCZI::IBitmapData > libCZI::ISingleChannelTileAccessor::Get	(	const libCZI::IntRect &	roi,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

inline

Gets the tile composite of the specified plane and the specified ROI. 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

roi	The ROI (given in raw-subblock-coordinate-system, c.f. Coordinate Systems).
planeCoordinate	The plane coordinate.
pOptions	Options for controlling the operation.

Returns: A std::shared_ptr<libCZI::IBitmapData> containing the tile-composite.

◆ Get() [2/8]

virtual std::shared_ptr< libCZI::IBitmapData > libCZI::ISingleChannelTileAccessor::Get	(	const libCZI::IntRectAndFrameOfReference &	roi,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

pure virtual

Gets the tile composite of the specified plane and the specified ROI. 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

roi	The ROI and the coordinate system it is defined in.
planeCoordinate	The plane coordinate.
pOptions	Options for controlling the operation.

Returns: A std::shared_ptr<libCZI::IBitmapData> containing the tile-composite.

◆ Get() [3/8]

std::shared_ptr< libCZI::IBitmapData > libCZI::ISingleChannelTileAccessor::Get	(	int	xPos,
		int	yPos,
		int	width,
		int	height,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

inline

Gets the tile composite of the specified plane and the specified ROI. 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

xPos	The x-position (given in raw-subblock-coordinate-system, c.f. Coordinate Systems).
yPos	The y-position (given in raw-subblock-coordinate-system, c.f. Coordinate Systems).
width	The width.
height	The height.
planeCoordinate	The plane coordinate.
pOptions	Options for controlling the operation.

Returns: A std::shared_ptr<libCZI::IBitmapData> containing the tile-composite.

◆ Get() [4/8]

virtual void libCZI::ISingleChannelTileAccessor::Get	(	libCZI::IBitmapData *	pDest,
		const IntPointAndFrameOfReference &	position,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

pure virtual

Copy the tile composite into the specified bitmap. The bitmap passed in here determines the width and the height of the ROI (and the pixeltype).

Parameters

[in]	pDest	The destination bitmap.
	position	The x-position and y-position of the ROI (width and height are given by pDest), and the coordinate system they are defined in.
	planeCoordinate	The plane coordinate.
	pOptions	Options for controlling the operation.

◆ Get() [5/8]

void libCZI::ISingleChannelTileAccessor::Get	(	libCZI::IBitmapData *	pDest,
		int	xPos,
		int	yPos,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

inline

Copy the tile composite into the specified bitmap. The bitmap passed in here determines the width and the height of the ROI (and the pixeltype).

Parameters

[in]	pDest	The destination bitmap.
	xPos	The x-position of the ROI (width and height are given by pDest) - given in raw-subblock-coordinate-system, c.f. Coordinate Systems.
	yPos	The y-position of the ROI (width and height are given by pDest) - given in raw-subblock-coordinate-system, c.f. Coordinate Systems.
	planeCoordinate	The plane coordinate.
	pOptions	Options for controlling the operation.

◆ Get() [6/8]

std::shared_ptr< libCZI::IBitmapData > libCZI::ISingleChannelTileAccessor::Get	(	libCZI::PixelType	pixeltype,
		const libCZI::IntRect &	roi,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

inline

Gets the tile composite of the specified plane and the specified ROI.

Parameters

pixeltype	The pixeltype.
roi	The ROI (given in raw-subblock-coordinate-system, c.f. Coordinate Systems).
planeCoordinate	The plane coordinate.
pOptions	Options for controlling the operation.

Returns: A std::shared_ptr<libCZI::IBitmapData> containing the tile-composite.

◆ Get() [7/8]

virtual std::shared_ptr< libCZI::IBitmapData > libCZI::ISingleChannelTileAccessor::Get	(	libCZI::PixelType	pixeltype,
		const libCZI::IntRectAndFrameOfReference &	roi,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

pure virtual

Gets the tile composite of the specified plane and the specified ROI.

Parameters

pixeltype	The pixeltype.
roi	The ROI and the coordinate system it is defined in.
planeCoordinate	The plane coordinate.
pOptions	Options for controlling the operation.

Returns: A std::shared_ptr<libCZI::IBitmapData> containing the tile-composite.

◆ Get() [8/8]

std::shared_ptr< libCZI::IBitmapData > libCZI::ISingleChannelTileAccessor::Get	(	libCZI::PixelType	pixeltype,
		int	xPos,
		int	yPos,
		int	width,
		int	height,
		const IDimCoordinate *	planeCoordinate,
		const Options *	pOptions
	)

inline

Gets the tile composite of the specified plane and the specified ROI.

Parameters

pixeltype	The pixeltype.
xPos	The x-position (given in raw-subblock-coordinate-system, c.f. Coordinate Systems).
yPos	The y-position (given in raw-subblock-coordinate-system, c.f. Coordinate Systems).
width	The width.
height	The height.
planeCoordinate	The plane coordinate.
pOptions	Options for controlling the operation.

Returns: A std::shared_ptr<libCZI::IBitmapData> containing the tile-composite.

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

libCZI/libCZI_Compositor.h

Classes

Public Member Functions

Detailed Description

Member Function Documentation

◆ Get() [1/8]

◆ Get() [2/8]

◆ Get() [3/8]

◆ Get() [4/8]

◆ Get() [5/8]

◆ Get() [6/8]

◆ Get() [7/8]

◆ Get() [8/8]