Struct ChannelDisplaySettingsPOD

• Defined in File libCZI_Metadata.h

Struct Documentation

struct ChannelDisplaySettingsPOD

This POD (“plain-old-data”) structure is intended to capture all information found inside an IChannelDisplaySetting-object. It allows for easy modification of the information.

Public Functions

inline void Clear()

Sets the structure to a defined standard value - not enabled, no tinting, linear gradation-curve and black-point to zero and white-point to one.

Public Members

bool isEnabled

A boolean indicating whether the corresponding channel is ‘active’ in the multi-channel-composition.

float weight

The weight of the channel (for multi-channel-composition).

IDisplaySettings::TintingMode tintingMode

The tinting mode.

libCZI::Rgb8Color tintingColor

The tinting color (only valid if tinting mode == Color).

float blackPoint

The (normalized) black point value.

float whitePoint

The (normalized) white point value.

IDisplaySettings::GradationCurveMode gradationCurveMode

The gradation curve mode.

float gamma

The value for gamma (only valid if gradation curve mode == Gamma).

std::vector<libCZI::IDisplaySettings::SplineControlPoint> splineCtrlPoints

The spline control points (only valid if gradation curve mode == Spline).

Public Static Functions

static IChannelDisplaySetting *CreateIChannelDisplaySetting(const ChannelDisplaySettingsPOD &pod)

Creates an IChannelDisplaySetting-object from the specified ChannelDisplaySettingsPOD-structure.

Parameters:

pod – The ChannelDisplaySettingsPOD-structure.

Returns:

The newly created IChannelDisplaySetting-object.

static std::shared_ptr<IChannelDisplaySetting> CreateIChannelDisplaySettingSp(const ChannelDisplaySettingsPOD &pod)

Creates an IChannelDisplaySetting-object from the specified ChannelDisplaySettingsPOD-structure, and return it as a shared pointer.

Parameters:

pod – The ChannelDisplaySettingsPOD-structure.

Returns:

The newly created IChannelDisplaySetting-object inside a shared pointer.