Class IDimensionChannelInfo

Class IDimensionChannelInfo#

Inheritance Relationships#

Base Types#

Class Documentation#

class IDimensionChannelInfo : public libCZI::IAttributeId, public libCZI::IAttributeName#

Information about the dimension “channel”.

Public Functions

virtual bool TryGetChannelType(DimensionChannelChannelType *type) const = 0#

Try to get the channel type.

Parameters:

type – [inout] If non-null and successful, the channel type is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetChannelUnit(std::wstring *unit) const = 0#

Try to get the channel unit.

Parameters:

unit – [inout] If non-null and successful, the channel unit is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetPixelType(PixelType *pixelType) const = 0#

Try to get the pixel type

Parameters:

pixelType – [inout] If non-null and successful, the pixel type is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetComponentBitCount(int *bitCount) const = 0#

Try to get the component bit count.

Parameters:

bitCount – [inout] If non-null and successful, the component bit count is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetAcquisitionMode(DimensionChannelAcquisitionMode *acquisitionMode) const = 0#

Try to get the acquisition mode.

Parameters:

acquisitionMode – [inout] If non-null and successful, the acquisition mode is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetIlluminationType(DimensionChannelIlluminationType *illuminationType) const = 0#

Try to get the illumination type

Parameters:

illuminationType – [inout] If non-null and successful, the illumination type is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetContrastMethod(DimensionChannelContrastMethod *contrastMethod) const = 0#

Try to get the contrast method

Parameters:

contrastMethod – [inout] If non-null and successful, the contrast method is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetIlluminationWavelength(SpectrumCharacteristics *illuminationwavelength) const = 0#

Try to get the illumination wavelength information.

Parameters:

illuminationwavelength – [inout] If non-null and successful, the illumination wavelength information is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetDetectionWavelength(SpectrumCharacteristics *detectionwavelength) const = 0#

Try to get the detection wavelength information.

Parameters:

detectionwavelength – [inout] If non-null and successful, the detection wavelength information is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetExcitationWavelength(double *excitationwavelength) const = 0#

Try to get excitation wavelength.

Parameters:

excitationwavelength – [inout] If non-null and successful, the excitation wavelength is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetEmissionWavelength(double *emissionwavelength) const = 0#

Try to get emission wavelength.

Parameters:

emissionwavelength – [inout] If non-null and successful, the emission wavelength is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetEffectiveNA(double *na) const = 0#

Try to get the effective numerical aperture.

Parameters:

na – [inout] If non-null and successful, the effective numerical aperture is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetDyeId(std::wstring *dyeid) const = 0#

Try to get the dye identifier.

Parameters:

dyeid – [inout] If non-null and successful, the dye identifier is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetDyeDatabaseId(std::wstring *dyedatabaseid) const = 0#

Try to get the dye database identifier.

Parameters:

dyedatabaseid – [inout] If non-null and successful, the dye database identifier is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetPinholeSize(double *pinholesize) const = 0#

Try to get the pinhole size.

Parameters:

pinholesize – [inout] If non-null and successful, the pinhole size is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetPinholeSizeAiry(double *pinholesizeairy) const = 0#

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

Parameters:

pinholesizeairy – [inout] If non-null, the pinhole size in units of airy disk size if placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetPinholeGeometry(DimensionChannelPinholeGeometry *pinholegeometry) const = 0#

Try to get the pinhole geometry.

Parameters:

pinholegeometry – [inout] If non-null and successful, the pinhole geometry is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetFluor(std::wstring *fluor) const = 0#

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

Parameters:

fluor – [inout] If non-null and successful, the name of the fluorophor is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetNDFilter(double *ndfilter) const = 0#

Try to get optical density of ND filters used.

Parameters:

ndfilter – [inout] If non-null and successful, the optical density of ND filters used is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetPocketCellSetting(int *pocketcellsetting) const = 0#

Try to get the pocket cell setting.

Parameters:

pocketcellsetting – [inout] If non-null and successful, the pocket cell setting is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetColor(libCZI::Rgb8Color *color) const = 0#

Try to get the color.

Parameters:

color – [inout] If non-null and successful, the color is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetExposureTime(RangeOrSingleValue<std::uint64_t> *exposuretime) const = 0#

Try to get the exposure time

Parameters:

exposuretime – [inout] If non-null and successful, the exposure time is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetDepthOfFocus(double *depthoffocus) const = 0#

Try to get the depth of focus.

Parameters:

depthoffocus – [inout] If non-null and successful, the depth of focus is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetSectionThickness(double *sectionthickness) const = 0#

Try to get the section thickness.

Parameters:

sectionthickness – [inout] If non-null and successful, the section thickness is placed here.

Returns:

True if it succeeds, false if it fails.

virtual std::shared_ptr<IDimensionChannelDetectorSettings> GetDetectorSettings() const = 0#

Gets the detector settings.

Returns:

The detector settings.

virtual std::shared_ptr<IDimensionChannelLightSourcesSettings> GetLightSourcesSettings() const = 0#

Gets the light sources settings.

Returns:

The light sources settings.

virtual std::shared_ptr<IDimensionChannelLightPath> GetLightPath() const = 0#

Gets the light path.

Returns:

The light path.

virtual std::shared_ptr<IDimensionChannelLaserScanInfo> GetLaserScanInfo() const = 0#

Gets the laser scan information.

Returns:

The laser scan information.

virtual std::shared_ptr<IDimensionChannelSPIMIlluminationSettings> GetSPIMIlluminationSettings() const = 0#

Gets the SPIM illumination settings

Returns:

The SPIM illumination settings.

virtual std::shared_ptr<IDimensionChannelSPIMDetectionSettings> GetSPIMDetectionSettings() const = 0#

Gets the SPIM detection settings

Returns:

The SPIM detection settings.

virtual std::shared_ptr<IDimensionChannelSIMSettings> GetSIMSettings() const = 0#

Gets the SIM settings.

Returns:

The SIM settings.

virtual std::shared_ptr<IDimensionChannelPolarizingSettings> GetPolarizingSettings() const = 0#

Gets the polarizing settings.

Returns:

The polarizing settings.

virtual std::shared_ptr<IDimensionChannelAiryscanSettings> GetAiryscanSettings() const = 0#

Gets the airy scan settings.

Returns:

The airy scan settings.

virtual bool TryGetReflector(std::wstring *reflector) const = 0#

Try to get the reflector.

Parameters:

reflector – [inout] If non-null and successful, the reflector is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetCondenserContrast(std::wstring *condensorContrast) const = 0#

Try to get the condenser contrast.

Parameters:

condensorContrast – [inout] If non-null and successful, the condensor contrast is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetNACondenser(double *naCondensor) const = 0#

Try to get numerical aperture of the condenser.

Parameters:

naCondensor – [inout] If non-null, the numerical aperture of the condenser.

Returns:

True if it succeeds, false if it fails.

virtual std::shared_ptr<IDimensionChannelRatio> GetRatio() const = 0#

Gets the ratio (between two active channels).

Returns:

The ratio.

~IDimensionChannelInfo() override = default#
Contents