LibCZI and Friends

Documentation of LibCZI and adjacent projects.

Contents:

• libCZI Documentation
  • Versioning of libCZI
  • CZI in a nutshell
• Building libCZI
  • Building on Windows with Visual Studio
  • Building on Linux
  • Configurations
  • Building the documentation
• Documentation Generation
  • Compiling Documentation for libCZI and libCZI-API
  • Generating Documentation with Sphinx
    • Method 1: Using Python Packages
    • Method 2: Using Docker Container
• Image Document Concept
  • General Concepts
  • Dimensions
• Valid-Pixel Mask Concept
  • Introduction
  • Mask in pyramids
  • Data layout of the mask in CZI
  • Defining the attachment format in metadata
  • Mask-support in libCZI
  • Resolution protocol for ill-formed masks
• Using libCZI
  • Opening a CZI-file
  • Reading sub-blocks in a CZI-file
  • creating multi-tile composites
  • creating a multi-channel composite
  • stream objects
• Accessors
• Multi-channel-composition
• Stream Objects
• stream objects
  • Azure-SDK reader
• CZIcmd Documentation
  • command ‘PrintInformation’
  • command ‘SingleChannelTileAccessor’
  • command ‘ChannelComposite’
  • command ‘ExtractAttachment’
• Coordinate Systems
  • Coordinate Systems
  • Usage in libCZI
  • Conversion
• Writing CZI
  • Writing a CZI
    • notes on implementing the output-stream object
    • considerations for writing a CZI
    • passing in data
• resolution protocol
• Resolution Protocol for Ambiguous or Contradictory Information
  • Introduction
  • discrepancies between sub-block’s DirectoryEntry and the actual payload content
    • case 1: payload-data size mismatch for uncompressed subblocks
    • case 2: width/height/pixel type size mismatch for JPGXR-data
  • discrepancies between sub-block’s DirectoryEntry in SubBlockDirectory-segment and the actual Subblock-segment
• Todos
• Version history
• libCZI API
  • General Overview
    • Versioning of API
    • Errors Codes in LibCZI API

Doxygen Documentation

libCZI

Code Documentation:

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