Commands

The first argument to the mex-function is a string which specifies the function to execute. The following functions are available:

• GetVersion
• Open
• GetSubBlockBitmap
• GetInfo
• GetScaling
• GetMetadataXml
• GetSingleChannelScalingTileComposite
• GetMultiChannelScalingTileComposite
• Close
• GetDefaultDisplaySettings
• GetSubBlock
• GetInfoFromSubBlock
• GetBitmapFromSubBlock
• GetMetadataFromSubBlock
• ReleaseSubBlock

GetVersion

The function returns a struct containing version information. It does not take any arguments.

Open

The specified file (second argument) is opened, and a handle for the document is returned.

GetSubBlockBitmap

argument #	type	comment
1	integer	The handle (as returned from "Open")
2	integer	The subblock number

Read the specified subblock and get the (uncompressed) bitmap.

GetInfo

Get information about the specified CZI-document. A struct is returned.

GetScaling

Retrieve scaling information from the specified document. The scaling is given in units of µm. If no information is available, the property will have the value of NaN.

GetMultiChannelScalingTileComposite

Get a multi-channel composite image from the specified axis-aligned ROI with the specified zoom.

argument #	type	comment
1	integer	The handle (as returned from "Open")
2	array of numbers	The coordinates of the ROI
3	string	The plane coordinate
4	number	The zoom

GetSingleChannelScalingTileComposite

Get a tile-composite for the specified region-of-interest for the specified plane with the specified zoom-factor. zoom is a number between 1 and 0, and the pixel-size of the resulting image will be zoom * w and zoom * h.

argument #	type	comment
1	integer	The handle (as returned from "Open")
2	array of numbers	The coordinates of the ROI
3	string	The plane coordinate
4	number	The zoom