libCZI::IDimensionChannelInfo Class Reference

Information about the dimension "channel". More...

#include <libCZI_Metadata2.h>

Inheritance diagram for libCZI::IDimensionChannelInfo:

Public Member Functions
virtual bool	TryGetChannelType (DimensionChannelChannelType *type)=0
virtual bool	TryGetChannelUnit (std::wstring *unit)=0
virtual bool	TryGetPixelType (PixelType *pixelType)=0
virtual bool	TryGetComponentBitCount (int *bitCount)=0
virtual bool	TryGetAcquisitionMode (DimensionChannelAcquisitionMode *acquisitionMode)=0
virtual bool	TryGetIlluminationType (DimensionChannelIlluminationType *illuminationType)=0
virtual bool	TryGetContrastMethod (DimensionChannelContrastMethod *contrastMethod)=0
virtual bool	TryGetIlluminationWavelength (SpectrumCharacteristics *illuminationwavelength)=0
virtual bool	TryGetDetectionWavelength (SpectrumCharacteristics *detectionwavelength)=0
virtual bool	TryGetExcitationWavelength (double *excitationwavelength)=0
virtual bool	TryGetEmissionWavelength (double *emissionwavelength)=0
virtual bool	TryGetEffectiveNA (double *na)=0
virtual bool	TryGetDyeId (std::wstring *dyeid)=0
virtual bool	TryGetDyeDatabaseId (std::wstring *dyedatabaseid)=0
virtual bool	TryGetPinholeSize (double *pinholesize)=0
virtual bool	TryGetPinholeSizeAiry (double *pinholesizeairy)=0
virtual bool	TryGetPinholeGeometry (DimensionChannelPinholeGeometry *pinholegeometry)=0
virtual bool	TryGetFluor (std::wstring *fluor)=0
virtual bool	TryGetNDFilter (double *ndfilter)=0
virtual bool	TryGetPocketCellSetting (int *pocketcellsetting)=0
virtual bool	TryGetColor (libCZI::Rgb8Color *color)=0
virtual bool	TryGetExposureTime (RangeOrSingleValue< std::uint64_t > *exposuretime)=0
virtual bool	TryGetDepthOfFocus (double *depthoffocus)=0
virtual bool	TryGetSectionThickness (double *sectionthickness)=0
virtual std::shared_ptr< IDimensionChannelDetectorSettings >	GetDetectorSettings ()=0
virtual std::shared_ptr< IDimensionChannelLightSourcesSettings >	GetLightSourcesSettings ()=0
virtual std::shared_ptr< IDimensionChannelLightPath >	GetLightPath ()=0
virtual std::shared_ptr< IDimensionChannelLaserScanInfo >	GetLaserScanInfo ()=0
virtual std::shared_ptr< IDimensionChannelSPIMIlluminationSettings >	GetSPIMIlluminationSettings ()=0
virtual std::shared_ptr< IDimensionChannelSPIMDetectionSettings >	GetSPIMDetectionSettings ()=0
virtual std::shared_ptr< IDimensionChannelSIMSettings >	GetSIMSettings ()=0
virtual std::shared_ptr< IDimensionChannelPolarizingSettings >	GetPolarizingSettings ()=0
virtual std::shared_ptr< IDimensionChannelAiryscanSettings >	GetAiryscanSettings ()=0
virtual bool	TryGetReflector (std::wstring *reflector)=0
virtual bool	TryGetCondenserContrast (std::wstring *condensorContrast)=0
virtual bool	TryGetNACondenser (double *naCondensor)=0
virtual std::shared_ptr< IDimensionChannelRatio >	GetRatio ()=0
Public Member Functions inherited from libCZI::IAttributeId
virtual bool	TryGetAttributeId (std::wstring *id)=0
Public Member Functions inherited from libCZI::IAttributeName
virtual bool	TryGetAttributeName (std::wstring *name)=0

Detailed Description

Information about the dimension "channel".

Member Function Documentation

GetAiryscanSettings()

