libCZI
Reading CZI documents made easy
Public Types | Public Member Functions | List of all members
libCZI::IDimensionChannelRatio Class Referenceabstract

Public Types

enum  Type : std::uint8_t {
  NoOnlineCalculation, OnlineRatio, OnlineSubtraction, OnlineSubtractionRatio,
  OnlineHillFunction, OnlineReferenceRatio, OnlineLinearUnmixing
}
 

Public Member Functions

virtual bool TryGetType (Type *type)=0
 
virtual bool TryGetConst1 (double *c1)=0
 
virtual bool TryGetConst2 (double *c2)=0
 
virtual bool TryGetConst3 (double *c3)=0
 
virtual bool TryGetConst4 (double *c4)=0
 
virtual bool TryGetConst5 (double *c5)=0
 
virtual bool TryGetConst6 (double *c6)=0
 
virtual bool TryGetSource1 (std::vector< std::wstring > *source1)=0
 
virtual bool TryGetSource2 (std::vector< std::wstring > *source2)=0
 

Member Enumeration Documentation

◆ Type

enum libCZI::IDimensionChannelRatio::Type : std::uint8_t
strong

The type of an online calculation where the channel is the destination. 

The following values are possible :

NoOnlineCalculation - The data channel receives raw scan data.
    OnlineRatio - (S1 + C1) / (S2 + C2) * C3 + C4
    OnlineSubtraction - (S1 * C1 - S2 * C3) / C2 + C4
    OnlineSubtractionRatio - (S1 - S2 * C1) / (S1 + S2 * C2) * C3 + C4
    OnlineHillFunction - C3 * (C4 / C5) * (S1 - C1) / (C2 - S2)
    OnlineReferenceRatio - (S1 - S2 + C1) / (S2 - C2) * C3 + C4
    OnlineLinearUnmixing - The Linear Unmixing processing.

    The operands and constants are :

S1 - Source1
    S2 - Source2
    C1 - RatioConstant1
    C2 - RatioConstant2
    C3 - RatioConstant3
    C4 - RatioConstant4
    C5 - RatioConstant5

Member Function Documentation

◆ TryGetSource1()

virtual bool libCZI::IDimensionChannelRatio::TryGetSource1 ( std::vector< std::wstring > *  source1)
pure virtual

Specifies the source operands S1 for an online calculation. The vector contains references to channels (ChannelRefs).

Parameters
[in,out]source1If non-null and the property is available, it will be put here.
Returns
True if it succeeds, false otherwise.

◆ TryGetSource2()

virtual bool libCZI::IDimensionChannelRatio::TryGetSource2 ( std::vector< std::wstring > *  source2)
pure virtual

Specifies the source operands S2 for an online calculation. The vector contains references to channels (ChannelRefs).

Parameters
[in,out]source2If non-null and the property is available, it will be put here.
Returns
True if it succeeds, false otherwise.
The documentation for this class was generated from the following file: