Skip to main content
Ctrl+K

libCZI documentation

Contents:

  • libCZI Documentation
  • Building libCZI
  • Documentation Generation
  • Image Document Concept
  • Using libCZI
  • Accessors
  • Multi-channel-composition
  • Stream Objects
  • CZIcmd Documentation
  • Coordinate Systems
  • Writing CZI
  • resolution protocol
  • Todos
  • Version history
  • libCZI API

Code Documentation:

  • C++ Library
    • Namespace libCZI
    • Namespace std
    • Struct AddAttachmentInfo
    • Struct AddSubBlockInfo
    • Struct AddSubBlockInfoBase
    • Struct AddSubBlockInfoLinewiseBitmap
    • Struct AddSubBlockInfoMemPtr
    • Struct AddSubBlockInfoStridedBitmap
    • Struct AttachmentInfo
    • Struct BitmapLockInfo
    • Struct BoundingBoxes
    • Struct BuildInformation
    • Struct ChannelDisplaySettingsPOD
    • Struct Compositors::ChannelInfo
    • Struct Compositors::ComposeSingleTileOptions
    • Struct Compositors::TintingColor
    • Struct CompressParameter
    • Struct CreateBitmapOptions
    • Struct CustomValueVariant
    • Struct CZIWriterOptions
    • Struct DblRect
    • Struct DimensionAndStartSize
    • Struct DimensionAndValue
    • Struct DirectorySubBlockInfo
    • Struct DisplaySettingsPOD
    • Struct FileHeaderInfo
    • Struct GeneralDocumentInfo
    • Struct GUID
    • Struct ICZIReader::OpenOptions
    • Struct IDimensionChannelLightSourcesSetting::Polarization
    • Struct IDisplaySettings::CubicSplineCoefficients
    • Struct IDisplaySettings::SplineControlPoint
    • Struct IDisplaySettings::SplineData
    • Struct IFastAiryScanSettings::Vector
    • Struct IntPoint
    • Struct IntPointAndFrameOfReference
    • Struct IntRect
    • Struct IntRectAndFrameOfReference
    • Struct IntSize
    • Struct ISingleChannelPyramidLayerTileAccessor::Options
    • Struct ISingleChannelPyramidLayerTileAccessor::PyramidLayerInfo
    • Struct ISingleChannelScalingTileAccessor::Options
    • Struct ISingleChannelTileAccessor::Options
    • Struct ISubBlockCacheControl::PruneOptions
    • Struct ISubBlockCacheStatistics::Statistics
    • Struct LibCZICZIParseException
    • Struct LibCZIInvalidPlaneCoordinateException
    • Struct LibCZISegmentNotPresent
    • Struct MetadataUtils::CoerceAdditionalInfoForChannelDisplaySettings
    • Struct PrepareMetadataInfo
    • Struct PyramidStatistics
    • Struct PyramidStatistics::PyramidLayerInfo
    • Struct PyramidStatistics::PyramidLayerStatistics
    • Template Struct RangeOrSingleValue
    • Struct Rgb8Color
    • Struct RgbFloatColor
    • Struct ScalingInfo
    • Struct ScalingInfoEx
    • Struct SpectrumCharacteristics
    • Struct StreamsFactory::CreateStreamInfo
    • Struct StreamsFactory::Property
    • Struct StreamsFactory::StreamClassInfo
    • Struct StreamsFactory::StreamPropertyBagPropertyInfo
    • Struct SubBlockInfo
    • Struct SubBlockStatistics
    • Struct WriteMetadataInfo
    • Struct XmlDateTime
    • Class CCziReaderWriterInfo
    • Class CCziWriterInfo
    • Class CDimBase
    • Class CDimBounds
    • Class CDimCoordinate
    • Class Compositors
    • Class CompressParametersOnMap
    • Class IAccessor
    • Class IAttachment
    • Class IAttachmentRepository
    • Class IAttributeId
    • Class IAttributeName
    • Class IBitmapData
    • Class IChannelDisplaySetting
    • Class ICompressParameters
    • Class ICziMetadata
    • Class ICziMetadataBuilder
    • Class ICziMultiDimensionDocumentInfo
    • Class ICZIReader
    • Class ICziReaderWriter
    • Class ICziReaderWriterInfo
    • Class ICziWriter
    • Class ICziWriterInfo
    • Class IDecoder
    • Class IDimBounds
    • Class IDimCoordinate
    • Class IDimensionChannelAiryscanSettings
    • Class IDimensionChannelDetectorSettings
    • Class IDimensionChannelInfo
    • Class IDimensionChannelLaserScanInfo
    • Class IDimensionChannelLightPath
    • Class IDimensionChannelLightSourcesSetting
    • Class IDimensionChannelLightSourcesSettings
    • Class IDimensionChannelPolarizingSettings
    • Class IDimensionChannelRatio
    • Class IDimensionChannelSIMSettings
    • Class IDimensionChannelSPIMDetectionSettings
    • Class IDimensionChannelSPIMIlluminationSettings
    • Class IDimensionInfo
    • Class IDimensionsChannelsInfo
    • Class IDimensionTInfo
    • Class IDimensionZInfo
    • Class IDisplaySettings
    • Class IFastAiryScanSettings
    • Class IIndexSet
    • Class IInputOutputStream
    • Class IInstrumentObjectiveSettings
    • Class IMemoryBlock
    • Class IMetadataSegment
    • Class IOutputStream
    • Class ISingleChannelPyramidLayerTileAccessor
    • Class ISingleChannelScalingTileAccessor
    • Class ISingleChannelTileAccessor
    • Class ISite
    • Class ISPIMIlluminationGalvoScannerSettings
    • Class ISPIMIlluminationResonanceScannerSettings
    • Class IStream
    • Class ISubBlock
    • Class ISubBlockCache
    • Class ISubBlockCacheControl
    • Class ISubBlockCacheOperation
    • Class ISubBlockCacheStatistics
    • Class ISubBlockRepository
    • Class ISubBlockRepositoryEx
    • Class IXmlNodeRead
    • Class IXmlNodeRw
    • Class IXmlNodeWrite
    • Class JxrLibCompress
    • Class LibCZIAccessorException
    • Class LibCZIException
    • Class LibCZIIOException
    • Class LibCZIMetadataBuilderException
    • Class LibCZIMetadataException
    • Class LibCZIReaderWriteException
    • Class LibCZIStringParseException
    • Class LibCZIWriteException
    • Class LibCZIXmlParseException
    • Class MetadataUtils
    • Template Class ScopedBitmapLocker
    • Class StreamsFactory
    • Class StreamsFactory::StreamProperties
    • Class Utils
    • Class ZstdCompress
    • Enum AccessorType
    • Enum ChannelDetectorCameraProcessingMode
    • Enum ChannelDetectorSettingsBinning
    • Enum ChannelDetectorSettingsShutter
    • Enum CompressionMode
    • Enum CompressionParameterKey
    • Enum CZIFrameOfReference
    • Enum DimensionChannelAcquisitionMode
    • Enum DimensionChannelChannelType
    • Enum DimensionChannelContrastMethod
    • Enum DimensionChannelIlluminationType
    • Enum DimensionChannelLaserScanAveragingMethod
    • Enum DimensionChannelLaserScanAveragingMode
    • Enum DimensionChannelLaserScanLaserAttenuatorState
    • Enum DimensionChannelLaserScanScanDirection
    • Enum DimensionChannelLaserScanScanningMode
    • Enum DimensionChannelPinholeGeometry
    • Enum DimensionChannelSPIMIlluminationSettingsBeamType
    • Enum DimensionIndex
    • Enum ImageDecoderType
    • Enum PixelType
    • Enum SiteObjectType
    • Enum SubBlockPyramidType
    • Function libCZI::CreateAccesor
    • Function libCZI::CreateBitmapFromSubBlock
    • Function libCZI::CreateCZIReader
    • Function libCZI::CreateCZIReaderWriter
    • Function libCZI::CreateCZIWriter
    • Function libCZI::CreateInputOutputStreamForFile
    • Function libCZI::CreateMetadataBuilder
    • Function libCZI::CreateMetadataBuilderFromXml
    • Function libCZI::CreateMetaFromMetadataSegment
    • Function libCZI::CreateOutputStreamForFile
    • Function libCZI::CreateOutputStreamForFileUtf8
    • Function libCZI::CreateStreamFromFile
    • Function libCZI::CreateStreamFromMemory(std::shared_ptr<const void>, size_t)
    • Function libCZI::CreateStreamFromMemory(IAttachment *)
    • Function libCZI::CreateSubBlockCache
    • Function libCZI::GetDefaultSiteObject
    • Function libCZI::GetLibCZIBuildInformation
    • Function libCZI::GetLibCZIVersion
    • Function libCZI::operator<<(std::ostream&, const IntRect&)
    • Function libCZI::operator<<(std::ostream&, const IntSize&)
    • Function libCZI::SetSiteObject
    • Variable libCZI::LOGLEVEL_CATASTROPHICERROR
    • Variable libCZI::LOGLEVEL_CHATTYINFORMATION
    • Variable libCZI::LOGLEVEL_ERROR
    • Variable libCZI::LOGLEVEL_INFORMATION
    • Variable libCZI::LOGLEVEL_SEVEREWARNING
    • Variable libCZI::LOGLEVEL_WARNING
    • Typedef libCZI::ScopedBitmapLockerP
    • Typedef libCZI::ScopedBitmapLockerSP
  • C API
    • Struct AccessorOptionsInterop
    • Struct AddAttachmentInfoInterop
    • Struct AddSubBlockInfoInterop
    • Struct AttachmentInfoInterop
    • Struct BitmapInfoInterop
    • Struct BitmapLockInfoInterop
    • Struct BoundingBoxesInterop
    • Struct CompositionChannelInfoInterop
    • Struct CoordinateInterop
    • Struct DimBoundsInterop
    • Struct ExternalInputStreamStructInterop
    • Struct ExternalOutputStreamStructInterop
    • Struct ExternalStreamErrorInfoInterop
    • Struct FileHeaderInfoInterop
    • Struct InputStreamClassInfoInterop
    • Struct IntRectInterop
    • Struct IntSizeInterop
    • Struct LibCZIBuildInformationInterop
    • Struct LibCZIVersionInfoInterop
    • Struct MetadataAsXmlInterop
    • Struct ReaderOpenInfoInterop
    • Struct ScalingInfoInterop
    • Struct SubBlockInfoInterop
    • Struct SubBlockStatisticsInterop
    • Struct SubBlockStatisticsInteropEx
    • Struct WriteMetadataInfoInterop
    • Function libCZI_AllocateMemory
    • Function libCZI_AttachmentGetInfo
    • Function libCZI_AttachmentGetRawData
    • Function libCZI_BitmapCopyTo
    • Function libCZI_BitmapGetInfo
    • Function libCZI_BitmapLock
    • Function libCZI_BitmapUnlock
    • Function libCZI_CompositorDoMultiChannelComposition
    • Function libCZI_CompositorFillOutCompositionChannelInfoInterop
    • Function libCZI_CreateInputStream
    • Function libCZI_CreateInputStreamFromExternal
    • Function libCZI_CreateInputStreamFromFileUTF8
    • Function libCZI_CreateInputStreamFromFileWide
    • Function libCZI_CreateOutputStreamForFileUTF8
    • Function libCZI_CreateOutputStreamForFileWide
    • Function libCZI_CreateOutputStreamFromExternal
    • Function libCZI_CreateReader
    • Function libCZI_CreateSingleChannelTileAccessor
    • Function libCZI_CreateWriter
    • Function libCZI_CziDocumentInfoGetAvailableDimension
    • Function libCZI_CziDocumentInfoGetDimensionInfo
    • Function libCZI_CziDocumentInfoGetDisplaySettings
    • Function libCZI_CziDocumentInfoGetGeneralDocumentInfo
    • Function libCZI_CziDocumentInfoGetScalingInfo
    • Function libCZI_DisplaySettingsGetChannelDisplaySettings
    • Function libCZI_Free
    • Function libCZI_GetLibCZIBuildInformation
    • Function libCZI_GetLibCZIVersionInfo
    • Function libCZI_GetStreamClassesCount
    • Function libCZI_GetStreamClassInfo
    • Function libCZI_MetadataSegmentGetCziDocumentInfo
    • Function libCZI_MetadataSegmentGetMetadataAsXml
    • Function libCZI_ReaderGetAttachmentCount
    • Function libCZI_ReaderGetAttachmentInfoFromDirectory
    • Function libCZI_ReaderGetFileHeaderInfo
    • Function libCZI_ReaderGetMetadataSegment
    • Function libCZI_ReaderGetPyramidStatistics
    • Function libCZI_ReaderGetStatisticsEx
    • Function libCZI_ReaderGetStatisticsSimple
    • Function libCZI_ReaderOpen
    • Function libCZI_ReaderReadAttachment
    • Function libCZI_ReaderReadSubBlock
    • Function libCZI_ReleaseAttachment
    • Function libCZI_ReleaseBitmap
    • Function libCZI_ReleaseChannelDisplaySettings
    • Function libCZI_ReleaseCreateSingleChannelTileAccessor
    • Function libCZI_ReleaseCziDocumentInfo
    • Function libCZI_ReleaseDisplaySettings
    • Function libCZI_ReleaseInputStream
    • Function libCZI_ReleaseMetadataSegment
    • Function libCZI_ReleaseOutputStream
    • Function libCZI_ReleaseReader
    • Function libCZI_ReleaseSubBlock
    • Function libCZI_ReleaseWriter
    • Function libCZI_SingleChannelTileAccessorCalcSize
    • Function libCZI_SingleChannelTileAccessorGet
    • Function libCZI_SubBlockCreateBitmap
    • Function libCZI_SubBlockGetInfo
    • Function libCZI_SubBlockGetRawData
    • Function libCZI_WriterAddAttachment
    • Function libCZI_WriterAddSubBlock
    • Function libCZI_WriterClose
    • Function libCZI_WriterCreate
    • Function libCZI_WriterWriteMetadata
    • Variable kDimensionB
    • Variable kDimensionC
    • Variable kDimensionH
    • Variable kDimensionI
    • Variable kDimensionInvalid
    • Variable kDimensionMaxValue
    • Variable kDimensionMinValue
    • Variable kDimensionR
    • Variable kDimensionS
    • Variable kDimensionT
    • Variable kDimensionV
    • Variable kDimensionZ
    • Variable kInvalidObjectHandle
    • Variable kMaxDimensionCount
    • Variable kStreamErrorCode_UnspecifiedError
    • Variable LibCZIApi_ErrorCode_IndexOutOfRange
    • Variable LibCZIApi_ErrorCode_InvalidArgument
    • Variable LibCZIApi_ErrorCode_InvalidHandle
    • Variable LibCZIApi_ErrorCode_LockUnlockSemanticViolated
    • Variable LibCZIApi_ErrorCode_OK
    • Variable LibCZIApi_ErrorCode_OutOfMemory
    • Variable LibCZIApi_ErrorCode_UnspecifiedError
    • Typedef AttachmentObjectHandle
    • Typedef BitmapObjectHandle
    • Typedef ChannelDisplaySettingsHandle
    • Typedef CziDocumentInfoHandle
    • Typedef CziReaderObjectHandle
    • Typedef CziWriterObjectHandle
    • Typedef DisplaySettingsHandle
    • Typedef InputStreamObjectHandle
    • Typedef LibCZIApiErrorCode
    • Typedef MemoryAllocationObjectHandle
    • Typedef MetadataSegmentObjectHandle
    • Typedef ObjectHandle
    • Typedef OutputStreamObjectHandle
    • Typedef SingleChannelScalingTileAccessorObjectHandle
    • Typedef SubBlockObjectHandle
  • .rst

File libCZI_compress.h

Contents

  • Definition (libCZI_compress.h)
  • Includes
  • Included By
  • Namespaces
  • Classes
  • Enums

File libCZI_compress.h#

Contents

  • Definition (libCZI_compress.h)

  • Includes

  • Included By

  • Namespaces

  • Classes

  • Enums

Definition (libCZI_compress.h)#

Includes#

  • cstdint

  • functional

  • libCZI.h (File libCZI.h)

  • map

  • memory

  • type_traits

Included By#

  • File libCZI.h

Namespaces#

  • Namespace libCZI

Classes#

  • Struct CompressParameter

  • Class CompressParametersOnMap

  • Class ICompressParameters

  • Class IMemoryBlock

  • Class JxrLibCompress

  • Class ZstdCompress

Enums#

  • Enum CompressionParameterKey

Contents
  • Definition (libCZI_compress.h)
  • Includes
  • Included By
  • Namespaces
  • Classes
  • Enums

By Zeiss Microscopy GmbH

© Copyright 2025, Zeiss Microscopy GmbH.