virtual std::shared_ptr<IDimensionChannelAiryscanSettings> libCZI::IDimensionChannelInfo::GetAiryscanSettings ( )

pure virtual

Gets the airy scan settings.

Returns

The airy scan settings.

GetDetectorSettings()

virtual std::shared_ptr<IDimensionChannelDetectorSettings> libCZI::IDimensionChannelInfo::GetDetectorSettings ( )

pure virtual

Gets the detector settings.

Returns

The detector settings.

GetLaserScanInfo()

virtual std::shared_ptr<IDimensionChannelLaserScanInfo> libCZI::IDimensionChannelInfo::GetLaserScanInfo ( )

pure virtual

Gets the laser scan information.

Returns

The laser scan information.

GetLightPath()

virtual std::shared_ptr<IDimensionChannelLightPath> libCZI::IDimensionChannelInfo::GetLightPath ( )

pure virtual

Gets the light path.

Returns

The light path.

GetLightSourcesSettings()

virtual std::shared_ptr<IDimensionChannelLightSourcesSettings> libCZI::IDimensionChannelInfo::GetLightSourcesSettings ( )

pure virtual

Gets the light sources settings.

Returns

The light sources settings.

GetPolarizingSettings()

virtual std::shared_ptr<IDimensionChannelPolarizingSettings> libCZI::IDimensionChannelInfo::GetPolarizingSettings ( )

pure virtual

Gets the polarizing settings.

Returns

The polarizing settings.

GetRatio()

virtual std::shared_ptr<IDimensionChannelRatio> libCZI::IDimensionChannelInfo::GetRatio ( )

pure virtual

Gets the ratio (between two active channels).

Returns

The ratio.

GetSIMSettings()

virtual std::shared_ptr<IDimensionChannelSIMSettings> libCZI::IDimensionChannelInfo::GetSIMSettings ( )

pure virtual

Gets the SIM settings.

Returns

The SIM settings.

GetSPIMDetectionSettings()

virtual std::shared_ptr<IDimensionChannelSPIMDetectionSettings> libCZI::IDimensionChannelInfo::GetSPIMDetectionSettings ( )

pure virtual

Gets the SPIM detection settings

Returns

The SPIM detection settings.

GetSPIMIlluminationSettings()

virtual std::shared_ptr<IDimensionChannelSPIMIlluminationSettings> libCZI::IDimensionChannelInfo::GetSPIMIlluminationSettings ( )

pure virtual

Gets the SPIM illumination settings

Returns

The SPIM illumination settings.

TryGetAcquisitionMode()

virtual bool libCZI::IDimensionChannelInfo::TryGetAcquisitionMode ( DimensionChannelAcquisitionMode *  acquisitionMode )

pure virtual

Try to get the acquisition mode.

Parameters

[in,out]

acquisitionMode

If non-null and successful, the acquisition mode is placed here.

Returns

True if it succeeds, false if it fails.

TryGetChannelType()

virtual bool libCZI::IDimensionChannelInfo::TryGetChannelType ( DimensionChannelChannelType *  type )

pure virtual

Try to get the channel type.

Parameters

[in,out]

type

If non-null and successful, the channel type is placed here.

Returns

True if it succeeds, false if it fails.

TryGetChannelUnit()

virtual bool libCZI::IDimensionChannelInfo::TryGetChannelUnit ( std::wstring *  unit )

pure virtual

Try to get the channel unit.

Parameters

[in,out]

unit

If non-null and successful, the channel unit is placed here.

Returns

True if it succeeds, false if it fails.

TryGetColor()

virtual bool libCZI::IDimensionChannelInfo::TryGetColor ( libCZI::Rgb8Color *  color )

pure virtual

Try to get the color.

Parameters

[in,out]

color

If non-null and successful, the color is placed here.

Returns

True if it succeeds, false if it fails.

TryGetComponentBitCount()

virtual bool libCZI::IDimensionChannelInfo::TryGetComponentBitCount ( int *  bitCount )

pure virtual

