Skip to content

Commands

ptahmose edited this page Sep 5, 2020 · 12 revisions

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
  • Close
  • GetDefaultDisplaySettings

GetVersion

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

CZIGetInfo sample

Open

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

CZIGetInfo sample

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.

CZIGetInfo sample

GetInfo

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

CZIGetInfo sample CZIGetInfo sample CZIGetInfo sample

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.

CZIGetInfo sample

GetSingleChannelScalingTileComposite

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

CZIGetInfo sample

Clone this wiki locally