C++ Library#
File Hierarchy#
-
- File libCZI.h
- File libCZI_Compositor.h
- File libCZI_compress.h
- File libCZI_DimCoordinate.h
- File libCZI_exceptions.h
- File libCZI_Helpers.h
- File libCZI_Metadata.h
- File libCZI_Metadata2.h
- File libCZI_Pixels.h
- File libCZI_ReadWrite.h
- File libCZI_Site.h
- File libCZI_StreamsLib.h
- File libCZI_SubBlock.h
- File libCZI_Utilities.h
- File libCZI_Write.h
Full API#
Namespaces#
Classes and Structs#
- Struct CustomValueVariant
- Struct Documentation
libCZI::CustomValueVariantTypeCustomValueVariant()CustomValueVariant()CustomValueVariant()CustomValueVariant()CustomValueVariant()CustomValueVariant()CustomValueVariant()SetInt32()SetDouble()SetFloat()SetBool()SetString()GetAsInt32OrThrow()GetAsDoubleOrThrow()GetAsFloatOrThrow()GetAsBoolOrThrow()GetAsStringOrThrow()GetType()int32ValuefloatValuedoubleValueboolValue
- Struct Documentation
- Struct GeneralDocumentInfo
- Struct Documentation
libCZI::GeneralDocumentInfoGeneralDocumentInfo()SetName()SetName()SetTitle()SetTitle()SetUserName()SetUserName()SetDescription()SetDescription()SetComment()SetComment()SetKeywords()SetKeywords()SetRating()SetCreationDate()SetCreationDate()SetCreationDate()Clear()name_validnametitle_validtitleuserName_validuserNamedescription_validdescriptioncomment_validcommentkeywords_validkeywordsrating_validratingcreationDateTime_validcreationDateTime
- Struct Documentation
- Struct StreamsFactory::Property
- Nested Relationships
- Struct Documentation
libCZI::StreamsFactory::Property
- Class CCziWriterInfo
- Inheritance Relationships
- Class Documentation
libCZI::CCziWriterInfoCCziWriterInfo()CCziWriterInfo()CCziWriterInfo()GetDimBounds()GetFileGuid()TryGetMIndexMinMax()TryGetReservedSizeForAttachmentDirectory()TryGetReservedSizeForSubBlockDirectory()TryGetReservedSizeForMetadataSegment()SetFileGuid()SetReservedSizeForAttachmentsDirectory()SetReservedSizeForSubBlockDirectory()SetReservedSizeForMetadataSegment()SetDimBounds()SetMIndexBounds()
- Class Compositors
- Nested Relationships
- Class Documentation
libCZI::CompositorsComposeSingleChannelTiles()ComposeSingleChannelTilesMaskAware()ComposeMultiChannel_Bgr24()ComposeMultiChannel_Bgra32()ComposeMultiChannel_Bgr24()ComposeMultiChannel_Bgra32()ComposeMultiChannel_Bgr24()ComposeMultiChannel_Bgra32()libCZI::Compositors::ChannelInfolibCZI::Compositors::ComposeSingleTileOptionslibCZI::Compositors::TintingColor
- Class ICZIReader
- Nested Relationships
- Inheritance Relationships
- Class Documentation
- Class ICziReaderWriter
- Inheritance Relationships
- Class Documentation
libCZI::ICziReaderWriterCreate()ReplaceSubBlock()RemoveSubBlock()ReplaceAttachment()RemoveAttachment()SyncAddSubBlock()SyncAddAttachment()SyncWriteMetadata()ReadMetadataSegment()GetFileHeaderInfo()Close()~ICziReaderWriter()SyncAddSubBlock()SyncAddSubBlock()SyncAddSubBlock()ReplaceSubBlock()ReplaceSubBlock()ReplaceSubBlock()
- Class IDimensionChannelDetectorSettings
- Class Documentation
libCZI::IDimensionChannelDetectorSettingsTryGetDetectorRef()TryGetBinning()TryGetShutter()TryGetPhotonConversionFactor()TryGetGain()TryGetDigitalGain()TryGetOffset()TryGetEMGain()TryGetVoltage()TryGetReadOutRate()TryGetUseBrightnessContrastCorrection()TryGetPixelMaximum()TryGetPixelAccuracy()TryGetPixelScaleFactor()TryGetCameraProcessingMode()~IDimensionChannelDetectorSettings()
- Class Documentation
- Class IDimensionChannelInfo
- Inheritance Relationships
- Class Documentation
libCZI::IDimensionChannelInfoTryGetChannelType()TryGetChannelUnit()TryGetPixelType()TryGetComponentBitCount()TryGetAcquisitionMode()TryGetIlluminationType()TryGetContrastMethod()TryGetIlluminationWavelength()TryGetDetectionWavelength()TryGetExcitationWavelength()TryGetEmissionWavelength()TryGetEffectiveNA()TryGetDyeId()TryGetDyeDatabaseId()TryGetPinholeSize()TryGetPinholeSizeAiry()TryGetPinholeGeometry()TryGetFluor()TryGetNDFilter()TryGetPocketCellSetting()TryGetColor()TryGetExposureTime()TryGetDepthOfFocus()TryGetSectionThickness()GetDetectorSettings()GetLightSourcesSettings()GetLightPath()GetLaserScanInfo()GetSPIMIlluminationSettings()GetSPIMDetectionSettings()GetSIMSettings()GetPolarizingSettings()GetAiryscanSettings()TryGetReflector()TryGetCondenserContrast()TryGetNACondenser()GetRatio()~IDimensionChannelInfo()
- Class IDimensionChannelLaserScanInfo
- Class Documentation
libCZI::IDimensionChannelLaserScanInfoTryGetPixelTime()TryGetLineTime()TryGetFrameTime()TryGetAveraging()TryGetScanningMode()TryGetSampleRotation()TryGetSampleOffsetX()TryGetSampleOffsetY()TryGetScanDirection()TryGetZoomX()TryGetZoomY()TryGetZoomZ()TryGetCropOffset()TryGetLaserAttenuatorMeas()TryGetLaserBlanking()TryGetLaserAttenuatorBleach()TryGetLineStep()TryGetScanSpeed()TryGetAveragingMethod()TryGetAveragingMode()TryGetLaserAttenuatorState()~IDimensionChannelLaserScanInfo()
- Class Documentation
- Class IDimensionChannelLightSourcesSetting
- Nested Relationships
- Class Documentation
libCZI::IDimensionChannelLightSourcesSettingTryGetLightSourceRef()TryGetWavelength()TryGetAttenuation()TryGetTransmission()TryGetIntensity()TryGetFlashDuration()TryGetTIRFAngle()TryGetTIRFDepthOfPenetration()TryGetIsTIRFCalibrated()TryGetIsNlo()TryGetPolarization()~IDimensionChannelLightSourcesSetting()libCZI::IDimensionChannelLightSourcesSetting::Polarization
- Class IDisplaySettings
- Class ISingleChannelPyramidLayerTileAccessor
- Class ISubBlockAttachmentAccessor
- Nested Relationships
- Class Documentation
libCZI::ISubBlockAttachmentAccessorISubBlockAttachmentAccessor()~ISubBlockAttachmentAccessor()ISubBlockAttachmentAccessor()operator=()ISubBlockAttachmentAccessor()operator=()GetSubBlockMetadata()HasChunkContainer()EnumerateChunksInChunkContainer()GetValidPixelMaskFromChunkContainer()GetValidPixelMaskAsUncompressedBitonalBitmap()CreateBitonalBitmapFromMaskInfo()GetValidPixelMaskAsUncompressedBitonalBitmap()CreateBitonalBitmapFromMaskInfo()libCZI::ISubBlockAttachmentAccessor::ChunkInfo
- Class IXmlNodeWrite
- Inheritance Relationships
- Class Documentation
libCZI::IXmlNodeWriteGetOrCreateChildNode()GetChildNode()AppendChildNode()SetAttribute()SetAttribute()SetValue()SetValue()SetValueI32()SetValueUI32()SetValueDbl()SetValueFlt()SetValueBool()SetValueI64()SetValueUI64()RemoveChildren()RemoveAttributes()RemoveChild()RemoveAttribute()~IXmlNodeWrite()SetValue()SetValue()GetOrCreateChildNode()GetChildNode()
- Class MetadataUtils
- Nested Relationships
- Class Documentation
libCZI::MetadataUtilsWriteImageSizeInformation()WriteMIndexSizeInformation()WriteDimensionSize()WriteFillWithSubBlockStatistics()WriteDimInfoT_Interval()WriteDimInfoT_List()WriteDimInfoZ_Interval()WriteDimInfoZ_List()WriteGeneralDocumentInfo()WriteScalingInfo()WriteScalingInfoEx()SetOrAddCustomKeyValuePair()WriteDisplaySettings()WriteDisplaySettings()WriteDisplaySettings()libCZI::MetadataUtils::CoerceAdditionalInfoForChannelDisplaySettings
- Class StreamsFactory
- Nested Relationships
- Class Documentation
libCZI::StreamsFactoryGetStreamPropertyBagPropertyInfo()Initialize()CreateStream()CreateStream()GetStreamInfoForClass()GetStreamClassesCount()CreateDefaultStreamForFile()CreateDefaultStreamForFile()kStreamClassInfoProperty_CurlHttp_CaInfokStreamClassInfoProperty_CurlHttp_CaPathlibCZI::StreamsFactory::CreateStreamInfolibCZI::StreamsFactory::PropertylibCZI::StreamsFactory::StreamClassInfolibCZI::StreamsFactory::StreamPropertieslibCZI::StreamsFactory::StreamPropertyBagPropertyInfo
- Class Utils
- Class Documentation
libCZI::UtilsCompressionOptionDimensionToChar()CharToDimension()CalcMd5SumHash()CalcMd5SumHash()Create8BitLookUpTableFromSplines()Create8BitLookUpTableFromGamma()Create16BitLookUpTableFromGamma()CalcSplineDataFromPoints()NearestNeighborResize()NearestNeighborResize()CalcZoom()CalcZoom()PixelTypeToInformalString()GetBytesPerPixel()CompressionModeToInformalString()DimCoordinateToString()StringToDimCoordinate()DimBoundsToString()IndexSetFromString()TryDeterminePixelTypeForChannel()Compare()HasSameDimensions()CreateSubBlockMetadata()EnumAllCoordinates()FillBitmap()CompressionModeFromRawCompressionIdentifier()CompressionModeToCompressionIdentifier()IsValidMindex()ParseCompressionOptions()ConvertToUtf8()KEY_COMPRESS_EXPLICIT_LEVELKEY_COMPRESS_PRE_PROCESSVALUE_COMPRESS_HILO_BYTE_UNPACK
- Class Documentation
Enums#
- Enum DimensionChannelAcquisitionMode
- Enum Documentation
DimensionChannelAcquisitionModeWideFieldLaserScanningConfocalMicroscopySpinningDiskConfocalSlitScanConfocalMultiPhotonMicroscopyStructuredIlluminationSingleMoleculeImagingTotalInternalReflectionFluorescenceLifetimeSpectralImagingFluorescenceCorrelationSpectroscopyNearFieldScanningOpticalMicroscopySecondHarmonicGenerationImagingPALMSTORMSTEDTIRFFSMLCMSPIMSEMFIBFIB_SEMApertureCorrelationOther
- Enum Documentation