IDS peak ICV v1.0.0
Loading...
Searching...
No Matches
peak_icv_digital_black_feature.hpp
Go to the documentation of this file.
1
11#pragma once
12
16
17namespace peak
18{
19namespace pipeline
20{
21namespace features
22{
23
56{
57public:
66
70 void SetEnabled(bool enabled) override;
71
75 PEAK_COMMON_NO_DISCARD bool IsEnabled() const override;
76
84 void ResetToDefault() override;
85
98 void SetValue(float digitalBlack);
99
107 PEAK_COMMON_NO_DISCARD float GetValue() const;
108
119
120private:
122};
123
127
128inline void DigitalBlackFeature::SetEnabled(bool enabled)
129{
130 m_module.SetDigitalBlackEnabled(enabled);
131}
132
134{
135 return m_module.IsDigitalBlackEnabled();
136}
137
139{
140 SetValue(0.0F);
141}
142
143inline void DigitalBlackFeature::SetValue(float digitalBlack)
144{
145 m_module.SetDigitalBlack(digitalBlack);
146}
147
149{
150 return m_module.GetDigitalBlack();
151}
152
154{
155 return m_module.GetDigitalBlackRange();
156}
157
158} // namespace features
159} // namespace pipeline
160} // namespace peak
Represents a continuous numeric interval with inclusive lower and upper bounds.
Tone curve correction is an image pipeline module that applies digital black correction and inverse g...
void SetDigitalBlack(float digitalBlack)
Sets the digital black used for digital black correction.
peak::common::IntervalF GetDigitalBlackRange() const
Returns the valid range for the digital black correction value.
float GetDigitalBlack() const
Gets the current digital black used for correction.
Digital black applies digital black correction to an image.
peak::common::IntervalF GetRange() const
Retrieves the valid range for the digital black value.
DigitalBlackFeature(detail::ToneCurveCorrectionModule &module)
Creates a DigitalBlackFeature for an existing tone curve correction module.
void SetValue(float digitalBlack)
Sets the digital black correction value.
void SetEnabled(bool enabled) override
Enables or disables the feature.
float GetValue() const
Gets the current digital black correction value.
void ResetToDefault() override
Resets the digital black value to its default.
bool IsEnabled() const override
Indicates whether the feature is currently enabled.
Abstract base class for all image processing pipeline features.
#define PEAK_COMMON_NO_DISCARD
Compatability macro for the nodiscard attribute.