Try to get the component bit count.

Parameters

[in,out]

bitCount

If non-null and successful, the component bit count is placed here.

Returns

True if it succeeds, false if it fails.

TryGetCondenserContrast()

virtual bool libCZI::IDimensionChannelInfo::TryGetCondenserContrast ( std::wstring *  condensorContrast )

pure virtual

Try to get the condenser contrast.

Parameters

[in,out]

condensorContrast

If non-null and successful, the condensor contrast is placed here.

Returns

True if it succeeds, false if it fails.

TryGetContrastMethod()

virtual bool libCZI::IDimensionChannelInfo::TryGetContrastMethod ( DimensionChannelContrastMethod *  contrastMethod )

pure virtual

Try to get the contrast method

Parameters

[in,out]

contrastMethod

If non-null and successful, the contrast method is placed here.

Returns

True if it succeeds, false if it fails.

TryGetDepthOfFocus()

virtual bool libCZI::IDimensionChannelInfo::TryGetDepthOfFocus ( double *  depthoffocus )

pure virtual

Try to get the depth of focus.

Parameters

[in,out]

depthoffocus

If non-null and successful, the depth of focus is placed here.

Returns

True if it succeeds, false if it fails.

TryGetDetectionWavelength()

virtual bool libCZI::IDimensionChannelInfo::TryGetDetectionWavelength ( SpectrumCharacteristics *  detectionwavelength )

pure virtual

Try to get the detection wavelength information.

Parameters

[in,out]

detectionwavelength

If non-null and successful, the detection wavelength information is placed here.

Returns

True if it succeeds, false if it fails.

TryGetDyeDatabaseId()

virtual bool libCZI::IDimensionChannelInfo::TryGetDyeDatabaseId ( std::wstring *  dyedatabaseid )

pure virtual

Try to get the dye database identifier.

Parameters

[in,out]

dyedatabaseid

If non-null and successful, the dye database identifier is placed here.

Returns

True if it succeeds, false if it fails.

TryGetDyeId()

virtual bool libCZI::IDimensionChannelInfo::TryGetDyeId ( std::wstring *  dyeid )

pure virtual

Try to get the dye identifier.

Parameters

[in,out]

dyeid

If non-null and successful, the dye identifier is placed here.

Returns

True if it succeeds, false if it fails.

TryGetEffectiveNA()

virtual bool libCZI::IDimensionChannelInfo::TryGetEffectiveNA ( double *  na )

pure virtual

Try to get the effective numerical aperture.

Parameters

[in,out]

na

If non-null and successful, the effective numerical aperture is placed here.

Returns

True if it succeeds, false if it fails.

TryGetEmissionWavelength()

virtual bool libCZI::IDimensionChannelInfo::TryGetEmissionWavelength ( double *  emissionwavelength )

pure virtual

Try to get emission wavelength.

Parameters

[in,out]

emissionwavelength

If non-null and successful, the emission wavelength is placed here.

Returns

True if it succeeds, false if it fails.

TryGetExcitationWavelength()

virtual bool libCZI::IDimensionChannelInfo::TryGetExcitationWavelength ( double *  excitationwavelength )

pure virtual

Try to get excitation wavelength.

Parameters

[in,out]

excitationwavelength

If non-null and successful, the excitation wavelength is placed here.

Returns

True if it succeeds, false if it fails.

TryGetExposureTime()

virtual bool libCZI::IDimensionChannelInfo::TryGetExposureTime ( RangeOrSingleValue< std::uint64_t > *  exposuretime )

pure virtual

Try to get the exposure time

Parameters

[in,out]

exposuretime

If non-null and successful, the exposure time is placed here.

Returns

True if it succeeds, false if it fails.

TryGetFluor()

virtual bool libCZI::IDimensionChannelInfo::TryGetFluor ( std::wstring *  fluor )

pure virtual

Try to get the name of the fluorophor used to produce this channel [plain text string].

Parameters

[in,out]

fluor

If non-null and successful, the name of the fluorophor is placed here.

