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_Metadata.h
- File libCZI_Metadata2.h
- File libCZI_Pixels.h
- File libCZI_ReadWrite.h
- File libCZI_Site.h
- File libCZI_StreamsLib.h
- File libCZI_Utilities.h
- File libCZI_Write.h
Full API#
Namespaces#
Classes and Structs#
- Struct CustomValueVariant
- Struct Documentation
libCZI::CustomValueVariant
Type
CustomValueVariant()
CustomValueVariant()
CustomValueVariant()
CustomValueVariant()
CustomValueVariant()
CustomValueVariant()
CustomValueVariant()
SetInt32()
SetDouble()
SetFloat()
SetBool()
SetString()
GetAsInt32OrThrow()
GetAsDoubleOrThrow()
GetAsFloatOrThrow()
GetAsBoolOrThrow()
GetAsStringOrThrow()
GetType()
int32Value
floatValue
doubleValue
boolValue
- Struct Documentation
- Struct GeneralDocumentInfo
- Struct Documentation
libCZI::GeneralDocumentInfo
GeneralDocumentInfo()
SetName()
SetName()
SetTitle()
SetTitle()
SetUserName()
SetUserName()
SetDescription()
SetDescription()
SetComment()
SetComment()
SetKeywords()
SetKeywords()
SetRating()
SetCreationDate()
SetCreationDate()
SetCreationDate()
Clear()
name_valid
name
title_valid
title
userName_valid
userName
description_valid
description
comment_valid
comment
keywords_valid
keywords
rating_valid
rating
creationDateTime_valid
creationDateTime
- Struct Documentation
- Struct StreamsFactory::Property
- Nested Relationships
- Struct Documentation
libCZI::StreamsFactory::Property
- Class CCziWriterInfo
- Inheritance Relationships
- Class Documentation
libCZI::CCziWriterInfo
CCziWriterInfo()
CCziWriterInfo()
CCziWriterInfo()
GetDimBounds()
GetFileGuid()
TryGetMIndexMinMax()
TryGetReservedSizeForAttachmentDirectory()
TryGetReservedSizeForSubBlockDirectory()
TryGetReservedSizeForMetadataSegment()
SetFileGuid()
SetReservedSizeForAttachmentsDirectory()
SetReservedSizeForSubBlockDirectory()
SetReservedSizeForMetadataSegment()
SetDimBounds()
SetMIndexBounds()
- Class Compositors
- Nested Relationships
- Class Documentation
libCZI::Compositors
ComposeSingleChannelTiles()
ComposeMultiChannel_Bgr24()
ComposeMultiChannel_Bgra32()
ComposeMultiChannel_Bgr24()
ComposeMultiChannel_Bgra32()
ComposeMultiChannel_Bgr24()
ComposeMultiChannel_Bgra32()
libCZI::Compositors::ChannelInfo
libCZI::Compositors::ComposeSingleTileOptions
libCZI::Compositors::TintingColor
- Class ICZIReader
- Nested Relationships
- Inheritance Relationships
- Class Documentation
- Class ICziReaderWriter
- Inheritance Relationships
- Class Documentation
libCZI::ICziReaderWriter
Create()
ReplaceSubBlock()
RemoveSubBlock()
ReplaceAttachment()
RemoveAttachment()
SyncAddSubBlock()
SyncAddAttachment()
SyncWriteMetadata()
ReadMetadataSegment()
GetFileHeaderInfo()
Close()
~ICziReaderWriter()
SyncAddSubBlock()
SyncAddSubBlock()
SyncAddSubBlock()
ReplaceSubBlock()
ReplaceSubBlock()
ReplaceSubBlock()
- Class IDimensionChannelDetectorSettings
- Class Documentation
libCZI::IDimensionChannelDetectorSettings
TryGetDetectorRef()
TryGetBinning()
TryGetShutter()
TryGetPhotonConversionFactor()
TryGetGain()
TryGetDigitalGain()
TryGetOffset()
TryGetEMGain()
TryGetVoltage()
TryGetReadOutRate()
TryGetUseBrightnessContrastCorrection()
TryGetPixelMaximum()
TryGetPixelAccuracy()
TryGetPixelScaleFactor()
TryGetCameraProcessingMode()
~IDimensionChannelDetectorSettings()
- Class Documentation
- Class IDimensionChannelInfo
- Inheritance Relationships
- Class Documentation
libCZI::IDimensionChannelInfo
TryGetChannelType()
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::IDimensionChannelLaserScanInfo
TryGetPixelTime()
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::IDimensionChannelLightSourcesSetting
TryGetLightSourceRef()
TryGetWavelength()
TryGetAttenuation()
TryGetTransmission()
TryGetIntensity()
TryGetFlashDuration()
TryGetTIRFAngle()
TryGetTIRFDepthOfPenetration()
TryGetIsTIRFCalibrated()
TryGetIsNlo()
TryGetPolarization()
~IDimensionChannelLightSourcesSetting()
libCZI::IDimensionChannelLightSourcesSetting::Polarization
- Class IDisplaySettings
- Class ISingleChannelPyramidLayerTileAccessor
- Class IXmlNodeWrite
- Inheritance Relationships
- Class Documentation
libCZI::IXmlNodeWrite
GetOrCreateChildNode()
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::MetadataUtils
WriteImageSizeInformation()
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::StreamsFactory
GetStreamPropertyBagPropertyInfo()
Initialize()
CreateStream()
CreateStream()
GetStreamInfoForClass()
GetStreamClassesCount()
CreateDefaultStreamForFile()
CreateDefaultStreamForFile()
kStreamClassInfoProperty_CurlHttp_CaInfo
kStreamClassInfoProperty_CurlHttp_CaPath
libCZI::StreamsFactory::CreateStreamInfo
libCZI::StreamsFactory::Property
libCZI::StreamsFactory::StreamClassInfo
libCZI::StreamsFactory::StreamProperties
libCZI::StreamsFactory::StreamPropertyBagPropertyInfo
- Class Utils
- Class Documentation
libCZI::Utils
CompressionOption
DimensionToChar()
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_LEVEL
KEY_COMPRESS_PRE_PROCESS
VALUE_COMPRESS_HILO_BYTE_UNPACK
- Class Documentation
Enums#
- Enum DimensionChannelAcquisitionMode
- Enum Documentation
DimensionChannelAcquisitionMode
WideField
LaserScanningConfocalMicroscopy
SpinningDiskConfocal
SlitScanConfocal
MultiPhotonMicroscopy
StructuredIllumination
SingleMoleculeImaging
TotalInternalReflection
FluorescenceLifetime
SpectralImaging
FluorescenceCorrelationSpectroscopy
NearFieldScanningOpticalMicroscopy
SecondHarmonicGenerationImaging
PALM
STORM
STED
TIRF
FSM
LCM
SPIM
SEM
FIB
FIB_SEM
ApertureCorrelation
Other
- Enum Documentation