Class IDimensionChannelRatio

Class IDimensionChannelRatio#

Class Documentation#

class IDimensionChannelRatio#

Information about the channel ratio.

Public Types

enum class Type : std::uint8_t#

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

Values:

enumerator NoOnlineCalculation#

An enum constant representing the “no online calculation option”.

enumerator OnlineRatio#

An enum constant representing the “online ratio calculation option”.

enumerator OnlineSubtraction#

An enum constant representing the “online subtraction calculation option”.

enumerator OnlineSubtractionRatio#

An enum constant representing the “online subtraction and ratio calculation option”.

enumerator OnlineHillFunction#

An enum constant representing the “online Hill function calculation option”.

enumerator OnlineReferenceRatio#

An enum constant representing the “online reference ratio calculation option”.

enumerator OnlineLinearUnmixing#

An enum constant representing the “online un-mixing calculation option”.

Public Functions

virtual bool TryGetType(Type *type) = 0#

Try to get the type.

Parameters:

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

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetConst1(double *c1) = 0#

Try to get the constant #1.

Parameters:

c1 – [inout] If non-null and successful, the constant #1 is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetConst2(double *c2) = 0#

Try to get the constant #2.

Parameters:

c2 – [inout] If non-null and successful, the constant #2 is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetConst3(double *c3) = 0#

Try to get the constant #3.

Parameters:

c3 – [inout] If non-null and successful, the constant #3 is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetConst4(double *c4) = 0#

Try to get the constant #4.

Parameters:

c4 – [inout] If non-null and successful, the constant #4 is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetConst5(double *c5) = 0#

Try to get the constant #5.

Parameters:

c5 – [inout] If non-null and successful, the constant #5 is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetConst6(double *c6) = 0#

Try to get the constant #6.

Parameters:

c6 – [inout] If non-null and successful, the constant #6 is placed here.

Returns:

True if it succeeds, false if it fails.

virtual bool TryGetSource1(std::vector<std::wstring> *source1) = 0#

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

Parameters:

source1 – [inout] If non-null and the property is available, it will be put here.

Returns:

True if it succeeds, false otherwise.

virtual bool TryGetSource2(std::vector<std::wstring> *source2) = 0#

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

Parameters:

source2 – [inout] If non-null and the property is available, it will be put here.

Returns:

True if it succeeds, false otherwise.

virtual ~IDimensionChannelRatio() = default#
Contents