Returns

True if it succeeds, false if it fails.

TryGetIlluminationType()

virtual bool libCZI::IDimensionChannelInfo::TryGetIlluminationType ( DimensionChannelIlluminationType *  illuminationType )

pure virtual

Try to get the illumination type

Parameters

[in,out]

illuminationType

If non-null and successful, the illumination type is placed here.

Returns

True if it succeeds, false if it fails.

TryGetIlluminationWavelength()

virtual bool libCZI::IDimensionChannelInfo::TryGetIlluminationWavelength ( SpectrumCharacteristics *  illuminationwavelength )

pure virtual

Try to get the illumination wavelength information.

Parameters

[in,out]

illuminationwavelength

If non-null and successful, the illumination wavelength information is placed here.

Returns

True if it succeeds, false if it fails.

TryGetNACondenser()

virtual bool libCZI::IDimensionChannelInfo::TryGetNACondenser ( double *  naCondensor )

pure virtual

Try to get numerical aperture of the condenser.

Parameters

[in,out]

naCondensor

If non-null, the numerical aperture of the condenser.

Returns

True if it succeeds, false if it fails.

TryGetNDFilter()

virtual bool libCZI::IDimensionChannelInfo::TryGetNDFilter ( double *  ndfilter )

pure virtual

Try to get optical density of ND filters used.

Parameters

[in,out]

ndfilter

If non-null and successful, the optical density of ND filters used is placed here.

Returns

True if it succeeds, false if it fails.

TryGetPinholeGeometry()

virtual bool libCZI::IDimensionChannelInfo::TryGetPinholeGeometry ( DimensionChannelPinholeGeometry *  pinholegeometry )

pure virtual

Try to get the pinhole geometry.

Parameters

[in,out]

pinholegeometry

If non-null and successful, the pinhole geometry is placed here.

Returns

True if it succeeds, false if it fails.

TryGetPinholeSize()

virtual bool libCZI::IDimensionChannelInfo::TryGetPinholeSize ( double *  pinholesize )

pure virtual

Try to get the pinhole size.

Parameters

[in,out]

pinholesize

If non-null and successful, the pinhole size is placed here.

Returns

True if it succeeds, false if it fails.

TryGetPinholeSizeAiry()

virtual bool libCZI::IDimensionChannelInfo::TryGetPinholeSizeAiry ( double *  pinholesizeairy )

pure virtual

Try to get the pinhole size in units of airy disk size.

Parameters

[in,out]

pinholesizeairy

If non-null, the pinhole size in units of airy disk size if placed here.

Returns

True if it succeeds, false if it fails.

TryGetPixelType()

virtual bool libCZI::IDimensionChannelInfo::TryGetPixelType ( PixelType *  pixelType )

pure virtual

Try to get the pixel type

Parameters

[in,out]

pixelType

If non-null and successful, the pixel type is placed here.

Returns

True if it succeeds, false if it fails.

TryGetPocketCellSetting()

virtual bool libCZI::IDimensionChannelInfo::TryGetPocketCellSetting ( int *  pocketcellsetting )

pure virtual

Try to get the pocket cell setting.

Parameters

[in,out]

pocketcellsetting

If non-null and successful, the pocket cell setting is placed here.

Returns

True if it succeeds, false if it fails.

TryGetReflector()

virtual bool libCZI::IDimensionChannelInfo::TryGetReflector ( std::wstring *  reflector )

pure virtual

Try to get the reflector.

Parameters

[in,out]

reflector

If non-null and successful, the reflector is placed here.

Returns

True if it succeeds, false if it fails.

TryGetSectionThickness()

virtual bool libCZI::IDimensionChannelInfo::TryGetSectionThickness ( double *  sectionthickness )

pure virtual

Try to get the section thickness.

Parameters

[in,out]

sectionthickness

If non-null and successful, the section thickness is placed here.

Returns

True if it succeeds, false if it fails.

---

The documentation for this class was generated from the following file:

• libCZI/libCZI_Metadata2.h