Skip to main content

libCZI_ReaderGetPyramidStatistics

Function libCZI_ReaderGetPyramidStatistics 

Source
pub unsafe extern "C" fn libCZI_ReaderGetPyramidStatistics(
    reader_object: CziReaderObjectHandle,
    pyramid_statistics_as_json: *mut *mut c_char,
) -> LibCZIApiErrorCode
Expand description

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: \code { “scenePyramidStatistics”: { “”: [ { “layerInfo”: { “minificationFactor”: , “pyramidLayerNo” : }, “count” : } ]} } \endcode It resembles the corresponding C++-structure ‘PyramidStatistics’ in the libCZI-library.

\param reader_object The reader object. \param [out] pyramid_statistics_as_json 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.