KDcrawIface::RawDecodingSettings Class

Settings for raw decoding. More...

Header: #include <rawdecodingsettings.h>

Public Types

enum DecodingQuality { BILINEAR, VNG, PPG, AHD, DCB, …, AAHD }
enum InputColorSpace { NOINPUTCS, EMBEDDED, CUSTOMINPUTCS }
enum NoiseReduction { NONR, WAVELETSNR, FBDDNR, LINENR, IMPULSENR }
enum OutputColorSpace { RAWCOLOR, SRGB, ADOBERGB, WIDEGAMMUT, PROPHOTO, CUSTOMOUTPUTCS }
enum WhiteBalance { NONE, CAMERA, AUTO, CUSTOM, AERA }

Public Functions

RawDecodingSettings()
RawDecodingSettings(const KDcrawIface::RawDecodingSettings &prm)
virtual ~RawDecodingSettings()
void optimizeTimeLoading()
KDcrawIface::RawDecodingSettings &operator=(const KDcrawIface::RawDecodingSettings &prm)
bool operator==(const KDcrawIface::RawDecodingSettings &o) const

Public Variables

bool DontStretchPixels
int NRThreshold
KDcrawIface::RawDecodingSettings::NoiseReduction NRType
KDcrawIface::RawDecodingSettings::DecodingQuality RAWQuality
bool RGBInterpolate4Colors
bool autoBrightness
int blackPoint
double brightness
int customWhiteBalance
bool dcbEnhanceFl
int dcbIterations
QString deadPixelMap
bool enableBlackPoint
bool enableWhitePoint
bool expoCorrection
double expoCorrectionHighlight
double expoCorrectionShift
bool fixColorsHighlights
bool halfSizeColorImage
KDcrawIface::RawDecodingSettings::InputColorSpace inputColorSpace
QString inputProfile
int medianFilterPasses
KDcrawIface::RawDecodingSettings::OutputColorSpace outputColorSpace
QString outputProfile
bool sixteenBitsImage
int unclipColors
KDcrawIface::RawDecodingSettings::WhiteBalance whiteBalance
QRect whiteBalanceArea
int whitePoint

Detailed Description

Member Type Documentation

enum RawDecodingSettings::DecodingQuality

RAW decoding Interpolation methods

