libCZI
Reading CZI documents made easy
libCZI::IDisplaySettings Class Referenceabstract

The display settings. More...

#include <libCZI_Metadata.h>

Classes

struct  CubicSplineCoefficients
 The coefficients of a cubic spline defined by \(a\,x^3 + b\,x^2 + c\,x + d =y\). More...
 
struct  SplineControlPoint
 The (normalized) control points of a spline. More...
 
struct  SplineData
 The defintion of the (piecewise) spline. The spline starts at xPos which is the normalized position (between 0 and 1). More...
 

Public Types

enum  GradationCurveMode { GradationCurveMode::Linear, GradationCurveMode::Gamma, GradationCurveMode::Spline }
 Values that represent the gradation curve modes. More...
 

Public Member Functions

virtual void EnumChannels (std::function< bool(int chIndex)> func) const =0
 
virtual std::shared_ptr< libCZI::IChannelDisplaySettingGetChannelDisplaySettings (int chIndex) const =0
 

Detailed Description

The display settings.

Member Enumeration Documentation

◆ GradationCurveMode

Values that represent the gradation curve modes.

Enumerator
Linear 

The gradation curve is a straight line (from white point to black point).

Gamma 

The gradation curve is defined by a gamma.

Spline 

The gradation curve is defined by piecewise splines.

Member Function Documentation

◆ EnumChannels()

virtual void libCZI::IDisplaySettings::EnumChannels ( std::function< bool(int chIndex)>  func) const
pure virtual

Enum all channels (which are described by the display-settings object).

Parameters
funcThe functor to be called (passing in the channel index). If the functor returns false, the enumeration is stopped.

◆ GetChannelDisplaySettings()

virtual std::shared_ptr<libCZI::IChannelDisplaySetting> libCZI::IDisplaySettings::GetChannelDisplaySettings ( int  chIndex) const
pure virtual

Gets channel display settings for the specified channel. If the channel index is not valid, then an empty shared_ptr is returned.

Parameters
chIndexThe channel index.
Returns
The channel display settings object (if the channel index was valid), and empty shared_ptr otherwise.

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