Function libCZI_ReaderGetPyramidStatistics

Function libCZI_ReaderGetPyramidStatistics#

Function Documentation#

LibCZIApiErrorCode libCZI_ReaderGetPyramidStatistics(CziReaderObjectHandle reader_object, char **pyramid_statistics_as_json)#

Get “pyramid-statistics” about the CZI-document. This function provides a JSON-formatted string which contains information about the pyramid. The JSON-schema is as follows: 

{
    "scenePyramidStatistics": {
        "<sceneIndex>": [
        {
            "layerInfo": {
            "minificationFactor": <number>,
            "pyramidLayerNo" : <number>
        },
        "count" : <number>
        }
    ]}
}
It resembles the corresponding C++-structure ‘PyramidStatistics’ in the libCZI-library.

Parameters:

  • reader_object – The reader object.

  • pyramid_statistics_as_json – [out] If successful, a pointer to a JSON-formatted string is placed here. The caller is responsible for freeing this memory (by calling libCZI_Free).

Returns:

An error-code indicating success or failure of the operation.

Contents