ConstantValueDescription
KDcrawIface::RawDecodingSettings::BILINEAR0use high-speed but low-quality bilinear interpolation (default - for slow computer). In this method, the red value of a non-red pixel is computed as the average of the adjacent red pixels, and similar for blue and green.
KDcrawIface::RawDecodingSettings::VNG1use Variable Number of Gradients interpolation. This method computes gradients near the pixel of interest and uses the lower gradients (representing smoother and more similar parts of the image) to make an estimate.
KDcrawIface::RawDecodingSettings::PPG2use Patterned Pixel Grouping interpolation. Pixel Grouping uses assumptions about natural scenery in making estimates. It has fewer color artifacts on natural images than the Variable Number of Gradients method.
KDcrawIface::RawDecodingSettings::AHD3use Adaptive Homogeneity-Directed interpolation. This method selects the direction of interpolation so as to maximize a homogeneity metric, thus typically minimizing color artifacts.
KDcrawIface::RawDecodingSettings::DCB4DCB interpolation (see http://www.linuxphoto.org/html/dcb.html for details)

Note: from GPL2/GPL3 demosaic packs - will not work with libraw>=0.19

KDcrawIface::RawDecodingSettings::PL_AHD5modified AHD interpolation (see https://sites.google.com/site/demosaicalgorithms/modified-dcraw for details).
KDcrawIface::RawDecodingSettings::AFD6demosaicing through 5 pass median filter from PerfectRaw project.
KDcrawIface::RawDecodingSettings::VCD7VCD interpolation.
KDcrawIface::RawDecodingSettings::VCD_AHD8mixed demosaicing between VCD and AHD.
KDcrawIface::RawDecodingSettings::LMMSE9LMMSE interpolation from PerfectRaw.
KDcrawIface::RawDecodingSettings::AMAZE10AMaZE interpolation and color aberration removal from RawTherapee project.

Note: for libraw>=0.19 only

KDcrawIface::RawDecodingSettings::DHT11DHT interpolation.
KDcrawIface::RawDecodingSettings::AAHD12Enhanced Adaptive AHD interpolation.

enum RawDecodingSettings::InputColorSpace

Input color profile used to decoded image

ConstantValueDescription
KDcrawIface::RawDecodingSettings::NOINPUTCS0No input color profile.
KDcrawIface::RawDecodingSettings::EMBEDDED1Use the camera profile embedded in RAW file if exist.
KDcrawIface::RawDecodingSettings::CUSTOMINPUTCS2Use a custom input color space profile.

enum RawDecodingSettings::NoiseReduction

Noise Reduction method to apply before demosaicing

ConstantValueDescription
KDcrawIface::RawDecodingSettings::NONR0No noise reduction.
KDcrawIface::RawDecodingSettings::WAVELETSNR1wavelets correction to erase noise while preserving real detail. It's applied after interpolation.
KDcrawIface::RawDecodingSettings::FBDDNR2Fake Before Demosaicing Denoising noise reduction. It's applied before interpolation.
KDcrawIface::RawDecodingSettings::LINENR3CFA Line Denoise. It's applied after interpolation.
KDcrawIface::RawDecodingSettings::IMPULSENR4Impulse Denoise. It's applied after interpolation.

enum RawDecodingSettings::OutputColorSpace

Output RGB color space used to decoded image

ConstantValueDescription
KDcrawIface::RawDecodingSettings::RAWCOLOR0No output color profile (Linear RAW).
KDcrawIface::RawDecodingSettings::SRGB1Use standard sRGB color space.
KDcrawIface::RawDecodingSettings::ADOBERGB2Use standard Adobe RGB color space.
KDcrawIface::RawDecodingSettings::WIDEGAMMUT3Use standard RGB Wide Gamut color space.
KDcrawIface::RawDecodingSettings::PROPHOTO4Use standard RGB Pro Photo color space.
KDcrawIface::RawDecodingSettings::CUSTOMOUTPUTCS5Use a custom workspace color profile.

enum RawDecodingSettings::WhiteBalance

White balances alternatives

ConstantValueDescription
KDcrawIface::RawDecodingSettings::NONE0no white balance used : reverts to standard daylight D65 WB.
KDcrawIface::RawDecodingSettings::CAMERA1Use the camera embedded WB if available. Reverts to NONE if not.
KDcrawIface::RawDecodingSettings::AUTO2Averages an auto WB on the entire image.
KDcrawIface::RawDecodingSettings::CUSTOM3Let use set its own temperature and green factor (later converted to RGBG factors).
KDcrawIface::RawDecodingSettings::AERA4Let use an area from image to average white balance (see whiteBalanceArea for details).

Member Function Documentation

RawDecodingSettings::RawDecodingSettings()

Standard constructor

RawDecodingSettings::RawDecodingSettings(const KDcrawIface::RawDecodingSettings &prm)

Standard constructor with default settings

[virtual noexcept] RawDecodingSettings::~RawDecodingSettings()

Standard destructor

void RawDecodingSettings::optimizeTimeLoading()

Method to use a settings to optimize time loading, for example to compute image histogram

KDcrawIface::RawDecodingSettings &RawDecodingSettings::operator=(const KDcrawIface::RawDecodingSettings &prm)

Equivalent to the copy constructor

bool RawDecodingSettings::operator==(const KDcrawIface::RawDecodingSettings &o) const

Compare for equality

Member Variable Documentation

bool RawDecodingSettings::DontStretchPixels

For cameras with non-square pixels, do not stretch the image to its correct aspect ratio. In any case, this option guarantees that each output pixel corresponds to one RAW pixel.

int RawDecodingSettings::NRThreshold

Noise reduction threshold value. Null value disable NR. Range is between 100 and 1000. For IMPULSENR : set the amount of Luminance impulse denoise.

KDcrawIface::RawDecodingSettings::NoiseReduction RawDecodingSettings::NRType

Noise reduction method to apply before demosaicing.

KDcrawIface::RawDecodingSettings::DecodingQuality RawDecodingSettings::RAWQuality

RAW quality decoding factor value.

See also DecodingQuality.

bool RawDecodingSettings::RGBInterpolate4Colors

Turn on RAW file decoding using RGB interpolation as four colors.

bool RawDecodingSettings::autoBrightness

If false, use a fixed white level, ignoring the image histogram.

int RawDecodingSettings::blackPoint

Black Point value of output image.

double RawDecodingSettings::brightness

Brightness of output image.

int RawDecodingSettings::customWhiteBalance

The temperature and the green multiplier of the custom white balance

bool RawDecodingSettings::dcbEnhanceFl

Turn on the DCB interpolation with enhance interpolated colors.

int RawDecodingSettings::dcbIterations

Number of DCB median filtering correction passes.

  • -1 : disable (default)
  • 1-10 : DCB correction passes

QString RawDecodingSettings::deadPixelMap

Path to text file including dead pixel list.

bool RawDecodingSettings::enableBlackPoint

Turn on the black point setting to decode RAW image.

bool RawDecodingSettings::enableWhitePoint

Turn on the white point setting to decode RAW image.

bool RawDecodingSettings::expoCorrection

Turn on the Exposure Correction before interpolation.

double RawDecodingSettings::expoCorrectionHighlight

Amount of highlight preservation for exposure correction before interpolation in E.V. Usable range is from 0.0 (linear exposure shift, highlights may blow) to 1.0 (maximum highlights preservation) This settings can only take effect if expoCorrectionShift > 1.0.

double RawDecodingSettings::expoCorrectionShift

Shift of Exposure Correction before interpolation in linear scale. Usable range is from 0.25 (darken image 1 stop : -2EV) to 8.0 (lighten ~1.5 photographic stops : +3EV).

bool RawDecodingSettings::fixColorsHighlights

If true, images with overblown channels are processed much more accurately, without 'pink clouds' (and blue highlights under tungsten lamps).

bool RawDecodingSettings::halfSizeColorImage

Half-size color image decoding (twice as fast as "enableRAWQuality"). Turn on this option to reduce time loading to render histogram for example, no to render an image to screen.

KDcrawIface::RawDecodingSettings::InputColorSpace RawDecodingSettings::inputColorSpace

The input color profile used to decoded RAW data.

See also InputColorSpace.

QString RawDecodingSettings::inputProfile

Path to custom input ICC profile to define the camera's raw colorspace.

int RawDecodingSettings::medianFilterPasses

After interpolation, clean up color artifacts by repeatedly applying a 3x3 median filter to the R-G and B-G channels.

KDcrawIface::RawDecodingSettings::OutputColorSpace RawDecodingSettings::outputColorSpace

The output color profile used to decoded RAW data.

See also OutputColorSpace.

QString RawDecodingSettings::outputProfile

Path to custom output ICC profile to define the color workspace.

bool RawDecodingSettings::sixteenBitsImage

Turn on RAW file decoding in 16 bits per color per pixel instead 8 bits.

int RawDecodingSettings::unclipColors

Unclip Highlight color level:

  • 0 = Clip all highlights to solid white.
  • 1 = Leave highlights unclipped in various shades of pink.
  • 2 = Blend clipped and unclipped values together for a gradual fade to white.
  • 3-9 = Reconstruct highlights. Low numbers favor whites; high numbers favor colors.

KDcrawIface::RawDecodingSettings::WhiteBalance RawDecodingSettings::whiteBalance

White balance type to use.

See also WhiteBalance.

QRect RawDecodingSettings::whiteBalanceArea

Rectangle used to calculate the white balance by averaging the region of image.

int RawDecodingSettings::whitePoint

White Point value of output image.