Usage

OpenCZI[filename]

Opens the specified file. The returned object is a ManagedLibraryExpression - which means that the associated object is destroyed if it is not referenced any more. However, the object may be explicitly destroyed with the function ReleaseCZI.

ReleaseCZI[fileobj]

Closes the specified CZI-document and releases the associated resources.

CZIGetInfo[fileobj]

Retrieve information about the CZI-document - how many subblocks, the extent in pixels, the number of dimensions (Z, T, C, ...). The return value is a JSON-formatted string.

CZIGetSubBlock[fileobj, index]

Gets the bitmap of the subblock with the specified index. The return value is an Image-object.

CZIGetSubBlockData[fileobj, index, options]

This method allows to read the various parts of a subblock - the bitmap, its coordinate and associated XML-information. The optional options argument allows to choose which information to retrieve; if options is not given, then all information is retrieved.

CZIGetScaling[fileObj]

Retrieve the scaling - this gives the size of a pixel in X-, Y- and Z-direction in units of meters.

CZISingleChannelScaledComposite[fileobj,x,y,w,h,zoom,coord,backgroundColor]

Get a tile-composite for the specified region-of-interest (given by x,y,w,h) for the specified plane (given by coord) with the specified zoom-factor (given by zoom). zoom is a number between 1 and 0, and the pixel-size of the resulting image will be zoom * w and zoom * h. Parts of the image not covered by a tile will have the color indicated by backgroundColor, which is given as a normalized RGB-value.

CZIMultiChannelScaledComposite[fileobj,x,y,w,h,zoom,coord,displaySettings]

CZIQuerySubblocks[fileobj,querystring,maxnoofids]

This function gives a list (of subblocks-ids) of all subblocks matching the condition specified by 'querystring'. The optional argument maxnoofids allows to limit the number of ids that are being returned at max.