diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000000..e69de29bb2 diff --git a/css/.gitkeep b/css/.gitkeep new file mode 100644 index 0000000000..8d1c8b69c3 --- /dev/null +++ b/css/.gitkeep @@ -0,0 +1 @@ + diff --git a/css/style.css.map b/css/style.css.map new file mode 100644 index 0000000000..1a15e757e4 --- /dev/null +++ b/css/style.css.map @@ -0,0 +1,231 @@ +{ + "version": 3, + "file": "style.css", + "sourceRoot": "/home/runner/work/dtdocs/dtdocs", + "sources": [ + "themes/hugo-darktable-docs-theme/assets/sass/main.scss", + "themes/hugo-darktable-docs-theme/assets/sass/modules/variables.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/bootstrap.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_functions.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_variables.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_mixins.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/vendor/_rfs.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_deprecate.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_breakpoints.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_hover.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_image.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_badge.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_resize.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_screen-reader.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_size.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_reset-text.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_text-emphasis.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_text-hide.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_text-truncate.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_visibility.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_alert.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_buttons.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_caret.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_pagination.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_lists.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_list-group.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_nav-divider.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_forms.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_table-row.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_background-variant.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_border-radius.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_box-shadow.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_gradients.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_transition.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_clearfix.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_grid-framework.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_grid.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/mixins/_float.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_root.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_reboot.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_type.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_images.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_code.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_grid.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_tables.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_forms.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_buttons.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_transitions.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_dropdown.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_button-group.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_input-group.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_custom-forms.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_nav.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_navbar.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_card.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_breadcrumb.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_pagination.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_badge.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_jumbotron.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_alert.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_progress.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_media.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_list-group.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_close.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_toasts.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_modal.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_tooltip.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_popover.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_carousel.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_spinners.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_utilities.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_align.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_background.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_borders.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_clearfix.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_display.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_embed.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_flex.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_float.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_interactions.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_overflow.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_position.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_screenreaders.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_shadows.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_sizing.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_spacing.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_stretched-link.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_text.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/utilities/_visibility.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/bootstrap/scss/_print.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/fork-awesome.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_variables.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_mixins.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_functions.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_path.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_core.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_larger.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_fixed-width.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_list.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_bordered-pulled.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_animated.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_rotated-flipped.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_stacked.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_icons.scss", + "themes/hugo-darktable-docs-theme/assets/node_modules/fork-awesome/scss/_screen-reader.scss", + "themes/hugo-darktable-docs-theme/assets/sass/modules/typography.scss", + "themes/hugo-darktable-docs-theme/assets/sass/modules/nav.scss", + "themes/hugo-darktable-docs-theme/assets/sass/modules/body.scss", + "themes/hugo-darktable-docs-theme/assets/sass/modules/images.scss", + "themes/hugo-darktable-docs-theme/assets/sass/modules/print.scss" + ], + "sourcesContent": [ + "/* Override any bootstrap variables here before importing bootstrap itself */\n\n@import 'modules/variables';\n\n/* Import bootstrap's sass */\n@import 'bootstrap';\n\n/* Import fork-awesome */\n@import 'fork-awesome';\n\n/* Custom SASS imports */\n\n@import 'modules/typography';\n@import 'modules/nav';\n@import 'modules/body';\n@import 'modules/images';\n@import 'modules/print';\n", + "// Variables are taken from bootstrap's _variables.scss file\n\n// Color system\n\n$white: #fff !default;\n$gray-100: #f8f9fa !default;\n$gray-200: #e9ecef !default;\n$gray-300: #dee2e6 !default;\n$gray-400: #ced4da !default;\n$gray-500: #adb5bd !default;\n$gray-600: #6c757d !default;\n$gray-700: #495057 !default;\n$gray-800: #343a40 !default;\n$gray-900: #212529 !default;\n$black: #000 !default;\n\n\n$code-color: $black;\n", + "/*!\n * Bootstrap v4.5.3 (https://getbootstrap.com/)\n * Copyright 2011-2020 The Bootstrap Authors\n * Copyright 2011-2020 Twitter, Inc.\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n */\n\n@import \"functions\";\n@import \"variables\";\n@import \"mixins\";\n@import \"root\";\n@import \"reboot\";\n@import \"type\";\n@import \"images\";\n@import \"code\";\n@import \"grid\";\n@import \"tables\";\n@import \"forms\";\n@import \"buttons\";\n@import \"transitions\";\n@import \"dropdown\";\n@import \"button-group\";\n@import \"input-group\";\n@import \"custom-forms\";\n@import \"nav\";\n@import \"navbar\";\n@import \"card\";\n@import \"breadcrumb\";\n@import \"pagination\";\n@import \"badge\";\n@import \"jumbotron\";\n@import \"alert\";\n@import \"progress\";\n@import \"media\";\n@import \"list-group\";\n@import \"close\";\n@import \"toasts\";\n@import \"modal\";\n@import \"tooltip\";\n@import \"popover\";\n@import \"carousel\";\n@import \"spinners\";\n@import \"utilities\";\n@import \"print\";\n", + "// Bootstrap functions\n//\n// Utility mixins and functions for evaluating source code across our variables, maps, and mixins.\n\n// Ascending\n// Used to evaluate Sass maps like our grid breakpoints.\n@mixin _assert-ascending($map, $map-name) {\n $prev-key: null;\n $prev-num: null;\n @each $key, $num in $map {\n @if $prev-num == null or unit($num) == \"%\" or unit($prev-num) == \"%\" {\n // Do nothing\n } @else if not comparable($prev-num, $num) {\n @warn \"Potentially invalid value for #{$map-name}: This map must be in ascending order, but key '#{$key}' has value #{$num} whose unit makes it incomparable to #{$prev-num}, the value of the previous key '#{$prev-key}' !\";\n } @else if $prev-num >= $num {\n @warn \"Invalid value for #{$map-name}: This map must be in ascending order, but key '#{$key}' has value #{$num} which isn't greater than #{$prev-num}, the value of the previous key '#{$prev-key}' !\";\n }\n $prev-key: $key;\n $prev-num: $num;\n }\n}\n\n// Starts at zero\n// Used to ensure the min-width of the lowest breakpoint starts at 0.\n@mixin _assert-starts-at-zero($map, $map-name: \"$grid-breakpoints\") {\n @if length($map) > 0 {\n $values: map-values($map);\n $first-value: nth($values, 1);\n @if $first-value != 0 {\n @warn \"First breakpoint in #{$map-name} must start at 0, but starts at #{$first-value}.\";\n }\n }\n}\n\n// Replace `$search` with `$replace` in `$string`\n// Used on our SVG icon backgrounds for custom forms.\n//\n// @author Hugo Giraudel\n// @param {String} $string - Initial string\n// @param {String} $search - Substring to replace\n// @param {String} $replace ('') - New value\n// @return {String} - Updated string\n@function str-replace($string, $search, $replace: \"\") {\n $index: str-index($string, $search);\n\n @if $index {\n @return str-slice($string, 1, $index - 1) + $replace + str-replace(str-slice($string, $index + str-length($search)), $search, $replace);\n }\n\n @return $string;\n}\n\n// See https://codepen.io/kevinweber/pen/dXWoRw\n//\n// Requires the use of quotes around data URIs.\n\n@function escape-svg($string) {\n @if str-index($string, \"data:image/svg+xml\") {\n @each $char, $encoded in $escaped-characters {\n // Do not escape the url brackets\n @if str-index($string, \"url(\") == 1 {\n $string: url(\"#{str-replace(str-slice($string, 6, -3), $char, $encoded)}\");\n } @else {\n $string: str-replace($string, $char, $encoded);\n }\n }\n }\n\n @return $string;\n}\n\n// Color contrast\n@function color-yiq($color, $dark: $yiq-text-dark, $light: $yiq-text-light) {\n $r: red($color);\n $g: green($color);\n $b: blue($color);\n\n $yiq: (($r * 299) + ($g * 587) + ($b * 114)) / 1000;\n\n @if ($yiq >= $yiq-contrasted-threshold) {\n @return $dark;\n } @else {\n @return $light;\n }\n}\n\n// Retrieve color Sass maps\n@function color($key: \"blue\") {\n @return map-get($colors, $key);\n}\n\n@function theme-color($key: \"primary\") {\n @return map-get($theme-colors, $key);\n}\n\n@function gray($key: \"100\") {\n @return map-get($grays, $key);\n}\n\n// Request a theme color level\n@function theme-color-level($color-name: \"primary\", $level: 0) {\n $color: theme-color($color-name);\n $color-base: if($level > 0, $black, $white);\n $level: abs($level);\n\n @return mix($color-base, $color, $level * $theme-color-interval);\n}\n\n// Return valid calc\n@function add($value1, $value2, $return-calc: true) {\n @if $value1 == null {\n @return $value2;\n }\n\n @if $value2 == null {\n @return $value1;\n }\n\n @if type-of($value1) == number and type-of($value2) == number and comparable($value1, $value2) {\n @return $value1 + $value2;\n }\n\n @return if($return-calc == true, calc(#{$value1} + #{$value2}), $value1 + unquote(\" + \") + $value2);\n}\n\n@function subtract($value1, $value2, $return-calc: true) {\n @if $value1 == null and $value2 == null {\n @return null;\n }\n\n @if $value1 == null {\n @return -$value2;\n }\n\n @if $value2 == null {\n @return $value1;\n }\n\n @if type-of($value1) == number and type-of($value2) == number and comparable($value1, $value2) {\n @return $value1 - $value2;\n }\n\n @return if($return-calc == true, calc(#{$value1} - #{$value2}), $value1 + unquote(\" - \") + $value2);\n}\n", + "// Variables\n//\n// Variables should follow the `$component-state-property-size` formula for\n// consistent naming. Ex: $nav-link-disabled-color and $modal-content-box-shadow-xs.\n\n// Color system\n\n$white: #fff !default;\n$gray-100: #f8f9fa !default;\n$gray-200: #e9ecef !default;\n$gray-300: #dee2e6 !default;\n$gray-400: #ced4da !default;\n$gray-500: #adb5bd !default;\n$gray-600: #6c757d !default;\n$gray-700: #495057 !default;\n$gray-800: #343a40 !default;\n$gray-900: #212529 !default;\n$black: #000 !default;\n\n$grays: () !default;\n$grays: map-merge(\n (\n \"100\": $gray-100,\n \"200\": $gray-200,\n \"300\": $gray-300,\n \"400\": $gray-400,\n \"500\": $gray-500,\n \"600\": $gray-600,\n \"700\": $gray-700,\n \"800\": $gray-800,\n \"900\": $gray-900\n ),\n $grays\n);\n\n$blue: #007bff !default;\n$indigo: #6610f2 !default;\n$purple: #6f42c1 !default;\n$pink: #e83e8c !default;\n$red: #dc3545 !default;\n$orange: #fd7e14 !default;\n$yellow: #ffc107 !default;\n$green: #28a745 !default;\n$teal: #20c997 !default;\n$cyan: #17a2b8 !default;\n\n$colors: () !default;\n$colors: map-merge(\n (\n \"blue\": $blue,\n \"indigo\": $indigo,\n \"purple\": $purple,\n \"pink\": $pink,\n \"red\": $red,\n \"orange\": $orange,\n \"yellow\": $yellow,\n \"green\": $green,\n \"teal\": $teal,\n \"cyan\": $cyan,\n \"white\": $white,\n \"gray\": $gray-600,\n \"gray-dark\": $gray-800\n ),\n $colors\n);\n\n$primary: $blue !default;\n$secondary: $gray-600 !default;\n$success: $green !default;\n$info: $cyan !default;\n$warning: $yellow !default;\n$danger: $red !default;\n$light: $gray-100 !default;\n$dark: $gray-800 !default;\n\n$theme-colors: () !default;\n$theme-colors: map-merge(\n (\n \"primary\": $primary,\n \"secondary\": $secondary,\n \"success\": $success,\n \"info\": $info,\n \"warning\": $warning,\n \"danger\": $danger,\n \"light\": $light,\n \"dark\": $dark\n ),\n $theme-colors\n);\n\n// Set a specific jump point for requesting color jumps\n$theme-color-interval: 8% !default;\n\n// The yiq lightness value that determines when the lightness of color changes from \"dark\" to \"light\". Acceptable values are between 0 and 255.\n$yiq-contrasted-threshold: 150 !default;\n\n// Customize the light and dark text colors for use in our YIQ color contrast function.\n$yiq-text-dark: $gray-900 !default;\n$yiq-text-light: $white !default;\n\n// Characters which are escaped by the escape-svg function\n$escaped-characters: (\n (\"<\", \"%3c\"),\n (\">\", \"%3e\"),\n (\"#\", \"%23\"),\n (\"(\", \"%28\"),\n (\")\", \"%29\"),\n) !default;\n\n\n// Options\n//\n// Quickly modify global styling by enabling or disabling optional features.\n\n$enable-caret: true !default;\n$enable-rounded: true !default;\n$enable-shadows: false !default;\n$enable-gradients: false !default;\n$enable-transitions: true !default;\n$enable-prefers-reduced-motion-media-query: true !default;\n$enable-hover-media-query: false !default; // Deprecated, no longer affects any compiled CSS\n$enable-grid-classes: true !default;\n$enable-pointer-cursor-for-buttons: true !default;\n$enable-print-styles: true !default;\n$enable-responsive-font-sizes: false !default;\n$enable-validation-icons: true !default;\n$enable-deprecation-messages: true !default;\n\n\n// Spacing\n//\n// Control the default styling of most Bootstrap elements by modifying these\n// variables. Mostly focused on spacing.\n// You can add more entries to the $spacers map, should you need more variation.\n\n$spacer: 1rem !default;\n$spacers: () !default;\n$spacers: map-merge(\n (\n 0: 0,\n 1: ($spacer * .25),\n 2: ($spacer * .5),\n 3: $spacer,\n 4: ($spacer * 1.5),\n 5: ($spacer * 3)\n ),\n $spacers\n);\n\n// This variable affects the `.h-*` and `.w-*` classes.\n$sizes: () !default;\n$sizes: map-merge(\n (\n 25: 25%,\n 50: 50%,\n 75: 75%,\n 100: 100%,\n auto: auto\n ),\n $sizes\n);\n\n\n// Body\n//\n// Settings for the `` element.\n\n$body-bg: $white !default;\n$body-color: $gray-900 !default;\n\n\n// Links\n//\n// Style anchor elements.\n\n$link-color: theme-color(\"primary\") !default;\n$link-decoration: none !default;\n$link-hover-color: darken($link-color, 15%) !default;\n$link-hover-decoration: underline !default;\n// Darken percentage for links with `.text-*` class (e.g. `.text-success`)\n$emphasized-link-hover-darken-percentage: 15% !default;\n\n// Paragraphs\n//\n// Style p element.\n\n$paragraph-margin-bottom: 1rem !default;\n\n\n// Grid breakpoints\n//\n// Define the minimum dimensions at which your layout will change,\n// adapting to different screen sizes, for use in media queries.\n\n$grid-breakpoints: (\n xs: 0,\n sm: 576px,\n md: 768px,\n lg: 992px,\n xl: 1200px\n) !default;\n\n@include _assert-ascending($grid-breakpoints, \"$grid-breakpoints\");\n@include _assert-starts-at-zero($grid-breakpoints, \"$grid-breakpoints\");\n\n\n// Grid containers\n//\n// Define the maximum width of `.container` for different screen sizes.\n\n$container-max-widths: (\n sm: 540px,\n md: 720px,\n lg: 960px,\n xl: 1140px\n) !default;\n\n@include _assert-ascending($container-max-widths, \"$container-max-widths\");\n\n\n// Grid columns\n//\n// Set the number of columns and specify the width of the gutters.\n\n$grid-columns: 12 !default;\n$grid-gutter-width: 30px !default;\n$grid-row-columns: 6 !default;\n\n\n// Components\n//\n// Define common padding and border radius sizes and more.\n\n$line-height-lg: 1.5 !default;\n$line-height-sm: 1.5 !default;\n\n$border-width: 1px !default;\n$border-color: $gray-300 !default;\n\n$border-radius: .25rem !default;\n$border-radius-lg: .3rem !default;\n$border-radius-sm: .2rem !default;\n\n$rounded-pill: 50rem !default;\n\n$box-shadow-sm: 0 .125rem .25rem rgba($black, .075) !default;\n$box-shadow: 0 .5rem 1rem rgba($black, .15) !default;\n$box-shadow-lg: 0 1rem 3rem rgba($black, .175) !default;\n\n$component-active-color: $white !default;\n$component-active-bg: theme-color(\"primary\") !default;\n\n$caret-width: .3em !default;\n$caret-vertical-align: $caret-width * .85 !default;\n$caret-spacing: $caret-width * .85 !default;\n\n$transition-base: all .2s ease-in-out !default;\n$transition-fade: opacity .15s linear !default;\n$transition-collapse: height .35s ease !default;\n\n$embed-responsive-aspect-ratios: () !default;\n$embed-responsive-aspect-ratios: join(\n (\n (21 9),\n (16 9),\n (4 3),\n (1 1),\n ),\n $embed-responsive-aspect-ratios\n);\n\n// Typography\n//\n// Font, line-height, and color for body text, headings, and more.\n\n// stylelint-disable value-keyword-case\n$font-family-sans-serif: -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, \"Helvetica Neue\", Arial, \"Noto Sans\", sans-serif, \"Apple Color Emoji\", \"Segoe UI Emoji\", \"Segoe UI Symbol\", \"Noto Color Emoji\" !default;\n$font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace !default;\n$font-family-base: $font-family-sans-serif !default;\n// stylelint-enable value-keyword-case\n\n$font-size-base: 1rem !default; // Assumes the browser default, typically `16px`\n$font-size-lg: $font-size-base * 1.25 !default;\n$font-size-sm: $font-size-base * .875 !default;\n\n$font-weight-lighter: lighter !default;\n$font-weight-light: 300 !default;\n$font-weight-normal: 400 !default;\n$font-weight-bold: 700 !default;\n$font-weight-bolder: bolder !default;\n\n$font-weight-base: $font-weight-normal !default;\n$line-height-base: 1.5 !default;\n\n$h1-font-size: $font-size-base * 2.5 !default;\n$h2-font-size: $font-size-base * 2 !default;\n$h3-font-size: $font-size-base * 1.75 !default;\n$h4-font-size: $font-size-base * 1.5 !default;\n$h5-font-size: $font-size-base * 1.25 !default;\n$h6-font-size: $font-size-base !default;\n\n$headings-margin-bottom: $spacer / 2 !default;\n$headings-font-family: null !default;\n$headings-font-weight: 500 !default;\n$headings-line-height: 1.2 !default;\n$headings-color: null !default;\n\n$display1-size: 6rem !default;\n$display2-size: 5.5rem !default;\n$display3-size: 4.5rem !default;\n$display4-size: 3.5rem !default;\n\n$display1-weight: 300 !default;\n$display2-weight: 300 !default;\n$display3-weight: 300 !default;\n$display4-weight: 300 !default;\n$display-line-height: $headings-line-height !default;\n\n$lead-font-size: $font-size-base * 1.25 !default;\n$lead-font-weight: 300 !default;\n\n$small-font-size: 80% !default;\n\n$text-muted: $gray-600 !default;\n\n$blockquote-small-color: $gray-600 !default;\n$blockquote-small-font-size: $small-font-size !default;\n$blockquote-font-size: $font-size-base * 1.25 !default;\n\n$hr-border-color: rgba($black, .1) !default;\n$hr-border-width: $border-width !default;\n\n$mark-padding: .2em !default;\n\n$dt-font-weight: $font-weight-bold !default;\n\n$kbd-box-shadow: inset 0 -.1rem 0 rgba($black, .25) !default;\n$nested-kbd-font-weight: $font-weight-bold !default;\n\n$list-inline-padding: .5rem !default;\n\n$mark-bg: #fcf8e3 !default;\n\n$hr-margin-y: $spacer !default;\n\n\n// Tables\n//\n// Customizes the `.table` component with basic values, each used across all table variations.\n\n$table-cell-padding: .75rem !default;\n$table-cell-padding-sm: .3rem !default;\n\n$table-color: $body-color !default;\n$table-bg: null !default;\n$table-accent-bg: rgba($black, .05) !default;\n$table-hover-color: $table-color !default;\n$table-hover-bg: rgba($black, .075) !default;\n$table-active-bg: $table-hover-bg !default;\n\n$table-border-width: $border-width !default;\n$table-border-color: $border-color !default;\n\n$table-head-bg: $gray-200 !default;\n$table-head-color: $gray-700 !default;\n$table-th-font-weight: null !default;\n\n$table-dark-color: $white !default;\n$table-dark-bg: $gray-800 !default;\n$table-dark-accent-bg: rgba($white, .05) !default;\n$table-dark-hover-color: $table-dark-color !default;\n$table-dark-hover-bg: rgba($white, .075) !default;\n$table-dark-border-color: lighten($table-dark-bg, 7.5%) !default;\n\n$table-striped-order: odd !default;\n\n$table-caption-color: $text-muted !default;\n\n$table-bg-level: -9 !default;\n$table-border-level: -6 !default;\n\n\n// Buttons + Forms\n//\n// Shared variables that are reassigned to `$input-` and `$btn-` specific variables.\n\n$input-btn-padding-y: .375rem !default;\n$input-btn-padding-x: .75rem !default;\n$input-btn-font-family: null !default;\n$input-btn-font-size: $font-size-base !default;\n$input-btn-line-height: $line-height-base !default;\n\n$input-btn-focus-width: .2rem !default;\n$input-btn-focus-color: rgba($component-active-bg, .25) !default;\n$input-btn-focus-box-shadow: 0 0 0 $input-btn-focus-width $input-btn-focus-color !default;\n\n$input-btn-padding-y-sm: .25rem !default;\n$input-btn-padding-x-sm: .5rem !default;\n$input-btn-font-size-sm: $font-size-sm !default;\n$input-btn-line-height-sm: $line-height-sm !default;\n\n$input-btn-padding-y-lg: .5rem !default;\n$input-btn-padding-x-lg: 1rem !default;\n$input-btn-font-size-lg: $font-size-lg !default;\n$input-btn-line-height-lg: $line-height-lg !default;\n\n$input-btn-border-width: $border-width !default;\n\n\n// Buttons\n//\n// For each of Bootstrap's buttons, define text, background, and border color.\n\n$btn-padding-y: $input-btn-padding-y !default;\n$btn-padding-x: $input-btn-padding-x !default;\n$btn-font-family: $input-btn-font-family !default;\n$btn-font-size: $input-btn-font-size !default;\n$btn-line-height: $input-btn-line-height !default;\n$btn-white-space: null !default; // Set to `nowrap` to prevent text wrapping\n\n$btn-padding-y-sm: $input-btn-padding-y-sm !default;\n$btn-padding-x-sm: $input-btn-padding-x-sm !default;\n$btn-font-size-sm: $input-btn-font-size-sm !default;\n$btn-line-height-sm: $input-btn-line-height-sm !default;\n\n$btn-padding-y-lg: $input-btn-padding-y-lg !default;\n$btn-padding-x-lg: $input-btn-padding-x-lg !default;\n$btn-font-size-lg: $input-btn-font-size-lg !default;\n$btn-line-height-lg: $input-btn-line-height-lg !default;\n\n$btn-border-width: $input-btn-border-width !default;\n\n$btn-font-weight: $font-weight-normal !default;\n$btn-box-shadow: inset 0 1px 0 rgba($white, .15), 0 1px 1px rgba($black, .075) !default;\n$btn-focus-width: $input-btn-focus-width !default;\n$btn-focus-box-shadow: $input-btn-focus-box-shadow !default;\n$btn-disabled-opacity: .65 !default;\n$btn-active-box-shadow: inset 0 3px 5px rgba($black, .125) !default;\n\n$btn-link-disabled-color: $gray-600 !default;\n\n$btn-block-spacing-y: .5rem !default;\n\n// Allows for customizing button radius independently from global border radius\n$btn-border-radius: $border-radius !default;\n$btn-border-radius-lg: $border-radius-lg !default;\n$btn-border-radius-sm: $border-radius-sm !default;\n\n$btn-transition: color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out !default;\n\n\n// Forms\n\n$label-margin-bottom: .5rem !default;\n\n$input-padding-y: $input-btn-padding-y !default;\n$input-padding-x: $input-btn-padding-x !default;\n$input-font-family: $input-btn-font-family !default;\n$input-font-size: $input-btn-font-size !default;\n$input-font-weight: $font-weight-base !default;\n$input-line-height: $input-btn-line-height !default;\n\n$input-padding-y-sm: $input-btn-padding-y-sm !default;\n$input-padding-x-sm: $input-btn-padding-x-sm !default;\n$input-font-size-sm: $input-btn-font-size-sm !default;\n$input-line-height-sm: $input-btn-line-height-sm !default;\n\n$input-padding-y-lg: $input-btn-padding-y-lg !default;\n$input-padding-x-lg: $input-btn-padding-x-lg !default;\n$input-font-size-lg: $input-btn-font-size-lg !default;\n$input-line-height-lg: $input-btn-line-height-lg !default;\n\n$input-bg: $white !default;\n$input-disabled-bg: $gray-200 !default;\n\n$input-color: $gray-700 !default;\n$input-border-color: $gray-400 !default;\n$input-border-width: $input-btn-border-width !default;\n$input-box-shadow: inset 0 1px 1px rgba($black, .075) !default;\n\n$input-border-radius: $border-radius !default;\n$input-border-radius-lg: $border-radius-lg !default;\n$input-border-radius-sm: $border-radius-sm !default;\n\n$input-focus-bg: $input-bg !default;\n$input-focus-border-color: lighten($component-active-bg, 25%) !default;\n$input-focus-color: $input-color !default;\n$input-focus-width: $input-btn-focus-width !default;\n$input-focus-box-shadow: $input-btn-focus-box-shadow !default;\n\n$input-placeholder-color: $gray-600 !default;\n$input-plaintext-color: $body-color !default;\n\n$input-height-border: $input-border-width * 2 !default;\n\n$input-height-inner: add($input-line-height * 1em, $input-padding-y * 2) !default;\n$input-height-inner-half: add($input-line-height * .5em, $input-padding-y) !default;\n$input-height-inner-quarter: add($input-line-height * .25em, $input-padding-y / 2) !default;\n\n$input-height: add($input-line-height * 1em, add($input-padding-y * 2, $input-height-border, false)) !default;\n$input-height-sm: add($input-line-height-sm * 1em, add($input-padding-y-sm * 2, $input-height-border, false)) !default;\n$input-height-lg: add($input-line-height-lg * 1em, add($input-padding-y-lg * 2, $input-height-border, false)) !default;\n\n$input-transition: border-color .15s ease-in-out, box-shadow .15s ease-in-out !default;\n\n$form-text-margin-top: .25rem !default;\n\n$form-check-input-gutter: 1.25rem !default;\n$form-check-input-margin-y: .3rem !default;\n$form-check-input-margin-x: .25rem !default;\n\n$form-check-inline-margin-x: .75rem !default;\n$form-check-inline-input-margin-x: .3125rem !default;\n\n$form-grid-gutter-width: 10px !default;\n$form-group-margin-bottom: 1rem !default;\n\n$input-group-addon-color: $input-color !default;\n$input-group-addon-bg: $gray-200 !default;\n$input-group-addon-border-color: $input-border-color !default;\n\n$custom-forms-transition: background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out !default;\n\n$custom-control-gutter: .5rem !default;\n$custom-control-spacer-x: 1rem !default;\n$custom-control-cursor: null !default;\n\n$custom-control-indicator-size: 1rem !default;\n$custom-control-indicator-bg: $input-bg !default;\n\n$custom-control-indicator-bg-size: 50% 50% !default;\n$custom-control-indicator-box-shadow: $input-box-shadow !default;\n$custom-control-indicator-border-color: $gray-500 !default;\n$custom-control-indicator-border-width: $input-border-width !default;\n\n$custom-control-label-color: null !default;\n\n$custom-control-indicator-disabled-bg: $input-disabled-bg !default;\n$custom-control-label-disabled-color: $gray-600 !default;\n\n$custom-control-indicator-checked-color: $component-active-color !default;\n$custom-control-indicator-checked-bg: $component-active-bg !default;\n$custom-control-indicator-checked-disabled-bg: rgba(theme-color(\"primary\"), .5) !default;\n$custom-control-indicator-checked-box-shadow: null !default;\n$custom-control-indicator-checked-border-color: $custom-control-indicator-checked-bg !default;\n\n$custom-control-indicator-focus-box-shadow: $input-focus-box-shadow !default;\n$custom-control-indicator-focus-border-color: $input-focus-border-color !default;\n\n$custom-control-indicator-active-color: $component-active-color !default;\n$custom-control-indicator-active-bg: lighten($component-active-bg, 35%) !default;\n$custom-control-indicator-active-box-shadow: null !default;\n$custom-control-indicator-active-border-color: $custom-control-indicator-active-bg !default;\n\n$custom-checkbox-indicator-border-radius: $border-radius !default;\n$custom-checkbox-indicator-icon-checked: url(\"data:image/svg+xml,\") !default;\n\n$custom-checkbox-indicator-indeterminate-bg: $component-active-bg !default;\n$custom-checkbox-indicator-indeterminate-color: $custom-control-indicator-checked-color !default;\n$custom-checkbox-indicator-icon-indeterminate: url(\"data:image/svg+xml,\") !default;\n$custom-checkbox-indicator-indeterminate-box-shadow: null !default;\n$custom-checkbox-indicator-indeterminate-border-color: $custom-checkbox-indicator-indeterminate-bg !default;\n\n$custom-radio-indicator-border-radius: 50% !default;\n$custom-radio-indicator-icon-checked: url(\"data:image/svg+xml,\") !default;\n\n$custom-switch-width: $custom-control-indicator-size * 1.75 !default;\n$custom-switch-indicator-border-radius: $custom-control-indicator-size / 2 !default;\n$custom-switch-indicator-size: subtract($custom-control-indicator-size, $custom-control-indicator-border-width * 4) !default;\n\n$custom-select-padding-y: $input-padding-y !default;\n$custom-select-padding-x: $input-padding-x !default;\n$custom-select-font-family: $input-font-family !default;\n$custom-select-font-size: $input-font-size !default;\n$custom-select-height: $input-height !default;\n$custom-select-indicator-padding: 1rem !default; // Extra padding to account for the presence of the background-image based indicator\n$custom-select-font-weight: $input-font-weight !default;\n$custom-select-line-height: $input-line-height !default;\n$custom-select-color: $input-color !default;\n$custom-select-disabled-color: $gray-600 !default;\n$custom-select-bg: $input-bg !default;\n$custom-select-disabled-bg: $gray-200 !default;\n$custom-select-bg-size: 8px 10px !default; // In pixels because image dimensions\n$custom-select-indicator-color: $gray-800 !default;\n$custom-select-indicator: url(\"data:image/svg+xml,\") !default;\n$custom-select-background: escape-svg($custom-select-indicator) no-repeat right $custom-select-padding-x center / $custom-select-bg-size !default; // Used so we can have multiple background elements (e.g., arrow and feedback icon)\n\n$custom-select-feedback-icon-padding-right: add(1em * .75, (2 * $custom-select-padding-y * .75) + $custom-select-padding-x + $custom-select-indicator-padding) !default;\n$custom-select-feedback-icon-position: center right ($custom-select-padding-x + $custom-select-indicator-padding) !default;\n$custom-select-feedback-icon-size: $input-height-inner-half $input-height-inner-half !default;\n\n$custom-select-border-width: $input-border-width !default;\n$custom-select-border-color: $input-border-color !default;\n$custom-select-border-radius: $border-radius !default;\n$custom-select-box-shadow: inset 0 1px 2px rgba($black, .075) !default;\n\n$custom-select-focus-border-color: $input-focus-border-color !default;\n$custom-select-focus-width: $input-focus-width !default;\n$custom-select-focus-box-shadow: 0 0 0 $custom-select-focus-width $input-btn-focus-color !default;\n\n$custom-select-padding-y-sm: $input-padding-y-sm !default;\n$custom-select-padding-x-sm: $input-padding-x-sm !default;\n$custom-select-font-size-sm: $input-font-size-sm !default;\n$custom-select-height-sm: $input-height-sm !default;\n\n$custom-select-padding-y-lg: $input-padding-y-lg !default;\n$custom-select-padding-x-lg: $input-padding-x-lg !default;\n$custom-select-font-size-lg: $input-font-size-lg !default;\n$custom-select-height-lg: $input-height-lg !default;\n\n$custom-range-track-width: 100% !default;\n$custom-range-track-height: .5rem !default;\n$custom-range-track-cursor: pointer !default;\n$custom-range-track-bg: $gray-300 !default;\n$custom-range-track-border-radius: 1rem !default;\n$custom-range-track-box-shadow: inset 0 .25rem .25rem rgba($black, .1) !default;\n\n$custom-range-thumb-width: 1rem !default;\n$custom-range-thumb-height: $custom-range-thumb-width !default;\n$custom-range-thumb-bg: $component-active-bg !default;\n$custom-range-thumb-border: 0 !default;\n$custom-range-thumb-border-radius: 1rem !default;\n$custom-range-thumb-box-shadow: 0 .1rem .25rem rgba($black, .1) !default;\n$custom-range-thumb-focus-box-shadow: 0 0 0 1px $body-bg, $input-focus-box-shadow !default;\n$custom-range-thumb-focus-box-shadow-width: $input-focus-width !default; // For focus box shadow issue in IE/Edge\n$custom-range-thumb-active-bg: lighten($component-active-bg, 35%) !default;\n$custom-range-thumb-disabled-bg: $gray-500 !default;\n\n$custom-file-height: $input-height !default;\n$custom-file-height-inner: $input-height-inner !default;\n$custom-file-focus-border-color: $input-focus-border-color !default;\n$custom-file-focus-box-shadow: $input-focus-box-shadow !default;\n$custom-file-disabled-bg: $input-disabled-bg !default;\n\n$custom-file-padding-y: $input-padding-y !default;\n$custom-file-padding-x: $input-padding-x !default;\n$custom-file-line-height: $input-line-height !default;\n$custom-file-font-family: $input-font-family !default;\n$custom-file-font-weight: $input-font-weight !default;\n$custom-file-color: $input-color !default;\n$custom-file-bg: $input-bg !default;\n$custom-file-border-width: $input-border-width !default;\n$custom-file-border-color: $input-border-color !default;\n$custom-file-border-radius: $input-border-radius !default;\n$custom-file-box-shadow: $input-box-shadow !default;\n$custom-file-button-color: $custom-file-color !default;\n$custom-file-button-bg: $input-group-addon-bg !default;\n$custom-file-text: (\n en: \"Browse\"\n) !default;\n\n\n// Form validation\n\n$form-feedback-margin-top: $form-text-margin-top !default;\n$form-feedback-font-size: $small-font-size !default;\n$form-feedback-valid-color: theme-color(\"success\") !default;\n$form-feedback-invalid-color: theme-color(\"danger\") !default;\n\n$form-feedback-icon-valid-color: $form-feedback-valid-color !default;\n$form-feedback-icon-valid: url(\"data:image/svg+xml,\") !default;\n$form-feedback-icon-invalid-color: $form-feedback-invalid-color !default;\n$form-feedback-icon-invalid: url(\"data:image/svg+xml,\") !default;\n\n$form-validation-states: () !default;\n$form-validation-states: map-merge(\n (\n \"valid\": (\n \"color\": $form-feedback-valid-color,\n \"icon\": $form-feedback-icon-valid\n ),\n \"invalid\": (\n \"color\": $form-feedback-invalid-color,\n \"icon\": $form-feedback-icon-invalid\n ),\n ),\n $form-validation-states\n);\n\n// Z-index master list\n//\n// Warning: Avoid customizing these values. They're used for a bird's eye view\n// of components dependent on the z-axis and are designed to all work together.\n\n$zindex-dropdown: 1000 !default;\n$zindex-sticky: 1020 !default;\n$zindex-fixed: 1030 !default;\n$zindex-modal-backdrop: 1040 !default;\n$zindex-modal: 1050 !default;\n$zindex-popover: 1060 !default;\n$zindex-tooltip: 1070 !default;\n\n\n// Navs\n\n$nav-link-padding-y: .5rem !default;\n$nav-link-padding-x: 1rem !default;\n$nav-link-disabled-color: $gray-600 !default;\n\n$nav-tabs-border-color: $gray-300 !default;\n$nav-tabs-border-width: $border-width !default;\n$nav-tabs-border-radius: $border-radius !default;\n$nav-tabs-link-hover-border-color: $gray-200 $gray-200 $nav-tabs-border-color !default;\n$nav-tabs-link-active-color: $gray-700 !default;\n$nav-tabs-link-active-bg: $body-bg !default;\n$nav-tabs-link-active-border-color: $gray-300 $gray-300 $nav-tabs-link-active-bg !default;\n\n$nav-pills-border-radius: $border-radius !default;\n$nav-pills-link-active-color: $component-active-color !default;\n$nav-pills-link-active-bg: $component-active-bg !default;\n\n$nav-divider-color: $gray-200 !default;\n$nav-divider-margin-y: $spacer / 2 !default;\n\n\n// Navbar\n\n$navbar-padding-y: $spacer / 2 !default;\n$navbar-padding-x: $spacer !default;\n\n$navbar-nav-link-padding-x: .5rem !default;\n\n$navbar-brand-font-size: $font-size-lg !default;\n// Compute the navbar-brand padding-y so the navbar-brand will have the same height as navbar-text and nav-link\n$nav-link-height: $font-size-base * $line-height-base + $nav-link-padding-y * 2 !default;\n$navbar-brand-height: $navbar-brand-font-size * $line-height-base !default;\n$navbar-brand-padding-y: ($nav-link-height - $navbar-brand-height) / 2 !default;\n\n$navbar-toggler-padding-y: .25rem !default;\n$navbar-toggler-padding-x: .75rem !default;\n$navbar-toggler-font-size: $font-size-lg !default;\n$navbar-toggler-border-radius: $btn-border-radius !default;\n\n$navbar-dark-color: rgba($white, .5) !default;\n$navbar-dark-hover-color: rgba($white, .75) !default;\n$navbar-dark-active-color: $white !default;\n$navbar-dark-disabled-color: rgba($white, .25) !default;\n$navbar-dark-toggler-icon-bg: url(\"data:image/svg+xml,\") !default;\n$navbar-dark-toggler-border-color: rgba($white, .1) !default;\n\n$navbar-light-color: rgba($black, .5) !default;\n$navbar-light-hover-color: rgba($black, .7) !default;\n$navbar-light-active-color: rgba($black, .9) !default;\n$navbar-light-disabled-color: rgba($black, .3) !default;\n$navbar-light-toggler-icon-bg: url(\"data:image/svg+xml,\") !default;\n$navbar-light-toggler-border-color: rgba($black, .1) !default;\n\n$navbar-light-brand-color: $navbar-light-active-color !default;\n$navbar-light-brand-hover-color: $navbar-light-active-color !default;\n$navbar-dark-brand-color: $navbar-dark-active-color !default;\n$navbar-dark-brand-hover-color: $navbar-dark-active-color !default;\n\n\n// Dropdowns\n//\n// Dropdown menu container and contents.\n\n$dropdown-min-width: 10rem !default;\n$dropdown-padding-x: 0 !default;\n$dropdown-padding-y: .5rem !default;\n$dropdown-spacer: .125rem !default;\n$dropdown-font-size: $font-size-base !default;\n$dropdown-color: $body-color !default;\n$dropdown-bg: $white !default;\n$dropdown-border-color: rgba($black, .15) !default;\n$dropdown-border-radius: $border-radius !default;\n$dropdown-border-width: $border-width !default;\n$dropdown-inner-border-radius: subtract($dropdown-border-radius, $dropdown-border-width) !default;\n$dropdown-divider-bg: $gray-200 !default;\n$dropdown-divider-margin-y: $nav-divider-margin-y !default;\n$dropdown-box-shadow: 0 .5rem 1rem rgba($black, .175) !default;\n\n$dropdown-link-color: $gray-900 !default;\n$dropdown-link-hover-color: darken($gray-900, 5%) !default;\n$dropdown-link-hover-bg: $gray-100 !default;\n\n$dropdown-link-active-color: $component-active-color !default;\n$dropdown-link-active-bg: $component-active-bg !default;\n\n$dropdown-link-disabled-color: $gray-600 !default;\n\n$dropdown-item-padding-y: .25rem !default;\n$dropdown-item-padding-x: 1.5rem !default;\n\n$dropdown-header-color: $gray-600 !default;\n$dropdown-header-padding: $dropdown-padding-y $dropdown-item-padding-x !default;\n\n\n// Pagination\n\n$pagination-padding-y: .5rem !default;\n$pagination-padding-x: .75rem !default;\n$pagination-padding-y-sm: .25rem !default;\n$pagination-padding-x-sm: .5rem !default;\n$pagination-padding-y-lg: .75rem !default;\n$pagination-padding-x-lg: 1.5rem !default;\n$pagination-line-height: 1.25 !default;\n\n$pagination-color: $link-color !default;\n$pagination-bg: $white !default;\n$pagination-border-width: $border-width !default;\n$pagination-border-color: $gray-300 !default;\n\n$pagination-focus-box-shadow: $input-btn-focus-box-shadow !default;\n$pagination-focus-outline: 0 !default;\n\n$pagination-hover-color: $link-hover-color !default;\n$pagination-hover-bg: $gray-200 !default;\n$pagination-hover-border-color: $gray-300 !default;\n\n$pagination-active-color: $component-active-color !default;\n$pagination-active-bg: $component-active-bg !default;\n$pagination-active-border-color: $pagination-active-bg !default;\n\n$pagination-disabled-color: $gray-600 !default;\n$pagination-disabled-bg: $white !default;\n$pagination-disabled-border-color: $gray-300 !default;\n\n\n// Jumbotron\n\n$jumbotron-padding: 2rem !default;\n$jumbotron-color: null !default;\n$jumbotron-bg: $gray-200 !default;\n\n\n// Cards\n\n$card-spacer-y: .75rem !default;\n$card-spacer-x: 1.25rem !default;\n$card-border-width: $border-width !default;\n$card-border-radius: $border-radius !default;\n$card-border-color: rgba($black, .125) !default;\n$card-inner-border-radius: subtract($card-border-radius, $card-border-width) !default;\n$card-cap-bg: rgba($black, .03) !default;\n$card-cap-color: null !default;\n$card-height: null !default;\n$card-color: null !default;\n$card-bg: $white !default;\n\n$card-img-overlay-padding: 1.25rem !default;\n\n$card-group-margin: $grid-gutter-width / 2 !default;\n$card-deck-margin: $card-group-margin !default;\n\n$card-columns-count: 3 !default;\n$card-columns-gap: 1.25rem !default;\n$card-columns-margin: $card-spacer-y !default;\n\n\n// Tooltips\n\n$tooltip-font-size: $font-size-sm !default;\n$tooltip-max-width: 200px !default;\n$tooltip-color: $white !default;\n$tooltip-bg: $black !default;\n$tooltip-border-radius: $border-radius !default;\n$tooltip-opacity: .9 !default;\n$tooltip-padding-y: .25rem !default;\n$tooltip-padding-x: .5rem !default;\n$tooltip-margin: 0 !default;\n\n$tooltip-arrow-width: .8rem !default;\n$tooltip-arrow-height: .4rem !default;\n$tooltip-arrow-color: $tooltip-bg !default;\n\n// Form tooltips must come after regular tooltips\n$form-feedback-tooltip-padding-y: $tooltip-padding-y !default;\n$form-feedback-tooltip-padding-x: $tooltip-padding-x !default;\n$form-feedback-tooltip-font-size: $tooltip-font-size !default;\n$form-feedback-tooltip-line-height: $line-height-base !default;\n$form-feedback-tooltip-opacity: $tooltip-opacity !default;\n$form-feedback-tooltip-border-radius: $tooltip-border-radius !default;\n\n\n// Popovers\n\n$popover-font-size: $font-size-sm !default;\n$popover-bg: $white !default;\n$popover-max-width: 276px !default;\n$popover-border-width: $border-width !default;\n$popover-border-color: rgba($black, .2) !default;\n$popover-border-radius: $border-radius-lg !default;\n$popover-inner-border-radius: subtract($popover-border-radius, $popover-border-width) !default;\n$popover-box-shadow: 0 .25rem .5rem rgba($black, .2) !default;\n\n$popover-header-bg: darken($popover-bg, 3%) !default;\n$popover-header-color: $headings-color !default;\n$popover-header-padding-y: .5rem !default;\n$popover-header-padding-x: .75rem !default;\n\n$popover-body-color: $body-color !default;\n$popover-body-padding-y: $popover-header-padding-y !default;\n$popover-body-padding-x: $popover-header-padding-x !default;\n\n$popover-arrow-width: 1rem !default;\n$popover-arrow-height: .5rem !default;\n$popover-arrow-color: $popover-bg !default;\n\n$popover-arrow-outer-color: fade-in($popover-border-color, .05) !default;\n\n\n// Toasts\n\n$toast-max-width: 350px !default;\n$toast-padding-x: .75rem !default;\n$toast-padding-y: .25rem !default;\n$toast-font-size: .875rem !default;\n$toast-color: null !default;\n$toast-background-color: rgba($white, .85) !default;\n$toast-border-width: 1px !default;\n$toast-border-color: rgba(0, 0, 0, .1) !default;\n$toast-border-radius: .25rem !default;\n$toast-box-shadow: 0 .25rem .75rem rgba($black, .1) !default;\n\n$toast-header-color: $gray-600 !default;\n$toast-header-background-color: rgba($white, .85) !default;\n$toast-header-border-color: rgba(0, 0, 0, .05) !default;\n\n\n// Badges\n\n$badge-font-size: 75% !default;\n$badge-font-weight: $font-weight-bold !default;\n$badge-padding-y: .25em !default;\n$badge-padding-x: .4em !default;\n$badge-border-radius: $border-radius !default;\n\n$badge-transition: $btn-transition !default;\n$badge-focus-width: $input-btn-focus-width !default;\n\n$badge-pill-padding-x: .6em !default;\n// Use a higher than normal value to ensure completely rounded edges when\n// customizing padding or font-size on labels.\n$badge-pill-border-radius: 10rem !default;\n\n\n// Modals\n\n// Padding applied to the modal body\n$modal-inner-padding: 1rem !default;\n\n// Margin between elements in footer, must be lower than or equal to 2 * $modal-inner-padding\n$modal-footer-margin-between: .5rem !default;\n\n$modal-dialog-margin: .5rem !default;\n$modal-dialog-margin-y-sm-up: 1.75rem !default;\n\n$modal-title-line-height: $line-height-base !default;\n\n$modal-content-color: null !default;\n$modal-content-bg: $white !default;\n$modal-content-border-color: rgba($black, .2) !default;\n$modal-content-border-width: $border-width !default;\n$modal-content-border-radius: $border-radius-lg !default;\n$modal-content-inner-border-radius: subtract($modal-content-border-radius, $modal-content-border-width) !default;\n$modal-content-box-shadow-xs: 0 .25rem .5rem rgba($black, .5) !default;\n$modal-content-box-shadow-sm-up: 0 .5rem 1rem rgba($black, .5) !default;\n\n$modal-backdrop-bg: $black !default;\n$modal-backdrop-opacity: .5 !default;\n$modal-header-border-color: $border-color !default;\n$modal-footer-border-color: $modal-header-border-color !default;\n$modal-header-border-width: $modal-content-border-width !default;\n$modal-footer-border-width: $modal-header-border-width !default;\n$modal-header-padding-y: 1rem !default;\n$modal-header-padding-x: 1rem !default;\n$modal-header-padding: $modal-header-padding-y $modal-header-padding-x !default; // Keep this for backwards compatibility\n\n$modal-xl: 1140px !default;\n$modal-lg: 800px !default;\n$modal-md: 500px !default;\n$modal-sm: 300px !default;\n\n$modal-fade-transform: translate(0, -50px) !default;\n$modal-show-transform: none !default;\n$modal-transition: transform .3s ease-out !default;\n$modal-scale-transform: scale(1.02) !default;\n\n\n// Alerts\n//\n// Define alert colors, border radius, and padding.\n\n$alert-padding-y: .75rem !default;\n$alert-padding-x: 1.25rem !default;\n$alert-margin-bottom: 1rem !default;\n$alert-border-radius: $border-radius !default;\n$alert-link-font-weight: $font-weight-bold !default;\n$alert-border-width: $border-width !default;\n\n$alert-bg-level: -10 !default;\n$alert-border-level: -9 !default;\n$alert-color-level: 6 !default;\n\n\n// Progress bars\n\n$progress-height: 1rem !default;\n$progress-font-size: $font-size-base * .75 !default;\n$progress-bg: $gray-200 !default;\n$progress-border-radius: $border-radius !default;\n$progress-box-shadow: inset 0 .1rem .1rem rgba($black, .1) !default;\n$progress-bar-color: $white !default;\n$progress-bar-bg: theme-color(\"primary\") !default;\n$progress-bar-animation-timing: 1s linear infinite !default;\n$progress-bar-transition: width .6s ease !default;\n\n\n// List group\n\n$list-group-color: null !default;\n$list-group-bg: $white !default;\n$list-group-border-color: rgba($black, .125) !default;\n$list-group-border-width: $border-width !default;\n$list-group-border-radius: $border-radius !default;\n\n$list-group-item-padding-y: .75rem !default;\n$list-group-item-padding-x: 1.25rem !default;\n\n$list-group-hover-bg: $gray-100 !default;\n$list-group-active-color: $component-active-color !default;\n$list-group-active-bg: $component-active-bg !default;\n$list-group-active-border-color: $list-group-active-bg !default;\n\n$list-group-disabled-color: $gray-600 !default;\n$list-group-disabled-bg: $list-group-bg !default;\n\n$list-group-action-color: $gray-700 !default;\n$list-group-action-hover-color: $list-group-action-color !default;\n\n$list-group-action-active-color: $body-color !default;\n$list-group-action-active-bg: $gray-200 !default;\n\n\n// Image thumbnails\n\n$thumbnail-padding: .25rem !default;\n$thumbnail-bg: $body-bg !default;\n$thumbnail-border-width: $border-width !default;\n$thumbnail-border-color: $gray-300 !default;\n$thumbnail-border-radius: $border-radius !default;\n$thumbnail-box-shadow: 0 1px 2px rgba($black, .075) !default;\n\n\n// Figures\n\n$figure-caption-font-size: 90% !default;\n$figure-caption-color: $gray-600 !default;\n\n\n// Breadcrumbs\n\n$breadcrumb-font-size: null !default;\n\n$breadcrumb-padding-y: .75rem !default;\n$breadcrumb-padding-x: 1rem !default;\n$breadcrumb-item-padding: .5rem !default;\n\n$breadcrumb-margin-bottom: 1rem !default;\n\n$breadcrumb-bg: $gray-200 !default;\n$breadcrumb-divider-color: $gray-600 !default;\n$breadcrumb-active-color: $gray-600 !default;\n$breadcrumb-divider: quote(\"/\") !default;\n\n$breadcrumb-border-radius: $border-radius !default;\n\n\n// Carousel\n\n$carousel-control-color: $white !default;\n$carousel-control-width: 15% !default;\n$carousel-control-opacity: .5 !default;\n$carousel-control-hover-opacity: .9 !default;\n$carousel-control-transition: opacity .15s ease !default;\n\n$carousel-indicator-width: 30px !default;\n$carousel-indicator-height: 3px !default;\n$carousel-indicator-hit-area-height: 10px !default;\n$carousel-indicator-spacer: 3px !default;\n$carousel-indicator-active-bg: $white !default;\n$carousel-indicator-transition: opacity .6s ease !default;\n\n$carousel-caption-width: 70% !default;\n$carousel-caption-color: $white !default;\n\n$carousel-control-icon-width: 20px !default;\n\n$carousel-control-prev-icon-bg: url(\"data:image/svg+xml,\") !default;\n$carousel-control-next-icon-bg: url(\"data:image/svg+xml,\") !default;\n\n$carousel-transition-duration: .6s !default;\n$carousel-transition: transform $carousel-transition-duration ease-in-out !default; // Define transform transition first if using multiple transitions (e.g., `transform 2s ease, opacity .5s ease-out`)\n\n\n// Spinners\n\n$spinner-width: 2rem !default;\n$spinner-height: $spinner-width !default;\n$spinner-border-width: .25em !default;\n\n$spinner-width-sm: 1rem !default;\n$spinner-height-sm: $spinner-width-sm !default;\n$spinner-border-width-sm: .2em !default;\n\n\n// Close\n\n$close-font-size: $font-size-base * 1.5 !default;\n$close-font-weight: $font-weight-bold !default;\n$close-color: $black !default;\n$close-text-shadow: 0 1px 0 $white !default;\n\n\n// Code\n\n$code-font-size: 87.5% !default;\n$code-color: $pink !default;\n\n$kbd-padding-y: .2rem !default;\n$kbd-padding-x: .4rem !default;\n$kbd-font-size: $code-font-size !default;\n$kbd-color: $white !default;\n$kbd-bg: $gray-900 !default;\n\n$pre-color: $gray-900 !default;\n$pre-scrollable-max-height: 340px !default;\n\n\n// Utilities\n\n$displays: none, inline, inline-block, block, table, table-row, table-cell, flex, inline-flex !default;\n$overflows: auto, hidden !default;\n$positions: static, relative, absolute, fixed, sticky !default;\n$user-selects: all, auto, none !default;\n\n\n// Printing\n\n$print-page-size: a3 !default;\n$print-body-min-width: map-get($grid-breakpoints, \"lg\") !default;\n", + "// Toggles\n//\n// Used in conjunction with global variables to enable certain theme features.\n\n// Vendor\n@import \"vendor/rfs\";\n\n// Deprecate\n@import \"mixins/deprecate\";\n\n// Utilities\n@import \"mixins/breakpoints\";\n@import \"mixins/hover\";\n@import \"mixins/image\";\n@import \"mixins/badge\";\n@import \"mixins/resize\";\n@import \"mixins/screen-reader\";\n@import \"mixins/size\";\n@import \"mixins/reset-text\";\n@import \"mixins/text-emphasis\";\n@import \"mixins/text-hide\";\n@import \"mixins/text-truncate\";\n@import \"mixins/visibility\";\n\n// Components\n@import \"mixins/alert\";\n@import \"mixins/buttons\";\n@import \"mixins/caret\";\n@import \"mixins/pagination\";\n@import \"mixins/lists\";\n@import \"mixins/list-group\";\n@import \"mixins/nav-divider\";\n@import \"mixins/forms\";\n@import \"mixins/table-row\";\n\n// Skins\n@import \"mixins/background-variant\";\n@import \"mixins/border-radius\";\n@import \"mixins/box-shadow\";\n@import \"mixins/gradients\";\n@import \"mixins/transition\";\n\n// Layout\n@import \"mixins/clearfix\";\n@import \"mixins/grid-framework\";\n@import \"mixins/grid\";\n@import \"mixins/float\";\n", + "// stylelint-disable property-blacklist, scss/dollar-variable-default\n\n// SCSS RFS mixin\n//\n// Automated font-resizing\n//\n// See https://github.com/twbs/rfs\n\n// Configuration\n\n// Base font size\n$rfs-base-font-size: 1.25rem !default;\n$rfs-font-size-unit: rem !default;\n\n// Breakpoint at where font-size starts decreasing if screen width is smaller\n$rfs-breakpoint: 1200px !default;\n$rfs-breakpoint-unit: px !default;\n\n// Resize font-size based on screen height and width\n$rfs-two-dimensional: false !default;\n\n// Factor of decrease\n$rfs-factor: 10 !default;\n\n@if type-of($rfs-factor) != \"number\" or $rfs-factor <= 1 {\n @error \"`#{$rfs-factor}` is not a valid $rfs-factor, it must be greater than 1.\";\n}\n\n// Generate enable or disable classes. Possibilities: false, \"enable\" or \"disable\"\n$rfs-class: false !default;\n\n// 1 rem = $rfs-rem-value px\n$rfs-rem-value: 16 !default;\n\n// Safari iframe resize bug: https://github.com/twbs/rfs/issues/14\n$rfs-safari-iframe-resize-bug-fix: false !default;\n\n// Disable RFS by setting $enable-responsive-font-sizes to false\n$enable-responsive-font-sizes: true !default;\n\n// Cache $rfs-base-font-size unit\n$rfs-base-font-size-unit: unit($rfs-base-font-size);\n\n// Remove px-unit from $rfs-base-font-size for calculations\n@if $rfs-base-font-size-unit == \"px\" {\n $rfs-base-font-size: $rfs-base-font-size / ($rfs-base-font-size * 0 + 1);\n}\n@else if $rfs-base-font-size-unit == \"rem\" {\n $rfs-base-font-size: $rfs-base-font-size / ($rfs-base-font-size * 0 + 1 / $rfs-rem-value);\n}\n\n// Cache $rfs-breakpoint unit to prevent multiple calls\n$rfs-breakpoint-unit-cache: unit($rfs-breakpoint);\n\n// Remove unit from $rfs-breakpoint for calculations\n@if $rfs-breakpoint-unit-cache == \"px\" {\n $rfs-breakpoint: $rfs-breakpoint / ($rfs-breakpoint * 0 + 1);\n}\n@else if $rfs-breakpoint-unit-cache == \"rem\" or $rfs-breakpoint-unit-cache == \"em\" {\n $rfs-breakpoint: $rfs-breakpoint / ($rfs-breakpoint * 0 + 1 / $rfs-rem-value);\n}\n\n// Responsive font-size mixin\n@mixin rfs($fs, $important: false) {\n // Cache $fs unit\n $fs-unit: if(type-of($fs) == \"number\", unit($fs), false);\n\n // Add !important suffix if needed\n $rfs-suffix: if($important, \" !important\", \"\");\n\n // If $fs isn't a number (like inherit) or $fs has a unit (not px or rem, like 1.5em) or $ is 0, just print the value\n @if not $fs-unit or $fs-unit != \"\" and $fs-unit != \"px\" and $fs-unit != \"rem\" or $fs == 0 {\n font-size: #{$fs}#{$rfs-suffix};\n }\n @else {\n // Variables for storing static and fluid rescaling\n $rfs-static: null;\n $rfs-fluid: null;\n\n // Remove px-unit from $fs for calculations\n @if $fs-unit == \"px\" {\n $fs: $fs / ($fs * 0 + 1);\n }\n @else if $fs-unit == \"rem\" {\n $fs: $fs / ($fs * 0 + 1 / $rfs-rem-value);\n }\n\n // Set default font-size\n @if $rfs-font-size-unit == rem {\n $rfs-static: #{$fs / $rfs-rem-value}rem#{$rfs-suffix};\n }\n @else if $rfs-font-size-unit == px {\n $rfs-static: #{$fs}px#{$rfs-suffix};\n }\n @else {\n @error \"`#{$rfs-font-size-unit}` is not a valid unit for $rfs-font-size-unit. Use `px` or `rem`.\";\n }\n\n // Only add media query if font-size is bigger as the minimum font-size\n // If $rfs-factor == 1, no rescaling will take place\n @if $fs > $rfs-base-font-size and $enable-responsive-font-sizes {\n $min-width: null;\n $variable-unit: null;\n\n // Calculate minimum font-size for given font-size\n $fs-min: $rfs-base-font-size + ($fs - $rfs-base-font-size) / $rfs-factor;\n\n // Calculate difference between given font-size and minimum font-size for given font-size\n $fs-diff: $fs - $fs-min;\n\n // Base font-size formatting\n // No need to check if the unit is valid, because we did that before\n $min-width: if($rfs-font-size-unit == rem, #{$fs-min / $rfs-rem-value}rem, #{$fs-min}px);\n\n // If two-dimensional, use smallest of screen width and height\n $variable-unit: if($rfs-two-dimensional, vmin, vw);\n\n // Calculate the variable width between 0 and $rfs-breakpoint\n $variable-width: #{$fs-diff * 100 / $rfs-breakpoint}#{$variable-unit};\n\n // Set the calculated font-size.\n $rfs-fluid: calc(#{$min-width} + #{$variable-width}) #{$rfs-suffix};\n }\n\n // Rendering\n @if $rfs-fluid == null {\n // Only render static font-size if no fluid font-size is available\n font-size: $rfs-static;\n }\n @else {\n $mq-value: null;\n\n // RFS breakpoint formatting\n @if $rfs-breakpoint-unit == em or $rfs-breakpoint-unit == rem {\n $mq-value: #{$rfs-breakpoint / $rfs-rem-value}#{$rfs-breakpoint-unit};\n }\n @else if $rfs-breakpoint-unit == px {\n $mq-value: #{$rfs-breakpoint}px;\n }\n @else {\n @error \"`#{$rfs-breakpoint-unit}` is not a valid unit for $rfs-breakpoint-unit. Use `px`, `em` or `rem`.\";\n }\n\n @if $rfs-class == \"disable\" {\n // Adding an extra class increases specificity,\n // which prevents the media query to override the font size\n &,\n .disable-responsive-font-size &,\n &.disable-responsive-font-size {\n font-size: $rfs-static;\n }\n }\n @else {\n font-size: $rfs-static;\n }\n\n @if $rfs-two-dimensional {\n @media (max-width: #{$mq-value}), (max-height: #{$mq-value}) {\n @if $rfs-class == \"enable\" {\n .enable-responsive-font-size &,\n &.enable-responsive-font-size {\n font-size: $rfs-fluid;\n }\n }\n @else {\n font-size: $rfs-fluid;\n }\n\n @if $rfs-safari-iframe-resize-bug-fix {\n // stylelint-disable-next-line length-zero-no-unit\n min-width: 0vw;\n }\n }\n }\n @else {\n @media (max-width: #{$mq-value}) {\n @if $rfs-class == \"enable\" {\n .enable-responsive-font-size &,\n &.enable-responsive-font-size {\n font-size: $rfs-fluid;\n }\n }\n @else {\n font-size: $rfs-fluid;\n }\n\n @if $rfs-safari-iframe-resize-bug-fix {\n // stylelint-disable-next-line length-zero-no-unit\n min-width: 0vw;\n }\n }\n }\n }\n }\n}\n\n// The font-size & responsive-font-size mixin uses RFS to rescale font sizes\n@mixin font-size($fs, $important: false) {\n @include rfs($fs, $important);\n}\n\n@mixin responsive-font-size($fs, $important: false) {\n @include rfs($fs, $important);\n}\n", + "// Deprecate mixin\n//\n// This mixin can be used to deprecate mixins or functions.\n// `$enable-deprecation-messages` is a global variable, `$ignore-warning` is a variable that can be passed to\n// some deprecated mixins to suppress the warning (for example if the mixin is still be used in the current version of Bootstrap)\n@mixin deprecate($name, $deprecate-version, $remove-version, $ignore-warning: false) {\n @if ($enable-deprecation-messages != false and $ignore-warning != true) {\n @warn \"#{$name} has been deprecated as of #{$deprecate-version}. It will be removed entirely in #{$remove-version}.\";\n }\n}\n", + "// Breakpoint viewport sizes and media queries.\n//\n// Breakpoints are defined as a map of (name: minimum width), order from small to large:\n//\n// (xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px)\n//\n// The map defined in the `$grid-breakpoints` global variable is used as the `$breakpoints` argument by default.\n\n// Name of the next breakpoint, or null for the last breakpoint.\n//\n// >> breakpoint-next(sm)\n// md\n// >> breakpoint-next(sm, (xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px))\n// md\n// >> breakpoint-next(sm, $breakpoint-names: (xs sm md lg xl))\n// md\n@function breakpoint-next($name, $breakpoints: $grid-breakpoints, $breakpoint-names: map-keys($breakpoints)) {\n $n: index($breakpoint-names, $name);\n @return if($n != null and $n < length($breakpoint-names), nth($breakpoint-names, $n + 1), null);\n}\n\n// Minimum breakpoint width. Null for the smallest (first) breakpoint.\n//\n// >> breakpoint-min(sm, (xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px))\n// 576px\n@function breakpoint-min($name, $breakpoints: $grid-breakpoints) {\n $min: map-get($breakpoints, $name);\n @return if($min != 0, $min, null);\n}\n\n// Maximum breakpoint width. Null for the largest (last) breakpoint.\n// The maximum value is calculated as the minimum of the next one less 0.02px\n// to work around the limitations of `min-` and `max-` prefixes and viewports with fractional widths.\n// See https://www.w3.org/TR/mediaqueries-4/#mq-min-max\n// Uses 0.02px rather than 0.01px to work around a current rounding bug in Safari.\n// See https://bugs.webkit.org/show_bug.cgi?id=178261\n//\n// >> breakpoint-max(sm, (xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px))\n// 767.98px\n@function breakpoint-max($name, $breakpoints: $grid-breakpoints) {\n $next: breakpoint-next($name, $breakpoints);\n @return if($next, breakpoint-min($next, $breakpoints) - .02, null);\n}\n\n// Returns a blank string if smallest breakpoint, otherwise returns the name with a dash in front.\n// Useful for making responsive utilities.\n//\n// >> breakpoint-infix(xs, (xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px))\n// \"\" (Returns a blank string)\n// >> breakpoint-infix(sm, (xs: 0, sm: 576px, md: 768px, lg: 992px, xl: 1200px))\n// \"-sm\"\n@function breakpoint-infix($name, $breakpoints: $grid-breakpoints) {\n @return if(breakpoint-min($name, $breakpoints) == null, \"\", \"-#{$name}\");\n}\n\n// Media of at least the minimum breakpoint width. No query for the smallest breakpoint.\n// Makes the @content apply to the given breakpoint and wider.\n@mixin media-breakpoint-up($name, $breakpoints: $grid-breakpoints) {\n $min: breakpoint-min($name, $breakpoints);\n @if $min {\n @media (min-width: $min) {\n @content;\n }\n } @else {\n @content;\n }\n}\n\n// Media of at most the maximum breakpoint width. No query for the largest breakpoint.\n// Makes the @content apply to the given breakpoint and narrower.\n@mixin media-breakpoint-down($name, $breakpoints: $grid-breakpoints) {\n $max: breakpoint-max($name, $breakpoints);\n @if $max {\n @media (max-width: $max) {\n @content;\n }\n } @else {\n @content;\n }\n}\n\n// Media that spans multiple breakpoint widths.\n// Makes the @content apply between the min and max breakpoints\n@mixin media-breakpoint-between($lower, $upper, $breakpoints: $grid-breakpoints) {\n $min: breakpoint-min($lower, $breakpoints);\n $max: breakpoint-max($upper, $breakpoints);\n\n @if $min != null and $max != null {\n @media (min-width: $min) and (max-width: $max) {\n @content;\n }\n } @else if $max == null {\n @include media-breakpoint-up($lower, $breakpoints) {\n @content;\n }\n } @else if $min == null {\n @include media-breakpoint-down($upper, $breakpoints) {\n @content;\n }\n }\n}\n\n// Media between the breakpoint's minimum and maximum widths.\n// No minimum for the smallest breakpoint, and no maximum for the largest one.\n// Makes the @content apply only to the given breakpoint, not viewports any wider or narrower.\n@mixin media-breakpoint-only($name, $breakpoints: $grid-breakpoints) {\n $min: breakpoint-min($name, $breakpoints);\n $max: breakpoint-max($name, $breakpoints);\n\n @if $min != null and $max != null {\n @media (min-width: $min) and (max-width: $max) {\n @content;\n }\n } @else if $max == null {\n @include media-breakpoint-up($name, $breakpoints) {\n @content;\n }\n } @else if $min == null {\n @include media-breakpoint-down($name, $breakpoints) {\n @content;\n }\n }\n}\n", + "// Hover mixin and `$enable-hover-media-query` are deprecated.\n//\n// Originally added during our alphas and maintained during betas, this mixin was\n// designed to prevent `:hover` stickiness on iOS-an issue where hover styles\n// would persist after initial touch.\n//\n// For backward compatibility, we've kept these mixins and updated them to\n// always return their regular pseudo-classes instead of a shimmed media query.\n//\n// Issue: https://github.com/twbs/bootstrap/issues/25195\n\n@mixin hover() {\n &:hover { @content; }\n}\n\n@mixin hover-focus() {\n &:hover,\n &:focus {\n @content;\n }\n}\n\n@mixin plain-hover-focus() {\n &,\n &:hover,\n &:focus {\n @content;\n }\n}\n\n@mixin hover-focus-active() {\n &:hover,\n &:focus,\n &:active {\n @content;\n }\n}\n", + "// Image Mixins\n// - Responsive image\n// - Retina image\n\n\n// Responsive image\n//\n// Keep images from scaling beyond the width of their parents.\n\n@mixin img-fluid() {\n // Part 1: Set a maximum relative to the parent\n max-width: 100%;\n // Part 2: Override the height to auto, otherwise images will be stretched\n // when setting a width and height attribute on the img element.\n height: auto;\n}\n\n\n// Retina image\n//\n// Short retina mixin for setting background-image and -size.\n\n@mixin img-retina($file-1x, $file-2x, $width-1x, $height-1x) {\n background-image: url($file-1x);\n\n // Autoprefixer takes care of adding -webkit-min-device-pixel-ratio and -o-min-device-pixel-ratio,\n // but doesn't convert dppx=>dpi.\n // There's no such thing as unprefixed min-device-pixel-ratio since it's nonstandard.\n // Compatibility info: https://caniuse.com/#feat=css-media-resolution\n @media only screen and (min-resolution: 192dpi), // IE9-11 don't support dppx\n only screen and (min-resolution: 2dppx) { // Standardized\n background-image: url($file-2x);\n background-size: $width-1x $height-1x;\n }\n @include deprecate(\"`img-retina()`\", \"v4.3.0\", \"v5\");\n}\n", + "@mixin badge-variant($bg) {\n color: color-yiq($bg);\n background-color: $bg;\n\n @at-root a#{&} {\n @include hover-focus() {\n color: color-yiq($bg);\n background-color: darken($bg, 10%);\n }\n\n &:focus,\n &.focus {\n outline: 0;\n box-shadow: 0 0 0 $badge-focus-width rgba($bg, .5);\n }\n }\n}\n", + "// Resize anything\n\n@mixin resizable($direction) {\n overflow: auto; // Per CSS3 UI, `resize` only applies when `overflow` isn't `visible`\n resize: $direction; // Options: horizontal, vertical, both\n}\n", + "// Only display content to screen readers\n//\n// See: https://www.a11yproject.com/posts/2013-01-11-how-to-hide-content/\n// See: https://hugogiraudel.com/2016/10/13/css-hide-and-seek/\n\n@mixin sr-only() {\n position: absolute;\n width: 1px;\n height: 1px;\n padding: 0;\n margin: -1px; // Fix for https://github.com/twbs/bootstrap/issues/25686\n overflow: hidden;\n clip: rect(0, 0, 0, 0);\n white-space: nowrap;\n border: 0;\n}\n\n// Use in conjunction with .sr-only to only display content when it's focused.\n//\n// Useful for \"Skip to main content\" links; see https://www.w3.org/TR/2013/NOTE-WCAG20-TECHS-20130905/G1\n//\n// Credit: HTML5 Boilerplate\n\n@mixin sr-only-focusable() {\n &:active,\n &:focus {\n position: static;\n width: auto;\n height: auto;\n overflow: visible;\n clip: auto;\n white-space: normal;\n }\n}\n", + "// Sizing shortcuts\n\n@mixin size($width, $height: $width) {\n width: $width;\n height: $height;\n @include deprecate(\"`size()`\", \"v4.3.0\", \"v5\");\n}\n", + "@mixin reset-text() {\n font-family: $font-family-base;\n // We deliberately do NOT reset font-size or word-wrap.\n font-style: normal;\n font-weight: $font-weight-normal;\n line-height: $line-height-base;\n text-align: left; // Fallback for where `start` is not supported\n text-align: start;\n text-decoration: none;\n text-shadow: none;\n text-transform: none;\n letter-spacing: normal;\n word-break: normal;\n word-spacing: normal;\n white-space: normal;\n line-break: auto;\n}\n", + "// stylelint-disable declaration-no-important\n\n// Typography\n\n@mixin text-emphasis-variant($parent, $color, $ignore-warning: false) {\n #{$parent} {\n color: $color !important;\n }\n @if $emphasized-link-hover-darken-percentage != 0 {\n a#{$parent} {\n @include hover-focus() {\n color: darken($color, $emphasized-link-hover-darken-percentage) !important;\n }\n }\n }\n @include deprecate(\"`text-emphasis-variant()`\", \"v4.4.0\", \"v5\", $ignore-warning);\n}\n", + "// CSS image replacement\n@mixin text-hide($ignore-warning: false) {\n // stylelint-disable-next-line font-family-no-missing-generic-family-keyword\n font: 0/0 a;\n color: transparent;\n text-shadow: none;\n background-color: transparent;\n border: 0;\n\n @include deprecate(\"`text-hide()`\", \"v4.1.0\", \"v5\", $ignore-warning);\n}\n", + "// Text truncate\n// Requires inline-block or block for proper styling\n\n@mixin text-truncate() {\n overflow: hidden;\n text-overflow: ellipsis;\n white-space: nowrap;\n}\n", + "// stylelint-disable declaration-no-important\n\n// Visibility\n\n@mixin invisible($visibility) {\n visibility: $visibility !important;\n @include deprecate(\"`invisible()`\", \"v4.3.0\", \"v5\");\n}\n", + "@mixin alert-variant($background, $border, $color) {\n color: $color;\n @include gradient-bg($background);\n border-color: $border;\n\n hr {\n border-top-color: darken($border, 5%);\n }\n\n .alert-link {\n color: darken($color, 10%);\n }\n}\n", + "// Button variants\n//\n// Easily pump out default styles, as well as :hover, :focus, :active,\n// and disabled options for all buttons\n\n@mixin button-variant($background, $border, $hover-background: darken($background, 7.5%), $hover-border: darken($border, 10%), $active-background: darken($background, 10%), $active-border: darken($border, 12.5%)) {\n color: color-yiq($background);\n @include gradient-bg($background);\n border-color: $border;\n @include box-shadow($btn-box-shadow);\n\n @include hover() {\n color: color-yiq($hover-background);\n @include gradient-bg($hover-background);\n border-color: $hover-border;\n }\n\n &:focus,\n &.focus {\n color: color-yiq($hover-background);\n @include gradient-bg($hover-background);\n border-color: $hover-border;\n @if $enable-shadows {\n @include box-shadow($btn-box-shadow, 0 0 0 $btn-focus-width rgba(mix(color-yiq($background), $border, 15%), .5));\n } @else {\n // Avoid using mixin so we can pass custom focus shadow properly\n box-shadow: 0 0 0 $btn-focus-width rgba(mix(color-yiq($background), $border, 15%), .5);\n }\n }\n\n // Disabled comes first so active can properly restyle\n &.disabled,\n &:disabled {\n color: color-yiq($background);\n background-color: $background;\n border-color: $border;\n // Remove CSS gradients if they're enabled\n @if $enable-gradients {\n background-image: none;\n }\n }\n\n &:not(:disabled):not(.disabled):active,\n &:not(:disabled):not(.disabled).active,\n .show > &.dropdown-toggle {\n color: color-yiq($active-background);\n background-color: $active-background;\n @if $enable-gradients {\n background-image: none; // Remove the gradient for the pressed/active state\n }\n border-color: $active-border;\n\n &:focus {\n @if $enable-shadows and $btn-active-box-shadow != none {\n @include box-shadow($btn-active-box-shadow, 0 0 0 $btn-focus-width rgba(mix(color-yiq($background), $border, 15%), .5));\n } @else {\n // Avoid using mixin so we can pass custom focus shadow properly\n box-shadow: 0 0 0 $btn-focus-width rgba(mix(color-yiq($background), $border, 15%), .5);\n }\n }\n }\n}\n\n@mixin button-outline-variant($color, $color-hover: color-yiq($color), $active-background: $color, $active-border: $color) {\n color: $color;\n border-color: $color;\n\n @include hover() {\n color: $color-hover;\n background-color: $active-background;\n border-color: $active-border;\n }\n\n &:focus,\n &.focus {\n box-shadow: 0 0 0 $btn-focus-width rgba($color, .5);\n }\n\n &.disabled,\n &:disabled {\n color: $color;\n background-color: transparent;\n }\n\n &:not(:disabled):not(.disabled):active,\n &:not(:disabled):not(.disabled).active,\n .show > &.dropdown-toggle {\n color: color-yiq($active-background);\n background-color: $active-background;\n border-color: $active-border;\n\n &:focus {\n @if $enable-shadows and $btn-active-box-shadow != none {\n @include box-shadow($btn-active-box-shadow, 0 0 0 $btn-focus-width rgba($color, .5));\n } @else {\n // Avoid using mixin so we can pass custom focus shadow properly\n box-shadow: 0 0 0 $btn-focus-width rgba($color, .5);\n }\n }\n }\n}\n\n// Button sizes\n@mixin button-size($padding-y, $padding-x, $font-size, $line-height, $border-radius) {\n padding: $padding-y $padding-x;\n @include font-size($font-size);\n line-height: $line-height;\n // Manually declare to provide an override to the browser default\n @include border-radius($border-radius, 0);\n}\n", + "@mixin caret-down() {\n border-top: $caret-width solid;\n border-right: $caret-width solid transparent;\n border-bottom: 0;\n border-left: $caret-width solid transparent;\n}\n\n@mixin caret-up() {\n border-top: 0;\n border-right: $caret-width solid transparent;\n border-bottom: $caret-width solid;\n border-left: $caret-width solid transparent;\n}\n\n@mixin caret-right() {\n border-top: $caret-width solid transparent;\n border-right: 0;\n border-bottom: $caret-width solid transparent;\n border-left: $caret-width solid;\n}\n\n@mixin caret-left() {\n border-top: $caret-width solid transparent;\n border-right: $caret-width solid;\n border-bottom: $caret-width solid transparent;\n}\n\n@mixin caret($direction: down) {\n @if $enable-caret {\n &::after {\n display: inline-block;\n margin-left: $caret-spacing;\n vertical-align: $caret-vertical-align;\n content: \"\";\n @if $direction == down {\n @include caret-down();\n } @else if $direction == up {\n @include caret-up();\n } @else if $direction == right {\n @include caret-right();\n }\n }\n\n @if $direction == left {\n &::after {\n display: none;\n }\n\n &::before {\n display: inline-block;\n margin-right: $caret-spacing;\n vertical-align: $caret-vertical-align;\n content: \"\";\n @include caret-left();\n }\n }\n\n &:empty::after {\n margin-left: 0;\n }\n }\n}\n", + "// Pagination\n\n@mixin pagination-size($padding-y, $padding-x, $font-size, $line-height, $border-radius) {\n .page-link {\n padding: $padding-y $padding-x;\n @include font-size($font-size);\n line-height: $line-height;\n }\n\n .page-item {\n &:first-child {\n .page-link {\n @include border-left-radius($border-radius);\n }\n }\n &:last-child {\n .page-link {\n @include border-right-radius($border-radius);\n }\n }\n }\n}\n", + "// Lists\n\n// Unstyled keeps list items block level, just removes default browser padding and list-style\n@mixin list-unstyled() {\n padding-left: 0;\n list-style: none;\n}\n", + "// List Groups\n\n@mixin list-group-item-variant($state, $background, $color) {\n .list-group-item-#{$state} {\n color: $color;\n background-color: $background;\n\n &.list-group-item-action {\n @include hover-focus() {\n color: $color;\n background-color: darken($background, 5%);\n }\n\n &.active {\n color: $white;\n background-color: $color;\n border-color: $color;\n }\n }\n }\n}\n", + "// Horizontal dividers\n//\n// Dividers (basically an hr) within dropdowns and nav lists\n\n@mixin nav-divider($color: $nav-divider-color, $margin-y: $nav-divider-margin-y, $ignore-warning: false) {\n height: 0;\n margin: $margin-y 0;\n overflow: hidden;\n border-top: 1px solid $color;\n @include deprecate(\"The `nav-divider()` mixin\", \"v4.4.0\", \"v5\", $ignore-warning);\n}\n", + "// Form control focus state\n//\n// Generate a customized focus state and for any input with the specified color,\n// which defaults to the `$input-focus-border-color` variable.\n//\n// We highly encourage you to not customize the default value, but instead use\n// this to tweak colors on an as-needed basis. This aesthetic change is based on\n// WebKit's default styles, but applicable to a wider range of browsers. Its\n// usability and accessibility should be taken into account with any change.\n//\n// Example usage: change the default blue border and shadow to white for better\n// contrast against a dark gray background.\n@mixin form-control-focus($ignore-warning: false) {\n &:focus {\n color: $input-focus-color;\n background-color: $input-focus-bg;\n border-color: $input-focus-border-color;\n outline: 0;\n @if $enable-shadows {\n @include box-shadow($input-box-shadow, $input-focus-box-shadow);\n } @else {\n // Avoid using mixin so we can pass custom focus shadow properly\n box-shadow: $input-focus-box-shadow;\n }\n }\n @include deprecate(\"The `form-control-focus()` mixin\", \"v4.4.0\", \"v5\", $ignore-warning);\n}\n\n// This mixin uses an `if()` technique to be compatible with Dart Sass\n// See https://github.com/sass/sass/issues/1873#issuecomment-152293725 for more details\n@mixin form-validation-state-selector($state) {\n @if ($state == \"valid\" or $state == \"invalid\") {\n .was-validated #{if(&, \"&\", \"\")}:#{$state},\n #{if(&, \"&\", \"\")}.is-#{$state} {\n @content;\n }\n } @else {\n #{if(&, \"&\", \"\")}.is-#{$state} {\n @content;\n }\n }\n}\n\n@mixin form-validation-state($state, $color, $icon) {\n .#{$state}-feedback {\n display: none;\n width: 100%;\n margin-top: $form-feedback-margin-top;\n @include font-size($form-feedback-font-size);\n color: $color;\n }\n\n .#{$state}-tooltip {\n position: absolute;\n top: 100%;\n left: 0;\n z-index: 5;\n display: none;\n max-width: 100%; // Contain to parent when possible\n padding: $form-feedback-tooltip-padding-y $form-feedback-tooltip-padding-x;\n margin-top: .1rem;\n @include font-size($form-feedback-tooltip-font-size);\n line-height: $form-feedback-tooltip-line-height;\n color: color-yiq($color);\n background-color: rgba($color, $form-feedback-tooltip-opacity);\n @include border-radius($form-feedback-tooltip-border-radius);\n }\n\n @include form-validation-state-selector($state) {\n ~ .#{$state}-feedback,\n ~ .#{$state}-tooltip {\n display: block;\n }\n }\n\n .form-control {\n @include form-validation-state-selector($state) {\n border-color: $color;\n\n @if $enable-validation-icons {\n padding-right: $input-height-inner;\n background-image: escape-svg($icon);\n background-repeat: no-repeat;\n background-position: right $input-height-inner-quarter center;\n background-size: $input-height-inner-half $input-height-inner-half;\n }\n\n &:focus {\n border-color: $color;\n box-shadow: 0 0 0 $input-focus-width rgba($color, .25);\n }\n }\n }\n\n // stylelint-disable-next-line selector-no-qualifying-type\n textarea.form-control {\n @include form-validation-state-selector($state) {\n @if $enable-validation-icons {\n padding-right: $input-height-inner;\n background-position: top $input-height-inner-quarter right $input-height-inner-quarter;\n }\n }\n }\n\n .custom-select {\n @include form-validation-state-selector($state) {\n border-color: $color;\n\n @if $enable-validation-icons {\n padding-right: $custom-select-feedback-icon-padding-right;\n background: $custom-select-background, escape-svg($icon) $custom-select-bg no-repeat $custom-select-feedback-icon-position / $custom-select-feedback-icon-size;\n }\n\n &:focus {\n border-color: $color;\n box-shadow: 0 0 0 $input-focus-width rgba($color, .25);\n }\n }\n }\n\n .form-check-input {\n @include form-validation-state-selector($state) {\n ~ .form-check-label {\n color: $color;\n }\n\n ~ .#{$state}-feedback,\n ~ .#{$state}-tooltip {\n display: block;\n }\n }\n }\n\n .custom-control-input {\n @include form-validation-state-selector($state) {\n ~ .custom-control-label {\n color: $color;\n\n &::before {\n border-color: $color;\n }\n }\n\n &:checked {\n ~ .custom-control-label::before {\n border-color: lighten($color, 10%);\n @include gradient-bg(lighten($color, 10%));\n }\n }\n\n &:focus {\n ~ .custom-control-label::before {\n box-shadow: 0 0 0 $input-focus-width rgba($color, .25);\n }\n\n &:not(:checked) ~ .custom-control-label::before {\n border-color: $color;\n }\n }\n }\n }\n\n // custom file\n .custom-file-input {\n @include form-validation-state-selector($state) {\n ~ .custom-file-label {\n border-color: $color;\n }\n\n &:focus {\n ~ .custom-file-label {\n border-color: $color;\n box-shadow: 0 0 0 $input-focus-width rgba($color, .25);\n }\n }\n }\n }\n}\n", + "// Tables\n\n@mixin table-row-variant($state, $background, $border: null) {\n // Exact selectors below required to override `.table-striped` and prevent\n // inheritance to nested tables.\n .table-#{$state} {\n &,\n > th,\n > td {\n background-color: $background;\n }\n\n @if $border != null {\n th,\n td,\n thead th,\n tbody + tbody {\n border-color: $border;\n }\n }\n }\n\n // Hover states for `.table-hover`\n // Note: this is not available for cells or rows within `thead` or `tfoot`.\n .table-hover {\n $hover-background: darken($background, 5%);\n\n .table-#{$state} {\n @include hover() {\n background-color: $hover-background;\n\n > td,\n > th {\n background-color: $hover-background;\n }\n }\n }\n }\n}\n", + "// stylelint-disable declaration-no-important\n\n// Contextual backgrounds\n\n@mixin bg-variant($parent, $color, $ignore-warning: false) {\n #{$parent} {\n background-color: $color !important;\n }\n a#{$parent},\n button#{$parent} {\n @include hover-focus() {\n background-color: darken($color, 10%) !important;\n }\n }\n @include deprecate(\"The `bg-variant` mixin\", \"v4.4.0\", \"v5\", $ignore-warning);\n}\n\n@mixin bg-gradient-variant($parent, $color, $ignore-warning: false) {\n #{$parent} {\n background: $color linear-gradient(180deg, mix($body-bg, $color, 15%), $color) repeat-x !important;\n }\n @include deprecate(\"The `bg-gradient-variant` mixin\", \"v4.5.0\", \"v5\", $ignore-warning);\n}\n", + "// stylelint-disable property-disallowed-list\n// Single side border-radius\n\n// Helper function to replace negative values with 0\n@function valid-radius($radius) {\n $return: ();\n @each $value in $radius {\n @if type-of($value) == number {\n $return: append($return, max($value, 0));\n } @else {\n $return: append($return, $value);\n }\n }\n @return $return;\n}\n\n@mixin border-radius($radius: $border-radius, $fallback-border-radius: false) {\n @if $enable-rounded {\n border-radius: valid-radius($radius);\n }\n @else if $fallback-border-radius != false {\n border-radius: $fallback-border-radius;\n }\n}\n\n@mixin border-top-radius($radius) {\n @if $enable-rounded {\n border-top-left-radius: valid-radius($radius);\n border-top-right-radius: valid-radius($radius);\n }\n}\n\n@mixin border-right-radius($radius) {\n @if $enable-rounded {\n border-top-right-radius: valid-radius($radius);\n border-bottom-right-radius: valid-radius($radius);\n }\n}\n\n@mixin border-bottom-radius($radius) {\n @if $enable-rounded {\n border-bottom-right-radius: valid-radius($radius);\n border-bottom-left-radius: valid-radius($radius);\n }\n}\n\n@mixin border-left-radius($radius) {\n @if $enable-rounded {\n border-top-left-radius: valid-radius($radius);\n border-bottom-left-radius: valid-radius($radius);\n }\n}\n\n@mixin border-top-left-radius($radius) {\n @if $enable-rounded {\n border-top-left-radius: valid-radius($radius);\n }\n}\n\n@mixin border-top-right-radius($radius) {\n @if $enable-rounded {\n border-top-right-radius: valid-radius($radius);\n }\n}\n\n@mixin border-bottom-right-radius($radius) {\n @if $enable-rounded {\n border-bottom-right-radius: valid-radius($radius);\n }\n}\n\n@mixin border-bottom-left-radius($radius) {\n @if $enable-rounded {\n border-bottom-left-radius: valid-radius($radius);\n }\n}\n", + "@mixin box-shadow($shadow...) {\n @if $enable-shadows {\n $result: ();\n\n @if (length($shadow) == 1) {\n // We can pass `@include box-shadow(none);`\n $result: $shadow;\n } @else {\n // Filter to avoid invalid properties for example `box-shadow: none, 1px 1px black;`\n @for $i from 1 through length($shadow) {\n @if nth($shadow, $i) != \"none\" {\n $result: append($result, nth($shadow, $i), \"comma\");\n }\n }\n }\n @if (length($result) > 0) {\n box-shadow: $result;\n }\n }\n}\n", + "// Gradients\n\n@mixin gradient-bg($color) {\n @if $enable-gradients {\n background: $color linear-gradient(180deg, mix($body-bg, $color, 15%), $color) repeat-x;\n } @else {\n background-color: $color;\n }\n}\n\n// Horizontal gradient, from left to right\n//\n// Creates two color stops, start and end, by specifying a color and position for each color stop.\n@mixin gradient-x($start-color: $gray-700, $end-color: $gray-800, $start-percent: 0%, $end-percent: 100%) {\n background-image: linear-gradient(to right, $start-color $start-percent, $end-color $end-percent);\n background-repeat: repeat-x;\n}\n\n// Vertical gradient, from top to bottom\n//\n// Creates two color stops, start and end, by specifying a color and position for each color stop.\n@mixin gradient-y($start-color: $gray-700, $end-color: $gray-800, $start-percent: 0%, $end-percent: 100%) {\n background-image: linear-gradient(to bottom, $start-color $start-percent, $end-color $end-percent);\n background-repeat: repeat-x;\n}\n\n@mixin gradient-directional($start-color: $gray-700, $end-color: $gray-800, $deg: 45deg) {\n background-image: linear-gradient($deg, $start-color, $end-color);\n background-repeat: repeat-x;\n}\n@mixin gradient-x-three-colors($start-color: $blue, $mid-color: $purple, $color-stop: 50%, $end-color: $red) {\n background-image: linear-gradient(to right, $start-color, $mid-color $color-stop, $end-color);\n background-repeat: no-repeat;\n}\n@mixin gradient-y-three-colors($start-color: $blue, $mid-color: $purple, $color-stop: 50%, $end-color: $red) {\n background-image: linear-gradient($start-color, $mid-color $color-stop, $end-color);\n background-repeat: no-repeat;\n}\n@mixin gradient-radial($inner-color: $gray-700, $outer-color: $gray-800) {\n background-image: radial-gradient(circle, $inner-color, $outer-color);\n background-repeat: no-repeat;\n}\n@mixin gradient-striped($color: rgba($white, .15), $angle: 45deg) {\n background-image: linear-gradient($angle, $color 25%, transparent 25%, transparent 50%, $color 50%, $color 75%, transparent 75%, transparent);\n}\n", + "// stylelint-disable property-disallowed-list\n@mixin transition($transition...) {\n @if length($transition) == 0 {\n $transition: $transition-base;\n }\n\n @if length($transition) > 1 {\n @each $value in $transition {\n @if $value == null or $value == none {\n @warn \"The keyword 'none' or 'null' must be used as a single argument.\";\n }\n }\n }\n\n @if $enable-transitions {\n @if nth($transition, 1) != null {\n transition: $transition;\n }\n\n @if $enable-prefers-reduced-motion-media-query and nth($transition, 1) != null and nth($transition, 1) != none {\n @media (prefers-reduced-motion: reduce) {\n transition: none;\n }\n }\n }\n}\n", + "@mixin clearfix() {\n &::after {\n display: block;\n clear: both;\n content: \"\";\n }\n}\n", + "// Framework grid generation\n//\n// Used only by Bootstrap to generate the correct number of grid classes given\n// any value of `$grid-columns`.\n\n@mixin make-grid-columns($columns: $grid-columns, $gutter: $grid-gutter-width, $breakpoints: $grid-breakpoints) {\n // Common properties for all breakpoints\n %grid-column {\n position: relative;\n width: 100%;\n padding-right: $gutter / 2;\n padding-left: $gutter / 2;\n }\n\n @each $breakpoint in map-keys($breakpoints) {\n $infix: breakpoint-infix($breakpoint, $breakpoints);\n\n @if $columns > 0 {\n // Allow columns to stretch full width below their breakpoints\n @for $i from 1 through $columns {\n .col#{$infix}-#{$i} {\n @extend %grid-column;\n }\n }\n }\n\n .col#{$infix},\n .col#{$infix}-auto {\n @extend %grid-column;\n }\n\n @include media-breakpoint-up($breakpoint, $breakpoints) {\n // Provide basic `.col-{bp}` classes for equal-width flexbox columns\n .col#{$infix} {\n flex-basis: 0;\n flex-grow: 1;\n max-width: 100%;\n }\n\n @if $grid-row-columns > 0 {\n @for $i from 1 through $grid-row-columns {\n .row-cols#{$infix}-#{$i} {\n @include row-cols($i);\n }\n }\n }\n\n .col#{$infix}-auto {\n @include make-col-auto();\n }\n\n @if $columns > 0 {\n @for $i from 1 through $columns {\n .col#{$infix}-#{$i} {\n @include make-col($i, $columns);\n }\n }\n }\n\n .order#{$infix}-first { order: -1; }\n\n .order#{$infix}-last { order: $columns + 1; }\n\n @for $i from 0 through $columns {\n .order#{$infix}-#{$i} { order: $i; }\n }\n\n @if $columns > 0 {\n // `$columns - 1` because offsetting by the width of an entire row isn't possible\n @for $i from 0 through ($columns - 1) {\n @if not ($infix == \"\" and $i == 0) { // Avoid emitting useless .offset-0\n .offset#{$infix}-#{$i} {\n @include make-col-offset($i, $columns);\n }\n }\n }\n }\n }\n }\n}\n", + "/// Grid system\n//\n// Generate semantic grid columns with these mixins.\n\n@mixin make-container($gutter: $grid-gutter-width) {\n width: 100%;\n padding-right: $gutter / 2;\n padding-left: $gutter / 2;\n margin-right: auto;\n margin-left: auto;\n}\n\n@mixin make-row($gutter: $grid-gutter-width) {\n display: flex;\n flex-wrap: wrap;\n margin-right: -$gutter / 2;\n margin-left: -$gutter / 2;\n}\n\n// For each breakpoint, define the maximum width of the container in a media query\n@mixin make-container-max-widths($max-widths: $container-max-widths, $breakpoints: $grid-breakpoints) {\n @each $breakpoint, $container-max-width in $max-widths {\n @include media-breakpoint-up($breakpoint, $breakpoints) {\n max-width: $container-max-width;\n }\n }\n @include deprecate(\"The `make-container-max-widths` mixin\", \"v4.5.2\", \"v5\");\n}\n\n@mixin make-col-ready($gutter: $grid-gutter-width) {\n position: relative;\n // Prevent columns from becoming too narrow when at smaller grid tiers by\n // always setting `width: 100%;`. This works because we use `flex` values\n // later on to override this initial width.\n width: 100%;\n padding-right: $gutter / 2;\n padding-left: $gutter / 2;\n}\n\n@mixin make-col($size, $columns: $grid-columns) {\n flex: 0 0 percentage($size / $columns);\n // Add a `max-width` to ensure content within each column does not blow out\n // the width of the column. Applies to IE10+ and Firefox. Chrome and Safari\n // do not appear to require this.\n max-width: percentage($size / $columns);\n}\n\n@mixin make-col-auto() {\n flex: 0 0 auto;\n width: auto;\n max-width: 100%; // Reset earlier grid tiers\n}\n\n@mixin make-col-offset($size, $columns: $grid-columns) {\n $num: $size / $columns;\n margin-left: if($num == 0, 0, percentage($num));\n}\n\n// Row columns\n//\n// Specify on a parent element(e.g., .row) to force immediate children into NN\n// numberof columns. Supports wrapping to new lines, but does not do a Masonry\n// style grid.\n@mixin row-cols($count) {\n > * {\n flex: 0 0 100% / $count;\n max-width: 100% / $count;\n }\n}\n", + "// stylelint-disable declaration-no-important\n\n@mixin float-left() {\n float: left !important;\n @include deprecate(\"The `float-left` mixin\", \"v4.3.0\", \"v5\");\n}\n@mixin float-right() {\n float: right !important;\n @include deprecate(\"The `float-right` mixin\", \"v4.3.0\", \"v5\");\n}\n@mixin float-none() {\n float: none !important;\n @include deprecate(\"The `float-none` mixin\", \"v4.3.0\", \"v5\");\n}\n", + "// Do not forget to update getting-started/theming.md!\n:root {\n // Custom variable values only support SassScript inside `#{}`.\n @each $color, $value in $colors {\n --#{$color}: #{$value};\n }\n\n @each $color, $value in $theme-colors {\n --#{$color}: #{$value};\n }\n\n @each $bp, $value in $grid-breakpoints {\n --breakpoint-#{$bp}: #{$value};\n }\n\n // Use `inspect` for lists so that quoted items keep the quotes.\n // See https://github.com/sass/sass/issues/2383#issuecomment-336349172\n --font-family-sans-serif: #{inspect($font-family-sans-serif)};\n --font-family-monospace: #{inspect($font-family-monospace)};\n}\n", + "// stylelint-disable at-rule-no-vendor-prefix, declaration-no-important, selector-no-qualifying-type, property-no-vendor-prefix\n\n// Reboot\n//\n// Normalization of HTML elements, manually forked from Normalize.css to remove\n// styles targeting irrelevant browsers while applying new styles.\n//\n// Normalize is licensed MIT. https://github.com/necolas/normalize.css\n\n\n// Document\n//\n// 1. Change from `box-sizing: content-box` so that `width` is not affected by `padding` or `border`.\n// 2. Change the default font family in all browsers.\n// 3. Correct the line height in all browsers.\n// 4. Prevent adjustments of font size after orientation changes in IE on Windows Phone and in iOS.\n// 5. Change the default tap highlight to be completely transparent in iOS.\n\n*,\n*::before,\n*::after {\n box-sizing: border-box; // 1\n}\n\nhtml {\n font-family: sans-serif; // 2\n line-height: 1.15; // 3\n -webkit-text-size-adjust: 100%; // 4\n -webkit-tap-highlight-color: rgba($black, 0); // 5\n}\n\n// Shim for \"new\" HTML5 structural elements to display correctly (IE10, older browsers)\n// TODO: remove in v5\n// stylelint-disable-next-line selector-list-comma-newline-after\narticle, aside, figcaption, figure, footer, header, hgroup, main, nav, section {\n display: block;\n}\n\n// Body\n//\n// 1. Remove the margin in all browsers.\n// 2. As a best practice, apply a default `background-color`.\n// 3. Set an explicit initial text-align value so that we can later use\n// the `inherit` value on things like `` elements.\n\nbody {\n margin: 0; // 1\n font-family: $font-family-base;\n @include font-size($font-size-base);\n font-weight: $font-weight-base;\n line-height: $line-height-base;\n color: $body-color;\n text-align: left; // 3\n background-color: $body-bg; // 2\n}\n\n// Future-proof rule: in browsers that support :focus-visible, suppress the focus outline\n// on elements that programmatically receive focus but wouldn't normally show a visible\n// focus outline. In general, this would mean that the outline is only applied if the\n// interaction that led to the element receiving programmatic focus was a keyboard interaction,\n// or the browser has somehow determined that the user is primarily a keyboard user and/or\n// wants focus outlines to always be presented.\n//\n// See https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible\n// and https://developer.paciellogroup.com/blog/2018/03/focus-visible-and-backwards-compatibility/\n[tabindex=\"-1\"]:focus:not(:focus-visible) {\n outline: 0 !important;\n}\n\n\n// Content grouping\n//\n// 1. Add the correct box sizing in Firefox.\n// 2. Show the overflow in Edge and IE.\n\nhr {\n box-sizing: content-box; // 1\n height: 0; // 1\n overflow: visible; // 2\n}\n\n\n//\n// Typography\n//\n\n// Remove top margins from headings\n//\n// By default, `

`-`

` all receive top and bottom margins. We nuke the top\n// margin for easier control within type scales as it avoids margin collapsing.\n// stylelint-disable-next-line selector-list-comma-newline-after\nh1, h2, h3, h4, h5, h6 {\n margin-top: 0;\n margin-bottom: $headings-margin-bottom;\n}\n\n// Reset margins on paragraphs\n//\n// Similarly, the top margin on `

`s get reset. However, we also reset the\n// bottom margin to use `rem` units instead of `em`.\np {\n margin-top: 0;\n margin-bottom: $paragraph-margin-bottom;\n}\n\n// Abbreviations\n//\n// 1. Duplicate behavior to the data-* attribute for our tooltip plugin\n// 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n// 3. Add explicit cursor to indicate changed behavior.\n// 4. Remove the bottom border in Firefox 39-.\n// 5. Prevent the text-decoration to be skipped.\n\nabbr[title],\nabbr[data-original-title] { // 1\n text-decoration: underline; // 2\n text-decoration: underline dotted; // 2\n cursor: help; // 3\n border-bottom: 0; // 4\n text-decoration-skip-ink: none; // 5\n}\n\naddress {\n margin-bottom: 1rem;\n font-style: normal;\n line-height: inherit;\n}\n\nol,\nul,\ndl {\n margin-top: 0;\n margin-bottom: 1rem;\n}\n\nol ol,\nul ul,\nol ul,\nul ol {\n margin-bottom: 0;\n}\n\ndt {\n font-weight: $dt-font-weight;\n}\n\ndd {\n margin-bottom: .5rem;\n margin-left: 0; // Undo browser default\n}\n\nblockquote {\n margin: 0 0 1rem;\n}\n\nb,\nstrong {\n font-weight: $font-weight-bolder; // Add the correct font weight in Chrome, Edge, and Safari\n}\n\nsmall {\n @include font-size(80%); // Add the correct font size in all browsers\n}\n\n//\n// Prevent `sub` and `sup` elements from affecting the line height in\n// all browsers.\n//\n\nsub,\nsup {\n position: relative;\n @include font-size(75%);\n line-height: 0;\n vertical-align: baseline;\n}\n\nsub { bottom: -.25em; }\nsup { top: -.5em; }\n\n\n//\n// Links\n//\n\na {\n color: $link-color;\n text-decoration: $link-decoration;\n background-color: transparent; // Remove the gray background on active links in IE 10.\n\n @include hover() {\n color: $link-hover-color;\n text-decoration: $link-hover-decoration;\n }\n}\n\n// And undo these styles for placeholder links/named anchors (without href).\n// It would be more straightforward to just use a[href] in previous block, but that\n// causes specificity issues in many other styles that are too complex to fix.\n// See https://github.com/twbs/bootstrap/issues/19402\n\na:not([href]):not([class]) {\n color: inherit;\n text-decoration: none;\n\n @include hover() {\n color: inherit;\n text-decoration: none;\n }\n}\n\n\n//\n// Code\n//\n\npre,\ncode,\nkbd,\nsamp {\n font-family: $font-family-monospace;\n @include font-size(1em); // Correct the odd `em` font sizing in all browsers.\n}\n\npre {\n // Remove browser default top margin\n margin-top: 0;\n // Reset browser default of `1em` to use `rem`s\n margin-bottom: 1rem;\n // Don't allow content to break outside\n overflow: auto;\n // Disable auto-hiding scrollbar in IE & legacy Edge to avoid overlap,\n // making it impossible to interact with the content\n -ms-overflow-style: scrollbar;\n}\n\n\n//\n// Figures\n//\n\nfigure {\n // Apply a consistent margin strategy (matches our type styles).\n margin: 0 0 1rem;\n}\n\n\n//\n// Images and content\n//\n\nimg {\n vertical-align: middle;\n border-style: none; // Remove the border on images inside links in IE 10-.\n}\n\nsvg {\n // Workaround for the SVG overflow bug in IE10/11 is still required.\n // See https://github.com/twbs/bootstrap/issues/26878\n overflow: hidden;\n vertical-align: middle;\n}\n\n\n//\n// Tables\n//\n\ntable {\n border-collapse: collapse; // Prevent double borders\n}\n\ncaption {\n padding-top: $table-cell-padding;\n padding-bottom: $table-cell-padding;\n color: $table-caption-color;\n text-align: left;\n caption-side: bottom;\n}\n\n// 1. Removes font-weight bold by inheriting\n// 2. Matches default `` alignment by inheriting `text-align`.\n// 3. Fix alignment for Safari\n\nth {\n font-weight: $table-th-font-weight; // 1\n text-align: inherit; // 2\n text-align: -webkit-match-parent; // 3\n}\n\n\n//\n// Forms\n//\n\nlabel {\n // Allow labels to use `margin` for spacing.\n display: inline-block;\n margin-bottom: $label-margin-bottom;\n}\n\n// Remove the default `border-radius` that macOS Chrome adds.\n//\n// Details at https://github.com/twbs/bootstrap/issues/24093\nbutton {\n // stylelint-disable-next-line property-disallowed-list\n border-radius: 0;\n}\n\n// Work around a Firefox/IE bug where the transparent `button` background\n// results in a loss of the default `button` focus styles.\n//\n// Credit: https://github.com/suitcss/base/\nbutton:focus {\n outline: 1px dotted;\n outline: 5px auto -webkit-focus-ring-color;\n}\n\ninput,\nbutton,\nselect,\noptgroup,\ntextarea {\n margin: 0; // Remove the margin in Firefox and Safari\n font-family: inherit;\n @include font-size(inherit);\n line-height: inherit;\n}\n\nbutton,\ninput {\n overflow: visible; // Show the overflow in Edge\n}\n\nbutton,\nselect {\n text-transform: none; // Remove the inheritance of text transform in Firefox\n}\n\n// Set the cursor for non-` + +

+ + +
+
+ + +
+ + + + +
+ + + + + + + + + + + + diff --git a/de/index.json b/de/index.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/de/index.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/de/index.xml b/de/index.xml new file mode 100644 index 0000000000..6d96050435 --- /dev/null +++ b/de/index.xml @@ -0,0 +1,11 @@ + + + + darktable user manual + https://darktable-org.github.io/dtdocs/de/ + Recent content on darktable user manual + Hugo + de + + + diff --git a/de/sitemap.xml b/de/sitemap.xml new file mode 100644 index 0000000000..9a306f943b --- /dev/null +++ b/de/sitemap.xml @@ -0,0 +1,176 @@ + + + + https://darktable-org.github.io/dtdocs/de/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/de/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/de/tags/ + + + + + + + + + + + + + diff --git a/de/tags/index.html b/de/tags/index.html new file mode 100644 index 0000000000..7c717074b9 --- /dev/null +++ b/de/tags/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Tags + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Tags

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/de/tags/index.xml b/de/tags/index.xml new file mode 100644 index 0000000000..5d18d679d8 --- /dev/null +++ b/de/tags/index.xml @@ -0,0 +1,11 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/de/tags/ + Recent content in Tags on darktable user manual + Hugo + de + + + diff --git a/en/categories/index.html b/en/categories/index.html new file mode 100644 index 0000000000..8e34a9e932 --- /dev/null +++ b/en/categories/index.html @@ -0,0 +1,3036 @@ + + + + + +darktable user manual - Categories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Categories + +
+ +
+ +
+ +
+
+ + +
+ +

Categories

+
    + +
+
+ +
+ +
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/categories/index.xml b/en/categories/index.xml new file mode 100644 index 0000000000..e79875ef96 --- /dev/null +++ b/en/categories/index.xml @@ -0,0 +1,11 @@ + + + + Categories on darktable user manual + https://darktable-org.github.io/dtdocs/en/categories/ + Recent content in Categories on darktable user manual + Hugo + en + + + diff --git a/en/darkroom/darkroom-view-layout/clipping-icon.png b/en/darkroom/darkroom-view-layout/clipping-icon.png new file mode 100644 index 0000000000..be3b735bb9 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/clipping-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/color-assessment-icon.png b/en/darkroom/darkroom-view-layout/color-assessment-icon.png new file mode 100644 index 0000000000..75b0bd1d2d Binary files /dev/null and b/en/darkroom/darkroom-view-layout/color-assessment-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/darkroom-bottom-panel.png b/en/darkroom/darkroom-view-layout/darkroom-bottom-panel.png new file mode 100644 index 0000000000..b6774b3b26 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/darkroom-bottom-panel.png differ diff --git a/en/darkroom/darkroom-view-layout/focus-peak-icon.png b/en/darkroom/darkroom-view-layout/focus-peak-icon.png new file mode 100644 index 0000000000..efff3177f6 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/focus-peak-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/gamut-check-icon.png b/en/darkroom/darkroom-view-layout/gamut-check-icon.png new file mode 100644 index 0000000000..a61b1a00e3 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/gamut-check-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/guides-overlays-icon.png b/en/darkroom/darkroom-view-layout/guides-overlays-icon.png new file mode 100644 index 0000000000..4911e79a4a Binary files /dev/null and b/en/darkroom/darkroom-view-layout/guides-overlays-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/high-quality-processing-icon.png b/en/darkroom/darkroom-view-layout/high-quality-processing-icon.png new file mode 100644 index 0000000000..59b9aec009 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/high-quality-processing-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/index.html b/en/darkroom/darkroom-view-layout/index.html new file mode 100644 index 0000000000..21657418be --- /dev/null +++ b/en/darkroom/darkroom-view-layout/index.html @@ -0,0 +1,3209 @@ + + + + + +darktable user manual - darkroom view layout + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Darkroom / darkroom view layout + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ darkroom view layout +

+ + + +

🔗left panel

+

From top to bottom:

+
+
navigation
+
Navigate and zoom the center view.
+
snapshots
+
Take and view snapshots for comparison with the current edit.
+
duplicate manager
+
View and manage duplicates.
+
global color picker
+
Select and display color information taken from parts of the image.
+
tagging
+
Manage tags.
+
image information
+
Display information about the current image.
+
mask manager
+
View and edit drawn shapes.
+
export
+
Export selected images to local files or external services.
+
+

🔗right panel

+

From top to bottom:

+
+
scopes
+
A graphical depiction of the image’s light levels and colors. This module can be moved to the left-hand panel if desired (see preferences > miscellaneous > position of the scopes module).
+
module groups
+
Select module groups (if enabled).
+
search module
+
Search for a module (if enabled).
+
processing modules
+
The modules used to process an image.
+
module order
+
Choose the order in which processing modules are executed in the pixelpipe.
+
+

🔗bottom panel

+

+ + + + + + + + +darkroom-view-layout + +

+

From left to right:

+
+
+ + + + + + + + +presets-icon + + presets
+
Quick access menu for module presets. You can manage the contents of this menu by selecting “manage quick presets list…”.
+
+ + + + + + + + +styles-icon + + styles
+
Quick access menu for styles. Hover over a style name with your mouse to show a preview of the current darkroom image with the selected style applied.
+
+ + + + + + + + +second-window-icon + + second darkroom window
+
For multi-monitor setup, allows the user to display a second image on another screen.
+
+ + + + + + + + +focus-peak-icon + + focus peaking
+
Toggle focus peaking mode.
+
+ + + + + + + + +color-assessment-icon + + color assessment
+
Toggle the ISO12646 color assessment view.
+
+ + + + + + + + +high-quality-processing-icon + + high quality processing
+
Toggle high quality processing mode.
+
+ + + + + + + + +raw-overexposed-icon + + raw overexposed warning
+
Toggle raw overexposed indicators (right-click for options).
+
+ + + + + + + + +clipping-icon + + clipping warning
+
Toggle clipping warnings (right-click for options).
+
+ + + + + + + + +softproof-icon + + soft proof
+
Toggle softproofing overlays (right-click for options).
+
+ + + + + + + + +gamut-check-icon + + gamut check
+
Toggle gamut checking (right-click for options).
+
+ + + + + + + + +guides-overlays-icon + + guides & overlays
+
Left-click to switch global guide overlays on/off and right-click to change the guide settings, including the color of all on-image drawing (masks, crop guides etc.)
+
+

You can also enable the filmstrip module at the bottom of the screen to allow you select and interact with the currently selected collection in the lighttable view.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/darkroom-view-layout/presets-icon.png b/en/darkroom/darkroom-view-layout/presets-icon.png new file mode 100644 index 0000000000..4d9fa1a21c Binary files /dev/null and b/en/darkroom/darkroom-view-layout/presets-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/raw-overexposed-icon.png b/en/darkroom/darkroom-view-layout/raw-overexposed-icon.png new file mode 100644 index 0000000000..d5fea45d42 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/raw-overexposed-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/second-window-icon.png b/en/darkroom/darkroom-view-layout/second-window-icon.png new file mode 100644 index 0000000000..dfc26e33f5 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/second-window-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/softproof-icon.png b/en/darkroom/darkroom-view-layout/softproof-icon.png new file mode 100644 index 0000000000..eaeb532e48 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/softproof-icon.png differ diff --git a/en/darkroom/darkroom-view-layout/styles-icon.png b/en/darkroom/darkroom-view-layout/styles-icon.png new file mode 100644 index 0000000000..257b8e72c5 Binary files /dev/null and b/en/darkroom/darkroom-view-layout/styles-icon.png differ diff --git a/en/darkroom/index.html b/en/darkroom/index.html new file mode 100644 index 0000000000..e9240d049b --- /dev/null +++ b/en/darkroom/index.html @@ -0,0 +1,3050 @@ + + + + + +darktable user manual - Darkroom + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/index.xml b/en/darkroom/index.xml new file mode 100644 index 0000000000..159ac09281 --- /dev/null +++ b/en/darkroom/index.xml @@ -0,0 +1,25 @@ + + + + Darkroom on darktable user manual + https://darktable-org.github.io/dtdocs/en/darkroom/ + Recent content in Darkroom on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/overview/ + The darkroom view is where you develop your images. The center panel contains the image currently being edited. 🔗zoom Middle-click on the center panel cycle between &ldquo;fit to screen&rdquo;, 1:1 and 2:1 zoom. Alternatively you can zoom between 1:1 and &ldquo;fit to screen&rdquo; by scrolling with your mouse. Scroll while holding the Ctrl key to extend the zoom range to between 2:1 and 1:10. + + + darkroom view layout + https://darktable-org.github.io/dtdocs/en/darkroom/darkroom-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/darkroom-view-layout/ + 🔗left panel From top to bottom: navigation Navigate and zoom the center view. snapshots Take and view snapshots for comparison with the current edit. duplicate manager View and manage duplicates. global color picker Select and display color information taken from parts of the image. tagging Manage tags. image information Display information about the current image. mask manager View and edit drawn shapes. export Export selected images to local files or external services. + + + diff --git a/en/darkroom/masking-and-blending/blend-modes/blend-reverse.png b/en/darkroom/masking-and-blending/blend-modes/blend-reverse.png new file mode 100644 index 0000000000..b0717b2ad1 Binary files /dev/null and b/en/darkroom/masking-and-blending/blend-modes/blend-reverse.png differ diff --git a/en/darkroom/masking-and-blending/blend-modes/index.html b/en/darkroom/masking-and-blending/blend-modes/index.html new file mode 100644 index 0000000000..ed0aff5c62 --- /dev/null +++ b/en/darkroom/masking-and-blending/blend-modes/index.html @@ -0,0 +1,3143 @@ + + + + + +darktable user manual - blend modes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / masking & blending / blend modes + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ blend modes +

+ + + +

Blend modes define how the input and output of a module are combined (blended) together before the module’s final output is passed to the next module in the pixelpipe.

+

Classic blending modes, designed for display-referred RGB (constrained to 0-100%), implicitly define a fulcrum at 50% (gray) or 100% (white) in their algorithms, depending on the blend mode. Because scene-referred is not subject to these restrictions, this fulcrum needs to be explicitly defined by the user when performing blending operations in the “RGB (scene)” color space. The additional blend fulcrum parameter will be presented to the user when using one of these blend modes in this color space. The effect depends on the operator used. For example, values above the fulcrum might be brightened and values below darkened, or vice versa.

+

The final output of a module is computed ‘per-pixel’ as follows:

+
final_output = (1.0 - opacity) * module_input + opacity * blended_output
+

where the blended_output is a combination of the input and output images, depending on the blend mode (below), and the opacity is defined ‘per-pixel’ by a combination of the mask and global opacity parameter. An opacity of 0% outputs an image that is identical to the input image of the module.

+

The “reverse” button + + + + + + + + +blend-reverse + + effectively reverses the roles of the input and output images in the ‘per-pixel’ computation:

+
final_output = (1.0 - opacity) * module_output + opacity * blended_input
+

where the blended_input is a combination of the output and input images, depending on the blend mode below where output and input image references are reversed. In “reversed” blend modes, an opacity of 0% outputs an image that is identical to the output image of the module.

+

🔗normal modes

+
+
normal
+
The most commonly used blend mode, “normal” simply mixes input and output to an extent determined by the opacity parameter. This mode is commonly used to reduce the strength of a module’s effect by reducing the opacity. This is also usually the blend mode of choice when applying a module’s effect selectively with masks. This mode is also known as the “over” Porter-Duff alpha blending operator (see alpha compositing for more details).
+
normal bounded
+
not available in the “RGB (scene)” color space
+
This blend mode is the same as “normal”, except that the input and output data are clamped to a particular min/max value range. Out-of-range values are effectively blocked and are not passed to subsequent modules. Sometimes this helps to prevent artifacts. However, in most cases (e.g. highly color-saturated extreme highlights) it is better to let unbound values travel through the pixelpipe to be properly handled later. The “normal” blend mode is therefore usually preferred.
+
+

🔗arithmetic modes

+
+
addition
+
Add together the pixel values of the input and output images, lightening the output. When blending in the “RGB (scene)” color space, the pixel values of the output image are multiplied by a value proportional to the “blend fulcrum”.
+
subtract
+
Subtract the pixel value of the output from the input. When blending in the “RGB (scene)” color space, the pixel values of the output image are multiplied by a value proportional to the “blend fulcrum”. Pixel values less than 0 are set to 0.
+
multiply
+
Multiply the pixel values of the input and output together. When blending in display-referred color spaces, pixel values are between 0 and 1.0, the final output will be clamped and will always be darker. When blending in the “RGB (scene)” color space, this value is further multiplied by a value proportional to the “blend fulcrum”. In this case, values may be greater than 1.0 and therefore brighten the base image. This may have other side-effects, such as updating the white point in the filmic module.
+
+

Multiply blending simulates an optical variable density filter, where the density is defined by the output of the module. It has many applications, from blooming and local contrast enhancements (when used with a blur or low-pass filter) to dodging/burning and global contrast enhancements (when used with exposure). The fulcrum sets the output intensity threshold between darkening and brightening (any RGB value below fulcrum will darken).

+
+
divide
+
Divide the pixel values of the input by the output. When blending in the “RGB (scene)” color space, the pixel values of the output image are multiplied by a value proportional to the “blend fulcrum”.
+
+

Since this is the inverse of the multiply mode, it will darken where multiply brightens and vice versa. Everything else works in essentially the same way.

+
+
screen
+
not available in the “RGB (scene)” color space
+
Invert the input and output pixel values, multiply those values together and invert the result. This yields approximately the opposite effect to “multiply” mode – the resulting image is usually brighter, and sometimes “washed out” in appearance.
+
average
+
Return the arithmetic mean of the input and output pixel values.
+
difference
+
Return the absolute difference between the input and output pixel values.
+
geometric mean
+
Return the square root of the product of the input and output pixel values.
+
harmonic mean
+
Return the product of the input and output pixel values, multiplied by 2 and divided by their sum.
+
+

🔗contrast enhancing modes

+

The following modes are not available in the “RGB (scene)” blending color space as they rely on an assumption of “50% mid gray” which only applies to display-referred and non-linear color spaces. In addition, they clamp pixel values of both input and output images as the underlying math is not valid outside the range 0..1, and can thus cause visible changes anywhere in the image. To avoid these, you will need to ensure that the module’s input does not exceed the display-referred range.

+
+
overlay
+
This mode combines the “multiply” and “screen” blend modes: The parts of the input where the output is brighter, become brighter; The parts of the image where the output is darker, become darker; Mid-gray is unaffected. This mode is often combined with the lowpass and highpass modules.
+
softlight
+
This mode is similar to “overlay”, except the results are softer and less bright. As with overlay, it is often combined with the lowpass and highpass modules.
+
hardlight
+
This mode is not related to “softlight” in anything but name. Like overlay mode it is a combination of “multiply” and “screen” modes and has a different effect above and below mid-gray. The results with hardlight blend mode tend to be quite intense and usually need to be combined with a reduced opacity.
+
vividlight
+
This mode is an extreme version of overlay/softlight. Values darker than mid-gray are darkened; Values brighter than mid-gray are brightened. You will probably need to tone down its effect by reducing the opacity
+
linearlight
+
This mode is similar to the effect of “vividlight”.
+
pinlight
+
This mode performs a darken and lighten blending simultaneously, removing mid-tones. It can result in artifacts such as patches and blotches.
+
+

🔗color channel modes

+

🔗Lab channels

+

The following are available for blending in the Lab color space only

+
+
Lab lightness
+
Mix the lightness from the input and output images, while taking the color channels (a and b) unaltered from the input image. In contrast to “lightness” this blend mode does not involve any color space conversion and does not clamp any data. In some cases this blend mode is less prone to artifacts than “lightness”.
+
Lab a-channel
+
Mix the Lab “a” color channel from the input and output images, while taking the other channels unaltered from the input image.
+
Lab b-channel
+
Mix the Lab “b” color channel from the input and output images, while taking the other channels unaltered from the input image.
+
Lab color
+
Mix the Lab color channels (a and b) from the input and output images, while taking the lightness unaltered from the input image. In contrast to “color” this blend mode does not involve any color space conversion and does not clamp any data. In some cases this blend mode is less prone to artifacts than “color”.
+
+

🔗RGB channels

+

The following are available when blending in RGB color spaces only.

+
+
RGB red channel
+
Mix the “red” channel from the input and output images, while taking the other channels unaltered from the input image. When blending in the “RGB (scene)” color space, the “red” channel from the output image is multiplied by a value proportional to the “blend fulcrum”.
+
RGB green channel
+
Mix the “green” channel from the input and output images, while taking the other channels unaltered from the input image. When blending in the “RGB (scene)” color space, the “green” channel from the output image is multiplied by a value proportional to the “blend fulcrum”.
+
RGB blue channel
+
Mix the “blue” channel from the input and output images, while taking the other channels unaltered from the input image. When blending in the “RGB (scene)” color space, the “blue” channel from the output image is multiplied by a value proportional to the “blend fulcrum”.
+
+

🔗HSV channels

+

The following are available when blending in the “RGB (display)” color space only.

+
+
HSV value
+
Mix the lightness from the input and output images, while taking color unaltered from the input image. In contrast to “lightness” this blend mode does not involve clamping.
+
HSV color
+
Mix the color from the input and output images, while taking lightness unaltered from the input image. In contrast to “color” this blend mode does not involve clamping.
+
+

🔗others

+
+
lightness
+
Mix lightness from the input and output images, while taking color (chromaticity and hue) unaltered from the input image.
+
chromaticity
+
Mix chromaticity from the input and output images, while taking lightness and hue unaltered from the input image. This blend mode uses RGB ratios, divided by a Euclidean norm.
+
lighten
+
not available in the “RGB (scene)” color space
+
Compare the pixel values of the input and output images, and output the lighter value.
+
darken
+
not available in the “RGB (scene)” color space
+
Compare the pixel values of the input and output images, and output the darker value.
+
hue
+
not available in the “RGB (scene)” color space
+
Mix hue (color tint) from the input and output images, while taking lightness and chroma unaltered from the input image.
+
color
+
not available in the “RGB (scene)” color space
+
Mix color (chroma and hue) from the input and output images while taking lightness unaltered from the input image.
+
+

Caution: When modules drastically modify hue (e.g. when generating complementary colors) this blend mode can result in strong color noise.

+
+
coloradjustment
+
not available in the “RGB (scene)” color space
+
Some modules act predominantly on the tonal values of an image but also perform some color saturation adjustments (e.g. the levels and tone curve modules). This blend mode takes the lightness from the module’s output and mixes colors from input and output, enabling control over the module’s color adjustments.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/index.html b/en/darkroom/masking-and-blending/index.html new file mode 100644 index 0000000000..60415140f1 --- /dev/null +++ b/en/darkroom/masking-and-blending/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - masking & blending + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Darkroom / masking & blending + +
+ +
+ +
+ + + +
+
+ + +
+ +

masking & blending

+ +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/index.xml b/en/darkroom/masking-and-blending/index.xml new file mode 100644 index 0000000000..2c1b4cb21f --- /dev/null +++ b/en/darkroom/masking-and-blending/index.xml @@ -0,0 +1,25 @@ + + + + masking & blending on darktable user manual + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/ + Recent content in masking & blending on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/overview/ + Each processing module takes its input from the preceding module in the pixelpipe, performs its operation on the image data, and then hands the output to the next module in the pixelpipe. A module&rsquo;s output data can optionally be reprocessed (combined) with its input data before being handed to the next module. This additional processing step is called blending &ndash; input and output data is reprocessed using algorithms called blending operators or blend modes. + + + blend modes + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/blend-modes/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/blend-modes/ + Blend modes define how the input and output of a module are combined (blended) together before the module&rsquo;s final output is passed to the next module in the pixelpipe. Classic blending modes, designed for display-referred RGB (constrained to 0-100%), implicitly define a fulcrum at 50% (gray) or 100% (white) in their algorithms, depending on the blend mode. Because scene-referred is not subject to these restrictions, this fulcrum needs to be explicitly defined by the user when performing blending operations in the &ldquo;RGB (scene)&rdquo; color space. + + + diff --git a/en/darkroom/masking-and-blending/masks/drawn-and-parametric/index.html b/en/darkroom/masking-and-blending/masks/drawn-and-parametric/index.html new file mode 100644 index 0000000000..e873fcefc9 --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/drawn-and-parametric/index.html @@ -0,0 +1,3055 @@ + + + + + +darktable user manual - combining drawn & parametric masks + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Darkroom / masking & blending / masks / combining drawn & parametric masks + +
+ + + + +
+ +

+ combining drawn & parametric masks +

+ + + +

Drawn and parametric masks can be used in combination to form a single mask that can be applied to a module.

+

There are two main elements which control how individual masks are combined: the polarity setting of each individual mask (defined by the plus or minus buttons) and the setting in the “combine masks” combobox.

+

The “combine masks” combobox contains the following options, defining how the drawn and parametric masks will be combined:

+
+
exclusive
+
A straightforward method of combining masks, exclusive mode multiplies together the individual pixel values from each of the component masks.
+
+

For a given pixel, the final mask will have value of 0 if any of the individual masks are 0 at that location and it will only have a value of 1.0 if all masks have a value of 1.0 at that location.

+
+
+

Any individual mask can exclude a pixel by setting its value to 0, regardless of what the other masks do. Once a pixel is excluded by a mask there is no way for another mask to include it again.

+
+
inclusive
+
Inclusive mode first inverts each individual mask (subtracts its value from 1.0), multiplies the inverted masks together, and finally inverts the combined mask once again.
+
+

For a given pixel, the final mask will have a value of 1.0 if any of the individual masks are 1.0 at that location and it will only have a value of 0 if all masks have a value of 0 at that location.

+
+
+

Any individual mask can include a pixel by setting its value to 1.0, regardless of what the other masks do. Once a pixel is fully included by a mask (its value is 1.0) there is no way for another mask to exclude it again.

+
+
exclusive and inclusive inverted modes
+
Using the above combination methods alone would still be rather limiting. We gain maximum flexibility by allowing an additional inversion step for each individual mask. This is governed by the polarity buttons that you find close to the individual channels.
+
+

Toggling the polarity button of a mask inverts its values (subtracts the original value from 1.0).

+
+
+

Finally within the “combine masks” combobox you may select the exclusive & inverted or inclusive & inverted options. Each of these options is equivalent to the exclusive and inclusive modes, respectively, but with a final step that inverts the resulting mask.

+
+
+

🔗typical use cases

+
+
inclusive mode
+
For this mode you set the “combine masks” combobox to inclusive mode and make sure that all polarity buttons of all the individual channels and of the drawn mask are set to negative (-). Your starting point is a mask where all pixels have a value of zero (no pixel is selected). You now adjust the parametric mask sliders to bring more and more pixels into the selection or you draw shapes on the canvas to select specific areas of your image.
+
exclusive mode
+
In the opposite case you set the “combine masks” combobox to exclusive mode and make sure that all polarity buttons are set to positive (+). Your starting point is a mask with all values at 1.0 (all pixels are selected). You now adjust the parametric mask sliders to exclude parts of your image as needed or directly draw shapes on the canvas to exclude those areas.
+
+

For your convenience the parametric masks GUI provides a toggle button that inverts all channel polarities and toggles between inclusive and exclusive mode in the “combine masks” combobox.

+

For novice users it is recommended that you stick to the above two use cases. This means that you should decide beforehand how you want to construct your mask.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/masks/drawn/index.html b/en/darkroom/masking-and-blending/masks/drawn/index.html new file mode 100644 index 0000000000..0bdfa3ec7f --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/drawn/index.html @@ -0,0 +1,3121 @@ + + + + + +darktable user manual - drawn masks + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Darkroom / masking & blending / masks / drawn masks + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ drawn masks +

+ + + +

With the drawn mask feature you can construct a mask by drawing shapes directly onto the image canvas. Shapes can be used alone or in combination. Once a shape has been drawn on an image it can be adjusted, removed, or reused in other modules.

+

Shapes are stored internally as vectors and are rendered with the required resolution during pixelpipe processing. Shapes are expressed in the coordinate system of the original image and are transformed along with the rest of the image by any active distorting modules in the pipe (lens correction, rotate and perspective for example). This means that a shape will always work on the same image area regardless of any modifications that may be subsequently applied.

+

The controls required to create and alter drawn masks may be enabled by selecting either the “drawn mask” or “drawn & parametric mask” icon at the bottom of a module. You can also create and edit shapes using the mask manager module.

+

🔗creating shapes

+

Choose a shape by clicking on the appropriate shape icon (from left to right: circle, ellipse, path, brush, gradient).

+

+ + + + + + + + +shape icons + +

+

This will take you into the creation mode for that shape. Once you have finished drawing your shape you will automatically be taken into edit mode.

+

Ctrl+click on the shape icon to continuously draw multiple shapes of the same type – each time a shape is completed, you will re-enter creation mode for a new instance of that shape. While in continuous creation mode, right-click on the image to stop drawing shapes and enter edit mode.

+

For all drawn shapes, you can hold Shift while scrolling with the mouse wheel to change the extent of the shape’s feathering (the blur at the edge of the shape) and use Ctrl+scroll to change the shape’s opacity (how transparent it is). These operations are available in both creation and edit modes (as long as your mouse is over the shape in question).

+

By default, scrolling your mouse up increases the value of the relevant shape parameters. This behavior can be changed in preferences > darkroom > scroll down to increase mask parameters.

+
+

Note: When used in shape creation mode, the preceding scroll operations will also cause the default feathering or opacity to be changed. The new default values will be used the next time you create a new shape.

+
+

🔗editing shapes

+

Click on the ‘show and edit mask elements’ icon + + + + + + + + +show-and-edit-masks-icon + + to enter shape edit mode. This will show all drawn masks in use by the current module and allow you to edit those shapes. It will also expand the associated group in the mask manager. Ctrl+click on the same icon to enter restricted edit mode, where certain actions (e.g. dragging a complete shape or changing its size) are blocked. This is particularly useful to avoid costly mistakes when editing path and brush shapes.

+

Click and drag a shape to move it around the image canvas. Clicking on a shape will also select that shape in the mask manager.

+

🔗removing shapes

+

While in edit mode right-click on a shape to remove it.

+

🔗reusing shapes

+

You can reuse shapes that you have drawn in other modules. Click on the shapes drop-down (next to the ‘show and edit mask elements’ button) to choose previously-drawn shapes individually or to use the same group of shapes as used by another module. The following options are available for selection:

+
+
add existing shape
+
Choose either an individual shape or a group of shapes that you’ve drawn previously (either within the mask manager or from within the drawn mask of another module). If that shape or group is used elsewhere, any changes you make will be reflected everywhere the shape or group is used.
+
use same shapes as
+
Add a list of shapes used in another module to the current module’s mask. This differs from the previous option in that it creates a new group of shapes, allowing shapes to be added to or removed from the group independently of the module from which they were copied. All shapes that are common to both groups remain linked.
+
+

🔗combining and managing shapes

+

The mask manager module can be used to manage your drawn shapes. This module also allows you to group and combine drawn masks using set operators (union, intersection, difference, exclusion).

+

🔗shape distortions

+

In order to ensure a consistent co-ordinate system, when you place a shape on the image, it is actually drawn on the original RAW file. This shape then passes up through the pixelpipe before finally being used by the module and drawn on the screen. This means that, if you have any enabled any distorting modules (such as lens correction), drawn shapes may appear distorted on the screen and in the final image. This can lead, for example, to circles being rendered as ellipses and gradient lines becoming curved. If you need to create a more accurate shape (to overcome these distortions) it is recommended that you avoid using the simple shapes (circles / ellipses) in favor of the path shape (which can be drawn using more points, reducing distortions). You can adjust the curve on gradient lines to overcome the simple distortions introduced by lens correction.

+

🔗available shapes

+
+
circle
+
Click on the image canvas to place the circle. Scroll while hovering over the circle to change its diameter. Scroll while hovering over the circle’s border to change the width of the feathering (the same effect as holding Shift while scrolling with the mouse wheel within the main shape).
+
ellipse
+
The general principle is the same as for the circle shape. In addition, four nodes are shown on the ellipse line. Click and drag the nodes to adjust the ellipse’s eccentricity. Ctrl+click and drag the nodes or use Shift+Ctrl+scroll (with the mouse wheel) to rotate the ellipse. Shift+click within the shape to toggle the gradual decay between equidistant and proportional mode.
+
path
+
Click on the image canvas to place three or more nodes and generate a free-format enclosed shape. Terminate the path by right-clicking after having set the last point. By default, nodes are connected with smooth lines. If you want a node to instead define a sharp corner, you can do so by creating it with Ctrl+click.
+
+

In edit mode Ctrl+click on an existing node to convert it from smooth to sharp corners and vice versa. Ctrl+click on one of the line segments to insert an additional node. Right-click on a node to delete it. Take care to ensure that the mouse pointer is over the desired node and the node is highlighted, to avoid accidentally removing the whole path.

+
+
+

The size of the completed shape can be modified by scrolling. The same holds true for the width of the border (the area with a gradual opacity decay), which can also be changed with Shift+scroll (with the mouse wheel) from anywhere within the shape. Single nodes as well as path segments can be moved by dragging them with the mouse. If a node is selected by clicking on it, a further control point appears which allows you to modify the curvature of the line (reset to default by right-clicking). Dragging one of the control points on the border adjusts the border width just in that part of the shape.

+
+
+

Consider fine-tuning paths in restricted edit mode (enabled by Ctrl+clicking on the ‘show and edit mask elements’ icon). This allows you to adjust single nodes and segments without the risk of accidentally shifting or resizing the whole shape.

+
+
brush
+
Start drawing a brush stroke by left-clicking on the image canvas and moving the mouse while keeping the button pressed. The brush stroke is finalized once you release the mouse button. Scroll the mouse to change the shape size and Shift+scroll to change the feathering (hardness), either before you start drawing or at any time during the operation. Likewise you can use the “{” and “}” keys to decrease/increase hardness, and the “<” and “>” keys to decrease/increase opacity.
+
+

If you have a graphics tablet with pen pressure sensitivity, darktable can apply the recorded pen pressure to certain attributes of the brush stroke. This operation can be controlled in preferences > darkroom > pen pressure control for brush masks.

+
+
+

On lifting the tablet pen or releasing the left mouse button the brush stroke is converted into a number of connected nodes, which define the final shape. A configuration option (preferences > darkroom > smoothing of brush strokes) controls how much smoothing is applied. A higher level of smoothing leads to fewer nodes being created – this eases subsequent editing at the expense of lower accuracy.

+
+
+

Nodes and segments of a brush stroke can be modified individually. See the documentation on path shapes (above) for more details. Change the size or hardness of a node by scrolling and Shift+scrolling over a node, respectively.

+
+
+
+

Note: Rendering a complex brush shape can consume a significant number of CPU cycles. Consider using the circle, ellipse or path shapes instead where possible.

+
+
+
gradient
+
The gradient shape is a linear gradient which extends from a given point to the edge of the image.
+
+

Click on the image canvas to define the position of the line that defines 50% opacity. Dotted lines indicate the distance beyond which the opacity is 100% and 0%. Between these dotted lines the opacity changes linearly.

+
+
+

The line has two anchor nodes which you can drag to change the rotation of the gradient. You can also set the rotation angle when placing the gradient shape by clicking and dragging to place the shape.

+
+
+

Gradient lines can also be curved by scrolling with your mouse while hovering close to the center line. This can be useful to counteract the distortion caused by the lens correction module.

+
+
+

Depending on the module and the underlying image, using a gradient shape might provoke banding artifacts. You should consider activating the dither or posterize module to alleviate this.

+
+
+

🔗reversing the polarity of a drawn mask

+

Click on the “+/-” button to reverse the polarity of the entire drawn mask. For example, a circular mask will, by default, cause the module to be applied only to the area inside the drawn circle. Reversing its polarity will cause the module to apply to the whole image, except for that circle.

+

🔗panning and zooming the image

+

While creating or editing a shape, mouse actions are applied to the current shape. If you need to move or zoom the portion of the image shown in the center view, hold down the ‘a’ key while dragging the mouse or using the scroll wheel. While the key is held down, the mouse actions will apply to the entire image rather than the current shape.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/masks/drawn/shape-edit.png b/en/darkroom/masking-and-blending/masks/drawn/shape-edit.png new file mode 100644 index 0000000000..b6fa4700d4 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/drawn/shape-edit.png differ diff --git a/en/darkroom/masking-and-blending/masks/drawn/shape-icons.png b/en/darkroom/masking-and-blending/masks/drawn/shape-icons.png new file mode 100644 index 0000000000..67b2a85031 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/drawn/shape-icons.png differ diff --git a/en/darkroom/masking-and-blending/masks/index.html b/en/darkroom/masking-and-blending/masks/index.html new file mode 100644 index 0000000000..46e05772eb --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/index.html @@ -0,0 +1,3052 @@ + + + + + +darktable user manual - masks + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/masks/index.xml b/en/darkroom/masking-and-blending/masks/index.xml new file mode 100644 index 0000000000..8182deb9c3 --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/index.xml @@ -0,0 +1,53 @@ + + + + masks on darktable user manual + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/ + Recent content in masks on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/overview/ + Masks allow you to limit the effect of a module so that it only applies to certain parts of the image. A mask can be regarded as a grayscale image where each pixel has a value between 0 and 1.0 (or between 0% and 100%). This value is the opacity and is used to determine how much a module affects each pixel. The following sections explain how to construct masks in darktable. + + + drawn masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn/ + With the drawn mask feature you can construct a mask by drawing shapes directly onto the image canvas. Shapes can be used alone or in combination. Once a shape has been drawn on an image it can be adjusted, removed, or reused in other modules. Shapes are stored internally as vectors and are rendered with the required resolution during pixelpipe processing. Shapes are expressed in the coordinate system of the original image and are transformed along with the rest of the image by any active distorting modules in the pipe (lens correction, rotate and perspective for example). + + + parametric masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/parametric/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/parametric/ + The parametric mask feature offers fine-grained selective control over how individual pixels are masked. It does this by automatically generating an intermediate blend mask from user-defined parameters. These parameters are color coordinates rather than the geometrical coordinates used in drawn masks. For each data channel of a module (e.g. Lab, RGB) and several virtual data channels (e.g. hue, saturation) you can construct a per-channel opacity function. Depending on each pixel&rsquo;s value for a given data channel this function calculates a blending factor between 0 and 1 (100%) for that pixel. + + + combining drawn & parametric masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn-and-parametric/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn-and-parametric/ + Drawn and parametric masks can be used in combination to form a single mask that can be applied to a module. There are two main elements which control how individual masks are combined: the polarity setting of each individual mask (defined by the plus or minus buttons) and the setting in the “combine masks” combobox. The &ldquo;combine masks&rdquo; combobox contains the following options, defining how the drawn and parametric masks will be combined: + + + mask refinement & additional controls + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/refinement-controls/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/refinement-controls/ + When a parametric or drawn mask is active, several additional sliders are shown which allow the mask to be further refined. details threshold This control allows you to alter the opacity of the mask based on the amount of detail in the image. Use this slider to select either areas with lots of detail (positive values) or areas that are flat and lacking in detail (negative values). The default (zero) effectively bypasses details refinement. + + + raster masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/raster/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/raster/ + As described in the previous sections, the final output of a module&rsquo;s mask (the combined effect of any drawn and parameteric masks) is a grayscale raster image representing the extent to which the module&rsquo;s effect should be applied to each pixel. This raster image is stored internally for active modules and can be subsequently reused by other modules in the pixelpipe. As with any mask, if the opacity value for a pixel in a raster mask is zero the module&rsquo;s input passed through the module unchanged. + + + diff --git a/en/darkroom/masking-and-blending/masks/overview/index.html b/en/darkroom/masking-and-blending/masks/overview/index.html new file mode 100644 index 0000000000..4b81d4a4ec --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/overview/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Darkroom / masking & blending / masks / overview + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ overview +

+ + + +

Masks allow you to limit the effect of a module so that it only applies to certain parts of the image.

+

A mask can be regarded as a grayscale image where each pixel has a value between 0 and 1.0 (or between 0% and 100%). This value is the opacity and is used to determine how much a module affects each pixel.

+

The following sections explain how to construct masks in darktable.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/masks/parametric/blendif_2a.png b/en/darkroom/masking-and-blending/masks/parametric/blendif_2a.png new file mode 100644 index 0000000000..6439183994 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/parametric/blendif_2a.png differ diff --git a/en/darkroom/masking-and-blending/masks/parametric/blendif_2b.png b/en/darkroom/masking-and-blending/masks/parametric/blendif_2b.png new file mode 100644 index 0000000000..1c0f0c244f Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/parametric/blendif_2b.png differ diff --git a/en/darkroom/masking-and-blending/masks/parametric/blendif_3a.png b/en/darkroom/masking-and-blending/masks/parametric/blendif_3a.png new file mode 100644 index 0000000000..e6699d07a6 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/parametric/blendif_3a.png differ diff --git a/en/darkroom/masking-and-blending/masks/parametric/blendif_3b.png b/en/darkroom/masking-and-blending/masks/parametric/blendif_3b.png new file mode 100644 index 0000000000..e6c7b1d618 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/parametric/blendif_3b.png differ diff --git a/en/darkroom/masking-and-blending/masks/parametric/index.html b/en/darkroom/masking-and-blending/masks/parametric/index.html new file mode 100644 index 0000000000..ffa408c1e1 --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/parametric/index.html @@ -0,0 +1,3111 @@ + + + + + +darktable user manual - parametric masks + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Darkroom / masking & blending / masks / parametric masks + +
+ + + + +
+ +

+ parametric masks +

+ + + +

The parametric mask feature offers fine-grained selective control over how individual pixels are masked. It does this by automatically generating an intermediate blend mask from user-defined parameters. These parameters are color coordinates rather than the geometrical coordinates used in drawn masks.

+

For each data channel of a module (e.g. Lab, RGB) and several virtual data channels (e.g. hue, saturation) you can construct a per-channel opacity function. Depending on each pixel’s value for a given data channel this function calculates a blending factor between 0 and 1 (100%) for that pixel.

+

Each pixel of an image thus has different blending factors for each of its data channels. All blending factors are finally multiplied together (pixel-by-pixel), along with the value of the global opacity slider, to form a complete parametric blend mask for the image.

+

If the blend mask has a value of 0 for a given pixel, the input of the module is left unchanged. If the blend mask has a value of 1 (100%) for a pixel, the module has its full effect.

+

🔗channel tabs

+

Click on one of the channel tabs to select a data channel to use to build your mask.

+

Modules acting in (display-referred) Lab color space have data channels for L, a, b, C (chroma of LCh) and h (hue of LCh).

+

Modules acting in display-referred RGB color space have data channels for g (gray), R, G, B, H (hue of HSL), S (saturation of HSL), and L (lightness of HSL).

+

Modules acting in scene-referred RGB color space have data channels for g (gray), R, G, B, Jz (luminance component of JzCzhz), Cz (chroma, or saturation, of JzCzhz), and hz (hue of JzCzhz). The g (gray) value is calculated as a weighted average of the R, G & B channels, the exact weightings depending on the working color space being used. The JzCzhz color space is a polar representation of the Jzazbz color space, in the same way that LCh is a polar representation of the Lab space. Like the L in Lab color space, the Jz is a representation of the luminosity of a pixel that aligns with how we perceive brightness. However, the Jzazbz color space is much better for high dynamic range images and is less susceptible to hue shifts than Lab space.

+

See Wikipedia for more details about these color spaces.

+

Two sliders can be shown for each associated data channel: one that works on the input data that the module receives and one that works on the output data that the module produces prior to blending. The sliders for the output data channels are hidden by default and can be shown using the show output channels option in the blending menu.

+

The boost factor slider allows the range of values targeted by the parametric mask sliders to be extended. It may be used in scene referred editing, where luminance values may extend beyond 100%, to target highlights. This slider is only available for channels where it is meaningful.

+

+ + + + + + + + +input and output sliders + +

+

🔗inspecting data channels & masks

+

Press the letter C while hovering over a channel’s input/output slider to view the input/output image data for that color channel. The center image changes to display that color channel either in gray-scale values or in false colors depending on the setting in preferences > darkroom > display of individual color channels.

+

Press the letter M to see the resulting mask for that slider overlaid on the image.

+

When the mouse pointer leaves the slider the image returns to normal after a short delay.

+

🔗linear / log mode

+

Press the letter A while hovering over the a slider to change its display to ’log’ mode. This provides more fine control in the shadows. Press A again to toggle back to ’linear’ mode.

+

🔗channel input/output sliders

+

With each color channel slider you can construct a trapezoidal opacity function. For this purpose there are four markers per slider. Two filled triangles above the slider mark the range of values where opacity is 1. Two open triangles below the slider mark the range values where opacity is 0. Intermediate points between full and zero are given a proportional opacity.

+

The filled triangles, or inside markers, indicate the closed (mostly narrower) edge of the trapezoidal function. The open triangles, or outside markers, indicate the open (mostly wider) edge of the trapezoidal function. The sequence of the markers always remains unchanged: they can touch one another but they cannot switch position.

+

A polarity (+/-) button to the right of each the slider switches between “range select” and “range de-select” modes, with visual confirmation provided by exchanging the upper and lower triangle markers. These two types of trapezoidal functions are represented graphically in the following images.

+

range select

+

+ + + + + + + + +range select slider + +

+

+ + + + + + + + +range select graph + +

+

range deselect

+

+ + + + + + + + +range deselect slider + +

+

+ + + + + + + + +range deselect graph + +

+

In their default state all markers are at their extreme positions.

+

In this state a range select function selects the whole range of values giving an “all at 100%” mask. Starting from there one can move the sliders inwards to gradually exclude more and more parts of the image except for the remaining narrow range.

+

Conversely a range de-select function (enabled by toggling the polarity) by default deselects the whole range of values, giving an “all-zero” mask as a starting point. Moving the sliders inwards gradually includes more and more parts of the image except for the remaining narrow range.

+

🔗pickers

+

With the left-hand picker button you can select a point or area probe from your image. The corresponding values for the real and virtual data channels are then displayed within each color channel slider.

+

With the right-hand picker button you can automatically set the slider’s values based on the selected range. Click and drag to set the parameters for the input slider from the drawn rectangle; Ctrl+click and drag to set the parameters for the output slider.

+

🔗invert

+

Click the invert button above the sliders to invert the polarity of the entire parametric mask. This differs from the polarity buttons beside the individual sliders which just invert the parameters for the current slider/channel.

+

🔗reset

+

Click the reset button above the sliders to revert all parametric mask parameters to their default state.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/masks/parametric/input-output-sliders.png b/en/darkroom/masking-and-blending/masks/parametric/input-output-sliders.png new file mode 100644 index 0000000000..9d47cf242a Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/parametric/input-output-sliders.png differ diff --git a/en/darkroom/masking-and-blending/masks/raster/index.html b/en/darkroom/masking-and-blending/masks/raster/index.html new file mode 100644 index 0000000000..5f4e86ad5c --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/raster/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - raster masks + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Darkroom / masking & blending / masks / raster masks + +
+ + + + +
+ +

+ raster masks +

+ + + +

As described in the previous sections, the final output of a module’s mask (the combined effect of any drawn and parameteric masks) is a grayscale raster image representing the extent to which the module’s effect should be applied to each pixel. This raster image is stored internally for active modules and can be subsequently reused by other modules in the pixelpipe.

+

As with any mask, if the opacity value for a pixel in a raster mask is zero the module’s input passed through the module unchanged. If the opacity is 1.0 the module has its full effect. For each value between 0 and 1.0 the module’s effect is applied proportionally at that location.

+

You can choose a raster mask from the combobox. Raster masks can be identified by the name of the module against which they were originally generated.

+
+

Note: Raster masks are generated as part of a module’s internal processing. Once a module’s processing is complete its mask then becomes available to subsequent modules in the pixelpipe.

+

This has two implications:

+
    +
  1. +

    Raster masks cannot be generated by disabled modules since they do not participate in pixelpipe processing. As soon as you disable a module, its mask is no longer available for use.

    +
  2. +
  3. +

    Raster masks are passed up the pixelpipe after module processing – they can only be used by modules that come later in the pipe than the generating module.

    +
  4. +
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/masks/refinement-controls/feathering.png b/en/darkroom/masking-and-blending/masks/refinement-controls/feathering.png new file mode 100644 index 0000000000..f3fa1e48b8 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/refinement-controls/feathering.png differ diff --git a/en/darkroom/masking-and-blending/masks/refinement-controls/icon-eye.png b/en/darkroom/masking-and-blending/masks/refinement-controls/icon-eye.png new file mode 100644 index 0000000000..17eb43db38 Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/refinement-controls/icon-eye.png differ diff --git a/en/darkroom/masking-and-blending/masks/refinement-controls/icon-mask.png b/en/darkroom/masking-and-blending/masks/refinement-controls/icon-mask.png new file mode 100644 index 0000000000..ed3b3ee7be Binary files /dev/null and b/en/darkroom/masking-and-blending/masks/refinement-controls/icon-mask.png differ diff --git a/en/darkroom/masking-and-blending/masks/refinement-controls/index.html b/en/darkroom/masking-and-blending/masks/refinement-controls/index.html new file mode 100644 index 0000000000..591dc4995c --- /dev/null +++ b/en/darkroom/masking-and-blending/masks/refinement-controls/index.html @@ -0,0 +1,3100 @@ + + + + + +darktable user manual - mask refinement & additional controls + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Darkroom / masking & blending / masks / mask refinement & additional controls + +
+ + + + +
+ +

+ mask refinement & additional controls +

+ + + +

When a parametric or drawn mask is active, several additional sliders are shown which allow the mask to be further refined.

+
+
details threshold
+
This control allows you to alter the opacity of the mask based on the amount of detail in the image. Use this slider to select either areas with lots of detail (positive values) or areas that are flat and lacking in detail (negative values). The default (zero) effectively bypasses details refinement. This is mostly useful to apply sharpening and blurring effects that ignore out-of-focus (bokeh) regions or to sharpen only blurry parts, preventing over-sharpening of in-focus regions.
+
+
+

Note: The data used for the detail mask refinement is taken from the demosaic stage in the processing pipeline, and not from the module’s input (which is used for the other parametric mask criteria). None of the processing modules after demosaic will have any effect on the detail mask and it is not currently available for non-RAW images.

+
+
+
feathering guide
+
Mask feathering smooths a drawn or parametric mask such that the mask’s edges automatically align with the edges of features in the image. The smoothing is guided either by the module’s input or output (before blending), and may happen before or after the mask blurring, depending on what is selected in the “feathering guide” combobox. Feathering is particularly sensitive to the choice of guide image when used with edge-modifying modules (modules for sharpening or blurring an image).
+
    +
  • output before blur: feathering is guided using the output image of the module and takes place before the mask is blurred
  • +
+
+
    +
  • input before blur: feathering is guided using the input image of the module and takes place before the mask is blurred
  • +
+
+
    +
  • output after blur: feathering is guided using the output image of the module and takes place after the mask has been blurred
  • +
+
+
    +
  • input after blur: feathering is guided using the input image of the module and takes place after the mask has been blurred
  • +
+
+
feathering radius
+
Adjust the strength of the feathering effect. Feathering works best if the mask’s edges already approximately match some edges in the guiding image. The larger the “feathering radius” the better the feathering algorithm can align the mask to more distant edges. If this radius is too large, however, the feathered mask may overshoot (cover regions that the user wants to exclude). Feathering is disabled when the feathering radius is set to 0.
+
blurring radius
+
Blurring the mask creates a softer transition between blended and unblended parts of an image and can be used to avoid artifacts. The blurring radius slider controls the radius of a gaussian blur applied to the final blend mask. The higher the radius, the stronger the blur (set to 0 for an unblurred mask). Mask blur is always applied after feathering if both kinds of mask adjustment are activated. This allows any resulting sharp edges or artifacts to be smoothed.
+
mask opacity
+
The strength of the module’s effect is determined by the mask’s local opacity. Feathering and blurring the mask may reduce the opacity of the original mask. The “mask opacity” slider allows you to readjust the mask opacity to compensate. If the mask opacity is decreased (negative slider values) less opaque parts are affected more strongly. Conversely, if the mask opacity is increased (positive slider values) more opaque parts are affected more strongly. As a consequence, completely opaque portions of the mask always remain opaque and completely transparent portions always remain transparent. This is to ensure that regions that have been fully excluded from or included in a module’s effect (by setting the mask’s opacity to 0% or 100%) remain fully excluded or included.
+
mask contrast
+
This slider increases or decreases the mask contrast. This allows you to adjust the transition between the opaque and transparent parts of the mask.
+
+ + + + + + + + +eye icon + + temporarily switch off mask
+
Sometimes it is useful to visualize a module’s effect without the mask being active. Click on this icon to temporarily deactivate the mask (the selected blend mode and global opacity remain in effect).
+
+ + + + + + + + +mask icon + + display mask
+
Click on this icon to display the current mask as a yellow overlay over a black-and-white version of the image. Solid yellow indicates an opacity of 100%; a fully visible gray background image (without yellow overlay) indicates an opacity of 0%.
+
+

🔗example: feathering a drawn mask

+

+ + + + + + + + +feathering + +

+

It can be rather tedious to create a drawn mask that precisely covers a particular feature in an image. In this example, we want to enhance the color contrast of the lion sculpture shown in the left image above without affecting the background.

+
    +
  1. The first image above shows the original, unaltered image.
  2. +
  3. The second image shows a rough selection of the sculpture created with a drawn mask. Note that the mask is rather fuzzy and does not precisely follow the outline of the lion sculpture.
  4. +
  5. The third image shows the effect of adjusting the feathering radius, mask opacity and mask contrast, leading to a well matched mask with little effort. In this example the feathering radius has been adjusted to 50 and a blur radius of 5 was chosen to smooth the mask to some degree. The mask opacity and mask contrast have been increased to 0.3 and 0.5, respectively.
  6. +
  7. The final image above shows the end result, where the color enhancement (via the color contrast module) is restricted to only the lion sculpture.
  8. +
+

Mask feathering works particularly well in this example because the sculpture is well separated from the out-of-focus background. The distinct edge at the border of the sculpture guides the feathering mask adjustment to match the shape of the sculpture.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/overview/index.html b/en/darkroom/masking-and-blending/overview/index.html new file mode 100644 index 0000000000..c50a69dfb4 --- /dev/null +++ b/en/darkroom/masking-and-blending/overview/index.html @@ -0,0 +1,3073 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / masking & blending / overview + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ overview +

+ + + +

Each processing module takes its input from the preceding module in the pixelpipe, performs its operation on the image data, and then hands the output to the next module in the pixelpipe.

+

A module’s output data can optionally be reprocessed (combined) with its input data before being handed to the next module. This additional processing step is called blending – input and output data is reprocessed using algorithms called blending operators or blend modes.

+

Each blend mode is further controlled by the opacity parameter (having a value between 0% and 100%) which defines how much the input and output images contribute to the final result. Typically an opacity of 0% outputs an image which is identical to the input image (the module has no effect) whereas an opacity of 100% delivers the maximum effect of the module.

+

This opacity can be the same for every pixel (using the global opacity slider), in which case blending acts uniformly over the entire image. Alternatively the opacity values can vary depending on the properties or location of each pixel. This local modification of opacity is called a mask. Masks provide the user with fine control over which parts of an image are affected by a module and to what extent. The user may choose to activate a drawn mask, a parametric mask or a combination.

+

Blending and masking functionality is controlled via a group of icons located at the bottom of each applicable module.

+

+ + + + + + + + +mask &amp; blend options + +

+

These icons enable the following masking and blending options, from left to right:

+
+
off
+
Module output is passed to the next module in the pixelpipe without additional reprocessing. No further controls are displayed.
+
uniformly
+
Input and output images are reprocessed uniformly with the chosen blend mode, where the amount of blending is controlled by a single opacity slider. Additional controls are displayed to allow the blend mode and opacity to be selected. The default is a blend mode of “normal” with an opacity of 100%.
+
drawn mask
+
Reprocessing takes place with the chosen blend mode and an opacity based on pixel location as defined by one or more drawn shapes. Additional controls are displayed to allow mask elements to be drawn. If no mask elements are drawn then all pixels have the same opacity, as defined by the opacity slider.
+
parametric mask
+
Reprocessing takes place with the chosen blend mode and an opacity based on the properties of individual pixels. Additional controls are displayed to allow the opacity to be adjusted on a per-pixel basis, determined by pixel values.
+
drawn & parametric mask
+
Reprocessing takes place with the chosen blend mode and an opacity based on a combination of a drawn and parametric mask.
+
raster mask
+
Reprocessing takes place with the chosen blend mode and an opacity based on a mask that was generated by an active module earlier in the pixelpipe.
+
blending options
+
Choose which color space to use when calculating the blending mask, and specify whether or not to allow a mask to be generated based on the module’s output channels (normally a parametric mask is generated based on the input channels coming into the module). The following options are available:
+
    +
  • reset to default blend colorspace: Use the default color space for the module to specify the parametric mask.
  • +
+
+
    +
  • Lab: Use the Lab color space (where available) to specify the parametric mask.
  • +
+
+
    +
  • RGB (display): Use the display-referred RGB/HSL color space to specify the parametric mask.
  • +
+
+
    +
  • RGB (scene): Use the scene-referred RGB/JzCzhz color space to specify the parametric mask.
  • +
+
+
    +
  • show output channels: Show the parametric mask output channel controls, so that the parametric mask can be defined in terms of the module’s output channels.
  • +
+
+
+
+

Note: Not all of these blending options are available for every module.

+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/masking-and-blending/overview/mask-blend-options.png b/en/darkroom/masking-and-blending/overview/mask-blend-options.png new file mode 100644 index 0000000000..c5573e0967 Binary files /dev/null and b/en/darkroom/masking-and-blending/overview/mask-blend-options.png differ diff --git a/en/darkroom/organization/index.html b/en/darkroom/organization/index.html new file mode 100644 index 0000000000..9919813b2b --- /dev/null +++ b/en/darkroom/organization/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - organization + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Darkroom / organization + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

organization

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/organization/index.xml b/en/darkroom/organization/index.xml new file mode 100644 index 0000000000..39c93170ea --- /dev/null +++ b/en/darkroom/organization/index.xml @@ -0,0 +1,39 @@ + + + + organization on darktable user manual + https://darktable-org.github.io/dtdocs/en/darkroom/organization/ + Recent content in organization on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/organization/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/overview/ + Processing modules are organized and accessed via the right-hand panel in the darkroom: Click on the icons at the top of this panel to reveal, from left to right, quick access panel A customizable panel allowing quick access to commonly-used module controls. active modules A group containing the modules that are currently active in the pixelpipe. Right-click to show all modules that are present in the history stack within the active group, regardless of whether or not they are actually active. + + + module groups + https://darktable-org.github.io/dtdocs/en/darkroom/organization/module-groups/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/module-groups/ + A number of pre-defined module groups are shipped with darktable and are selectable as presets. These are summarized below. All of these presets (with the exception of modules: deprecated and search only) also include the quick access panel. All except the modules: deprecated group include the search bar. 🔗modules: all This preset contains all modules, sorted according to the traditional module groupings used prior to darktable 3.4, as follows: base modules The minimal set of modules normally required to render a presentable image. + + + quick access panel + https://darktable-org.github.io/dtdocs/en/darkroom/organization/quick-access-panel/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/quick-access-panel/ + The quick access panel allows you to access widgets from a number of processing modules all in one place. You can add new widgets to the panel by right-clicking on the &ldquo;hamburger&rdquo; icon at the top-left of the panel using the manage module layouts screen Ctrl+clicking on a widget in a processing module while in visual shortcut mapping mode Click on the icon to the right of the module name to open the full version of that module. + + + manage module layouts + https://darktable-org.github.io/dtdocs/en/darkroom/organization/manage-module-layouts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/manage-module-layouts/ + Manage the layout and grouping of processing modules and the quick access panel. This maintenance screen can be accessed from the presets menu beside the module search box or module group icons (below the scopes module in the darkroom view). Ctrl+click on the preset menu to open this screen directly. Settings are automatically saved when you exit the screen. Click reset to abandon any changes made in the current editing session. + + + diff --git a/en/darkroom/organization/manage-module-layouts/index.html b/en/darkroom/organization/manage-module-layouts/index.html new file mode 100644 index 0000000000..5b26fe1c68 --- /dev/null +++ b/en/darkroom/organization/manage-module-layouts/index.html @@ -0,0 +1,3072 @@ + + + + + +darktable user manual - manage module layouts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / organization / manage module layouts + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ manage module layouts +

+ + + +

Manage the layout and grouping of processing modules and the quick access panel.

+

+ + + + + + + + +manage module layouts + +

+

This maintenance screen can be accessed from the presets menu beside the module search box or module group icons (below the scopes module in the darkroom view). Ctrl+click on the preset menu to open this screen directly.

+

Settings are automatically saved when you exit the screen. Click reset to abandon any changes made in the current editing session.

+

🔗module controls

+

🔗global controls

+

The following global controls are available in the top panel of the screen.

+
+
preset
+
Select an existing module group preset.
+
remove
+
Remove the current preset (user-defined presets only).
+
duplicate
+
Duplicate the current preset with a new name. The above example shows a new preset named “user defined”, which has been created by duplicating the “modules: default” preset.
+
rename
+
Rename the current preset (user-defined presets only). Right-click to bring up a menu that can be used to copy, paste, select all, delete or insert an emoji).
+
new
+
Create a new preset containing a minimal list of modules.
+
show search line
+
Choose whether to display the search bar below the module group icons
+
show quick access panel
+
Choose whether to display the quick access panel. If checked, a new entry will appear in the bottom panel to allow you to add or remove widgets.
+
show all history modules in active group
+
Select this to show all modules that are present in the history stack within the active group, regardless of whether or not they are actually active.
+
auto-apply this preset
+
Module group presets can be automatically applied based on the type of image being worked on. The check box indicates whether this preset currently has any auto-apply rules. Click on the gear icon to amend the auto-apply settings. See presets for details.
+
+

🔗module groups

+

The bottom panel of the screen allows you to alter the quick access panel and module groups for the selected preset (user-defined presets only).

+
+
add a group
+
Click on the + sign beside the “module groups” label to add a new group.
+
remove a group
+
Remove a group by clicking on the X button beside the group name.
+
add a module/widget
+
Add a module to a group, or a widget to the quick access panel, by clicking the + sign below the group name. Select the required module/widget from the displayed list.
+
remove a module/widget
+
Remove a module from a group, or a widget from the quick access panel, by clicking the X beside the module/widget name.
+
change a group’s icon
+
Change the icon assigned to a group by clicking on the existing group icon and selecting a new one from the displayed list.
+
change the group order
+
Change the order in which the groups are displayed by clicking on the < and > buttons below the group names.
+
rename a group
+
Rename a module group by clicking on the group name and typing. Right-click to bring up a menu that can be used to copy, paste, select all, delete or insert an emoji)
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/organization/manage-module-layouts/manage-module-layouts.png b/en/darkroom/organization/manage-module-layouts/manage-module-layouts.png new file mode 100644 index 0000000000..c34c78abf3 Binary files /dev/null and b/en/darkroom/organization/manage-module-layouts/manage-module-layouts.png differ diff --git a/en/darkroom/organization/module-groups/index.html b/en/darkroom/organization/module-groups/index.html new file mode 100644 index 0000000000..d4f77ce772 --- /dev/null +++ b/en/darkroom/organization/module-groups/index.html @@ -0,0 +1,3208 @@ + + + + + +darktable user manual - module groups + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / organization / module groups + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ module groups +

+ + + +

A number of pre-defined module groups are shipped with darktable and are selectable as presets. These are summarized below.

+

All of these presets (with the exception of modules: deprecated and search only) also include the quick access panel. All except the modules: deprecated group include the search bar.

+

🔗modules: all

+

This preset contains all modules, sorted according to the traditional module groupings used prior to darktable 3.4, as follows:

+
+
+ + + + + + + + +module-group-basic-icon + + base modules
+
The minimal set of modules normally required to render a presentable image.
+
+ + + + + + + + +module-group-tone-icon + + tone modules
+
Other modules related to tone levels and contrast.
+
+ + + + + + + + +module-group-color-icon + + color modules
+
Modules related to color grading and color profiles.
+
+ + + + + + + + +module-group-correct-icon + + corrective modules
+
Modules related to correcting problems such as lens distortions, sensor noise, sharpening, etc.
+
+ + + + + + + + +module-group-effects-icon + + (special) effects modules
+
“Special effect” modules such as bloom, diffuse or sharpen, etc.
+
+

🔗workflow: scene-referred & workflow: display-referred

+

These presets define groups of modules relevant to the scene-referred and display-referred workflows, sorted into groups as shown below:

+
+
+ + + + + + + + +module-group-basic-icon + + base modules
+
A basic set of modules to adjust the cropping/orientation, adjust the exposure, and apply tone mappings and contrast as appropriate to the workflow.
+
+ + + + + + + + +module-group-color-icon + + color modules
+
Modules relating to color grading and color saturation.
+
+ + + + + + + + +module-group-correct-icon + + corrective modules
+
Modules relating to correcting problems relating to lens distortions, sensor noise, sharpening, retouching, etc.
+
+ + + + + + + + +module-group-effects-icon + + (special) effects modules
+
“Special effect” modules such as watermark, framing, vignetting, etc.
+
+

🔗workflow: beginner

+

This preset provides a minimal set of modules targeted as a starting point for beginners. It is suggested that beginners start by copying this minimal preset, and add to it as they gain experience with other modules.

+
+
+ + + + + + + + +module-group-basic-icon + + base modules
+
A basic set of modules to adjust the cropping/orientation, adjust the exposure, and apply a basic tone mapping.
+
+ + + + + + + + +module-group-grading-icon + + grading modules
+
Modules dealing with creative tone and color grading.
+
+ + + + + + + + +module-group-effects-icon + + (special) effects modules
+
“Special effect” modules such as retouch, sharpen, watermark, etc.
+
+

🔗previous config

+

These presets are automatically generated for users who have upgraded from a version of darktable prior to 3.4. Where you have previously set up favourites or altered the hidden flag on modules, these presets contains those customizations, retaining the legacy module groups (previous config preset) or new module groups (previous config with new layout preset).

+

If favourites were created in prior versions these will remain available in an additional group:

+
+
+ + + + + + + + +module-group-favourites-icon + + favourite modules
+
This group was previously used by users to make it easier to find frequently-used modules, and is available under the “previous config” presets. New users can, of course, still create their own custom group and name it “favourites” if they so desire.
+
+

🔗search only

+

This preset does not include any module groupings. Modules may only be accessed using the search facility.

+

🔗modules: deprecated

+

This preset contains a list of deprecated modules. This is the only way to access deprecated modules for new edits but be warned: these modules will be removed for new edits in the next release of darktable. This group cannot be duplicated and the modules within it cannot be added to user-created groups.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/organization/module-groups/module-group-basic-icon.png b/en/darkroom/organization/module-groups/module-group-basic-icon.png new file mode 100644 index 0000000000..1bf8cad62b Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-basic-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-color-icon.png b/en/darkroom/organization/module-groups/module-group-color-icon.png new file mode 100644 index 0000000000..d4d398e508 Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-color-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-correct-icon.png b/en/darkroom/organization/module-groups/module-group-correct-icon.png new file mode 100644 index 0000000000..669dec412b Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-correct-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-effects-icon.png b/en/darkroom/organization/module-groups/module-group-effects-icon.png new file mode 100644 index 0000000000..b6abc16ede Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-effects-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-favorites-icon.png b/en/darkroom/organization/module-groups/module-group-favorites-icon.png new file mode 100644 index 0000000000..e16a72b5a1 Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-favorites-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-grading-icon.png b/en/darkroom/organization/module-groups/module-group-grading-icon.png new file mode 100644 index 0000000000..f5703d88dc Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-grading-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-technical-icon.png b/en/darkroom/organization/module-groups/module-group-technical-icon.png new file mode 100644 index 0000000000..f1de2f53b5 Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-technical-icon.png differ diff --git a/en/darkroom/organization/module-groups/module-group-tone-icon.png b/en/darkroom/organization/module-groups/module-group-tone-icon.png new file mode 100644 index 0000000000..896e3df08c Binary files /dev/null and b/en/darkroom/organization/module-groups/module-group-tone-icon.png differ diff --git a/en/darkroom/organization/overview/index.html b/en/darkroom/organization/overview/index.html new file mode 100644 index 0000000000..f3688503b6 --- /dev/null +++ b/en/darkroom/organization/overview/index.html @@ -0,0 +1,3066 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / organization / overview + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ overview +

+ + + +

Processing modules are organized and accessed via the right-hand panel in the darkroom:

+

+ + + + + + + + +organization + +

+

Click on the icons at the top of this panel to reveal, from left to right,

+
+
+ + + + + + + + +quick access + + quick access panel
+
A customizable panel allowing quick access to commonly-used module controls.
+
+ + + + + + + + +module-group-active-icon + + active modules
+
A group containing the modules that are currently active in the pixelpipe. Right-click to show all modules that are present in the history stack within the active group, regardless of whether or not they are actually active.
+
module groups
+
One or more groups of processing modules. These groups are user-defined but some default groupings are provided as presets.
+
presets menu
+
A menu that allows you to access stored module layout presets and create your own (via the “manage presets..” option). You can also directly access the “manage presets” dialog by Ctrl+clicking on the presets menu.
+
+

Click once on a module group icon (including the active group) to show only the modules in that group. Click a second time to show a list of all modules that are currently active or present in any group.

+

You can change which widgets appear in the quick access panel and which modules appear in the module groups, by right-clicking the appropriate icon.

+

🔗search

+

Below the module group icons is the search bar, which you can use to access any of the processing modules, regardless of whether they are currently in a group. This option allows you to search by module name, any user-defined instance name, as well as pre-defined module tags (for example, the color calibration rgb module can also be searched using the terms “hue”, “contrast” and “vibrance”).

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/organization/overview/module-group-active-icon.png b/en/darkroom/organization/overview/module-group-active-icon.png new file mode 100644 index 0000000000..03c738d754 Binary files /dev/null and b/en/darkroom/organization/overview/module-group-active-icon.png differ diff --git a/en/darkroom/organization/overview/organization.png b/en/darkroom/organization/overview/organization.png new file mode 100644 index 0000000000..9bbfd6f08e Binary files /dev/null and b/en/darkroom/organization/overview/organization.png differ diff --git a/en/darkroom/organization/overview/quick-access-panel-icon.png b/en/darkroom/organization/overview/quick-access-panel-icon.png new file mode 100644 index 0000000000..699f7e1cc7 Binary files /dev/null and b/en/darkroom/organization/overview/quick-access-panel-icon.png differ diff --git a/en/darkroom/organization/quick-access-panel/index.html b/en/darkroom/organization/quick-access-panel/index.html new file mode 100644 index 0000000000..f13c499b3d --- /dev/null +++ b/en/darkroom/organization/quick-access-panel/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - quick access panel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / organization / quick access panel + +
+ + + + +
+ +

+ quick access panel +

+ + + +

The quick access panel allows you to access widgets from a number of processing modules all in one place.

+

+ + + + + + + + +quick-access-panel + +

+

You can add new widgets to the panel by

+ +

Click on the icon to the right of the module name to open the full version of that module. Click on the icon to the left of the module name to enable/disable the module.

+

If any module has multiple instances enabled you will no longer be able to manage that module’s widgets through the quick access panel and will have to use the full module interface.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/organization/quick-access-panel/quick-access-panel.png b/en/darkroom/organization/quick-access-panel/quick-access-panel.png new file mode 100644 index 0000000000..39dfbfe963 Binary files /dev/null and b/en/darkroom/organization/quick-access-panel/quick-access-panel.png differ diff --git a/en/darkroom/overview/index.html b/en/darkroom/overview/index.html new file mode 100644 index 0000000000..3b80ee567a --- /dev/null +++ b/en/darkroom/overview/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Darkroom / overview + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ overview +

+ + + +

The darkroom view is where you develop your images. The center panel contains the image currently being edited.

+

🔗zoom

+

Middle-click on the center panel cycle between “fit to screen”, 1:1 and 2:1 zoom.

+

Alternatively you can zoom between 1:1 and “fit to screen” by scrolling with your mouse. Scroll while holding the Ctrl key to extend the zoom range to between 2:1 and 1:10.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/pixelpipe/history-stack/index.html b/en/darkroom/pixelpipe/history-stack/index.html new file mode 100644 index 0000000000..4abd014a44 --- /dev/null +++ b/en/darkroom/pixelpipe/history-stack/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - the history stack + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / the pixelpipe / the history stack + +
+ + + + +
+ +

+ the history stack +

+ + + +

The history stack stores the entire editing history for a given image, in the order in which those edits were applied. It is saved to darktable’s library database and the image’s XMP sidecar file and persists between editing sessions.

+

Each time a processing module is enabled, disabled, moved or amended a new entry is added to the top of the history stack.

+

The history stack can be queried and modified within the history stack module in the darkroom.

+
+

Note: The history stack is not a representation of the order in which the modules are executed but the order in which they were amended. The execution order is represented by the order of the modules in the right-hand panel.

+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/pixelpipe/index.html b/en/darkroom/pixelpipe/index.html new file mode 100644 index 0000000000..1c3c33f14f --- /dev/null +++ b/en/darkroom/pixelpipe/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - the pixelpipe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/pixelpipe/index.xml b/en/darkroom/pixelpipe/index.xml new file mode 100644 index 0000000000..9847dff4e8 --- /dev/null +++ b/en/darkroom/pixelpipe/index.xml @@ -0,0 +1,39 @@ + + + + the pixelpipe on darktable user manual + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/ + Recent content in the pixelpipe on darktable user manual + Hugo + en + + + the anatomy of a processing module + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-anatomy-of-a-module/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-anatomy-of-a-module/ + The basic element of image processing in darktable is the processing module. In order to process a raw image a number of such modules act on the input image in sequence, each performing a different operation on the image data. For those familiar with Adobe Photoshop, the concept of a processing module in darktable is analogous to that of an adjustment layer in that both make an incremental adjustment to the image, building on top of the adjustments that came before. + + + the pixelpipe & module order + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/ + The ordered sequence of processing modules operating on an input file to generate an output image is known as the &ldquo;pixelpipe&rdquo;. The order of the pixelpipe is represented graphically by the order in which modules are presented in the user interface &ndash; the pixelpipe starts with a RAW image at the bottom of the module list, and applies the processing modules one by one, piling up layer upon layer of processing from the bottom up, until it reaches the top of the list, where it outputs the fully processed image. + + + the history stack + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/history-stack/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/history-stack/ + The history stack stores the entire editing history for a given image, in the order in which those edits were applied. It is saved to darktable&rsquo;s library database and the image&rsquo;s XMP sidecar file and persists between editing sessions. Each time a processing module is enabled, disabled, moved or amended a new entry is added to the top of the history stack. The history stack can be queried and modified within the history stack module in the darkroom. + + + undo and redo + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/undo-redo/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/undo-redo/ + While you are editing your image, darktable records all of the modifications you make to that image. This means that it is possible to undo and redo changes to recover a previous editing state. Note that the undo/redo facility is unlimited in the number of steps while editing an image, but is reset each time the darkroom is switched to a new image. Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any). + + + diff --git a/en/darkroom/pixelpipe/the-anatomy-of-a-module/index.html b/en/darkroom/pixelpipe/the-anatomy-of-a-module/index.html new file mode 100644 index 0000000000..4e90c5f126 --- /dev/null +++ b/en/darkroom/pixelpipe/the-anatomy-of-a-module/index.html @@ -0,0 +1,3049 @@ + + + + + +darktable user manual - the anatomy of a processing module + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / the pixelpipe / the anatomy of a processing module + +
+ + + + +
+ +

+ the anatomy of a processing module +

+ + + +

The basic element of image processing in darktable is the processing module. In order to process a raw image a number of such modules act on the input image in sequence, each performing a different operation on the image data. For those familiar with Adobe Photoshop, the concept of a processing module in darktable is analogous to that of an adjustment layer in that both make an incremental adjustment to the image, building on top of the adjustments that came before.

+

Utility modules are also provided by darktable, however these are not directly involved in image processing, instead providing a GUI that allows you to manage your images, tag them, export them etc.

+

Every processing module acts independently of the others, but all modules perform their processing in a similar manner:

+

+ + + + + + + + +module anatomy + +

+
    +
  1. +

    Receive the module input from the last executed module and perform an operation on it to produce the processed output. This operation is different for every processing module.

    +
  2. +
  3. +

    Combine the module input and processed output using a blending operator to produce the blended output. If no blending is performed, the output of this step is the same as the processed output.

    +
  4. +
  5. +

    Generate a mask, which defines an opacity for each pixel in the image. The opacity is later used to control how strongly the module’s operation is applied to each part of the image.

    +

    You may define your own mask by drawing shapes over the image or by using pixel properties from the module input or processed output (see masks for details). This mask may be further modified with a global opacity setting, which affects every pixel equally.

    +

    If no drawn/parametric mask is used, the output of this step is a mask where every pixel has the same opacity (governed by the global opacity setting). If no opacity is defined (no blending is performed) a global opacity of 1.0 (or 100%) is assumed.

    +
  6. +
  7. +

    Combine the module input and blended output pixel-by-pixel using the mask as a mixing operator, to produce the final output. Where the mask opacity is 100%, the final output is the blended output for that pixel. Where the mask opacity is 0 the final output is the module input for that pixel. An intermediate opacity combines the blended output and module input proportionally. The final output is passed to the next module for further processing.

    +
  8. +
+

Steps 2 and 3 are optional and not supported by all modules. For example, the demosaic module must be applied to the entire raw file in order to produce a legible image so it does not make sense to mask or blend its output.

+

Each of the above steps is defined in more detail in subsequent sections.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/pixelpipe/the-anatomy-of-a-module/module-anatomy.png b/en/darkroom/pixelpipe/the-anatomy-of-a-module/module-anatomy.png new file mode 100644 index 0000000000..8509b90530 Binary files /dev/null and b/en/darkroom/pixelpipe/the-anatomy-of-a-module/module-anatomy.png differ diff --git a/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/index.html b/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/index.html new file mode 100644 index 0000000000..f3b57d6498 --- /dev/null +++ b/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/index.html @@ -0,0 +1,3074 @@ + + + + + +darktable user manual - the pixelpipe & module order + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / the pixelpipe / the pixelpipe & module order + +
+ + + + +
+ +

+ the pixelpipe & module order +

+ + + +

The ordered sequence of processing modules operating on an input file to generate an output image is known as the “pixelpipe”.

+

The order of the pixelpipe is represented graphically by the order in which modules are presented in the user interface – the pixelpipe starts with a RAW image at the bottom of the module list, and applies the processing modules one by one, piling up layer upon layer of processing from the bottom up, until it reaches the top of the list, where it outputs the fully processed image.

+
+

Note: The order in which processing modules are executed exactly matches the order in which the modules appear in darktable’s user interface. Changing the order of the modules in the user interface changes how your image is processed.

+
+

🔗types of pixelpipe

+

Processing images can be very resource-intensive. For this reason, darktable includes various types of pixelpipe, optimised for different parts of the system. For example:

+
    +
  • The export pixelpipe processes the full-sized image at full quality. This is the slowest type of pixelpipe, but provides the maximum available image quality.
  • +
  • The thumbnail pixelpipe is optimised for speed, since it needs to process multiple small images at the same time without impacting lighttable or filmstrip performance. These optimisations impact image quality, but this is not usually a problem for the small images used in thumbnail generation.
  • +
  • The standard darkroom pixelpipe attempts to produce as accurate an image as possible, while also maintaining responsiveness when modifying module parameters. It does this by only processing the pixels that are visible on-screen – known as the “region of interest” (ROI). However, this can mean that the image doesn’t accurately reflect the exported file, especially when using modules that rely on the properties of neighboring pixels. This is particularly noticeable in modules that impact local contrast (e.g. diffuse or sharpen, denoise (profiled) and local contrast) and can mean that the darkroom view appears over-sharpened compared to a full-sized export.
  • +
  • A cut-down darkroom pixelpipe is used while interacting with some darkroom modules that display the full image with overlays (like retouch, crop and liquify). This pixelpipe excludes some long-running modules (like diffuse or sharpen) in order to improve responsiveness, but can temporarily make the image look under-processed (blurred). This limitation is removed as soon as you move focus to a different module.
  • +
  • In order to overcome the above limitations within the standard darkroom pixelpipe, you can enable high quality processing mode in the darkroom view. This mode processes the entire image using the export pixelpipe and only downscales for display at the end of the pipe. This means that the darkroom image will very closely match the exported image, but will significantly degrade responsiveness when interacting with processing modules. You are advised to only use this mode after you have already done most of your processing. Its performance will be significantly improved by using an OpenCL-capable GPU.
  • +
+

🔗module order and workflows

+

The order in which modules are executed within the pixelpipe has been carefully chosen to give the best output quality. In previous versions of darktable it was not possible to change the module order. However, there are a number of very specific use cases where the movement of some modules within the pixelpipe is advised.

+

One of the main reasons to change the module order came about with darktable version 3.0, which introduced the new scene-referred way of working. Version 3.2 formalised this by introducing the display-referred and scene-referred workflows, which are controlled by the preferences > processing > auto-apply pixel workflow defaults setting. Starting with version 3.6, scene-referred workflow is now the official recommended (and default) way to use darktable.

+

The scene-referred workflow attempts to perform as many operations as possible in a linear RGB color space, only compressing the tones to fit the output medium (with a non-linear tone mapping) at the end of the pixelpipe. This has the advantage of being a more physically-realistic space to do transformations than the traditional display-referred workflow, which attempts to perform operations in a non-linear perceptual color space. Honoring the physical realism (rather than the perceptual realism) makes it much easier to produce predictable processing algorithms with a minimum of artifacts.

+

The following diagram should help you to understand the difference between these workflows:

+

+ + + + + + + + +scene-referred and display-referred modules + +

+
    +
  1. +

    Scene-referred modules process linear data that is proportional to the amount of light collected by the camera at the scene. The dynamic range of an image in the scene-referred section of the pixelpipe is often larger than that of the display medium.

    +
  2. +
  3. +

    At some point in the pixelpipe, these pixel values are compressed by a non-linear tone mapping operation into a smaller dynamic range more suitable for display on a monitor or a print.

    +
  4. +
  5. +

    The remaining modules operate in the non-linear display-referred section of the pixelpipe to produce the final output image.

    +
  6. +
+

🔗display-referred workflow

+

Prior to version 3.0 darktable’s workflow was display-referred (auto-apply pixel workflow defaults = “display-referred”) and this option is still provided as a legacy mode. In this workflow, the base curve or filmic rgb module performs tone mapping early in the pixelpipe and most other darktable modules operate on image data in the compressed display-referred space.

+

Selecting the display-referred workflow enables the legacy (pre-darktable-3.0) module order and automatically switches on the base curve module for new images.

+

Pixel data within the display-referred space is non-linear and is not a physically realistic representation of the original scene. This can lead to various artifacts with some modules, hence the creation of the (now default) scene-referred workflow.

+

🔗scene-referred workflow

+

Scene-referred workflow (auto-apply pixel workflow defaults = “scene-referred”) was introduced as part of darktable 3.0. The module order was entirely rearranged to place the filmic rgb and base curve tone mapping modules much later in the pixelpipe. This means that most modules now operate in linear rgb space with only a few modules remaining within the non-linear display-referred space. Within this workflow it is now recommended that the majority of image processing takes place using the modules up to and including filmic rgb. Operations in this section of the pixelpipe, being truly linear, are much more physically realistic and produce fewer artifacts.

+

Selecting the scene-referred workflow enables the v3.0 module order and automatically enables the exposure and filmic rgb modules with some presets designed to act as a reasonable starting point for scene-referred editing.

+

🔗changing module order

+

It remains highly recommended that users not change the order within the pixelpipe for a number of reasons:

+
    +
  • The sequence of modules has been selected with great care in order to give highest output quality. Changes to the sequence often worsen the result rather than improving it.
  • +
  • Some processing modules simply don’t make sense if they are shifted in the pixelpipe. For example, highlight reconstruction needs to be performed on raw data before demosaic, which itself needs to be performed before any input color profile can be applied. For this reason it is still not possible to move some of the modules that are placed early in the pixelpipe.
  • +
  • Most processing modules are designed to work within a specific color space (see the color management section for more details). Full flexibility would require modules to support different parallel algorithms depending on the color space they are working in, which would drastically increase complexity.
  • +
+

Despite the general recommendation to leave the pixelpipe order alone, it is possible to move modules within the pixelpipe by holding Ctrl+Shift and dragging and dropping the desired module to a new location. This should only be done by experienced users who understand the impact this will have on the image.

+

The module order can be manually changed back to either the v3.0 or legacy versions using the module order module, which can also be used to define your own custom module order presets.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/scene-display-workflows.png b/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/scene-display-workflows.png new file mode 100644 index 0000000000..b72ad47b03 Binary files /dev/null and b/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/scene-display-workflows.png differ diff --git a/en/darkroom/pixelpipe/undo-redo/index.html b/en/darkroom/pixelpipe/undo-redo/index.html new file mode 100644 index 0000000000..e1fb0a4d6d --- /dev/null +++ b/en/darkroom/pixelpipe/undo-redo/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - undo and redo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / the pixelpipe / undo and redo + +
+ + + + +
+ +

+ undo and redo +

+ + + +

While you are editing your image, darktable records all of the modifications you make to that image. This means that it is possible to undo and redo changes to recover a previous editing state. Note that the undo/redo facility is unlimited in the number of steps while editing an image, but is reset each time the darkroom is switched to a new image.

+

Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any).

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/curves/curve.png b/en/darkroom/processing-modules/curves/curve.png new file mode 100644 index 0000000000..de322c561d Binary files /dev/null and b/en/darkroom/processing-modules/curves/curve.png differ diff --git a/en/darkroom/processing-modules/curves/index.html b/en/darkroom/processing-modules/curves/index.html new file mode 100644 index 0000000000..23e0b49e5e --- /dev/null +++ b/en/darkroom/processing-modules/curves/index.html @@ -0,0 +1,3097 @@ + + + + + +darktable user manual - curves + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / curves + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ curves +

+ + + +

The base curve, tone curve and rgb curve modules use curves to control the tones in the image. These modules have some common features that warrant separate discussion.

+

+ + + + + + + + +curve + +

+

🔗nodes

+

In their default state, curves are straight lines, defined by two anchor nodes at the top-right and bottom-left of the graph. You can move the nodes to modify the curve or generate new nodes by clicking on the curve. Ctrl+click to generate a new node at the x-location of the mouse pointer and the corresponding y-location of the current curve – this adds a node without the risk of accidentally modifying the curve. Up to 20 nodes can be defined per curve. To remove a node, click on it and drag it out of the widget area.

+

🔗curve controls

+

The following controls are common to two or more of the above processing modules and are therefore discussed separately here. Please see the individual module documentation for discussion of any additional controls.

+
+
interpolation method
+
tone curve and rgb curve only
+
+

Interpolation is the process by which a continuous curve is derived from a few nodes. As this process is never perfect, several methods are offered that can alleviate some of the issues you may encounter.

+
+
+
    +
  • cubic spline is, arguably, the most visually pleasing. Since it gives smooth curves, the contrast in the image is better enhanced. However, this method is very sensitive to the nodes’ position, and can produce cusps and oscillations when the nodes are too close to each other, or when there are too many of them. This method works best when there are only 4 to 5 nodes, evenly spaced.
  • +
+
+
+
    +
  • centripetal spline is designed specifically to avoid cusps and oscillations but, as a drawback, it will follow the nodes more loosely. It is very robust, no matter the number of nodes and their spacing, but will produce a more faded and dull contrast.
  • +
+
+
+
    +
  • monotonic spline is designed specifically to give a monotonic interpolation, meaning that there will be none of the oscillations the cubic spline may produce. This method is most suitable when you are trying to build an analytical function from a node interpolation (for example: exponential, logarithm, power, etc.). Such functions are provided as presets. It is a good trade-off between the two aforementioned methods.
  • +
+
+
preserve colors
+
If a non-linear tone curve is applied to each of the RGB channels individually, then the amount of tone adjustment applied to each color channel may be different, and this can cause hue shifts. The preserve colors combobox provides different methods of calculating the “luminance level” of a pixel in order to minimise these shifts. The amount of tone adjustment is calculated based on this luminance value, and then this same adjustment is applied to all three of the RGB channels. Different luminance estimators can affect the contrast in different parts of the image, depending on the characteristics of that image. The user can therefore choose the estimator that provides the best results for the given image. Some of these methods are discussed in detail in the preserve chrominance control in the filmic rgb module. The following options are available:
+
+
    +
  • none
  • +
+
+
    +
  • luminance
  • +
+
+
    +
  • max RGB
  • +
+
+
    +
  • average RGB
  • +
+
+
    +
  • sum RGB
  • +
+
+
    +
  • norm RGB
  • +
+
+
    +
  • basic power
  • +
+
+
scale for graph
+
tone curve and base curve only
+
+

The scale allows you to distort the graph display so that certain graphical properties emerge to help you draw more useful curves. Note that the scaling option only affects the curve display, not the actual parameters stored by the module.

+
+
+

By default, a “linear” scale is used (scale factor 0), which uses evenly spaced horizontal and vertical axes. Positive values give the graph a logarithmic scale, compressing high values and dilating low values on both the horizontal and vertical axes, so that nodes in lowlights get more space on the graph and can be controlled more precisely.

+
+
+

Increasing the ‘scale for graph’ slider sets the base of the logarithm used to scale the axes. This allows you to control the amount of compression/dilation operated by the scale. If you draw purely exponential or logarithmic functions from identity lines, setting this value defines the base of such functions.

+
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/deprecated/index.html b/en/darkroom/processing-modules/deprecated/index.html new file mode 100644 index 0000000000..b7de90d5a2 --- /dev/null +++ b/en/darkroom/processing-modules/deprecated/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - deprecated modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / deprecated modules + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ deprecated modules +

+ + + +

The darktable team regularly reviews old modules and updates their implementation where issues are found or updated science means that they can be improved. Most of the time we try to update existing modules with new functionality but occasionally that becomes problematic, often due to the overhead of having to maintain multiple versions of the module. In such circumstances a new replacement module is created and the old module becomes deprecated.

+

Module deprecation follows a fairly standard process: In the release that deprecates a module, that module can no longer be searched or added to custom module groups. It is moved into the read-only deprecated modules group and a message added to the module to warn of its removal and direct the user to a suitable alternative.

+

After a year, the module is removed from the deprecated modules group and is then only available for use in old edits (where that module was already active against a given image). Deprecated modules are never fully removed from darktable (in order to retain old edits) but development ceases and you are advised to use supported modules instead if you encounter an issue.

+

For example, modules deprecated in darktable 3.4 will be removed from the deprecated modules group in darktable 3.8 (assuming two major releases each year).

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/index.html b/en/darkroom/processing-modules/index.html new file mode 100644 index 0000000000..5ba654a048 --- /dev/null +++ b/en/darkroom/processing-modules/index.html @@ -0,0 +1,3058 @@ + + + + + +darktable user manual - processing modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Darkroom / processing modules + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

processing modules

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/index.xml b/en/darkroom/processing-modules/index.xml new file mode 100644 index 0000000000..ce68531c12 --- /dev/null +++ b/en/darkroom/processing-modules/index.xml @@ -0,0 +1,60 @@ + + + + processing modules on darktable user manual + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/ + Recent content in processing modules on darktable user manual + Hugo + en + + + module header + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-header/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-header/ + At the top of each processing module is the module header. Click on the module name to expand the module and display the parameters that control its operation. By default darktable will only allow one processing module to be expanded at a time &ndash; if you click the header of another module, the previously-opened module&rsquo;s controls are collapsed. If you want to expand more than one module, you may expand further modules by Shift+clicking on the header and all previously expanded modules will remain open. + + + multiple instances + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/multiple-instances/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/multiple-instances/ + Many of darktable&rsquo;s modules can be applied more than once in the pixelpipe. Each instance of a module behaves independently, taking its input from the module below it in the pixelpipe and delivering its output to the next module. As with the base instance of a module, all instances can be moved independently within the pixelpipe either by holding Ctrl+Shift while dragging &amp; dropping or by choosing &ldquo;move up&rdquo; or &ldquo;move down&rdquo; in the multiple instances drop-down menu. + + + presets + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/presets/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/presets/ + Presets allow you to store commonly-used module settings for future use. Some modules already come with pre-defined (internal) presets and you may also define your own (user-defined). Both internal and user-defined presets can be shown by clicking the presets menu in the module header. Most of the functionality described here applies to processing modules only. However, presets can also be used with some utility modules. When used with utility modules, the functionality to auto-apply or auto-show presets based on image Exif data is not available. + + + module controls + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-controls/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-controls/ + This section describes how to interact with processing module controls. 🔗sliders Sliders offer five different methods of interaction, depending on the level of control you require. left-click (set) Click anywhere in the slider area to set the value. You can also click and drag to change it. You don&rsquo;t have to aim for the triangle or even the line &ndash; you can click anywhere in the entire height of the slider, including the label. + + + curves + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/curves/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/curves/ + The base curve, tone curve and rgb curve modules use curves to control the tones in the image. These modules have some common features that warrant separate discussion. 🔗nodes In their default state, curves are straight lines, defined by two anchor nodes at the top-right and bottom-left of the graph. You can move the nodes to modify the curve or generate new nodes by clicking on the curve. Ctrl+click to generate a new node at the x-location of the mouse pointer and the corresponding y-location of the current curve &ndash; this adds a node without the risk of accidentally modifying the curve. + + + wavelets + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/wavelets/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/wavelets/ + Wavelets are used to separate (or decompose) an image into a number of distinct layers, each containing a different level of detail. After decomposing an image in this way, a module can limit its processing to one or more of these detail layers, and then piece the layers back together again at the end to form its output. This allows us to be surgical about which features in the image we wish to impact when working with a module. + + + deprecated modules + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/deprecated/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/deprecated/ + The darktable team regularly reviews old modules and updates their implementation where issues are found or updated science means that they can be improved. Most of the time we try to update existing modules with new functionality but occasionally that becomes problematic, often due to the overhead of having to maintain multiple versions of the module. In such circumstances a new replacement module is created and the old module becomes deprecated. + + + diff --git a/en/darkroom/processing-modules/module-controls/bauhaus.png b/en/darkroom/processing-modules/module-controls/bauhaus.png new file mode 100644 index 0000000000..636d959838 Binary files /dev/null and b/en/darkroom/processing-modules/module-controls/bauhaus.png differ diff --git a/en/darkroom/processing-modules/module-controls/color-picker.png b/en/darkroom/processing-modules/module-controls/color-picker.png new file mode 100644 index 0000000000..b915ad178c Binary files /dev/null and b/en/darkroom/processing-modules/module-controls/color-picker.png differ diff --git a/en/darkroom/processing-modules/module-controls/index.html b/en/darkroom/processing-modules/module-controls/index.html new file mode 100644 index 0000000000..4abe98a54d --- /dev/null +++ b/en/darkroom/processing-modules/module-controls/index.html @@ -0,0 +1,3085 @@ + + + + + +darktable user manual - module controls + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / module controls + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ module controls +

+ + + +

This section describes how to interact with processing module controls.

+

🔗sliders

+

Sliders offer five different methods of interaction, depending on the level of control you require.

+
+
left-click (set)
+
Click anywhere in the slider area to set the value. You can also click and drag to change it. You don’t have to aim for the triangle or even the line – you can click anywhere in the entire height of the slider, including the label.
+
mouse wheel (adjust)
+
Hover over the slider with your mouse, then use your mouse wheel to adjust the value. You can alter the default speed at which the mouse scroll adjusts a slider by scrolling over that slider while in visual shortcut mapping mode.
+
keyboard arrow keys (adjust)
+
When the slider has focus you can hover over the slider with your mouse, then use your keyboard’s arrow keys (←/↓ and →/↑) to adjust the value. In order to give focus to the widget without changing the current value you can right-click, then right-click again.
+
right-click (pop-up edit)
+
When your mouse is over a slider right-clicking enables a multi-functional pop-up below the slider for fine control with your mouse or numerical entry using the keyboard.
+
+

+ + + + + + + + +bauhaus + +

+
+
+

A bent line extending from the triangular marker moves with your mouse. The closer your mouse pointer is to the triangular marker the coarser the control you have over the value; the further away from the triangular marker the finer your control. Left-click with your mouse to accept the new value and hide the pop-up.

+
+
+

Alternatively you can type in a new value using your keyboard and commit by hitting the Enter key. You may even supply the new value in the form of an arithmetic expression which darktable will calculate for you – the previous value is referenced as “x”.

+
+
+

For most sliders, the minimum and maximum values displayed are known as “soft limits” – they do not represent the minimum/maximum values that you may enter, merely a suggested range of “normal” values that most users will not need to exceed. As well as these soft limits, each slider also has “hard limits” which may not be exceeded.

+
+
+

You may right-click and type any value up to the hard limits for a given slider. For example, in the rotate and perspective module, the soft limits for angle are -10 to +10 degrees while the hard limits are -180 to +180 degrees; In the exposure module, the soft limits for the exposure slider are -3 to +4 EV while the hard limits are -18 to +18 EV. If you try to enter a value beyond the hard limit, it will be automatically be adjusted to the minimum/maximum allowable value.

+
+
double-click (reset)
+
Double-click on a slider or its label to reset back to the default value. Ctrl+double-click to reset its value back to any auto-applied preset (if one applies for the current image). If controls are grouped together within a tabbed interface, you can double-click on the tab’s header label to reset all settings in that tab.
+
+

In addition, the speed of mouse-wheel, arrow-key and click+drag adjustments can be altered:

+
    +
  • hold down the Shift key while adjusting to increase the step size by a factor of 10.
  • +
  • hold down the Ctrl key while adjusting to decrease the step size by a factor of 10.
  • +
+

Both of these multipliers can be amended in preferences > shortcuts by altering the speed of the fallbacks/value actions.

+

🔗comboboxes

+

Click on a combobox to show a list of available options which you can click to select. Occasionally the selection list will open close to the bottom or top of the screen meaning that only some of the items are visible – simply scroll with your mouse wheel to bring up the full list. Alternatively, you can also use the mouse wheel and keyboard arrow keys to select an option, or start typing to filter the combobox entries.

+

As with sliders, you can double-click the combobox or its label to reset back to the default value, or Ctrl+double-click to reset back to any auto-applied preset.

+

🔗pickers

+

Many modules allow parameters to be set using pickers (identified by the + + + + + + + + +picker-icon + + icon). Pickers allow you to select sample areas of the image from which to calculate values for module parameters. You can usually choose to select either a “point” (a single pixel) or an “area” (a rectangular selection of pixels) from the image, although some modules only allow one mode to be used.

+

Selecting pixel(s) will cause the appropriate module value(s) to be updated, and may also cause additional visual feedback (for example, overlaying the range of selected pixels on a tone curve).

+

Activate point mode by left-clicking the picker icon and then left-click anywhere on the image to select the pixel from which to calculate values. The selected point will be shown on-screen (with a cross icon) which you can adjust by left-clicking another pixel. Deactivate the picker by left-clicking the picker icon again.

+

Activate area mode by either right-clicking or Ctrl+clicking the picker icon and then left-click and drag to select a rectangular area of the image from which to calculate values. The selected area will be shown on-screen as an overlaid rectangle which can be moved by either drawing another rectangle elsewhere or by left-clicking and dragging the corners of the drawn rectangle. Reset the rectangle (to select the whole image) by right-clicking anywhere on the image. Deactivate the picker by right-clicking (or Ctrl+clicking) the picker icon again.

+

In modules where only one mode is available, left-clicking the icon will usually toggle that mode on and off.

+

🔗keyboard shortcuts

+

Module parameters can also be adjusted using keyboard shortcuts. See preferences > shortcuts for more information.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/module-header/index.html b/en/darkroom/processing-modules/module-header/index.html new file mode 100644 index 0000000000..bb835a91f4 --- /dev/null +++ b/en/darkroom/processing-modules/module-header/index.html @@ -0,0 +1,3056 @@ + + + + + +darktable user manual - module header + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / module header + +
+ + + + +
+ +

+ module header +

+ + + +

At the top of each processing module is the module header.

+

+ + + + + + + + +module header + +

+

Click on the module name to expand the module and display the parameters that control its operation.

+

By default darktable will only allow one processing module to be expanded at a time – if you click the header of another module, the previously-opened module’s controls are collapsed. If you want to expand more than one module, you may expand further modules by Shift+clicking on the header and all previously expanded modules will remain open. This behaviour can be reversed via a setting in preferences > darkroom.

+
+

Note: Expanding a module does not cause it to be activated. See below for how to activate modules.

+
+

The module header contains the following controls in order from left to right:

+
+
on/off button
+
Click to toggle the module on or off. Some modules are essential for image processing and cannot be disabled (though their parameters may be amended). Similarly, some modules are not applicable for certain types of image and cannot be enabled.
+
+

Ctrl+click on the on/off button to toggle whether the module has focus. The focus state is usually used to activate any overlays that a module places over the image to control its functionality. For example, the crop module only shows the composition and crop guide lines on the image if it has focus. Modules are automatically given focus when expanded.

+
+
module name
+
The module name consists of a description of the module’s operation (which cannot be changed) followed by the module’s instance name (which can). By default the first instance of a module has an empty instance name. If you create additional instances, the name of each new instance is initiated with a unique integer. For example, the second created instance of an exposure module will be automatically named exposure 1.
+
+

Ctrl+click on a module’s name to manually amend its instance name.

+
+
mask toggle
+
This icon will appear in the header whenever a mask is active on a module. Hover over the icon to see what type of mask is enabled. Click it to display the current mask as a yellow overlay over a black-and-white version of the image. Solid yellow indicates an opacity of 100%; a fully visible gray background image (without yellow overlay) indicates an opacity of 0%. This toggle button can be disabled in preferences > darkroom > show mask indicator in module headers.
+
multiple instance menu
+
This menu allows you to create, delete, move and rename module instances. Right-click on this icon to directly create a new instance of the module. See the multiple instances section for more information.
+
reset
+
Click to reset all module controls to their default values. Ctrl+click to reapply any automatic presets for the module – if no automatic presets are applicable for this module, Ctrl+click will simply reset to default values (same as click).
+
presets menu
+
This menu allows you to apply, create and edit module presets. See the presets section for more information.
+
+

The visibility of the four icons to the right of the module name can be controlled in preferences > darkroom > show right-side buttons in processing module headers.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/module-header/module-header.png b/en/darkroom/processing-modules/module-header/module-header.png new file mode 100644 index 0000000000..c3fbf65f29 Binary files /dev/null and b/en/darkroom/processing-modules/module-header/module-header.png differ diff --git a/en/darkroom/processing-modules/multiple-instances/index.html b/en/darkroom/processing-modules/multiple-instances/index.html new file mode 100644 index 0000000000..46619fff58 --- /dev/null +++ b/en/darkroom/processing-modules/multiple-instances/index.html @@ -0,0 +1,3042 @@ + + + + + +darktable user manual - multiple instances + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / multiple instances + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ multiple instances +

+ + + +

Many of darktable’s modules can be applied more than once in the pixelpipe. Each instance of a module behaves independently, taking its input from the module below it in the pixelpipe and delivering its output to the next module.

+

As with the base instance of a module, all instances can be moved independently within the pixelpipe either by holding Ctrl+Shift while dragging & dropping or by choosing “move up” or “move down” in the multiple instances drop-down menu.

+

Instances can be renamed by Ctrl+clicking on the module name.

+

🔗typical use cases

+

There are many occasions where it makes sense to have a module apply more than once in the pixelpipe. Here are some typical use cases.

+
    +
  • The exposure module can be used in combination with masks to lighten or darken parts of an image. A separate instance may be created to modify each masked region of the image.
  • +
  • You may wish to handle luma and chroma noise independently. This can be accomplished by generating two instances of your chosen denoising module and using the first one only on luma (by selecting blend mode “lightness”) and the second one only on chroma (by selecting blend mode “color”).
  • +
+
+

Note: Each instance also adds to the workload of your pixelpipe. Generating too many instances – especially of the more demanding modules – will cause noticeable slow-down.

+
+

🔗managing multiple instances

+

Click on the multiple instance menu in the module header to display a menu with the following options. Right-click on the menu icon to create a new instance directly (same action as clicking on the “new instance” option of the menu).

+
+
new instance
+
Create a new instance of the current module with all of its parameters reset to their default values. The ‘instance name’ is automatically set to a unique integer so that it can be distinguished from its parent.
+
duplicate instance
+
Create a new instance of the current module with all of its parameters inherited from the current instance. As with ’new instance’ the ‘instance name’ is automatically set to a unique integer.
+
move up/down
+
Move the instance up or down in the pixelpipe
+
delete
+
Remove the current instance. This option is not available if only one instance is present.
+
rename
+
Rename the current instance. See the history stack section for more details on how the instance name impacts copying and pasting history stacks.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/presets/index.html b/en/darkroom/processing-modules/presets/index.html new file mode 100644 index 0000000000..5e8eef5624 --- /dev/null +++ b/en/darkroom/processing-modules/presets/index.html @@ -0,0 +1,3105 @@ + + + + + +darktable user manual - presets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / presets + +
+ + + + +
+ +

+ presets +

+ + + +

Presets allow you to store commonly-used module settings for future use. Some modules already come with pre-defined (internal) presets and you may also define your own (user-defined). Both internal and user-defined presets can be shown by clicking the presets menu in the module header.

+

Most of the functionality described here applies to processing modules only. However, presets can also be used with some utility modules. When used with utility modules, the functionality to auto-apply or auto-show presets based on image Exif data is not available.

+

Please note that, for processing modules, the saved preset also includes the active state of the module. You can use this to create your own default settings, which you can activate on-demand. Simply set your desired defaults, disable the module, and save the preset.

+

🔗the presets menu

+

The presets menu will contain one or more of the following entries depending on the presets that are defined or selected for the current module:

+
+
preset list
+
A list of the presets available for the current module. The currently selected preset (if any) is shown in bold and with a small check mark beside it.
+
edit this preset
+
If a preset has been selected, edit the selected preset (see below).
+
delete this preset
+
If a preset has been selected, delete the selected preset.
+
update preset [name]
+
Update the named preset to match the module’s current parameters.
+
store new preset
+
Create a new preset using the module’s current parameters.
+
+

Click on a preset name to apply the preset to the current instance of the module. Long-left-click on a preset name to apply the preset but keep the preset list open (so that you can experiment with multiple presets without needing to re-open the menu). Right-click on a preset name to create a new instance of the module and apply the selected preset to it. You can also apply a preset at any time while you are in the darkroom using a keyboard shortcut – if you have assigned one (see preferences > shortcuts).

+

🔗creating and editing presets

+

When creating or editing presets, the following dialog is shown:

+

+ + + + + + + + +new preset + +

+

🔗controls

+
+
name
+
The name of the preset
+
description
+
A searchable description for the preset (optional)
+
reset all module parameters to their default values
+
Selecting this option will cause all module parameters to be reset to their default values (as if you had simply enabled the module on a new image or clicked the module reset button). This can be used to automatically set certain modules (color calibration, exposure, filmic) based on the Exif properties of the current image rather than setting to hard-coded parameters. Note that this option is not available when editing presets from the preferences > presets tab.
+
auto apply this preset to matching images (processing modules only)
+
Check this box to automatically apply this preset to matching images when they are opened in the darkroom for the first time (you can reapply such automatic presets by Ctrl+clicking on the reset button in the module header). Additional controls will appear to allow you to define which images the preset will be applied to based on image Exif data (see below).
+
+

For example, if you want a preset to be applied to all images from a specific camera leave all fields at default values except for “model”. Leave all fields unchanged to auto-apply a preset to all images.

+
+
+

The example dialog above sets up following rules: if the lens name matches, the aperture is greater than or equal to f/8 and the focal length is between 24 and 35mm the preset will be automatically applied.

+
+
+

The image information module displays the camera model and lens name for each image. Use this to ensure you have the correct spelling.

+
+
only show this preset for matching images (processing modules only)
+
Check this box to automatically show the preset in the preset menu, using the same set of filters.
+
+

🔗filter criteria

+

The following criteria can be used to auto-apply or auto-show presets for processing modules:

+
+
model
+
A pattern to be matched against the Exif field that describes your camera model; use % as wildcard.
+
maker
+
A pattern to be matched against the Exif field that describes the maker of your camera; use % as wildcard.
+
lens
+
A pattern to be matched against the Exif field that describes your lens; use % as wildcard.
+
ISO
+
Only apply the preset if the ISO value of your image lies within the given range (shows ∞ if the upper range is unlimited).
+
exposure
+
Only apply the preset if the exposure time of your image lies within the given range; set + as the upper value to match arbitrarily long exposures.
+
aperture
+
Only apply the preset if the aperture of your image lies within the given range; set f/0 as the lower value to match arbitrarily open apertures; set f/+ as the upper value to match arbitrarily closed apertures.
+
focal length
+
Only apply the preset if the focal length of your image lies within the given range (from 0 to 1000).
+
format
+
Only apply the preset to certain types of image. Check boxes to include files matching these criteria; uncheck boxes to exclude those files. Choose from “raw”, “non-raw”, “HDR”, “monochrome” and “color”.
+
+

🔗managing presets

+

Both user-defined and internal presets can be viewed and managed from within preferences > presets.

+
+

Note: If you create a user-defined preset with the same name as a built-in preset, your preset will override the built-in version, which will no longer be accessible.

+

If you delete a preset that has the same name as one of the built-in presets, then your user preset will be deleted, and that preset name will no longer appear in the preset menu at all. The next time you start darktable, the corresponding built-in preset will once again become visible.

+
+

🔗module naming in the darkroom view

+

By default, if the current parameters of a processing module match those of a saved preset, darktable will attempt to automatically set the name (label) of the module in question, as follows:

+
    +
  • If the user has manually amended the name of the module in the current image, the module name will be left unchanged,
  • +
  • If the module instance from which the preset was created had a manually-set name, any subsequent module that matches this preset will automatically be given the same name. Note that if this was unintentional, the only way to revert will be to drop and recreate the preset, since the automatic name is a hidden field in the database,
  • +
  • If the module instance from which the preset was created did not have a manually-set name, the name of any subsequent module that matches this preset will be set to the same as the preset name.
  • +
+

As soon as the module parameters are changed such that it no longer matches a preset, the module’s name will be reset.

+

This functionality can be disabled in preferences > darkroom > automatically update module name.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/presets/new_preset.png b/en/darkroom/processing-modules/presets/new_preset.png new file mode 100644 index 0000000000..eb863a4c02 Binary files /dev/null and b/en/darkroom/processing-modules/presets/new_preset.png differ diff --git a/en/darkroom/processing-modules/wavelets/clean-retouch.png b/en/darkroom/processing-modules/wavelets/clean-retouch.png new file mode 100644 index 0000000000..9ba103eb1c Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/clean-retouch.png differ diff --git a/en/darkroom/processing-modules/wavelets/clean-spline.png b/en/darkroom/processing-modules/wavelets/clean-spline.png new file mode 100644 index 0000000000..9f71b8bc88 Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/clean-spline.png differ diff --git a/en/darkroom/processing-modules/wavelets/index.html b/en/darkroom/processing-modules/wavelets/index.html new file mode 100644 index 0000000000..9fa465583c --- /dev/null +++ b/en/darkroom/processing-modules/wavelets/index.html @@ -0,0 +1,3177 @@ + + + + + +darktable user manual - wavelets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Darkroom / processing modules / wavelets + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ wavelets +

+ + + +

Wavelets are used to separate (or decompose) an image into a number of distinct layers, each containing a different level of detail. After decomposing an image in this way, a module can limit its processing to one or more of these detail layers, and then piece the layers back together again at the end to form its output. This allows us to be surgical about which features in the image we wish to impact when working with a module.

+

Some of the operations that darktable can perform in this way are:

+ +

🔗theory

+

A wavelet is an oscillating mathematical function that starts and ends at zero. The following diagram shows some simple wavelets of differing sizes.

+

+ + + + + + + + +wavelets-overview + +

+

These wavelet functions are used to scan and decompose an image using a mathematical operation called convolution. This picks out details from the image that are on a similar scale to the size of a given wavelet, and builds a number of these detail layers, each corresponding to a different wavelet scale.

+

The following is an example where detail layers have been extracted from the above image. In this case, the images were produced using the retouch module, splitting the image into 8 different layers, and using the module’s “display wavelet scale” button to visualise each of the detail layers:

+

+ + + + + + + + +wavelets-retouch-gui + +

+

The bars in the wavelet decompose section indicate the layers that have been extracted at different wavelet scales. The darkest rectangle at the left represents the entire image (before decomposition) and the gray boxes each represent one of the decomposed layers. Clicking on the staircase icon below the bar graph enables the layer visualization overlay so that you can see what the currently selected layer looks like.

+

Let’s take a look at some of the layers generated for the above image.

+

At scale #2, the image contains only very fine details, including the model’s eyebrows, eye lashes and the pores of his skin. It doesn’t include the coarser details of the image, because those details have been extracted to other layers:

+

+ + + + + + + + +wavelets-layer-scale-2 + +

+

At scales #5 and #6 we begin to see larger and larger features:

+

+ + + + + + + + +wavelets-layer-scale-5 + +

+

+ + + + + + + + +wavelets-layer-scale-6 + +

+

By scale #8 we only see very high-level features such as the overall shape of the model’s nose, eye and cheek:

+

+ + + + + + + + +wavelets-layer-scale-8 + +

+

🔗why use wavelets?

+

Suppose, in the above example, that we wanted to smooth out some of the blotchiness in the model’s skin, without losing any of the underlying small-scale texture. Wavelet decomposition makes this a trivial operation - we can simply use the retouch module to apply a Gaussian blur to only the ‘blotchy’ detail layer(s), leaving all other layers untouched. Once the adjustment is complete, the retouch module simply recombines the adjusted layer with the remaining untouched layers to produce the final image.

+

The sequence of images below shows (1) The original image; (2) The layer (scale 5) that we wish to blur; and (3) The final image after the scale 5 layer has been blurred and the layers recombined:

+

+ + + + + + + + +wavelets-original + +

+

+ + + + + + + + +wavelets-layer-scale-5 + +

+

+ + + + + + + + +wavelets-blur-layered + +

+

As you can see, the large-scale skin blotches have been removed, but the small-scale details remain untouched.

+

🔗interacting with wavelet scales

+

There are two methods by which processing modules allow you to modify their operation using wavelet scales.

+

🔗wavelet decomposition

+

As discussed above, the retouch module allows you to choose how many detail levels to split your image into. It decomposes the image into separate layers and allows you to perform operations selectively on each individual layer or on the image as a whole:

+

+ + + + + + + + +wavelets-retouch-gui + +

+

See the retouch module documentation for more details.

+

🔗spline controls

+

The denoise (profiled), raw denoise and contrast equalizer modules allow their effects to be applied more or less to each wavelet scale using splines.

+

+ + + + + + + + +spline + +

+

Here, each node in the graph represents a different level of detail in the image, from coarse detail on the left to fine detail on the right. You can raise or lower each of these nodes with your mouse to increase or decrease the module’s effect, respectively, on that wavelet scale.

+

To modify the curve, click slightly above or below the line near to a node and drag up or down. You can change the width of your modification by scrolling with your mouse wheel, which increases or reduces the size of the circle displayed under your mouse pointer. A small circle indicates that the effect of dragging the curve up or down will be isolated mostly to the node being adjusted. A larger circle indicates that the effect will be more broad and will increasingly impact adjacent nodes. When you hover your mouse over the graph, shaded areas indicate the parts of the spline that will be impacted when you attempt to modify the curve.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/darkroom/processing-modules/wavelets/wavelets-blur-layered.png b/en/darkroom/processing-modules/wavelets/wavelets-blur-layered.png new file mode 100644 index 0000000000..84b5f05f27 Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-blur-layered.png differ diff --git a/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-2.png b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-2.png new file mode 100644 index 0000000000..4ed10a92c2 Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-2.png differ diff --git a/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-5.png b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-5.png new file mode 100644 index 0000000000..0a4112382d Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-5.png differ diff --git a/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-6.png b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-6.png new file mode 100644 index 0000000000..9a4ca14efd Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-6.png differ diff --git a/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-8.png b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-8.png new file mode 100644 index 0000000000..39dfa183fa Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-layer-scale-8.png differ diff --git a/en/darkroom/processing-modules/wavelets/wavelets-original.png b/en/darkroom/processing-modules/wavelets/wavelets-original.png new file mode 100644 index 0000000000..812f9a7ef8 Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-original.png differ diff --git a/en/darkroom/processing-modules/wavelets/wavelets-overview.png b/en/darkroom/processing-modules/wavelets/wavelets-overview.png new file mode 100644 index 0000000000..11147160b3 Binary files /dev/null and b/en/darkroom/processing-modules/wavelets/wavelets-overview.png differ diff --git a/en/darktable-logo.png b/en/darktable-logo.png new file mode 100644 index 0000000000..3df6449a9a Binary files /dev/null and b/en/darktable-logo.png differ diff --git a/en/darktable_user_manual.epub b/en/darktable_user_manual.epub new file mode 100644 index 0000000000..c3ea7a22ec Binary files /dev/null and b/en/darktable_user_manual.epub differ diff --git a/en/darktable_user_manual.pdf b/en/darktable_user_manual.pdf new file mode 100644 index 0000000000..998d099700 Binary files /dev/null and b/en/darktable_user_manual.pdf differ diff --git a/en/guides-tutorials/batch-editing/index.html b/en/guides-tutorials/batch-editing/index.html new file mode 100644 index 0000000000..5c78648b21 --- /dev/null +++ b/en/guides-tutorials/batch-editing/index.html @@ -0,0 +1,3054 @@ + + + + + +darktable user manual - batch-editing images + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Guides & Tutorials / batch-editing images + +
+ + + + +
+ +

+ batch-editing images +

+ + + +

Batch-editing is the process of developing images in a semantically-related series that are expected to have a consistent final look, often with the intent of publishing the images in catalogues, magazines or books. It can be a tedious, frustrating and unexciting task, so darktable includes functionality to help make it faster and more reliable.

+

🔗preparation

+

🔗shooting color checkers

+

Shooting a color checker on-location can save a tremendous amount of time during batch post-processing of a series of images. The image of the color checker can be quickly used as a color reference in the post-processing workflow to neutralize any color cast – Datacolor and X-Rite color checkers (24 and 48) are natively supported.

+

🔗prefer consistent lighting conditions

+

If possible, use controlled artificial lighting to maintain consistent lighting over the series of images. This means that you won’t have to worry about light color temperature and intensity changes between images. Shoot a new image of the same color checker every time your lighting conditions change.

+

🔗prefer manual mode

+

If possible, shooting in manual mode with constant exposure settings will help to remove some variability in the series. In terms of post-processing, any variation means that individual adjustments will be needed on each image, which will hinder your productivity.

+

🔗post-processing

+

🔗concepts

+

The post-processing needs to be split in 2 fully separated parts:

+
    +
  1. primary color-grading,
  2. +
  3. secondary color-grading.
  4. +
+

Primary color-grading is performed first in the pixel pipeline and in the editing workflow, with modules such as exposure, input color profile and color calibration. Its purpose is to normalize each image to the same neutral ground-truth, in terms of overall brightness, color accuracy and white balance. This stage aims at making all images look similarly boring by removing any color cast and ensuring a perfectly neutral white, and is particularly important if your series uses different cameras. Primary color-grading is not about artistic intent or expression, but simply about preparing a sane and consistent basis for the next stage.

+

Secondary color-grading happens next in the pixel pipeline and in the editing workflow. This is where all the artistic expression happens, with modules such as color balance rgb. If and only if the primary color-grading was successful at perfectly neutralizing all images to the same ground-truth, copying and pasting the secondary color-grading steps between images should have exactly the same visual effect on each image, no matter if the images were shot with a different camera or under slightly different lighting conditions.

+

In a nutshell, the whole purpose of the primary color-grading is to ensure the repeatability of the secondary color-grading between images. For example, if a non-neutral white balance is expected in the series, it is much easier to re-introduce non-neutrality in color balance rgb (using the same color shift) on fully-neutralized images, than to fine-tune the primary color-grading individually on each image, especially if several different cameras were used.

+

🔗method

+

🔗profiling the series

+

You will first need to extract a color calibration profile from the image(s) of your color checker. This profile can then be applied to all images shot under the same lighting conditions with the same camera by copying and pasting the development history stack in the lighttable view. This step needs to be repeated for each camera and lighting setup.

+
+

Note: this process only works with the modern chromatic adaptation workflow, which assumes hard-setting the white balance to a D65 (camera reference) illuminant. See the documentation in the color calibration module for more information.

+
+

🔗editing the reference image

+

Choose a reference image that was taken in the lighting conditions closest to those of the color checker image that served as your profiling reference. Your primary color-grading should already be handled by the profile used in the color calibration module (in conjunction with the input color profile module). What remains to complete this stage is to adjust the exposure setting to match the overall brightness that you expect.

+

Next, proceed with the filmic rgb white and black relative exposures, as well as the contrast setting. Finish with the secondary color-grading.

+

When this is done, you can measure the brightness and chromaticity of a control sample, preferably located on a non-moving surface that is consistently lit across your series (and appearing in all the frames). These measurements are taken using the area exposure mapping and color calibration area mapping tools. They will be memorized and will serve as a target for individual images as needed.

+

🔗propagating the look

+

You can then propagate your secondary color-grading (including filmic rgb) to all the other images of the series, no matter whether or not they were shot in the same lighting conditions, since you should already have propagated your primary color-grading (calibration profile) to the relevant images. Don’t forget to paste the history using append mode or you will overwrite your primary color-grading as well.

+

However, this alone will not ensure a consistent look for the whole series.

+

🔗fine-tune individual settings

+

If there was some variability in your lighting conditions, each image will need some further fine-tuning adjustments. Fortunately, if you have applied the proposed method so far, this should be relatively straightforward.

+

First, homogenize the exposure using your control sample and the area exposure mapping tool.

+

Then, adjust the filmic rgb white relative exposure if needed, preferably using the picker. The contrast should not require any adjustment since it does not depend on the dynamic-range of the image.

+

Finally, homogenize the chromatic adaptation, using your control sample and the color calibration area mapping tool.

+

This should get you close enough in most cases. However, if the background has changed, it is possible that these fine adjustments (aimed towards technically normalizing the primary color-grading on an individual basis) are not sufficient to give a perceptually-even look. In this case, you will need an extra step of secondary color-grading, which you are advised to perform on top of the previous one (shared with the other images of the series), in new instances of the relevant modules located later in the pipe. This ensures that the base secondary color-grading stays constant for all images and makes for a better workflow. You are not advised to make large changes in the primary color-grading to manage perceptual discrepancies involving contrast with the background.

+

🔗controlling your series

+

The culling mode in the lighttable view will help you to compare images side-by-side when the work is done. To view your reference edit in the darkroom view, you may display the filmstrip and increase its height, or use a snapshot of the reference overlaid on the current image (which will not necessarily have the same size).

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/guides-tutorials/index.html b/en/guides-tutorials/index.html new file mode 100644 index 0000000000..37289d4084 --- /dev/null +++ b/en/guides-tutorials/index.html @@ -0,0 +1,3029 @@ + + + + + +darktable user manual - Guides & Tutorials + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Guides & Tutorials + +
+ + + + +
+ +

Guides & Tutorials

+ +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/guides-tutorials/index.xml b/en/guides-tutorials/index.xml new file mode 100644 index 0000000000..55408489b2 --- /dev/null +++ b/en/guides-tutorials/index.xml @@ -0,0 +1,32 @@ + + + + Guides & Tutorials on darktable user manual + https://darktable-org.github.io/dtdocs/en/guides-tutorials/ + Recent content in Guides & Tutorials on darktable user manual + Hugo + en + + + developing monochrome images + https://darktable-org.github.io/dtdocs/en/guides-tutorials/monochrome/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/guides-tutorials/monochrome/ + Photography has a long history of producing monochrome images, and many still enjoy this aspect of photography. While there are some specialized/modified cameras with a truly monochrome sensor, most still use a regular camera to capture a color image and transform it into a monochrome image during post-processing. There are two main approaches to this conversion: A physical approach, where we attempt to simulate how a silver-based photographic film emulsion would react to the light captured at the scene. + + + batch-editing images + https://darktable-org.github.io/dtdocs/en/guides-tutorials/batch-editing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/guides-tutorials/batch-editing/ + Batch-editing is the process of developing images in a semantically-related series that are expected to have a consistent final look, often with the intent of publishing the images in catalogues, magazines or books. It can be a tedious, frustrating and unexciting task, so darktable includes functionality to help make it faster and more reliable. 🔗preparation 🔗shooting color checkers Shooting a color checker on-location can save a tremendous amount of time during batch post-processing of a series of images. + + + other resources + https://darktable-org.github.io/dtdocs/en/guides-tutorials/other-resources/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/guides-tutorials/other-resources/ + For help and support with using darktable you are encouraged to ask questions on the main discussion forums at discuss.pixls.us. The official places to obtain information concerning darktable are the following: darktable.org GitHub wiki The following articles provide some useful background information about darktable&rsquo;s scene-referred workflow: darktable 3.0 for dummies in 3 modules darktable 3.0 for dummies &ndash; hardcore edition darktable 3.0: RGB or Lab? Which modules? Help! darktable&rsquo;s filmic FAQ Introducing color calibration module The following resources can provide a deeper understanding of the functionality of some specific processing modules: + + + diff --git a/en/guides-tutorials/monochrome/index.html b/en/guides-tutorials/monochrome/index.html new file mode 100644 index 0000000000..b3fc1e573f --- /dev/null +++ b/en/guides-tutorials/monochrome/index.html @@ -0,0 +1,3074 @@ + + + + + +darktable user manual - developing monochrome images + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Guides & Tutorials / developing monochrome images + +
+ + + + +
+ +

+ developing monochrome images +

+ + + +

Photography has a long history of producing monochrome images, and many still enjoy this aspect of photography. While there are some specialized/modified cameras with a truly monochrome sensor, most still use a regular camera to capture a color image and transform it into a monochrome image during post-processing.

+

There are two main approaches to this conversion:

+
    +
  • +

    A physical approach, where we attempt to simulate how a silver-based photographic film emulsion would react to the light captured at the scene.

    +
  • +
  • +

    A perceptual approach, where we develop a color image and reduce the color saturation in a perceptual color space such as CIE Lab.

    +
  • +
+

These approaches, and other monochrome-related features in darktable, are discussed in the following sections.

+

🔗importing and flagging images as monochrome

+

When importing an image, there are a number of properties that can be used to indicate that the image requires a monochrome treatment:

+
    +
  • +

    If the image was taken using an achromatic camera, the image will be automatically flagged as monochrome.

    +
  • +
  • +

    When you capture a scene from which you would like to produce a monochrome image, it can be helpful to put your camera into a “black & white” creative mode. This allows you to visualise what the scene would look like in monochrome through your camera’s liveview screen or electronic viewfinder. The camera will still capture the full color data in the raw file, but the embedded JPEG preview image will be monochrome. When you import such an image, darktable can automatically flag the image as monochrome based on the preview image.

    +

    Checking whether the preview is monochrome slows down the import process, so this is disabled by default. You can enable this check in preferences > processing > detect monochrome previews

    +
  • +
  • +

    When processing a raw file, one of the first steps is to demosaic the image. If you set the demosaicing method to “passthrough (monochrome)”, this discards color information during the demosaicing process, and darktable will flag the image as monochrome.

    +

    Note: You should only use this for images taken on a camera where the color filter array has been removed.

    +
  • +
  • +

    After you have imported the image, you can manually flag an image as monochrome (or not) using the metadata tab on the lighttable’s actions on selection module,

    +
  • +
+

If any of the above methods result in an image being flagged as monochrome, darktable modules can use this information to present the user with some monochrome-specific module controls and/or apply special processing to the image.

+

The darktable|mode|monochrome tag will be automatically applied to any images flagged as monochrome and, if you have enabled any permanent overlay information on your lighttable thumbnails, such images will be marked with a visual indicator B&W next to the file type information. By automatically applying this tag and visual indicator, darktable makes it easy to set up filters to single out images for monochrome treatment, and to see at a glance which images in the current collection bear the monochrome tag.

+

If darktable detects a true monochrome image or one from a monochrome-converted camera (using the “passthrough monochrome” demosaicer) some modules (e.g. demosaic, white balance) are automatically disabled.

+

🔗monochrome conversion

+

🔗physical approach

+

This approach tends to work with linear scene-referred data from the sensor, and attempts to mimic the response of a photographic film with a silver emulsion. It consists of three steps:

+
    +
  1. +

    Map the color channels from the sensor into a single monochrome channel. Different types of monochrome photographic film have different levels of sensitivity to various wavelengths of light, and this can be simulated by giving the three color channels different weightings when combining them together into a single monochrome channel. The color calibration module allows the three channels to be mixed into a gray channel by varying amounts, and it includes a number of presets that are designed to emulate the characteristics of some well-known types of photographic film.

    +
  2. +
  3. +

    Apply a luminosity saturation curve. As a piece of photographic film is exposed to more intense light, its response will fall off as the silver emulsion becomes saturated. This saturation curve can be simulated within the filmic rgb module.

    +
  4. +
  5. +

    Developing a monochrome film in the darkroom traditionally involves “dodging and burning” to control the level of exposure across different parts of the image. This can be emulated in darktable by using either the exposure module with manually created masks, or by using the tone equalizer module, which generates a mask using a guided filter.

    +
  6. +
+

🔗perceptual approach

+

The other option for producing a monochrome image is to reduce the color saturation in the image, which can be done in a linear colorspace, or in a color space oriented towards modelling human perception.

+
    +
  • +

    The color balance module operates in linear RGB, and allows you to reduce the color saturation in the image using either the input or output color saturation slider – which you choose depends on whether you want to make any other adjustments to either the color or monochrome image in the color balance module. The color balance module tends to give a predictable and perceptually-uniform result.

    +
  • +
  • +

    The monochrome module works in Lab color space, and it allows the user to graphically define a weighted combination of colors to determine the density of the blacks in the monochrome image. The interface can be somewhat sensitive to the settings, with small changes producing large effects, and you may experience problems with the global contrast and/or black pixel artifacts.

    +
  • +
  • +

    Other modules such as color zones can also be used to remove color saturation from the image, but these don’t offer any real advantage over the simplicity of the color balance module’s saturation sliders.

    +
  • +
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/guides-tutorials/other-resources/index.html b/en/guides-tutorials/other-resources/index.html new file mode 100644 index 0000000000..388b45f441 --- /dev/null +++ b/en/guides-tutorials/other-resources/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - other resources + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Guides & Tutorials / other resources + +
+ + + + +
+ +

+ other resources +

+ + + +

For help and support with using darktable you are encouraged to ask questions on the main discussion forums at discuss.pixls.us.

+

The official places to obtain information concerning darktable are the following:

+ +

The following articles provide some useful background information about darktable’s scene-referred workflow:

+ +

The following resources can provide a deeper understanding of the functionality of some specific processing modules:

+ +

Some other YouTube channels with recent content on using darktable are:

+ + + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/index.html b/en/index.html new file mode 100644 index 0000000000..65ae10136e --- /dev/null +++ b/en/index.html @@ -0,0 +1,3088 @@ + + + + + + +darktable user manual - darktable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+

darktable is an open source photography workflow application and raw developer — a virtual lighttable and darkroom for photographers. It manages your digital negatives in a database, lets you view them through a zoomable lighttable and enables you to develop and enhance your raw images.

+

The source repository for this documentation may be found at https://github.com/darktable-org/dtdocs.git. Any feedback relating to this documentation can be provided by creating a ticket or a pull request against this repository.

+

You can also click on the following links to download the manual in PDF or epub format.

+

This documentation is released under the GPL 3.0 license.

+ + + +

translations

+ + +
+ + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/index.json b/en/index.json new file mode 100644 index 0000000000..91483fe01e --- /dev/null +++ b/en/index.json @@ -0,0 +1 @@ +[{"categories":null,"content":"Remove image noise while preserving structure.\nThis is accomplished by averaging each pixel with some surrounding pixels in the image. The weight of such a pixel in the averaging process depends on the similarity of its neighborhood with the neighborhood of the pixel being denoised. A patch with a defined size is used to measure that similarity.\nAs denoising is a resource-intensive process, it slows down pixelpipe processing significantly. Consider activating this module late in your workflow.\n🔗module controls patch size The radius of the patch used for similarity evaluation. strength The strength of the denoising. luma The amount of denoising to apply to luma. Select carefully in order not to lose too much structure. chroma The amount of denoising to apply to chroma. You can be much more aggressive with this parameter. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/astrophoto-denoise/","tags":null,"title":"astrophoto denoise"},{"categories":null,"content":"Simulate the in-camera JPEG by applying a characteristic base curve to the image.\ndarktable comes with a number of base curve presets that attempt to mimic the curves of various camera manufacturers. These presets are automatically applied according to the manufacturer ID found in the image\u0026rsquo;s Exif data. Camera-specific base curve presets are also available for some camera models.\nThis module will be enabled by default if preferences \u0026gt; processing \u0026gt; auto-apply pixel workflow defaults is set to \u0026ldquo;display-referred\u0026rdquo;. A second option in the preferences dialog allows you to choose whether darktable should attempt to apply a camera-specific base curve (if found) or the generic manufacturer one.\n🔗module controls Please refer to the curves section for more details about how to modify curves including the scale for graph and preserve colors controls.\nfusion Trigger the exposure fusion feature (see this Wikipedia article). This feature allows you to merge the image with one or two copies of itself after applying the current base curve and boosting its exposure by a selected number of EV units. The resulting image is thus a combination of two or three different exposures of the original image. Use this feature to compress the dynamic range of extremely underexposed images or for true HDR input. For best results, use the exposure module to apply a suitable adjustment for correctly exposed highlights. exposure shift (fusion) The exposure difference between the merged images in EV units (default 1). This slider is only visible if the exposure fusion feature is activated. exposure bias (fusion) Determines how the multiple exposures are computed. With a bias of 1 (the default), the image is fused with overexposed copies of itself. With a bias of -1, it is fused with underexposed copies. A bias of 0 attempts to preserve the overall lightness of the image by combining both over- and underexposed copies of the image. This slider is only visible if the exposure fusion feature is activated. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/base-curve/","tags":null,"title":"base curve"},{"categories":null,"content":"Create a soft bloom effect.\nThis module works by blurring the highlights and then blending the result with the original image.\nNote: This module performs blurs in Lab color space, and is no longer recommended. Instead, use the tone equalizer module or the exposure module with a parametric mask.\n🔗module controls size The spatial extent of the bloom effect. threshold The threshold for the brightness increase. strength The strength of the overlighting. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/bloom/","tags":null,"title":"bloom"},{"categories":null,"content":"Simulate physically-accurate blurs in scene-referred RGB space.\n🔗blur types Three types of blur are provided:\nlens blur: Simulates a lens diaphragm with a configurable number of blades and blade curvature to create synthetic bokeh. motion blur: Simulates the effect of camera motion with a configurable path. gaussian blur: This is not really an optical blur but can be used for denoising or for creative effects using blend modes A diagram at the top of the module shows the shape of the blurring operator (known as the point spread function). The module will turn each luminous point from the scene into a blot shaped like the displayed blurring operator, with the size of the blot defined by the blur radius.\n🔗module controls 🔗general blur radius The spreading size of the blur. blur type Choose between the different blur variants (above). 🔗controls specific to lens blur diaphragm blades The number of blades that the diaphragm is composed of. Older lenses used typically 5 or 7 blades, newer lenses typically use 9 or 11 blades. In any case, real lenses have an odd number of blades and any number greater than 11 blades comes very close to producing a perfect disc. If you degenerate the diaphragm settings with the concavity to create a star or an asterisk, this control defines how many branches it has. concavity a concavity of 1 ensures the diaphragm is a regular convex polygon (triangle, pentagon, heptagon, etc.). a concavity greater than 1 but lower than number of blades - 1 turns the shape into a star. a concavity greater than number of blades - 1 but lower than number of blades turns the shape into an asterisk, when decreasing linearity below 1. a concavity greater than or equal to number of blades degenerates the shape into a \u0026ldquo;burst pattern\u0026rdquo;. linearity a linearity of 0 creates a disc, no matter the number of blades or the concavity. a linearity of 1 makes all the outer bounds of the shape straight. a linearity between 0 and 1 makes the outer bounds of the shape more or less curved. rotation Allows the shape to be rotated with respect to its center \u0026ndash; mostly useful with a small number of blades, when a particular orientation is needed. 🔗controls specific to motion blur direction The orientation of the motion\u0026rsquo;s path in angular degrees. 0° is horizontal motion. curvature The curvature of the motion. Zero produces a straight line, a negative value produces a concave curvature, a positive value produces a convex curvature. offset Shifts along the motion path following its curve. This is useful to select a portion of the curved path that is symmetrical, which produces a coma shape (example 1: direction = -45°, curvature = +2, offset = +0.5 ; example 2 : direction = -45°, curvature = +1, offset = +1). 🔗caveats This module is implemented using a \u0026ldquo;naive\u0026rdquo; convolution, which is a slow algorithm. Faster approaches are available (using FFT) but not yet implemented. The GPU implementation, through OpenCL, should hide this issue somewhat. In any case, the runtime of the module will increase with the square of the blur radius.\nThe blurring process does not take scene depth and depth-of-field into account, but blurs the whole image as a flat object. It is therefore not suitable for creating fake depth-of-field. Using darktable\u0026rsquo;s general masking will only partially work to isolate the foreground of an image, since it will still be blurred into the background.\n🔗tips and tricks All images are usually (even a tiny bit) noisy. If you blur only a part of the image, the blurred region will look suspiciously clean compared to the rest of the image. It is therefore a good idea to add a bit of noise on top of the blurred part to blend it with the rest, using either the grain or the censorize modules.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/blurs/","tags":null,"title":"blurs"},{"categories":null,"content":"Degrade parts of the image in an aesthetically pleasing way, in order to anonymize people/objects or hide body parts.\nCensorize works in linear RGB color space to apply a physically-accurate gaussian blur and gaussian luminance noise.\nAside from anonymization, this module can also be used for a wide range of creative purposes, for example:\nCombine a simple blur with a multiply blend mode to create a realistic bloom (Orton effect). Combine a simple blur with a subtract blending mode and low opacity to create an unsharp mask, similar to the sharpen module but in an RGB scene-referred space. Add noise to create artificial grain. Note: The anonymizing methods provided by this module are not forensically safe in order to favor aesthetics. Some forensic techniques may still be able to reconstruct the censorized content based on its structure, especially for simple shapes and text (e.g. license plates, street numbers).\nIf forensically safe anonymization is required, the only way to achieve this is to paint the surfaces with a solid color.\nThe darktable team does not accept responsibility for poorly anonymized pictures leading to the identification of individuals or personal property.\n🔗workflow You are advised to leave the module\u0026rsquo;s controls at their default values while you mask the areas of the image that you wish to censorize, in order that the details of the image remain visible.\n🔗module controls input blur radius The strength of the first pass of the gaussian blur. pixellation radius The size of the \u0026ldquo;big pixels\u0026rdquo; created after the first pass of gaussian blur. output blur radius The strength of the second pass of the gaussian blur, applied after the pixellation. noise level The strength (standard deviation) of the luminance gaussian noise applied after the second pass of the gaussian blur. Adding noise can fake details in the blurred regions and make content detection more difficult for artificial intelligence algorithms. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/censorize/","tags":null,"title":"censorize"},{"categories":null,"content":"Correct chromatic aberrations.\nIn contrast to the raw chromatic aberrations module, this module does not require raw data as input.\n🔗workflow To obtain the best result, you are advised to proceed as follows:\nAttenuate the chromatic aberrations as much as possible in the lens correction module using the TCA sliders. Increase the strength slider in this module to better see its effect. Increase the radius until the chromatic aberrations disappear. If this is insufficient, try enabling the \u0026ldquo;very large chromatic aberrations\u0026rdquo; setting. Choose the guide that gives the best result in term of sharpness and artifacts. Reduce the strength to avoid washing out the colors too much. For more complicated cases you could also try the following:\nUse several instances with different correction modes \u0026ndash; for example, a first instance in \u0026ldquo;brighten only\u0026rdquo; mode, and a second in \u0026ldquo;darken only\u0026rdquo; mode. Use several instances with low strength to correct the chromatic aberrations a little at a time without degrading colors too much. Use the module with parametric or drawn masks. Use RGB red, green and blue blend modes to restrict the effect to a particular channel. 🔗module controls guide The color channel that will be used as a reference for the correction. radius The radius of the effect. Increase until chromatic aberrations are eliminated. This is the most important slider of the module. strength This slider acts as a safeguard and can help to preserve colorful areas that do not suffer from chromatic aberrations. Increase for stronger correction, decrease for stronger preservation. correction mode Allows you to restrict the effect to brighten or darken pixels only. For full control, this can be used in combination with R, G, B blend modes and multiples instances. very large chromatic aberrations Makes the algorithm iterative to help in reducing very large chromatic aberrations. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/chromatic-aberrations/","tags":null,"title":"chromatic aberrations"},{"categories":null,"content":"A versatile tool for adjusting the image\u0026rsquo;s color balance.\nThis module can be used to revert parasitic color casts or to enhance the visual atmosphere of an image using color grading, a popular technique in the cinema industry. For scene-referred workflow, you should consider using the improved color balance rgb module instead.\n🔗overview The color balance module allows you to shift colors selectively by luminance range (shadows, mid-tones, and highlights). It can do this using two different methods:\nlift, gamma, gain The classic method, which allows a more separated control of shadows versus highlights. slope, offset, power The new standard defined by the American Society of Cinematographers Color Decision List (ASC CDL) and more suited to scene-referred editing. The master settings affect the whole image. They are not available in lift, gamma, gain (sRGB) mode. The slider ranges are limited to usual values ([50%; 150%] for saturation, [-50%; 50%] for contrast), but higher and lower values can be defined via keyboard input after right-clicking on the corresponding slider.\nFor better efficiency, in slope, offset, power mode it is recommended that you set the slope first, then the offset, and finally the power, in that order. The name of the mode can be use as a mnemonic to remember the order.\nThe shadows parameter has a far heavier effect in slope, offset, power mode than in lift, gamma, gain mode. When switching from the former to the latter, you should adapt the saturation in shadows, dividing by around 10.\nNote: Although this module acts on RGB colors its location in the pixelpipe puts it into the Lab color space. Accordingly the module converts from Lab to RGB, performs its color adjustments, and then converts back to Lab.\n🔗presets Several presets are provided in this module to help you to better understand how it can best be used. The \u0026ldquo;teal/orange color-grading\u0026rdquo; preset is a very popular look in cinema and is a good showcase model. It is meant to be used with two instances combined with masks. The first instance will exclude skin tones and will shift neutral colors toward teal blue. The second will partially revert the first one and add more vibrance to skin tones only. Together they will create separation between subject and background. The masking and blending parameters will need to be tweaked to suit every image.\nOther presets provide Kodak film emulations. In this way you can recreate any film look you like using color balance.\n🔗module controls mode lift, gamma, gain (sRGB) is the legacy mode from darktable 2.4 and earlier. In this mode, the color transformations are applied in sRGB color space encoded with the sRGB gamma (average gamma of 2.2). lift, gamma, gain (ProPhoto RGB) is the same as the previous mode but works in ProPhoto RGB space, encoded linearly. In this mode, the RGB parameters are corrected in XYZ luminance (Y channel) internally so they affect only the color, and only the “factors” adjust the luminance.\nslope, offset, power (ProPhoto RGB) applies the ASC CDL in ProPhoto RGB space, encoded linearly. As with the previous mode, the RGB parameters are corrected in XYZ luminance internally. In this mode, the slope parameter acts as an exposure compensation, the offset acts as a black level correction, and the power acts as a gamma correction. All parameters will have some impact on the whole luminance range but the slope will mostly affect the highlights, the offset will mostly affect the shadows, and the power will mostly affect the mid-tones.\ncolor control sliders This combobox selection affects the user interface used for the shadows, mid-tones and highlights controls. RGBL controls allow direct access to the RGB parameters that will be sent to the algorithm and internally adjusted in XYZ luminance, depending on the mode used. They are the only ones stored in darktable\u0026rsquo;s development history.\nHSL controls are more intuitive, but are only an interface: the hues and saturations are computed dynamically from and to the RGB parameters and never stored. During the HSL to RGB conversion, the HSL lightness is always assumed to be 50%, so the RGB parameters are always balanced to avoid lightness changes. However, during the RGB to HSL conversion, the HSL lightness is not corrected.\nAs a consequence, editing in RGB, then in HSL, then again in RGB will not retain the original RGB parameters, but will normalize them so their HSL lightness is 50%. The difference is barely noticeable in most cases, especially using the modes that already correct the RGB parameters internally in XYZ luminance.\nIn both modes, additional “factor” sliders act on all RGB channels at once. Their effect is similar to the controls of the levels module and affect only the luminance.\ninput saturation A saturation correction applied before the color balance. This can be used to dampen colors before adjusting the balance, to make difficult images easier to process. When you entirely desaturate the image, this creates a luminance-based monochrome image that can be used as a luminance mask, to create color filters with the color balance settings, like a split-toning or sepia effect (when used with blending modes). output saturation A saturation correction applied after the color balance. This is useful once you have found a proper hue balance but find the effect too heavy, so you can adjust the global saturation at once instead of editing each channel saturation separately at the expense of possibly messing up the colors. contrast / contrast fulcrum The contrast slider allows the luminance separation to be increased. The fulcrum value defines the luminance value that will not be affected by the contrast correction, so the contrast will roll over the fulcrum. Luminance values above the fulcrum will be amplified almost linearly. Luminance values below the fulcrum value will be compressed with a power function (creating a toe). This correction comes after the output saturation and is applied on all RGB channels separately, so hues and saturations might not be preserved in case of dramatic settings (shadows might be resaturated, highlights might be desaturated, and some color shift is to be expected). shadows, mid-tones, highlights Depending on the mode used, the shadows settings will control either the lift or the offset, the mid-tones settings will control either the gamma or the power, and the highlights settings will control either the gain or the slope. Parameters are transferred unaltered when you change the mode. In RGBL mode, the RGB sliders\u0026rsquo; range is limited to [-0.5; 0.5]. In HSL mode, the saturation sliders range is limited to [0%; 25%]. Values outside of these bounds can be defined with keyboard input by right-clicking on the slider.\nNote: The shadows, mid-tones and highlights sliders can take up a great deal of space in the color balance module. The overall layout of these sliders can therefore be cycled through three different layouts by clicking on the shadows, mid-tones, highlights heading.\noptimize luma The picker beside the optimize luma label will select the whole image and optimize the factors for shadows, mid-tones and highlights so that the average luminance of the image is 50% Lab, the maximum is 100% and the minimum is 0%, at the output of this module. This is essentially histogram normalization, similar to that performed by the levels module. The optimizer is only really accurate when used in slope, offset, power mode. If you want more control, you can define three control patches by using the pickers beside each factor slider to sample luminance in selected areas. The shadows picker samples the minimum luminance, the mid-tones picker samples the average luminance, and the highlights picker samples the maximum luminance. The most sensitive parameter is the mid-tones factor, since selecting a slightly different area can lead to dramatic parameter changes. Using the factors pickers alone, without triggering the luma optimization, will allow you to perform adjustments without general optimization, but each parameter is always computed taking the other two into account. Once patches are selected, the label changes to read “optimize luma from patches”. To reset one patch, you can just redo the selection. Patches are not saved in the parameters and are retained only during the current session.\nIt is important to note that the luminance adjustment targets only the output of the color balance module and does not account for adjustments performed in other modules later in the pixelpipe (e.g. filmic rgb, tone curve, color zones, levels). Using the color balance module to remap the luminance globally on the image is not recommended because it does not preserve the original colors \u0026ndash; modules such as tone curve or filmic rgb are better suited for this purpose. Luminance adjustments in color balance are better performed, in combination with color adjustments, using masks.\nneutralize colors In an image where some areas are exposed to direct sunlight and some areas are exposed to reflected light (shadows), or where several artificial light sources are present simultaneously, shadows and highlights often have different color temperatures. These images are particularly difficult to correct since no general white balance will match all the colors at once. The color neutralization optimizer aims at helping you find the complementary color for shadows, mid-tones, and highlights so that all the color casts are reverted, and the average color of the image is a neutral gray. As with the luma optimization, the picker beside the neutralize colors label will trigger a general optimization over the whole image. This works fairly well in landscape photography, or for any photograph with a full spectrum of colors and luminances.\nFor night and events photography, this will most likely fail and you will need to manually input the sampling areas with the picker beside each hue slider. For the highlights sample, use a color exposed to spotlights that should be neutral white or light gray. For the shadows sample, use a color exposed to ambient light that should be neutral black or dark gray. For the mid-tones sample, use a color exposed by both ambient and spotlights.\nThe success of the optimization depends on the quality of the samples. Not every set of samples will converge to a good solution and you need to ensure that the color patches you choose are really a neutral color in real life. In many cases the optimizer will output the correct hue but an excessive saturation that will need some extra tweaking. In some cases, no valid optimization will be delivered and you will need to reset the saturation parameters and start over, or simply stop after the patches selection. Note that in the auto-optimization, the maximum saturation is 25%, which might not be enough in very few cases but will avoid inconsistent results in most.\nIf you select color patches from the hue pickers without triggering the optimization, the software will only perform one round of optimization and then stop. This allows you to control each luminance range separately and avoid divergence of the solution in corner cases. The hue and saturation corrections are computed taking into account the two other luminance ranges and three factors, and will always output the complementary color of the selected area. If you want to reinforce the color of the area instead, you can then add 180° to the computed hue. Once patches are selected, the label changes to read “neutralize colors from patches”. To reset one patch you can just redo the selection. Patches are not saved in the parameters and are retained only during the current session. The parameters found by the automatic neutralization are accurate only in slope, offset, power mode, but can work to some extent in lift, gamma, gain mode too.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-balance/","tags":null,"title":"color balance"},{"categories":null,"content":"An advanced module which brings color-grading tools from cinematography into the photographic scene-referred pipeline.\nThis module is not suitable for beginners with no prior knowledge of color theory, who might want to stick to the global chroma and global vibrance settings until they have a good understanding of the dimensions of color.\n🔗introduction Color-grading is an important part of image editing. It can help to remove unwanted color casts and can also deliver a creative color twist that will add atmosphere to your images. In the days of film photography, most of the color ambiance was obtained with the film emulsion and the developing chemicals, with some color timing being performed under the enlarger with color heads. This consumed expensive resources and was mostly reserved for the cinema industry, where the job was performed by a colorist.\nIn the digital age, where raw images look flat and even, color-grading assumes the same role that film emulsions did, by re-introducing color shifts for aesthetic purposes. It can also serve to harmonize the color palette of a series of images (which may have been shot under different conditions) to achieve a consistent global look. For this task, the vectorscope is also extremely useful.\nColorists usually split color-grading into two distinct steps:\nPrimary color-grading aims to fix unwanted color casts and create a neutral starting point, Secondary color-grading gives the image its final look and atmosphere. Primary color-grading is best left to the color calibration module, which operates in a physical framework better suited to illuminant correction. Color balance RGB, on the other hand, is mostly concerned with secondary color-grading. Performing a truly neutral primary color-grading should make the secondary color-grading easy to transfer between images (via styles, presets or copy \u0026amp; paste) with a similar effect.\n🔗general principles The color balance RGB module is an improvement over the American Society of Cinematographers Color Decision List (ASC CDL), and uses alpha masks to allow the effect to be properly split between shadows and highlights. The classic CDL acts on the entire luminance range, and each of its parameters is given more weight on some parts of the image only as a side-effect of the mathematics.\nThis module works, for the most part (4 ways, chroma, vibrance, contrast), in a linear RGB color space designed specifically for color-grading. This color space exhibits a uniform spacing of perceptual hues while retaining a physically-scaled luminance1. The perceptual part of the module (saturation and brilliance) works in the JzAzBz2 color space, which provides a perceptual scaling of both lightness and chromaticity suitable for HDR images. Both color spaces ensure that saturation and chroma changes take place at constant hue, which is not the case for most other saturation operators in darktable (notably in the older color balance module).\nThe color balance RGB module expects a scene-referred linear input and produces a scene-referred RGB output, which may or may not be linear, depending on the module settings (contrast and power will delinearize the output).\nAt its output, color balance RGB checks that the graded colors fit inside the pipeline RGB color space (Rec. 2020 by default) and applies a soft saturation clipping at constant hue, aiming to retarget out-of-gamut color to the nearest in-gamut color by scaling both chroma and lightness. This prevents the chroma and saturation settings from pushing colors outside of the valid range and allows more drastic adjustments to be safely used.\nNote that this module abides by the CIE definitions of chroma and saturation, as explained in the dimensions of color section.\n🔗module controls 🔗master tab hue shift Rotate all colors in the image by an angle over the chromaticity plane, at constant luminance and chroma. You can use this control to remove spilled colored light on a subject or to quickly change the color of some object. This setting is usually best applied locally, using masks. global vibrance This affects the chroma dimension of color over the entire image, prioritizing those colors with low chroma. This allows the chroma of neutral colors to be increased without exaggerating already-colorful pixels. contrast This setting is applied on the luminance channel at constant hue and chroma. The fulcrum setting (in the masks tab, under contrast gray fulcrum) allows you to set the neutral point of the contrast curve: at the fulcrum, the contrast curve leaves the luminance unchanged, below the fulcrum, the contrast curve decreases the luminance for positive contrast values, or increases it for negative values, above the fulcrum, the contrast curve increases the luminance for positive contrast values, or decreases it for negative values. The fulcrum has a value of 18.45% by default, which is consistent with the current scene-referred workflow and should fit most use cases (assuming that global brightness has been fixed as recommended using the exposure module).\nThe contrast algorithm gives natural results that mimic the central part of the contrast curve of analog film. However, it will also increase the image\u0026rsquo;s dynamic range, which may void filmic settings in the pipe. For global contrast adjustments, you should normally use the tone equalizer module \u0026ndash; the color balance RGB contrast slider is best used with masks, e.g. for selective corrections over the foreground or background.\n🔗linear chroma grading Linear chroma grading affects the chroma dimension proportionally to its input value, at constant hue and luminance. It does this globally, with a flat coefficient (using the global chroma), as well as on each of the shadows, mid-tones and highlights masks (defined in the masks tab under luminance ranges).\n🔗perceptual saturation grading Perceptual saturation grading affects both the luminance and the chroma dimensions, in a perceptual space, proportionally to its input value, at constant hue. It does this globally, with a flat coefficient (using the global saturation), as well as on each of the shadows, mid-tones and highlights masks (defined in the masks tab under luminance ranges).\n🔗perceptual brilliance grading Perceptual brilliance grading affects both the luminance and the chroma dimensions, in a perceptual space, proportionally to its input value, at constant hue, and in a direction orthogonal to the saturation. Its effect is close to that of changing exposure, but scaled perceptually. It does this globally, with a flat coefficient (using the global saturation), as well as on each of the shadows, mid-tones and highlights masks (defined in the masks tab under luminance ranges).\n🔗4 ways tab Each of the settings in the 4 ways tab is composed of the same three components, which define a color using independent coordinates:\nluminance, hue, chroma. Color input like this defines a color shift applied to the image globally or over the specified luminance range.\nEach hue slider has a picker, which may be used to compute the opponent color of the selected region. This is useful to revert unwanted color casts (e.g. skin redness), since shifting the color to its opponent cast neutralizes it.\n🔗global offset This is equivalent to the ASC CDL offset and falls back to adding a constant RGB value to all pixels, quite like the black offset in the exposure module. This control does not use masking.\n🔗shadows lift This is conceptually equivalent to the lift from lift/gamma/gain, although implemented differently, and falls back to multiplying the masked pixels by a constant RGB value. It is applied using the shadows mask.\n🔗highlights gain This is equivalent to the ASC CDL slope, and falls back to multiplying a the masked pixels by a constant RGB value. It is applied using the highlights mask.\n🔗global power This is equivalent to the ASC CDL power, and falls back to applying a constant RGB exponent. It is not masked and needs to be normalized, since the power function has a different behaviour above and below 1, and we are in an unbounded pipeline where white is typically greater than 1. The normalization parameter is available in the masks tab under white fulcrum.\n🔗masks tab This tab defines auxiliary controls for the previous tabs. Masking controls typically don\u0026rsquo;t require any user modification since the defaults are calibrated to suit most needs and fulfil the normal scene-referred pixel pipeline expectations. You should only need to change these settings in specific scenarios.\n🔗luminance ranges The graphs show the opacity (on the y axis) of the 3 luminance masks relative to the pixel luminance (on the x axis). The darkest curve represents the shadows mask, the brightest represents the highlights mask, and the third curve represents the mid-tones mask.\nOnly the shadows and highlights masks can be controlled directly \u0026ndash; the mid-tones mask is computed indirectly from the others and acts as an adjustment variable.\nshadows fall-off Control the softness or hardness of the transition from fully opaque (100%) to fully transparent (0%) for the shadows mask. mask middle-gray fulcrum Set the luminance value where all three masks have 50% opacity. In practice, this is used to define how the image is separated into shadows and highlights. highlights fall-off Control the softness or hardness of the transition from fully opaque (100%) to fully transparent (0%) for the highlights mask. For each of these settings, a mask button, provided to the right of the slider, displays the appropriate mask (shadows, mid-tones, highlights), overlaid as a checker board. The still-visible area of the image (not hidden by the mask) is the area that will be affected by the shadows, mid-tones and highlights sliders in the other tabs.\nAll mask previews display the output of the module, including any color changes made, so you can also activate them while editing, to see only the affected part of the image.\nLuminance masks are computed at the input of the module, which means that they are insensitive to any luminance changes made inside the module.\n🔗thresholds white fulcrum Set the white point luminance in EV. This is used to normalize the power setting in the 4 ways tab. Display-referred implementations of power functions assume that white is at 100%, which removes the need for normalization. For scene-referred purposes this needs to be taken into account. The picker to the right of the slider automatically sets the white fulcrum to the maximum luminance from the selected region, which should be sufficient in most cases.\ncontrast gray fulcrum Set the fulcrum for the contrast setting in the master tab. This corresponds to the luminance value that will be left unchanged by the contrast adjustment. This setting usually matches the middle-gray linear value. If you followed the scene-referred workflow recommendations and set the global brightness early in the pipeline, using the exposure module, the correct value should usually be around 18-20%. The picker to the right of the slider automatically sets the contrast gray fulcrum to the average luminance from the selected region. This relies on the assumption that the average luminance is usually close to middle-gray, which is not true if you have specular highlights or primary light sources in the frame, or for low/high-key images.\n🔗saturation formula Note that this setting is not really appropriate for the masks tab (since it is not technically related to the masks) but is placed here because it is not meant to be used regularly and in the spirit of saving some display real-estate. Two options are provided:\nJzAzBz (2021) This mode is the original saturation algorithm. It uses the JzAzBz uniform color space (UCS) to compute the saturation. This color space is not meant for color changes and its lightness does not account for the Helmholtz-Kohlrausch effect, which states that colorful colors will look brighter than neutral or near-neutral colors (greys and pastels) having the same luminance. It also suffers from non-smooth behaviour near black, with colors being darkened too much. darktable UCS (2022) The darktable Uniform Color Space has been designed from the ground up, using psychoperceptual measurement datasets, for the sole purpose of the color manipulation (saturation) performed by this module. This color space does account for the Helmholtz-Kohlrausch effect and has a built-in gamut mapping formula that is more accurate and efficient than can be achieved in JzAzBz. It displays a smoother behaviour which makes saturation changes more even across the lightness range. 🔗mask preview settings These settings apply to the mask previews, displayed by clicking the mask buttons in the luminance ranges section. These settings are saved globally, so will be applied to all subsequent images unless changed.\nchecker board color 1 and 2 Set the two colors for the background checker board mask underlay. You can set them to opponent colors of the current image to aid legibility. checker board size Set the width of the checker board cells in pixels (adjusted according to the display\u0026rsquo;s DPI setting). 🔗FAQ 🔗saturation or chroma? As described in the dimensions of color section, saturation and chroma roam the (lightness, chroma) plane in different directions. In addition, the chroma of color balance RGB uses a scene-referred linear space, while the saturation uses a perceptual space, which rescales color for even spacing.\nIn practice, you should use the chroma setting if you want to preserve the scene-linearity of the light emission and/or keep the luminance unchanged. However, these changes might affect some hues more heavily than others, due to the fact that the color space is not fully perceptually-scaled.\nSaturation is closer to the effect of mixing white paint with some base color. Reducing the saturation of red will degrade it to pink, while reducing its chroma will degrade to a gray shade at the same luminance. Saturation is perhaps a more intuitive way to interact with color, due to its connection with painting.\nChoosing one or the other is mostly a matter of deciding where on the (lightness, chroma) graph you want to push your colors, and where they are to begin with. To reach pastel colors, saturation is the way to go. To reach laser-like colors (almost monochromatic), at the risk of looking synthetic, chroma is the way to go.\n🔗what is the connection with lift/gamma/gain? The lift/gamma/gain algorithm relies on a display-referred color space, since it assumes a bounded and symmetric dynamic range, with white point at 100% and gray at 50%. As such, it is simply unusable in a scene-referred space. However, the only incompatible part is the lift. The gamma is exactly the ASC CDL power, and the gain is exactly the ASC CDL slope.\nThe color balance RGB module simply has two slopes instead of one: the gain, applied on the highlights extracted from the whole image by a mask, and the lift, applied similarly but on the shadows.\n🔗changing contrast While color balance RGB is mostly about color (other modules handle the global contrast in chromaticity-preserving ways) luminance is as much a part of color as hue or chroma, and it needs to be dealt with here too, because the perception of saturation relies on it. If you wish to turn red into pink, for example, reducing its chroma will turn it gray, so you need to increase its luminance as well.\nThere are several ways to change the contrast in color balance RGB, either locally (with masks) or globally (without):\nin the master tab, use the contrast setting (possibly alongside the contrast gray fulcrum in the masks tab). Be aware that this will raise the white point and therefore increase the dynamic range of the image, which may void filmic settings later in the pipeline. in perceptual saturation grading, desaturate highlights and resaturate shadows to produce a luminance contrast boost, in perceptual brilliance grading, add brilliance in the highlights and remove brilliance in the shadows to produce to a luminance contrast boost, in the 4 ways tab, set the shadows lift luminance to negative values and the highlights gain luminance to positive values, which also produces a luminance contrast boost. The difference between these methods is how the effect will be weighted relative to the input of the module. You are advised to do the majority of luminance contrast adjustments in the filmic and tone equalizer modules, and then undertake final changes in color balance RGB while examining the colors.\n🔗internal processing The following is the internal order of operations within the module:\nTransform from pipeline RGB to Kirk/Filmlight Ych space, Apply hue shift at constant chroma and constant luminance, Compute luminance masks with Y, Apply the linear chroma and vibrance settings at constant hue and luminance, Transform to Kirk/Filmlight RGB space, Apply the 4 ways settings (except luminance power), Transform to Kirk/Filmlight Yrg space, Apply luminance power and contrast on Y, Transform to JzAzBz space, Apply the perceptual saturation and perceptual brilliance settings, Soft-clip the chroma using pipeline RGB gamut at constant hue and lightness, Transform back to pipeline RGB. 🔗caveats Setting the global chroma to -100% will not produce a real monochrome image, as is customary with other algorithms. The reason for this is that the RGB space used has a D65 white point defined in CIE LMS 2006 space, while darktable uses a white point defined in CIE XYZ 1931 space, and there is no exact conversion between these spaces. The result will therefore be a slightly tinted black \u0026amp; white image. If your intent is to get a real black \u0026amp; white image using the luminance channel, the color calibration module offers a B\u0026amp;W : luminance-based preset that does exactly the same thing but without the white-point discrepancy.\nThis module has its gamut-mapping (against pipeline RGB) permanently enabled. This means that if your original image contains some largely out-of-gamut colors to start with, simply enabling color balance RGB with no particular setting will slightly alter its colors. This is probably for the best.\nThe maximum saturation allowed in the pipeline working RGB space is recorded for each hue when initializing the module, and is later cached in a LUT (look-up table) to save performance. If the working profile is later changed, color balance RGB is not notified, meaning that it will not update its cached hue/saturation LUT. To force a LUT update, you can simply change any setting in the color balance RGB module, then change it back again. It is not recommended that you change the working RGB space half-way through an editing session, as this could result in unexpected chroma and hue changes.\nFor performance reasons, the non-linear conversions from and to the working RGB space are bypassed, meaning that the internal colorimetry will be wrong when using non-linear color spaces. Note that there is no reason to use non-linear spaces as working RGB since they make alpha blending more challenging for no benefit.\nRichard A. Kirk, Chromaticity coordinates for graphic arts based on CIE 2006 LMS with even spacing of Munsell colours, 2019. https://doi.org/10.2352/issn.2169-2629.2019.27.38\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nSafdar et al., Perceptually uniform color space for image signals including high dynamic range and wide gamut, 2017. https://doi.org/10.1364/OE.25.015131\u0026#160;\u0026#x21a9;\u0026#xfe0e;\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-balance-rgb/","tags":null,"title":"color balance rgb"},{"categories":null,"content":"A fully-featured color-space correction, white balance adjustment and channel mixer module.\nThis simple yet powerful module can be used in the following ways:\nTo adjust the white balance (chromatic adaptation), working in tandem with the white balance module. Here, the white balance module makes some initial adjustments (required for the demosaic module to work effectively), and the color calibration module then calculates a more perceptually-accurate white balance after the input color profile has been applied.\nAs a simple RGB channel mixer, adjusting the R, G and B output channels based on the R, G and B input channels, to perform cross-talk color-grading.\nTo adjust the color saturation and brightness of the image, based on the relative strength of the R, G and B channels of each pixel.\nTo produce a grayscale output based on the relative strengths of the R, G and B channels, in a way similar to the response of black and white film to a light spectrum.\nTo improve the color accuracy of the input color profile using a color checker chart.\n🔗White Balance in the Chromatic Adaptation Transformation (CAT) tab Chromatic adaptation aims to predict how all surfaces in the scene would look if they had been lit by another illuminant. What we actually want to predict, though, is how those surfaces would have looked if they had been lit by the same illuminant as your monitor, in order to make all colors in the scene match the change of illuminant. White balance, on the other hand, aims only at ensuring that whites and grays are really neutral (R = G = B) and doesn’t really care about the rest of the color range. White balance is therefore only a partial chromatic adaptation.\nChromatic adaptation is controlled within the Chromatic Adaptation Transformation (CAT) tab of the color calibration module. When used in this way the white balance module is still required as it needs to perform a basic white balance operation (connected to the input color profile values). This technical white balancing (\u0026ldquo;camera reference\u0026rdquo; mode) is a flat setting that makes grays lit by a standard D65 illuminant look achromatic, and makes the demosaicing process more accurate, but does not perform any perceptual adaptation according to the scene. The actual chromatic adaptation is then performed by the color calibration module, on top of those corrections performed by the white balance and input color profile modules. The use of custom matrices in the input color profile module is therefore discouraged. Additionally, the RGB coefficients in the white balance module need to be accurate in order for this module to work in a predictable way.\nThe color calibration and white balance modules can be automatically applied to perform chromatic adaptation for new edits by setting the chromatic adaptation workflow option (preferences \u0026gt; processing \u0026gt; auto-apply chromatic adaptation defaults) to \u0026ldquo;modern\u0026rdquo;. If you prefer to perform all white balancing within the white balance module, a \u0026ldquo;legacy\u0026rdquo; option is also provided. Neither option precludes the use of other modules (such as color balance RGB) for creative color grading further along the pixel pipeline.\nBy default, color calibration performs chromatic adaptation by:\nreading the RAW file\u0026rsquo;s Exif data to fetch the scene white balance set by the camera, adjusting this setting using the camera reference white balance from the white balance module, further adjusting this setting with the input color profile in use (standard matrix only). For consistency, the color calibration module\u0026rsquo;s default settings always assume that the standard matrix is used in the input color profile module \u0026ndash; any non-standard settings in this module are ignored. However, color calibration\u0026rsquo;s defaults can read any auto-applied preset in the white balance module.\nIt is also worth noting that, unlike the white balance module, color calibration can be used with masks. This means that you can selectively correct different parts of the image to account for differing light sources.\nTo achieve this, create an instance of the color calibration module to perform global adjustments using a mask to exclude those parts of the image that you wish to handle differently. Then create a second instance of the module reusing the mask from the first instance (inverted) using a raster mask.\n🔗CAT tab workflow The default illuminant and color space used by the chromatic adaptation are initialised from the Exif metadata of the RAW file \u0026ldquo;as set in camera\u0026rdquo;.\nAlternatively you can use the picker (to the right of the color patch) to select a neutral color from the image or, if one is unavailable, select the entire image. In this case, the algorithm finds the average color within the chosen area and sets that color as the illuminant. This method relies on the \u0026ldquo;gray-world\u0026rdquo; assumption, which predicts that the average color of a natural scene will be neutral. This method will not work for artificial scenes, for example those with painted surfaces.\nSelect \u0026ldquo;as shot in camera\u0026rdquo; to restore the camera defaults and re-read the RAW Exif. The color patch shows the color of the currently calculated illuminant projected into sRGB space. The aim of the chromatic adaptation algorithm is to turn this color into pure white, which does not necessarily means shifting the image toward its perceptual opponent color. If the illuminant is properly set, the image will be given the same tint as shown in the color patch when the module is disabled.\nTo the left of the color patch is the CCT (correlated color temperature) approximation. This is the closest temperature, in kelvin, to the illuminant currently in use. In most image processing software it is customary to set the white balance using a combination of temperature and tint. However, when the illuminant is far from daylight, the CCT becomes inaccurate and irrelevant, and the CIE (International Commission on Illumination) discourages its use in such conditions. The CCT reading informs you of the closest CCT match found:\nWhen the CCT is followed by \u0026ldquo;(daylight)\u0026rdquo;, this means that the current illuminant is close to an ideal daylight spectrum ± 0.5 %, and the CCT figure is therefore meaningful. In this case, you are advised to use the \u0026ldquo;D (daylight)\u0026rdquo; illuminant. When the CCT is followed by \u0026ldquo;(black body)\u0026rdquo;, this means that the current illuminant is close to an ideal black body (Planckian) spectrum ± 0.5 %, and the CCT figure is therefore meaningful. In this case, you are advised to use the \u0026ldquo;Planckian (black body)\u0026rdquo; illuminant. When the CCT is followed by \u0026ldquo;(invalid)\u0026rdquo;, this means that the CCT figure is meaningless and wrong, because we are too far from either a daylight or a black body light spectrum. In this case, you are advised to use the custom illuminant. The chromatic adaptation will still perform as expected (see the note below), so the \u0026ldquo;(invalid)\u0026rdquo; tag only means that the current illuminant color is not accurately tied to the displayed CCT. This tag is nothing to be concerned about \u0026ndash; it is merely there to tell you to stay away from the daylight and planckian illuminants because they will not behave as you might expect. When one of the above illuminant detection methods is used, the module checks where the calculated illuminant sits using the two idealized spectra (daylight and black body) and chooses the most accurate spectrum model to use in its illuminant parameter. The user-interface will change accordingly:\nA temperature slider will be provided if the detected illuminant is close to a D (daylight) or Planckian (black body) spectrum, for which the CCT is meaningful. Hue and chroma sliders in CIE 1976 Luv space are offered for the custom illuminant, which allows direct selection of the illuminant color in a perceptual framework without any intermediate assumption. Note: Internally, the illuminant is represented by its absolute chromaticity coordinates in CIE xyY color space. The illuminant selection options in the module are merely interfaces to set up this chromaticity from real-world relationships and are intended to make this process faster. It does not matter to the algorithm if the CCT is tagged \u0026ldquo;invalid\u0026rdquo; \u0026ndash; this just means that the relationship between the CCT and the corresponding xyY coordinates is not physically accurate. Regardless, the color set for the illuminant, as displayed in the patch, will always be honored by the algorithm.\nWhen switching from one illuminant to another, the module attempts to translate the previous settings to the new illumninant as accurately as possible. Switching from any illuminant to custom preserves your settings entirely, since the custom illuminant is a general case. Switching between other modes, or from custom to any other mode, will not precisely preserve your settings from the previous mode due to rounding errors.\nOther hard-coded illuminants are available (see below). Their values come from standard CIE illuminants and are absolute. You can use them directly if you know exactly what kind of light bulb was used to illuminate the scene and if you trust your camera\u0026rsquo;s input profile and reference (D65) coefficients to be accurate. Otherwise, see caveats below.\n🔗CAT tab controls adaptation The working color space in which the module will perform its chromatic adaptation transform and channel mixing. The following options are provided: Linear Bradford (1985): This is accurate for illuminants close to daylight and is compatible with the ICC v4 standard, but produces out-of-gamut colors for more difficult illuminants. CAT16 (2016): This is the default option and is more robust in avoiding imaginary colors while working with large gamut or saturated cyan and purple. It is more accurate than the Bradford CAT in most cases. Non-linear Bradford (1985): This can sometimes produce better results than the linear version but is unreliable. XYZ: This is the least accurate method and is generally not recommended except for testing and debugging purposes. none (disable): Disable any adaptation and use the pipeline working RGB space. illuminant The type of illuminant assumed to have lit the scene. Choose from the following: same as pipeline (D50): Do not perform chromatic adaptation in this module instance but just perform channel mixing, using the selected adaptation color space. CIE standard illuminant: Choose from one of the CIE standard illuminants (daylight, incandescent, fluorescent, equi-energy, or black body), or a non-standard \u0026ldquo;LED light\u0026rdquo; illuminant. These values are all pre-computed \u0026ndash; as long as your camera sensor is properly profiled, you can just use them as-is. For illuminants that lie near the Planckian locus, an additional \u0026ldquo;temperature\u0026rdquo; control is also provided (see below). custom: If a neutral gray patch is available in the image, the color of the illuminant can be selected using the picker, or can be manually specified using hue and saturation sliders (in LCh perceptual color space). The color swatch next to the picker shows the color of the calculated illuminant used in the CAT compensation. The picker can also be used to restrict the area used for AI detection (below). (AI) detect from image surfaces: This algorithm obtains the average color of image patches that have a high covariance between chroma channels in YUV space and a high intra-channel variance. In other words, it looks for parts of the image that appear as though they should be gray, and discards flat colored surfaces that may be legitimately non-gray. It also discards chroma noise as well as chromatic aberrations. (AI) detect from image edges: Unlike the white balance module\u0026rsquo;s auto-white-balancing which relies on the \u0026ldquo;gray world\u0026rdquo; assumption, this method auto-detects a suitable illuminant using the \u0026ldquo;gray edge\u0026rdquo; assumption, by calculating the Minkowski p-norm (p = 8) of the laplacian and trying to minimize it. That is to say, it assumes that edges should have the same gradient over all channels (gray edges). It is more sensitive to noise than the previous surface-based detection method. as shot in camera: Calculate the illuminant based on the white balance settings provided by the camera. temperature Adjust the color temperature of the illuminant. Move the slider to the right to assume a more blue illuminant, which will make the white-balanced image appear warmer/more red. Move the slider to the left to assume a more red illuminant, which makes the image appear cooler/more blue after compensation. This control is only provided for illuminants that lie near the Planckian locus and provides fine-adjustment along that locus. For other illuminants the concept of \u0026ldquo;color temperature\u0026rdquo; doesn\u0026rsquo;t make sense, so no temperature slider is provided.\nhue For custom white balance, set the hue of the illuminant color in LCh color space (derived from CIE Luv space). chroma For custom white balance, set the chroma (or saturation) of the illuminant color in LCh color space (derived from CIE Luv space). gamut compression Most camera sensors are slightly sensitive to invisible UV wavelengths, which are recorded on the blue channel and produce \u0026ldquo;imaginary\u0026rdquo; colors. Once corrected by the input color profile, these colors will end up out of gamut (that is, it may no longer be possible to represent certain colors as a valid [R,G,B] triplet with positive values in the working color space) and produce visual artifacts in gradients. The chromatic adaptation may also push other valid colors out of gamut, at the same time pushing any already out-of-gamut colors even further out of gamut. Gamut compression uses a perceptual, non-destructive, method to attempt to compress the chroma while preserving the luminance as-is and the hue as close as possible, in order to fit the whole image into the gamut of the pipeline working color space. One example where this feature is very useful is for scenes containing blue LED lights, which are often quite problematic and can result in ugly gamut clipping in the final image. clip negative RGB from gamut Remove any negative RGB values (set them to zero). This helps to deal with bad black level as well as the blue channel clipping issues that may occur with blue LED lights. This option is destructive for color (it may change the hue) but ensures a valid RGB output no matter what. It should never be disabled unless you want to take care of the gamut mapping manually and understand what you are doing. In that case, use the black level correction in the exposure module to get rid of any negative RGB (RGB means light, which is energy, and which should always be a positive quantity), then increase the gamut compression until no solid black patches remain in the image. Proper denoising may help getting rid of odd RGB values too. Note that this approach may still be insufficient to recover some deep and luminous shades of blue. Note 1: It has been reported that some OpenCL drivers don\u0026rsquo;t play well when negative RGB values are present in the pixel pipeline, because many pixel operators use logarithms and power functions (filmic, color balance, all the CIE Lab \u0026lt;-\u0026gt; CIE XYZ color space conversions), which are not defined for negative numbers. Although the inputs are sanitized before sensitive operations, it is not enough for some OpenCL drivers, which will output isolated NaN (Not a Number) values. These NaN values may be subsequently spread by local filters (blurring and sharpening operations, like sharpness, local contrast, contrast equalizer, low pass, high pass, surface blur, and filmic highlights reconstruction), resulting in large black, gray or white squares.\nIn all these cases, you must enable the \u0026ldquo;clip negative RGB from gamut\u0026rdquo; option in the color calibration module.\nNote 2: A common case for failure of the color algorithms in color calibration (especially the gamut compression) is pixels that have a luminance value of 0 (Y channel of the CIE 1931 XYZ space), but non-zero chromaticity values (X and Z channels of the CIE 1931 XYZ space). This case is a numerical oddity that matches no physical reality (a pixel with no luminance should have no chromaticity either), will produce a division by zero in xyY and Yuv color spaces, and will create NaN RGB values as a result. This issue is not corrected inside color calibration because it is a symptom of a bad input profiling and/or a bad black point level, and needs to be addressed manually either by adjusting the input color profile with the channel mixer or in the exposure module\u0026rsquo;s black level correction.\n🔗CAT warnings The chromatic adaptation in this module relies on a number of assumptions about the earlier processing steps in the pipeline in order to work correctly, and it can be easy to inadvertently break those assumptions in subtle ways. To help you to avoid these kinds of mistakes, the color calibration module will show warnings in the following circumstances.\nIf the color calibration module is set up to perform chromatic adaptation but the white balance module is not set to \u0026ldquo;camera reference\u0026rdquo;, warnings will be shown in both modules. These errors can be resolved either by setting the white balance module to \u0026ldquo;camera reference\u0026rdquo; or by disabling chromatic adaptation in the color calibration module. Note that some sensors may require minor corrections within the white balance module in which case these warnings can be ignored.\nIf two or more instances of color calibration have been created, each attempting to perform chromatic adaptation, an error will be shown on the second instance. This could be a valid use case (for instance where masks have been set up to apply different white balances to different non-overlapping areas of the image) in which case the warnings can be ignored. For most other cases, chromatic adaptation should be disabled in one of the instances to avoid double-corrections.\nBy default, if an instance of the color calibration module is already performing chromatic adaptation, each new instance you create will automatically have its adaptation set to \u0026ldquo;none (bypass)\u0026rdquo; to avoid this \u0026ldquo;double-correction\u0026rdquo; error.\nThe chromatic adaptation modes in color calibration can be disabled by either setting the adaptation to \u0026ldquo;none (bypass)\u0026rdquo; or setting the illuminant to \u0026ldquo;same as pipeline (D50)\u0026rdquo; in the CAT tab.\nThese warnings are intended to prevent common and easy mistakes while using the automatic default presets in the module in a typical RAW editing workflow. When using custom presets and some specific workflows, such as editing film scans or JPEGs, these warnings can and should be ignored.\nAdvanced users can disable module warnings in preferences \u0026gt; processing \u0026gt; show warning messages.\n🔗channel mixing The remainder of this module is a standard channel mixer, allowing you to adjust the output R, G, B, colorfulness, brightness and gray of the module based on the relative strengths of the R, G and B input channels.\nChannel mixing is performed in the color space defined by the adaptation control on the CAT tab. For all practical purposes, these CAT spaces are particular RGB spaces tied to human physiology and proportional to the light emissions in the scene, but they still behave in the same way as any other RGB space. The use of any of the CAT spaces can make the channel mixer tuning process easier, due to their connection with human physiology, but it is also possible to mix channels in the RGB working space of the pipeline by setting the adaptation to \u0026ldquo;none (bypass)\u0026rdquo;. To perform channel mixing in one of the adaptation color spaces without chromatic adaptation, set the illuminant to \u0026ldquo;same as pipeline (D50)\u0026rdquo;.\nNote: The actual colors of the CAT or RGB primaries used for the channel mixing, projected to sRGB display space, are painted in the background of the RGB sliders, so you can get a sense of the color shift that will result from your altered settings.\nChannel mixing is a process that defines a boosting/muting factor for each channel as a ratio of all the original channels. Instead of entering a single flat correction that ties the output value of a channel to its input value (for example, R_output = R_input × correction), the correction to each channel is dependent on the input of all of the channels for each pixel (for example, R_output = R_input × R_correction + G_input × G_correction + B_input × B_correction). Thus a pixel\u0026rsquo;s channels contribute to each other (a process known as \u0026ldquo;cross-talk\u0026rdquo;) which is equivalent to rotating the primary colors of the color space in 3D. This is, in effect, digital simulation of physical color filters.\nAlthough rotating primary colors in 3D is ultimately equivalent to applying a general hue rotation, the connection between the RGB corrections and the resulting perceptual hue rotation is not directly predictable, which makes the process non-intuitive. \u0026ldquo;R\u0026rdquo;, \u0026ldquo;G\u0026rdquo; and \u0026ldquo;B\u0026rdquo; should be taken as a mixture of 3 lights that we dial up and down, not as a set of colors or hues. Also, since RGB tristimulus does not decouple luminance and chrominance, but is an additive lighting setup, the \u0026ldquo;G\u0026rdquo; channel is more strongly tied to human luminance perception than the \u0026ldquo;R\u0026rdquo; and \u0026ldquo;B\u0026rdquo; ones. All pixels have a non-zero G channel, which implies that any correction to the G channel is likely to affect all pixels.\nThe channel mixing process is therefore tied to a physical interpretation of the RGB tristimulus (as additive lights), which makes it well-suited for primary color grading and illuminant corrections, and blends the color changes smoothly. However, trying to understand and predict it from a perceptual point of view (luminance, hue and saturation) is going to fail and is discouraged.\nNote: The \u0026ldquo;R\u0026rdquo;, \u0026ldquo;G\u0026rdquo; and \u0026ldquo;B\u0026rdquo; labels on the channels of the color spaces in this module are merely conventions formed out of habit. These channels do not necessarily look \u0026ldquo;red\u0026rdquo;, \u0026ldquo;green\u0026rdquo; and \u0026ldquo;blue\u0026rdquo;, and users are advised against trying to make sense out of them based on their names. This is a general principle that applies to any RGB space used in any application.\n🔗R, G and B tabs At its most basic level, you can think of the R, G and B tabs of the color calibration module as a type of matrix multiplication between a 3x3 matrix and the input [R G B] values. This is in fact very similar to what a matrix-based ICC color profile does, except that the user can input the matrix coefficients via the darktable GUI rather than reading the coefficients from an ICC profile file.\n┌ R_out ┐ ┌ Rr Rg Rb ┐ ┌ R_in ┐ │ G_out │ = │ Gr Gg Gb │ X │ G_in │ └ B_out ┘ └ Br Bg Bb ┘ └ B_in ┘ If, for example, you\u0026rsquo;ve been provided with a matrix to transform from one color space to another, you can enter the matrix coefficients into the channel mixer as follows:\nselect the R tab and then set the Rr, Rg \u0026amp; Rb values using the R, G and B input sliders select the G tab and then set the Gr, Gg \u0026amp; Gb values using the R, G and B input sliders select the B tab and then set the Br, Bg \u0026amp; Bb values using the R, G and B input sliders By default, the mixing function in color calibration just copies the input [R G B] channels straight over to the matching output channels. This is equivalent to multiplying by the identity matrix:\n┌ R_out ┐ ┌ 1 0 0 ┐ ┌ R_in ┐ │ G_out │ = │ 0 1 0 │ X │ G_in │ └ B_out ┘ └ 0 0 1 ┘ └ B_in ┘ For a more intuitive understanding of how the mixing sliders on the R, G and B tabs behave, consider the following:\nfor the R destination channel, adjusting sliders to the right will make the R, G or B areas of the image more \u0026ldquo;red\u0026rdquo;. Moving the slider to the left will make those areas more \u0026ldquo;cyan\u0026rdquo;. for the G destination channel, adjusting sliders to the right will make the R, G or B areas of the image more \u0026ldquo;green\u0026rdquo;. Moving the slider to the left will make those areas more \u0026ldquo;magenta\u0026rdquo;. for the B destination channel, adjusting sliders to the right will make the R, G or B areas of the image more \u0026ldquo;blue\u0026rdquo;. Moving the slider to the left will make those areas more \u0026ldquo;yellow\u0026rdquo;. 🔗R, G and B tab controls The following controls are shown for each of the R, G and B tabs:\ninput R/G/B Choose how much the input R, G and B channels influence the output channel relating to the tab concerned. normalize channels Select this checkbox to normalize the coefficients to try to preserve the overall brightness of this channel in the final image as compared to the input image. 🔗brightness and colorfulness tabs The brightness and colorfulness (color saturation) of pixels in an image can also be adjusted based on the R, G and B input channels. This uses the same basic algorithm that the filmic rgb module uses for tone mapping (which preserves RGB ratios) and for mid-tones saturation (which massages them).\nsaturation algorithm This control allows you to upgrade the saturation algorithm to the new 2021 version, for edits produced prior to darktable 3.6 \u0026ndash; it will not appear for edits that already use the latest version. 🔗colorfulness tab controls input R/G/B Adjust the color saturation of pixels, based on the R, G and B channels of those pixels. For example, adjusting the input R slider will affect the color saturation of pixels containing a lot of \u0026ldquo;R\u0026rdquo; more than pixels containing only a small amount of \u0026ldquo;R\u0026rdquo;. normalize channels Select this checkbox to try to keep the overall saturation constant between the input and output images. 🔗brightness tab controls input R/G/B Adjust the brightness of certain colors in the image, based on the R, G and B channels of those colors. For example, adjusting the input R slider will affect the brightness of colors containing a lot of R channel much more than colors containing only a small amount of R channel. When darkening/brightening a pixel, the ratio of the R, G and B channels for that pixel is maintained, in order to preserve the hue. normalize channels Select this checkbox to try to keep the overall brightness constant between the input and output images. 🔗gray tab Another very useful application of color calibration is the ability to mix the channels together to produce a grayscale output \u0026ndash; a monochrome image. Select the gray tab, and set the R, G and B sliders to control how much each channel contributes to the brightness of the output. This is equivalent to the following matrix multiplication:\nGRAY_out = [ r g b ] X ┌ R_in ┐ │ G_in │ └ B_in ┘ When dealing with skin tones, the relative weights of the three channels will affect the level of detail in the image. Placing more weight on R (e.g. [0.9, 0.3, -0.3]) will make for smooth skin tones, whereas emphasising G (e.g. [0.4, 0.75, -0.15]) will bring out more detail. In both cases the B channel is reduced to avoid emphasising unwanted skin texture.\n🔗gray tab controls input R/G/B Choose how much each of the R, G and B channels contribute to the gray level of the output. The image will only be converted to monochrome if the three sliders add up to some non-zero value. Adding more B will tend to bring out more details, adding more R will tend to smooth skin tones. normalize channels Select this checkbox to try to keep the overall brightness constant as the sliders are adjusted. 🔗area color mapping The area mapping feature is designed to help with batch-editing a series of images in an efficient way. In this scenario, you typically develop a single reference image for the whole batch and then copy\u0026amp;paste the development stack to all of the other images in the batch.\nUnfortunately, the color temperature of the illuminating light often changes slightly between shots, even within the same series captured in the same conditions. This can be the result of a cloud passing by the sun in natural light, or a different ratio between colored bounce light and main light. Each image will still need some individual fine-tuning if you want a perfectly even look over the whole series, and this can be both time-consuming and frustrating.\nArea color mapping allows you to define a target chromaticity (hue and chroma) for a particular region of the image (the control sample), which you then match against the same target chromaticity in other images. The control sample can either be a critical part of your subject that needs to have constant color, or a non-moving and consistently-lit surface over your series of images.\nThe mapping process consists of two steps.\n🔗step 1: set the target There are two ways of setting the target chromaticity for your control sample:\nif you know or expect an arbitrary color for the control sample (for example, a gray card, a color chart, a product or a logo of a specified color), you can set its L, h and c values directly, in Lch derived from CIE Lab 1976 space, if you simply want to match the development of your reference image, set the area mode to measure, then enable the picker (to the right of the color patch) and draw a rectangle over your control sample. The input column will then be updated with the L, h, c values of the control sample before the color correction, and the target column will show the resulting L, h, c values of the control sample after the current calibration setting is applied. If you reset the L, h, c values, the default value is a neutral color at 50% lightness (middle-gray) \u0026ndash; this can be useful to quickly set the average white balance of any image. If you want to match the control sample against neutral gray, you only need to reset the chroma slider because the lightness and hue settings have no effect on chromaticity for neutral grays.\nNote that the target value is not reset when you reset the module itself, but is stored indefinitely in darktable\u0026rsquo;s configuration and will be available on next launch as well as for the next image you develop. Additionally, the position of the selected rectangle is also stored for ease of use when applying the picked correction value to multiple similar images (see below under \u0026ldquo;match the target\u0026rdquo;), though you may redraw the rectangle if the position of the target object changes between images.\nThe take channel mixing into account option lets you choose where the target is sampled. If disabled, the target color is measured immediately after the CAT (Chromatic Adaptation Transform) step, which takes place before any channel mixing. This means that if you have a calibrated profile in effect within the channel mixer, this profile will be discarded. If enabled, the target color is measured after the CAT and the channel mixing steps, including any calibrated profile. This is the recommended option for most use cases.\nNote: If you are defining your target from a gray patch, you should know that the gray patch on color checkers is never entirely neutral. For example, Datacolor Spyder has a slightly warm gray (hue = 20°, chroma = 1.2) while X-Rite pre-2014 has a colder but more neutral gray (hue = 240°, chroma = 0.3) and X-Rite post-2014 is almost perfectly neutral (hue = 133°, chroma = 0.2). In general, it is not desirable to match the control sample against a perfectly neutral gray target, and it is actually wrong to do so when using gray cards and color checkers as a control sample.\n🔗step 2 : match the target When you open a new image, the area mode is automatically reset to correction. Using the picker attached to the color patch, you can then directly reselect your control sample in the new image. The proper illuminant settings required for the control sample to match the memorized target chromaticity will be automatically computed, and the setting will be updated in the same operation.\nThe take channel mixing into account option will need to be set the same as when the measurement of the target was performed to ensure consistent results. Note that the target matching only defines the illuminant settings used in the Chromatic Adaptation Transform \u0026ndash; it does not alter the channel mixer settings, since the calibration is handled in the color checker calibration tool. However, the channel mixer settings can be used or discarded in the computation of the illuminant settings, depending on this option.\nThis operation can be repeated as many times as you have images in your series with no further work.\n🔗step 3: deactivate color mapping The settings you configured in step 1 are \u0026ldquo;sticky\u0026rdquo; \u0026ndash; they will stay active until you manually turn them off by resetting lightness to 50 and chroma to 0. Until then, every time you use this module (even after closing and restarting darktable), those settings will affect the results of an auto-whitebalance operation. To remind you that color mapping is active, especially while the section is collapsed, the heading will change from \u0026ldquo;area color mapping\u0026rdquo; to \u0026ldquo;area color mapping (active)\u0026rdquo; whenever chroma is nonzero or lightness is other than 50.\nNote: Perfectly matching your control sample against the target chromaticity may still not yield a similar perceptual result, even if the numbers are exactly the same. The ratio of lightness between the control sample and its surrounding, as well as the color contrasts at play in the frame, will alter the perception of colors in ways that are very difficult to model. To build an intuition of this problem, see the gray strawberries illusion.\n🔗extracting settings using a color checker Since the channel mixer is essentially an RGB matrix (similar to the input color profile used for RAW images) it can be used to improve the color accuracy of the input color profile by computing ad-hoc color calibration settings.\nThese computed settings aim to minimize the color difference between the scene reference and the camera recording in a given lighting situation. This is equivalent to creating a generic ICC color profile but here, the profile is instead stored as module settings that can be saved as presets or styles, to be shared and reused between images. Such profiles are meant to complement and refine the generic input profile but do not replace it.\nThis feature can assist with:\nhandling difficult illuminants, such as low CRI light bulbs, for which a mere white balancing will never suffice, digitizing artworks or commercial products where an accurate rendition of the original colors is required, neutralizing a number of different cameras to the same ground-truth, in multi-camera photo sessions, in order to obtain a consistent base look and share the color editing settings with a consistent final look, obtaining a sane color pipeline from the start, nailing white balance and removing any bounced-light color cast at once, with minimal effort and time. 🔗supported color checker targets Users are not currently permitted to use custom targets, but a limited number of verified color checkers (from reputable manufacturers) are supported:\nX-Rite / Gretag MacBeth Color Checker 24 (pre- and post-2014), Datacolor SpyderCheckr 24 (pre- and post-2018), Datacolor SpyderCheckr 48 (pre- and post-2018), Datacolor SpyderCheckr Photo. Users are discouraged from obtaining cheap, off-brand, color targets as color constancy between batches cannot possibly be asserted at such prices. Inaccurate color checkers will only defeat the purpose of color calibration and possibly make things worse.\nIT7 and IT8 charts are not supported since they are hardly portable and not practical for use on-location for ad-hoc profiles. These charts are better suited for creating generic color profiles, undertaken using a standard illuminant, for example with Argyll CMS.\nNote: X-Rite changed the formula of their pigments in 2014 and Datacolor in 2018, which slightly altered the color of the patches. Both formulas are supported in darktable, but you should be careful to choose the correct reference for your target. If in doubt, try both and choose the one that yields the lowest average delta E after calibration.\n🔗prerequisites In order to use this feature you will need to take a test shot of a supported color checker chart, on-location, under appropriate lighting conditions:\nframe the chart in the center 50% of the camera\u0026rsquo;s field, to ensure that the image is free of vignetting, ensure that the main light source is far enough from the chart to give an even lighting field over the surface of the chart, adjust the angle between the light, chart and lens to prevent reflections and gloss on the color patches, for the best quality profile you should capture an image with the appropriate brightness. To achieve this, take a few bracketed images (between -1 and +1 EV) of your color checker and load them into darktable, ensuring that all modules between color calibration and output color profile are disabled. Choose the image where the white patch has a brightness L of 94-96% in CIE Lab space or a luminance Y of 83-88% in CIE XYZ space (use the global color picker). This step is not strictly necessary \u0026ndash; alternatively you can take a single image and apply the exposure compensation as recommended in the profile report. If the lighting conditions are close to a standard D50 to D65 illuminant (direct natural light, no colored bounced light), the color checker shot can be used to produce a generic profile that will be suitable for any daylight illuminant with only a slight adjustment of the white balance.\nIf the lighting conditions are peculiar and far from standard illuminants, the color checker shot will be only usable as an ad-hoc profile for pictures taken in the same lighting conditions.\n🔗usage The settings used in color calibration depend on the chosen CAT space and on any color settings defined earlier in the pipe within the white balance and input color profile modules. As such, the results of the profiling (e.g. the RGB channel mixing coefficients) are valid only for a rigid set of CAT space, white balance and input color profile settings. If you wish to create a generic style with your profile, don\u0026rsquo;t forget that you will need to include the settings from these modules as well.\nUse the following process to create your profile preset/style:\nEnable the lens correction module to correct any vignetting that might mislead the calibration, On the bottom of the color calibration module, click on the arrow near the calibrate with a color checker label, to show the controls, Pick the correct model and manufacturer of your color checker from the chart drop-down, In the image preview, an overlay of the chart\u0026rsquo;s patches will appear. Drag the corners of the chart so that they match the visual references (dots or crosses) around the target, to compensate for any perspective distortion, Click the refresh button to compute the profile, Check the Profile quality report. If it is \u0026ldquo;good\u0026rdquo;, you can click on the validation button. If not, try changing the optimization strategy and refresh the profile again. Save the profile in a preset or style, or simply copy \u0026amp; paste the module settings to all of the pictures taken under the same lighting conditions, from within the lighttable view or filmstrip. Note: You don\u0026rsquo;t need to use the standard matrix in the input color profile module when performing a calibration, but be aware that the \u0026ldquo;as shot in camera\u0026rdquo; default white balance will not work properly with any other profile, and that you will need to always use the same input profile whenever you reuse such calibration settings.\n🔗reading the profile report The profile report helps you to assess the quality of the calibration. The settings in color calibration are only a \u0026ldquo;best fit\u0026rdquo; optimization and will never be 100% accurate for the whole color spectrum. We therefore need to track \u0026ldquo;how inaccurate\u0026rdquo; it is in order to know whether we can trust this profile or not.\nBad profiles can happen and will do more harm than good if used.\n🔗delta E and the quality report The CIE delta E 2000 (ΔE) is used as a perceptual metric of the error between the reference color of the patches and the color obtained after each step of calibration:\nΔE = 0 means that there is no error \u0026ndash; the obtained color is exactly the reference color. Unfortunately, this will never happen in practice. ΔE = 2.3 is defined as the Just Noticeable Difference (JND). ΔE \u0026lt; 2.3 means that the average observer will not be able to tell the difference between the expected reference color and the obtained color. This is a satisfactory result. ΔE \u0026gt; 2.3 means that the color difference between the expected reference and the obtained color is noticeable for the average observer. This is unsatisfactory but sometimes unavoidable. The quality report tracks the average and maximum ΔE at the input of the module (before anything is done), after the chromatic adaptation step (white balance only), and at the output of the module (white balance and channel mixing). At each step, the ΔE should be lower than at the previous step, if everything goes as planned.\n🔗profile data The data generated by the profiling process comprises the RGB 3×3 matrix and the detected illuminant. These are expressed in the CAT adaptation space defined in the CAT tab and are provided in case you want to export these coefficients to other software. If the detected illuminant is daylight or black body, the matrix should be fairly generic and reusable for other daylight and black body illuminants with the addition of a small white balance adjustment.\n🔗normalization values These are the settings that you should define, as-is, for the exposure and black level correction parameters in the exposure module, in order to obtain the lowest possible error in your profile. This step is optional and is useful only when the utmost precision is required, but beware that it can produce negative RGB values that will be clipped at various points in the pipeline.\n🔗overlay The chart overlay displays a disc in the center of each color patch, which represents the expected reference value of that patch, projected into the display RGB space. This helps you to visually assess the difference between the reference and the actual color without having to bother with ΔE values. This visual clue will be reliable only if you set the exposure module as instructed in the normalization values of the profile report.\nOnce the profile has been calibrated, some of the square patches will be crossed in the background by one or two diagonals:\npatches that are not crossed have ΔE \u0026lt; 2.3 (JND), meaning they are accurate enough that the average observer will be unable to notice the deviation, patches crossed with one diagonal have 2.3 \u0026lt; ΔE \u0026lt; 4.6, meaning that they are mildly inaccurate, patches crossed with two diagonals have ΔE \u0026gt; 4.6 (2 × JND), meaning that they are highly inaccurate. This visual feedback will help you to set up the optimization trade-off to check which colors are more or less accurate.\n🔗enhancing the profile Because any calibration is merely a \u0026ldquo;best fit\u0026rdquo; optimization (using a weighted least-squares method) it is impossible to have all patches within our ΔE \u0026lt; 2.3 tolerance. Some compromise will therefore be required.\nThe optimize for parameter allows you to define an optimization strategy that attempts to increase the profile accuracy in some colors at the expense of others. The following options are available:\nnone: Don\u0026rsquo;t use an explicit strategy but rely on the implicit strategy defined by the color checker manufacturer. For example, if the color checker has mostly low-saturation patches, the profile will be more accurate for less-saturated colors. neutral colors: Give priority to grays and less-saturated colors. This is useful for desperate cases involving cheap fluorescent and LED lightings, having low CRI. However, it may increase the error in highly-saturated colors more than not having any profile. saturated colors: Give priority to primary colors and highly-saturated colors. This is useful in product and commercial photography, to get brand colors right. skin and soil colors, foliage colors, sky and water colors: Give priority to the chosen hue range. This is useful if the subject of your pictures is clearly defined and has a typical color. average delta E: Attempt to make the color error uniform across the color range and minimize the average perceptual error. This is useful for generic profiles. maximum delta E: Attempt to minimize outliers and large errors, at the expense of the average error. This can be useful to get highly saturated blues back into line. No matter what you do, strategies that favor a low average ΔE will usually have a higher maximum ΔE, and vice versa. Also, blues are always the more challenging color range to get correct, so the calibration usually falls back to protecting blues at the expense of everything else, or everything else at the expense of blues.\nThe ease of obtaining a proper calibration depends on the quality of the scene illuminant (daylight and high CRI illuminants should always be preferred), the quality of the primary input color profile, the black point compensation set in the exposure module, but first and foremost on the mathematical properties of the camera sensor\u0026rsquo;s filter array.\n🔗profile checking It is possible to use the color space check button (first on the left, at the bottom of the module) to perform a single ΔE computation of the color checker reference against the output of the color calibration module. This can be used in the following ways:\nTo check the accuracy of a profile calculated in particular conditions against a color checker shot in different conditions. To evaluate the performance of any color correction performed earlier in the pipe, by setting the color calibration parameters to values that effectively disable it (CAT adaptation to none, everything else set to default), and just use the average ΔE as a performance metric. 🔗caveats The ability to use standard CIE illuminants and CCT-based interfaces to define the illuminant color depends on sound default values for the standard matrix in the input color profile module as well as reasonable RGB coefficients in the white balance module.\nSome cameras, most notably those from Olympus and Sony, have unexpected white balance coefficients that will always make the detected CCT invalid even for legitimate daylight scene illuminants. This error most likely comes from issues with the standard input matrix, which is taken from the Adobe DNG Converter.\nIt is possible to alleviate this issue, if you have a computer screen calibrated for a D65 illuminant, using the following process:\nDisplay a white surface on your screen, for example by opening a blank canvas in any photo editing software you like Take a blurry (out of focus) picture of that surface with your camera, ensuring that you don\u0026rsquo;t have any \u0026ldquo;parasite\u0026rdquo; light in the frame, you have no clipping, and are using an aperture between f/5.6 and f/8, Open the picture in darktable and extract the white balance by using the picker tool in the white balance module on the center area of the image (non-central regions might be subject to chromatic aberrations). This will generate a set of 3 RGB coefficients. Save a preset for the white balance module with these coefficients and auto-apply it to any color RAW image created by the same camera. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-calibration/","tags":null,"title":"color calibration"},{"categories":null,"content":"A simplified control for changing the contrast or separation of colors between the green/magenta and blue/yellow axes in Lab color space. Higher values increase color contrast, lower values decrease it.\n🔗module controls green-magenta contrast Change the green-magenta color contrast. This is equivalent to raising or lowering the steepness of the a* curve in Lab. Lower values desaturate greens and magenta, while higher values increase their saturation. blue-yellow contrast Change the blue-yellow color contrast. This is equivalent to raising or lowering the steepness of the b* curve in Lab. Lower values desaturate blues and yellows, while higher values increase their saturation. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-contrast/","tags":null,"title":"color contrast"},{"categories":null,"content":"Modify the global image saturation to give the image a tint or as an alternative method to split-tone the image.\nNote: Use the color balance rgb module for color modifications.\n🔗module controls color board For split toning move the white dot to the desired highlight tint and then select a tint for shadows with the dark spot. For a simple global tint set both spots to the same color. saturation Correct the global saturation. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-correction/","tags":null,"title":"color correction"},{"categories":null,"content":"Selectively adjust the hue, saturation, and/or brightness of pixels based on their current hue.\nThis module is an attempt to recreate some of the functionality of the color zones module in the scene-referred part of the pipeline whilst overcoming some of that module\u0026rsquo;s limitations. Specifically, the color zones module is prone to increase chroma/luma noise, and introduce artefacts or harsh transitions. These are somewhat mitigated within color equalizer with the following additions:\na fixed number of equally-spaced adjustment nodes means a smoother adjustment curve a guided filter is used, which attempts to smooth out changes by taking into account both the hue of the neighboring pixels and their overall saturation The provided tabs can be used (either individually or in combination) to adjust the hue, saturation, and/or brightness at each of the color nodes. While the distance between nodes cannot be changed (see above), if you wish to target a specific hue that does not currently lie on a node, the \u0026ldquo;node placement\u0026rdquo; slider can be used to move all of the nodes simultaneously. The picker can be used to display the color of a \u0026ldquo;picked\u0026rdquo; pixel or area on the curve adjustment section of the module to allow specific colors to be targeted.\nNote: While the above mitigations can reduce the noise/artefacts generated by this module, they will not always be entirely successful, and you are therefore advised to use this module with care. Try not to make very large changes, and look at some of the options for tweaking the guided filter (below) if introduced noise is excessive.\n🔗module controls 🔗hue/saturation/brightness adjustment curves The main controls of this module are the hue/saturation/brightness adjustment curves. Use each of these tabs to adjust the hue, saturation, or brightness of pixels based on their current hue. Click and drag the color nodes (up/down) to alter the properties of pixels with the given hue. You can also adjust nodes using the scroll wheel on your mouse and, as with sliders, you can change the speed of the adjustment by combining the scroll with Ctrl (to adjust more slowly) or Shift (to adjust more quickly).\nYou can also adjust the color nodes using sliders, which can be shown/hidden by middle-clicking on the curve adjustment section of the module with your mouse.\nAs with sliders, you can also right-click on a node/slider to perform fine adjustments (see module controls/sliders for more details).\nUse the picker to choose a pixel or area on the image and show the hue of that pixel/area on the adjustment curve.\nnode placement Adjust the position of all of the nodes simultaneously (move them left/right). Note: The slider color names will not change when you move the nodes with the \u0026ldquo;node placement\u0026rdquo; slider.\n🔗options 🔗general white level Set the upper bound of brightness corrections that can be made with the module \u0026ndash; the module will not allow brightness of any pixels to be greater than this value. Use the picker to set based on a point/area on the image. This should usually be kept at its default value. hue curve (N/A for saturation/brightness curves) Control how the hue adjustment curve is interpolated between nodes. Values greater than 1 make the transitions between the nodes more gradual. Values less than 1 create sharper transitions, allowing for more precise adjustments to individual hues, while affecting neighbouring areas/colors less. Be aware that lower values can increase the likelihood of introducing noise or artefacts. 🔗guided filter In order to reduce the amount of noise/artefacts, this module uses a guided filter by default. The guided filter attempts to smooth out changes by taking into account both the hue of the neighboring pixels and their overall saturation. This guided filter is ultimately a compromise between adjustment precision (targeting colors more specifically) and avoidance of artefacts (which will generally require less precise targeting). The following options allow the guided filter to be adjusted and visualised in order to better manage these compromises:\nuse guided filter Toggle the guided filter on/off. hue analysis radius Choose how much to take neighboring pixels into account when accounting for hue in the guided filter. The default value (1.5px) is a compromise intended to ensure that individual \u0026ldquo;noisy\u0026rdquo; pixels (whose color differs significantly from their neighbors) don\u0026rsquo;t become more noisy as a result of any adjustments. Increase this value to smooth out any introduced noise (such as Moiré). However, be aware that very large values can cause halos and other artefacts at edges. saturation threshold Since this module is intended to perform operations based on a pixel\u0026rsquo;s hue, it is usually desirable to restrict its operation to only those pixels that have the highest saturation (and for it to have more of an effect on more highly-saturated pixels). The saturation threshold can be used to choose how saturated a pixel must be before its properties can be adjusted by the module. Decrease to allow adjustment of less-saturated pixels. Increase to restrict adjustment of less-saturated pixels. visualize weighting function (saturation) The first \u0026ldquo;visualization\u0026rdquo; button (to the right of the \u0026ldquo;saturation threshold\u0026rdquo; slider) can be used to see which pixels might be impacted by the operation of this module, based on their saturation, and by how much. Pixels with lower saturation, which will not be adjusted, are shown in shades of blue. Pixels with higher saturation, which might be adjusted (depending on the adjustment curves), are shown in shades of red. The more saturated the red/blue, the more/less (respectively) a pixel will be affected by any adjustment. This visualization only depends on a pixel\u0026rsquo;s saturation, and will not change when you alter the hue/saturation/brightness adjustment curves. It is also affected by the \u0026ldquo;contrast\u0026rdquo; setting (below).\ncontrast Regulate the steepness of the saturation adjustment curve. This is used in conjunction with the \u0026ldquo;saturation threshold\u0026rdquo; slider to determine how much a pixel might be adjusted based on its saturation. The generated curve is shown overlaid on the image when the \u0026ldquo;visualise weighting function\u0026rdquo; button is toggled. Positive values result in a steeper transition (highly-saturated pixels are more likely to be changed, low-saturation pixels are less likely to be changed). Negative values result in a shallower transition (highly-saturated pixels are less likely to be changed, low-saturation pixels are more likely to be changed) effect radius Set the radius of the applied parameters in the guided filter. Larger values will smooth the effects of any adjustments, and will better retain pre-existing detail within the image, though can cause bleeding at edges that will need to be mitigated by other means. visualize changed output for the selected tab The second \u0026ldquo;visualization\u0026rdquo; button (to the right of the \u0026ldquo;effect radius\u0026rdquo; slider) can be used to visualize the overall effect of the adjustments made in the current tab, taking into account both the guided filter and the adjustment curve. Red pixels indicate where the value of the chosen adjustment (hue/saturation/brightness) has increased. Blue pixels indicate where the value of the adjustment has decreased. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-equalizer/","tags":null,"title":"color equalizer"},{"categories":null,"content":"A generic color look up table implemented in Lab space.\nThe input to this module is a list of source and target points and the complete mapping is interpolated using splines. The resulting look up tables (LUTs) are editable by hand and can be created using the darktable-chart utility to match given input (such as hald-cluts and RAW/JPEG with in-camera processing pairs). See using darktable-chart for details.\n🔗module controls color board The color board grid shows a list of colored patches. The colors of the patches are the source points. The target color of the selected patch is shown as offsets which are controlled by sliders beneath the color board. An outline is drawn around patches that have been altered (where the source and target colors differ). Click a patch to select it, or use the combo box or picker. The currently-selected patch is marked with a white square, and its number is displayed in the combo box below.\nBy default, the module will load the 24 patches of a classic color checker and initialise the mapping to identity (no change to the image). Configurations with more than 24 patches are shown in a 7x7 grid.\ninteraction To modify the color mapping, you can change the source and target colors, though the main use is to change the target colors. Start with an appropriate palette of source colors (either from the presets menu or from a style you have downloaded). You can then change the lightness (L), green-red (a), blue-yellow (b), or saturation (c) of the patches\u0026rsquo; target values with the sliders.\nTo change the source color of a patch you can select a new color from your image by using the picker and Shift+click on the patch you want to replace.\nDouble-click a patch to reset it; Right-click a patch to delete it; Shift+click on empty space to add a new patch (with the currently picked color as the source).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-look-up-table/","tags":null,"title":"color look up table"},{"categories":null,"content":"Transfer the look and feel of one image to another.\nThis module statistically analyses the color characteristics of a source and target image. The colors of the source image are then mapped to corresponding colors on the target image.\nTwo steps are required to use this module:\nOpen the source image in the darkroom view and acquire its color characteristics by pressing the “acquire as source” button. A set of color clusters is generated and displayed in the “source clusters” area. Each cluster is represented by a set of color swatches with the mean value in the center surrounded by swatches indicating the variance within that cluster. The clusters are sorted in ascending order by their weight (the number of pixels that contribute to each of them). Open the target image in the darkroom view. The previously collected source clusters should be stored; if they are not yet displayed, press the reset button. Now press the “acquire as target” button to generate a corresponding set of color clusters for your target image, which are then displayed in the “target clusters” area. When both source and target clusters are collected an automatic color mapping is applied to the target image. In its default settings the overall effect is quite exaggerated. A set of sliders gives you control of the effect\u0026rsquo;s strength. You can also use the normal blend mode along with the opacity slider to tame the effect. As the color mapping module comes early in the pixelpipe, you can also finetune the colors with later modules.\n🔗module controls acquire as source/target Press these buttons to generate color clusters for the source and target image, respectively. The processing takes a few seconds during which the GUI will be unresponsive. number of clusters The number of color clusters to use. This should roughly correlate to the number of dominant colors in the image. The clusters are acquired through a statistical sampling process to represent the colors that occur most commonly throughout the image. The random nature of the sampling process means that you might get different results each time you acquire the clusters, especially if you have a larger number of clusters and/or a complex color palette in the image. If you change this parameter all the collected color clusters are reset and must be re-acquired. color dominance This parameter controls the mapping between source and target clusters. At the minimum value, the mapping is based on color proximity. This typically leads to very subtle effects on the target image. At the maximum value, the mapping is based on the relative weight of the color clusters – dominant colors of the source image are mapped to dominant colors of the target image. This typically leads to a very strong effect. Intermediate values incrementally shift between these extremes. histogram equalization Modify the target image\u0026rsquo;s contrast by matching its histogram with the histogram of the source image. This slider controls the extent of this effect. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-mapping/","tags":null,"title":"color mapping"},{"categories":null,"content":"Recover color information in blown-out highlights.\nDue to the nature of digital sensors, overexposed highlights lack valid color information. Most frequently they appear neutral white or exhibit some color cast, depending on what other image processing steps are involved. This module can be used to “heal” overexposed highlights by replacing their colors with better fitting ones. The module acts on pixels whose luminance exceeds a user-defined threshold. Replacement colors are taken from neighboring pixels. Both the spatial distance and the luminance distance (range) are taken into account for color selection.\nDue to a limitation of the underlying algorithm, reconstructed colors may sometimes be displayed incorrectly if you zoom into the image in the darkroom view. If this happens you might observe a magenta shift in highlight areas close to high contrast edges, or you might see colorless highlight areas when used alongside the “reconstruct color” method of the highlight reconstruction module. These artifacts only influence on-screen image display \u0026ndash; the final output remains unaffected. It is recommended that you finetune the parameters of this module only when viewing the fully zoomed-out image.\nNote that similar functionality is also available in the reconstruct tab of the filmic rgb module.\n🔗module controls threshold The color reconstruction module replaces the color of all target pixels having luminance values above this threshold. Only pixels with luminance values below the threshold are taken as valid source pixels for replacement colors. Setting this parameter too high will cause the module to have no effect on any pixels. Setting it too low will minimize the “pool” of replacement colors \u0026ndash; if no suitable colors are available, the original colors are retained. This parameter therefore exhibits a “sweet spot” characteristic with an optimum setting depending on the individual image. spatial extent The spatial distance that source pixels may have from target pixels in order for them to contribute to color replacement. Higher values cause ever more distant pixels to contribute. This increases the chance of finding a replacement color but can make the replacement color less well suited for the reconstruction. range extent The range difference (in luminance) that source pixels may have from target pixels in order for them to contribute to color replacement. Higher values cause more pixels to contribute even if their luminance differs more strongly from the target pixels. This again increases the chance of finding a replacement color but at the same time increases the risk of unfitting colors creeping in. precedence This combobox defines whether certain replacement colors shall take precedence over others as follows: off (default): All pixels contribute equally saturated colors: Pixels contribute according to their chromaticity \u0026ndash; the more highly-saturated a color, the more it contributes hue: Give precedence to a specific hue (see below) hue This slider is only visible if you set the precedence to “hue”. It allows you to select a preferred hue for replacement colors. This only has an effect if the preferred hue is actually present within the selected spatial and range distance of the target pixels (see above). A typical use case is repairing highlights on human skin in situations where diverging colors are in close proximity (e.g. textiles or hair with a luminance close that of to skin). Setting a hue preference on skin tones prevents these other colors from creeping in. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-reconstruction/","tags":null,"title":"color reconstruction"},{"categories":null,"content":"Selectively adjust the lightness, chroma and hue of pixels based on their current lightness, chroma and hue.\nThis module works in CIE LCh color space, which separates pixels into lightness, chroma and hue components. It allows you to manipulate the lightness, chroma and hue of targeted groups of pixels through the use of curves.\nYou first need to choose whether you wish to adjust (select) pixels based on their lightness, chroma or hue. You can then use three curves, on their respective tabs, to adjust the lightness, chroma and hue of ranges of pixels selected via this method.\nNote: This module should be used with care, as transitions between colors may not be graceful. Instead, use the color balance rgb module with a parametric mask.\n🔗pixel selection method The color zones module offers three different methods for selecting which pixels you want to adjust. They are:\nselect by hue (default) Select pixels to manipulate based on their hue. For example, you may want to darken a blue sky, or to change a red porche into a yellow one. The following image shows the full range of hues that you can choose to operate on: select by lightness Select pixels to manipulate based on their lightness. For example, you may want to make your shadows brighter, or to make your highlights more yellow. The following image shows the range of lightness levels that you can choose to operate on, from dark to light: select by chroma Select pixels to manipulate based on their chroma. For example, you may want to tone down the chroma of some already highly saturated pixels, or to change their hue. The following image shows the range of chroma levels that you can choose to operate on, from a completely unsaturated monochrome gray through to the most highly saturated color: 🔗pixel manipulation curves Once you have chosen a pixel selection method, the selected range of lightness, chroma or hue levels will appear along the horizontal axis of the three pixel manipulation curves, which can be viewed and adjusted by choosing the appropriate tab (lightness, chroma, hue).\nIf, for example, you were to choose to select by hue (the default), the horizontal axis (below the manipulation curves) would show the range of hues you can work with, and the three pixel manipulation curves would appears as follows:\nlightness By adjusting the lightness curve up or down in a given (hue) location, you can brighten or darken pixels matching hues where the curve has been raised or lowered, respectively. The example below reduces the lightness of the blue parts of the image: chroma By adjusting the chroma curve up or down in a given (hue) location, you can desaturate (make less colorful) or resaturate (make more colorful) pixels matching hues where the curve has been raised or lowered, respectively. The example below reduces the chroma of the red parts of the image: hue By adjusting the hue curve up or down in a given (hue) location, you can shift the hue of pixels matching hues where the curve has been raised or lowered, allowing you to replace one color with another. The example below shifts the blue parts of the image to green: The curves work similarly in the lightness- and chroma-based selection modes as well. See the section on curves to see how spline curves work in general.\nNote that these examples are somewhat contrived in order to illustrate the module\u0026rsquo;s usage. In practical use, they would likely need to be combined with drawn and/or parametric masks to further isolate their effect.\n🔗range selection When adjusting the pixel manipulation curves, it can sometimes be difficult to judge exactly where on the horizontal axis pixels will fall. To the right of the tab controls are a pair of pickers that can be used to assist with this.\nIf you click the left-hand picker and choose a pixel in the image, you will see a dark vertical line showing where that pixel falls on the horizontal axis. If you Ctrl+click or right-click on the same picker you can choose a rectangular area from the image \u0026ndash; the range of values represented within the selected rectangle will be shaded vertically, with a similar dark line showing the median value.\nIf you click on the right-hand picker, you can similarly choose a rectangular area on the image and the display will be shown as described above (a shaded area with a dark vertical line). However, in this case the picker will also automatically add some control points to the curve for you, representing the highlighted range (see below). Simply drag on the center node to raise or lower the curve within the selected range. Alternatively, hold Ctrl while selecting a range to automatically create a positive curve (push up the selected range) or hold Shift while selecting to create a negative curve (pushed down).\n🔗module controls The following controls are available in the color zones module:\nlightness, chroma \u0026amp; hue tabs Each tab displays a pixel manipulation curve to allow you to alter “lightness”, “chroma”, or “hue” based on the pixel selection method. edit by area Choose how to interact with the curve. This setting is disabled by default, allowing the control points for the curve to be freely placed. Check the box to fall back to the legacy \u0026ldquo;edit by area\u0026rdquo; mode, which functions in a similar way to the spline curve controls used in wavelet modules. mask display Enable the mask display to highlight pixels that have been affected by color zones adjustments in yellow. select by Define the horizontal axis (the range of values to work on). You can choose between “lightness”, “chroma”, and “hue” (the default). Changing this parameter resets all pixel manipulation curves to their default state (horizontal straight lines). If you want to work on multiple ranges, you need to create additional instances of the module. process mode Choose between a “smooth” (default) or “strong” processing mode. The default mode is less likely to cause artifacts. mix Use this parameter to tune the strength of the overall effect. interpolation method Define how the curve is interpolated using the user-defined control points. See the curves section for more details. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/color-zones/","tags":null,"title":"color zones"},{"categories":null,"content":"Add a solid layer of color to the image.\n🔗module controls hue The hue of the color layer. saturation The saturation of shadow tones. lightness The lightness of the color layer. source mix Controls how the lightness of the input image is mixed with the color layer. Setting this to zero will result in a uniformly colored plane. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/colorize/","tags":null,"title":"colorize"},{"categories":null,"content":"Create a composite image by overlaying an already-processed image on top of the current image.\nDrag and drop a processed image from the filmstrip onto the \u0026ldquo;drop image from filmstrip here\u0026rdquo; box to overlay the chosen image, and then alter the various placement and adjustment attributes of the image being overlaid.\nThe full history stack of the overlayed image is used by the module, so if you want to drastically change the overlaid image beyond the controls of this module, you should first edit that image separately.\n🔗module controls drop image from filmstrip here The image to overlay onto the currently edited image (dragged from the filmstrip). opacity The percentage of transparency applied to the overlaid image. rotation The amount to turn the overlaid image. Rotation is around the alignment point. scale The amount to shrink the overlaid image. scale on The criteria on which to base the overlaid image scaling. alignment The area on which to align the overlaid image. x offset The amount to move the overlaid image horizontally. y offset The amount to move the overlaid image vertically. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/composite/","tags":null,"title":"composite"},{"categories":null,"content":"Adjust luminance and chroma contrast in the wavelet domain.\nThis versatile module can be used to achieve a variety of effects, including bloom, denoise, clarity, and local contrast enhancement.\nIt works in the wavelet domain and its parameters can be tuned independently for each wavelet detail scale. The module operates in CIE LCh color space and so is able to treat luminosity and chromaticity independently.\nA number of presets are provided, which should help you to understand the capabilities of the module.\n🔗module controls The contrast equalizer module decomposes the image into various detail scales. On each detail scale, you can independently adjust the contrast and denoise splines for lightness (\u0026ldquo;luma\u0026rdquo;) and chromaticity (“chroma”, or color saturation), as well as adjusting the edge-awareness (“edges”) of the wavelet transform. The luma, chroma and edges splines are provided on separate tabs, and some examples of their usage are given in the following sections.\nBelow the spline graphs is a mix slider, which can be used to adjust the strength of the effect, and even to invert the graph (with negative values). While your mouse is over the spline graph, the curve will be displayed as if the mix slider was set to 1.0, to allow for easier editing. When you move your mouse away, the graph will be re-adjusted to account for the mix slider.\nIn the background of the curve you can see a number of alternating light and dark stripes. These represent the levels of detail that are visible at your current zoom scale \u0026ndash; any details without these stripes are too small to be seen your current view. Adjustments made to control points within the striped section may produce a visible effect (depending on the strength of the adjustment). Adjustments outside of the striped region will not. Zoom in to see higher levels of detail and make adjustments to the more detailed areas of the image.\nTip: if you are having trouble visualising which parts of the curve will affect which details in the image, you can set the blend mode to \u0026ldquo;difference\u0026rdquo;. This will make the image go black except for those areas where the output of the module differs from the input. By raising the curve at one of the control points, you will be able to see which details in the image are represented by that point.\n🔗luma tab The luma tab allows you to adjust the local contrast in the image\u0026rsquo;s luminance (brightness). Adjustments are represented by a white spline that begins as a horizontal line running across the centre of the graph (indicating that no change will be made). Raise or lower this spline at the left end of the graph to increase or decrease the local contrast of coarse detail in the image. Perform similar adjustments towards the right side of the graph to adjust the local contrast of the fine details in the image.\nWhen you hover the mouse pointer over the graph, a white circle indicates the radius of influence of the mouse pointer \u0026ndash; the size of this circle can be adjusted by scrolling with the mouse wheel. The larger the circle of influence, the more control points will be affected when you adjust the curve. A highlighted region in the background shows what the spline would look like if you pushed the currently-hovered control point all the way to the top or bottom on the graph \u0026ndash; see the screenshot below for examples of these features. For more information see the wavelets section.\nThe following image shows the default state of the contrast equalizer module before any adjustments have been made:\nRaising the two control points at the right-hand end of the graph will increase the sharpness of the fine details (the eye and feathers of the bird) while leaving coarser details (the rocks in the background) largely unaffected. The example below has been exaggerated to better illustrate the effect.\nIncreasing the local contrast can also amplify the luma noise in the image. A second spline located at the bottom of the graph can be used to denoise the selected detail scales. Raise this spline (by clicking just above one of the triangles at the bottom of the graph and dragging the line upwards) to reduce noise at the given wavelet scale. In the example above, the dark denoising spline has been raised at the fine-detail end of the graph.\n🔗chroma tab The chroma tab allows the color contrast or saturation to be adjusted at the selected wavelet scales. See the following example:\nSay you wanted to bring out the green color of the anthers at the end of the stamen. The pink petals of the flowers are already quite saturated, but using contrast equalizer you can selectively boost the saturation on the small scale of the anthers without impacting the saturation of the petals. By raising the third control point from the right, you can target the saturation of the anthers only:\nAs in the luma tab, the chroma tab also has a denoising spline at the bottom of the graph. This can be used to handle chroma noise at different scales within the image. Chroma denoising can generally be more aggressive on larger wavelet scales and has less effect on a smaller scale.\n🔗edge tab The basic wavelet à trous transform has been enhanced in the contrast equalizer to be \u0026ldquo;edge-aware\u0026rdquo;, which can help to reduce the gradient reversals and halo artifacts that the basic algorithm can produce. The edges tab does not directly act on the edges in an image; rather it adjusts the edge awareness feature of the wavelet transform. If you have not adjusted the luma or chroma splines, adjusting the edge awareness spline will have no effect.\nTo see the sorts of artifacts that the edges curve tries to combat, here is an example taken from the original paper \u0026ldquo;Edge-Optimized À-Trous Wavelets for Local Contrast Enhancement with Robust Denoising\u0026rdquo; (Hanika, Damertz and Lensch 2011):\nIn the image on the left, the edges spline has been reduced to a minimum, effectively disabling the edge awareness and resulting in halos. In the middle image, the edges spline has been increased too much, resulting in gradient reversals. In the image on the right the edges spline has been set somewhere in between the two extremes, resulting in nice clean edges.\nUsually the default central position of the spline is a good starting point, but if there are objectionable artifacts around the edges, this control can be helpful in mitigating them. Some experimentation will be required.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/contrast-equalizer/","tags":null,"title":"contrast equalizer"},{"categories":null,"content":"Crop an image using on-screen guides.\nThis module appears later in the pipeline than the deprecated crop and rotate module, meaning that the full image can remain available for source spots in the retouch module. For best results, you are advised to use the rotate and perspective module to perform rotation and perspective correction (if required), and then perform final creative cropping with this module.\nWhenever this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines.\nResize the crop by dragging the border and corner handles.\nMove the crop rectangle by clicking and dragging inside the crop area. Constrain movement to the horizontal/vertical axis by holding Ctrl/Shift, respectively while dragging. Commit changes by giving focus to another module.\n🔗module controls The crop module controls are split into two sections as follows:\n🔗crop settings aspect Set the aspect ratio of the crop, constraining the width:height ratio of the crop rectangle to the chosen aspect. Many common numerical ratios are pre-defined. A few special aspect ratios deserve explanation: freehand: Crop without any restrictions original image: Retain the aspect ratio of the original image square: Constrains the aspect ratio to be 1:1 golden cut: The golden ratio (1.62:1) You can also enter any other ratio after opening the combobox by typing it in the form of \u0026ldquo;x:y\u0026rdquo; or as a decimal (e.g. \u0026ldquo;0.5\u0026rdquo; to apply a ratio of 2:1).\nThe button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio.\nIf you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form \u0026ldquo;plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y\u0026rdquo; in darktable\u0026rsquo;s configuration file $HOME/.config/darktable/darktablerc. Here \u0026ldquo;foo\u0026rdquo; defines the name of the new aspect ratio and “x” and “y” the corresponding numerical values (x and y must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. You can not use fractions as the actual crop size, however you can for the name. For example, if you want an aspect ratio of 1.91:1, add the following to your darktablerc file: plugins/darkroom/clipping/extra_aspect_ratios/1.91:1=191:100\nNote: When resizing an image in freehand mode you may retain the currently-set aspect ratio by holding Shift while dragging on any of the resize controls.\n🔗margins These sliders allow you to directly set how much of the image to crop from each side. They are automatically updated if you move or resize the crop area on the image using the mouse.\nAs this section is rarely used, it is collapsed by default.\nleft The percentage of the image that should be cropped from the left side. right The percentage of the image that should be cropped from the right side. top The percentage of the image that should be cropped from the top. bottom The percentage of the image that should be cropped from the bottom. 🔗guides Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/crop/","tags":null,"title":"crop"},{"categories":null,"content":"The darktable binary starts darktable with its GUI and full functionality. This is the standard way to use darktable.\ndarktable can called with the following command line parameters:\ndarktable [-d {all,act_on,cache,camctl,camsupport,common,control, dev,expose,fswatch,imageio,input,ioporder,lighttable,lua, masks,memory,nan,opencl,params,perf,pipe,print,pwstorage, signal,sql,tiling,undo,verbose}] [--d-signal \u0026lt;signal\u0026gt;] [--d-signal-act \u0026lt;all,raise,connect,disconnect,print-trace\u0026gt;] [--disable-pipecache] [\u0026lt;input file\u0026gt;|\u0026lt;image folder\u0026gt;] [--version] [--disable-opencl] [--configdir \u0026lt;user config directory\u0026gt;] [--library \u0026lt;library file\u0026gt;] [--datadir \u0026lt;data directory\u0026gt;] [--moduledir \u0026lt;module directory\u0026gt;] [--tmpdir \u0026lt;tmp directory\u0026gt;] [--cachedir \u0026lt;user cache directory\u0026gt;] [--localedir \u0026lt;locale directory\u0026gt;] [--luacmd \u0026lt;lua command\u0026gt;] [--noiseprofiles \u0026lt;noiseprofiles json file\u0026gt;] [--conf \u0026lt;key\u0026gt;=\u0026lt;value\u0026gt;] [-t \u0026lt;num openmp threads\u0026gt;] All parameters are optional. In most cases darktable should be started without any additional parameters, in which case darktable uses suitable defaults.\n-d {all,act_on,cache,camctl,camsupport,common,control,dev,expose,fswatch,imageio,input,ioporder,lighttable,lua,masks,memory,nan,opencl,params,perf,pipe,print,pwstorage,signal,sql,tiling,undo,verbose} Enable debug output to the terminal. There are several subsystems of darktable and each of them can be debugged separately. You can use this option multiple times if you want to debug more than one subsystem (e.g. darktable -d opencl -d camctl) or debug all of them at once (with -d all). The -d common switch is provided to give information about most relevant subsystems while debugging darktable or if you want to provide a log for reporting a darktable issue. Some debug options (like -d opencl) can also provide more verbose output, which can be invoked with the additional option -d verbose. The verbose option must be explicitly provided, even when using -d all. --d-signal \u0026lt;signal\u0026gt; If -d signal or -d all is specified, specify the signal to debug using this option. Specify ALL to debug all signals or specify signal using it\u0026rsquo;s full name. Can be used multiple times. --d-signal-act \u0026lt;all,raise,connect,disconnect,print-trace\u0026gt; If -d signal or -d all is specified, specify the signal action to debug using this option. --disable-pipecache Disable the pixelpipe cache. This option allows only two cachelines per pipe, and should be used for debugging purposes only. \u0026lt;input file\u0026gt;|\u0026lt;image folder\u0026gt; Optionally supply the name of an image file or folder. If a filename is given darktable starts in darkroom view with that file opened. If a folder is given darktable starts in lighttable view with the content of that folder as the current collection. --version Print the darktable version number, a copyright notice, some other useful information, and then terminate. --disable-opencl Prevent darktable from initializing the OpenCL subsystem. Use this option if darktable crashes at startup due to a defective OpenCL implementation. --configdir \u0026lt;config directory\u0026gt; Define the directory where darktable stores user-specific configuration. The default location is $HOME/.config/darktable/. --library \u0026lt;library file\u0026gt; darktable keeps image information in an sqlite database for fast access. The default location of that database file is file name library.db in the directory specified by --configdir or defaulted to $HOME/.config/darktable/. Use this option to provide an alternative location (e.g. if you want to do some experiments without compromising your original library.db). If the database file does not exist, darktable creates it for you. You may also provide :memory: as the library file, in which case the database is kept in system memory \u0026ndash; all changes are discarded when darktable terminates. Whenever darktable starts, it will lock the library to the current user. It does this by writing the current process identifier (PID) into a lock file \u0026lt;library file\u0026gt;.lock next to the library specified. If darktable finds an existing lock file for the library, it will terminate immediately.\n--datadir \u0026lt;data directory\u0026gt; Define the directory where darktable finds its runtime data. The default location depends on your installation. Typical locations are /opt/darktable/share/darktable/ and /usr/share/darktable/. --moduledir \u0026lt;module directory\u0026gt; darktable has a modular structure and organizes its modules as shared libraries for loading at runtime. This option tells darktable where to look for its shared libraries. The default location depends on your installation. Typical locations are /opt/darktable/lib64/darktable/ and /usr/lib64/darktable/. --tmpdir \u0026lt;tmp directory\u0026gt; Define where darktable should store its temporary files. If this option is not supplied darktable uses the system default. --cachedir \u0026lt;cache directory\u0026gt; darktable keeps a cache of image thumbnails for fast image preview and precompiled OpenCL binaries for fast startup. By default the cache is located in $HOME/.cache/darktable/. Multiple thumbnail caches may exist in parallel \u0026ndash; one for each library file. --localedir \u0026lt;locale directory\u0026gt; Define where darktable can find its language-specific text strings. The default location depends on your installation. Typical locations are /opt/darktable/share/locale/ and /usr/share/locale/. --luacmd \u0026lt;lua command\u0026gt; A string containing lua commands to execute after lua initialization. These commands will be run after your “luarc” file. If lua is not compiled-in, this option will be accepted but won\u0026rsquo;t do anything. --noiseprofiles \u0026lt;noiseprofiles json file\u0026gt; Provide a json file that contains camera-specific noise profiles. The default location depends on your installation. Typical locations are /opt/darktable/share/darktable/noiseprofile.json and /usr/share/darktable/noiseprofile.json. --conf \u0026lt;key\u0026gt;=\u0026lt;value\u0026gt; darktable supports a rich set of configuration parameters defined by the user in file darktablerc, located in the directory specified by --configdir or defaulted to $HOME/.config/darktable/. You may temporarily overwrite individual settings on the command line with this option \u0026ndash; these settings will not be stored in darktablerc on exit. -t \u0026lt;num openmp threads\u0026gt; limit number of openmp threads to use in openmp parallel sections. --dump-pfm MODULE_A,MODULE_B, --dump-pipe MODULE_A,MODULE_B, --dumpdir DIR These options are provided for debugging darktable\u0026rsquo;s internal processing pipeline. For example, if called with --dump-pfm demosaic darktable will dump the input and output of the demosaic module as pfm files. By default the location of these files is defined by the operating system \u0026ndash; some temporary folder reported in the log output \u0026ndash; but you can also explicitly define it via the --dumpdir option. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/darktable/","tags":null,"title":"darktable"},{"categories":null,"content":"Control how raw files are demosaiced.\n🔗bayer filters The sensor cells of a digital camera are not color-sensitive \u0026ndash; they are only able to record different levels of lightness. In order to obtain a color image, each cell is covered by a color filter (red, green or blue) that primarily passes light of that color. This means that each pixel of the raw image only contains information about a single color channel.\nColor filters are commonly arranged in a mosaic pattern known as a Bayer filter array. A demosaic algorithm reconstructs the missing color channels by interpolation with data from the neighboring pixels. For further reading see the Wikipedia articles on demosaicing and the Bayer filter.\nDarktable offers several demosaic algorithms, each with it\u0026rsquo;s own characteristics. The differences between them are often very subtle and might only be visible while pixel-peeping. However, as the program works on a pixel-by-pixel basis and demosaic generates the base data for the other modules, the choice of the algorithm can have a visually significant effect on the quality of very fine details in the image. This can include the appearance of false maze patterns as well as the rendering quality of colored edges.\nDemosaic interpolation algorithms are often prone to produce artifacts, typically visible as Moiré patterns when zooming into the image. The chosen algorithm might handle pre-existing Moiré- or Maze-like patterns in the raw data in a better or worse way. In these circumstances VNG4 and LMMSE are often more stable.\nThe following demosaic algorithms are available for sensors with Bayer filters:\nPPG used to be darktable\u0026rsquo;s default demosaic algorithm. It is fast, but other algorithms generally yield better results.\nAMaZE and RCD offer better reconstruction of high-frequency content (finer details, edges, stars) but might struggle with color reconstruction overshoots or added noise in areas of low contrast. While AMaZE often retains more high-frequency details it is also more prone to color overshoots than RCD. Since RCD now offers similar performance to PPG, but with better results, it is now the default algorithm.\nLMMSE is better suited for use on high ISO and noisy images than AMaZE or RCD, both of which tend to generate overshooting artefacts when applied to such images. It can also be useful to manage images that exhibit Moiré patterns with other algorithms.\nVNG4 is better suited for use on images with low-frequency content (e.g. low contrast regions such as sky) but, compared to AMaZE and RCD, it causes loss of some high-frequency details and can sometimes add local color shifts. VNG4 is no longer recommended \u0026ndash; for most images, other available algorithms provide better results.\nNote: The performance of the demosaic algorithms differs significantly, AMaZE being by far the slowest.\n🔗sensors without bayer filters There are a few cameras whose sensors do not use a Bayer filter. Cameras with an \u0026ldquo;X-Trans\u0026rdquo; sensor have their own set of demosaic algorithms. The default algorithm for X-Trans sensors is Markesteijn 1-pass, which produces fairly good results. For slightly better quality (at the cost of much slower processing), choose Markesteijn 3-pass. Though VNG is faster than Markesteijn 1-pass on some computers, it is more prone to artifacts.\n🔗special algorithms passthrough (monochrome) is only useful for cameras that have had the color filter array physically removed from the sensor (e.g. scratched off). Demosaic algorithms usually reconstruct missing color channels by interpolation with data from the neighboring pixels. However, if the color filter array is not present, there is nothing to interpolate, so this algorithm simply sets all the color channels to the same value, resulting in a monochrome image. This method avoids the interpolation artifacts that the standard demosaic algorithms might introduce.\nphotosite_color is not meant to be used for image processing. It takes the raw photosite data and presents it as red, blue or green pixels. This is designed for debugging purposes in order to see the raw data and can assist with analysis of errors produced by the other demosaic algorithms.\n🔗dual demosaic algorithms Some images have areas best demosaiced using an algorithm that preserves high frequency information (like AMaZE or RCD) and other areas that might profit from an algorithm more suited to low frequency content (like VNG4).\nIn dual demosaic algorithms (e.g. RCD + VNG4) the sensor data is demosaiced twice, first by RCD, AMaZE or Markesteijn 3-pass and then by VNG4. Both sets of demosaiced data are retained for subsequent processing.\nThe data from the high frequency algorithm is then analysed for local data change and, using a threshold (there is a bit more of maths involved here), the output image is written pixel-by-pixel for each color channel using data from each demosaic algorithm weighed by the local data change.\nIn general, areas with greater detail are demosaiced by the algorithm best suited to that purpose (RCD, AMaZe, Markesteijn 3-pass) and any flat areas (like blue sky) are demosaiced using the second algorithm (VNG4).\nThe \u0026rsquo;local data change\u0026rsquo; is technically implemented as a gaussian-blurred single channel selection mask calculated from a combination of the threshold value and the pixels\u0026rsquo; luminance.\n🔗selecting the threshold An automatically-calculated threshold is difficult to implement. Instead, the \u0026ldquo;display blending mask\u0026rdquo; button can be used to display the selection mask so you can control the selection of the algorithm manually. The brighter the pixel in the displayed mask, the more the output is taken from the high-frequency algorithm.\n🔗module controls method The demosaic algorithm to use (see above). edge threshold (PPG only) The threshold for an additional median pass. Defaults to “0” which disables median filtering. LMMSE refine (LMMSE only) Refinement steps for use with the LMMSE demosaic algorithm. Median steps average the output. Refinement steps add some recalculation of red and blue channels. While the refinement options work well for luma noise, they may decrease quality on images with heavy chroma noise. color smoothing Activate a number of additional color smoothing passes. Defaults to “off”. match greens In some cameras the green filters have slightly varying properties. This parameter adds an additional equalization step to suppress artifacts. Available options are “disabled”, “local average”, “full average” and “full and local average”. This option is not shown for X-Trans sensors. switch dual threshold (dual demosaic modes only) Set the contrast threshold for dual demosaic modes. Lower values favor the high frequency demosaic algorithm and higher values favor the low frequency algorithm. display blending mask (dual demosaic modes only) Show the blending mask that is used to differentiate between high and low frequency areas (adjusted by the \u0026ldquo;switch dual threshold\u0026rdquo; parameter). For each pixel, the brighter the mask, the more the module\u0026rsquo;s output is taken from the high frequency demosaic algorithm. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/demosaic/","tags":null,"title":"demosaic"},{"categories":null,"content":"An easy to use and highly efficient denoise module, adapted to the individual noise profiles of a wide range of camera sensors.\nOne issue with a lot of denoising algorithms is that they assume that the variance of the noise is independent of the luminosity of the signal. By profiling the noise characteristics of a camera\u0026rsquo;s sensor at different ISO settings, the variance at different luminosities can be assessed, and the denoising algorithm can be adjusted to more evenly smooth out the noise.\nCurrently, darktable has sensor noise profiles for over 300 popular camera models from all the major manufacturers. If you generate your own noise profile for a camera that is not yet supported by darktable, be sure to share it with the darktable development team so they can include it in the next release! Please see darktable\u0026rsquo;s camera support page for more information.\n🔗modes The denoise (profiled) module implements two algorithms, each of which is available in either an easy-to-use \u0026ldquo;auto\u0026rdquo; mode, or a more advanced manual mode with additional controls:\nnon-local means This algorithm works in the spatial domain in much the same way as the astrophoto denoise module. It averages each pixel with some surrounding pixels in the image. The weight of such a pixel in the averaging process depends on the similarity of its neighborhood with the neighborhood of the pixel being denoised. A patch with a defined size is used to measure that similarity. Note that this algorithm is quite resource-intensive.\nwavelets (default) This algorithm works in the wavelet domain, and provides a simplified user interface. Wavelet decomposition allows you to adjust the denoise strength depending on the coarseness of the noise in the image. This mode can be used in either Y0U0V0 color mode (which allows you to independently control luminance and chroma noise) or RGB color mode (which allows you to independently control noise for each RGB channel). The wavelet algorithm is less resource-intensive than non-local means.\n🔗luma versus chroma noise Both “non-local means” and “wavelet” algorithms can efficiently tackle luma (lightness) noise and chroma (color) noise.\nIn the past, it was suggested that you use two separate instances of this module to tackle chroma and luma noise independently (using chroma and lightness blending modes). This is no longer recommended, since the denoise (profiled) module is placed before the input color profile module in the pixelpipe (so that the profile parameters are accurate) and color blending modes should only be used after the input color profile has been applied.\nThe new algorithms in this module now provide their own methods to separately handle luma and chroma noise, and in both cases this can be handled with a single module instance.\n🔗module controls The denoise (profiled) module provides some controls that are independent of the algorithm used. These are described first, before moving on to the algorithm-specific controls.\nWhen describing the controls specific to an algorithm, we will first cover the simplified interface, and then move on to the more advanced controls for that algorithm.\nNote that sliders are provided with minimum and maximum values by default. However, these are only soft limits and, where needed, higher values can be entered by right-clicking on the slider and typing a new value.\n🔗common controls profile darktable automatically determines the camera model and ISO based on the Exif data of your raw file, and searches for a corresponding profile in its database. If your image has an intermediate ISO value, settings will be interpolated between the two closest datasets in the database, and this interpolated setting will show up as the first line in the combo box. You can also manually override this selection if necessary. Re-selecting the top-most entry in the combo box will return you to the default profile. mode Choose which denoising algorithm to use (see above), and whether to present the simplified (\u0026ldquo;auto\u0026rdquo;) or full manual interface for that algorithm. whitebalance-adaptive transform As the white balance amplifies each of the RGB channels differently, each channel exhibits different noise levels. This checkbox makes the selected algorithm adapt to the white balance adjustments. This option should be disabled on the second instance if you have applied a first instance with a color blend mode. adjust autoset parameters (auto modes only) Automatically adjust all the other parameters on the current denoising algorithm using a single slider. This is particularly useful when you have had to increase the exposure on an underexposed image, which normally introduces additional noise (as if you had taken the shot with a higher ISO). This control compensates for that by using settings similar to those used for a higher ISO image. The \u0026ldquo;effective ISO\u0026rdquo; used by the denoise algorithm is the actual ISO used, multiplied by the value of this slider. strength Fine-tune the strength of the denoising. The default value has been chosen to maximize the peak signal-to-noise ratio. It\u0026rsquo;s mostly a matter of taste \u0026ndash; whether you prefer a low noise level at the cost of fine details, or you accept more noise to better preserve fine detail. preserve shadows (advanced mode only) Lower this control to denoise the shadows more aggressively. Usually, as noise increases, you will need to decrease this parameter. bias correction (advanced mode only) Correct any color cast that may appear in the shadows. Increase this value if dark shadows appear too green, decrease if they appear too purple. 🔗non-local means auto sliders central pixel weight (details) Control the amount of detail that should be preserved by the denoising algorithm. By default, this will have a low value, meaning that the algorithm will treat both luma and chroma noise equally. Move this slider to the right to reduce the amount of luma denoising, so that the algorithm will primarily affect chroma noise. By adjusting this slider together with the strength slider, you can find a good balance between luma and chroma denoising. 🔗non-local means advanced sliders When you take non-local means out of auto mode, the adjust autoset parameters slider is replaced with the following controls. You can use the auto-adjust slider to arrive at some initial settings then, when you switch to manual mode, the sliders will show the equivalent manual settings. You can then continue to fine-tune the manual settings from the auto-set starting point.\npatch size Control the size of the patches being matched when deciding which pixels to average \u0026ndash; see astrophoto denoise for more information. Increase this for images with more noise but be aware that high values may smooth out fine edges. The effect of this slider on processing time is minimal. search radius Control how far away from a pixel the algorithm will attempt to find similar patches. Increasing the value can give better results for very noisy images when coarse grain noise is visible, but the processing time is hugely impacted by this parameter (the processing time increases with the square of this parameter). A lower value will make execution faster, a higher value will make it slower. It most cases it is better to use the scattering parameter, which has a similar effect but without the heavy processing cost. scattering (coarse-grain noise) Like the search radius, this slider controls how far from a pixel the algorithm will attempt to find similar patches. However, it does this without increasing the number of patches considered. As such, processing time will stay about the same. Increasing the value will reduce coarse grain noise, but may smooth local contrast. This slider is particularly effective at reducing chroma noise. 🔗wavelet curves Wavelet curves are shown when one of the “wavelet” modes is selected.\nThe noise in an image usually consists of both fine grain and coarse grain noise, to varying degrees. The wavelet curves allow the strength of the denoising to be adjusted depending on the coarseness of the visible noise. The left end of the curve will act on very coarse grain noise, while the right of the curve will act on very fine grain noise. Raising the curve will increase the amount of smoothing, while lowering the curve will decrease it.\nFor example, you can preserve very-fine-grain noise by pulling the right-most part of the curve down. When tackling chroma noise (e.g. on a U0V0 curve, or on a second module instance with a color blend mode) you can safely raise the right side of the curve, since colors do not change a lot on fine scales. This can be useful if you see some noisy isolated pixels with the wrong color.\n🔗wavelets Y0U0V0 color mode The preferred way to use wavelets is with the Y0U0V0 color mode. This mode separates the denoising curves into luminance (Y0) and color (U0V0) components. You can then use the Y0 curve to control the level of luma denoising, and the U0V0 curve to control the level of chroma denoising.\n🔗wavelets RGB color mode Before the Y0U0V0 color mode was introduced, wavelet-based denoising could only be performed directly on the R, G and B channels, either together or individually.\nIf you want to denoise the RGB channels independently, the best way to do this is to use an instance of the color calibration module placed immediately before the denoise (profiled) module so that it outputs a gray channel based on the red channel only, then denoise that monochrome image using the red wavelet curve. Repeat this procedure for the blue and green channels. This procedure is time-consuming, but gives the best result because looking at the color of a noisy pixel is not a reliable way to determine which channel to adjust. For example, a noisy red pixel could be due to a noise peak on the red channel, but could also be due to a noise lull on the blue and green channels.\nThe issue with independently denoising the RGB channels is that there can still be some residual chroma noise at the end that requires excessive smoothing to eliminate. This was in fact one of the key motivations behind implementing the Y0U0V0 color mode.\n🔗wavelets advanced sliders When you take wavelets out of auto mode, the adjust autoset parameters slider is replaced with the preserve shadows and bias correction controls listed above in the common controls section.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/denoise-profiled/","tags":null,"title":"denoise (profiled)"},{"categories":null,"content":"Photography has a long history of producing monochrome images, and many still enjoy this aspect of photography. While there are some specialized/modified cameras with a truly monochrome sensor, most still use a regular camera to capture a color image and transform it into a monochrome image during post-processing.\nThere are two main approaches to this conversion:\nA physical approach, where we attempt to simulate how a silver-based photographic film emulsion would react to the light captured at the scene.\nA perceptual approach, where we develop a color image and reduce the color saturation in a perceptual color space such as CIE Lab.\nThese approaches, and other monochrome-related features in darktable, are discussed in the following sections.\n🔗importing and flagging images as monochrome When importing an image, there are a number of properties that can be used to indicate that the image requires a monochrome treatment:\nIf the image was taken using an achromatic camera, the image will be automatically flagged as monochrome.\nWhen you capture a scene from which you would like to produce a monochrome image, it can be helpful to put your camera into a \u0026ldquo;black \u0026amp; white\u0026rdquo; creative mode. This allows you to visualise what the scene would look like in monochrome through your camera\u0026rsquo;s liveview screen or electronic viewfinder. The camera will still capture the full color data in the raw file, but the embedded JPEG preview image will be monochrome. When you import such an image, darktable can automatically flag the image as monochrome based on the preview image.\nChecking whether the preview is monochrome slows down the import process, so this is disabled by default. You can enable this check in preferences \u0026gt; processing \u0026gt; detect monochrome previews\nWhen processing a raw file, one of the first steps is to demosaic the image. If you set the demosaicing method to \u0026ldquo;passthrough (monochrome)\u0026rdquo;, this discards color information during the demosaicing process, and darktable will flag the image as monochrome.\nNote: You should only use this for images taken on a camera where the color filter array has been removed.\nAfter you have imported the image, you can manually flag an image as monochrome (or not) using the metadata tab on the lighttable\u0026rsquo;s actions on selection module,\nIf any of the above methods result in an image being flagged as monochrome, darktable modules can use this information to present the user with some monochrome-specific module controls and/or apply special processing to the image.\nThe darktable|mode|monochrome tag will be automatically applied to any images flagged as monochrome and, if you have enabled any permanent overlay information on your lighttable thumbnails, such images will be marked with a visual indicator B\u0026amp;W next to the file type information. By automatically applying this tag and visual indicator, darktable makes it easy to set up filters to single out images for monochrome treatment, and to see at a glance which images in the current collection bear the monochrome tag.\nIf darktable detects a true monochrome image or one from a monochrome-converted camera (using the \u0026ldquo;passthrough monochrome\u0026rdquo; demosaicer) some modules (e.g. demosaic, white balance) are automatically disabled.\n🔗monochrome conversion 🔗physical approach This approach tends to work with linear scene-referred data from the sensor, and attempts to mimic the response of a photographic film with a silver emulsion. It consists of three steps:\nMap the color channels from the sensor into a single monochrome channel. Different types of monochrome photographic film have different levels of sensitivity to various wavelengths of light, and this can be simulated by giving the three color channels different weightings when combining them together into a single monochrome channel. The color calibration module allows the three channels to be mixed into a gray channel by varying amounts, and it includes a number of presets that are designed to emulate the characteristics of some well-known types of photographic film.\nApply a luminosity saturation curve. As a piece of photographic film is exposed to more intense light, its response will fall off as the silver emulsion becomes saturated. This saturation curve can be simulated within the filmic rgb module.\nDeveloping a monochrome film in the darkroom traditionally involves \u0026ldquo;dodging and burning\u0026rdquo; to control the level of exposure across different parts of the image. This can be emulated in darktable by using either the exposure module with manually created masks, or by using the tone equalizer module, which generates a mask using a guided filter.\n🔗perceptual approach The other option for producing a monochrome image is to reduce the color saturation in the image, which can be done in a linear colorspace, or in a color space oriented towards modelling human perception.\nThe color balance module operates in linear RGB, and allows you to reduce the color saturation in the image using either the input or output color saturation slider \u0026ndash; which you choose depends on whether you want to make any other adjustments to either the color or monochrome image in the color balance module. The color balance module tends to give a predictable and perceptually-uniform result.\nThe monochrome module works in Lab color space, and it allows the user to graphically define a weighted combination of colors to determine the density of the blacks in the monochrome image. The interface can be somewhat sensitive to the settings, with small changes producing large effects, and you may experience problems with the global contrast and/or black pixel artifacts.\nOther modules such as color zones can also be used to remove color saturation from the image, but these don\u0026rsquo;t offer any real advantage over the simplicity of the color balance module\u0026rsquo;s saturation sliders.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/guides-tutorials/monochrome/","tags":null,"title":"developing monochrome images"},{"categories":null,"content":"Diffusion is a family of physical processes by which particles move and spread gradually with time, from a source that generates them. In image processing, diffusion mostly occurs in two places:\ndiffusion of photons through lens glass (blur) or humid air (hazing), diffusion of pigments in wet inks or watercolors. In both cases, diffusion makes the image less sharp by \u0026ldquo;leaking\u0026rdquo; particles and smoothing local variations.\nThe diffuse or sharpen module uses a generalized physical model to describe several kinds of diffusion, and can be used by image makers to either simulate or revert diffusion processes.\nAs it is a highly technical module, several presets are provided to demonstrate its use for various purposes.\nDiffusion can be removed in order to:\nrecover the original image from sensors with an anti-aliasing filter or mitigate the blur created by most demosaicing algorithms (use one of the sharpen demosaicing presets and move the module before the input color profile module in the pipeline), reverse static lens blurring/defocusing (use one of the lens deblur presets), remove atmospheric haze (use the dehaze preset), add extra acutance for better legibility (use the local contrast preset). Note that motion blurs cannot be reverted by undoing the diffusion process, as they are not diffusive in nature.\nDiffusion can be added in order to:\ncreate a bloom or Orton effect (use the bloom preset), inpaint missing or damaged parts of an image (use the inpaint highlights preset), denoise in an edge-preserving way (use one of the denoise presets) apply a surface blur (use the surface blur preset). Since the process is physical, even its glitches may be used for creative purposes. For example, you can:\nsimulate line drawing or watercolor (use the simulate line drawing and simulate watercolor presets), create random patterns and textures by increasing noise (over time, with iterations, noise will connect with neighbors to create random specks). Note: This module is highly resource-intensive, as it is actually an anisotropic, multiscale, partial differential equation solver. The module\u0026rsquo;s runtime increases with the number of iterations and OpenCL is therefore strongly recommended. Some \u0026ldquo;fast\u0026rdquo; presets are also provided for use on systems without OpenCL.\n🔗concepts 🔗time Diffusion is a time-dependent process: the more time it has, the further the particles can spread. In this module, time is simulated using the number of iterations (the number of times the algorithm runs on top of itself). More iterations can make reconstruction (deblurring, denoising, dehazing) more accurate if properly set, but can also cause it to degenerate.\n🔗direction Natural diffusion usually takes place from points with a high potential (high energy or high concentration of particles) to those with a low potential (low energy or low concentration of particles). In an image, this means that diffusion always occurs from the brightest pixels to the darkest.\nThis particular implementation can simulate natural diffusion, using what is called an isotropic diffusion (all directions have the same weight, like heat diffusion), but can also force a weighted direction parallel to the gradients (forcing diffusion across object edges and creating ghost edges), or a weighted direction perpendicular to the gradients, called isophote (forcing diffusion to be contained inside edges, like in a droplet of watercolor). The relative weight of each direction (gradient and isophote) is user-defined and can be found in the direction section of the module.\n🔗speed Depending how fluid the environment is, particles can move more or less freely and therefore more or less fast. The speed of diffusion can be set in the speed section of the module.\nWhen performing reconstruction (denoising, deblurring, dehazing), it is advisable to use smaller speeds for better accuracy. This prevents numerical overshoots (and therefore degeneration of the solution) and may require more iterations. For small numbers of iterations, higher speeds may be used. Note that large blurs need many iterations for proper reconstruction, so the speed should be adjusted to avoid degenerating the solution.\nAll speeds are added (first to fourth orders), and the sums \u0026ldquo;first order + second order\u0026rdquo; and \u0026ldquo;third order + fourth order\u0026rdquo; should never exceed ±100%, unless you want to produce glitch art.\n🔗scale Natural diffusion is supposed to happen only to the closest neighboring coordinates. That is, at each iteration, each pixel should only interact with its 9 nearest neighbors.\nHere, we fast-track things a bit to save time and reuse the multi-scale wavelets scheme from the contrast equalizer module, so that we can diffuse at different scales. The maximal scale of diffusion is defined by the radius span parameter.\nRegardless of the diffusion, a sharpness parameter allows you to increase or decrease the details at each scale, much like the spline controls of the contrast equalizer. Along with the edge sensitivity slider, this provides the same features as the contrast equalizer module (luma and edges tabs) but in a scene-referred RGB space.\n🔗module controls 🔗properties iterations The number of times the algorithm should run on top of itself. High values slow the module down but allow more accurate reconstructions, provided that the diffusion speeds are low enough. central radius The main scale of the diffusion. Zero causes the diffusion to act more heavily on fine details (used for deblurring and denoising). Non-zero values define the size of details to be heavily diffused (used to increase local contrast). radius span This allows you to select the band of details radii to act on, around the central radius. The span of diffusion defines a range of detail scales (between center - span and center + span) within which the diffusion is confined. High values diffuse on a large band of radii, at the expense of computation time. Low values diffuse closer around the central radius. If you plan to deblur, the radius span should be approximately the width of your lens blur and the central radius should be zero. If you plan to increase the local contrast, but don\u0026rsquo;t want to affect sharpness or noise, the radius span should be 3/4 of your central radius maximum. The radii are expressed in pixels of the full-resolution image, so copy+pasting settings between images of different resolution may lead to slightly different results, except for pixel-level sharpness.\nFor electrical engineers, what is set here is a band-pass filter in wavelets space, using a gaussian frequential window centered on central radius with a fall-off (standard deviation) of radius span. Wavelet scales are analogous to harmonic frequencies and each wavelet scale defines the radius of the details to act on.\n🔗speed (sharpen ↔ diffuse) In the following controls, positive values apply diffusion, negative values undo diffusion (i.e. sharpen) and zero does nothing.\n1st order speed (gradient) The speed of diffusion of the low-frequency wavelet layers in the direction defined by the 1st order anisotropy setting. 2nd order speed (laplacian) The speed of diffusion of the low-frequency wavelet layers in the direction defined by the 2nd order anisotropy setting. 3rd order speed (gradient of laplacian) The speed of diffusion of the high-frequency wavelet layers in the direction defined by the 3rd order anisotropy setting. 4th order speed (laplacian of laplacian) The speed of diffusion of the high-frequency wavelet layers in the direction defined by the 4th order anisotropy setting. 🔗direction In the following controls, positive values cause diffusion to avoid edges (isophotes), negative values make diffusion follow gradients more closely, and zero affects both equally (isotropic).\n1st order anisotropy The direction of diffusion of the low-frequency wavelet layers relative to the orientation of the gradient of the low-frequency (1st order speed setting). 2nd order anisotropy The direction of diffusion of the low-frequency wavelet layers relative to the orientation of the gradient of the high-frequency (2nd order speed setting). 3rd order anisotropy The direction of diffusion of the high-frequency wavelet layers relative to the orientation of the gradient of the low-frequency (3rd order speed setting). 4th order anisotropy The direction of diffusion of the high-frequency wavelet layers relative to the orientation of the gradient of the high-frequency (4th order speed setting). 🔗edge management sharpness Apply a gain on wavelet details, regardless of properties set above. Zero does nothing, positive values sharpen, negative values blur. This is mostly useful as an adjustment variable when blooming or blurring, to retain some sharpness while adding a glow around edges. You are not advised to use this for sharpening alone, since there is nothing to prevent halos or fringes with this setting. edge sensitivity Apply a penalty over the diffusion speeds when edges are detected. This detection uses the local variance around each pixel. Zero disables the penalty, higher values make the penalty stronger and more sensitive to edges. Increase if you notice edge artifacts like fringes and halos. edge threshold Define a variance threshold, which affects mostly low-variance areas (dark or blurry areas, or flat surfaces). Positive values will increase the penalty for low-variance areas, which is good for sharpening or increasing local contrast without crushing blacks. Negative values will decrease the penalty for low-variance areas, which is good for denoising or blurring with a maximal effect on black and blurry regions. 🔗diffusion spatiality luminance masking threshold This control is useful if you want to in-paint highlights. For values greater than 0%, the diffusion will only occur in regions with a luminance greater than this setting. Note that gaussian noise will be added in these regions to simulate particles and initialize the in-painting. 🔗workflow The main difficulty with this module is that while its output can vary dramatically depending on its input paramaters, these parameters have no intuitive link to everyday life. Users are likely to be overwhelmed, unless they are already familiar with Fourier partial differential equations. This section proposes some ways to approach this module without the burden of having to understand the underlying theory.\n🔗general advice If you intend to deblur your image using this module, always start by properly correcting any chromatic aberrations and noise in the image, since the deblurring may magnify these artifacts. It is also important that you don\u0026rsquo;t have clipped black pixels in your image. These can be corrected with the black level correction of the exposure module.\nSince it works on separate RGB channels, it is better to apply this module after color calibration, so that you start with a fully neutral, white-balanced, input image. Note that increasing local contrast or sharpness will also lead to a slight color contrast and saturation boost, which is usually a good thing. Since it uses a variance-based regularization to detect edges, it is also better to put this module before any non-linear operation.\n🔗starting with presets The provided presets have been tuned by the developer and tested on a range of images for typical purposes. The easiest way is simply to start from the presets, and then tweak them as needed:\nif the effect seems too strong, decrease the number of iterations, if edge artifacts appear, increase the edge sensitivity, if deblurring starts to affect valid blurry parts (bokeh), reduce the radius, if deblurring seems correct in bright areas but excessive in dark areas, increase the edges threshold, if deblurring clips black pixels, lower the black level correction in exposure module, fine-tune the sharpness to your taste. 🔗starting from scratch The module\u0026rsquo;s default settings are entirely neutral and will do nothing to your image. The spirit of the module is that each order affects the texture of the image in a particular way.\nStart by tuning the first order parameters (speed and anisotropy) to get an initial base. Then adjust the radius. This will affect coarser textures (either blur or sharpen them). Remember that the first order acts on the low frequencies of the wavelet scale and follows a direction parallel or perpendicular to the gradient of the low frequencies.\nNext, start to tune the second order parameters (speed and anisotropy). The second order also acts on the low frequencies of the wavelet scale but this time follows a direction parallel or perpendicular to the gradient of the high frequencies, which can either be the direction of maximal sharpness or of noise. This can be used to reduce noise (using the second order in diffusion mode, with positive values) when you used the first order in sharpening mode (with negative values).\nThese two steps can be performed on the zoomed-out image. Remember that, while great care has been taken to make the algorithm\u0026rsquo;s visual result fairly scale-invariant, the preview will be exact only when zoomed 1:1. In any case, anything happening at pixel level (radius \u0026lt; 2px) will not be visible for zoom levels lower than 50%.\nAt this point, you may want to tweak the edge sensitivity to take care of any edge artifacts. In theory, diffusing in the isophote direction ensures that diffusion is contained inside edges, but this is not sufficient when corners and sharp convex shapes are present in the image.\nWhen the edge sensitivity control has been adjusted to produce satisfying results, the image usually becomes quite soft. In most cases it will be necessary, at this point, to increase the number of iterations in order to compensate. This will come with a performance penalty so tread carefully with the performance/quality trade-off depending on your hardware. If you can\u0026rsquo;t increase the number of iterations, you will have to increase the diffusing speed.\nThe final step is to fine-tune the third and fourth order, which take care of the high frequencies of each wavelet scale. You will need to be a lot more gentle with these settings than for the first and second orders, as they can cause noise to blow-up really fast.\nThe third order follows the gradient or isophote direction of the low frequency layer, so can be used to guide the high frequency diffusion in a direction that is more likely to be legitimate regarding real edges (and less prone to catch noise).\nThe fourth order follows the gradient or isophote direction of the high frequency layer and is more likely to catch noise. Diffusing on the fourth order is the best way to reduce noise without affecting sharpness too much, either as a stand-alone denoiser, or as a regularization step in a deblurring process.\n🔗using multiple instances for image reconstruction Noise post-filtering may benefit from introducing a diffusion process \u0026ndash; this can be applied as an extra step after the denoise (profiled) module.\nConversely, the following optical issues may benefit from reconstruction by undoing the diffusion process:\nblur introduced by a sensor\u0026rsquo;s low-pass filter (LPF) and/or anti-aliasing performed by the demosaic module, static lens blur, haze/fog, light diffusion (using a diffuser that is too large), leading to even lighting and lack of local contrast on the subject. While more than one of these issues can affect the same picture at the same time, it is better to try to fix them separately using multiple instances of the module. When doing so, ensure the issues are corrected from coarse scale to fine scale, and that denoising always happens first. That is, your instances should appear in the following pipe order:\ndenoise, local contrast enhancement, dehaze, lens blur correction, sensor and demosaic correction. Starting with the coarser-scale reconstructions reduces the probability of introducing or increasing noise when performing the finer-scale reconstructions. This is unintuitive because these processes don\u0026rsquo;t happen in this order during the formation of the image. For the same reason, denoising should always happen before any attempt at sharpening or increasing acutance.\n🔗notes and warnings While this module is designed to be scale-invariant, its output can only be guaranteed at 100% zoom and high quality or full-size export. Results at lower zoom levels or export dimensions may or may not match your expectations.\nWhen setting a deblurring algorithm, try to bear in mind that many of the greatest images in the history of photography were taken with lenses that were not remotely as sharp as those available today. Although the current trend is to build and sell increasingly sharp lenses and have software apply insane amounts of sharpening on top, this fashion does not lead to better imagery and makes the retouching process more tedious. Soft focus and a bit of blurriness have some poetic merits too, which surgically-sanitized HD images may fail to convey.\nIt should be noted that global contrast (using simple tone curves or black/white levels) also affects our perception of sharpness, which is quite different from optical sharpness (optical resolution). Human eyes are only sensitive to local contrast, which may come from optical sharpness (e.g absence of diffusion \u0026ndash; thin edges) as well as from amplified tonal transitions. If some global tone mapping is in place to increase the contrast, the image will look sharper. If a tone mapping is used to decrease the contrast, the image will look more blurry. In none of these cases are the actual edges of objects affected in any way, and the perceptual consequences are pure illusion.\nPart of the aging process is a loss of eyesight. The amount of sharpening that people over 50 find pleasing may not be the same as for people in their 20s. It is worth considering sharpening to obtain a plausible result (matching your everyday perception) rather than a pleasing result (that may look good only to people with the same eyesight as yours).\nFinally, assessing the sharpness of images zoomed to 1:1 (100%) or more is a foolish task. In museums, exhibitions and even on screen, the general audience looks at images as a whole, not with a magnifying glass. Moreover, in most practical uses, photographs rarely exceed a resolution of 3000×2000 pixels (roughly a 300 DPI print at A4/Letter dimensions) which, for 24 megapixel sensors, means downscaling by a factor of 4. When examining a 24 megapixel file at 1:1, you are actually looking at an image that will never exist. Sharpening at pixel level, in this context, is a waste of time and CPU cycles.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/diffuse/","tags":null,"title":"diffuse or sharpen"},{"categories":null,"content":"This module eliminates some of the banding artifacts that can result when darktable\u0026rsquo;s internal 32-bit floating point data is transferred into discrete 8-bit or 16-bit integer output format for display or export. It can also be used for creative posterization effects.\nAlthough not an inherent problem in any of darktable\u0026rsquo;s modules, some operations may provoke banding if they produce a lightness gradient in the image. To mitigate possible artifacts you should consider activating dithering when using the vignetting or graduated density modules. This is especially relevant for images with extended homogeneous areas such as cloudless sky. Also watch out for banding artifacts when using a gradient drawn mask.\nViewing an image dithered into a very low bit depth from some distance (e.g. “Floyd-Steinberg 1-bit b\u0026amp;w”) will give the impression of a homogeneous grayscale image. darktable attempts to mimic this impression when rendering zoomed-out images in the center view, the navigation window and thumbnails. This is accomplished by dithering those images into a higher number of grayscale levels. Note that, as a consequence, the scopes module \u0026ndash; the data for which is derived from the navigation window \u0026ndash; will show this increased number of levels and is therefore not a full match to the output image.\n🔗module controls method Choose the dithering method to use. Floyd-Steinberg (default): Systematically distribute quantization errors over neighboring pixels. This method can be selected with some typical output bit depths. Alternatively, you can select Floyd-Steinberg auto, which automatically adapts to the desired output format.\nrandom dithering: This method just adds some level of randomness to break sharp tonal value bands.\nposterization: This method quantizes the pixel values into the indicated number of distinct levels per color channel (similar to Floyd-Steinberg) but does not redistribute the quantization errors, producing a posterization effect. Selecting two levels per channel produces eight possible output colors, three levels produces 27 colors (3x3x3), and so on. Use other modules affecting colors or tone curves (such as tone equalizer or color balance rgb) to fine-tune which pixels produce which posterized colors. You can also use various blending modes to control the colors of the result.\ndamping (\u0026ldquo;random\u0026rdquo; method only) Controls the level of added random noise expressed as a damping factor in a 10*log 2 basis. A value of -80 is a good fit for 8-bit output formats as it corresponds to a maximum change of one of the 256 possible levels; -160 is a good fit for for 16-bit output. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/dither-or-posterize/","tags":null,"title":"dither or posterize"},{"categories":null,"content":"Increase the size of the image canvas and fill the additional area with the selected color.\n🔗module controls percent left The amount of enlargement to the left of the image. percent right The amount of enlargement to the right of the image. percent top The amount of enlargement to the top of the image. percent bottom The amount of enlargement to the bottom of the image. color The color with which to fill the additional area. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/enlarge-canvas/","tags":null,"title":"enlarge canvas"},{"categories":null,"content":"Increase or decrease the overall brightness of an image.\nThis module has two modes of operation:\nmanual Set the exposure and black level manually automatic (RAW images only) Use an analysis of the image\u0026rsquo;s histogram to automatically set the exposure. Darktable automatically selects the exposure compensation that is required to shift the selected percentile to the selected target level (see definitions below). This mode is particularly useful for automatically altering a large number of images to have the same exposure. A typical use case of automatic mode is deflickering of time-lapse photographs. 🔗module controls mode Choose the mode of operation (automatic/manual). compensate camera exposure (manual mode) Automatically remove the camera exposure bias (taken from the image\u0026rsquo;s Exif data). exposure (manual mode) Increase (move to the right) or decrease (move to the left) the exposure value (EV). To adjust by more than the default limits shown on the slider, right click and enter the desired value up to +/-18 EV (see module controls). The picker tool on the right sets the exposure such that the average of the selected region matches the target lightness defined in area exposure mapping options. percentile (automatic mode) Define a location in the histogram to use for automatic exposure correction. A percentile of 50% denotes a position in the histogram where 50% of pixel values are above and 50% of pixel values are below that exposure. target level (automatic mode) Define the target level for automatic exposure correction (EV) relative to the white point of the camera. black level correction (manual and automatic modes) Adjust the black level point to unclip negative RGB values. Note: Do not use the black level correction to add more density in blacks as this can clip near-black colors out of gamut by generating negative RGB values. This can cause problems with some modules later in the pixelpipe. Instead, use a tone mapping curve to add density to the blacks. For example, you can use the relative black exposure slider on the scene tab of the filmic rgb module, or establish a deeper toe in the base curve module.\n🔗area exposure mapping The area mapping feature is designed to help with batch-editing a series of images in an efficient way. In this scenario, you typically develop a single reference image for the whole batch and then copy\u0026amp;paste the development stack to all of the other images in the batch.\nUnfortunately, the light often changes slightly between shots, even within the same series captured in the same conditions. This can be the result of a cloud passing by the sun in natural light, surface reflections having less \u0026ldquo;shine\u0026rdquo; from a different angle, or simply due to unavoidable variability in the mechanical diaphragm aperture. Each image will still need some individual fine-tuning if you want a perfectly even look over the whole series, and this can be both time-consuming and frustrating.\nArea exposure mapping allows you to define a target brightness, in terms of exposure, for a particular region of the image (the control sample), which you then match against the same target brightness in other images. The control sample can either be a critical part of your subject that needs to have constant brightness, or a non-moving and consistently-lit surface over your series of images.\nThe mapping process consists of two steps.\n🔗step 1: set the target There are two ways of setting the target brightness for your control sample:\nif you know or expect an arbitrary lightness for the control sample (for example, a gray card, a color chart, a product or a logo of a specified brightness), you can set its L value directly, in CIE Lab 1976 space, if you simply want to match the development of your reference image, set the area mode to measure, then enable the picker (to the right of the exposure slider) and draw a rectangle over your control sample. The input column will then be updated with the lightness value of the control sample before the exposure correction, and the target column will show the resulting lightness of the control sample after the current exposure setting is applied. If you reset the lightness value, the default value is 50% (middle-gray) \u0026ndash; this can be useful to quickly set the average exposure of any image.\nNote that the target value is not reset when you reset the module itself, but is stored indefinitely in darktable\u0026rsquo;s configuration and will be available on next launch as well as for the next image you develop.\n🔗step 2 : match the target When you open a new image, the area mode is automatically reset to correction. Using the picker attached to the exposure slider, you can then directly reselect your control sample in the new image. The proper exposure setting required for the control sample to match the memorized target lightness will be automatically computed, and the setting will be updated in the same operation.\nThis operation can be repeated as many times as you have images in your series with no further work.\nNote 1: Trying to match lightness of moving parts of a subject across frames can prove tricky because they can have legitimate changes in their illumination as their orientation changes with respect to the main light source. For example, a part of the face can be fully lit in some frames and partially shaded in others. An inconsistently-lit control sample will generally not provide a robust reference for lightness matching across a series and may result in more work than manually matching it with visual feedback.\nNote 2: The exposure module works (by default) in the scene-referred, linear, camera RGB part of the pixel pipeline, before the input color profile is applied. However, the conversion from camera RGB to CIE Lab 1976 space relies on the input color profile. All of the lightness L metrics given in the area mapping settings will use the input profile defined later in the input color profile module to perform the conversion accurately, but the conversion itself assumes a linear (RAW) signal and will not work for JPEG and PNG images (which are non-linearly encoded before the input color profile module). If you want to use this feature on non-RAW images, you will need to move the exposure module to after input color profile or to use the module order preset v3.0 for JPEG/non-RAW input.\nNote 3: Perfectly matching your control sample against the target lightness may still not yield a similar perceptual result, even if the numbers are exactly the same. For example, if your subject sits in front of a background made of some bright parts and some dark parts, the ratio of bright areas / dark areas will affect the perception of contrast and brightness. If this ratio changes across your series, the subject brightness will not appear constant even though the lightness value is exactly constant. For more details, see the checker shadow illusion and the Chubb illusion.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/exposure/","tags":null,"title":"exposure"},{"categories":null,"content":"In the default mode images are displayed in a grid with an adjustable number of images per row.\n🔗controls zoom The number of images in each row can be altered using the slider in the bottom panel, or by holding Ctrl while scrolling over the center view with your mouse. navigate You can navigate through the images using the arrow keys (←/→/↑/↓) or by scrolling with your mouse. Press the Home key to scroll to the top of the collection, the End key to scroll to the bottom, and PageUp/PageDown to scroll up/down by a page. select You can select the image under the pointer by clicking on its thumbnail or by pressing Enter. A range of images can be selected by clicking on the first image and then Shift+clicking on the last one. Images can be added or removed from a selection by Ctrl+clicking on their thumbnails or by pressing Spacebar. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/lighttable-modes/filemanager/","tags":null,"title":"filemanager"},{"categories":null,"content":"Remap the tonal range of an image by reproducing the tone and color response of classic film.\nThis module can be used either to expand or to contract the dynamic range of the scene to fit the dynamic range of the display. It protects colors and contrast in the mid-tones, recovers the shadows, and compresses bright highlights and dark shadows. Highlights will need extra care when details need to be preserved (e.g. clouds).\nThe module is derived from another module of the same name in Blender 3D modeller by T. J. Sobotka. While it is primarily intended to recover high-dynamic-range images from raw sensor data it can be used with any image in place of the base curve module. The following video (by the developer of this module) provides a useful introduction: filmic rgb: remap any dynamic range in darktable 3.\nfilmic rgb is the successor to the filmic module from darktable 2.6. While the underlying principles have not changed much, the default settings and their assumptions have, so users of the previous version should not expect a 1:1 translation of their workflow to the new version.\nNote: Despite the technical look of this module, the best way to set it up is to assess the quality of the visual result. Do not overthink the numbers that are presented in the GUI to quantify the strength of the effects.\n🔗prerequisites In order to get the best from this module, your images need some preparation:\ncapturing (ETTR) In-camera, it is recommended that you use a technique known as \u0026ldquo;Expose To The Right\u0026rdquo; (ETTR). This means exposing the shot so that the exposure is as bright as possible without clipping the highlights. It is called \u0026ldquo;exposing to the right\u0026rdquo; because the in-camera histogram should be touching all the way up to the right hand side without peaking at the right hand side (which could indicate clipping). This technique ensures you make maximum use of the dynamic range of your camera\u0026rsquo;s sensor. The default auto-exposure metering mode in your camera will normally expose the image so that the average brightness in the image tends towards middle-gray. Sometimes, for scenes dominated by light tones, the camera will underexpose the image to bring those light tones more towards middle-gray. For scenes dominated by dark tones, it may overexpose the image and end up clipping the highlights. In such cases you can use the exposure compensation dial in your camera to raise or lower the exposure \u0026ndash; the darktable exposure module can automatically take this into account when processing your image.\nIn some cases (e.g. specular highlights reflecting off shiny objects) it may be acceptable to have some clipping, but be aware that any clipped data in your image is irrevocably lost. Where data has been clipped, filmic rgb offers a \u0026ldquo;highlight reconstruction\u0026rdquo; feature to help mitigate the effects of the clipping and blend it smoothly with the rest of the image. The settings for this feature are on the reconstruct tab. Some cameras also offer a \u0026ldquo;highlight priority\u0026rdquo; exposure metering mode that can help to maximise exposure while protecting the highlights, and many offer features such as \u0026ldquo;zebras\u0026rdquo; or \u0026ldquo;blinkies\u0026rdquo; in the live view to alert the photographer when parts of the image are being clipped.\nadjust for the mid-tones In the exposure module, adjust the exposure until the mid-tones are clear enough. Don\u0026rsquo;t worry about losing the highlights at this point \u0026ndash; they will be recovered as part of the filmic processing. However, it is important to avoid negative pixels in black areas else the computations performed by filmic rgb may produce unpredictable results. For some camera models (Canon, mainly), rawspeed (the raw decoding library of darktable) may set an exaggerated black level, resulting in crushed blacks and negative pixel values. If so, brighten the blacks by setting a negative black level correction value in the exposure module. white balance, denoise, demosaic If you plan on using filmic rgb\u0026rsquo;s auto-tuners, use the white balance module to first correct any color casts and obtain neutral colors. In RGB color spaces, luminance and chrominance are linked, and filmic rgb\u0026rsquo;s luminance detection relies on accurate measurements of both. If your image is very noisy, add an initial step of denoising to improve the black exposure readings, and use a high quality demosaic algorithm. You don\u0026rsquo;t need to worry about noise if you are planning to set up filmic manually, without using the auto-tuners. disable tone mapping modules If you plan to use one of filmic rgb\u0026rsquo;s chrominance preservation modes, avoid using base curve and the various tone mapping modules. These may produce unpredictable color shifts that would make the chrominance preservation useless. None of these modules should be required when using filmic rgb. 🔗usage The filmic rgb module is designed to map the dynamic range of the photographed scene (RAW image) to the dynamic range of the display.\nThis mapping is defined in three steps, each handled in a separate tab in the interface:\nThe scene tab contains the “input” settings of the scene, defining what constitutes white and black in the photographed scene.\nThe reconstruct tab offers tools to handle blown highlights.\nThe look tab contains the artistic intent of the mapping that is applied to the input parameters (as defined in the scene tab). This part of the module applies an S-shaped parametric curve to enhance the contrast of the mid-tones and remap the gray value to the middle-gray of the display. This is similar to what the base curve and tone curve modules do. As a general guideline, you should aim to increase the latitude as much as possible without clipping the extremes of the curve.\nThe display tab defines the output settings required to map the transformed image to the display. In typical use cases, the parameters in this tab rarely require adjustment.\nThe options tab includes some optional advanced settings and parameters.\nfilmic rgb tends to compress local contrast, so after you have finished adjusting settings here, you may wish to compensate for this using the local contrast module. You may also want to increase the saturation in the color balance rgb module, and perhaps to further adjust the tones using the tone equalizer.\nThe ranges of filmic rgb\u0026rsquo;s sliders are limited to typical and safe values, but you can enter values outside of these limits by right-clicking and entering values with the keyboard.\nNote: filmic rgb cannot be set with entirely neutral parameters (resulting in a \u0026ldquo;no-operation\u0026rdquo;) \u0026ndash; as soon as the module is enabled, the image is always at least slightly affected. You can, however, come close to neutral with the following settings:\nin the look tab, set contrast to 1.0, latitude to 99 % and mid-tones saturation to 0 %, in the options tab, set contrast in shadows and in highlights to soft. In this configuration, filmic will only perform a logarithmic tone mapping between the bounds set in the scene tab.\n🔗graphic display The graphic display at the top of the filmic rgb module offers multiple views to help you to understand its functionality. You can cycle through these views using the icon to the right of the graph display. You can also toggle the labels on the axes on and off using the icon.\nThe following views are available:\nlook only This is the default view. The main bright curve shows how the dynamic range of the scene (in EV) is compressed into the display-referred output range. The orange dot shows the middle-gray point, the white dots either side mark out the latitude range, and the orange part of the curve at the bottom and top indicates an overshoot problem with the spline (the look tab has some controls to deal with this). look + mapping (linear) This view shows the mapping of input values [0,1] to output values in linear space, including the dynamic range mapping and the output transfer function. Note that in a scene-referred workflow, input values are allowed to exceed 1, however the graph only shows in/out values in the interval [0,1] in order to make the shape of the graph comparable to other tone curve mapping tools such as base curve or tone curve. The actual value of the scene white point is shown in brackets on the X axis (expressed as a percentage of an input value of 1). look + mapping (log) The same as the previous view, but plotted in log space. dynamic range mapping This view is inspired by the Ansel Adams Zone System, showing how the zones in the input scene (EV) are mapped to the output. Middle gray from the scene is always mapped to 18% in the output (linear) space, and the view shows how the tonal ranges towards the extremes of the scene exposure range are compressed into a smaller number of zones in the display space, leaving more room for the mid-tones to be spread out over the remaining zones. The latitude range is represented by the darker gray portion in the middle. Note: When some parameters are too extreme, resulting in an unfeasible curve, filmic rgb will sanitize them internally. Sanitizing is illustrated in two ways on the look views:\nA dot becoming red indicates that the linear part of the curve is pushed too far towards the top or the bottom. In the look tab, reduce the latitude or recenter the linear part using the shadows ↔ highlights balance parameter. A dot becoming a half circle indicates that contrast is too low given the dynamic range of the image. Increase contrast in the look tab, or the dynamic range in the scene tab. 🔗module controls 🔗scene The controls in the scene tab are similar in principle to those of the levels module (black, gray, white). The difference is that levels assumes display-referred pixels values (between 0 and 100%), whereas filmic allows you to work on scene-referred pixels (between \u0026ndash;infinity EV and +infinity EV), which forces the use of a different interface.\nmiddle-gray luminance (hidden by default) This setting allows you to decide what luminance in the scene should be considered the reference middle-gray (which will be remapped to 18% in display). Use the picker tool to read the average luminance over the drawn area. If you have a photograph of a gray card or a color chart (IT8 chart or colorchecker) shot in the scene lighting conditions, then the gray picker tool can be used to quickly sample the luminance of the gray patch on that image. In other situations, the picker can be used to sample the average luminance of the subject. This has an effect on the picture that is analogous to a brightness correction. Values close to 100% do not compress the highlights but fail to recover shadows. Values close to 0% greatly recover the shadows but compress the highlights more harshly and result in local-contrast losses.\nWhen modifying the middle-gray luminance, the white and black exposures are automatically adjusted accordingly, to prevent the dynamic range from clipping and to help you set the right parameter faster. If you are not happy with the auto adjustment performed by the gray slider, you can correct the white and black exposure parameters afterwards.\nNote: You are not advised to use this control to set middle-gray, hence it is now hidden by default. You should instead use the exposure module to set the middle-gray level (see usage, above). However, if you wish to make this slider visible, you can enable it with the use custom mid-gray values checkbox in the options tab.\nwhite relative exposure The number of stops (EV) between the scene middle-gray luminance and the scene luminance to be remapped to display white (peak-white). This is the right bound of the scene dynamic range that will be represented on the display \u0026ndash; everything brighter than this value on the scene will be clipped (pure white) on the display. The picker tool reads the maximum luminance in RGB space over the drawn area, assumes it is pure white, and sets the white exposure parameter to remap the maximum to 100% luminance. black relative exposure The number of stops (EV) between the scene middle-gray luminance and the scene luminance to be remapped to display black (maximum density). This is the left bound of the scene dynamic range that will be represented on the display \u0026ndash; everything darker than this value on the scene will be clipped (pure black) on the display. The picker tool reads the minimum luminance in RGB space over the drawn area, assumes it is pure black, and sets the black exposure parameter to remap the minimum to 0% luminance. The black picker measurement is very sensitive to noise, and cannot identify whether the minimum luminance is pure black (actual data) or just noise. It works better on low ISO pictures and with high quality demosaicing. When the picker puts the black exposure at \u0026ndash;16 EV, this is a sign that the measurement has failed and you will need to adjust it manually. The black relative exposure allows you to choose how far you want to recover lowlights.\ndynamic range scaling and auto-tune The auto-tune picker combines the above pickers, and allows you to set the white and black exposures at the same time, using the maximum of the drawn region as the white and the minimum as the black. This gives good results in landscape photography but usually fails for portraits and indoor scenes. When no true white and black are available on the scene, the maximum and minimum RGB values read on the image are not valid assumptions any more. Dynamic range scaling symmetrically shrinks or enlarges the detected dynamic range and the current parameters. This works with both pickers, and adjusts the current values of white and black relative exposures.\nNote: There is no direct relationship between your camera sensor\u0026rsquo;s dynamic range (to be found in DxoMark.com or PhotonsToPhotos.org measurements) and the dynamic range in filmic (scene white EV \u0026ndash; scene black EV). Many things happen before filmic in the pipeline (for example a black raw offset that could map black to 0) such that filmic sees a theoretically infinite dynamic range at its input. This has to do only with pixel encoding manipulation in software, not actual sensor capabilities.\nThe scene-referred workflow forces a black level correction of \u0026ndash;0.0002, in the exposure module, which ensures that the dynamic range seen by filmic\u0026rsquo;s input is around 12.3 EV most of the time. Decrease this value even more if setting the black relative exposure in filmic to \u0026ndash;16 EV fails to unclip blacks.\n🔗reconstruct This tab provides controls that blend transitions between unclipped and clipped areas within an image and can also help to reconstruct colors from adjacent pixels. It is designed to handle spotlights that could not possibly be unclipped when taking the shot (such as naked light bulbs or the sun disc in the frame) and aims at diffusing their edges as film would do. It is not designed to recover large areas of clipped pixels or in-paint missing parts of the image.\nIt can sometimes be useful to disable the highlight reconstruction module in order to provide additional data to the reconstruction algorithm (highlight reconstruction clips highlight data by default). You should note that this can lead to magenta highlights, which will need to be handled with the gray/colorful details slider.\nFirstly, a mask needs to be set up to identify the parts of the image that will be affected by the highlights reconstruction. There are then some additional controls to fine-tune some of the trade-offs made by the reconstruction algorithm.\n🔗highlights clipping These controls allow you to choose which areas of the image are impacted by the highlight reconstruction algorithms.\nthreshold Any pixels brighter than this threshold will be affected by the reconstruction algorithm. The units are in EV, relative to the white point set in the scene tab. By default, this control is set to +3 EV, meaning that pixels need to be at least +3 EV brighter than the white point set in the scene tab in order for the highlight reconstruction to have any effect. In practise, this means that highlight reconstruction is effectively disabled by default (for performance reasons \u0026ndash; it should only be enabled when required). Therefore, to use the highlights reconstruction feature, first click the display highlight reconstruction mask icon to show the mask, and lower this threshold until the highlight areas you want to reconstruct are selected in white by the mask. It may be useful to first review the image using the raw overexposed warning to show you which pixels in the raw file have been clipped, and whether those pixels are clipped on just one RGB channel or all of them. transition Use this control to soften the transition between clipped and valid pixels. Moving this control to the right will increase the amount of blur in the mask, so that the transition between clipped and non-clipped areas is softer. This allows for a smoother blending between the clipped and non-clipped regions. Moving this control to the left will reduce the blur in the mask, making the transition in the mask much sharper and therefore reducing the amount of feathering between clipped and non-clipped areas. display highlight reconstruction mask Click on the icon to the right of this label to toggle the display of the highlight reconstruction mask. It is recommended that you turn this on while adjusting the above controls. 🔗balance These controls allow you to balance the trade-offs between the various reconstruction algorithms.\nstructure ↔ texture Use this to control whether the reconstruction algorithm should favor painting in a smooth color gradient (structure), or trying to reconstruct the texture using sharp details extracted from unclipped pixel data (texture). By default, the control is in the middle at 0%, which favors both strategies equally. If you have lots of areas where all three channels are clipped, there is no texture detail available to reconstruct, so it is better to move the slider to the left to favor color reconstruction. If you have lots of areas where only one or two channels are clipped, then there may be some texture detail in the unclipped channel(s), and moving the slider to the right will place more emphasis on trying to reconstruct texture using this unclipped data. bloom ↔ reconstruct Use this to control whether the algorithm tries to reconstruct sharp detail in the clipped areas (reconstruct), or apply a blur that approximates the blooming effect you get with traditional film (bloom). By default, this is set to 100%, which tries to maximise the sharpness of the detail in the clipped areas. Move this slider to the left if you want to introduce more blur in these areas. Introducing more blur will usually tend to darken the highlights as a by-product, which may lead to a more colorful reconstruction. gray ↔ colorful details Use this to control whether the algorithm favors the recovery of monochromatic highlights (gray) or colorful details. Move the slider to the right if you want more color in the highlights. Move the slider to the left if you want to reduce the saturation of the highlights. It can be helpful to reduce the saturation in the highlights if you start seeing magenta or out-of-gamut colors. 🔗look When working on the look tab, it is recommended that you monitor the S-curve spline on the look only graph. This curve starts from the scene/display black levels at the bottom left of the graph, and should smoothly increase up to the scene/display white levels at the top right. Sometimes, if the constraints on the S-curve are too tight, the splines in the shadows and/or highlights regions can \u0026ldquo;overshoot\u0026rdquo; the limits of the display, and an orange warning is shown on those parts of the spline.\nIf you see the orange warning indicator at either end of the S-curve, corrective actions should be performed to bring the S-curve back to a smooth monotonically increasing curve. This may involve:\nreducing the latitude and/or contrast,\nadjusting the shadows/highlights slider to shift the latitude and allow more room for the spline,\nensuring that the scene-referred black and white relative exposure sliders on the scene tab have been properly set for the characteristics of the scene,\nsetting one or both of the contrast settings on the options tab to safe or hard.\nIf the target black luminance setting on the display tab is non-zero, this can also make it difficult for filmic rgb to find a smooth monotonic spline, and reducing this can also help to relax the constraints. See the display section to understand the implications of this.\ncontrast The filmic S-curve is created by computing the position of virtual nodes from the module parameters and interpolating them. This is similar to how the tone curve module operates, but here, the nodes cannot be moved manually. The curve is split into three parts \u0026ndash; a middle linear part, and two extremities that transition smoothly from the slope of the middle part to the ends of the exposure range. The contrast slider controls the slope of the middle part of the curve, as illustrated in the graph display. The larger the dynamic range, the greater the contrast should be set to, in order preserve a natural-looking image. This parameter mostly affects the mid-tones. Note that global contrast has an impact on the acutance (perceived sharpness) \u0026ndash; a low-contrast image will look unsharp even though it is optically sharp in the sense of the Optical Transfer Function (OTF).\nSetting the contrast to 1 almost completely disables the S-curve, though there will be a very small residual effect from the splines in the highlights and shadows.\nhardness (previously target power factor function) Known as the target power factor function slider in older versions of filmic rgb, this slider is hidden by default, and is adjusted automatically based on values in the scene tab. To make this slider visible, you need to uncheck auto adjust hardness in the options tab. This parameter is the power function applied to the output transfer function, and it is often improperly called the gamma (which can mean too many things in imaging applications, so we should stop using that term). It is used to raise or compress the mid-tones to account for display non-linearities or to avoid quantization artifacts when encoding in 8 bit file formats. This is a common operation when applying ICC color profiles (except for linear RGB spaces, like Rec. 709 or Rec. 2020, which have a linear “gamma” of 1.0). However, at the output of filmic rgb, the signal is logarithmically encoded, which is not something ICC color profiles know to handle. As a consequence, if we let them apply a gamma of 1/2.2 on top, it will result in a double-up, which would cause the middle-gray to be remapped to 76% instead of 45% as it should in display-referred space.\nlatitude The latitude is the range between the two nodes enclosing the central linear portion of the curve, expressed as a percentage of the dynamic range defined in the scene tab (white relative exposure minus black relative exposure). It is the luminance range that is remapped in priority, and it is remapped to the luminance interval defined by the contrast parameter. It is usually advisable to keep the latitude as large as possible, while avoiding clipping. If clipping is observed, you can compensate by either decreasing the latitude, shifting the latitude interval with the shadow ↔ highlights balance parameter, or decreasing the contrast. The latitude also defines the range of luminances that are not desaturated at the extremities of the luminance range (See mid-tones saturation).\nshadows ↔ highlights balance By default, the latitude is centered in the middle of the dynamic range. If this produces clipping at one end of the curve, the balance parameter allows you to slide the latitude along the slope, towards the shadows or towards the highlights. This allows more room to be given to one extremity of the dynamic range than to the other, if the properties of the image demand it. mid-tones saturation / extreme luminance saturation / highlights saturation mix At extreme luminances, the pixels will tend towards either white or black. Because neither white nor black have color associated with them, the saturation of these pixels must be 0%. In order to gracefully transition towards this 0% saturation point, pixels outside the mid-tone latitude range are progressively desaturated as they approach the extremes. The darker curve in the filmic rgb graph indicates the amount of desaturation that is applied to pixels outside the latitude range. Moving the slider to the right pushes the point where desaturation will start to be applied towards the extremes, resulting in a steeper desaturation curve. If pushed too far, this can result in fringing around the highlights. Moving the slider to the left brings the point at which color desaturation will start to be applied closer to the center, resulting in a gentler desaturation curve. If you would like to see more color saturation in the highlights, and you have checked that the white relative exposure in the scene tab is not yet clipping those highlights, move the mid-tones saturation slider to the right to increase the saturation. Please note that this desaturation strategy has changed compared to previous versions of filmic rgb (which provided a different slider control labelled extreme luminance saturation). You can revert to the previous desaturation behaviour by selecting \u0026ldquo;v3 (2019)\u0026rdquo; in the color science setting on the options tab. Since filmic v6 and v7 use accurate gamut mapping to the output color space, the desaturation curve is removed and the extreme luminance desaturation becomes a method to control the bleaching of highlights.\nThis control is set to 0 by default and it is now recommended that saturation is handled earlier in the pipeline. A preset \u0026ldquo;add basic colorfulness\u0026rdquo; has been added to the color balance rgb module for this purpose.\n🔗display The parameters in this tab should rarely require adjustment.\ntarget black luminance The destination parameters set the target luminance values used to remap the tones. The default parameters should work 99% of the time, the remaining 1% being when you output in linear RGB space (Rec. 709, Rec. 2020) for media handling log-encoded data. These settings should therefore be used with caution because darktable does not allow separate pipelines for display preview and file output. The target black luminance parameter sets the ground-level black of the target medium. By default it is set to the minimum non-zero value that can be encoded by the available number of bits in the output color space. Reducing it to zero means that some non-zero luminances will be mapped to 0 in the output, potentially losing some detail in the very darkest parts of the shadows. Increasing this slider will produce raised, faded blacks that can provide something of a \u0026ldquo;retro\u0026rdquo; look.\ntarget middle-gray This is the middle-gray of the output medium that is used as a target for the S-curve\u0026rsquo;s central node. On gamma-corrected media, the actual gray is computed with the gamma correction (middle-gray^(1/gamma)), so a middle-gray parameter of 18% with a gamma of 2.2 gives an actual middle-gray target of 45.87%. target white luminance This parameter allows you to set the ceiling level white of the target medium. Set it lower than 100% if you want dampened, muted whites to achieve a retro look. To avoid double-ups and washed-out images, filmic rgb applies a “gamma” compression reverting the output ICC gamma correction, so the middle-gray is correctly remapped at the end. To remove this compression, set the destination power factor to 1.0 and the middle-gray destination to 45%.\n🔗options color science This setting defaults to v7 (2023) for new images, and defines the algorithms used by the filmic rgb module (e.g. the extreme luminance desaturation strategy). To revert to the behavior of previous versions of filmic rgb, set this parameter to v3 (2019), v4 (2020) or v5 (2021). The difference between these methods lies in the way in which they handle desaturation close to pure black and pure white (see the background section for details). If you have previously edited an image using older versions of filmic rgb, the color science setting will be kept at the earlier version number in order to provide backward compatibility for those edits. v7 (2023) removes the preserve chrominance option (see background). preserve chrominance (not available with color science v7) Define how the chrominance should be handled by filmic rgb \u0026ndash; either not at all, or using one of the three provided norms. When applying the S-curve transformation independently on each color, the proportions of the colors are modified, which modifies the properties of the underlying spectrum, and ultimately the chrominance of the image. This is what happens if you choose \u0026ldquo;no\u0026rdquo; in the preserve chrominance parameter. This value may yield seemingly “better” results than the other values, but it may negatively impact later parts of the pipeline, for example, when it comes to global saturation.\nThe other values of this parameter all work in a similar way. Instead of applying the S-curve to the R, G and B channels independently, filmic rgb, divides all the three components by a norm (N), and applies the S-curve to N. This way, the relationship between the channels is preserved.\nThe value of the preserve chrominance parameter indicates which norm is used (the value used for N):\nno means that the ratios between the RGB channels are not preserved. This will tend to saturate the shadows and desaturate the highlights, and can be helpful when there are out-of-gamut blues or reds. max RGB is the maximum value of the R, G and B channels. This is the same behaviour as the original version of the filmic rgb module. It tends to darken the blues, especially skies, and to yield halos or fringes, especially if some channels are clipped. It can also flatten the local contrast somewhat. luminance Y is a linear combination of the R, G and B channels. It tends to darken and increase local contrast in the reds, and tends not to behave so well with saturated and out-of-gamut blues. RGB power norm is the sum of the cubes of the R, G, and B channels, divided by the sum of their squares (R³ + G³ + B³)/(R² + G² + B²). It is usually a good compromise between the max RGB and the luminance Y values. RGB euclidean norm has the property of being RGB-space-agnostic, so it will yield the same results regardless of which working color profile is used. It weighs more heavily on highlights than the power norm and gives more highlights desaturation, and is probably the closest to a color film look. There is no \u0026ldquo;right\u0026rdquo; choice for the norm, and the appropriate choice depends strongly on the image to which it is applied. You are advised to experiment and decide for yourself which setting gives the most pleasing result with the fewest artifacts.\ncontrast in highlights This control selects the desired curvature at the highlights end of the filmic rgb spline curve. The default setting (safe) is guaranteed not to over- or under-shoot but has quite muted contrast near white. Selecting hard places a tighter constraint on the slope of the spline, which makes the curve sharper and hence introduces more tonal compression in the highlights. Selecting soft loosens this constraint, resulting in a gentler curve with less tonal compression in the highlights. contrast in shadows This control selects the desired curvature at the shadows end of the filmic rgb spline curve. The default setting (safe) is guaranteed not to over- or under-shoot but has quite muted contrast near black. Selecting hard places a tighter constraint on the slope of the spline, which makes the curve sharper and hence introduces more tonal compression in the shadows. Selecting soft loosens this constraint, resulting in a gentler curve with less tonal compression in the shadows. use custom middle-gray values Enabling this setting makes the middle-gray luminance slider visible on the scene tab. With the current version of filmic rgb, you are advised to use the exposure module to set the middle-gray level, so this setting is disabled by default (and the middle-gray luminance slider is hidden). auto-adjust hardness By default, this setting is enabled, and filmic rgb will automatically calculate the power function (aka \u0026ldquo;gamma\u0026rdquo;) to be applied on the output transfer curve. If this setting is disabled, a hardness slider will appear on the look tab so that value can be manually set. iterations of high-quality reconstruction Use this setting to increase the number of passes of the highlight reconstruction algorithm. More iterations means more color propagation into clipped areas from pixels in the surrounding neighbourhood. This can produce more neutral highlights, but it also costs more in terms of processing power. It can be useful in difficult cases where there are magenta highlights due to channel clipping. The default reconstruction works on separate RGB channels and has only one iteration applied, whereas the high quality reconstruction uses a different algorithm that works on RGB ratios (which is a way of breaking down chromaticity from luminance) and can use several iterations to graduately propagate colors from neighbouring pixels into clipped areas. However, if too many iterations are used, the reconstruction can denegenerate, which will result in far colors being improperly inpainted into clipped objects (color bleeding) \u0026ndash; for example white clouds being inpainted with blue sky, or the sun disc shot through trees being inpainted with leaf-green.\nadd noise in highlights This artificially introduces noise into the reconstructed highlights to prevent them from looking too smooth compared to surrounding areas that may already contain noise. This can help to blend the reconstructed areas more naturally with the surrounding non-clipped areas. type of noise This specifies the statistical distribution of the added noise. It can be helpful to match the look of the artificially generated noise with the naturally occurring noise in the surrounding areas from the camera\u0026rsquo;s sensor. The poissonian noise is the closest to natural sensor noise but is less visually pleasing than gaussian, which is probably closer to film grain. Also note that most denoising modules will turn the sensor noise from poissonian to slightly gaussian, so you should pick the variant that blends better into the actual noise in your image. 🔗background The color science parameter (in the options tab) defines the strategy that is used to desaturate colors near pure white (maximum display emission) and pure black (minimum display emission). The problem can be explained with the graph below, which represents the gamut of the sRGB color space at the constant hue of its green primary, with varying lightness (vertical axis) and chroma (horizontal axis):\nAs we approach pure black and pure white, the chroma available in gamut shrinks considerably until it reaches zero for lightness = 0 and lightness = 100% of the medium emission. This means that very bright (or very dark) colors cannot be very saturated at the same time if we want them to fit in gamut, with the gamut being imposed by the printing or displaying device we use.\nIf colors are left unmanaged and are allowed to escape gamut, they will be clipped to valid values at the time of conversion to display color space. The problem is that this clipping is generally not hue-preserving and definitely not luminance-preserving, so highlights will typically shift to yellow and appear darker than they should, when evaluated against their neighborhood.\nTo overcome this, filmic has used various strategies over the years (the so-called color sciences) to desaturate extreme luminances, forcing a zero saturation at minimum and maximum lightness and a smooth desaturation gradient. These strategies were all intended to minimize the hue shifts that come with gamut clipping.\nSince all of these strategies were approximations (and often over-conservative ones) v6 (2022) introduces a more accurate and measured approach. It performs a test-conversion to display color space, checks if the resulting color fits within the [0; 100]% range, and if it doesn\u0026rsquo;t, computes the maximum saturation available in gamut at this luminance and hue, finally clipping the color to this value. This ensures a minimal color distortion, allowing for more saturated colors and better use of the available gamut, but also enforces a constant hue throughout the whole tone mapping and gamut mapping operation.\nThis gamut mapping uses the output color profile as a definition of the display color space and automatically adjusts to any output space. However, only matrix or matrix + curve(s) ICC profiles are supported. LUT ICC profiles are not supported and, if used, will make the gamut mapping default to the pipeline working space (Rec. 2020 by default).\nNote that the hue used as a reference for the gamut mapping is the hue before any tone mapping, sampled at the input of filmic. This means that even the none chrominance preservation mode (applied on individual RGB channels regardless of their ratios) preserves hue in v6. This mode will only desaturate highlights more than the other modes, and a mechanism is in place to prevent it from resaturating shadows \u0026ndash; this behaviour can be bypassed by increasing the extreme luminance saturation setting.\nv7 (2023) improves over v6 (2022) by replacing the chroma preservation methods with a single slider. Chroma preservation methods aim at anchoring saturation and hue across the tone-mapping operation, by preserving RGB ratios compared to a norm. The choice of norm is important when it comes to managing how the gamut is used and how the contrast of bright objects (relative to their neighborhood) is rendered by the tone-mapper. Several norms have been proposed since filmic v1 (2018), none being objectively better and only one of which (max RGB) has some theoretical justification (allowing display peak primary colors to be reached after the transform).\nThe approach in v7 is to offer a mix between the max RGB norm and the no-preservation option (where the output hue and saturation are still forced to their input values). The proportions of the mix are driven by the highlights saturation mix setting as follows:\n-50% is strictly equivalent to the v6 no-preservation option, +50% is strictly equivalent to the v6 max RGB option, 0% is an average of no-preservation and max RGB, intermediate values are weighted averages between no-preservation and max RGB, values beyond ±50% (up to ±200%) are linear extrapolations. Positive values favor saturated highlights and are generally suitable for skies, but need to be handled with care for portraits (producing accurate skin tones), whereas negative values favor bleaching of highlights.\nThe highlights saturation mix slider provides fine control over the amount of saturation vs. bleaching expected in the highlights. Regardless of this setting, the saturation algorithm will never permit the output saturation to be higher than the input saturation. This setting is not designed for creative purposes, but only to drive the complicated trade-off that comes from remapping RGB values from one color space to another, each having different gamuts and dynamic ranges.\n🔗caveats 🔗color artifacts As filmic versions 6 and 7 are so far the best approach for retaining saturated colors at constant hue, they are also much less forgiving to invalid colors like chromatic aberrations and clipped magenta highlights, which are much better hidden (albeit not solved) by simple curves applied on individual channels (no chrominance preservation) with no care given to their ratios.\nIt is not the purpose of a tone mapping and gamut mapping operators to reconstruct damaged signals, and these flaws need to be corrected earlier in the pipeline with the specialized modules provided. However, there is a mechanism in filmic v6 that ensures that any color brighter than the white relative exposure degrades to pure white, so a quick workaround is to simply set the white relative exposure to a value slightly lower than the exposure of the clipped parts. In other words: if it is clipped at the input, let it be clipped at the output. Chrominance preservation options that work the best for this purpose are the luminance and euclidean norms, or simply none.\n🔗inconsistent output With filmic v6, if you export the same image to sRGB and Adobe RGB color spaces, and then compare both images side by side on a large-gamut screen (that can cover Adobe RGB), the sRGB export should have more desaturated highlights than the Adobe RGB version. Since the sRGB color space is shorter than Adobe RGB, its gamut boundary is closer to the neutral grey axis, and therefore the maximum allowed chroma is lower for any given luminance. This is by no means a bug but rather is proof that the gamut mapping is actually doing its job.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/filmic-rgb/","tags":null,"title":"filmic rgb"},{"categories":null,"content":"Generate a frame around the image.\nThe frame consists of a border (with a user-defined color) and a frame line within that border (with a second user-defined color). Various options are available to control the geometry and color of the frame.\n🔗module controls border size The size of the frame as a percentage of the underlying full image. aspect The aspect ratio of the final module output (i.e. the underlying image plus the frame). Right-click on the slider to enter a custom aspect as a ratio (e.g. \u0026ldquo;6:5\u0026rdquo;). orientation The orientation of the frame (portrait/landscape). Select \u0026lsquo;auto\u0026rsquo; for darktable to choose the most reasonable orientation based on the underlying image. horizontal/vertical position Select from a set of pre-defined ratios to control where the underlying image will be positioned on the horizontal/vertical axis. You can also right click and enter your own ratio as \u0026ldquo;x/y\u0026rdquo;. frame line size The percentage of the frame line size, relative to the border size at its smallest part. frame line offset The position of the frame line, relative to the underlying image. Choose 0% for a frame line that touches the image. Choose 100% for a frame line that touches the outer border. border color / frame line color A pair of color selectors which allow the border and frame line colors to be defined. Clicking on the colored field will open a color selector dialog which offers a choice of commonly-used colors, or allows you to define a color in RGB color space. You can also activate a picker to take a color probe from the image. show guides Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/framing/","tags":null,"title":"framing"},{"categories":null,"content":"Simulate a graduated density filter in order to correct exposure and color in a progressive manner.\nA line is shown on screen allowing the position and rotation of the gradient to be modified with the mouse.\nThis module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate these issues.\n🔗module controls density Set the density of the filter (EV). A low value underexposes slightly whereas a high value creates a strong filter. hardness The progressiveness of the gradient. A low value creates a smooth transition, whereas a high value makes the transition more abrupt. rotation The rotation of the filter. Negative values rotate clockwise. The rotation can also be set by dragging the end of the gradient line with the mouse. hue Choose a hue to add a color cast to the gradient. saturation The saturation of the color cast to add to the gradient (defaults to a neutral color cast of 0) ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/graduated-density/","tags":null,"title":"graduated density"},{"categories":null,"content":"Simulate the grain of analog film. The grain is processed on the L channel of Lab color space.\n🔗module controls coarseness The grain size, scaled to simulate an ISO number. strength The strength of the effect. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/grain/","tags":null,"title":"grain"},{"categories":null,"content":"Automatically reduce the effect of dust and haze in the atmosphere. This module may also be employed more generally to give pictures a color boost specifically in low-contrast regions of the image.\nHaze absorbs light from objects in the scene but it is also a source of diffuse background light. The haze removal module first estimates, for each image region, the amount of haze in the scene. It then removes the diffuse background light according to its local strength and recovers the original object light.\nSetting both of the module\u0026rsquo;s controls to unity maximizes the amount of haze removal but is also likely to produce some artifacts. Removing the atmospheric light entirely may render the image flat and result in an unnatural looking style. Optimal values are typically below unity and are rather image dependent, but also a matter of personal aesthetic preferences.\n🔗module controls strength The amount of haze removal. At unity, the module removes 100 percent of the detected haze up to the specified distance. Negative values increase the amount of haze in the image. distance Limit the distance up to which haze is removed. For small values, haze removal is restricted to the foreground of the image. Haze is removed from the entire image if the distance parameter is set to unity. If the strength is negative the distance control has no effect. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/haze-removal/","tags":null,"title":"haze removal"},{"categories":null,"content":"Attempt to reconstruct color information for pixels that are clipped in one or more RGB channel.\n🔗clipping Clipping occurs when the amount of captured light exceeds either the capacity of a camera\u0026rsquo;s sensor to record that light (photosite saturation) or the capacity of the Raw file to store it (digital clipping). Once a pixel is clipped we can no longer know the precise brightness of that pixel \u0026ndash; only that it is equal to or greater than the maximum value that pixel can store.\nIdeally, the photosite saturation point would be the same as the value at which digital clipping occurs (to make maximum use of the camera\u0026rsquo;s dynamic range) but these values often differ between cameras. Darktable uses a camera\u0026rsquo;s \u0026ldquo;white point\u0026rdquo; to determine whether or not a given channel is clipped. If the white point is set incorrectly for a given camera, this can lead to valid pixels being clipped and can adversely impact the effectiveness of this module.\nWhen a camera captures light (using a normal Bayer sensor) each pixel represents a single color (R,G,B), which is then interpolated by the demosaic module to calculate the color of neighboring pixels. The result will often be pixels (in the demosaiced image) that are clipped in some (R,G,B) channels but not others.\nIf these pixels are left partially clipped it can result in unrealistic colors appearing in the image. These incorrect colors can then be further skewed by the white balance module, which adjusts the ratios of the R, G, and B channels to account for the overall color of the scene. For example, where only the G channel is clipped (and R and B are close to clipping) the white balance module can cause the R and B channels to be adjusted above the clipping point of the G channel leading to pink highlights that would otherwise have been white.\nThe crude method to resolve this is to clip the R and B channels to the clipping point of the G channel (the \u0026ldquo;clip highlights\u0026rdquo; reconstruction method), but this can result in the loss of valid pixel data that may be useful in highlight reconstruction, and may also cause other artefacts and hue shifts.\n🔗highlight reconstruction methods A number of highlight reconstruction methods are provided within this module. These methods all use unclipped channels and/or adjacent pixels to reconstruct the missing data.\ninpaint opposed (default) Restore clipped pixels by using an average of adjacent unclipped pixels to estimate the correct color. This works well for the majority of images but may fail where the clipped areas are adjacent to areas of a different color. segmentation based A more sophisticated algorithm that uses adjacent unclipped pixels to estimate the correct color, by treating each clipped area separately (as an individual segment). The color of each clipped segment is estimated by analysing the color ratios of the adjacent pixels. Pixels that are too dark or appear to be an edge are rejected by the algorithm. If all surrounding pixels are rejected, that segment is reconstructed using the \u0026ldquo;inpaint opposed\u0026rdquo; method (above). Segments that are close together are often parts of the same object and so can be treated as if they were a single segment. Segmentation based reconstruction is able to rebuild large areas where all channels are clipped by examining the surrounding gradients. However, you should think of this method more as a way to \u0026ldquo;disguise\u0026rdquo; clipped areas with something plausible, rather than a way to \u0026ldquo;magically\u0026rdquo; repair them.\nguided laplacians Use an algorithm (derived from the diffuse or sharpen module) to replicate details from valid channels into clipped channels and to propagate color gradients from valid surrounding regions into clipped regions. This is a computationally-intensive method designed for maximum smoothness and seamless blending of the reconstructed regions into their neighborhood, and is designed primarily to reconstruct spotlights and specular reflections. This mode is available for Bayer sensors only. clip highlights Clamp all pixels to the white level (i.e. clip the remaining color channels). This method is most useful in cases where clipped highlights occur in naturally desaturated objects (e.g. clouds). reconstruct in LCh Analyse each pixel with at least one clipped channel and attempt to correct the clipped pixel (in LCh color space) using the values of the other (3 for Bayer or 8 for X-Trans) pixels in the affected sensor block. The reconstructed highlights will still be monochrome, but brighter and with more detail than with “clip highlights”. This method works fairly well with a high-contrast base curve, which renders highlights desaturated. As with clip highlights this method is a good option for naturally desaturated objects. reconstruct color Use an algorithm that transfers color information from unclipped surroundings into the clipped highlights. This method works very well on areas with homogeneous colors and is especially useful on skin tones with smoothly fading highlights. Please note that this method can produce maze-like artifacts on highlights behind high-contrast edges, for example well-exposed fine structures in front of an overexposed background. Note: When using the highlight reconstruction included with the filmic rgb module it may be better to avoid using this module in clip highlights mode (so that filmic rgb has more information to work with).\n🔗module controls 🔗common controls method The method used to reconstruct highlights. clipping threshold Pixels above this value are considered to be clipped. Click the icon beside the slider to visualise what areas of the image are considered to be clipped (the clipping mask). If the clipping mask does not match the RAW overexposed warning, you may need to correct this value.\n🔗\u0026ldquo;guided laplacians\u0026rdquo; mode noise level Add Poisson noise (natural photon noise such as you would find in sensor readings) to the clipped regions. For high-ISO images, the valid regions of the image will be noisy, but the reconstructed clipped areas will be smooth, which may look odd. Adding some noise in the reconstruction helps to visually blend the result with the rest of the image. iterations The guided laplacians mode is an iterative process that extrapolates gradients and details from the neighborhood. Each new iteration refines the previous reconstruction but adds more computations that will make the module slower. The default number of iterations should provide reasonable results but you can increase if magenta highlights are not completely recovered \u0026ndash; increase this parameter gradually but carefully, to manage the speed/quality trade-off. inpaint a flat color Inpainting a flat color is an algorithmic trick that may help recover magenta highlights in difficult cases (large blown areas) by smoothing RGB ratios. It can be seen as a \u0026ldquo;reconstruction booster\u0026rdquo; that may reduce the number of iterations required to entirely remove magenta in clipped highlights. However, this also makes the reconstruction less accurate and can lead to non-smooth reconstructed edges and unrelated colors being inpainted (e.g. blue sky or green leaves bleeding into white clouds). Use this setting with caution. diameter of the reconstruction The guided laplacians mode uses a multi-scale algorithm that tries to recover details from each scale independently. The diameter of the reconstruction is the largest scale used by the algorithm. Large scales will increase memory consumption as well as runtimes, and may also cause unrelated colors or details to be inpainted in clipped regions. You are advised to use a diameter roughly twice as large as the largest clipped area to be reconstructed. It is also possible that a given diameter may not suit all clipped areas, in which case you should use several instances at different scales and mask the clipped areas accordingly. 🔗\u0026ldquo;segmentation based\u0026rdquo; mode clipping threshold Since this controls the number of pixels that are considered to be clipped, it also changes the size of the resulting segments and the location of the adjacent pixels used for the reconstruction. For accurate adjustment, you can use the exposure module to ensure that no highlights are clipped in the histogram (or the image you see on screen). Then raise the clipping threshold until the highlights are no longer white and slowly lower it again until they look acceptable. combine The radius at which close segments are combined and considered to be part of the same segment. Increase (to combine more segments) when different parts of the same object have been incorrectly reconstructed to different colors. Decrease (to separate segments) when different objects have been incorrectly reconstructed to the same color. Click on the button beside the slider to see the outlines of the resulting segments. candidating Choose whether to prefer choosing candidate pixels (used to obtain color data) with segmentation analysis (high values) or inpaint opposed (low values). Click the button beside the slider to show the segments that are considered to have good candidates. rebuild Choose how to rebuild areas that have all channels clipped. The \u0026ldquo;small\u0026rdquo; and \u0026ldquo;large\u0026rdquo; modes are tuned for segment sizes less than 25 and greater than 100 pixels in diameter, respectively. The \u0026ldquo;flat\u0026rdquo; modes attempt to ignore narrow un-clipped features (powerlines, branches) to avoid gradients. Finally, the \u0026ldquo;generic\u0026rdquo; modes attempt to find the best settings for each segment. 🔗\u0026ldquo;guided laplacians\u0026rdquo; mode and filmic\u0026rsquo;s highlight reconstruction It is important to note that the highlight reconstruction module is quite early in the pixel pipeline \u0026ndash; before input color profile and the full chromatic adaptation in color calibration (if you use the modern chromatic adaptation workflow). A common trick to solve clipped highlights is to simply desaturate them to white but, because white is not defined before the full chromatic adaptation and the input color profiling, it is not possible to use this trick here. Technically, there is no color yet at this point in the pipeline, only an arbitrary 3D signal.\nThe guided laplacians approach has been designed specifically to be immune to white-balance discrepancies and to avoid any concept or method related to color (so there is no explicit desaturation). It only handles gradients (transitions) in the signal and aims at connecting them smoothly, in order to fill the missing parts. This process is quite heavy though, since it falls into the category of supervised machine learning (gradient-based optimization through multi-scale curvature), which is a sub-branch of artificial intelligence.\nFilmic\u0026rsquo;s highlight reconstruction uses a simpler color propagation algorithm coupled with a desaturation option that can favor an achromatic reconstruction. Not only does it know about color (because it comes after the full color profiling and chromatic adaptation) but it also uses a simplified and faster version of the algorithm used by the guided laplacians approach. Namely, this variant will not try as hard to restore details and will favor a smooth blur instead.\nThe filmic reconstruction is good enough for very large clipped patches and offers the benefit of being able to degrade to white as a last resort. It is also better and faster to inpaint solid color into clipped areas, at the expense of details. Its main drawback is that it is not as selective in the source of the colors being inpainted in clipped parts, so it may inpaint unrelated colors.\nAll in all, you are advised to use the guided laplacians highlight reconstruction mode to:\nsmooth the boundaries of clipped areas, recover spotlights and clipped areas of diameter below approximately 256px (on the full-resolution RAW), remove chromatic aberrations, which can occur during demosaicing (the next module in the pipeline) at the boundary between clipped and valid regions. If you find yourself having to increase the diameter of reconstruction past 512px to get a full recovery from magenta, the best approach is usually to cap the diameter to 512px, do the most you can with this setting, and then enable filmic\u0026rsquo;s highlight reconstruction to finish the work. This will give more bearable run-times with a very similar result.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/highlight-reconstruction/","tags":null,"title":"highlight reconstruction"},{"categories":null,"content":"A high pass filter.\nThis module is primarily intended to be used in combination with a blend mode. For example, try using the module with a blend mode of \u0026ldquo;soft light\u0026rdquo; for high pass sharpening.\nNote: This module performs blurs in Lab color space, which can result in undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for fine sharpness or the local contrast module for general sharpness.\n🔗Module Controls sharpness The sharpness of the filter contrast boost The contrast boost ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/highpass/","tags":null,"title":"highpass"},{"categories":null,"content":"Automatically detect and eliminate hot pixels.\nHot pixels are pixels which have failed to record a light level correctly. Detected hot pixels are replaced by an average of their neighbors.\n🔗module controls threshold How strong a pixel\u0026rsquo;s value needs to deviate from that of its neighbors to be regarded as a hot pixel. strength The blending strength of the hot pixels with their surrounding. detect by 3 neighbours Extend the detection of hot pixels \u0026ndash; regard a pixel as hot if a minimum of only three (instead of four) neighbor pixels deviate by more than the threshold level. mark fixed pixels Visually mark the corrected pixels on the image and display a count of hot pixels that have been fixed. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/hot-pixels/","tags":null,"title":"hot pixels"},{"categories":null,"content":"Define how darktable will interpret the colors of the image.\nThis module takes the color space used by the image source (e.g. camera, scanner) and converts the pixel encodings to a standardized working color space. This means that subsequent modules in the pipeline don\u0026rsquo;t need to be concerned with the specifics of the input device, and can work with and convert to/from a common working color space.\nWhere an image has been captured in a raw file, the input color profile module will normally apply either a standard or enhanced color matrix specific for that camera model, which will be used to map the colors into the working profile color space. If color space information is embedded in the image, the input color profile module will use this information when mapping the colors to the working profile color space. The user can also explicitly specify a color space for the incoming image, and can even supply a custom ICC color profile specifically made for the input device.\nAs part of the mapping from the input color space to the working profile space, the colors can be confined to a certain gamut using the gamut clipping options, which can help to mitigate some (infrequent) color artifacts. This is also influenced by the chosen rendering intent.\nNote that the final color profile that will be used when exporting the image is controlled by the output color profile module.\n🔗module controls input profile The profile or color matrix to apply. A number of matrices are provided along with an enhanced color matrix for some camera models. The enhanced matrices are designed to provide a look that is closer to that of the camera manufacturer. You can also supply your own input ICC profiles and put them into $DARKTABLE/share/darktable/color/in or $HOME/.config/darktable/color/in (where $DARKTABLE is the darktable installation directory and $HOME is your home directory). Note that these color/in directories are not created by the darktable install; if you need to use one, you must create it yourself. One common source of ICC profiles is the software that is shipped with your camera, which often contains profiles specific to your camera model. You may need to activate the unbreak input profile module to use your own profiles.\nIf your input image is a low dynamic range file like JPEG, or a raw file in DNG format, it might already contain an embedded ICC profile, which darktable will use by default. You can restore this default by selecting “embedded icc profile”. If you hover your mouse over the input profile combobox on such an image, details of the embedded profile will be shown in a tooltip.\nworking profile The working profile used by darktable\u0026rsquo;s processing modules. Each module can specify an alternative space that it will work in, and this will trigger a conversion. By default darktable will use \u0026ldquo;linear Rec. 2020 RGB\u0026rdquo;, which is a good choice in most cases. gamut clipping Activate a color clipping mechanism. In most cases you can leave this control in its default “off” state. However, if your image shows some specific features such as highly saturated blue light sources, gamut clipping might be useful to avoid black pixel artifacts. See possible color artifacts for more information. Choose from a list of RGB profiles. Input colors with a saturation that exceeds the permissible range of the selected profile are automatically clipped to a maximum value. “linear Rec. 2020 RGB” and “Adobe RGB (compatible)” allow for a broader range of unclipped colors, while “sRGB” and “linear Rec. 709 RGB” produce a tighter clipping. Select the profile that prevents artifacts while still maintaining the highest color dynamics.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/input-color-profile/","tags":null,"title":"input color profile"},{"categories":null,"content":"This section is intended to provide you with a flavor of what darktable can do and offer a suggested end-to-end processing workflow. New users should start by working through this introduction and following the links provided for further details.\nPlease note that this is not an exhaustive guide and many useful topics are not covered. You are advised to read through the reference sections of this manual once you are familiar with the basics.\nFurther information on most of the subjects in this guide are also covered in the other resources section.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/workflow/introduction/","tags":null,"title":"introduction"},{"categories":null,"content":"Automatically correct for (or simulate) lens distortion, transverse chromatic aberrations (TCA) and vignetting.\nYou can choose to either use lens correction data embedded in your Raw file (where present/supported) or correction data provided by the external Lensfun library.\nAdditional controls are also provided for manual vignetting correction, in case the profiles for your lens are insufficient or missing.\nNote that if TCA correction is enabled in this module, also using raw chromatic aberrations may cause artifacts from over-correction.\n🔗Lensfun correction data If your system\u0026rsquo;s Lensfun library has no correction profile for the automatically identified camera/lens combination, the controls for the three photometric parameters (below) are replaced with a warning message. You may try to find the right profile yourself by searching for it in the menu.\nIf your lens is present in the list but has not been correctly identified, this may require some adjustment within the exiv2 program (see this post for details). Note that you may need to re-import the images once such adjustments have been made as the lens name is retrieved as part of the import process.\nBy default, only lenses that are directly compatible with your camera\u0026rsquo;s mount are listed and automatically identified. If you are using lenses for a different mount with an adapter (for example a Four Thirds lens adapted to a Micro Four Thirds body), then you must run the lensfun-add-adapter tool to enable those lenses.\nIf you can\u0026rsquo;t find your lens, check if it is in the list of currently supported lenses, and try running the lensfun-update-data tool. If there is still no matching profile for your lens, a lens calibration service is offered by Torsten Bronger, one of darktable\u0026rsquo;s users. Alternatively you may visit the Lensfun project to learn how to generate your own set of correction parameters. Don\u0026rsquo;t forget to share your profile with the Lensfun team!\n🔗module controls correction method Choose which method to use to correct distortions. Additional controls will be provided depending on the option selected: \u0026ldquo;Lensfun database\u0026rdquo;: Use corrections provided by the Lensfun project. \u0026ldquo;embedded metadata\u0026rdquo;: Use corrections embedded in the metadata of the Raw file. This is only available if supported metadata is found. \u0026ldquo;only manual vignette\u0026rdquo;: Do not perform any automatic correction but provide manual vignette correction. corrections Choose which corrections (distortion, TCA, vignetting) to apply. Change this from its default \u0026ldquo;all\u0026rdquo;, if your camera has already performed some internal corrections (e.g. vignetting), or if you plan to undertake some corrections with a separate program. corrections done Occasionally, for a given camera/lens combination, only some of the possible corrections are supported. This message box appears at the bottom of the module to indicate which corrections have actually been applied to the image. show guides Tick the box at the bottom of the module to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details. 🔗Lensfun controls The following controls are provided for the \u0026ldquo;Lensfun\u0026rdquo; correction method only:\ncamera The camera make and model as determined by the image\u0026rsquo;s Exif data. You can override this manually and select your camera from a hierarchical menu. Only lenses with correction profiles matching the selected camera will be shown. lens The lens make and model as determined by the image\u0026rsquo;s Exif data. You can override this manually and select your lens from a hierarchical menu. This is mainly required for pure mechanical lenses, but may also be needed for off-brand / third party lenses. photometric parameters (focal length, aperture, focal distance) Lens corrections depend on certain photometric parameters that are read from the image\u0026rsquo;s Exif data: focal length (for distortion, TCA, vignetting), aperture (for TCA, vignetting) and focal distance (for vignetting). Many cameras do not record focal distance in their Exif data, in which case you will need to set this manually. You can manually override all automatically selected parameters. Either take one of the predefined values from the drop-down menu or, with the drop-down menu still open, just type in your own value.\ntarget geometry In addition to correcting lens flaws, this module can change the projection type of your image. Set this combobox to the desired projection type (e.g. \u0026ldquo;rectilinear\u0026rdquo;, \u0026ldquo;fisheye\u0026rdquo;, \u0026ldquo;panoramic\u0026rdquo;, \u0026ldquo;equirectangular\u0026rdquo;, \u0026ldquo;orthographic\u0026rdquo;, \u0026ldquo;stereographic\u0026rdquo;, \u0026ldquo;equisolid angle\u0026rdquo;, \u0026ldquo;Thoby fisheye\u0026rdquo;). To correct the aspect ratio of an anamorphic lens, use the rotate and perspective module. scale Adjust the scaling factor of your image to avoid black corners. Press the auto scale button (to the right of the slider) for darktable to automatically find the best fit. mode The default behavior of this module is to correct lens flaws. Switch this combobox to \u0026ldquo;distort\u0026rdquo; in order to instead simulate the flaws/distortions of a specific lens (inverted effect). TCA overwrite Check this box to override the automatic correction parameters for TCA. This will expose the TCA red and TCA blue parameters below. Un-check the box to revert back to automatic corrections. TCA red; TCA blue Override the correction parameters for TCA. You can also use these sliders to manually set the parameters if the lens profile does not include TCA correction. Look out for colored seams at features with high contrast edges and adjust the TCA parameters to minimize those seams. Note: TCA corrections will not be applied to images that have been identified as monochrome (see developing monochrome images for more information).\nNote: The lens correction module will fill in missing data at the borders by repeating the borders\u0026rsquo; pixels. For strong corrections, this filling can be visible (especially on noisy images). Crop the image if necessary.\n🔗embedded metadata controls The following controls are provided for the \u0026ldquo;embedded metadata\u0026rdquo; correction method only:\nuse latest algorithm This control appears for images using an older version of the \u0026ldquo;embedded metadata\u0026rdquo; correction algorithm. Check this box to irreversibly change to the newer algorithm. The following controls can be revealed by clicking the \u0026ldquo;fine-tuning\u0026rdquo; button:\ndistortion Fine-tune the distortion / chromatic aberration correction. vignetting Fine-tune the vignetting correction. TCA red Fine-tune the red chromatic aberration correction. TCA blue Fine-tune the blue chromatic aberration correction. image scale Override the image scaling. 🔗manual vignette correction Full vignetting correction is unavailable or inadequate for many lenses, whether using embedded metadata or the Lensfun database. Click on the \u0026ldquo;manual vignetting correction\u0026rdquo; button to provide additional adjustments via the following controls.\nstrength the overall strength of the effect. radius the amount of the image that is unchanged by the correction. steepness the steepness of the correction effect outside of the radius. The effect of the correction can be visualised by clicking on the mask button beside the strength slider.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/lens-correction/","tags":null,"title":"lens correction"},{"categories":null,"content":"Move pixels around by applying freestyle distortions to parts of the image using points, lines and curves.\nAs you might want to use source data from any part of the image you will be shown the uncropped image (possibly with the cropping rectangle overlaid as a guide) while the module is active.\n🔗nodes Each of liquify\u0026rsquo;s tools is based on nodes. A point consists of a single node and a line or curve consists of a sequence of linked nodes defining a path.\nEach instance of the liquify module is limited to a maximum of 100 nodes \u0026ndash; for more nodes, use additional instances. However, please note that the liquify module consumes a lot of system resources.\nDrag the central point of a node to move the node around. The radius describes the area of the effect (distortion occurs only within this radius). To change the radius drag the handle at the circumference. A strength vector starting from the center describes the direction of the distortion, and its strength is depicted by the length of the vector. Change the vector by dragging its arrow head.\n🔗points A point consists of a single node and strength vector.\nClick the point icon to activate the point tool and then click on the image to place it. Hold Ctrl while clicking on the point icon to add multiple points without having to click the icon again each time. Right-click to exit creation mode.\n🔗point modes The strength vector of a point has three different modes. These can be toggled by holding Ctrl and clicking on the arrowhead of the strength vector.\nlinear A linear distortion inside the circle, starting from the opposite side of the strength vector and following the vector\u0026rsquo;s direction. This is the default mode. radial growing The strength vector\u0026rsquo;s effect is radial, starting with a strength of 0% in the center and increasing away from the center. This mode is depicted by an additional circle with the arrow pointing outwards. radial shrinking The strength vector\u0026rsquo;s effect is radial, starting with a strength of 100% in the center and decreasing away from the center. This mode is depicted by an additional circle with the arrow pointing inwards. 🔗feathering default mode By default the strength varies linearly from 0% to 100% between the center and the radius of the control point. It is possible to modify the feathering effect by clicking on the center of the circle. feathered mode In \u0026ldquo;feathered\u0026rdquo; mode, two control circles are displayed, which can be modified independently to feather the strength of the effect. Note that clicking the center of the circle again hides the feathering controls but does not return to the default mode. 🔗removing points A point can be removed by right-clicking on the center of the node.\n🔗lines and curves Lines and curves are sequences of points linked together by straight or curved lines. The effect is interpolated by a set of associated strength vectors.\nClick the appropriate icon to activate the line or curve tool and then click on the image to place a sequence of points forming the path. Right-click anywhere when the last point has been placed in order to finish drawing the line/curve.\nHold Ctrl while clicking on the line/curve icon to add multiple lines/curves without having to click the icon again each time. Right-click a second time to exit creation mode after the final line or curve has been completed.\nlines curves Ctrl+click on a line or curve segment to add a new control point. Ctrl+right-click on the center of a node to remove a control point.\nRight-click on a segment to remove the shape completely. Ctrl+Alt+click on a segment to change that segment from a line to a curve and vice versa.\n🔗link modes Ctrl+click on the center of a node to change the way the points of a curve are linked together. There are four modes, which correspond to different ways of handling the steepness of the bezier curve using control handles:\nautosmooth This is the default mode, in which control handles are not displayed \u0026ndash; controls are automatically computed to give a smooth curve. cusp Control handles can be moved independently. This mode is depicted by a triangle symbol in the node\u0026rsquo;s center. smooth Control handles always give a smooth curve. This mode is depicted by a diamond symbol in the node\u0026rsquo;s center. symmetrical Control handles are always moved together. This mode is depicted by a square symbol in the node\u0026rsquo;s center. 🔗view and edit nodes Click the node tool icon to activate or deactivate the node edit tool. This displays all currently-defined distortion objects and their controls. Alternatively you can right-click on the image at any time for the same effect.\n🔗warps and nodes count This information field displays the number of warps (individual distortion objects) and nodes currently in use.\n🔗show guides Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/liquify/","tags":null,"title":"liquify"},{"categories":null,"content":"Enhance the image\u0026rsquo;s local contrast.\nThis is achieved using either a local laplacian (default) or unnormalized bilateral filter. Both modes work exclusively on the L channel from Lab. The local laplacian filter has been designed to be robust against unwanted halo effects and gradient reversals along edges.\n🔗module controls mode Choice of local laplacian filter or bilateral grid. The following sections define the controls available for each of these modes. 🔗bilateral grid coarseness Adjust the coarseness of the details to be adjusted. contrast Control how strongly the algorithm distinguishes between brightness levels. Increase this parameter for a more contrasty look. detail Add or remove detail. Higher values increase local contrast. 🔗local laplacian To understand the parameters of the local laplacian filter, one can think of it as applying a curve to the image, similar to the following graph:\nThis curve is applied to the image in a way that works locally and avoids halo artifacts.\nThe local laplacian mode also supports shadow lifting and highlight compression, similar to the shadows and highlights module.\ndetail Add or remove detail. Higher values increase local contrast. This inserts an S shaped element in the center of the curve, to increase or decrease local contrast. highlights This affects one end of the S shaped contrast curve, effectively increasing or compressing contrast in the highlights. A low value pulls the highlights down. shadows Similar to the highlights parameter, this affects the other end of the contrast curve, and increases or decreases contrast in the shadows. A higher value gives more contrast in the shadows. A lower value lifts the shadows and can effectively simulate a fill light. Note that this is done with local manipulation of the image. However, this means that a completely dark image cannot be brightened in this way \u0026ndash; only dark objects in front of bright objects are affected. mid-tone range This controls the extent of the S shaped part of the contrast curve. A larger value makes the S wider, and thus classifies more values as mid-tones and fewer values as highlights and shadows. In higher dynamic range settings it can be useful to reduce this value to achieve stronger range compression, by lowering the contrast in the highlights and the shadows. Note however, that for really strong HDR scenarios this may work best in combination with a base curve that pre-compresses the range, perhaps with an approximately logarithmic curve. The exposure fusion feature in the base curve module may lead to more pleasing results at times, but is also more prone to halo effects. This setting can cause banding artifacts in the image if pushed to extreme values. This is due to the way in which darktable computes the fast approximation of the local laplacian filter.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/local-contrast/","tags":null,"title":"local contrast"},{"categories":null,"content":"Simulate human lowlight vision. This module can also be used to perform a day-to-night conversion.\nThe idea is to calculate a scotopic vision image, which is perceived by the rods rather than the cones in the eyes under low light. Scotopic lightness is then mixed with photopic value (regular color image pixel) using some blending function. This module can also simulate the Purkinje effect by adding some blueness to the dark parts of the image.\nThis module comes with several presets, which can be used to get a better idea of how the module works.\n🔗module controls curve The horizontal axis represents pixel lightness from dark (left) to bright (right). The vertical axis represents the kind of vision from night vision (bottom) to day vision (top). blue Set the blue hint in shadows (Purkinje effect). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/lowlight-vision/","tags":null,"title":"lowlight vision"},{"categories":null,"content":"Apply a low pass filter (for example, a Gaussian blur) to the image, while controlling the output contrast and saturation.\nThis module is primarily intended to be used in combination with a blend mode. For example, try using the local contrast mask preset with the overlay blend mode.\nNote: This module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for blurring or the tone equalizer module for dynamic range compression.\n🔗module controls radius The radius of the blur. soften with The blur algorithm to use: gaussian blur: Blur all image channels (L, a, b) bilateral filter: Blur the L channel only, while preserving edges contrast Higher absolute values increase contrast. Lower absolute values reduce contrast. Negative values result in an inverted negative image. A value of zero leads to a neutral plane. brightness Negative values darken the image. Positive values lighten the image. saturation The color saturation. Negative values result in complementary colors by inverting the a/b channels. Higher absolute values increase color saturation. Lower absolute values reduce color saturation. A value of zero fully desaturates the image. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/lowpass/","tags":null,"title":"lowpass"},{"categories":null,"content":"Transform RGB values with a 3D LUT file.\nA 3D LUT is a tridimensional table that is used to transform a given RGB value into another RGB value. It is normally used for film simulation and color grading.\nThis module accepts .cube, .3dl, .png (haldclut) and .gmz files. Uncompressed 3D LUT data is not saved in the database or the XMP file, but is instead saved to the 3D LUT file path inside the 3D LUT root folder. It is therefore important to back up your 3D LUT folder properly \u0026ndash; sharing an image with its XMP is pointless if the recipient doesn\u0026rsquo;t also have the same 3D LUT file in their own 3D LUT folder.\nThe compressed format .gmz is only available when GMIC is installed. This format can hold a full library of LUTs, and LUT data loaded from this type of file can be saved to the database and XMP files.\nNote: the module clips all values outside of the range [0,1]. You may have to reduce the range of the input before applying.\n🔗usage LUTs are most commonly used in darktable for color grading or film look simulation. For this reason, by default, the module is placed after the filmic rgb module in the pixelpipe and should be applied to a neutral image (without first applying a specific look). While you can find hundreds of free LUTs on the internet, you should note that not all of them are compatible with the darktable environment and workflow \u0026ndash; incompatible LUTs will not produce the advertised look. To limit the risk, a color grading LUT should have been created to work with one of the available \u0026ldquo;application color spaces\u0026rdquo; (see below), for both the input and the output of the module.\nCamera log LUTs (as F-log or S-Log3) are different to color-grading and film-look-simulation LUTs, and are intended to convert the camera log raw data into something (linear raw data or other color space) that darktable is able to understand. In this case the LUT 3D module should be manually placed between the demosaic and input color profile modules. Once you have done this, you can no longer choose an \u0026ldquo;application color space\u0026rdquo;. The \u0026ldquo;input profile\u0026rdquo; of input color profile module should be aligned with the output of the LUT. Please note that this use case has not yet been tested.\n🔗module controls file selection Choose the 3D LUT file to use. File selection is inactive if the 3D LUT root folder has not been defined in preferences \u0026gt; processing. application color space A 3D LUT is defined relative to a specific color space. Choose the color space for which the selected 3D LUT file has been built. Cube files are usually related to Rec. 709 while most others are related to sRGB. interpolation This defines how to calculate output colors when input colors are not exactly on a node of the RGB cube described by the 3D LUT. There are three interpolation methods available: tetrahedral (default), trilinear and pyramid. Usually you won\u0026rsquo;t see any difference between interpolation methods except with smaller sized LUTs. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/lut-3d/","tags":null,"title":"LUT 3D"},{"categories":null,"content":"At the top of each processing module is the module header.\nClick on the module name to expand the module and display the parameters that control its operation.\nBy default darktable will only allow one processing module to be expanded at a time \u0026ndash; if you click the header of another module, the previously-opened module\u0026rsquo;s controls are collapsed. If you want to expand more than one module, you may expand further modules by Shift+clicking on the header and all previously expanded modules will remain open. This behaviour can be reversed via a setting in preferences \u0026gt; darkroom.\nNote: Expanding a module does not cause it to be activated. See below for how to activate modules.\nThe module header contains the following controls in order from left to right:\non/off button Click to toggle the module on or off. Some modules are essential for image processing and cannot be disabled (though their parameters may be amended). Similarly, some modules are not applicable for certain types of image and cannot be enabled. Ctrl+click on the on/off button to toggle whether the module has focus. The focus state is usually used to activate any overlays that a module places over the image to control its functionality. For example, the crop module only shows the composition and crop guide lines on the image if it has focus. Modules are automatically given focus when expanded.\nmodule name The module name consists of a description of the module\u0026rsquo;s operation (which cannot be changed) followed by the module\u0026rsquo;s instance name (which can). By default the first instance of a module has an empty instance name. If you create additional instances, the name of each new instance is initiated with a unique integer. For example, the second created instance of an exposure module will be automatically named exposure 1. Ctrl+click on a module\u0026rsquo;s name to manually amend its instance name.\nmask toggle This icon will appear in the header whenever a mask is active on a module. Hover over the icon to see what type of mask is enabled. Click it to display the current mask as a yellow overlay over a black-and-white version of the image. Solid yellow indicates an opacity of 100%; a fully visible gray background image (without yellow overlay) indicates an opacity of 0%. This toggle button can be disabled in preferences \u0026gt; darkroom \u0026gt; show mask indicator in module headers. multiple instance menu This menu allows you to create, delete, move and rename module instances. Right-click on this icon to directly create a new instance of the module. See the multiple instances section for more information. reset Click to reset all module controls to their default values. Ctrl+click to reapply any automatic presets for the module \u0026ndash; if no automatic presets are applicable for this module, Ctrl+click will simply reset to default values (same as click). presets menu This menu allows you to apply, create and edit module presets. See the presets section for more information. The visibility of the four icons to the right of the module name can be controlled in preferences \u0026gt; darkroom \u0026gt; show right-side buttons in processing module headers.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/module-header/","tags":null,"title":"module header"},{"categories":null,"content":"Quickly convert an image to black \u0026amp; white using a variable color filter.\nTo use this module, first reduce the filter size (to concentrate its effect) and move it across the hue palette to find the best filter value for your desired image rendition. Then gradually expand the filter to include more hues and achieve more natural tonality.\nAlthough this module is easy to use, better results can usually be obtained by using the film emulation presets in the color calibration module.\nNote: Under certain conditions, especially highly saturated blue light sources in the frame, this module may produce black pixel artifacts. Use the gamut clipping option of the input color profile module to mitigate this issue.\n🔗module controls filter size/position The default central location of the filter has a neutral effect but dragging it to an alternate position applies a filter analogous to taking a b\u0026amp;w photograph through a conventional color filter. A picker can be activated to automatically set the position and size of the filter based on the selected portion of the image. Scroll the mouse wheel to change the filter size, making the filter\u0026rsquo;s range of hues more or less selective.\nhighlights Control how much to retain highlights. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/monochrome/","tags":null,"title":"monochrome"},{"categories":null,"content":"Process scanned film negatives.\nYou can obtain an image of a negative using a film scanner, or by photographing it against a white light (e.g. a light table or computer monitor) or off-camera flash.\n🔗preparation If the image of the negative was obtained using a digital camera, then in order to obtain accurate colors in the final image, you will need to take the following points into consideration:\nWhen taking the photograph, adjust the exposure to fully utilise the entire dynamic range of your camera sensor \u0026ndash; i.e. \u0026ldquo;expose-to-the-right\u0026rdquo;, so that the histogram in your camera touches the right hand side without clipping the image.\nEnsure the white balance is correctly set up to compensate for the light source used to illuminate the negative. You can take a profiling picture of the light source with no film negative in front of it, and then use the \u0026ldquo;from image area\u0026rdquo; feature in the white balance module to obtain a reference white-balance setting. This reference white balance setting can then be made into a style or simply pasted onto the images taken from your film negatives.\nApply the standard or enhanced camera matrix in the input color profile module.\nWhen scanning or photographing your film negative, make sure you include some unexposed part of the film within the captured image. This is required to set the Dmin parameter (see below). If this is not possible (e.g. your film holder completely obscures the unexposed parts of the film), you can take a separate image of an unexposed part of the film, measure the Dmin parameter from that image, and then paste that setting to the rest of the images from that film.\nWhen developing the scanned/photographed film negatives, it is recommended that you disable any tone mapping modules such as filmic rgb and base curve.\nThe working profile parameter in darktable\u0026rsquo;s input color profile module should be set to either linear Rec. 2020 RGB, or to an ICC profile representing the actual color space of your film emulsion. Some examples of such ICC profiles may be found in the following forum posts:\nhttps://discuss.pixls.us/t/any-interest-in-a-film-negative-feature-in-rt/12569/177\nhttps://discuss.pixls.us/t/input-color-profile-to-use-for-negatives/20271/13\nNote: if you want to use the tone equalizer with negadoctor, you\u0026rsquo;ll need to move the tone equalizer module after negadoctor in the pixelpipe, since the tone equalizer is not designed to work with negatives.\n🔗module controls It is strongly recommended that you set the parameters following the order in which they are presented in the GUI. Start by setting the film stock, then work through each of the tabs (film properties, corrections, print properties) in order, working from top to bottom in each tab.\nWhen using ,pickers be careful to avoid including dust and scratches, which can skew the data taken from the sampled region.\nfilm stock The first step is to choose \u0026ldquo;color\u0026rdquo; or \u0026ldquo;black and white\u0026rdquo; in the film stock drop-down. If you select \u0026ldquo;black and white\u0026rdquo;, any sliders that are only used for color will be hidden from view. 🔗film properties This tab contains a number of basic settings. If, after adjusting these settings, your image is still not quite as you would like it, you can make further adjustments on the corrections tab. These are technical settings, and serve a similar purpose to the scene tab in the filmic rgb module, in that they adjust the black and white points and hence define the dynamic range of the negative.\ncolor of the film base Sample an area of the base film stock from your scan. This is the area just outside of the image (an unexposed part of the film). If you are working with black and white negatives, you can leave this slider at its default value (white). If working on color film, click the picker to the right of the color bar, which will create a bounding box covering about 98% of your image. Then, click and drag across an area of your negative which contains only unexposed film stock. This will automatically calculate values for the D min slider(s). It is likely at this point that your image will still look too dark, but you can correct this later. D min If the film stock is set to \u0026ldquo;black and white\u0026rdquo;, this slider indicates the minimum value corresponding to the unexposed film stock. If the film stock is set to \u0026ldquo;color\u0026rdquo;, this control will consist of 3 separate sliders, one for each of the red, green and blue channels. D max This slider represents the dynamic range of your film, and it effectively sets the film\u0026rsquo;s white point. Dragging this slider to the left will make the negative brighter. Dragging it to the right will make the negative darker. When adjusting this slider manually, it\u0026rsquo;s a good idea to closely watch your histogram to ensure that you don\u0026rsquo;t clip the highlights (where the histogram has been pushed over too far off the right hand side of the graph). If you click the picker icon (on the right) negadoctor will automatically calculate this value to ensure maximal use of the histogram without clipping. To use the picker, click and drag to draw a rectangle across only the exposed parts of the negative. Don\u0026rsquo;t include the unexposed film stock, as this will skew the result. scan exposure bias This slider allows you to set the black point. It is a technical adjustment that ensures a proper zeroing of the RGB values and a spreading of the histogram between [0, 1] values for robustness in the operations that follow. Dragging this to the left will make the negative brighter. Dragging to the right will make the negative darker. When adjusting this slider manually, it\u0026rsquo;s a good idea to closely watch your histogram to ensure that you don\u0026rsquo;t clip the shadows (where the histogram is pushed too far off the left hand side of the graph). If you click the picker negadoctor will automatically calculate any required offset. To use the picker, select a region in the darkest lowlights, or select the entire image without including any unexposed film stock. Double-check the histogram to ensure the left part of it doesn\u0026rsquo;t clip. 🔗corrections This tab contains sliders that allow you to make color cast corrections within both the shadow and highlight regions.\nThe settings on this tab should not be needed for most well-preserved negatives. It is mostly useful for old and poorly-preserved negatives with a decayed film base that introduces undesirable color casts.\nThe other case where these color cast corrections may be needed is if the white balance properties of the light used to scan the film negative are significantly different to the light source under which the original film camera took the shot. For example, if you illuminate the film with an LED light, but the original shot was taken under daylight, this may require some additional color cast corrections.\nshadows color cast These three sliders allow you to correct for color casts in the shadows by adjusting the red, green and blue channels individually. Use the picker to set the sliders automatically by selecting a neutral gray shadow region requiring correction. Because the shadows sliders can also affect color casts in the highlights, it is important to finish setting the shadows sliders before moving on to the highlights sliders. highlights white balance These three sliders allow you to correct the white balance in the highlights by adjusting the red, green and blue channels individually. Use the picker to set the sliders automatically by selecting a neutral gray region in the highlights that is not properly balanced. 🔗print properties This tab contains settings that mimic the tonal effect of the photochemical papers that would have been used to create the hard copy image if you were not developing the photo digitally. These are creative settings, and serve a similar overall purpose to the creative tone curve settings on the look tab of the filmic rgb module.\nThe print exposure, paper black and paper grade are analogous to the slope, offset and power controls in the color balance module (which in turn is based on the ASC CDL standard). These settings define a creative tone curve to enforce your contrast intent after the inversion, at the end of the module. The equation governing this slope/offset/power behaviour is:\nRGB_out = ( RGB_in × exposure + black ) ᵍʳᵃᵈᵉ\npaper black (density correction) For this slider, select the picker and click and drag to select a region that encompasses only the exposed part of the film negative. If you can see unexposed film stock around the edges of your image, ensure that these areas are excluded from the drawn rectangle when calculating the paper black setting. Paper black represents the density of the blackest silver-halide crystal available on the virtual paper. In the analog development process, this black density always results in non-zero luminance, but the digital pipeline usually expects black to be encoded with a zero RGB value. This slider setting lets you remap paper black to pipeline black via an offset. You can use the picker to select a region of the image that should be mapped to black in the final image. paper grade (gamma) This slider is your gamma (contrast) control, and it defaults to a value of 4. If all has gone well, this value (4) minus the value of D max (from the “film properties” tab) should normally leave you with a value between 2 and 3. paper gloss (specular highlights) This slider is essentially a highlights compression tool. As you drag this slider to the left, you will see in the histogram that the highlight values are being compressed (pushed to the left). Adjust this accordingly, so that your highlights are not clipped in the histogram. You can also use this to simulate a matte photo print with low-contrast highlights. print exposure adjustment This slider offers one final opportunity to correct any clipping of the highlights. If you have followed all the previous instructions carefully, you shouldn\u0026rsquo;t need to adjust this setting. Note that you can increase the print exposure while at the same time decreasing the paper gloss, which allows you to brighten the mid-tones without losing any highlights. You can use the picker to select the brightest highlights, or select the entire image without including any unexposed film stock. This will set the exposure so that the brightest part of the selected region is not clipped. Double-check the histogram to make sure that the right part of the histogram doesn\u0026rsquo;t clip. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/negadoctor/","tags":null,"title":"negadoctor"},{"categories":null,"content":"Rotate the image 90 degrees at a time or flip the image horizontally and/or vertically.\nThe module is enabled by default and the orientation (rotation) is automatically set based on the image\u0026rsquo;s Exif data.\nThe orientation can also be set using the actions on selection module in the lighttable view.\n🔗module controls transform Double click the label to reset to the default transformations rotate counter-clockwise Rotate the image 90 degrees counter-clockwise rotate clockwise Rotate the image 90 degrees clockwise flip horizontally Flip the image (mirror) horizontally flip vertically Flip the image (mirror) vertically show guides Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/orientation/","tags":"rotate orientation basic-module-group","title":"orientation"},{"categories":null,"content":"Manage the output profile for export and the rendering intent to be used when mapping between color spaces.\ndarktable comes with pre-defined profiles sRGB, Adobe RGB, XYZ and linear RGB. You can provide additional profiles by placing them in $DARKTABLE/share/darktable/color/out and $HOME/.config/darktable/color/out (where $DARKTABLE is the darktable installation directory and $HOME is your home directory). Note that these color/out directories are not created by the darktable install; if you need to use one, you must create it yourself.\nThe output color profile may also be defined within the export module.\n🔗module controls output intent The rendering intent for output/export. Rendering intent can only be selected when using LittleCMS2 to apply the output color profile (this can be changed in preferences \u0026gt; processing). If darktable\u0026rsquo;s internal rendering routines are used, this option is hidden. For more details see rendering intent. output profile The profile used to render colors for output/export. The profile data will be embedded into the output file (if supported by the file format) allowing other applications to correctly interpret its colors. As not all applications are aware of color profiles, the general recommendation is to stick to sRGB unless you know what you are doing and have a good reason to do otherwise. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/output-color-profile/","tags":null,"title":"output color profile"},{"categories":null,"content":"Masks allow you to limit the effect of a module so that it only applies to certain parts of the image.\nA mask can be regarded as a grayscale image where each pixel has a value between 0 and 1.0 (or between 0% and 100%). This value is the opacity and is used to determine how much a module affects each pixel.\nThe following sections explain how to construct masks in darktable.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/masks/overview/","tags":null,"title":"overview"},{"categories":null,"content":"Each processing module takes its input from the preceding module in the pixelpipe, performs its operation on the image data, and then hands the output to the next module in the pixelpipe.\nA module\u0026rsquo;s output data can optionally be reprocessed (combined) with its input data before being handed to the next module. This additional processing step is called blending \u0026ndash; input and output data is reprocessed using algorithms called blending operators or blend modes.\nEach blend mode is further controlled by the opacity parameter (having a value between 0% and 100%) which defines how much the input and output images contribute to the final result. Typically an opacity of 0% outputs an image which is identical to the input image (the module has no effect) whereas an opacity of 100% delivers the maximum effect of the module.\nThis opacity can be the same for every pixel (using the global opacity slider), in which case blending acts uniformly over the entire image. Alternatively the opacity values can vary depending on the properties or location of each pixel. This local modification of opacity is called a mask. Masks provide the user with fine control over which parts of an image are affected by a module and to what extent. The user may choose to activate a drawn mask, a parametric mask or a combination.\nBlending and masking functionality is controlled via a group of icons located at the bottom of each applicable module.\nThese icons enable the following masking and blending options, from left to right:\noff Module output is passed to the next module in the pixelpipe without additional reprocessing. No further controls are displayed. uniformly Input and output images are reprocessed uniformly with the chosen blend mode, where the amount of blending is controlled by a single opacity slider. Additional controls are displayed to allow the blend mode and opacity to be selected. The default is a blend mode of “normal” with an opacity of 100%. drawn mask Reprocessing takes place with the chosen blend mode and an opacity based on pixel location as defined by one or more drawn shapes. Additional controls are displayed to allow mask elements to be drawn. If no mask elements are drawn then all pixels have the same opacity, as defined by the opacity slider. parametric mask Reprocessing takes place with the chosen blend mode and an opacity based on the properties of individual pixels. Additional controls are displayed to allow the opacity to be adjusted on a per-pixel basis, determined by pixel values. drawn \u0026amp; parametric mask Reprocessing takes place with the chosen blend mode and an opacity based on a combination of a drawn and parametric mask. raster mask Reprocessing takes place with the chosen blend mode and an opacity based on a mask that was generated by an active module earlier in the pixelpipe. blending options Choose which color space to use when calculating the blending mask, and specify whether or not to allow a mask to be generated based on the module\u0026rsquo;s output channels (normally a parametric mask is generated based on the input channels coming into the module). The following options are available: reset to default blend colorspace: Use the default color space for the module to specify the parametric mask. Lab: Use the Lab color space (where available) to specify the parametric mask. RGB (display): Use the display-referred RGB/HSL color space to specify the parametric mask. RGB (scene): Use the scene-referred RGB/JzCzhz color space to specify the parametric mask. show output channels: Show the parametric mask output channel controls, so that the parametric mask can be defined in terms of the module\u0026rsquo;s output channels. Note: Not all of these blending options are available for every module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/overview/","tags":null,"title":"overview"},{"categories":null,"content":"Processing modules are organized and accessed via the right-hand panel in the darkroom:\nClick on the icons at the top of this panel to reveal, from left to right,\nquick access panel A customizable panel allowing quick access to commonly-used module controls. active modules A group containing the modules that are currently active in the pixelpipe. Right-click to show all modules that are present in the history stack within the active group, regardless of whether or not they are actually active. module groups One or more groups of processing modules. These groups are user-defined but some default groupings are provided as presets. presets menu A menu that allows you to access stored module layout presets and create your own (via the \u0026ldquo;manage presets..\u0026rdquo; option). You can also directly access the \u0026ldquo;manage presets\u0026rdquo; dialog by Ctrl+clicking on the presets menu. Click once on a module group icon (including the active group) to show only the modules in that group. Click a second time to show a list of all modules that are currently active or present in any group.\nYou can change which widgets appear in the quick access panel and which modules appear in the module groups, by right-clicking the appropriate icon.\n🔗search Below the module group icons is the search bar, which you can use to access any of the processing modules, regardless of whether they are currently in a group. This option allows you to search by module name, any user-defined instance name, as well as pre-defined module tags (for example, the color calibration rgb module can also be searched using the terms \u0026ldquo;hue\u0026rdquo;, \u0026ldquo;contrast\u0026rdquo; and \u0026ldquo;vibrance\u0026rdquo;).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/organization/overview/","tags":null,"title":"overview"},{"categories":null,"content":"The darkroom view is where you develop your images. The center panel contains the image currently being edited.\n🔗zoom Middle-click on the center panel cycle between \u0026ldquo;fit to screen\u0026rdquo;, 1:1 and 2:1 zoom.\nAlternatively you can zoom between 1:1 and \u0026ldquo;fit to screen\u0026rdquo; by scrolling with your mouse. Scroll while holding the Ctrl key to extend the zoom range to between 2:1 and 1:10.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/overview/","tags":null,"title":"overview"},{"categories":null,"content":"The lighttable view allows you to view and manage your image collection.\nThe centre view contains thumbnails of your images \u0026ndash; how they are displayed depends on which mode you are working in.\nWhile the mouse is over an image thumbnail or images are selected, there are a number of actions you can perform with keyboard shortcuts:\nF1, F2, F3, F4, F5 adds or removes a color label (red, yellow, green, blue, purple, respectively). A color label will be added if any selected image does not currently have the label; otherwise the label will be removed\n0, 1, 2, 3, 4, 5 sets the star rating\nR rejects the image(s)\nCtrl+D duplicates the image(s)\nCtrl+C copies the full history stack\nCtrl+V pastes all of the copied history stack\nCtrl+Shift+C selectively copies the history stack\nCtrl+Shift+V selectively pastes from the copied history stack\nD opens the image in the darkroom view for developing\nW fully zooms into the current image while the key is pressed\nCtrl+W fully zooms into the current image and show areas in focus\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/overview/","tags":null,"title":"overview"},{"categories":null,"content":"Lua scripts can be used to define actions for darktable to perform when an event is triggered. One example might be calling an external application during file export in order to apply additional processing steps outside of darktable.\nLua is an independent project founded in 1993, providing a powerful, fast, lightweight, embeddable scripting language. Lua is widely used by many open source applications, in commercial programs, and for games programming.\ndarktable uses Lua version 5.4. Describing the principles and syntax of Lua is beyond the scope of this usermanual. For a detailed introduction see the Lua reference manual.\nThe following sections will provide you with a brief introduction to how Lua scripts can be used within darktable.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/overview/","tags":null,"title":"overview"},{"categories":null,"content":"The map view allows you to see where your geo-tagged images were taken, and to add location information to non-geo-tagged images.\nThe map view shows a world map with the images in the current collection pinned to their geo-tagged location (if available). This requires that images are tagged with location information. Some newer cameras, including smartphones, are already equipped with GPS receivers. Other cameras may need additional GPS hardware to do this.\nEven if your camera doesn\u0026rsquo;t support this feature, there is an alternative method \u0026ndash; darktable can match the Exif date/time in your image(s) to a separate GPX data tracking file created by a GPS tracker, that has recorded your movements. GPS trackers can be purchased as standalone handheld devices or you can install a GPS tracker app on your smartphone. Location tagging with GPS tracking data can be done using the geotagging module, in the lighttable and map views.\n🔗center map view In the center of the map view you will see a world map.\nMap data is taken from open map sources on the internet. As such, new map data is only available if you are connected to the internet \u0026ndash; darktable keeps a disk cache of previously loaded map data.\nYou can navigate within the map using your mouse. Left-click and drag to move the map. Use the scroll-wheel to zoom in and out.\nOn-screen controls and displays are available to help you find your way. A navigation area is located on top left of the map \u0026ndash; use this as an alternative to mouse-dragging and scrolling. The scale of the map is displayed at the bottom-left. At the bottom-right you can see the geographical coordinates for the center of the map.\nImages that already have geo-location attributes in their metadata are displayed as small icons on the map. Images close to each other are grouped and a count of grouped images is displayed on the bottom-left corner.\nIn order to assign geo coordinates to an image, activate the filmstrip on the lower panel (press Ctrl+F). You can assign a geo location to an image by dragging the image icon from the film-strip and positioning it on the map \u0026ndash; darktable will record the new location (latitude and longitude ) as part of the image metadata. This data will be included in exported images.\nIn order to remove location data from an image simply drag it from the map and drop it onto the filmstrip.\nImages close to each other are grouped under a single image group. You can use the map settings module to control the grouping as needed. The number displayed on the bottom left of the thumbnail is the number of images inside the group. A white number means that all images in the group are at exactly the same location, whereas a yellow number means they are not. Use the mouse scroll wheel while hovering over a group of images to scroll through the thumbnails of the images in that group.\nNormally, images in the center map view have black borders. If an image is selected in the filmstrip, then the corresponding image on the map will be highlighted with a white border.\nClick+drag to adjust the location of an image. Shift+click to move a complete group of images.\nThe left and right panels provide additional controls (see map view layout).\n🔗undo/redo All image movements in the map view are recorded by darktable. It is possible to undo or redo such changes to recover a previous state. Note that this undo/redo facility is unlimited while moving images but it is reset each time you leave the map view.\nPress Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/map/overview/","tags":null,"title":"overview"},{"categories":null,"content":"The modules in this reference section are broken down into two distinct types:\nprocessing modules Processing modules are used exclusively in the darkroom view. Each module performs a processing operation on the image before passing its output to the next module for further processing. Together this sequence of processing steps forms the pixelpipe. utility modules Utility modules may be used in any darktable view. They are not directly involved in processing the pixels of an image but perform other ancillary functions (managing image metadata and tags, editing history, modifying pixel pipeline order, snapshots and duplicates, image export etc.). The two types of modules have a few aspects in common, described below.\n🔗module header Each module has a header at the top, normally consisting of the following elements:\nmodule name Click on the name to expand or collapse the rest of the module and show/hide its controls. reset parameters button This normally appears to the right of the module name and is used to reset the state of the module back to its original condition. presets menu This normally appears at the far right of the module header. The presets menu is predominantly used in processing modules, but many of the utility modules allow presets to be defined as well. You can also access this menu by right-clicking anywhere on the module header. Processing modules contain additional elements in their module header, as described in the processing module header section.\n🔗module resizing 🔗utility modules Some utility modules contain lists of information that can grow as more entries are added. To help manage screen real-estate, it is possible to increase or decrease the maximum number of entries that can be displayed before a scroll bar is added. To alter the maximum number of entries, place the mouse over an entry in the list, and hold Shift+Alt while scrolling your mouse wheel. If the list currently contains more entries than this maximum, a scrollbar will appear so that you can access the hidden entries. Alternatively you can click+drag the bottom of the scrollable area with your mouse.\nNote: It is not possible to extend these areas beyond the number of entries currently shown. If you attempt to do so using Shift+Alt+scroll, the maximum number of entries will increase, and a toast message will appear informing you of the new maximum. However, the module itself will not be resized unless its content exceeds this maximum.\n🔗processing modules Some processing modules contain drawn graphical elements that can take up too much or too little screen space depending on the width of your side panels. These drawing areas usually default to a 16:9 aspect ratio and can be similarly resized by hovering over them and holding Ctrl while scrolling.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/overview/","tags":null,"title":"overview"},{"categories":null,"content":"darktable comes with a number of user-configurable preferences. These can be adjusted in the preferences dialog, which can be reached by clicking the gear icon on the right of the top panel. Preferences are separated into tabs, each of which is described in more detail in the following sections.\nWhen opened from within the lighttable or darkroom views, the appropriate tab will be loaded by default to allow you to modify that view\u0026rsquo;s settings.\nAny altered settings (i.e. those that differ from their default state) are highlighted with a bullet beside them. If you change a setting that needs a restart to take effect, a message will appear as a reminder after you exit the preferences dialog.\nDouble click on a setting\u0026rsquo;s label to reset to its default value.\nThe preferences dialog can be closed by clicking on the close button in your window manager or pressing the Escape key.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/overview/","tags":null,"title":"overview"},{"categories":null,"content":"This view allows you to print your images. Because printing is not easy, there are many technical aspects to be taken into account.\nAfter selecting an image in the lighttable view you can enter the print settings module to adjust printer settings and initiate printing.\nThis module supports the printer\u0026rsquo;s ICC profile, which is somewhat mandatory if you want to obtain a high quality print close to the image displayed on the screen.\nIt is important to note that ICC profiles provided by the paper and/or printer manufacturers cannot be used on GNU/Linux as they are printer-driver dependent. The darktable print module uses CUPS and there are no ready-to-use ICC profiles available for this driver.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/print/overview/","tags":null,"title":"overview"},{"categories":null,"content":"The slideshow view allows you to watch a slideshow of your current collection with the associated filtering rules and sort order applied.\nTo learn more about how to define the collection and filtering rules, see the section on collections. Select the sort criteria and sort order of the images in the top panel.\nThe next section provides more details on the usage of the slideshow view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/slideshow/overview/","tags":null,"title":"overview"},{"categories":null,"content":"darktable employs a fully color managed workflow:\nInput color specifications are taken from embedded or user-supplied ICC profiles or (in the case of raw files) from a library of camera-specific color matrices.\ndarktable automatically reads the display profile of your monitor (if properly configured) for accurate on-screen color rendition. Multiple-screen setups are fully supported as long as a system service like colord is in place and properly configured to inform darktable of the correct monitor profile.\nOutput files can be encoded in one of darktable\u0026rsquo;s built-in profiles, including sRGB and Adobe RGB, or into a color space supplied by the user as an ICC profile.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/overview/","tags":null,"title":"overview"},{"categories":null,"content":"darktable-chart is a tool for extracting luminance and color values from images of color reference cards such as IT8.7/1 charts. Its main purpose is to compare a source image (typically a largely unprocessed raw image) to a target image (typically a JPEG image created in-camera) and produce a darktable style that is able to use the luminance and color values of the source image to produce the target image. This style employs the tone curve module, the input color profile module, and the color look up table module for that purpose.\nSome cameras offer various film simulation modes of your choice. With the help of darktable-chart and the underlying modules you can create styles that replicate these film simulations from within darktable.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/darktable-chart/overview/","tags":null,"title":"overview"},{"categories":null,"content":"The tethering view allows you to capture images directly into darktable from a connected camera.\nTo use the tethering feature you first need to connect your camera to your PC using a USB cable. Your computer might ask to mount or view the connected camera. Do not mount or view the camera. If your camera is mounted or viewed automatically, you will need to “unmount/eject” the camera before darktable can access it. This unlocks the camera so that darktable can take control of it \u0026ndash; darktable will then re-lock the camera so that it cannot be used by other applications.\nAfter the USB cable is connected, go to the import module in the lighttable view. If your camera is available for use, a new section should appear in the import module containing the name of your camera and a \u0026ldquo;mount camera\u0026rdquo; button. Click this button to connect your camera and three additional buttons will appear: “copy \u0026amp; import from camera”, “tethered shoot” and \u0026ldquo;unmount camera\u0026rdquo;. Click “tethered shoot” to enter the tethering view. When you are finished, press the \u0026ldquo;unmount camera\u0026rdquo; button before physically disconnecting it.\ndarktable uses gphoto2 to interface with your camera. If you have problems finding the connected camera as described above, check the troubleshooting section in this chapter to verify that your camera has tethering support.\nIn the center view, images are shown while you capture them. You can capture an image by either using darktable\u0026rsquo;s user interface or by manually triggering a capture with your camera. If you are using Live View the image will be shown in darktable\u0026rsquo;s center view.\nWhen entering tethering view, a film roll will be created using the same structure as defined for camera import (see preferences \u0026gt; import \u0026gt; session options). The job code will be predefined as “capture”.\nIf you want to group your captures into different film rolls, you should use the session module in the right-hand panel to set a different job code. When entering a new name and pressing Enter, a new film roll will be created and newly-captured images will be added into this new film roll.\ndarktable provides some useful tools to set up an image capture in the user interface. You can set up timelapse captures, brackets for HDR and even sequential captures of bracketed images. For more information read the documentation on the camera settings module and the examples later in this chapter.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/tethering/overview/","tags":null,"title":"overview"},{"categories":null,"content":"Define camera-specific black and white points.\nThis module is activated automatically for all raw images. Default settings are applied for all supported cameras. Changes to the defaults are not normally required.\n🔗module controls black level 0-3 The camera-specific black level of the four pixels in the RGGB Bayer pattern. Pixels with values lower than this level are not considered to contain valid data. white point The camera-specific white level. All pixels with values above this are likely to be clipped and will be handled accordingly in the highlight reconstruction module. flat field correction Use flat field correction to compensate for lens shading. This field only appears for applicable Raw files and will automatically use any GainMap embedded in the Raw. You can choose to disable this correction if desired. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/raw-black-white-point/","tags":null,"title":"raw black/white point"},{"categories":null,"content":"Correct chromatic aberrations of raw images.\nThis module currently only works for raw images recorded with a Bayer sensor (the sensor used in the majority of cameras) \u0026ndash; for other types of image, you should use the chromatic aberrations module instead.\nThe module will also not apply any corrections to any photos that have been identified as monochrome (see developing monochrome images for more information).\nThis module expects good white balance data (provided by the white balance module) for best results. In most cases the default settings are sufficient.\nNote that if this module is enabled, then TCA correction in the lens correction module should be disabled, as the two modules will conflict with one another.\n🔗module controls iterations The number of iterations. For most images, \u0026ldquo;twice\u0026rdquo; is sufficient, and is the default value. Occasionally, increasing this control can give better results. avoid colorshift If the module causes tinting \u0026ndash; often pink or greenish \u0026ndash; tick this box to apply a correction. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/raw-chromatic-aberrations/","tags":null,"title":"raw chromatic aberrations"},{"categories":null,"content":"Perform denoising on raw image data before it is demosaiced.\nThis module has been ported from dcraw.\n🔗module controls noise threshold The threshold for noise detection. Higher values lead to stronger noise removal and greater loss of image detail. coarse/fine curves The noise of an image is usually a combination of fine-grained and coarse-grained noise. These curves allow the image to be denoised more or less depending on the coarseness of the visible noise. The left of the curve will act on very coarse grain noise, while the right of the curve will act on very fine grain noise. Raising the curve will result in more smoothing, while lowering it will result in less smoothing. As an example, you can preserve very fine-grained noise by pulling down the rightmost point of the curve to the minimum value.\nIf you are tackling chroma noise with a blend mode, you can raise the rightmost part of the curve quite high, as colors do not change a lot on fine grain scales. This will help especially if you see some isolated pixel left un-denoised.\nThe best way to use the R, G, and B curves is to examine each of the channels in turn using the color calibration module in gray mode, denoise that channel, and then repeat for the other channels. This way, you can take into account the fact that some channels may be noisier than others. Beware that guessing which channel is noisy without actually seeing the channels individually is not straightforward and can be counterintuitive. A pixel which is completely red may not be caused by noise on the R channel, but actually by noise on G and B channels.\nSee the wavelet section for more details.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/raw-denoise/","tags":null,"title":"raw denoise"},{"categories":null,"content":"Remove unwanted elements from your image by cloning, healing, blurring and filling using drawn shapes.\nThis module extends the capabilities of the deprecated spot removal module (equivalent to this module\u0026rsquo;s \u0026ldquo;clone\u0026rdquo; tool) by including a \u0026ldquo;heal\u0026rdquo; tool (based on the heal tool from GIMP), as well as \u0026ldquo;fill\u0026rdquo; and \u0026ldquo;blur\u0026rdquo; modes. It can also take advantage of wavelet decomposition, allowing the image to be separated into layers of varying detail (from coarse to fine) which can be selectively retouched before being recombined to produce the output image.\nAs you might want to use source data from any part of the image you will be shown the uncropped image (possibly with the cropping rectangle overlaid as a guide) while the module is active.\n🔗clone and heal Cloning allows a part of the image (the target) to be hidden by replacing it with an area copied from elsewhere in the image (the source). For example, you may wish to remove a small cloud from a blue sky:\nThe simplest way to do this is with the cloning tool . The following example uses a circular shape to clone out the cloud using the circle of blue sky beside it:\nIn many cases, the edges of the source shape won\u0026rsquo;t precisely match the surroundings of the target, leading to unnatural looking results. In this example, the sample of sky we chose as the source was slightly darker than the target, leaving a faint outline of the circular shape used in the cloning process:\nIn such cases, the heal tool is more appropriate. With this tool, the color and luma of the sample is blended to fit better with the surroundings. In this example, using heal instead of clone produces a much more pleasing result:\n🔗source and target shapes Once you have chosen heal or clone mode, you must choose the shape you wish to use (circle, ellipse, path or brush \u0026ndash; see the drawn masks section for details). The source and target patches will both use the same shape.\nWhen you hover over the image with your mouse, a plus symbol (+) will appear to indicate where the source shape will be placed by default. Your normal mouse cursor will indicate the position of the target shape:\nIt is recommended that you choose the position of the source shape first, followed by the position of the target, as follows:\nShift+click to set the position of the source shape in \u0026ldquo;relative mode\u0026rdquo;. The position of the \u0026ldquo;plus\u0026rdquo; (+) symbol will move to the clicked location and will remain in a fixed position relative to your cursor until you click on the image to begin placing your target shape. If you place subsequent shapes without first changing the target location, the source shape will be placed at the same offset from the target shape as was used for the first stroke.\nCtrl+Shift+click to change the position of the source shape in \u0026ldquo;absolute\u0026rdquo; mode. As above, the position of the \u0026ldquo;plus\u0026rdquo; (+) symbol will move to the clicked location, but will remain in the same absolute position even if you move your mouse. You can then click on the image to begin placing the target shape. If you place subsequent shapes without first changing the target location, exactly the same source position will be used, fixed in the absolute coordinate system of the image.\nOnce you have placed your source and target shapes on the image, they can be adjusted manually with your mouse.\nNote: For circle and ellipse shapes only, you can place both the source and target shapes with a single click-and-drag motion: Click on the desired target location and then drag, releasing your mouse button when you reach the desired source location. This operation does not affect the placement of subsequent shapes.\n🔗fill and blur The clone and heal tools both require the use of another part of the image to \u0026ldquo;fill in\u0026rdquo; the region being hidden. Sometimes there is no suitable sample in the image to use for this purpose. In such cases, the retouch module offers two further options:\nfill tool Fill the drawn region with a selected color. blur tool Apply a blur to the drawn region, smoothing out any details. These two options are most useful when used together with wavelet decomposition, where they can be used to smooth over features within a selected detail layer.\n🔗wavelet decomposition Wavelets allow an image to be decomposed into a number of layers each containing varying levels of detail, so that you can work on each detail layer independently and then recombine them at the end. This is particularly useful in portrait photography, where you can deal with skin blotches and blemishes on a coarse layer of detail, leaving the finer skin texture untouched. The wavelets section provides more information on the decomposition process.\nThis method can be used with the healing tool, for example, to paint over a spot that appears in one of the coarse detail layers, while leaving the hairs in the fine detail layers intact:\nIt can also be used with the blur tool to even out coarse blotches in the skin, again without impacting the finer details (see the wavelets section for details on this technique).\n🔗module controls 🔗retouch tools The retouch tools section consists of two items:\nshapes The number after the shapes label indicates how many shapes have been placed on the image, either directly or within a wavelet layer. Click on one of the shape icons to draw a new shape on the image (see drawn masks for details).\nCtrl+click on a shape icon to draw multiple shapes continuously (right-click to cancel).\nClick the show and edit shapes button to show and edit any existing shapes for the currently-selected wavelet scale.\nalgorithms Choose a retouching algorithm (clone, heal, fill or blur). Ctrl+click to change the algorithm used for the currently-selected shape. Shift+click to set the default algorithm (used for new images or when you reset module parameters). 🔗wavelet decompose The wavelet decompose section centres around a bar graph that shows how the image has been decomposed into detail (scale) layers. The key features of the bar graph are:\nThe black square on the left represents the entire image before decomposition. The gray squares show the various wavelet detail layers, with fine details to the left, and coarse details to the right. The white square on the far right represents the residual image (the remainder of the image after the detail layers have been extracted). A light gray dot in a square indicates the currently-selected layer. Click on another square to select a different layer. The light gray bar running along the top indicates which levels of detail are visible at the current zoom level. Zoom in to see finer details. The triangle at the bottom shows how many layers the image has been decomposed into. Drag the triangle to the right to create more layers. Drag it to the left to decrease the number of layers. By default no wavelet decomposition is performed. The triangle at the top shows the current value of the \u0026ldquo;merge from\u0026rdquo; parameter (see below). The orange lines under the squares indicate which layers have retouch edits applied. The remaining items in this section are:\nscales Shows how many detail layers the image has been decomposed into. Zero indicates that no wavelet decomposition has been performed. current Shows which layer is currently selected (also marked with the light gray dot on the bar graph). merge from This setting allows a single edit to be applied to multiple consecutive scales within a group starting from the coarsest scale (excluding the residual image) down to the scale selected. For example, if \u0026ldquo;merge from\u0026rdquo; is set to 3 and the maximum scale is 5 then all edits that are added to scale 5 will be applied to scales 3, 4 and 5. Edits added to scale 4 will be applied to scales 3 and 4, and edits added to scale 3 will be applied to scale 3 only. If you set merge from to 0, then merging is disabled, and all edits apply only to the scale that they are defined in. Setting merge from to the highest scale available (in this example, 5) also disables merging. merge_from v 0 1 2 3 4 5 scale \u0026lt;-------o scale 5 edits \u0026lt;---o scale 4 edits o scale 3 edits o scale 2 edits o scale 1 edits display wavelet scale Display the currently-selected wavelet layer on the center image. Selecting this option brings up an additional control \u0026ndash; preview single scale. preview single scale An additional control that allows the black, white and gray points of the wavelet scale preview to be adjusted to make it easier to see. Click the to set these values automatically. This does not affect the module\u0026rsquo;s operation \u0026ndash; only the wavelet scale preview. cut Cut all shapes from the currently-selected layer and place them into the clipboard. paste Move the shapes on the clipboard to the currently-selected layer. temporarily switch off shapes Toggle all shapes (whether on the current layer or not) on or off, temporarily removing the module\u0026rsquo;s effect. display masks Show the target shapes associated with the currently-selected layer with a yellow overlay. 🔗shapes This section allows you to modify settings related to the currently-selected shape:\nshape selected Indicates which shape is currently selected, and what type of shape it is. fill mode If the fill algorithm has been chosen for the currently-selected shape, choose whether to \u0026ldquo;erase\u0026rdquo; or fill the selected shape with a chosen \u0026ldquo;color\u0026rdquo;. fill color If a fill mode of \u0026ldquo;color\u0026rdquo; has been chosen, select the color to fill the shape with. You can click to select or enter a custom rgb value or use the picker to take a sample from the image. brightness If the fill algorithm has been chosen for the currently-selected shape, fine-tune the color\u0026rsquo;s brightness. This slider also works in \u0026ldquo;erase\u0026rdquo; mode. blur type If the blur algorithm has been chosen for the currently-selected shape, choose whether to apply a \u0026ldquo;gaussian\u0026rdquo; or \u0026ldquo;bilateral\u0026rdquo; blur. blur radius If the blur algorithm has been chosen for the currently-selected shape, choose the radius of the blur. mask opacity Alter the opacity of the mask associated with the currently-selected shape. An opacity of 1.0 indicates that the shape is completely opaque and the module\u0026rsquo;s effect is fully applied, whereas a value less than 1.0 indicates that the effect applied by the shape is blended with the underlying image to the degree indicated by the slider. 🔗panning and zooming the image While creating or editing a shape, mouse actions are applied to the current shape. If you need to move or zoom the portion of the image shown in the center view, hold down the \u0026lsquo;a\u0026rsquo; key while dragging the mouse or using the scroll wheel. While the key is held down, the mouse actions will apply to the entire image rather than the current shape. Holding down the key will also temporarily suppress generating new shapes in continuous-creation mode.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/retouch/","tags":null,"title":"retouch"},{"categories":null,"content":"A classic digital photography tool to alter an image\u0026rsquo;s tones using curves.\nThis module is very similar to the tone curve module but works in RGB color space.\nActivate the picker on the left to show the picked values in the graph (Ctrl+click or right-click to use the picker in area mode). Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the widget.\nA second picker to the right can be used to automtaically create new nodes based on the sampled area. Ctrl+click+drag to alter the created nodes to have a positive curve for the selected area; Shift+click+drag to create a negative curve.\n🔗module controls Please refer to the curves section for more details about how to modify curves including the interpolation method and preserve colors controls.\nmode RGB is a linear color space designed to capture and display images in additive synthesis. It is related to the capture and display media and does not isolate color and lightness information in the same way that Lab and XYZ color spaces do. This module works in ProPhoto RGB. Adding contrast in RGB space is known to desaturate highlights and boost saturation in the shadows, but this has been proven to be the most reliable way to edit contrast, and is the standard method in most software Depending on the desired intent you can apply the RGB curve in two different modes\nRGB, linked channels: Apply the L-channel curve to all three channels in the RGB color space. RGB, independent channels: R, G and B curves can be adjusted independently. compensate middle gray Select this to change the histogram display in the module. This option does not alter the processing but may assist when editing the curve. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/rgb-curve/","tags":null,"title":"rgb curve"},{"categories":null,"content":"Adjust black, white and mid-gray points in RGB color space. This module is silmilar to the levels module, which works in Lab color space.\nThe rgb levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in lightness (in \u0026ldquo;RGB, linked channels\u0026rdquo; mode) or independently for each of the R, G and B channels (in \u0026ldquo;RGB, independent channels\u0026rdquo; mode).\nMoving the black and white bars to match the left and right borders of the histogram will make the output image span the full available tonal range. This will increase the image\u0026rsquo;s contrast.\nMoving the middle bar will modify the mid-tones. Move it to the left to make the image look brighter and move it to the right to make it darker. This is often referred to as changing the image\u0026rsquo;s gamma.\nThree pickers are available for sampling the black, white and gray points from the image.\nNote: Under certain conditions, especially with highly saturated blue light sources, the levels module may produce black pixel artifacts. See the \u0026ldquo;gamut clipping\u0026rdquo; option of the input color profile module for information about how to mitigate this issue.\n🔗module controls mode The mode of operation. \u0026ldquo;RGB, linked channels\u0026rdquo; (default) provides a single levels tool which updates all channels, taking into account the selected color preservation method (see \u0026ldquo;preserve colors\u0026rdquo; below). \u0026ldquo;RGB, independent channels\u0026rdquo; provides separate levels controls for each of the R, G and B channels. auto Auto-adjust the black and white point and put the gray point exactly in the mean between them. Use the picker to auto-adjust based on a selected region of the image. preserve colors Choose a color preservation method when using \u0026ldquo;RGB, linked channels\u0026rdquo; mode (default \u0026ldquo;luminance\u0026rdquo;). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/rgb-levels/","tags":null,"title":"rgb levels"},{"categories":null,"content":"Adjust the hue and purity of the RGB primary colors (i.e. which red, green and blue they represent), while leaving uncolored (gray) pixels unchanged. In addition to preserving gray pixels, the opponency relationships between the colors are also preserved under this adjustment: If you increase the purity of the blue primary, the opponent yellow\u0026rsquo;s intensity increases to balance things out; If you twist the blue hue toward cyan, the opponent yellow is twisted toward orange.\nThis module is essentially a channel mixer (as in the color calibration module) but with a different interface. Even though the sliders are named \u0026ldquo;red\u0026rdquo;, \u0026ldquo;green\u0026rdquo; and \u0026ldquo;blue\u0026rdquo;, all adjustments are global and affect the overall colorimetry of the image, just like a channel mixer does.\nWhen applied before the filmic rgb or sigmoid tone mapping modules rgb primaries can be used to make small adjustments to colorimetry. When applied after the tone mapping modules it may be used to apply creative edits such as tinting.\n🔗module controls red hue Shift red towards yellow (positive values) or magenta (negative values) red purity The purity of the red primary green hue Shift green towards cyan (positive values) or yellow (negative values) green purity The purity of the green primary blue hue Shift blue towards magenta (positive values) or cyan (negative values) blue purity The purity of the blue primary tint hue When applied after tone mapping, this control allows the gray (achromatic) parts of the image to be tinted. When applied before tone mapping, it acts like a white balance control. tint purity The purity of the tint that is applied to the image ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/rgb-primaries/","tags":null,"title":"rgb primaries"},{"categories":null,"content":"Automatically correct for converging lines, a form of perspective distortion. The underlying mechanism is inspired by Markus Hebel\u0026rsquo;s ShiftN program. This module also allows for the rotation of the image to be adjusted.\nPerspective distortions are a natural effect when projecting a three dimensional scene onto a two dimensional plane and cause objects close to the viewer to appear larger than objects further away. Converging lines are a special case of perspective distortions frequently seen in architectural photographs \u0026ndash; parallel lines, when photographed at an angle, are transformed into converging lines that meet at some vantage point within or outside of the image frame.\nThis module is able to correct converging lines by warping the image in such a way that the lines in question become parallel to the image frame. Corrections can be applied in a vertical and horizontal direction, either separately or in combination. In order to perform automatic correction the module is able to analyze the image for suitable structural features consisting of line segments. You can also set the line structures manually by drawing a \u0026ldquo;perspective rectangle\u0026rdquo; or drawing multiple horizontal and vertical lines onto the image. Based on these (automatic or manually-drawn) line segments a fitting procedure is initiated, which determines the best values for the module\u0026rsquo;s parameters.\nAs the most common use case for this module is for rotation, the perspective correction controls are hidden by default. Click the \u0026ldquo;perspective\u0026rdquo; header to expand the controls.\nWhile the module is active (and none of the structure buttons are selected) you can right-click and drag anywhere on the image to define a horizontal or vertical line. This will cause the rotation parameter to be automatically adjusted to make the drawn line horizontal/vertical with respect to the image frame.\nNote: This functionality (right-click and drag to set horizontal/vertical) is also available when the module is inactive, as long as no other function (e.g. drawn mask creation) claims the right-hand mouse button.\n🔗perspective correction workflow 🔗structure The first step is to obtain details about the horizontal and/or vertical structures in the image. Three alternative methods are provided to do this:\n🔗manually draw structure lines Click on the icon to enable line drawing mode and then click-and-drag on the image to draw lines that you wish to become horizontal or vertical. The module will automatically detect whether the lines are horizontal or vertical and color them green or blue, respectively. Draw as many lines as you wish (the more lines, the better the fit mechanism will work) and then click on one of the \u0026ldquo;fit\u0026rdquo; icons to complete the process. You can re-enter this mode to edit your drawn lines at any time. Edit a line by clicking and dragging on the line or the end nodes, and right-click a line to delete it. Once you are happy with your changes, re-select a \u0026ldquo;fit\u0026rdquo; icon to complete the process.\n🔗manually define a perspective rectangle Click on the icon to enable perspective rectangle drawing mode. This will draw a rectangle on the screen and you can grab and move the corners of the rectangle so that the left and right sides fall on lines you wish to make vertical, and the top and bottom fall on lines you wish to make horizontal. Once you are happy with your rectangle, click one of the \u0026ldquo;fit\u0026rdquo; icons to complete the process. You can re-enter this mode to edit your drawn rectangle at any time. Once you are happy with your changes, re-select a \u0026ldquo;fit\u0026rdquo; icon to complete the process.\nThis method is similar to how \u0026ldquo;keystone\u0026rdquo; correction works in the crop and rotate module.\n🔗automatically detect structure Click the icon to analyze the image for structural elements \u0026ndash; darktable will automatically detect and evaluate line elements. Shift+click to apply a contrast enhancement step before performing further analysis. Ctrl+click to apply an edge enhancement step before performing further analysis. Both variations can be used alone or in combination if the default analysis is not able to detect a sufficient number of lines.\nOnly lines that form a set of vertical or horizontal converging lines are used for subsequent processing steps. Line segments are displayed as overlays on the image canvas, with the type of line identified by color as follows:\ngreen Vertical converging lines red Vertical lines that do not converge blue Horizontal converging lines yellow Horizontal lines that do not converge gray Other lines that are not of interest to this module Lines marked in red or yellow are regarded as outliers and are not taken into account during the automatic fitting step. This outlier elimination involves a statistical process using random sampling which means that each time you press the \u0026ldquo;get structure\u0026rdquo; button the color pattern of the lines will look slightly different.\nYou can manually change the status of line segments: Left-Click on a line to select it (turn the color to green or blue) and Right-click to deselect it (turn the color to red or yellow). If you keep the mouse button pressed, you can use a sweeping action to select/deselect multiple lines in a row. The size of the select/deselect brush can be changed with the mouse wheel. Hold down the Shift key and keep the left or right mouse button pressed while dragging to select or deselect all lines in the chosen rectangular area.\nOnce you are happy with the detected lines, select a \u0026ldquo;fit\u0026rdquo; icon to complete the process.\n🔗fit Once you are happy with the identified horizontal and vertical lines, using one of the methods above, click on one of the \u0026ldquo;fit\u0026rdquo; icons to automatically set the module\u0026rsquo;s parameters based on the defined structure. The image and the overlaid lines are then displayed with perspective corrections applied.\nYou may choose to automatically apply just the vertical corrections , just the horizontal corrections , or both together . Ctrl+click on any of the icons to apply a rotation without the lens shift. Shift+click on any of the icons to apply the lens shift without any rotation.\n🔗rotate Once you are happy with the applied perspective corrections, you may wish to perform a final rotation correction either by adjusting the rotation parameter or right-clicking and dragging the image to define a horizontal/vertical line.\n🔗module controls rotation Control the rotation of the image around its center to correct for a skewed horizon. To rotate by more than the default soft limit of ten degrees, right click and enter the desired value up to 180 degrees (see module controls). automatic cropping When activated, this feature crops the image to remove any black areas at the edges caused by the distortion correction. You can either crop to the \u0026ldquo;largest area\u0026rdquo;, or to the largest rectangle that maintains the original aspect ratio (\u0026ldquo;original format\u0026rdquo;). In the latter case you can manually adjust the automatic cropping result by clicking in the clip region and moving it around. The size of the region is modified automatically to exclude any black areas. lens shift (vertical) Correct converging vertical lines (i.e. to make the green lines parallel). In some cases you can obtain a more natural looking image if you correct vertical distortions to an 80 ~ 90% level rather than to the maximum extent. To do this, reduce the correction slider after having performed the automatic correction. lens shift (horizontal) Correct converging horizontal lines (i.e. to make the blue lines parallel). shear Shear the image along one of its diagonals. This is required when correcting vertical and horizontal perspective distortions simultaneously. lens model This parameter controls the lens focal length, camera crop factor and aspect ratio that used by the correction algorithm. If set to \u0026ldquo;generic\u0026rdquo; a lens focal length of 28mm on a 35mm full-frame camera is assumed. If set to “specific”, the focal length and crop factor can be set manually using the sliders provided. focal length If the lens model is set to \u0026ldquo;specific\u0026rdquo;, set the lens focal length. The default value is taken from the image\u0026rsquo;s Exif data, and can be overridden by adjusting the slider manually. crop factor If the lens model is set to \u0026ldquo;specific\u0026rdquo;, set the camera crop factor. You will normally need to set this value manually. aspect adjust If the lens model is set to \u0026ldquo;specific\u0026rdquo;, this parameter allows for a free manual adjustment of the image\u0026rsquo;s aspect ratio. This is useful for \u0026ldquo;unsqueezing\u0026rdquo; images taken with an anamorphic lens (which changes the ratio of image height to width). structure Define horizontal and vertical lines in the image using a manual or automatic method (see workflow section for details). fit Set the distortion correction sliders automatically based on the identified structure (see workflow section for details). show guides Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details. 🔗examples Here is an image with a skewed horizon and converging lines caused by directing the camera upwards:\nHere is the image after having corrected for vertical and horizontal perspective distortions using automatic structure detection. Note the framing adjustment made by the automatic cropping feature and the still-visible overlay of structural lines:\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/rotate-perspective/","tags":null,"title":"rotate and perspective"},{"categories":null,"content":"The sensors of some cameras (such as the Fujifilm FinePix S2Pro, F700, and E550) have a diagonally oriented Bayer pattern instead of the usual orthogonal layout.\nWithout correction this would lead to a tilted image with black corners. This module applies the required rotation.\ndarktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled.\nThe module has no controls.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/rotate-pixels/","tags":null,"title":"rotate pixels"},{"categories":null,"content":"Some cameras (such as the Nikon D1X) have rectangular instead of the usual square sensor cells. Without correction this would lead to distorted images. This module applies the required scaling.\ndarktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled.\nThe module has no controls.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/scale-pixels/","tags":null,"title":"scale pixels"},{"categories":null,"content":"Modify the tonal range of the shadows and highlights of an image by enhancing local contrast.\nNote: This module performs blurs in Lab color space, which can result in a number of issues when the parameters are pushed hard, including halos, high local contrast in highlights, and hue shifts towards blue in the shadows. You are advised to use the tone equalizer module instead.\n🔗module controls shadows Control the effect on shadows. Positive values will lighten shadows while negative values will darken them. highlights Control the effect on highlights. Positive values will lighten highlights while negative values will darken them. white point adjustment By default the algorithm of this module leaves the black and white points untouched. In some cases an image might contain tonal variations beyond the white point, i.e. above a luminance value of 100. A negative shift in the white point adjustment can bring these values back into the proper range so that further details in the highlights become visible. soften with The underlying blurring filter: gaussian or bilateral. Try the bilateral filter if the gaussian blur generates halos. radius The radius of the blurring filter used by the algorithm. Higher values give softer transitions between shadows and highlights but might introduce halos. Lower values will reduce the size of halos but may lead to an artificial look. The bilateral filter is much less prone to halo artifacts. compress Control how strongly the effect extends to the mid-tones. High values limit the effect to only the extreme shadows and highlights. Lower values also cause adjustments to the mid-tones. At 100% this module has no visible effect as only absolute black and absolute white are affected. shadows color adjustment Control the color saturation adjustment made to shadows. High values cause saturation enhancements on lightened shadows. Low values cause desaturation on lightened shadows. It is normally safe to leave this at its default of 100%. This gives a natural saturation boost on shadows – similar to what you would expect in nature if shadows were to receive more light. highlights color adjustment Control the color saturation adjustment made to highlights. High values cause saturation enhancements on darkened highlights. Low values cause desaturation on darkened highlights. Often highlights do not contain enough color information to give convincing colors when darkened. You might need to adjust this parameter in order to find the best fitting value depending on your specific image, but be aware that sometimes the results might not be fully satisfying. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/shadows-and-highlights/","tags":null,"title":"shadows and highlights"},{"categories":null,"content":"Sharpen the details in the image using a standard UnSharp Mask (USM).\nThis module works by increasing the contrast around edges and thereby enhancing the impression of sharpness of an image. This module is applied to the L channel in Lab color space.\nNote: The USM algorithm used in this module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead use the presets offered by the contrast equalizer module for deblurring or the local contrast module for general sharpness.\n🔗module controls radius The unsharp mask applies a gaussian blur to the image as part of its algorithm. This parameter controls the radius of that blur which, in turn, defines the spatial extent of the edge enhancement. Very high values will lead to ugly over-sharpening. amount The strength of the sharpening. threshold Contrast differences below this threshold are excluded from sharpening. Use this to avoid amplification of noise. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/sharpen/","tags":null,"title":"sharpen"},{"categories":null,"content":"darktable is a non-destructive image editor and opens all images in read-only mode. Any data created within darktable (metadata, tags, and image processing steps) is stored in separate .XMP sidecar files. These files are stored alongside the original Raw files and allow darktable to store information about the images as well as the full editing history without touching the original raw files. When you import an image into darktable for the first time, an XMP file is automatically generated. The generation of XMP files can be disabled in preferences \u0026gt; storage \u0026gt; XMP sidecar files but this is not recommended in normal use.\nFor a given source image, multiple editing versions, called duplicates, can co-exist, sharing the same input image data but each having their own metadata, tags and processing steps. Each duplicate of a given image (named \u0026lt;basename\u0026gt;.\u0026lt;extension) is represented by a separate XMP sidecar file (with a filename constructed in the form \u0026lt;basename\u0026gt;_\u0026lt;number\u0026gt;.\u0026lt;extension\u0026gt;.xmp, where \u0026lt;number\u0026gt; represents the version number of that edit). Information for the initial edit \u0026ndash; the “duplicate” with version number zero \u0026ndash; is stored in the sidecar file named \u0026lt;basename\u0026gt;.\u0026lt;extension\u0026gt;.xmp. The version number of each duplicate is displayed in the image information module in each of darktable\u0026rsquo;s views.\nYour work is automatically synchronised to the sidecar files without the need to press a “save” button. When backing up your data, make sure that you also retain copies of the XMP files, as these are required to fully reconstruct your work in case of a disaster.\nIn addition to the sidecar files, darktable keeps all image-related data in its library database for fast access. An image can only be viewed and edited from within darktable if its data has first been loaded into the library database. This happens automatically when you first import an image. If an image is subsequently re-imported, the database will be updated from the contents of its XMP file.\nOnce an image has been imported into darktable, the database entries take precedence over the XMP file. Subsequent changes to the XMP file by any other software are not visible to darktable \u0026ndash; such changes will be overwritten the next time darktable synchronizes the file. On request, darktable can be configured to search for updated XMP files at startup, offering a choice to update the database or overwrite the XMP file where changes are identified. This configuration can be changed in preferences \u0026gt; storage \u0026gt; XMP sidecar files.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/sidecar-files/sidecar/","tags":null,"title":"sidecar files"},{"categories":null,"content":"Remap the tonal range of an image using a modified generalized log-logistic curve.\nThis module can be used to expand or contract the dynamic range of the scene to fit the dynamic range of the display.\nNote: Modules placed before sigmoid in the pipeline operate in scene-referred space. Modules after sigmoid work in display-referred space.\n🔗usage Please take note of the following guidelines while using this module within your workflow:\nonly use one display transform Never use sigmoid together with another display transform module (i.e. filmic rgb or base curve). adjust for the mid-tones first The sigmoid curve pivots around middle gray. Before using sigmoid, you should first use the exposure module to adjust the mid-tones to your liking. less is more You should try to accomplish the majority of your processing using modules in the scene-referred section of the pixelpipe and not rely on the display transform module (sigmoid, filmic rgb, base curve) to do all the work. preserve hue to taste This module provides a number of methods to preserve hues. You are advised to use the \u0026ldquo;per channel\u0026rdquo; mode and tune the hue preservation to your liking on a per-image basis. Sunsets and fire are two examples where users commonly reduce the hue preservation to achieve a \u0026ldquo;hotter\u0026rdquo; look. keep skew at bay For images like portraits, it is best to refrain from using skew values above zero. This way you will avoid harsh transitions in the skin tones. This is particularly important when hue preservation is not enabled, as the skew also affects the hue path of the skin tones. 🔗module controls contrast Adjust the aggressiveness of the compression while leaving middle-gray unchanged. Higher values require lower exposure to reach display white, and shadows become darker. Lower contrast is able to display a larger dynamic range. skew Lean the compression towards shadows or highlights. Skew can be used to transfer some contrast from shadows to highlights or vice versa without changing the amount of contrast at middle gray. Positive skew flattens shadows and compresses highlights. Negative skew creates darker shadows and duller highlights. color processing The mode used to map pixel values from scene to display space. per channel mode applies the sigmoid curve to each rgb channel separately, affecting luminance, chroma, and hue. Hue can be optionally preserved using the preserve hue option (below). This mode is in line with the behavior of the color layers in analog film, and handles smooth roll-off to bright areas very well. rgb ratio is similar to preserve color in filmic rgb. It maps the rgb triplet uniformly using the sigmoid curve, which preserves the spectral color of the pixel. Bright colorful pixels are desaturated along spectral lines as they would otherwise end up outside the display gamut. preserve hue (per channel mode only) Choose how much to preserve hue \u0026ndash; 100% preserves the spectral hue of the image (identical to using the \u0026ldquo;rgb ratio\u0026rdquo; color processing mode); 0% uses the per-channel mode with heavy hue skewing (see below). An acceptable approximation of preserved perceptual hue is usually somewhere between the two extremes. All colors that lie between the primary colors (red, green, and blue) converge towards the closest secondary colors (yellow, magenta, and cyan). The per channel hue skew effect creates yellow sunsets and fires, magenta-looking blue lights, and cyan skies. The skew is stronger for brighter and more saturated pixels. target black Lower bound that the sigmoid curve converges to as the scene value approaches zero \u0026ndash; this should normally be left unchanged. You can use this to give a faded analog look, but should instead prefer to use the \u0026ldquo;global offset\u0026rdquo; slider in color balance rgb to achieve a similar effect. target white Upper bound that the sigmoid curve converges to as the scene value approaches infinity \u0026ndash; this should normally be left unchanged. You can use this to clip white at a defined scene intensity. 🔗primaries Expand this section to set custom primaries. You are advised to use the \u0026ldquo;smooth\u0026rdquo; preset as a starting point and then adjust using the following controls:\nNote: These settings apply only to the per channel processing mode.\nbase primaries Choose the set of primaries to use as the base for adjustments. This is a bit like locally overriding the working profile, and is necessary to allow presets to be created that don\u0026rsquo;t change even if the user amends the working profile used in the pixel pipeline. red/green/blue attenuation Attenuate (decrease) the purity of the red, green or blue primaries before the signal is processed through sigmoid\u0026rsquo;s per-channel curves. An important consequence is that now even the brightest and most pure inputs get smoothly degraded to achromatic at the high end. This avoids posterization and flat-looking patches, which are often seen with, for example, blue LED lights. red/green/blue rotation Rotate the primaries where the per-channel curves are applied. This affects the hue paths when approaching white in the high end. These controls should not normally need large adjustments from the starting values given in the \u0026ldquo;smooth\u0026rdquo; preset. recover purity Recover some of the original purity. A value of 100 causes all of the attenuations to be restored after the per-channel process is done. This lands the middle range values near their original purities. A value of 0 doesn’t restore the purity at all, so the more you apply attenuation, the less purity there is in the final picture. The rotations are always restored regardless of the value of this slider. When this slider is at 0, the output of the module is guaranteed to remain within the gamut footprint of the chosen base primaries. Bear in mind that unlike the rgb primaries module, this is not a tool for creative color grading but rather a set of controls to provide a reasonable starting point for further edits. The effect of these adjustments is not the same as the rgb primaries module even though the interface looks similar.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/sigmoid/","tags":null,"title":"sigmoid"},{"categories":null,"content":"Create a softened image using the Orton effect.\nMichael Orton achieved his results on slide film by using two exposures of the same scene, one well exposed and one overexposed. He then used a darkroom technique to blend these two images into a final image where the overexposed image was blurred.\nThis module is a near-copy of Orton\u0026rsquo;s analog process into the digital domain.\n🔗module controls size The size of blur of the overexposed image. The bigger the size, the softer the result. saturation The saturation of the overexposed image. brightness The brightness (EV) of the overexposed image. mix How the two images are mixed. 50% represents an equal mix of the well exposed and overexposed images. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/soften/","tags":null,"title":"soften"},{"categories":null,"content":"Create a two color linear toning effect where the shadows and highlights are represented by two different colors.\nThe split-toning module does not convert images to black and white and has limited benefits on color images. In order to perform traditional split-toning, the input to this module should therefore be monochrome.\n🔗module controls shadows and highlights color Set the desired hue and saturation for both shadows and highlights. Clicking on the colored squares will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define a color in RGB color space. balance The ratio of toning between shadows and highlights. When set to 50%, half of the lightness range in image is used for shadows toning and the other half for highlights toning. compress The percentage of total (mid-tone) lightness range that is not affected by color toning. This compresses the effect on the shadows and highlights while preserving the mid-tones. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/split-toning/","tags":null,"title":"split-toning"},{"categories":null,"content":"Smooth image surfaces while preserving sharp edges using a bilateral filter.\nThis module can be used to denoise images, however you should be aware that bilateral filters are susceptible to overshoots and darktable offers much better alternatives. For example, the astrophoto denoise module uses a non-local means denoising algorithm, and the denoise (profiled) module provides a choice between non-local means and wavelet denoising algorithms.\nThe surface blur module blurs noise within the surfaces of an image by averaging pixels with their neighbors, taking into account not only their geometric distance but also their distance on the range scale (i.e. differences in their RGB values). It can be particularly useful if one RGB channel is more noisy/needs more smoothing than the others. In such a case, use the color calibration module to examine the channels one by one, in order to set the blur intensities accordingly.\nIn chromaticity blending mode, this module can be used to reduce the appearance of color moire resulting from fine repeated patterns on the object being photographed. You will likely need to increase the values of the Red, Green, and Blue sliders from their defaults for optimal effectiveness.\nThe module can also be used as a creative filter to provide interesting effects, for example to lend an image a cartoon-like appearance. When used with chrominance blending, it can also be used to even out the color of a surface (for example, to remove skin redness).\nThis module is resource-intensive and slows down pixelpipe processing significantly. You should consider activating it late in your workflow.\n🔗module controls radius The spatial extent of the gaussian blur. red, green, blue The blur intensity for each of the RGB channels. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/surface-blur/","tags":null,"title":"surface blur"},{"categories":null,"content":"The basic element of image processing in darktable is the processing module. In order to process a raw image a number of such modules act on the input image in sequence, each performing a different operation on the image data. For those familiar with Adobe Photoshop, the concept of a processing module in darktable is analogous to that of an adjustment layer in that both make an incremental adjustment to the image, building on top of the adjustments that came before.\nUtility modules are also provided by darktable, however these are not directly involved in image processing, instead providing a GUI that allows you to manage your images, tag them, export them etc.\nEvery processing module acts independently of the others, but all modules perform their processing in a similar manner:\nReceive the module input from the last executed module and perform an operation on it to produce the processed output. This operation is different for every processing module.\nCombine the module input and processed output using a blending operator to produce the blended output. If no blending is performed, the output of this step is the same as the processed output.\nGenerate a mask, which defines an opacity for each pixel in the image. The opacity is later used to control how strongly the module\u0026rsquo;s operation is applied to each part of the image.\nYou may define your own mask by drawing shapes over the image or by using pixel properties from the module input or processed output (see masks for details). This mask may be further modified with a global opacity setting, which affects every pixel equally.\nIf no drawn/parametric mask is used, the output of this step is a mask where every pixel has the same opacity (governed by the global opacity setting). If no opacity is defined (no blending is performed) a global opacity of 1.0 (or 100%) is assumed.\nCombine the module input and blended output pixel-by-pixel using the mask as a mixing operator, to produce the final output. Where the mask opacity is 100%, the final output is the blended output for that pixel. Where the mask opacity is 0 the final output is the module input for that pixel. An intermediate opacity combines the blended output and module input proportionally. The final output is passed to the next module for further processing.\nSteps 2 and 3 are optional and not supported by all modules. For example, the demosaic module must be applied to the entire raw file in order to produce a legible image so it does not make sense to mask or blend its output.\nEach of the above steps is defined in more detail in subsequent sections.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/pixelpipe/the-anatomy-of-a-module/","tags":null,"title":"the anatomy of a processing module"},{"categories":null,"content":"Processing high resolution images is a demanding task requiring a modern computer. In terms of both memory and CPU power, getting the best out of a typical 15, 20 or 25 megapixel image can quickly take your computer to its limits.\ndarktable\u0026rsquo;s requirements are no exception. All calculations are performed on 4 x 32bit floating point numbers. This is slower than “ordinary” 8 or 16 bit integer algebra, but eliminates all problems of tonal breaks or loss of information.\nA great deal of optimization has been undertaken to make darktable as fast as possible. If you run a current version of darktable on a modern computer, you might not notice any “slowness”. However, there are conditions and certain modules where you will feel (or hear from the howling of your CPU fan) how much your poor multi-core processor has to struggle.\nThat\u0026rsquo;s where OpenCL comes in. OpenCL allows darktable to take advantage of the enormous power of modern graphics cards. Gamers\u0026rsquo; demand for highly detailed 3D worlds in modern shooters (as well as cryptocurrency mining) has fostered rapid GPU development. AMD, NVIDIA and Co had to put enormous processing power into their GPUs to meet these demands. The result is modern graphics cards with highly parallelized GPUs that can quickly calculate surfaces and textures at high frame rates.\nYou are not a gamer and you don\u0026rsquo;t take advantage of that power? Well, then you should at least use it in darktable! For the task of highly parallel floating point calculations modern GPUs are much faster than CPUs. This is especially true when you want to repeat the same few processing steps millions of times. Typical use case: processing high megapixel images.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/background/","tags":null,"title":"the background"},{"categories":null,"content":"A classic digital photography tool to alter the tones of an image\u0026rsquo;s using curves.\nThis module is very similar to the rgb curve module but works in Lab color space.\nActivate the picker to show the picked values on the displayed histogram. Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the graph.\n🔗module controls Please refer to the curves section for more details about how to modify curves including the interpolation method, scale for graph and preserve colors controls.\ncolor spaces Depending on the desired intent, the tone curve can be applied in one of three color spaces: Lab (linked or separated channels): Lab is a perceptual color space that is designed to approximate the way humans perceive colors and lightness. It represents color information independently of lightness. In “Lab, separated channels” mode, you are given fully independent control over the luminance (L-channel) and the chrominance (a/b-channels). In “Lab, linked channels” mode, only the luminance (L-channel) control is available. The color saturation correction is automatically computed, for each pixel, from the contrast correction applied to the luminance channel. This works better in cases where a subtle contrast correction is applied, but gives increasingly inaccurate saturation correction as the contrast is more dramatically altered. XYZ (linked channels): XYZ is a linear technical color space designed to link the physiological light response of the human eye to RGB color spaces. As with Lab, it separates lightness from color information, but does so in a way that does not account for the role of the brain\u0026rsquo;s correction in human perception. The “XYZ, linked channels” mode offers an alternative to “Lab, linked channels”, and works by applying the L-channel curve to all three channels in the XYZ color space. Look at blend mode “coloradjustment” if you want to tune the strength of automatic chroma scaling. This mode is known to produce a slight hue shift towards yellow. RGB (linked channels): RGB is a linear color space designed to capture and display images in additive synthesis. It is related to capture and display media and does not isolate color and lightness information. The “RGB, linked channels” mode works in ProPhoto RGB and applies the L-channel curve to all three channels in the RGB color space. Adding contrast in RGB space is known to desaturate highlights and boost saturation in the shadows, but this has proven to be the most reliable way to edit contrast, and is the standard method used in most software. This mode makes the tone curve module behave in much the same way as the base-curve module, except that the latter works in camera RGB space. Note that the module works in Lab color space in all cases. This means that the middle-gray coordinate is always 50% in the graph, no matter what color space is used. The same applies to the inset histogram displayed in the background of the curve. The controls are converted to the relevant color space before the corrections are applied \u0026ndash; in RGB and XYZ, the middle-gray is therefore remapped from 50% to 18%.\nL-channel curve The tone curve in L-channel works on Lightness. To provide a better overview, a lightness histogram is displayed in the module. When working in one of the \u0026ldquo;linked channels\u0026rdquo; modes, the L-channel curve is the only one available. The horizontal axis represents the lightness of the input image pixels. The vertical axis represents the lightness of the output image pixels. The default straight diagonal line does not change anything. A curve above the default diagonal increases the lightness, whereas a curve below decreases it. An S-like curve will enhance the contrast of the image. You can move the end-points of the default diagonal to change the black and white points and hence alter the overall contrast \u0026ndash; this has the same effect as changing the black and white points in the levels module.\na/b-channel curves The curves in the a and b channels work on color values and are available only in the “Lab, separated channels” mode. The horizontal axis represents the color channel value of the input image pixels. The vertical axis represents the color channel value of the output image pixels. Positive a-values correspond to more magenta colors; negative a-values correspond to more greenish colors. Positive b-values correspond to more yellowish colors; negative b-values correspond to more blueish colors. The default diagonal straight line does not change anything. Shifting the center of the curve will give the image a color tint: shifting the a-channel upwards gives a magenta tint; shifting the b-channel upwards gives a yellow tint; shifting the a-channel downwards gives a green tint; shifting the b-channel downwards gives a blue tint.\nIncreasing/decreasing the steepness of a curve, without shifting its center, will increase/decrease the color saturation of the respective channel. With properly defined curves you can exert fine control on color saturation, depending on the input pixel\u0026rsquo;s colors.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/tone-curve/","tags":null,"title":"tone curve"},{"categories":null,"content":"Dodge and burn while preserving local contrast.\nWhen used together with filmic rgb, this module replaces the need for other tone-mapping modules such as the base curve, shadows and highlights, tone curve and zone system (deprecated) modules. It works in linear RGB space and utilizes a user-defined mask to guide the dodging and burning adjustments, helping to preserve local contrast within the image.\nThe following diagram describes how the tone equalizer works:\nCreate a monochrome guided mask that divides the input image into regions of similar luminosity. The resulting mask should blur the fine details within the image so that pixels within each region are all treated similarly, preserving local contrast.\nAdjust the sliders in the simple tab or the equalizer graph in the advanced tab to alter the brightness of the underlying image, based on the brightness of the mask. Exposure can also be adjusted by scrolling with the mouse while hovering the cursor over the preview image (see cursor indicator/control for details).\nIn the simple tab, each slider corresponds to a single brightness zone (EV) in the mask, which can be raised or lowered to adjust the exposure of the image where the mask\u0026rsquo;s brightness lies in that zone. Similarly, in the equalizer tab, the horizontal axis of the graph corresponds to the brightness level of the mask, and the vertical axis specifies the required exposure adjustment to pixels where the mask matches that brightness level.\nThe exposure of each pixel of the input image is adjusted using the mask and the equalizer graph. For each pixel, the module looks up the brightness of the mask at that point, finds the matching brightness on the horizontal axis of the equalizer graph, and increases or decreases the exposure accordingly (using the vertical axis of the graph).\nIt is important that the mask separates the image into regions of similar brightness, and that a suitable amount of blur is applied within those regions. This means that all of the pixels in each region will have their exposure adjusted similarly, without adversely affecting local contrast. Examine your image beforehand to identify which regions you wish to dodge and burn, and use the controls on the masking tab to ensure that those areas are reasonably separated in tone within the final mask. This will allow those regions to be adjusted independently.\n🔗module controls The controls of the tone equalizer module are divided between three tabs.\ndisplay exposure mask Click on the icon to the right of this label to show/hide the module\u0026rsquo;s guided mask over the top of the image. This control is available in all three tabs. 🔗simple tab This tab splits the brightness of the guided mask into nine zones (from \u0026ndash;8 to 0 EV) and allows you to alter each zone independently. This is a simplified interface and is used to generate the same tone adjustment curve as shown in the advanced tab.\n\u0026ndash;8 EV \u0026hellip; 0 EV Each slider adjusts the exposure of all pixels where the guided mask has the given brightness. If the mask\u0026rsquo;s histogram is evenly spread over the entire tonal range, sliders towards the top generally affect the shadows, whereas sliders towards the bottom generally affect the highlights. You can check the spread of the histogram within the advanced tab. 🔗advanced tab This tab allows you to control the same intensity levels as in the simple tab, though here they are represented as control points on a curve. Behind the curve is a histogram representing the intensity levels of the guided mask (not the underlying image). If the histogram is too bunched up, this means your mask doesn\u0026rsquo;t have a good spread of intensity levels, which makes it harder to independently control the brightness of the different parts of your image. It is therefore recommended that the histogram be adjusted so that it extends the entire range, covering as many control points as possible for maximum flexibility. You can adjust the mask using the controls in the masking tab.\nClick+drag the control points on the curve to adjust the brightness of all pixels where the mask has the given intensity. If the mask\u0026rsquo;s histogram is evenly spread over the entire tonal range, control points to the left will generally affect the shadows, and control points to the right will generally affect the highlights. Moving a single control point will also affect control points on either side to ensure the curve remains smooth. This behaviour can be adjusted using the curve smoothing control.\ncurve smoothing Control how the curve is interpolated between control points. Move the slider to the right to make the transitions between the control points more gradual, but beware that going past about 0.6 can introduce some instability (oscillations) in the curve due to mathematical constraints. Move the slider to the left for a more well-behaved curve, but beware that this can result in harsher tonal transitions that may damage local contrast. 🔗masking tab This tab contains controls for adjusting the guided mask.\nThe purpose of the guided mask is to separate out areas with different tonal ranges so that they can be independently brightened or darkened by the tone equalizer. The masking filters are designed to allow sharp edges between these areas to be preserved, while blurring details within a given tonal range, so that the brightness can be adjusted without adversely impacting local contrast. Ideally the mask histogram shown in the advanced tab should be spread out across all of the control points.\nTo avoid having to switch back and forth between the advanced and masking tabs, a gray bar under the \u0026ldquo;mask post processing\u0026rdquo; label displays a representation of the middle 80% of the histogram. By using the controls in this tab to center and spread out this gray bar, you can expect to have a nicely shaped histogram when you return to the \u0026ldquo;advanced\u0026rdquo; tab. If you see orange at either end of the gray bar, this means that part of the histogram is outside of the 9 EV range of the mask, and needs to be further adjusted.\nWhen setting up the guided mask you will need to strike a balance between obtaining a smooth blur within tonal regions (to preserve local contrast) and preservation of the boundaries between those regions. Some experimentation will be required to find the best settings. Often the key controls to adjust are the exposure/contrast compensation sliders at the bottom of the module.\nDisplaying the guided mask while making these adjustments will help you to understand these controls and better judge the quality of the mask.\nluminance estimator Choose the method by which the luminance of a pixel will be estimated when mapping it to a mask intensity value (default RGB euclidean norm). preserve details Choose the smoothing algorithm used to blur the mask: no: Do not smooth the mask (the effect is the same as using normal tone curves). When the module is used to compress dynamic range, this option can cause compression of local contrast. This can be useful when increasing (local and global) contrast. guided filter: Use the original guided filter algorithm to blur the mask while attempting to preserve edges. One of the limitations of this algorithm is that the guided filter is exposure-sensitive, meaning that shadows tend to be blurred more than highlights. Note that this limitation can sometimes be an asset: if one wants to lighten shadows a lot, the guided filter can provide very good local contrast preservation. average guided filter: Use this option in cases where the effect of the guided filter is too strong. In this mode, a geometric mean is taken between the output of the original guided filter algorithm and the output given by the no option. eigf (default): The exposure-independent guided filter solves the problem of the original guided filter, in that it makes the degree of blurring independent of the exposure. This means the degree of blurring applied to the highlights and the shadows regions should be about the same. This improved algorithm is now the default option. averaged eigf: This option takes the geometric mean between the eigf mask and the mask generated by the no option, and is useful in cases where the degree of blurring in the mask needs to be mitigated. filter diffusion By default this is set to a value of 1, meaning that the filtering algorithm is run once on the input image to produce the blurred monochrome mask. If you increase this to 2, the filtering algorithm will be run once on the input image to produce an intermediate mask, and then a second time on the intermediate mask. As a result, the final mask will be more blurred than when using a single iteration. Progressively higher values will diffuse the mask even further. However, because the mask filtering algorithm is run multiple times, each iteration will increase the processing time.\nsmoothing diameter This controls how much of the surrounding image to take into account when calculating the mask\u0026rsquo;s blur at a particular point, defined as a percentage of the length of the image\u0026rsquo;s longer side (default 5%). With lower values, the transition between darker and lighter areas of the mask will be more pronounced. As the value is increased, transitions become smoother/softer. For the default exposure-independent guided filter (eigf), you should typically use blurring radii around 1-10%. With the original guided filter, blurring radii around 1-25% will typically yield better results. edges refinement/feathering Higher values force the mask to follow high contrast edges more closely. Lower values give smoother gradients, but may introduce halos. If required, feathering can be set to values as high as 10,000. mask post-processing This bar provides a representation of the current span of the mask\u0026rsquo;s histogram. It covers the middle 80% of the histogram, dropping the first and last decile to prevent outliers from skewing the indicator too much. Orange indicators at either end mean that the histogram exceeds the upper or lower bounds of its 9 EV range. mask quantization Apply a degree of posterization to the mask, so that it tends to centre round a few discrete levels. In some cases, this may be useful to help separate out areas of your image into distinct masking levels. mask exposure compensation Adjust the mask\u0026rsquo;s histogram to the left or right. If you have used the exposure module to adjust the image brightness, you may need to offset that adjustment by using this slider to re-centre the mask\u0026rsquo;s histogram. Click on the wand icon to the right of the slider to set the exposure compensation such that the average of the mask\u0026rsquo;s histogram will coincide with the central \u0026ndash;4EV control point. The slider can then be fine-tuned as required. mask contrast compensation Dilate (spread out) or compress the mask\u0026rsquo;s histogram. The wand icon to the right of the slider will propose a reasonable starting point, which can then be fine-tuned to optimize the spread of the histogram under the tone equalizer control points. 🔗cursor indicator/control When the tone equalizer module is enabled and expanded, you can move the mouse pointer over the preview image to show a cursor that displays information about the pixel under the pointer. When this cursor is shown, the mouse wheel can be used to brighten or darken the areas of your image that match the mask intensity level at that point. This provides a convenient way to quickly brighten or darken specific parts of the image.\nthe cross-hairs indicate the position of the pixel under the cursor the text label shows the intensity of the guided mask at that point, in EV the shade of the outer circle indicates the intensity of the mask at that point if the tone equalizer has brightened or darkened pixels matching this mask intensity, the magnitude of the adjustment is indicated by an arc on the left-hand-side. The longer the arc, the greater the brightness adjustment, if there has been an exposure adjustment, the shade of the inner circle indicates the amount of brightening or darkening, relative to the mask\u0026rsquo;s intensity at that point (as indicated by the outer gray circle). That is to say, if the pixel under the crosshairs has been brightened, the inner circle will be a lighter shade of gray than the outer circle; if the pixel has been darkened, the inner circle will be a darker shade of gray than the outer circle. If you need to move or zoom the portion of the image shown in the center view while the module is expanded, hold down the \u0026lsquo;a\u0026rsquo; key while dragging the mouse or using the scroll wheel. As long as the key is held down, mouse actions adjust the viewport rather than adjusting the tone curve.\n🔗presets The tone equalizer comes with several presets that can use used to compress shadows and highlights. Each comes in two variants, using either the guided filter (gf) or the exposure-independent guided filter (eigf). The variants using the guided filter tend to preserve local contrast in the shadows better those that use the exposure-independent guided filter, but at the price of reducing the local contrast in the highlights. Either of these variants may lead to better results, depending on the image. In both cases, the presets preserve middle-gray, so you shouldn\u0026rsquo;t need to adjust the global exposure after activating the tone equalizer.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/tone-equalizer/","tags":null,"title":"tone equalizer"},{"categories":null,"content":"Add a correction curve to image data. This is required if you have selected certain input profiles in the input color profile module.\nIf you decide to use an ICC profile from the camera manufacturer in the input color profile module, a correction curve frequently needs to be pre-applied to image data to prevent the final output from looking too dark. This extra processing is not required if you use darktable\u0026rsquo;s standard or enhanced color matrices.\nThe correction curve is defined with a linear part extending from the shadows to some upper limit and a gamma curve covering mid-tones and highlights. For further information please see darktable\u0026rsquo;s neighboring project UFRaw.\nlinear The upper limit for the region counted as shadows and where no gamma correction is performed. Typically values between 0.0 and 0.1 are required by the profile. gamma The gamma value required to compensate the input profile. Often the required value is 0.45 (the reciprocal of the 2.2 gamma used by some manufacturer\u0026rsquo;s profiles). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/unbreak-input-profile/","tags":null,"title":"unbreak input profile"},{"categories":null,"content":"Resaturate pixels in a weighted manner that gives more weight to blacks, whites and less saturated pixels.\nNote: This module causes hue and brightness shifts that can be difficult to manage. Instead, use the color balance rgb module for color modifications.\n🔗module controls strength The strength of the effect mid-tones bias Reduce the effect on mid-tones in order to avoid unnatural skin tones. Reducing the mid-tone bias decreases mid-tone protection and makes the overall velvia effect stronger. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/velvia/","tags":null,"title":"velvia"},{"categories":null,"content":"The functionality in darktable is separated into six different views:\nlighttable Manage images and collections. darkroom Develop a single image. map Show geo-tagged images on a map and manually geo-tag new images. print Send images to a printer. slideshow Display images as a slideshow, processing them on-the-fly. tethering Remotely capture and save images taken with a connected camera. You can switch between views by clicking the view name at the top of the right-hand panel (the currently active view is highlighted) or by using one of the following keyboard shortcuts:\nL switches to lighttable D switches to darkroom M switches to map P switches to print S switches to slideshow T switches to tethering ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/user-interface/views/","tags":null,"title":"views"},{"categories":null,"content":"Apply a vignetting effect to the image.\nVignetting is a modification of the brightness and saturation at the borders of the image in a specified shape. Many of the parameters listed below can also be modified with a graphical control that overlays the image when the module has focus, showing the shape and extent of the effect.\nNote: This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate this.\nAlso note: This module can produce unnatural-looking results and should be used with care. Instead, use the exposure module with an elliptical mask with a large transition area and, if necessary, use the color balance rgb module with the same mask to reduce saturation at the edges.\n🔗module controls fall-off start The radius of the central vignetting area. fall-off radius The progressiveness of the fall-off. Lower values cause a steeper transition. brightness The intensity of brightening (positive values) or darkening (negative values). saturation Control how strong colors become when desaturated/saturated in the darkened/brightened vignetting area. horizontal/vertical center Shift the center of the vignetting area horizontally/vertically. shape The shape of the vignetting effect. The default value of 1 creates a circular or elliptical area. Smaller values shift the shape to being more square; higher values turn it into a cross-like shape. automatic ratio Automatically adjust the width/height ratio of the vignetting area to match the aspect ratio of the underlying image. This typically causes the vignetting area to become elliptical. width/height ratio Manually adjust the width/height ratio of the vignetting area. dithering Activate random noise dithering to alleviate banding artifacts caused by vignette gradients. Select “8-bit output” to prevent banding on monitor display and for JPEGs. When set to “16-bit output”, only a small amount of dithering is applied, just strong enough to compensate for banding on the fine grained 16-bit level. It is now recommended that you instead use the dither or posterize module to alleviate banding artifacts. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/vignetting/","tags":null,"title":"vignetting"},{"categories":null,"content":"Render a vector-based overlay onto your image. Watermarks are standard SVG documents and can be designed using Inkscape.\nYou can also use bitmap (PNG) images.\nThe SVG processor in darktable can also substitute strings within an SVG document, allowing image-dependent information to be included in the watermark.\nUser-designed watermarks should be placed into the directory $HOME/.config/darktable/watermarks. Once in place, use the reload button update the list of available watermarks.\nThe following is a list of variable strings that are supported for substitution within an SVG document.\nIn addition to this list you can also use the variable strings defined in the variables section.\n$(WATERMARK_TEXT) A short free text (max. 63 characters) $(WATERMARK_COLOR) The color to use for $WATERMARK_TEXT $(WATERMARK_FONT_FAMILY) The font family to use for $WATERMARK_TEXT $(WATERMARK_FONT_STYLE) The font style (normal, oblique, italic) $(WATERMARK_FONT_WEIGHT) The font weight (boldness) 🔗module controls marker Choose the watermark to apply. Use the reload button to update the list to include any newly-added watermarks. The extension of the file (png/svg) is shown in brackets. text A free text field in which you can enter up to 63 characters to be printed where referenced by the corresponding watermark. An example is supplied as simple-text.svg. font The font to use (default \u0026ldquo;DejaVu Sans Book\u0026rdquo;). Click on the field to open a dialog box showing the fonts available on your system. Fonts can be searched by name and a preview is shown next to the font name. You may specify your own sample text. color The color of the text. Click on the colored field to open a color selector dialog which offers you a choice of commonly used colors, or allows you to define a color in RGB color space. opacity The opacity of the watermark\u0026rsquo;s rendering. rotation The rotation angle of the watermark. scale The scale of the watermark (in per cent), with respect to the option selected in the \u0026ldquo;scale on\u0026rdquo; parameter. scale on The reference for the scale parameter \u0026ndash; how the watermark is scaled relative to the image: \u0026ldquo;image\u0026rdquo; (default): Scale the watermark relative to the whole image, \u0026ldquo;larger border\u0026rdquo;: Scale the larger border of the watermark relative to the larger border of the image, \u0026ldquo;smaller border\u0026rdquo;: Scale the smaller border of the watermark relative to the smaller border of the image, \u0026ldquo;height\u0026rdquo;: Scale the height of the watermark relative to the height of the image (useful for text with a constant font height), \u0026ldquo;advanced options\u0026rdquo;: activate additional options (below) to allow you to choose which image dimension to scale to which watermark dimension. For example, you can choose to scale the watermark\u0026rsquo;s height relative to the image\u0026rsquo;s width. scale marker to (\u0026ldquo;advanced options\u0026rdquo; only) The image reference against which the watermark should be scaled \u0026ndash; \u0026ldquo;image width\u0026rdquo;, \u0026ldquo;image height\u0026rdquo;, \u0026ldquo;larger image border\u0026rdquo; or \u0026ldquo;smaller image border\u0026rdquo;. scale marker reference (\u0026ldquo;advanced options\u0026rdquo; only) The dimension of the unrotated watermark (\u0026ldquo;marker width\u0026rdquo; or \u0026ldquo;marker height\u0026rdquo;) to use as a scaling reference. alignment Use these controls to align the watermark to any edge or the center of the image. x offset Pixel-independent offset relative to the choice of alignment on the x-axis. y offset Pixel-independent offset relative to the choice of alignment on the y-axis. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/watermark/","tags":null,"title":"watermark"},{"categories":null,"content":"Adjust the white balance of the image by altering the temperature and tint, defining a coefficient for each RGB channel, or choosing from list of predefined white balance settings.\nThe default settings for this module are derived from the camera white balance stored in the image\u0026rsquo;s Exif data.\nWhite balance is not intended as a \u0026ldquo;creative\u0026rdquo; module \u0026ndash; its primary goal is to technically correct the white balance of the image ensuring that neutral colored objects in the scene are rendered with neutral colors in the image. For creative color operations, it is usually better to use other modules such as color calibration or color balance rgb.\nNote: The color calibration module now provides a more modern and flexible method of controlling white balance. The color calibration module can be enabled by default for new images by selecting \u0026ldquo;scene-referred\u0026rdquo; (filmic or sigmoid) in preferences \u0026gt; processing \u0026gt; auto-apply pixel workflow defaults. Some basic settings are still required (and applied automatically) in the white balance module, so that demosaic works correctly.\n🔗module controls 🔗scene illuminant temp This section provides scene-illuminant temperature and tint controls to adjust the white balace of the image. Click on the \u0026lsquo;scene illuminant temp\u0026rsquo; section label to cycle between 3 different color modes for the temperature/tint sliders.\ntemperature Set the color temperature in kelvin. tint Alter the color tint of the image, from magenta (tint \u0026lt; 1) to green (tint \u0026gt; 1). 🔗white balance presets setting Choose from a predetermined list of white balances. The available settings are derived from the presets available in the camera used to take the photograph. The following options are provided in addition to any camera-defined white balance presets. as shot (default): The white balance as reported by the camera from image area: Draw a rectangle over a neutral color in the image to calculate white balance from that area. user modified: The most recently modified setting. Manual adjustment of temperature, tint or r/g/b channel coefficients will automatically select this option. Choose this setting after selecting any other preset to return parameters to the most recent user-modified state camera reference: Set the temperature to the camera reference white point, which is assumed to be D65 (or ~6502K). The white balance channel multipliers are calculated such that pure white in the camera colorspace is converted into pure white in sRGB D65 (where pure white means that each color channel has an equal value). For convenience the final four modes can also be set by clicking on one of the buttons in the button bar above the setting drop-down.\nfinetune Finetune a camera-specific white balance preset. This is only shown if it is available for the camera in question. The direction of adjustment is dependent on the provided presets. If your camera doesn\u0026rsquo;t have white balance presets available, check this guide to see how you can submit your own. 🔗channel coefficients The RGB channel coefficients are automatically calculated from the above parameters and, as such, are hidden by default. You can expand/collapse the channel coefficients section by clicking on either the \u0026lsquo;channel coefficients\u0026rsquo; label or the adjacent triangular button.\nred/green/blue Set the value of each RGB channel coefficient from 0 to 8 🔗additional functionality 🔗colored sliders By default the module\u0026rsquo;s sliders are monochrome. However, two flavors of colored sliders can be enabled in preferences \u0026gt; darkroom \u0026gt; white balance slider colors or by clicking on the \u0026lsquo;scene illuminant temp\u0026rsquo; section label in the module.\nno color (default) The background of the sliders is not colored. illuminant color The slider colors represent the color of the light source (the color you are adjusting to in order to achieve neutral white). effect emulation The slider colors represent the effect the adjustment would have had on the scene. This is how most other raw processors show temperature/tint sliders colors. 🔗button bar The button bar is simple addition that allows one-click access to the internal white balance settings. You can disable this by editing your darktablerc file. Find the line that says\nplugins/darkroom/temperature/button_bar=TRUE and change TRUE to FALSE.\n🔗usage warning The only parameters that are used internally by this module\u0026rsquo;s operation are the rgb channel coefficients. The temperature and tint sliders are provided as a more user-friendly way to adjust those parameters. The relationship between the channel coefficients and temperature/tint sliders depends on characteristics specific to the camera used to take the photograph. This means that applying white balance settings from an image made with one camera to an image made with another will, in general, not give consistent results.\nThe mathematical relationship between the two sets of values is not straightforward. It is possible to set the channel coefficients such that there is no valid equivalent temperature and tint setting (mainly where very high temperature values are calculated from the sliders). Editing white balance using temperature and tint on an image previously edited using channel coefficients may therefore give odd results, at least where high temperature values are involved.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/white-balance/","tags":null,"title":"white balance"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the quick access panel instead.\nA convenience module that combines controls from exposure, highlight reconstruction, color balance and vibrance into a single module.\nWhile this module can provide a quick and convenient way to make simple adjustments to an image, it must be used with care. Normally exposure adjustments should come before input color profile in the pixelpipe, and color adjustments should come after. Because the basic adjustments module combines all of these functions into a single operation in the pixelpipe, it may not play nicely with other modules. Therefore, if you plan to use basic adjustments with other modules, please instead consider using the exposure + base curve / tone curve / filmic rgb + color balance modules so that these operations occur in the correct places in the pixelpipe.\n🔗module controls black level correction Equivalent to black level correction in the exposure module, this slider defines the threshold at which dark gray values are cut off to pure black. Reducing this can bring some dark colors back into gamut. Increasing this slider may appear to increase the contrast and pop of an image, but it can push dark colors out of gamut, and clipped data cannot be recovered further down the pixel pipe. To control the contrast in the shadows, it is better to use other modules such as tone curve or levels, which mitigate these negative impacts further down the pixel pipeline. exposure Adjust exposure compensation. Adding 1 EV of exposure compensation is equivalent to doubling the exposure time in camera, opening the aperture by 1 stop, or doubling the ISO. Positive exposure corrections will make the image brighter. As a side effect noise level is increased. Depending on the basic noise level of your camera and the ISO value of your image, positive exposure compensations with up to 1EV or 2EV should still give reasonable results.\nNegative exposure corrections will make the image darker. Given the nature of digital images this can not correct for fully blown out highlights but allows you to reconstruct data if only some of the RGB channels are clipped (see the highlight reconstruction module for information on how to deal with clipped pixels).\nhighlight compression Compress the highlights of the image in order to recover detail. contrast Equivalent to the contrast slider in the color balance module, this is used to increase the separation of luminance values around a fulcrum point, in effect making the tone curve steeper. The middle gray slider sets the fulcrum point for the contrast, and any pixels whose luminance matches this middle gray point will be unaffected. Pixels brighter than the middle gray point will become even brighter, and pixels darker than the middle gray point will become even darker. preserve colors If a non-linear tone curve is applied to each of the RGB channels individually, then the amount of tone adjustment applied to each color channel may be different, and this can cause hue shifts. Therefore, the preserve colors menu provides different methods of calculating the \u0026ldquo;luminance level\u0026rdquo; of a pixel. The amount of tone adjustment is calculated based on this luminance value, and then this same adjustment is applied to all three of the RGB channels. Different luminance estimators can affect the contrast in different parts of the image, depending on the specific characteristics of that image. The user can therefore choose a particular estimator that provides the best results for the given image. middle gray Set the fulcrum point for the contrast slider. This is equivalent to the contrast fulcrum slider on the color balance module. If the contrast slider is set to 0 this slider will not have any effect. brightness Equivalent to increasing the gamma factor slider in the color balance module. Moving the slider to the right will increase the brightness of the image, with an emphasis on the mid-tones. saturation Equivalent to the output saturation slider on the color balance module, this slider affects the saturation, or brilliance and intensity of the colors. Moving the slider to the right will increase the amount of color in the image; moving the slider to the left will reduce the amount of color in the image. vibrance Accentuate the colors of the image without adding unnatural colors, as it\u0026rsquo;s often the case with the saturation slider. It works by reducing the lightness of already saturated pixels to make the colors more vivid. You can also achieve some interesting effects by combining it with the saturation slider to target more or less saturated areas of the image. auto Automatically adjust the exposure, taking into account the entire image, or use the picker to select a rectangular area of the image \u0026ndash; the exposure will be automatically adjusted based on the selected region. This allows you to prioritise which parts of the image should be well-exposed. clip This affects the number of pixels that will be clipped to black or white during the auto-exposure calculation. Moving this slider to the right will allow more pixels to be clipped and increase the contrast; moving this slider to the left will compress the image more and lower the contrast. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/basic-adjustments/","tags":null,"title":"(deprecated) basic adjustments"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the color calibration module instead.\nA simple yet powerful tool to manage color channels.\nThis module accepts red, green and blue channels as an input and provides red, green, blue, gray, hue, saturation and lightness channels as output. It allows you to independently control how much each input channel contributes to each output channel.\n🔗RGB matrix multiplication You can think of the channel mixer as a type of matrix multiplication between a 3x3 matrix and the input [R G B] values.\n┌ R_out ┐ ┌ Rr Rg Rb ┐ ┌ R_in ┐ │ G_out │ = │ Gr Gg Gb │ X │ G_in │ └ B_out ┘ └ Br Bg Bb ┘ └ B_in ┘ If, for example, you\u0026rsquo;ve been provided with a matrix to transform from one color space to another, you can enter the matrix coefficients into the channel mixer as follows:\nset the destination to red then set the Rr, Rg \u0026amp; Rb values using the red, green and blue sliders set the destination to green then set the Gr, Gg \u0026amp; Gb values using the red, green and blue sliders set the destination to blue then set the Br, Bg \u0026amp; Bb values using the red, green and blue sliders By default, channel mixer just copies the input [R G B] channels straight over to the matching output channels. This is equivalent to multiplying by the identity matrix:\n┌ R_out ┐ ┌ 1 0 0 ┐ ┌ R_in ┐ │ G_out │ = │ 0 1 0 │ X │ G_in │ └ B_out ┘ └ 0 0 1 ┘ └ B_in ┘ As an example use case, the following matrix is useful for taming ugly out-of-gamut blue LED lights by making them more magenta:\n┌ 1.00 -0.18 0.18 ┐ │ -0.20 1.00 0.20 │ └ 0.05 -0.05 1.00 ┘ In this case it is useful to use a parameteric mask to limit the effect of the channel mixer to just the problematic colors.\nA more intuitive take for what the channel mixer sliders do:\nfor the red destination, adjusting sliders to the right will make the R, G or B areas of the image more red. Moving the slider to the left will make those areas more cyan. for the green destination, adjusting sliders to the right will make the R, G or B areas of the image more green. Moving the slider to the left will make those areas more magenta. for the blue destination, adjusting sliders to the right will make the R, G or B areas of the image more blue. Moving the slider to the left will make those areas more yellow. 🔗monochrome Another very useful application of the channel mixer is the ability to mix the channels together to produce a grayscale output \u0026ndash; a monochrome image. Use the gray destination, and set the red, green and blue sliders to control how much each channel contributes to the brightness of the output. This is equivalent to the following matrix multiplication:\nGRAY_out = [ r g b ] X ┌ R_in ┐ │ G_in │ └ B_in ┘ When dealing with skin tones, the relative weights of the three channels will affect the level of detail in the image. Placing more weight on red (e.g. [0.9, 0.3, -0.3]) will make for smooth skin tones, whereas emphasising green (e.g. [0.4, 0.75, -0.15]) will bring out more detail. In both cases the blue channel is reduced to avoid emphasising unwanted skin texture.\nDifferent types of traditional black and white film have differing sensitivities to red, green and blue colors, and this can be simulated by setting the gray destination coefficients appropriately. The channel mixer module has a number of built-in presets that can be used to achieve this.\n🔗module controls destination Select the destination channel that will be affected by the slider settings immediately below. The red, green and blue destination channels are used for color mixing as described in the matrix multiplication section above. The gray channel is used for making grayscale images as described in the monochome section above. It is also possible to define the R, G \u0026amp; B input channels to produce HSL (hue, saturation and lightness) values on the output, although this is a very specialised application. red Defines how much the red input channel should contribute to the selected destination channel. green Defines how much the green input channel should contribute to the selected destination channel. blue Defines how much the blue input channel should contribute to the selected destination channel. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/channel-mixer/","tags":null,"title":"(deprecated) channel mixer"},{"categories":null,"content":" Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the color balance rgb module instead.\nA very basic tool for adjusting the contrast, brightness and saturation of an image. Please note that a number of other modules provide much more versatile methods of adjusting these parameters.\nAll module controls default to a neutral position (zero) and provide the ability to increase or decrease the relevant parameter\nNote: This module works in Lab color space and is prone to halos. Instead, use the color balance rgb module.\n🔗module controls contrast The contrast brightness The brightness saturation The saturation ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/contrast-brightness-saturation/","tags":null,"title":"(deprecated) contrast brightness saturation"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.8 and should no longer be used for new edits. Please use the crop module to crop the image, the rotate and perspective module to perform rotation and keystone correction, and the orientation module to flip the image on the horizontal/vertical axes.\nCrop, rotate, and correct perspective distortions using on-screen guides.\nWhenever the user interface of this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines.\nResize the crop by dragging the border and corner handles.\nMove the crop rectangle by clicking and dragging inside the crop area. Constrain movement to the horizontal/vertical axis by holding Ctrl/Shift, respectively while dragging. Commit changes by giving focus to another module.\nIf you intend to use the retouch module, you are recommended to use rotate and perspective for rotation and/or keystone correction only, performing creative cropping in the crop module. This process ensures that the entire image is available for source spots in retouch, since the crop module is placed after retouch in the pixelpipe.\nNote: Some of the tools in this module (angle adjustment and perspective distortion correction) require the original image data to be interpolated. For best sharpness results set “lanczos3” as the pixel interpolator in preferences \u0026gt; processing.\n🔗module controls The crop and rotate module controls are split between two tabs as follows:\n🔗main tab flip Flip the image on the horizontal, vertical or both axes. angle Correct the rotation angle to level an image by setting a numerical value in degrees or using the mouse. To use the mouse, right-click and drag to draw a line along a suitable horizontal or vertical feature. As soon as you release the mouse button the image is rotated so that the line you drew matches the horizontal or vertical axis. keystone Correct perspective distortions. This tool is useful, for example, when you shoot a high building from the ground with a short focal length, aiming upwards with your camera. The combobox allows you to select the type of correction you want to use: vertical: Limit the correction to vertical lines horizontal: Limit the correction to horizontal lines full: Correct horizontal and vertical lines at the same time Depending on the selected correction type you will see two or four straight adjustment lines overlaid on your image. Two red circles on each line allow you to modify the line positions with your mouse. Each line additionally carries a “symmetry” button. If activated (and highlighted in red) all movements of the affected line will be mirrored by the opposite line.\nIn order to correct perspective distortions, you need to find suitable horizontal and/or vertical features in your image and align the adjustment lines with them. When finished, press the “OK” button located close to the center of the image \u0026ndash; corrections will be applied immediately. You can return to the module and refine your corrections by selecting “correction applied” in the keystone combobox.\nautomatic cropping Automatically crop the image to avoid black edges on the image borders. This is useful when rotating the image. aspect Set the aspect ratio of the crop, constraining the width:height ratio of the crop rectangle to the chosen aspect. Many common numerical ratios are pre-defined. A few special aspect ratios deserve explanation: freehand: Crop without any restrictions original image: Retain the aspect ratio of the original image square: Constrains the aspect ratio to be 1:1 golden cut: The golden ratio (1.62:1) You can also enter any other ratio after opening the combobox by typing it in the form of “x:y” or as a decimal (e.g. \u0026ldquo;0.5\u0026rdquo; to apply a ratio of 2:1).\nIf you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form \u0026ldquo;plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y\u0026rdquo; in darktable\u0026rsquo;s configuration file $HOME/.config/darktable/darktablerc. Here “foo” defines the name of the new aspect ratio and “x” and “y” the corresponding numerical values (x and y must be integers). Note that you can only add new entries for ratios not already present in the drop-down list.\nFinally, the button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio.\nNote: When resizing an image in freehand mode you may retain the currently-set aspect ratio by holding Shift while dragging on any of the resize controls.\nshow guides Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides \u0026amp; overlays for details. 🔗margins tab These sliders allow you to directly set how much of the image to crop from each side. They are automatically updated if you move or resize the crop area on the image using the mouse.\nleft The percentage of the image that should be cropped from the left side. right The percentage of the image that should be cropped from the right side. top The percentage of the image that should be cropped from the top. bottom The percentage of the image that should be cropped from the bottom. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/crop-rotate/","tags":null,"title":"(deprecated) crop and rotate"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the chromatic aberrations module instead.\nRemove color fringing, which often results from Longitudinal Chromatic Aberrations (LCA), also known as Axial Chromatic Aberrations.\nThis module uses edge-detection. Where pixels are detected as a fringe, the color is rebuilt from less saturated neighboring pixels.\n🔗module controls operation mode global average: This mode is usually the fastest but might show slightly incorrect previews at high magnification. It might also protect the wrong regions of color too much or too little by comparison with local average. local average: This mode is slower because it computes local color references for every pixel. However it might protect color better than global average and allows for rebuilding color where actually required.\nstatic threshold: This mode does not use a color reference but directly uses the threshold as given by the user.\nedge detection radius The algorithm uses the difference between the input image and a gaussian-blurred version of the same image to detect edges. This parameter controls the spatial extent of the gaussian blur used in the edge detection. Try increasing this value if you want a stronger detection of the fringes or the thickness of the fringe edges is too high. threshold The threshold over which a pixel is counted as a “fringe”. Try lowering this value if there is not enough fringe detected and increasing it if too many pixels are desaturated. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/defringe/","tags":null,"title":"(deprecated) defringe"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module or the exposure module with a drawn mask.\nLocally modify exposure based on pixel lightness.\nThis module pushes exposure by increasing lightness with a Gaussian curve of a specified width, centered on a given lightness.\n🔗module controls exposure The fill-light exposure (EV) center The median lightness impacted by the fill-light. The lightness must be set manually but a picker can be used to provide a guide based on a sample from the image. The lightness of the selected point/area is displayed in the gradient bar. width The width of the Gaussian curve. This number is expressed in zones, with the full range being 10 zones. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/fill-light/","tags":null,"title":"(deprecated) fill light"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the filmic rgb module instead.\nCompress the tonal range of an HDR image into the limited tonal range of a typical LDR output file.\nGlobal tonemap processes each pixel of an HDR image, without taking the local surrounding into account. This is generally faster than local tone mapping (deprecated), but might lead to less convincing results with very high-dynamic-range scenes.\n🔗module controls operator The operator to use. Reinhard, Filmic and Drago global tonemap operators are available. Depending on the selected operator, different parameters can be adjusted. Some operators are fully self-adjusting, and do not require specific controls.\nbias (Drago operator only) This parameter influences the contrast of the output image. It is an essential parameter for adjusting the compression of high values and the visibility of details in dark areas. A value of 0.85 is recommended as a starting point. target (Drago operator only) A scale factor to adjust the global image brightness to the brightness of the intended display. It is measured in cd/m, and should match the brightness of your output device. Higher values lead to a brighter image, while lower values lead to a darker image. detail (all operators) This parameter controls how much detail is preserved from the original input image and transferred back into the output image after tonemapping. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/global-tonemap/","tags":null,"title":"(deprecated) global tonemap"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the negadoctor module instead.\nInvert scanned negatives.\n🔗module controls color of film material Clicking on the colored field will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define an RGB color. You can also activate the picker to take a color probe from your image – preferably from the unexposed border of your negative. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/invert/","tags":null,"title":"(deprecated) invert"},{"categories":null,"content":" Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the rgb levels module instead.\nAdjust black, white and mid-gray points.\nThe levels tool offers two modes of operation:\nmanual The levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in absolute values of image lightness (the L value from Lab). Moving the black and white bars to match the left and right borders of the histogram will make the output image span the full available tonal range, increasing the image\u0026rsquo;s contrast.\nMoving the middle bar will modify the mid-tones. Move it to the left to make the image look brighter and move it to the right to make it darker. This is often referred to as changing the image\u0026rsquo;s gamma.\nThree pickers are available for sampling the black, white and gray points from the image. The \u0026ldquo;auto\u0026rdquo; button auto-adjusts the black and white point and puts the gray point exactly in the mean between them.\nautomatic The module automatically analyses the histogram of the image, detects the left and right histogram borders, and lets you define the black point, the gray point and the white point in terms of percentiles relative to these borders. Note: Under certain conditions, especially with highly saturated blue light sources, the levels module may produce black pixel artifacts. See the \u0026ldquo;gamut clipping\u0026rdquo; option of the input color profile module for information about how to mitigate this issue.\n🔗module controls mode The mode of operation (automatic or manual). black (automatic mode only) The black point in percentiles relative to the left border of the histogram. gray The gray point in percentiles relative to the left and right borders of the histogram after having applied the black point and white point corrections. white The white point in percentiles relative to the right border of the histogram. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/levels/","tags":null,"title":"(deprecated) levels"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the \u0026ldquo;cloning\u0026rdquo; tool in the retouch module instead.\nCorrect areas of an image (the target) using details from another area of the image (the source).\nThis module uses some of the shapes that are available for drawn masks (circles, ellipses and paths), and the user interface is similar.\nTo use this module, first select the desired shape by clicking the corresponding shape icon (Ctrl+click to enable continuous shape creation mode). Next, you may optionally choose the source for the correction by using Shift+Ctrl+click or Shift+click on the image canvas to choose absolute or relative mode, respectively (see below). Finally click on the canvas to choose the area to be healed (the target area). A cross is displayed where the source area will be positioned.\nThe source positioning has two modes\nabsolute mode Before placing a shape on the image canvas, Shift+Ctrl+click on the desired position for the source. From this point on, all new shapes will have their source created at the same absolute position (in image co-ordinates). relative mode Before placing a shape on the image canvas, Shift+click on the desired position for the source. The current shape will have the source created at that position and subsequent shapes will have their source created at the same position, relative to the target shape. After creation the source and target areas of each shape can be shifted independently until the result matches your expectations. An arrow points from the source area of each shape to its target.\nUse the shape-specific controls to adjust each shape\u0026rsquo;s size, border width, and other attributes.\nRight-click on a shape to delete it.\nThis module is equivalent to the \u0026ldquo;cloning\u0026rdquo; tool in the retouch module; see the description of the cloning tool for additional details and examples. If spot removal produces unsatisfactory results, you may want to try the \u0026ldquo;heal\u0026rdquo; tool in retouch instead.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/spot-removal/","tags":null,"title":"(deprecated) spot removal"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module instead.\nCompress the tonal range of HDR images so that they fit into the limits of an LDR image, using Durand\u0026rsquo;s 2002 algorithm.\nThe underlying algorithm uses a bilateral filter to decompose an image into a coarse base layer and a detail layer. The contrast of the base layer is compressed, while the detail layer is preserved, then both layers are re-combined.\n🔗module controls contrast compression The contrast compression level of the base layer. A higher compression will make the image fit a lower dynamic range. spatial extent The spatial extent of the bilateral filter. Lower values cause the contrast compression to have stronger effects on image details. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/tone-mapping/","tags":null,"title":"(deprecated) tone mapping"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the vibrance control in the color balance rgb module instead.\nSaturate and reduce the lightness of the most saturated pixels to make the colors more vivid.\n🔗module controls vibrance The amount of vibrance to apply to the image. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/vibrance/","tags":null,"title":"(deprecated) vibrance"},{"categories":null,"content":" Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer or multiple instances of the exposure module with parametric masks to narrow down on a zone.\nAdjust the lightness of an image using Ansel Adams\u0026rsquo; zone system.\nThe lightness of the image (the L channel in Lab color space) is divided into a number of zones ranging from pure black to pure white. These zones are displayed in a zonebar beneath a preview image. The number of zones can be changed by mouse-scrolling on that bar (default 10 zones).\nThe zonebar is split horizontally with the lower part showing the zones of the module\u0026rsquo;s input and the upper part the zones of the module\u0026rsquo;s output. In its default state both parts are fully aligned. While the output zones are static you can left click and drag a control point in the input zones to modify the mapping between input and output.\nShifting a control point proportionally expands the zones on one side and compresses the zones on the other side of that point. All pre-existing control points stay in place, effectively preventing changes to the zones beyond the next control point. Use right click to remove a control point.\nThe preview image above the zonebar shows how the image\u0026rsquo;s zones are broken down. When hovering above a zone, that zone – either from input or output – is highlighted in yellow on the preview image.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/processing-modules/zone-system/","tags":null,"title":"(deprecated) zone system"},{"categories":null,"content":"At startup, darktable will automatically run the Lua scripts $DARKTABLE/share/darktable/luarc and $HOME/.config/darktable/luarc (where $DARKTABLE represents the darktable installation directory and $HOME represents your home directory).\nThis is the only time darktable will run Lua scripts by itself. These scripts can register callbacks to perform actions on various darktable events. This callback mechanism is the primary method of triggering lua actions.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/basic-principles/","tags":null,"title":"basic principles: luarc files"},{"categories":null,"content":"Blend modes define how the input and output of a module are combined (blended) together before the module\u0026rsquo;s final output is passed to the next module in the pixelpipe.\nClassic blending modes, designed for display-referred RGB (constrained to 0-100%), implicitly define a fulcrum at 50% (gray) or 100% (white) in their algorithms, depending on the blend mode. Because scene-referred is not subject to these restrictions, this fulcrum needs to be explicitly defined by the user when performing blending operations in the \u0026ldquo;RGB (scene)\u0026rdquo; color space. The additional blend fulcrum parameter will be presented to the user when using one of these blend modes in this color space. The effect depends on the operator used. For example, values above the fulcrum might be brightened and values below darkened, or vice versa.\nThe final output of a module is computed \u0026lsquo;per-pixel\u0026rsquo; as follows:\nfinal_output = (1.0 - opacity) * module_input + opacity * blended_output where the blended_output is a combination of the input and output images, depending on the blend mode (below), and the opacity is defined \u0026lsquo;per-pixel\u0026rsquo; by a combination of the mask and global opacity parameter. An opacity of 0% outputs an image that is identical to the input image of the module.\nThe \u0026ldquo;reverse\u0026rdquo; button effectively reverses the roles of the input and output images in the \u0026lsquo;per-pixel\u0026rsquo; computation:\nfinal_output = (1.0 - opacity) * module_output + opacity * blended_input where the blended_input is a combination of the output and input images, depending on the blend mode below where output and input image references are reversed. In \u0026ldquo;reversed\u0026rdquo; blend modes, an opacity of 0% outputs an image that is identical to the output image of the module.\n🔗normal modes normal The most commonly used blend mode, \u0026ldquo;normal\u0026rdquo; simply mixes input and output to an extent determined by the opacity parameter. This mode is commonly used to reduce the strength of a module\u0026rsquo;s effect by reducing the opacity. This is also usually the blend mode of choice when applying a module\u0026rsquo;s effect selectively with masks. This mode is also known as the \u0026ldquo;over\u0026rdquo; Porter-Duff alpha blending operator (see alpha compositing for more details). normal bounded not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space This blend mode is the same as “normal”, except that the input and output data are clamped to a particular min/max value range. Out-of-range values are effectively blocked and are not passed to subsequent modules. Sometimes this helps to prevent artifacts. However, in most cases (e.g. highly color-saturated extreme highlights) it is better to let unbound values travel through the pixelpipe to be properly handled later. The “normal” blend mode is therefore usually preferred. 🔗arithmetic modes addition Add together the pixel values of the input and output images, lightening the output. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, the pixel values of the output image are multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. subtract Subtract the pixel value of the output from the input. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, the pixel values of the output image are multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. Pixel values less than 0 are set to 0. multiply Multiply the pixel values of the input and output together. When blending in display-referred color spaces, pixel values are between 0 and 1.0, the final output will be clamped and will always be darker. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, this value is further multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. In this case, values may be greater than 1.0 and therefore brighten the base image. This may have other side-effects, such as updating the white point in the filmic module. Multiply blending simulates an optical variable density filter, where the density is defined by the output of the module. It has many applications, from blooming and local contrast enhancements (when used with a blur or low-pass filter) to dodging/burning and global contrast enhancements (when used with exposure). The fulcrum sets the output intensity threshold between darkening and brightening (any RGB value below fulcrum will darken).\ndivide Divide the pixel values of the input by the output. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, the pixel values of the output image are multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. Since this is the inverse of the multiply mode, it will darken where multiply brightens and vice versa. Everything else works in essentially the same way.\nscreen not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space Invert the input and output pixel values, multiply those values together and invert the result. This yields approximately the opposite effect to \u0026ldquo;multiply\u0026rdquo; mode \u0026ndash; the resulting image is usually brighter, and sometimes “washed out” in appearance. average Return the arithmetic mean of the input and output pixel values. difference Return the absolute difference between the input and output pixel values. geometric mean Return the square root of the product of the input and output pixel values. harmonic mean Return the product of the input and output pixel values, multiplied by 2 and divided by their sum. 🔗contrast enhancing modes The following modes are not available in the \u0026ldquo;RGB (scene)\u0026rdquo; blending color space as they rely on an assumption of \u0026ldquo;50% mid gray\u0026rdquo; which only applies to display-referred and non-linear color spaces. In addition, they clamp pixel values of both input and output images as the underlying math is not valid outside the range 0..1, and can thus cause visible changes anywhere in the image. To avoid these, you will need to ensure that the module\u0026rsquo;s input does not exceed the display-referred range.\noverlay This mode combines the \u0026ldquo;multiply\u0026rdquo; and \u0026ldquo;screen\u0026rdquo; blend modes: The parts of the input where the output is brighter, become brighter; The parts of the image where the output is darker, become darker; Mid-gray is unaffected. This mode is often combined with the lowpass and highpass modules. softlight This mode is similar to \u0026ldquo;overlay\u0026rdquo;, except the results are softer and less bright. As with overlay, it is often combined with the lowpass and highpass modules. hardlight This mode is not related to \u0026ldquo;softlight\u0026rdquo; in anything but name. Like overlay mode it is a combination of \u0026ldquo;multiply\u0026rdquo; and \u0026ldquo;screen\u0026rdquo; modes and has a different effect above and below mid-gray. The results with hardlight blend mode tend to be quite intense and usually need to be combined with a reduced opacity. vividlight This mode is an extreme version of overlay/softlight. Values darker than mid-gray are darkened; Values brighter than mid-gray are brightened. You will probably need to tone down its effect by reducing the opacity linearlight This mode is similar to the effect of \u0026ldquo;vividlight\u0026rdquo;. pinlight This mode performs a darken and lighten blending simultaneously, removing mid-tones. It can result in artifacts such as patches and blotches. 🔗color channel modes 🔗Lab channels The following are available for blending in the Lab color space only\nLab lightness Mix the lightness from the input and output images, while taking the color channels (a and b) unaltered from the input image. In contrast to “lightness” this blend mode does not involve any color space conversion and does not clamp any data. In some cases this blend mode is less prone to artifacts than “lightness”. Lab a-channel Mix the Lab \u0026ldquo;a\u0026rdquo; color channel from the input and output images, while taking the other channels unaltered from the input image. Lab b-channel Mix the Lab \u0026ldquo;b\u0026rdquo; color channel from the input and output images, while taking the other channels unaltered from the input image. Lab color Mix the Lab color channels (a and b) from the input and output images, while taking the lightness unaltered from the input image. In contrast to “color” this blend mode does not involve any color space conversion and does not clamp any data. In some cases this blend mode is less prone to artifacts than “color”. 🔗RGB channels The following are available when blending in RGB color spaces only.\nRGB red channel Mix the \u0026ldquo;red\u0026rdquo; channel from the input and output images, while taking the other channels unaltered from the input image. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, the \u0026ldquo;red\u0026rdquo; channel from the output image is multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. RGB green channel Mix the \u0026ldquo;green\u0026rdquo; channel from the input and output images, while taking the other channels unaltered from the input image. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, the \u0026ldquo;green\u0026rdquo; channel from the output image is multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. RGB blue channel Mix the \u0026ldquo;blue\u0026rdquo; channel from the input and output images, while taking the other channels unaltered from the input image. When blending in the \u0026ldquo;RGB (scene)\u0026rdquo; color space, the \u0026ldquo;blue\u0026rdquo; channel from the output image is multiplied by a value proportional to the \u0026ldquo;blend fulcrum\u0026rdquo;. 🔗HSV channels The following are available when blending in the \u0026ldquo;RGB (display)\u0026rdquo; color space only.\nHSV value Mix the lightness from the input and output images, while taking color unaltered from the input image. In contrast to “lightness” this blend mode does not involve clamping. HSV color Mix the color from the input and output images, while taking lightness unaltered from the input image. In contrast to “color” this blend mode does not involve clamping. 🔗others lightness Mix lightness from the input and output images, while taking color (chromaticity and hue) unaltered from the input image. chromaticity Mix chromaticity from the input and output images, while taking lightness and hue unaltered from the input image. This blend mode uses RGB ratios, divided by a Euclidean norm. lighten not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space Compare the pixel values of the input and output images, and output the lighter value. darken not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space Compare the pixel values of the input and output images, and output the darker value. hue not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space Mix hue (color tint) from the input and output images, while taking lightness and chroma unaltered from the input image. color not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space Mix color (chroma and hue) from the input and output images while taking lightness unaltered from the input image. Caution: When modules drastically modify hue (e.g. when generating complementary colors) this blend mode can result in strong color noise.\ncoloradjustment not available in the \u0026ldquo;RGB (scene)\u0026rdquo; color space Some modules act predominantly on the tonal values of an image but also perform some color saturation adjustments (e.g. the levels and tone curve modules). This blend mode takes the lightness from the module\u0026rsquo;s output and mixes colors from input and output, enabling control over the module\u0026rsquo;s color adjustments. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/blend-modes/","tags":null,"title":"blend modes"},{"categories":null,"content":"A collection is a set of images matching a given selection criteria.\nThe most basic kind of collection is a film roll, which contains all of the images that have been imported from a specific folder on disk. Whenever you import images from the filesystem, those images are organized in a film roll whose name is derived from that of their parent folder.\nYou can easily construct other kinds of collection based on various image attributes (Exif data, filename, tags etc.) in the collections module. Multiple criteria can be logically combined to narrow or extend your collection.\ndarktable retains a list of the most recently used collections for quick access. These can be accessed from the recent collections module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/digital-asset-management/collections/","tags":null,"title":"collections \u0026 film rolls"},{"categories":null,"content":"🔗left panel From top to bottom:\nnavigation Navigate and zoom the center view. snapshots Take and view snapshots for comparison with the current edit. duplicate manager View and manage duplicates. global color picker Select and display color information taken from parts of the image. tagging Manage tags. image information Display information about the current image. mask manager View and edit drawn shapes. export Export selected images to local files or external services. 🔗right panel From top to bottom:\nscopes A graphical depiction of the image\u0026rsquo;s light levels and colors. This module can be moved to the left-hand panel if desired (see preferences \u0026gt; miscellaneous \u0026gt; position of the scopes module). module groups Select module groups (if enabled). search module Search for a module (if enabled). processing modules The modules used to process an image. module order Choose the order in which processing modules are executed in the pixelpipe. 🔗bottom panel From left to right:\npresets Quick access menu for module presets. You can manage the contents of this menu by selecting \u0026ldquo;manage quick presets list\u0026hellip;\u0026rdquo;. styles Quick access menu for styles. Hover over a style name with your mouse to show a preview of the current darkroom image with the selected style applied. second darkroom window For multi-monitor setup, allows the user to display a second image on another screen. focus peaking Toggle focus peaking mode. color assessment Toggle the ISO12646 color assessment view. high quality processing Toggle high quality processing mode. raw overexposed warning Toggle raw overexposed indicators (right-click for options). clipping warning Toggle clipping warnings (right-click for options). soft proof Toggle softproofing overlays (right-click for options). gamut check Toggle gamut checking (right-click for options). guides \u0026amp; overlays Left-click to switch global guide overlays on/off and right-click to change the guide settings, including the color of all on-image drawing (masks, crop guides etc.) You can also enable the filmstrip module at the bottom of the screen to allow you select and interact with the currently selected collection in the lighttable view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/darkroom-view-layout/","tags":null,"title":"darkroom view layout"},{"categories":null,"content":"The darktable-cli binary starts the command line interface variant of darktable which allows images to be exported.\nThis variant does not open any display \u0026ndash; it works in pure console mode without launching a GUI. This mode is particularly useful for servers running background jobs.\ndarktable-cli can be called with the following command line parameters:\ndarktable-cli [\u0026lt;input file or folder\u0026gt;] [\u0026lt;xmp file\u0026gt;] \u0026lt;output file or folder\u0026gt; [--width \u0026lt;max width\u0026gt;] [--height \u0026lt;max height\u0026gt;] [--hq \u0026lt;0|1|true|false\u0026gt;] [--upscale \u0026lt;0|1|true|false\u0026gt;] [--style \u0026lt;style name\u0026gt;] [--style-overwrite] [--apply-custom-presets \u0026lt;0|1|false|true\u0026gt;] [--out-ext \u0026lt;extension\u0026gt;] [--import \u0026lt;file or dir\u0026gt;] [--icc-type \u0026lt;type\u0026gt;] [--icc-file \u0026lt;file\u0026gt;] [--icc-intent \u0026lt;intent\u0026gt;] [--verbose] [--help [option]] [--core \u0026lt;darktable options\u0026gt;] The user must supply an input filename and an output filename. All other parameters are optional.\n\u0026lt;input file or folder\u0026gt; The name of the input file or folder (containing images) to be exported. If you wish to process multiple images or multiple folders use the --import option instead. \u0026lt;xmp file\u0026gt; The optional name of an XMP sidecar file containing the history stack data to be applied during export. If this option is not provided darktable will search for an XMP file that belongs to the given input file(s). \u0026lt;output file or folder\u0026gt; The name of the output file or destination folder. The export file format is derived from the file extension or from the --out-ext option. You can also use a number of variables in the output filename. For obvious reasons this parameter is mandatory if you use the program on an image folder containing multiple images. If you specify output folder it is recommended that you also specify the file format with --out-ext. --width \u0026lt;max width\u0026gt; Limit the width of the exported image to the given number of pixels. --height \u0026lt;max height\u0026gt; Limit the height of the exported image to the given number of pixels. --hq \u0026lt;0|1|true|false\u0026gt; Define whether to use high quality resampling during export (see the export module reference for more details). Defaults to true. --upscale \u0026lt;0|1|true|false\u0026gt; Define whether allow upscaling during export. Defaults to false. --style \u0026lt;style name\u0026gt; Specify the name of a style to be applied during export. If a style is specified, the path to the darktable configuration directory must also be specified (i.e. --core --configdir ~/.config/darktable). By default no style is applied. --style-overwrite The specified style overwrites the history stack instead of being appended to it. --apply-custom-presets \u0026lt;0|1|false|true\u0026gt; Whether to load data.db which contains presets and styles. Disabling this option allows you to run multiple instances of darktable-cli at the cost of being unable to use the --style option. Defaults to true. --out-ext \u0026lt;extension\u0026gt; Set the export file format to use derived from the extension (jpg, tif, jxl). If specified takes precedence over \u0026lt;output file\u0026gt;. By default this is extracted from \u0026lt;output file\u0026gt;. Defaults to jpg if \u0026lt;output folder\u0026gt; is specified. Note: the extension used in the export filename is predetermined by the export format and not adjustable. --import \u0026lt;file or dir\u0026gt; Specify input file or folder, can be used multiple times. This option cannot be combined with \u0026lt;input file or folder\u0026gt;. --icc-type \u0026lt;type\u0026gt; Specify the ICC profile type, which is the same as specifying the \u0026ldquo;output profile\u0026rdquo; in the output color profile module. Defaults to \u0026ldquo;image specified\u0026rdquo;. Use --help icc-type to obtain a list of the supported types. See the output color profile module reference for a more detailed description of the available options. --icc-file \u0026lt;file\u0026gt; Specify the ICC profile filename. Defaults to an empty filename. --icc-intent \u0026lt;intent\u0026gt; Specify the rendering intent. Defaults to \u0026ldquo;image specified\u0026rdquo;. Use --help icc-intent to obtain a list of the supported intents. See rendering intent for a more detailed description of the available options. --verbose Enables verbose output. --help [option] Prints usage and exits. If option is specified, additionally prints usage for the given option. --core \u0026lt;darktable options\u0026gt; All command line parameters following --core are passed to the darktable core and handled as standard parameters. See the darktable binary section for a detailed description. 🔗export options Export options for darktable are defined as configuration items, set from within the export module. There are two ways to alter this configuration when using darktable-cli, as described below.\n🔗use the export module The darktable-cli command will use the last format configuration used in the export module, when run in interactive (gui) mode. You may therefore manually set your desired format options in the darktable gui and then run darktable-cli to export your files.\n🔗pass options on the command-line You can set any export format configuration option using the following syntax:\n--core --conf plugins/imageio/format/\u0026lt;FORMAT\u0026gt;/\u0026lt;OPTION\u0026gt;=\u0026lt;VALUE\u0026gt; where \u0026lt;FORMAT\u0026gt; is the name of the desired output format and \u0026lt;OPTION\u0026gt; is any configuration option for that format.\nAn option set in this way will not be permanently stored but will be used just for this run of darktable-cli.\nThe following sections describe the configuration options/values that are available for each export format:\n🔗jpeg quality The compression quality (5 - 100) 🔗j2k (jpg2000) format The format of the output 0: J2K 1: jp2 quality The compression quality (5 - 100) preset The DCP mode 0: Cinema2K, 24 FPS 1: Cinema2K, 48 FPS 2: Cinema4K, 24 FPS 🔗exr (OpenEXR) bpp The bit depth (16 or 32) compression The compression type 0: uncompressed 1: RLE 2: ZIPS 3: ZIP 4: PIZ 5: PXR24 6: B44 7: DWAA 8: DWAB 🔗pdf title The title of the pdf (any character) size The size of the pdf (a4, a3, letter, legal) orientation the paper orientation of the pdf 0: portrait 1: landscape border The empty space around the pdf; format: size (a number) + unit; examples: 10 mm, 1 inch dpi The resolution in dots per inch inside the pdf (1 - 5000) rotate Whether to rotate the pdf (0 or 1) icc Whether to embed an icc profile (0 or 1) bpp The bit depth (8 or 16) compression Whether to compress the pdf (0 or 1) mode The mode to put the images in the pdf 0: normal: just put the images into the pdf 1: draft: images are replaced with boxes 2: debug: only show the outlines and bounding boxen 🔗pfm No options provided.\n🔗png bpp The bit depth (8 or 16) compression The compression level (0 - 9) 🔗ppm No options provided.\n🔗tiff bpp The bit depth (8, 16, 32) compress The compression type 0: uncompressed 1: deflate 2: deflate with predictor compresslevel The compression level (0 - 9) shortfile B\u0026amp;W or color image 0: write rgb colors 1: write grayscale 🔗webp comp_type The compression type 0: lossy 1: lossless quality the compression quality (5 - 100) hint The preferred way to manage the compression 0: default 1: picture: digital picture, like portrait, inner shot 2: photo: outdoor photograph, with natural lighting 3: graphic: discrete tone image (graph, map-tile etc) 🔗copy No options provided.\n🔗xcf bpp The bit depth (8, 16, 32) 🔗JXL bpp The bit depth (8, 10, 12, 16, 32) pixel_type Boolean whether the (16 bit) pixel type is unsigned integer or floating point 0: unsigned integer 1: floating point quality Integer (4-100): the quality of the image, roughly corresponding to JPEG quality (100 is lossless) original Boolean whether to encode using the original color profile or the internal XYB one 0: internal 1: original effort Integer between 1-9. Effort with which to encode output; higher is slower (default is 7) tier Integer between 0-4. Higher value favors decoding speed vs quality (default is 0) ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/darktable-cli/","tags":null,"title":"darktable-cli"},{"categories":null,"content":"For darktable to faithfully render colors on screen it needs to find the correct display profile for your monitor. In general this requires your monitor to be properly calibrated and profiled, and it needs the profile to be correctly installed on your system. darktable queries your X display server\u0026rsquo;s xatom as well as the system service colord (if available) for the right profile. If required you can enforce a specific method in preferences \u0026gt; miscellaneous.\nTo investigate your display profile configuration you can run the darktable-cmstest binary (Linux only) which prints out useful information (e.g. profile name per-monitor) and tells you if the system is correctly configured.\nIn rare cases you may need to manually select the display profile. This is possible from within the soft proof and gamut check option dialogs in the darkroom view and the display profile dialog in the lighttable view.\nBear in mind that high-tier consumer-grade screens usually don\u0026rsquo;t need a user-made display profile unless you need to perform soft-proofing with professional expectations, since they are properly calibrated to sRGB in the factory.\nA poorly-made display profile will be more harmful than sticking to the default sRGB profile, since the default might be slightly inaccurate but will at least be reliable. Advanced and professional users are advised to proceed with the production of custom display profiles only if they have the training to assess the quality of the resulting profile and understanding of the profiling options.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/display-profile/","tags":null,"title":"display profile"},{"categories":null,"content":"With the drawn mask feature you can construct a mask by drawing shapes directly onto the image canvas. Shapes can be used alone or in combination. Once a shape has been drawn on an image it can be adjusted, removed, or reused in other modules.\nShapes are stored internally as vectors and are rendered with the required resolution during pixelpipe processing. Shapes are expressed in the coordinate system of the original image and are transformed along with the rest of the image by any active distorting modules in the pipe (lens correction, rotate and perspective for example). This means that a shape will always work on the same image area regardless of any modifications that may be subsequently applied.\nThe controls required to create and alter drawn masks may be enabled by selecting either the \u0026ldquo;drawn mask\u0026rdquo; or \u0026ldquo;drawn \u0026amp; parametric mask\u0026rdquo; icon at the bottom of a module. You can also create and edit shapes using the mask manager module.\n🔗creating shapes Choose a shape by clicking on the appropriate shape icon (from left to right: circle, ellipse, path, brush, gradient).\nThis will take you into the creation mode for that shape. Once you have finished drawing your shape you will automatically be taken into edit mode.\nCtrl+click on the shape icon to continuously draw multiple shapes of the same type \u0026ndash; each time a shape is completed, you will re-enter creation mode for a new instance of that shape. While in continuous creation mode, right-click on the image to stop drawing shapes and enter edit mode.\nFor all drawn shapes, you can hold Shift while scrolling with the mouse wheel to change the extent of the shape\u0026rsquo;s feathering (the blur at the edge of the shape) and use Ctrl+scroll to change the shape\u0026rsquo;s opacity (how transparent it is). These operations are available in both creation and edit modes (as long as your mouse is over the shape in question).\nBy default, scrolling your mouse up increases the value of the relevant shape parameters. This behavior can be changed in preferences \u0026gt; darkroom \u0026gt; scroll down to increase mask parameters.\nNote: When used in shape creation mode, the preceding scroll operations will also cause the default feathering or opacity to be changed. The new default values will be used the next time you create a new shape.\n🔗editing shapes Click on the \u0026lsquo;show and edit mask elements\u0026rsquo; icon to enter shape edit mode. This will show all drawn masks in use by the current module and allow you to edit those shapes. It will also expand the associated group in the mask manager. Ctrl+click on the same icon to enter restricted edit mode, where certain actions (e.g. dragging a complete shape or changing its size) are blocked. This is particularly useful to avoid costly mistakes when editing path and brush shapes.\nClick and drag a shape to move it around the image canvas. Clicking on a shape will also select that shape in the mask manager.\n🔗removing shapes While in edit mode right-click on a shape to remove it.\n🔗reusing shapes You can reuse shapes that you have drawn in other modules. Click on the shapes drop-down (next to the \u0026lsquo;show and edit mask elements\u0026rsquo; button) to choose previously-drawn shapes individually or to use the same group of shapes as used by another module. The following options are available for selection:\nadd existing shape Choose either an individual shape or a group of shapes that you\u0026rsquo;ve drawn previously (either within the mask manager or from within the drawn mask of another module). If that shape or group is used elsewhere, any changes you make will be reflected everywhere the shape or group is used. use same shapes as Add a list of shapes used in another module to the current module\u0026rsquo;s mask. This differs from the previous option in that it creates a new group of shapes, allowing shapes to be added to or removed from the group independently of the module from which they were copied. All shapes that are common to both groups remain linked. 🔗combining and managing shapes The mask manager module can be used to manage your drawn shapes. This module also allows you to group and combine drawn masks using set operators (union, intersection, difference, exclusion).\n🔗shape distortions In order to ensure a consistent co-ordinate system, when you place a shape on the image, it is actually drawn on the original RAW file. This shape then passes up through the pixelpipe before finally being used by the module and drawn on the screen. This means that, if you have any enabled any distorting modules (such as lens correction), drawn shapes may appear distorted on the screen and in the final image. This can lead, for example, to circles being rendered as ellipses and gradient lines becoming curved. If you need to create a more accurate shape (to overcome these distortions) it is recommended that you avoid using the simple shapes (circles / ellipses) in favor of the path shape (which can be drawn using more points, reducing distortions). You can adjust the curve on gradient lines to overcome the simple distortions introduced by lens correction.\n🔗available shapes circle Click on the image canvas to place the circle. Scroll while hovering over the circle to change its diameter. Scroll while hovering over the circle\u0026rsquo;s border to change the width of the feathering (the same effect as holding Shift while scrolling with the mouse wheel within the main shape). ellipse The general principle is the same as for the circle shape. In addition, four nodes are shown on the ellipse line. Click and drag the nodes to adjust the ellipse\u0026rsquo;s eccentricity. Ctrl+click and drag the nodes or use Shift+Ctrl+scroll (with the mouse wheel) to rotate the ellipse. Shift+click within the shape to toggle the gradual decay between equidistant and proportional mode. path Click on the image canvas to place three or more nodes and generate a free-format enclosed shape. Terminate the path by right-clicking after having set the last point. By default, nodes are connected with smooth lines. If you want a node to instead define a sharp corner, you can do so by creating it with Ctrl+click. In edit mode Ctrl+click on an existing node to convert it from smooth to sharp corners and vice versa. Ctrl+click on one of the line segments to insert an additional node. Right-click on a node to delete it. Take care to ensure that the mouse pointer is over the desired node and the node is highlighted, to avoid accidentally removing the whole path.\nThe size of the completed shape can be modified by scrolling. The same holds true for the width of the border (the area with a gradual opacity decay), which can also be changed with Shift+scroll (with the mouse wheel) from anywhere within the shape. Single nodes as well as path segments can be moved by dragging them with the mouse. If a node is selected by clicking on it, a further control point appears which allows you to modify the curvature of the line (reset to default by right-clicking). Dragging one of the control points on the border adjusts the border width just in that part of the shape.\nConsider fine-tuning paths in restricted edit mode (enabled by Ctrl+clicking on the \u0026lsquo;show and edit mask elements\u0026rsquo; icon). This allows you to adjust single nodes and segments without the risk of accidentally shifting or resizing the whole shape.\nbrush Start drawing a brush stroke by left-clicking on the image canvas and moving the mouse while keeping the button pressed. The brush stroke is finalized once you release the mouse button. Scroll the mouse to change the shape size and Shift+scroll to change the feathering (hardness), either before you start drawing or at any time during the operation. Likewise you can use the \u0026ldquo;{\u0026rdquo; and \u0026ldquo;}\u0026rdquo; keys to decrease/increase hardness, and the \u0026ldquo;\u0026lt;\u0026rdquo; and \u0026ldquo;\u0026gt;\u0026rdquo; keys to decrease/increase opacity. If you have a graphics tablet with pen pressure sensitivity, darktable can apply the recorded pen pressure to certain attributes of the brush stroke. This operation can be controlled in preferences \u0026gt; darkroom \u0026gt; pen pressure control for brush masks.\nOn lifting the tablet pen or releasing the left mouse button the brush stroke is converted into a number of connected nodes, which define the final shape. A configuration option (preferences \u0026gt; darkroom \u0026gt; smoothing of brush strokes) controls how much smoothing is applied. A higher level of smoothing leads to fewer nodes being created – this eases subsequent editing at the expense of lower accuracy.\nNodes and segments of a brush stroke can be modified individually. See the documentation on path shapes (above) for more details. Change the size or hardness of a node by scrolling and Shift+scrolling over a node, respectively.\nNote: Rendering a complex brush shape can consume a significant number of CPU cycles. Consider using the circle, ellipse or path shapes instead where possible.\ngradient The gradient shape is a linear gradient which extends from a given point to the edge of the image. Click on the image canvas to define the position of the line that defines 50% opacity. Dotted lines indicate the distance beyond which the opacity is 100% and 0%. Between these dotted lines the opacity changes linearly.\nThe line has two anchor nodes which you can drag to change the rotation of the gradient. You can also set the rotation angle when placing the gradient shape by clicking and dragging to place the shape.\nGradient lines can also be curved by scrolling with your mouse while hovering close to the center line. This can be useful to counteract the distortion caused by the lens correction module.\nDepending on the module and the underlying image, using a gradient shape might provoke banding artifacts. You should consider activating the dither or posterize module to alleviate this.\n🔗reversing the polarity of a drawn mask Click on the \u0026ldquo;+/-\u0026rdquo; button to reverse the polarity of the entire drawn mask. For example, a circular mask will, by default, cause the module to be applied only to the area inside the drawn circle. Reversing its polarity will cause the module to apply to the whole image, except for that circle.\n🔗panning and zooming the image While creating or editing a shape, mouse actions are applied to the current shape. If you need to move or zoom the portion of the image shown in the center view, hold down the \u0026lsquo;a\u0026rsquo; key while dragging the mouse or using the scroll wheel. While the key is held down, the mouse actions will apply to the entire image rather than the current shape.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/masks/drawn/","tags":null,"title":"drawn masks"},{"categories":null,"content":"Control the overall look and feel of darktable.\ninterface language Set the language of the user interface. This includes the option to enable sentence case (en@truecase) for English. The system default is marked with an * (needs a restart) theme Set the theme for the user interface. Aside from any aesthetic considerations, the recommended interface color for color evaluation is middle gray. Visual perception is affected by ambient brightness, and a low user interface brightness causes all kinds of illusions. Using a dark interface to retouch photos can therefore lead to excessive retouching (abuse of contrast and saturation) and to a photo that is too dark when printed. It is therefore highly recommended that you use one of the \u0026ldquo;grey\u0026rdquo; themes for retouching work as these are designed so that the user interface approximates middle gray (default \u0026ldquo;darktable-elegant-grey\u0026rdquo;). use system font size Select this option to use the font size defined by your system. If unchecked, you may enter a custom font size in the box below (default on). font size in points If the \u0026ldquo;use system font size\u0026rdquo; option is switched off, enter a font size (in points) for darktable to use. The font size will be changed immediately. GUI controls and text DPI Adjust the global GUI resolution to rescale controls, buttons, labels, etc. Increase for a magnified GUI, decrease to fit more content in the window. Set to -1 to use the system-defined global resolution. The default is 96 DPI on most systems. (needs a restart) 🔗CSS theme modifications In addition to selecting a pre-built theme you can also apply additional CSS customizations of your own to tweak the look-and-feel of darktable.\nTwo different methods are provided for this:\ncreate a custom theme If you wish to make a large number of changes to darktable\u0026rsquo;s UI you may wish to create your own theme (in a .css file) and place it in $HOME/.config/darktable/themes (or C:\\%LOCALAPPDATA%\\darktable\\themes on Windows). Your new theme will automatically appear in the theme selection list the next time you restart darktable. Please note that the structure of darktable\u0026rsquo;s internal CSS changes frequently and you may need to make significant changes to your own themes when new versions of darktable are released. For this reason (among others) we do not recommend creating complex custom themes unless you are willing to devote a lot of time to ongoing maintenance. If your theme loads any of darktable\u0026rsquo;s pre-built themes using the @import url directive, note that your CSS theme file may not be portable between installations (@import url uses relative paths and the location of the pre-built themes is system-dependent).\ncreate theme tweaks A text box is provided at the bottom of the general tab within which you can enter your own CSS tweaks. When using this option, darktable will first load your selected theme (the \u0026ldquo;base\u0026rdquo; theme, chosen in the theme drop-down) and then apply your custom CSS on top. This means that you can easily make minor alterations to the look-and-feel, while still keeping mostly up-to-date with core theme changes when a new version of darktable is released. It also means that you can usually change your base theme without affecting your custom CSS tweaks. When you have finished entering your CSS, click the \u0026ldquo;save CSS and apply\u0026rdquo; button. This will save your CSS to $HOME/.config/darktable/user.css (or C:\\%LOCALAPPDATA%\\darktable\\user.css on Windows) and immediately apply it to the current darktable session.\nIf you notice any issues after applying your CSS, you can uncheck the \u0026ldquo;modify selected theme with CSS tweaks below\u0026rdquo; box to revert. This will immediately restore the base theme but will leave your tweaks in the editor so that you can re-edit them and try again. Simply press \u0026ldquo;save CSS and apply\u0026rdquo; again when you are ready to retry. This will automatically re-check the \u0026ldquo;modify selected theme with CSS tweaks below\u0026rdquo; checkbox and apply the new CSS.\nNote: If you have any issues while using custom CSS tweaks please retry with the \u0026ldquo;modify selected theme with CSS tweaks below\u0026rdquo; option unchecked to be certain that they were not caused by any of your alterations.\n🔗understanding darktable\u0026rsquo;s themes All of darktable\u0026rsquo;s pre-built themes are provided as CSS files in $DARKTABLE/share/darktable/themes/ (where $DARKTABLE is darktable\u0026rsquo;s installation directory). The darktable.css theme contains the bulk of the code used to control the look-and-feel of darktable. A number of other themes are also provided but most of them use darktable.css as a base (by importing darktable.css using the @import url directive).\nIf you choose to create your own custom theme file you are advised to follow a similar approach \u0026ndash; import one of darktable\u0026rsquo;s existing theme files using @import url (this directive expects relative paths) and then apply your own customizations on top. You do not need to do this when using the CSS text box in the preferences dialog \u0026ndash; attempting to use @import url in the CSS tweaks text box will not work correctly.\nThemes use the same basic CSS principles as in html browsers (with some minor exceptions \u0026ndash; see the Gtk documentation for details):\nThe majority of the style properties are assigned to broad groups of UI elements, for example, Gtk buttons and text entry fields Next, related groups of darktable-specific UI elements are given class names allowing them to be styled as a group Finally, some unique UI elements are assigned a CSS id so that they can be styled independently You are encouraged to explore the existing themes (darktable.css in particular is very well commented) and to make use of the Gtk Inspector tool to figure out how to select the specific UI element (or class of elements) you wish to modify. Some experimentation will be required.\nPlease note that darktable themes are grayscale by default in order that users not be distracted by strong colors while editing images. You are advised to retain this practice in your own themes and to keep the average shade as close to middle-gray as possible. In addition you are advised to review your custom CSS each time darktable is updated, to ensure that changes to the application have not adversely affected your tweaks.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/general/","tags":null,"title":"general"},{"categories":null,"content":"As you can imagine, the hardware architecture of GPUs can vary significantly. There are different manufacturers, and even different generations of GPUs from the same manufacturer may not be comparable. At the same time GPU manufacturers don\u0026rsquo;t normally disclose all the hardware details of their products to the public. One of the consequences of this is the need to use proprietary drivers under Linux, if you want to take full advantage of your graphics card.\nFortunately an industry consortium lead by The Khronos Group has developed an open, standardized interface called OpenCL, which allows your GPU to be used as a numerical processing device. OpenCL offers a C99-like programming language with a strong focus on parallel computing. An application that wants to use OpenCL will need OpenCL source code that it hands over to a hardware-specific compiler at run-time. This way applications can use OpenCL on different GPU architectures (even at the same time). All of the hardware “secrets” are hidden in this compiler and are normally not visible to the user (or the application). The compiled OpenCL code is loaded onto your GPU and \u0026ndash; with certain API calls \u0026ndash; it is ready to perform calculations for you.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/how-opencl-works/","tags":null,"title":"how OpenCL works"},{"categories":null,"content":"Before you can do anything in darktable you must first add some images files to the library using the import module in the lighttable view. This will create entries for your images in darktable\u0026rsquo;s library database so that it can keep track of the changes you make. There are three ways to import images, each accessible through buttons in the import module:\nadd to library This option adds images to the library without copying or moving \u0026ndash; your original files will stay in their current location and will not be altered. On import, darktable will read the metadata from the image files and any accompanying XMP sidecar file. If an image has already been added to the database, any updates you have made to the sidecar file will be loaded. copy \u0026amp; import Copies the images to the storage location (following the file naming pattern defined in preferences \u0026gt; import), then adds the copied images to the library \u0026ndash; the original images are not changed or moved. Only the images are copied and if an existing XMP sidecar file is available for the image, it will not be read, copied or used. copy \u0026amp; import from camera Connect the camera to your system with a USB cable (if your camera is auto-mounted by your system, you will need to un-mount it before it can be accessed by darktable). If you don\u0026rsquo;t see your camera listed in the import module, press the \u0026ldquo;scan for devices\u0026rdquo; button. Once your camera is detected the import module should offer the ability to copy \u0026amp; import images from the camera. Clicking the \u0026ldquo;copy \u0026amp; import\u0026rdquo; button physically copies the selected images from the camera into a specified directory (following the file naming pattern defined in preferences \u0026gt; import) and then adds the copied images to the library. Once images have been imported, their thumbnails are displayed in the lighttable view, within which you can organize and catalog your imported images \u0026ndash; please refer to the digital asset management section for more information.\nThe primary use for the lighttable view is to review your images and decide which you would like to edit further and which to discard. The following is a possible culling process to choose which images to edit/delete:\nSet the lighttable view to only show images with a rating of exactly 1 star using the view setting on the top panel. Since darktable assigns a 1 star rating to newly-imported images by default, this will show all of the images you have just imported. You can use the collections module to further refine your selection if needed. Perform a quick first-level screening of your images: If any images are badly out-of-focus or otherwise unwanted, reject them or give them a 0-star rating (by pressing the \u0026ldquo;R\u0026rdquo; or \u0026ldquo;0\u0026rdquo; keys, respectively, while hovering over the image with your mouse). If you would like an image to pass to the next review phase, press 2 to give it a 2 star rating. Any images that no longer have a 1 star rating will automatically disappear from view. Continue in this manner until no more images remain visible in the lighttable view. Alter the lighttable view to only show images with 2 stars. Go through these images more carefully, and decide whether to promote them to a 3 star rating, or put them back down to a lower rating. Again, proceed until no more images remain in the lighttable view. Alter the lighttable view to only show images with 3 stars. Perform quick edits and experiments on those images in the darkroom view to decide if they are worthy of further effort. If you are happy with the results of those edits, promote that image to a 4 star rating for final editing. Go through your 4 star images, perform any final edits on them and then export to see the final result. Increase the rating a final time to 5 stars to indicate that processing is complete. If space is at a premium you might consider permanently deleting your rejected or 0-star images. Select these images in the lighttable view and use the \u0026rsquo;trash/delete\u0026rsquo; option in the actions on selection module. You should only do this for images you are certain you will never need again.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/workflow/import-review/","tags":null,"title":"import \u0026 review"},{"categories":null,"content":"When importing an image, darktable automatically checks if it is accompanied by a sidecar file. As well as looking for files named \u0026lt;basename\u0026gt;.\u0026lt;extension\u0026gt;.xmp and \u0026lt;basename\u0026gt;_\u0026lt;number\u0026gt;.\u0026lt;extension\u0026gt;.xmp (darktable\u0026rsquo;s XMP file naming formats) darktable also checks for the presence of a file in the form \u0026lt;basename\u0026gt;.xmp (the naming format for Lightroom\u0026rsquo;s XMP sidecar files). Files with the latter naming format will be read by darktable but will not be written to. Once the image has been imported, darktable will generate an additional XMP file using its own naming convention.\nAt present, darktable is able to load the following metadata from Lightroom-generated sidecar files during the import process:\ntags (including hierarchical tags) color labels ratings GPS information In addition, darktable has been designed to help migrate some image operations from other specific applications. The aim here is not to make darktable a drop-in replacement for any other software, but rather to help you to recover part of the work you have already invested into your image. It is important to understand that the import process will never give identical results to other software. The underlying processing engines are very different from application to application, and depend a lot on the individual image. In some cases, the results may be similar but often, further adjustment will be required in darktable.\nThis migration happens automatically when entering the darkroom view, provided that a corresponding XMP sidecar is found.\nAt present, darktable is able to handle the following development steps from Lightroom-generated XMP files (with the corresponding darktable module in parentheses):\ncrop and rotate (crop and rotate) black level (exposure) exposure (exposure) vignette (vignetting) clarity (local contrast) tone curve (tone curve) HSL (color zones) split-toning (split-toning) grain (grain) spot removal (spot removal) ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/sidecar-files/sidecar-import/","tags":null,"title":"importing sidecar files generated by other applications"},{"categories":null,"content":"🔗left panel From top to bottom:\nimport Import images from the filesystem or a connected camera. collections Filter the images displayed in the lighttable center panel \u0026ndash; also used to control the images displayed in the filmstrip and timeline modules. recently used collections View recently used collections of images. image information Display image information. lua scripts installer (optional) Install lua scripts. 🔗right panel From top to bottom:\nselection Select images in the lighttable using simple criteria. actions on selection Perform actions on selected images. history stack Manipulate the history stack of selected images. styles Store an image\u0026rsquo;s history stack as a named style and apply it to other images. metadata editor Edit metadata for selected images. tagging Tag selected images. geotagging Import and apply GPX track data to selected images. export Export selected images to local files or external services. 🔗bottom panel From left to right:\nstar ratings Apply star ratings to images. color labels Apply color labels to images. mode selector Choose a lighttable mode. zoom Adjust the size of thumbnails. enable focus-peaking mode Highlight the parts of the image that are in focus. set display profile Set the display profile of your monitor(s). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/lighttable-view-layout/","tags":null,"title":"lighttable view layout"},{"categories":null,"content":"🔗left panel These modules are identical to the lighttable view. From top to bottom:\ncollections Filter the list of images displayed in the map view. recently used collections View recently used collections of images. image information Display image information. 🔗right panel Here you can find the modules specific to the map view. From top to bottom:\nfind location Search for a place on map. locations Manage a hierarchical list of location tags and their corresponding regions on the map. map settings Choose the map provider and set up various map display parameters. tagging Tag selected images. geotagging Apply GPX track data to selected images. 🔗bottom panel filmstrip Drag images from the filmstrip onto the map as described in the map overview. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/map/map-view-layout/","tags":null,"title":"map view layout"},{"categories":null,"content":"A number of pre-defined module groups are shipped with darktable and are selectable as presets. These are summarized below.\nAll of these presets (with the exception of modules: deprecated and search only) also include the quick access panel. All except the modules: deprecated group include the search bar.\n🔗modules: all This preset contains all modules, sorted according to the traditional module groupings used prior to darktable 3.4, as follows:\nbase modules The minimal set of modules normally required to render a presentable image. tone modules Other modules related to tone levels and contrast. color modules Modules related to color grading and color profiles. corrective modules Modules related to correcting problems such as lens distortions, sensor noise, sharpening, etc. (special) effects modules \u0026ldquo;Special effect\u0026rdquo; modules such as bloom, diffuse or sharpen, etc. 🔗workflow: scene-referred \u0026amp; workflow: display-referred These presets define groups of modules relevant to the scene-referred and display-referred workflows, sorted into groups as shown below:\nbase modules A basic set of modules to adjust the cropping/orientation, adjust the exposure, and apply tone mappings and contrast as appropriate to the workflow. color modules Modules relating to color grading and color saturation. corrective modules Modules relating to correcting problems relating to lens distortions, sensor noise, sharpening, retouching, etc. (special) effects modules \u0026ldquo;Special effect\u0026rdquo; modules such as watermark, framing, vignetting, etc. 🔗workflow: beginner This preset provides a minimal set of modules targeted as a starting point for beginners. It is suggested that beginners start by copying this minimal preset, and add to it as they gain experience with other modules.\nbase modules A basic set of modules to adjust the cropping/orientation, adjust the exposure, and apply a basic tone mapping. grading modules Modules dealing with creative tone and color grading. (special) effects modules \u0026ldquo;Special effect\u0026rdquo; modules such as retouch, sharpen, watermark, etc. 🔗previous config These presets are automatically generated for users who have upgraded from a version of darktable prior to 3.4. Where you have previously set up favourites or altered the hidden flag on modules, these presets contains those customizations, retaining the legacy module groups (previous config preset) or new module groups (previous config with new layout preset).\nIf favourites were created in prior versions these will remain available in an additional group:\nfavourite modules This group was previously used by users to make it easier to find frequently-used modules, and is available under the \u0026ldquo;previous config\u0026rdquo; presets. New users can, of course, still create their own custom group and name it \u0026ldquo;favourites\u0026rdquo; if they so desire. 🔗search only This preset does not include any module groupings. Modules may only be accessed using the search facility.\n🔗modules: deprecated This preset contains a list of deprecated modules. This is the only way to access deprecated modules for new edits but be warned: these modules will be removed for new edits in the next release of darktable. This group cannot be duplicated and the modules within it cannot be added to user-created groups.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/organization/module-groups/","tags":null,"title":"module groups"},{"categories":null,"content":"Many of darktable\u0026rsquo;s modules can be applied more than once in the pixelpipe. Each instance of a module behaves independently, taking its input from the module below it in the pixelpipe and delivering its output to the next module.\nAs with the base instance of a module, all instances can be moved independently within the pixelpipe either by holding Ctrl+Shift while dragging \u0026amp; dropping or by choosing \u0026ldquo;move up\u0026rdquo; or \u0026ldquo;move down\u0026rdquo; in the multiple instances drop-down menu.\nInstances can be renamed by Ctrl+clicking on the module name.\n🔗typical use cases There are many occasions where it makes sense to have a module apply more than once in the pixelpipe. Here are some typical use cases.\nThe exposure module can be used in combination with masks to lighten or darken parts of an image. A separate instance may be created to modify each masked region of the image. You may wish to handle luma and chroma noise independently. This can be accomplished by generating two instances of your chosen denoising module and using the first one only on luma (by selecting blend mode “lightness”) and the second one only on chroma (by selecting blend mode “color”). Note: Each instance also adds to the workload of your pixelpipe. Generating too many instances – especially of the more demanding modules – will cause noticeable slow-down.\n🔗managing multiple instances Click on the multiple instance menu in the module header to display a menu with the following options. Right-click on the menu icon to create a new instance directly (same action as clicking on the \u0026ldquo;new instance\u0026rdquo; option of the menu).\nnew instance Create a new instance of the current module with all of its parameters reset to their default values. The \u0026lsquo;instance name\u0026rsquo; is automatically set to a unique integer so that it can be distinguished from its parent. duplicate instance Create a new instance of the current module with all of its parameters inherited from the current instance. As with \u0026rsquo;new instance\u0026rsquo; the \u0026lsquo;instance name\u0026rsquo; is automatically set to a unique integer. move up/down Move the instance up or down in the pixelpipe delete Remove the current instance. This option is not available if only one instance is present. rename Rename the current instance. See the history stack section for more details on how the instance name impacts copying and pasting history stacks. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/multiple-instances/","tags":null,"title":"multiple instances"},{"categories":null,"content":"The central area displays the image layout on the paper (the white area). Some gray borders may be displayed around the image to represent the printable area (the page minus the borders) not filled by the image.\nThe filmstrip below the image allows you to select more images.\n🔗overlays When the mouse is over the bounding box of an image, its width and height are shown along its top and left, respectively. Margins between the bounding box and the page edge are notated next to the dotted lines extending out from each side of the bounding box. All measurements are shown in the units as chosen in the print settings module.\nImages are inset along one dimension of their bounding box when they do not match the aspect ratio of the box. The overlaid margin measurements should therefore only be used to understand the layout bounds, not the actual printed size of the image.\n🔗left panel collections Filter the list of images displayed in the lighttable. image information Display image information 🔗right panel print settings Adjust print settings and initiate printing. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/print/print-view-layout/","tags":null,"title":"print view layout"},{"categories":null,"content":"The layout of all darktable views is similar and consists of a center area with panels at the edges:\ncenter area : Contains information and functionality specific to the current view.\nleft panel : Contains modules primarily used to provide information.\nright panel : Contains modules primarily used for image processing.\ntop banner : Contains information about the current darktable version and allows you to switch between views. Also used by some modules to show additional hints and messages.\ntop panel : Provides access to global settings and shortcuts\nbottom panel : Provides access to view-specific settings and shortcuts.\nfilmstrip/timeline panel : An optional panel that can be enabled at the bottom of the screen to display a timeline (in the lighttable view) or a filmstrip (in other views) of images in the current collection.\n🔗panel size and visibility The left, right and filmstrip/timeline panels can be resized by dragging their inner borders.\nEach of the panels can be expanded or collapsed by pressing the triangle located at the outside edge of the panels. Panel visibility can also be adjusted using keyboard shortcuts, as follows:\nTAB temporarily expands the centre view to fill the whole window. Press again to return to the previous view. F11 toggles fullscreen mode Shift+Ctrl+t toggles the top panel (between the image and the top banner) Shift+Ctrl+b toggles the bottom panel (between the image and the filmstrip/timeline, if shown) Shift+Ctrl+l toggles the left panel Shift+Ctrl+r toggles the right panel Ctrl+f toggles the filmstrip/timeline Ctrl+h toggles the top banner b toggles all borders and panel-collapse controls Note: The size and visibility of the panels are stored independently for each view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/user-interface/screen-layout/","tags":null,"title":"screen layout"},{"categories":null,"content":"darktable supports a huge number of file formats from various camera manufacturers. In addition darktable can read a wide range of low- and high-dynamic-range images \u0026ndash; mainly for data exchange between darktable and other software.\nIn order for darktable to consider a file for import, it must have one of the following extensions (case independent): 3FR, ARI, ARW, BAY, BMQ, CAP, CINE, CR2, CR3, CRW, CS1, DC2, DCR, DNG, GPR, ERF, FFF, EXR, IA, IIQ, JPEG, JPG, JXL, K25, KC2, KDC, MDC, MEF, MOS, MRW, NEF, NRW, ORF, PEF, PFM, PNG, PXN, QTK, RAF, RAW, RDC, RW1, RW2, SR2, SRF, SRW, STI, TIF, TIFF, X3F\nIf darktable was compiled with JPEG2000 support, the following extensions are also recognized: J2C, J2K, JP2, JPC.\nIf darktable was compiled with GraphicsMagick support, the following extensions are also recognized: BMP, DCM, GIF, JNG, JPC, JP2, MIFF, MNG, PBM, PGM, PNM, PPM, WEBP.\n🔗camera raw files darktable reads raw files using the open source library RawSpeed, originally developed by Klaus Post and now maintained as part of the darktable project. The number of supported cameras and file formats is constantly increasing. Most modern camera models are supported, and new ones tend to get added very quickly. It is beyond the scope of this manual to give an exhaustive list.\nWith the exception of Fujifilm X-Trans cameras, darktable does not decode images from cameras with non-Bayer sensors (e.g. Sigma cameras with the Foveon X3 sensor).\n🔗other image files darktable natively reads “ordinary” images in JPEG, 8-bit/16-bit PNG and 8-bit/16-bit TIFF format, as well as 16-bit/32-bit floating point TIFF formats.\ndarktable also reads high dynamic range images in OpenEXR, RGBE and PFM formats.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/supported-file-formats/","tags":null,"title":"supported file formats"},{"categories":null,"content":"🔗left panel image information Display image information. 🔗right panel From top to bottom:\nscopes A graphical depiction of the current image\u0026rsquo;s light levels and colors. This module can be moved to the left-hand panel if desired (see preferences \u0026gt; miscellaneous \u0026gt; position of the scopes module). session Session settings. live view Live view settings. camera settings Camera settings. metadata editor Edit metadata for selected images. tagging Tag selected images. 🔗bottom panel From left to right:\nstar ratings Apply star ratings to images. color labels Apply color labels to images. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/tethering/tethering-view-layout/","tags":null,"title":"tethering view layout"},{"categories":null,"content":"The ordered sequence of processing modules operating on an input file to generate an output image is known as the \u0026ldquo;pixelpipe\u0026rdquo;.\nThe order of the pixelpipe is represented graphically by the order in which modules are presented in the user interface \u0026ndash; the pixelpipe starts with a RAW image at the bottom of the module list, and applies the processing modules one by one, piling up layer upon layer of processing from the bottom up, until it reaches the top of the list, where it outputs the fully processed image.\nNote: The order in which processing modules are executed exactly matches the order in which the modules appear in darktable\u0026rsquo;s user interface. Changing the order of the modules in the user interface changes how your image is processed.\n🔗types of pixelpipe Processing images can be very resource-intensive. For this reason, darktable includes various types of pixelpipe, optimised for different parts of the system. For example:\nThe export pixelpipe processes the full-sized image at full quality. This is the slowest type of pixelpipe, but provides the maximum available image quality. The thumbnail pixelpipe is optimised for speed, since it needs to process multiple small images at the same time without impacting lighttable or filmstrip performance. These optimisations impact image quality, but this is not usually a problem for the small images used in thumbnail generation. The standard darkroom pixelpipe attempts to produce as accurate an image as possible, while also maintaining responsiveness when modifying module parameters. It does this by only processing the pixels that are visible on-screen \u0026ndash; known as the \u0026ldquo;region of interest\u0026rdquo; (ROI). However, this can mean that the image doesn\u0026rsquo;t accurately reflect the exported file, especially when using modules that rely on the properties of neighboring pixels. This is particularly noticeable in modules that impact local contrast (e.g. diffuse or sharpen, denoise (profiled) and local contrast) and can mean that the darkroom view appears over-sharpened compared to a full-sized export. A cut-down darkroom pixelpipe is used while interacting with some darkroom modules that display the full image with overlays (like retouch, crop and liquify). This pixelpipe excludes some long-running modules (like diffuse or sharpen) in order to improve responsiveness, but can temporarily make the image look under-processed (blurred). This limitation is removed as soon as you move focus to a different module. In order to overcome the above limitations within the standard darkroom pixelpipe, you can enable high quality processing mode in the darkroom view. This mode processes the entire image using the export pixelpipe and only downscales for display at the end of the pipe. This means that the darkroom image will very closely match the exported image, but will significantly degrade responsiveness when interacting with processing modules. You are advised to only use this mode after you have already done most of your processing. Its performance will be significantly improved by using an OpenCL-capable GPU. 🔗module order and workflows The order in which modules are executed within the pixelpipe has been carefully chosen to give the best output quality. In previous versions of darktable it was not possible to change the module order. However, there are a number of very specific use cases where the movement of some modules within the pixelpipe is advised.\nOne of the main reasons to change the module order came about with darktable version 3.0, which introduced the new scene-referred way of working. Version 3.2 formalised this by introducing the display-referred and scene-referred workflows, which are controlled by the preferences \u0026gt; processing \u0026gt; auto-apply pixel workflow defaults setting. Starting with version 3.6, scene-referred workflow is now the official recommended (and default) way to use darktable.\nThe scene-referred workflow attempts to perform as many operations as possible in a linear RGB color space, only compressing the tones to fit the output medium (with a non-linear tone mapping) at the end of the pixelpipe. This has the advantage of being a more physically-realistic space to do transformations than the traditional display-referred workflow, which attempts to perform operations in a non-linear perceptual color space. Honoring the physical realism (rather than the perceptual realism) makes it much easier to produce predictable processing algorithms with a minimum of artifacts.\nThe following diagram should help you to understand the difference between these workflows:\nScene-referred modules process linear data that is proportional to the amount of light collected by the camera at the scene. The dynamic range of an image in the scene-referred section of the pixelpipe is often larger than that of the display medium.\nAt some point in the pixelpipe, these pixel values are compressed by a non-linear tone mapping operation into a smaller dynamic range more suitable for display on a monitor or a print.\nThe remaining modules operate in the non-linear display-referred section of the pixelpipe to produce the final output image.\n🔗display-referred workflow Prior to version 3.0 darktable\u0026rsquo;s workflow was display-referred (auto-apply pixel workflow defaults = \u0026ldquo;display-referred\u0026rdquo;) and this option is still provided as a legacy mode. In this workflow, the base curve or filmic rgb module performs tone mapping early in the pixelpipe and most other darktable modules operate on image data in the compressed display-referred space.\nSelecting the display-referred workflow enables the legacy (pre-darktable-3.0) module order and automatically switches on the base curve module for new images.\nPixel data within the display-referred space is non-linear and is not a physically realistic representation of the original scene. This can lead to various artifacts with some modules, hence the creation of the (now default) scene-referred workflow.\n🔗scene-referred workflow Scene-referred workflow (auto-apply pixel workflow defaults = \u0026ldquo;scene-referred\u0026rdquo;) was introduced as part of darktable 3.0. The module order was entirely rearranged to place the filmic rgb and base curve tone mapping modules much later in the pixelpipe. This means that most modules now operate in linear rgb space with only a few modules remaining within the non-linear display-referred space. Within this workflow it is now recommended that the majority of image processing takes place using the modules up to and including filmic rgb. Operations in this section of the pixelpipe, being truly linear, are much more physically realistic and produce fewer artifacts.\nSelecting the scene-referred workflow enables the v3.0 module order and automatically enables the exposure and filmic rgb modules with some presets designed to act as a reasonable starting point for scene-referred editing.\n🔗changing module order It remains highly recommended that users not change the order within the pixelpipe for a number of reasons:\nThe sequence of modules has been selected with great care in order to give highest output quality. Changes to the sequence often worsen the result rather than improving it. Some processing modules simply don\u0026rsquo;t make sense if they are shifted in the pixelpipe. For example, highlight reconstruction needs to be performed on raw data before demosaic, which itself needs to be performed before any input color profile can be applied. For this reason it is still not possible to move some of the modules that are placed early in the pixelpipe. Most processing modules are designed to work within a specific color space (see the color management section for more details). Full flexibility would require modules to support different parallel algorithms depending on the color space they are working in, which would drastically increase complexity. Despite the general recommendation to leave the pixelpipe order alone, it is possible to move modules within the pixelpipe by holding Ctrl+Shift and dragging and dropping the desired module to a new location. This should only be done by experienced users who understand the impact this will have on the image.\nThe module order can be manually changed back to either the v3.0 or legacy versions using the module order module, which can also be used to define your own custom module order presets.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/","tags":null,"title":"the pixelpipe \u0026 module order"},{"categories":null,"content":"The slideshow view is still in an early stage of development with only a basic set of features.\nIf you don\u0026rsquo;t need the auto-advance mode, you could even use the sticky preview feature instead.\nspacebar start and stop auto-advance mode which automatically switches to the next images every five seconds by default. ESC leave slideshow mode and return to lighttable view. + or increase delay between each image. up arrow - or decrease delay between each image. down arrow left-click or right arrow or switch to the next image of the collection. right shift-key right-click or left arrow or switch to the previous image of the collection. left shift-key Hint: To take full advantage of your screen size, put darktable into fullscreen mode by pressing F11 and hide the border-controls by pressing the B key.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/slideshow/usage/","tags":null,"title":"usage"},{"categories":null,"content":"The tool is organized into three tabs in the upper part and a text output frame in the lower part.\nThe first tab is used to define the source image, the second tab defines the reference (target) and the third tab contains the controls to generate the resulting darktable style.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/darktable-chart/usage/","tags":null,"title":"usage"},{"categories":null,"content":"The zoomable lighttable mode provides an alternative way to navigate large collections of images, but with some similarities to the filemanager mode (described below).\n🔗controls zoom Scroll with the mouse wheel to zoom in and out of the lighttable (compared to Ctrl+scroll in filemanager mode). Zooming the thumbnails does not change the number of thumbnails per row, so the lighttable can exceed the visible area on all sides. navigate Hold down the left mouse button and drag to move the lighttable around and navigate through your collection. select As with the filemanager mode, you can select the image under the pointer by clicking on its thumbnail or by pressing Enter. A range of images can be selected by clicking on the first image and then Shift+clicking on the last one. Images can be added to or removed from a selection by Ctrl+clicking on their thumbnails or by pressing Spacebar. Hint: you may find that image thumbnails are slow to load when zooming quickly through a large collection. One way to speed up the navigation is to generate a cache containing all the thumbnails using the darktable-generate-cache command.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/lighttable-modes/zoomable-lighttable/","tags":null,"title":"zoomable lighttable"},{"categories":null,"content":"Let\u0026rsquo;s start with a simple example that will print some code on the console. Create a file called luarc in darktable\u0026rsquo;s configuration directory (usually $HOME/.config/darktable/) and add the following line to it:\nprint(\u0026#34;Hello World !\u0026#34;) Start darktable and you will see the sentence \u0026ldquo;Hello World !\u0026rdquo; printed on the console. Nothing fancy but it\u0026rsquo;s a start.\nAt this point, there is nothing darktable-specific in the script. We simply use Lua\u0026rsquo;s standard print function to print a string. That\u0026rsquo;s nice and all, but we can do better than that. To access the darktable API you first need to require it and save the returned object in a variable. Once this is done you can access the darktable API as subfields of the returned object. All of this is documented in darktable\u0026rsquo;s Lua API reference manual.\nlocal darktable = require \u0026#34;darktable\u0026#34; darktable.print_error(\u0026#34;Hello World !\u0026#34;) Run the script and \u0026hellip; nothing happens. The function darktable.print_error is just like print but will only print the message if you have enabled lua traces by running darktable with \u0026ldquo;darktable -d lua\u0026rdquo; on the command line. This is the recommended way to do traces in a darktable lua script.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/a-simple-example/","tags":null,"title":"a simple lua example"},{"categories":null,"content":"Using OpenCL in darktable requires that your PC is equipped with a suitable graphics card and that it has the required libraries in place. Most modern graphics cards from NVIDIA, Intel or AMD come with full OpenCL support. The OpenCL compiler is normally shipped as part of the proprietary graphics driver and is used as a dynamic library called libOpenCL.so. This library must be in a folder where it can be found by your system\u0026rsquo;s dynamic linker.\nWhen darktable starts, it will first try to find and load libOpenCL.so and \u0026ndash; on success \u0026ndash; checks if the available graphics card comes with OpenCL support. A minimally-sufficient amount of graphics memory (1GB+) needs to be available for darktable to take advantage of the GPU. If that check passes, darktable tries to setup its OpenCL environment: a processing context needs to be initialized, a calculation pipeline to be started, OpenCL source code files (extension is .cl) needs to be read and compiled and the included routines (OpenCL kernels) need to be prepared for darktable\u0026rsquo;s modules. If all of that completes successfully, the preparation is complete.\nBy default, OpenCL support is activated in darktable if all the above steps were successful. If you want to de-activate it you can do so in preferences \u0026gt; processing \u0026gt; OpenCL. This configuration parameter is grayed out if the OpenCL initialization failed.\nYou can switch OpenCL support off and on at any time without requiring a restart. Depending on the type of modules you are using, you will notice the effect as a general speed-up during interactive work and export. Most modules in darktable can take advantage of OpenCL but not all modules are demanding enough to make a noticeable difference. In order to feel a real difference, use modules like diffuse or sharpen, and denoise (profiled).\nIf you are interested in profiling statistics, you can start darktable with command line parameters -d opencl -d perf. After each run of the pixelpipe you will be shown details of processing time for each module plus an even more fine-grained profile for all used OpenCL kernels.\nApart from the speed-up you should not see any difference in the results between CPU and GPU processing. Except for some rounding errors, the results are designed to be identical. If, for some reason, darktable fails to properly finish a GPU calculation, it will normally detect the failure and automatically (and transparently) fall back to CPU processing.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/activate-opencl/","tags":null,"title":"activating OpenCL in darktable"},{"categories":null,"content":"Culling mode allows you to display images side by side for easy comparison.\n🔗controls zoom In culling mode, you can zoom into images (up to 100%) by holding Ctrl while scrolling with the mouse wheel. Pan within zoomed images with click+drag. By default, zooming and panning are synchronized between all visible images. If you want to zoom or pan only a specific image, add the Shift modifier to the above actions. navigate Use the mouse wheel or arrow keys (←/→) to scroll through your collection. 🔗modes There are two different culling modes, which define how many images are shown at the same time: “fixed” and “dynamic”. Switch between these while in culling mode by pressing the \u0026ldquo;\u0026lt;\u0026rdquo; key.\nfixed mode The number of images displayed is always the same, independent of the selection length. This number can be set with a slider on the bottom panel. In this mode, you will navigate through all selected images. If no selection is set (or if only one image is selected), you will navigate through all images.\nThe default keyboard shortcut to enter culling in fixed mode is X.\ndynamic mode All of the selected images are shown. If no selection is set (or if only one image is selected) the last value from fixed mode is used. The default keyboard shortcut to enter culling in dynamic mode is Ctrl+X.\nHint: To enhance performance when loading zoomed images, you can enable (preferences \u0026gt; processing \u0026gt; cpu/gpu/memory \u0026gt; enable disk backend for full preview cache). Bear in mind that this can occupy a lot of disk space.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/lighttable-modes/culling/","tags":null,"title":"culling"},{"categories":null,"content":"The darktable-generate-cache binary updates darktable\u0026rsquo;s thumbnail cache. Invoke this program to generate all missing thumbnails in the background when your computer is idle.\ndarktable-generate-cache can be called with the following command line parameters:\ndarktable-generate-cache [-h, --help] [--version] [--min-mip \u0026lt;0-8\u0026gt;] [-m, --max-mip \u0026lt;0-8\u0026gt;] [--min-imgid \u0026lt;N\u0026gt;] [--max-imgid \u0026lt;N\u0026gt;] [--core \u0026lt;darktable options\u0026gt;] All parameters are optional. If started without parameters darktable-generate-cache uses reasonable defaults.\n-h, --help Display usage information and terminate. --version Display copyright and version information and terminate. --min-mip \u0026lt;0-8\u0026gt;, -m, --max-mip \u0026lt;0-8\u0026gt; darktable can store thumbnails with up to eight different resolution steps for each image. These parameters define the maximum resolution to be generated (defaults to a range of 0-2). There is normally no need to generate all possible resolutions here \u0026ndash; missing ones will be automatically generated by darktable the moment they are needed. When asked to generate multiple resolutions at once, the lower-resolution images are quickly downsampled from the highest-resolution image. --min-imgid \u0026lt;N\u0026gt;, --max-imgid \u0026lt;N\u0026gt; Specifies the range of internal image IDs from the database to work on. If no range is given, darktable-generate-cache will process all images. --core \u0026lt;darktable options\u0026gt; All command line parameters following --core are passed to the darktable core and handled as standard parameters. See the darktable binary section for a detailed description. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/darktable-generate-cache/","tags":null,"title":"darktable-generate-cache"},{"categories":null,"content":"The following sections show two typical use cases for the tethering view.\n🔗studio setup with screening This is a pretty common use case. You have your studio and subject set up, the camera is connected to your computer and tethering view is active in darktable. You work at the camera and take images. Whenever you like, you can review the images directly on your computer monitor instead of using the camera LCD.\nThis workflow is efficient and effective, since you can immediately review your captures instead of waiting until after the shoot when everyone is gone. If you\u0026rsquo;re shooting with a model this is a nice way to preview the captures with the client instead of fumbling around with your camera.\nWorking in the tethering view can save you time and aggravation. Set a session name, shoot your images, and they will be saved to the correct film roll for the session, for easy on-site review.\n🔗capturing a timelapse A timelapse is a video clip composed of images taken in a timed sequence. A typical example is to take a timelapse of a cityscape to capture the movement of the clouds and traffic etc.\nTo set up a timelapse capture, create a new session. Now decide whether you want to shoot in manual or auto mode. It is recommended that you only use auto mode in situations where the ambient light will change significantly during the time of the shoot, for example, when shooting a timelapse over 24 hours.\nThe camera settings module can be used to define the delay (the number of seconds between capture) and sequence (the number of images to capture) of your timelapse.\nTo start the timelapse click the capture button in the same panel and watch the filmstrip fill up with images. The last captured image is always displayed in the center view.\n🔗storing images on the camera and computer By default, the gphoto2 framework (used by darktable\u0026rsquo;s tethering feature) will only download images to your computer, and will not store them on the camera\u0026rsquo;s memory card. This setting can be changed outside of darktable by using the gphoto2 command line interface. However, there are cases where this method fails, as it requires that darktable use the same configuration file as the gphoto2 command line tool. In particular, if darktable or gphoto2 are installed within a sandbox or container that hides user account settings, you may face this issue (for example, with snap packages and similar).\nTo allow captured images to be retained on the camera\u0026rsquo;s memory card, connect the camera to your computer for a tethering session, but close darktable. Enter gphoto2 --set-config capturetarget=1 on the command line. If this command is successful, start darktable again. Thereafter, images should be stored (duplicated) on the camera\u0026rsquo;s memory card during a tethered capture.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/tethering/examples/","tags":null,"title":"examples"},{"categories":null,"content":"The filmstrip, when enabled, is shown at the bottom of the screen (except in the lighttable view, where it is replaced with the timeline module) and displays the images from the current collection (set in the lighttable view). You can navigate the filmstrip by scrolling with the mouse wheel.\nThe filmstrip allows you to interact with images while you are not in the lighttable view. For example, while developing an image in darkroom mode, you can switch to another image by clicking its thumbnail in the filmstrip. You can also rate and color-classify the images as you do in lighttable, as well as copy \u0026amp; paste the history stack using keyboard shortcuts.\nSee the filmstrip module documentation for more information.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/user-interface/filmstrip/","tags":null,"title":"filmstrip"},{"categories":null,"content":"Control default file naming conventions used when importing images.\n🔗session options The following options define the default naming pattern for use in the \u0026ldquo;copy \u0026amp; import\u0026rdquo; or \u0026ldquo;copy \u0026amp; import from camera\u0026rdquo; options in the import module, or when taking photos in the tethering view.\nThe naming pattern consists of three parts: a base part defining the parent folder, a session part defining a sub directory (which is specific to the individual import session), and a file name part defining the filename structure for each imported image.\nSeveral pre-defined variables can be used in the pattern as placeholders:\n$(HOME) the home folder as defined by the system $(PICTURES_FOLDER) the pictures folder as defined by the system (usually “$HOME/Pictures”) $(DESKTOP) the desktop folder as defined by the system (usually “$HOME/Desktop”) $(USERNAME) your user account name on the system $(FILE_NAME) basename of the imported image $(FILE_EXTENSION) extension of the imported image $(JOBCODE) unique identifier of the import job $(SEQUENCE) a sequence number within the import job $(MAX_WIDTH) maximum image width to limit within export session $(MAX_HEIGHT) maximum image height to limit within export session $(ID) unique identification number of the image in darktable\u0026#39;s database $(YEAR) year at the date of import $(MONTH) month at the date of import $(DAY) day at the date of import $(HOUR) hour at the time of import $(MINUTE) minute at the time of import $(SECOND) second at the time of import $(EXIF_YEAR) year the photo was taken (from Exif data) $(EXIF_MONTH) month the photo was taken (from Exif data) $(EXIF_DAY) day the photo was taken (from Exif data) $(EXIF_HOUR) hour the photo was taken (from Exif data) $(EXIF_MINUTE) minute the photo was taken (from Exif data) $(EXIF_SECOND) seconds the photo was taken (from Exif data) $(EXIF_ISO) ISO value of the photo (from Exif data) base directory naming pattern The base directory part of the naming pattern (default $(PICTURES_FOLDER)/Darktable). sub directory naming pattern The sub directory part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(JOBCODE)). keep original filename Check this box to keep the original filename instead of using the pattern below when importing from a camera or card (default off). file naming pattern The file name part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(SEQUENCE).$(FILE_EXTENSION). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/import/","tags":null,"title":"import"},{"categories":null,"content":"Many users have huge image collections stored on extra hard drives in their desktop computer, or on an external storage medium (RAID NAS, external hard drives etc.).\nIt is a common requirement to develop a number of images while travelling using a laptop and then later synchronize them back to the original storage medium. However, copying images manually from the main storage to the laptop and back is cumbersome and prone to errors. The “local copies” feature of darktable has been designed to directly support these use cases.\nYou can create local copies of selected images from within the lighttable. Local copies are always used when present, giving continued access to images even if the external storage is no longer connected. At a later point, when your primary storage medium has been reconnected, you can synchronize the XMP sidecar files back to this storage, deleting any local copies. These operations can be found in the actions on selection module in the lighttable.\nFor safety reasons, if local copies exist and the external storage is available, the local XMP sidecars are automatically synchronized at start up.\nLocal copies are stored within the $HOME/.cache/darktable directory and named img-\u0026lt;SIGNATURE\u0026gt;.\u0026lt;EXT\u0026gt; (where SIGNATURE is a hash signature (MD5) of the full pathname, and EXT is the original filename extension).\nLocal copies can be identified in the lighttable view by a white marker on the top right of the thumbnail. In addition, all local copies carry the darktable|local-copy tag to allow them to be easily selected.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/sidecar-files/local-copies/","tags":null,"title":"local copies"},{"categories":null,"content":"The parametric mask feature offers fine-grained selective control over how individual pixels are masked. It does this by automatically generating an intermediate blend mask from user-defined parameters. These parameters are color coordinates rather than the geometrical coordinates used in drawn masks.\nFor each data channel of a module (e.g. Lab, RGB) and several virtual data channels (e.g. hue, saturation) you can construct a per-channel opacity function. Depending on each pixel\u0026rsquo;s value for a given data channel this function calculates a blending factor between 0 and 1 (100%) for that pixel.\nEach pixel of an image thus has different blending factors for each of its data channels. All blending factors are finally multiplied together (pixel-by-pixel), along with the value of the global opacity slider, to form a complete parametric blend mask for the image.\nIf the blend mask has a value of 0 for a given pixel, the input of the module is left unchanged. If the blend mask has a value of 1 (100%) for a pixel, the module has its full effect.\n🔗channel tabs Click on one of the channel tabs to select a data channel to use to build your mask.\nModules acting in (display-referred) Lab color space have data channels for L, a, b, C (chroma of LCh) and h (hue of LCh).\nModules acting in display-referred RGB color space have data channels for g (gray), R, G, B, H (hue of HSL), S (saturation of HSL), and L (lightness of HSL).\nModules acting in scene-referred RGB color space have data channels for g (gray), R, G, B, Jz (luminance component of JzCzhz), Cz (chroma, or saturation, of JzCzhz), and hz (hue of JzCzhz). The g (gray) value is calculated as a weighted average of the R, G \u0026amp; B channels, the exact weightings depending on the working color space being used. The JzCzhz color space is a polar representation of the Jzazbz color space, in the same way that LCh is a polar representation of the Lab space. Like the L in Lab color space, the Jz is a representation of the luminosity of a pixel that aligns with how we perceive brightness. However, the Jzazbz color space is much better for high dynamic range images and is less susceptible to hue shifts than Lab space.\nSee Wikipedia for more details about these color spaces.\nTwo sliders can be shown for each associated data channel: one that works on the input data that the module receives and one that works on the output data that the module produces prior to blending. The sliders for the output data channels are hidden by default and can be shown using the show output channels option in the blending menu.\nThe boost factor slider allows the range of values targeted by the parametric mask sliders to be extended. It may be used in scene referred editing, where luminance values may extend beyond 100%, to target highlights. This slider is only available for channels where it is meaningful.\n🔗inspecting data channels \u0026amp; masks Press the letter C while hovering over a channel\u0026rsquo;s input/output slider to view the input/output image data for that color channel. The center image changes to display that color channel either in gray-scale values or in false colors depending on the setting in preferences \u0026gt; darkroom \u0026gt; display of individual color channels.\nPress the letter M to see the resulting mask for that slider overlaid on the image.\nWhen the mouse pointer leaves the slider the image returns to normal after a short delay.\n🔗linear / log mode Press the letter A while hovering over the a slider to change its display to \u0026rsquo;log\u0026rsquo; mode. This provides more fine control in the shadows. Press A again to toggle back to \u0026rsquo;linear\u0026rsquo; mode.\n🔗channel input/output sliders With each color channel slider you can construct a trapezoidal opacity function. For this purpose there are four markers per slider. Two filled triangles above the slider mark the range of values where opacity is 1. Two open triangles below the slider mark the range values where opacity is 0. Intermediate points between full and zero are given a proportional opacity.\nThe filled triangles, or inside markers, indicate the closed (mostly narrower) edge of the trapezoidal function. The open triangles, or outside markers, indicate the open (mostly wider) edge of the trapezoidal function. The sequence of the markers always remains unchanged: they can touch one another but they cannot switch position.\nA polarity (+/-) button to the right of each the slider switches between \u0026ldquo;range select\u0026rdquo; and \u0026ldquo;range de-select\u0026rdquo; modes, with visual confirmation provided by exchanging the upper and lower triangle markers. These two types of trapezoidal functions are represented graphically in the following images.\nrange select\nrange deselect\nIn their default state all markers are at their extreme positions.\nIn this state a range select function selects the whole range of values giving an “all at 100%” mask. Starting from there one can move the sliders inwards to gradually exclude more and more parts of the image except for the remaining narrow range.\nConversely a range de-select function (enabled by toggling the polarity) by default deselects the whole range of values, giving an “all-zero” mask as a starting point. Moving the sliders inwards gradually includes more and more parts of the image except for the remaining narrow range.\n🔗pickers With the left-hand picker button you can select a point or area probe from your image. The corresponding values for the real and virtual data channels are then displayed within each color channel slider.\nWith the right-hand picker button you can automatically set the slider\u0026rsquo;s values based on the selected range. Click and drag to set the parameters for the input slider from the drawn rectangle; Ctrl+click and drag to set the parameters for the output slider.\n🔗invert Click the invert button above the sliders to invert the polarity of the entire parametric mask. This differs from the polarity buttons beside the individual sliders which just invert the parameters for the current slider/channel.\n🔗reset Click the reset button above the sliders to revert all parametric mask parameters to their default state.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/masks/parametric/","tags":null,"title":"parametric masks"},{"categories":null,"content":"Presets allow you to store commonly-used module settings for future use. Some modules already come with pre-defined (internal) presets and you may also define your own (user-defined). Both internal and user-defined presets can be shown by clicking the presets menu in the module header.\nMost of the functionality described here applies to processing modules only. However, presets can also be used with some utility modules. When used with utility modules, the functionality to auto-apply or auto-show presets based on image Exif data is not available.\nPlease note that, for processing modules, the saved preset also includes the active state of the module. You can use this to create your own default settings, which you can activate on-demand. Simply set your desired defaults, disable the module, and save the preset.\n🔗the presets menu The presets menu will contain one or more of the following entries depending on the presets that are defined or selected for the current module:\npreset list A list of the presets available for the current module. The currently selected preset (if any) is shown in bold and with a small check mark beside it. edit this preset If a preset has been selected, edit the selected preset (see below). delete this preset If a preset has been selected, delete the selected preset. update preset [name] Update the named preset to match the module\u0026rsquo;s current parameters. store new preset Create a new preset using the module\u0026rsquo;s current parameters. Click on a preset name to apply the preset to the current instance of the module. Long-left-click on a preset name to apply the preset but keep the preset list open (so that you can experiment with multiple presets without needing to re-open the menu). Right-click on a preset name to create a new instance of the module and apply the selected preset to it. You can also apply a preset at any time while you are in the darkroom using a keyboard shortcut \u0026ndash; if you have assigned one (see preferences \u0026gt; shortcuts).\n🔗creating and editing presets When creating or editing presets, the following dialog is shown:\n🔗controls name The name of the preset description A searchable description for the preset (optional) reset all module parameters to their default values Selecting this option will cause all module parameters to be reset to their default values (as if you had simply enabled the module on a new image or clicked the module reset button). This can be used to automatically set certain modules (color calibration, exposure, filmic) based on the Exif properties of the current image rather than setting to hard-coded parameters. Note that this option is not available when editing presets from the preferences \u0026gt; presets tab. auto apply this preset to matching images (processing modules only) Check this box to automatically apply this preset to matching images when they are opened in the darkroom for the first time (you can reapply such automatic presets by Ctrl+clicking on the reset button in the module header). Additional controls will appear to allow you to define which images the preset will be applied to based on image Exif data (see below). For example, if you want a preset to be applied to all images from a specific camera leave all fields at default values except for \u0026ldquo;model\u0026rdquo;. Leave all fields unchanged to auto-apply a preset to all images.\nThe example dialog above sets up following rules: if the lens name matches, the aperture is greater than or equal to f/8 and the focal length is between 24 and 35mm the preset will be automatically applied.\nThe image information module displays the camera model and lens name for each image. Use this to ensure you have the correct spelling.\nonly show this preset for matching images (processing modules only) Check this box to automatically show the preset in the preset menu, using the same set of filters. 🔗filter criteria The following criteria can be used to auto-apply or auto-show presets for processing modules:\nmodel A pattern to be matched against the Exif field that describes your camera model; use % as wildcard. maker A pattern to be matched against the Exif field that describes the maker of your camera; use % as wildcard. lens A pattern to be matched against the Exif field that describes your lens; use % as wildcard. ISO Only apply the preset if the ISO value of your image lies within the given range (shows ∞ if the upper range is unlimited). exposure Only apply the preset if the exposure time of your image lies within the given range; set + as the upper value to match arbitrarily long exposures. aperture Only apply the preset if the aperture of your image lies within the given range; set f/0 as the lower value to match arbitrarily open apertures; set f/+ as the upper value to match arbitrarily closed apertures. focal length Only apply the preset if the focal length of your image lies within the given range (from 0 to 1000). format Only apply the preset to certain types of image. Check boxes to include files matching these criteria; uncheck boxes to exclude those files. Choose from \u0026ldquo;raw\u0026rdquo;, \u0026ldquo;non-raw\u0026rdquo;, \u0026ldquo;HDR\u0026rdquo;, \u0026ldquo;monochrome\u0026rdquo; and \u0026ldquo;color\u0026rdquo;. 🔗managing presets Both user-defined and internal presets can be viewed and managed from within preferences \u0026gt; presets.\nNote: If you create a user-defined preset with the same name as a built-in preset, your preset will override the built-in version, which will no longer be accessible.\nIf you delete a preset that has the same name as one of the built-in presets, then your user preset will be deleted, and that preset name will no longer appear in the preset menu at all. The next time you start darktable, the corresponding built-in preset will once again become visible.\n🔗module naming in the darkroom view By default, if the current parameters of a processing module match those of a saved preset, darktable will attempt to automatically set the name (label) of the module in question, as follows:\nIf the user has manually amended the name of the module in the current image, the module name will be left unchanged, If the module instance from which the preset was created had a manually-set name, any subsequent module that matches this preset will automatically be given the same name. Note that if this was unintentional, the only way to revert will be to drop and recreate the preset, since the automatic name is a hidden field in the database, If the module instance from which the preset was created did not have a manually-set name, the name of any subsequent module that matches this preset will be set to the same as the preset name. As soon as the module parameters are changed such that it no longer matches a preset, the module\u0026rsquo;s name will be reset.\nThis functionality can be disabled in preferences \u0026gt; darkroom \u0026gt; automatically update module name.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/presets/","tags":null,"title":"presets"},{"categories":null,"content":"This section is intended to get you comfortable processing images in the darkroom view using a scene-referred workflow. You are advised to follow the guidelines provided below, up to the end of the image processing in 3 modules section and then choose other areas to learn as-and-when you need to use those techniques in your images.\n🔗getting started 🔗take a well-exposed photograph Good image processing techniques start in the camera \u0026ndash; a well-exposed image (without blown highlights or heavily crushed blacks) will always make post-processing much more straightforward. Under- or over-exposure can be \u0026ldquo;fixed\u0026rdquo; by darktable to some extent but no software can recover information that is not present in the Raw image (clipped highlights). Where possible, you are advised to use exposure to-the-right (ETTR) techniques to maximize the amount of data available for processing while avoiding clipping. As a general rule of thumb, in cases where the scene-dynamic-range exceeds that of your camera, it is safe to underexpose all images by 0.5 to 1 EV (by reducing the ISO sensitivity if possible) even if the in-camera preview looks darker than expected (the preview is not the raw data). If the scene dynamic range is lower than that of your camera, you may wish to dial in some over-exposure (decrease shutter speed or increase aperture) to capture more light and reduce noise.\n🔗scene-referred workflow: a new approach If you have used other Raw software in the past (or darktable prior to version 3.0) you may notice some significant differences from what you are used to \u0026ndash; darktable now uses a scene-referred approach for most of its processing modules. This approach is used extensively in cinematography and is known to be much more robust than the traditional display-referred approach.\nIn display-referred processing the data from your Raw file is initially compressed into a range that represents pure black as 0 and pure white as 1, fixing mid-gray at 0.5. A tone curve is automatically (and irreversibly) applied to this data to make the image look \u0026ldquo;good\u0026rdquo; on your display and subsequent edits are carried out on top of this already highly-modified image data. The cost of display-referred is an early loss of the relationship between pixel luminosity and saturation (usually also involving hue shifts), which is responsible for the infamous \u0026ldquo;HDR look\u0026rdquo; when the dynamic range increases.\nIn the real world, \u0026ldquo;pure black\u0026rdquo; does not really exist (there is always some light) and there is no limit to how bright things can be (so no \u0026ldquo;pure white\u0026rdquo; either). Scene-referred processing attempts to retain the physical properties of the scene for as long as possible by placing the Raw data on an unbounded linear scale and only compressing the data to the dynamic range of your display after image processing is complete.\nIn a scene-referred workflow many common tools (tone curves and levels, for example) are no longer useful ways to manipulate the image, since they rely on now-invalid definitions of black, white and gray. Experienced users may need to learn new techniques and discard old ones, but will be rewarded with much more robust and predictable outputs.\nThe scene-referred workflow in darktable enables the filmic rgb and exposure modules by default when you open new images in the darkroom view.\n🔗white balance and color calibration Most processing software uses a traditional temperature/tint model for adjusting the white balance of an image. In darktable, the color calibration module provides a much more robust and flexible approach, allowing you to explicitly define the color of the light source. This is particularly useful for scenes illuminated by artificial lighting.\nPlease note that the white balance module is still enabled in this approach, but its settings normally should not be altered.\nSet preferences \u0026gt; processing \u0026gt; auto-apply pixel workflow defaults to \u0026ldquo;scene-referred (filmic)\u0026rdquo; now.\nEnter preferences by clicking on the gear icon in the top panel.\n🔗edit in a controlled environment Image processing should be performed in a controlled environment, lit by a white light source against a background approximating mid-gray, and on a monitor that has been properly calibrated.\nWhile this may not be practical in many home editing environments you can control the background colors on your monitor\u0026rsquo;s display. You should set the darktable color scheme to use one of the \u0026ldquo;grey\u0026rdquo; themes and use the color assessment mode when altering tones and colors in your image. Dark themes might look good but, unless you are processing images to be viewed on a cinema screen in a darkened room, they should not be used for photo processing.\nSet preferences \u0026gt; general \u0026gt; theme to \u0026ldquo;darktable-elegant-grey\u0026rdquo; or \u0026ldquo;darktable-icons-grey\u0026rdquo; now.\n🔗enter the darkroom Choose an image to edit from the lighttable view and double-click to load that image into the darkroom view. For now try to choose an image that is well exposed \u0026ndash; we will discuss some techniques to recover badly-exposed images later.\nIn the darkroom view, you will see a list of processing modules to the right of your image. Each module performs its own processing on the image, in the order shown in the module list, starting at the bottom of the list and moving up to the top. You can think of this like a stack of building blocks where each block builds on the processing performed by the modules below it.\nOn the left hand side is the history stack (you may need to expand the module), which shows the order in which adjustments were made to the controls of the various modules. This allows you to undo changes by reverting to an earlier step in the history stack. You will see that a number of modules are applied automatically \u0026ndash; these are needed in order to generate a legible image from the Raw data.\nIt is important to understand the distinction between the order of the modules on the right-hand-side of the screen (which represents the order in which modules are executed) and the order of the modules in the history stack (which represents the order in which modules were modified).\nTo the top right is the scopes module, which shows the spread of tones/colors in your image.\nIf you have previously viewed or edited the image in the darkroom view, start by discarding history (click the reset button in the history stack). This will reapply defaults using your new settings and provide a clean starting point for editing.\n🔗why doesn\u0026rsquo;t the raw image look like the JPEG? \u0026hellip;because you haven\u0026rsquo;t processed it yet\nOne of the first things people notice when switching from lighttable to darkroom view is that the image looks different \u0026ndash; often flatter and less saturated than that shown in the lighttable view. This is because the darkroom view displays the (mostly unprocessed) Raw image, but the lighttable view initially displays the (in-camera) JPEG preview. Now that you have opened the image in the darkroom view, the lighttable view will update to show the edited version.\nMost Raw software goes to great lengths to reproduce the look of standard camera JPEGs out of the box. While this can be useful (if you only want to make very minor adjustments to the camera\u0026rsquo;s rendition of an image) we assume that you are using a Raw editor to make the image your own, and that the camera does not know how to do this. Certainly, if you are using the ETTR techniques mentioned above, the camera JPEG will rarely be close to how you want the final image to look.\nThe default settings in darktable are therefore intended to provide you with a neutral starting point for further editing and nothing more. We do not intend to change this.\n🔗module groups Below the scopes module, at the top right of the screen, is a set of tabs into which darktable\u0026rsquo;s modules are grouped. If you cannot find a module in one of the tabs you can use the search feature to locate it.\nFor the purposes of this guide, click on the hamburger icon (to the right of the tabs) and select the \u0026ldquo;workflow: scene-referred\u0026rdquo; preset now.\n🔗image processing in 3 modules The following basic adjustments are fundamental to scene-referred editing and will be required, to some extent, on the majority of images. You can usually produce a good-looking image with these steps alone.\nAs you will be adjusting the tones and colors of the image, start by enabling color assessment mode (press Ctrl+B) and perform the following edits on the zoomed-out image while in this mode.\nSet overall image brightness: First, set the overall (average) brightness of the image (the mid-gray point) by adjusting the exposure slider in the exposure module. This is a purely artistic setting and should be defined based on your intent \u0026ndash; for example, for a high-key image you will set the average brightness to be lighter than for a low-key image. The color assessment mode provides you with two reference points to assist with this by surrounding the image with a white frame against a middle-gray background.\nAt this point, don\u0026rsquo;t worry if the brightest parts of your image lose detail \u0026ndash; this can be recovered in the next step.\nNote: The lens correction module can also affect the image brightness so you may want to consider enabling it before adjusting exposure.\nSet white and black points: The next two steps use the filmic rgb module to define how the tones in your image will be mapped to the dynamic range of your display. Start by setting the white and black relative exposure sliders in the scene tab. These are purely technical settings, defining white and black relative to the mid-gray point you set in the previous step. If your image contains tones you want to treat as pure white or pure black you can use the pickers beside the sliders to set these values (using the maximum and minimum brightness of the image). Otherwise set the values manually using the color assessment frames as a reference.\nAdjust the contrast: Now move to the look tab in filmic rgb (for now we will skip the reconstruct tab). Enable the look only view at the top of the module to see a representation of the filmic tone curve, which consists of a straight section in the middle (used to set the contrast of the mid-tones) and curved sections at the top and bottom (where the shadows and highlights are compressed to fit the dynamic range of the display).\nThe contrast slider changes the slope of the straight section (the mid-tone image contrast), the latitude slider changes its length and the shadows/highlights balance slider changes its position. There is a lot of give-and-take involved here \u0026ndash; if you want to increase the contrast of the mid-tones, you must sacrifice contrast in the shadows/highlights and vice versa. The default settings of this module are tuned to work for the majority of images but you should experiment with these sliders to understand how they affect the image.\nNote: The highlight compression in the filmic rgb module can cause detail to be lost in the highlights. You can mitigate this to some extent by reducing the white relative exposure, adjusting the shadows/highlights balance or changing the contrast in highlights setting in the options tab. The tone equalizer module can also be used to reduce the relative brightness of the sky.\nColor preservation: The tone mapping in the filmic rgb module attempts to redistribute the tones in your image without affecting color reproduction. While the default color preservation algorithm works for most images, you are encouraged to experiment by changing the preserve chrominance setting in the options tab if you do not like how the colors appear.\nSaturation: Your image will probably not look very colorful at this point. You can adjust the global saturation of the image using the color balance rgb module. The \u0026ldquo;basic colorfulness\u0026rdquo; preset should provide you with generally-reasonable defaults, but you are encouraged to experiment further with these settings as required.\nNote: This guide assumes that the white balance of the image has been correctly captured by your camera. If this is not the case, you may need to make some corrections in the color calibration module first.\nYou can now switch off color assessment mode by pressing Ctrl+B again.\n🔗other processing techniques With practice the above workflow can quickly provide you with a reasonable-looking image, though most will need some additional work before they are ready for export. The following sections are intended to provide a brief outline of some more image processing techniques in darktable, with links to the relevant reference sections for more information.\nAs a general rule, you should begin with the basic steps outlined in the previous section, then perform corrections and finish with creative adjustments.\n🔗corrections 🔗color calibration Traditional white balance correction attempts to ensure that whites and grays are really neutral (R = G = B) and doesn’t really try to manage the impact on other colors. The CAT tab of the color calibration module extends this treatment to handle the remainder of the color range and works in a color space designed specifically for chromatic (color) adaptation. As with traditional white balance controls you can select a patch of neutral gray in your image to calculate the white balance, or use a selection of other automatic and manual methods. The default settings use the white balance from the image\u0026rsquo;s Exif data and are usually sufficient.\nIf you need to make adjustments in the color calibration module, you may want to also revisit any saturation corrections you made earlier in the color balance rgb module.\n🔗correct lens distortions All lenses introduce some artifacts (distortion, chromatic aberrations, vignetting) to the image. The lens correction module can correct many of these issues for a wide variety of lenses. The chromatic aberrations and raw chromatic aberrations modules can also be used to handle chromatic aberrations for lenses that are not (or only partially) supported by lens correction. In most cases simply enabling the lens correction module will auto-detect your lens and auto-apply all available corrections.\nIf you decide to use the lens correction module, it should be enabled at the start of your edit, before you adjust exposure, since vignetting correction can alter the overall brightness of your image.\n🔗reduce noise / retain detail At a pixel level there is a trade-off to be made between the retention of fine details and the reduction/removal of sensor noise. In most situations, a small amount of noise is perfectly acceptable and will not be noticeable except when you zoom in to 100%. At this scale you are not viewing the image at a realistic size \u0026ndash; even when represented on a large monitor or print, noise that is obvious at high zoom factors will be virtually invisible on the final image. However, some modules further along the image pipeline (especially those that increase local contrast) may end up exaggerating any noise that is present so, again, there are trade-offs to be made.\nThe first module you can use to manage this is demosaic, which controls how the single-color (R, G or B) pixels in your Raw file are converted to image pixels combining all three colors. Each demosaic algorithm has its own trade-offs between retaining fine detail and reducing noise. The default demosaic algorithm (RCD) usually provides a reasonable compromise.\nDemosaic algorithms can only do so much to manage noise in your image. The denoise (profiled) module is individually tuned for a number of common camera sensors and can be used to reduce or remove pixel noise. As with demosaic you should alter the settings until you are happy with the balance of denoising vs fine-detail reproduction. The default settings are usually sufficient.\n🔗sharpness and local contrast A number of modules can be used to adjust the local contrast and sharpness of your image. Most of these modules aim to enhance the apparent contrast of edges and do not add \u0026ldquo;real\u0026rdquo; sharpness (they are not the same as lens deconvolution). You should take care when using these modules as most of them can introduce artifacts (such as halos) when settings are pushed too far:\nthe contrast equalizer module allows you to adjust contrast, limiting the effect to certain feature sizes. For example you can use it to increase the contrast of fine details without impacting larger-scale objects, or vice versa the diffuse or sharpen module offers a number of presets for sharpening, lens deblurring and the addition of local contrast the local contrast module provides a simpler interface for quickly adding local contrast to your images \u0026ndash; just enabling the module or selecting one of the presets is often all that is required the sharpen module is intended to re-introduce sharpness that was removed by your camera\u0026rsquo;s anti-alias filter (if present) and can be enabled by default in preferences \u0026gt; processing. The methods listed above are usually preferred to this legacy module. As with the modules mentioned in the previous section, you should take care when adding contrast to small-scale objects \u0026ndash; an image viewed at 100% is not a realistic representation of your final edit and local contrast adjustments are usually better judged when zoomed out.\n🔗reconstruct blown highlights While a well-exposed image will make post-processing much easier, darktable does provide a few tools to handle blown highlights.\nThe highlight reconstruction module attempts to reconstruct blown highlights (colors and structure) using adjacent pixels. A number of different approaches are provided, some of which may be better on certain images, however, the default algorithm produces good results in most cases.\nEven well-reconstructed highlights can show color and edge artefacts, some of which may be exacerbated by subsequent modules in the pipe. In this case the reconstruct tab on the filmic rgb module provides additional methods to further smooth/correct highlights at the end of the processing pipeline.\n🔗adjust angle and perspective The rotate and perspective module can be used to adjust the angle of the image or to simulate the functionality of a tilt/shift lens by altering the perspective, making converging horizontal and/or vertical lines parallel (keystone correction). This latter technique is most commonly used for architectural photography. If you just want to correct the angle of the horizon you can do this by right-clicking and dragging along the horizon line.\n🔗remove spots and unwanted objects Use the retouch module to remove unwanted objects by replacing pixels with detail from elsewhere in the image. This module also offers powerful techniques for removing large-scale objects (such as spots or blemishes) while leaving fine-scale details (like hairs and follicles) intact. The most common use for this module is to remove dust spots from images or blemishes from skin.\n🔗remove atmospheric haze There are two methods for removing atmospheric haze in darktable. The haze removal module provides a much simpler interface, but the \u0026ldquo;dehaze\u0026rdquo; preset in the diffuse or sharpen module can provide more flexibility when needed.\n🔗creative adjustments 🔗crop and frame Use the crop module to crop your image and the framing module to surround your image with a colored frame. Both modules can be set to use a predefined or custom aspect ratio \u0026ndash; for example, you could place a square-cropped image into a 3:2 frame.\n🔗dodge and burn Dodging and burning is a traditional darkroom technique to add and remove brightness from an image. There are two recommended ways to achieve this\nIf you want to selectively dodge or burn only certain objects you can apply a new instance of the exposure module using a drawn mask to isolate the effect to the required area of the image (see also the mask refinement section for more information). Move the exposure slider to alter the brightness of the masked area. If you wish to dodge or burn areas with a similar brightness (for example, to brighten the shadows or darken the highlights) you should use the tone equalizer module. 🔗convert to monochrome darktable provides a number of ways to remove the color from your image. The most flexible method is to use the gray tab of the color calibration module. A number of film emulation presets are available in this module to provide you with a starting point.\nSee the developing monochrome images section for details of other techniques.\n🔗color grading The color balance rgb module is your one-stop-shop for controlling the colors in your image. Adjustments can be isolated to the shadows, highlights and mid-tones, or applied at a global level.\n🔗other important topics 🔗reuse common module settings If you find yourself using the same module parameters repeatedly, you can create presets containing your favorite settings. If you use the same settings on every image, you can also make presets apply automatically to new images. For example, you may find yourself adding the same exposure settings to every image taken by a certain camera \u0026ndash; in this case you can create a preset that automatically applies those corrections only to images from that camera.\nYou may also have groups of module settings that you commonly apply only to certain types of image. You can use styles to apply multiple module settings at once to a selection of images.\n🔗perform adjustments locally Most darktable modules can either be applied to the whole image, or restricted to parts of the image using drawn and parametric masks.\n🔗control darktable with other input methods You don\u0026rsquo;t need to use the darktable UI to make adjustments to your images. Most of the functionality in darktable can also be controlled using shortcuts defined with your keyboard/mouse and even with other input devices such as game controllers and MIDI devices. See the shortcuts section for details.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/workflow/process/","tags":null,"title":"process"},{"categories":null,"content":"The quick access panel allows you to access widgets from a number of processing modules all in one place.\nYou can add new widgets to the panel by\nright-clicking on the \u0026ldquo;hamburger\u0026rdquo; icon at the top-left of the panel using the manage module layouts screen Ctrl+clicking on a widget in a processing module while in visual shortcut mapping mode Click on the icon to the right of the module name to open the full version of that module. Click on the icon to the left of the module name to enable/disable the module.\nIf any module has multiple instances enabled you will no longer be able to manage that module\u0026rsquo;s widgets through the quick access panel and will have to use the full module interface.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/organization/quick-access-panel/","tags":null,"title":"quick access panel"},{"categories":null,"content":"darktable can render colors either with its own internal algorithms or by using the external library LittleCMS2. darktable\u0026rsquo;s internal method is, by an order of magnitude, faster than the external one. The external option gives you a choice of the rendering intent and might offer a slightly higher accuracy in some cases.\nYou can change the default method in preferences \u0026gt; processing \u0026gt; always use LittleCMS 2 to apply output color profile\nNote: If the given ICC is LUT-based or contains both, a LUT and a matrix, darktable will use LittleCMS2 to render the colors regardless of the configuration parameter\u0026rsquo;s value.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/rendering-method/","tags":null,"title":"rendering method"},{"categories":null,"content":"In the “source image” tab you set your source image, which requires two elements. The first element is an input file in Lab Portable Float Map format (extension .pfm). The source file represents the largely unmodified data as the camera sees it. Information about how to take photos of a color reference card and produce a .pfm output file are described below. The second element is a chart file that contains a formal description of the underlying color reference card\u0026rsquo;s layout (extension .cht). Chart files are usually shipped with your color reference card or can be downloaded from the internet.\nIn real life the photo taken from the color reference card will show some perspective distortions relative to the layout defined in the chart file. For that reason the layout is displayed as a grid over the image and can be modified.\nYou can move the corners of the grid using the mouse to reach best alignment of grid and image.\nA rectangular frame is displayed for each patch and defines the area from which darktable-chart will sample the required input data. You may need to modify the size of these rectangles so that the sampling area is big enough but does not overlap with neighboring patches. Use the “size” slider in the upper right part of the GUI. Higher values lead to smaller sizes.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/darktable-chart/source-image/","tags":null,"title":"source image"},{"categories":null,"content":"The history stack stores the entire editing history for a given image, in the order in which those edits were applied. It is saved to darktable\u0026rsquo;s library database and the image\u0026rsquo;s XMP sidecar file and persists between editing sessions.\nEach time a processing module is enabled, disabled, moved or amended a new entry is added to the top of the history stack.\nThe history stack can be queried and modified within the history stack module in the darkroom.\nNote: The history stack is not a representation of the order in which the modules are executed but the order in which they were amended. The execution order is represented by the order of the modules in the right-hand panel.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/pixelpipe/history-stack/","tags":null,"title":"the history stack"},{"categories":null,"content":"Each image in the current collection is represented by a thumbnail in the lighttable view and filmstrip module. A cache of the most recently used thumbnails is stored in a file on disk and loaded into memory at startup.\n🔗thumbnail creation A thumbnail is created when an image is imported into darktable for the first time, after an image has been modified in the darkroom, or when revisiting an image whose thumbnail is no longer available.\nWhen an image is imported for the first time darktable can either try to extract an embedded thumbnail from the input image (most raw files contain these, usually in JPEG format) or process the raw image itself using default settings. You can define how darktable obtains its thumbnails in preferences \u0026gt; lighttable \u0026gt; thumbnails.\nExtracting an embedded thumbnail from the input image is usually very fast. However, these thumbnails have been generated by the raw converter of the camera and do not represent darktable\u0026rsquo;s “view” of that image. You will notice the difference as soon as you open the image in the darkroom mode, at which point darktable replaces the thumbnail with its own internally processed version.\nAfter import darktable automatically generates thumbnails for new images as they are needed. When importing a large set of new images, thumbnail generation can slow down navigation in the lighttable view. Alternatively you may terminate darktable and generate the thumbnail cache separately by running darktable-generate-cache. This program will generate all missing thumbnails in one go.\nAs the thumbnail cache has a pre-defined maximum size it will eventually get filled up. If new thumbnails are subsequently added, old thumbnails are dropped from the cache. However, darktable will keep all thumbnails on disk if the corresponding disk backend option is activated in preferences \u0026gt; lighttable \u0026gt; thumbnails. Access to the thumbnails in this secondary cache is slower than the primary cache, but still much faster than reprocessing thumbnails from scratch. The size of the secondary cache is limited only by the available disk space.\nThumbnails are never removed from the secondary cache. You can manually clean the secondary cache by recursively deleting all images in the $HOME/.cache/darktable/mipmaps-xyz.d folder (where xyz denotes an alphanumeric identifier of the cache). After clearing the secondary cache you can simply allow darktable to re-generate thumbnails as needed, or you can generate all thumbnails in one go with darktable-generate-cache.\nIf you choose not to activate the disk backend and select too small a cache size, darktable may become unresponsive, you may experience continuous regeneration of thumbnails when you navigate your collection or flickering of thumbnail images. A good choice of cache size is 512MB or higher (see memory \u0026amp; performance tuning for more information).\nAll thumbnails are fully color managed. Colors are rendered accurately on screen as long as your system is properly set up to hand over the right monitor profile to darktable. For more information see the color management section.\n🔗skulls If for some reason darktable is unable to generate a thumbnail, it displays an image of a skull instead. Don\u0026rsquo;t panic!\nThere are three main reasons this could happen:\nMissing image file: darktable remembers all images it has ever imported, as long as they have not been removed from your database. If darktable wants to create a thumbnail but is not able to open the input file, a skull is displayed instead. Users are advised to remove images from the database using the actions on selection module before physically removing them from disk. Alternatively you may occasionally run the script purge_non_existing_images.sh from darktable\u0026rsquo;s toolset to clean-up your database.\nInvalid image format: While the extension of an image may seem to be supported by darktable, its contents could be either an unsupported image format or a corrupt file.\nLow memory: If darktable runs out of memory while generating a thumbnail, it will warn you and display a skull. This can happen if darktable is run with sub-optimal settings, especially on a 32-bit system. See memory \u0026amp; performance tuning for more information.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/digital-asset-management/thumbnails/","tags":null,"title":"thumbnails"},{"categories":null,"content":"Most changes made within the lighttable are recorded and can be reverted to a previous state. This includes modifications to color labels, ratings, geo-localization, tags, metadata, orientation, copy/paste of history, image duplication, or application of a style. Note that the facility to undo/redo actions is unlimited in the number of steps while in the lighttable view, but it is reset each time you switch to a different view.\nPress Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/undo-redo/","tags":null,"title":"undo/redo"},{"categories":null,"content":"🔗memory requirements Processing a Raw image in darktable requires a great deal of system memory. A simple calculation makes this clear: For a 20 megapixel image, darktable requires a 4x32-bit floating point cell to store each pixel, meaning that each full image of this size will require approximately 300MB of memory just to store the image data. In order to actually process this image through a given module, darktable needs at least two buffers (input and output) of this size, with more complex modules potentially requiring several additional buffers for intermediate data. Without further optimization, anything between 600MB and 3GB of memory might be required to store and process image data as the pixelpipe executes. On top of this is darktable\u0026rsquo;s code segment, the code and data of any dynamically-linked system libraries, as well as further buffers that darktable uses to store intermediate states (cache) for quick access during interactive work.\nAll in all, darktable requires at least 4GB of physical RAM plus 4 to 8GB of additional swap space to run but it will perform better the more memory you have.\nAs well as executing on your CPU, many darktable modules also have OpenCL implementations that can take full advantage of the parallel processing offered by your graphics card (GPU). Similarly, the more GPU memory you have, the better darktable will perform.\n🔗tiling If darktable does not have sufficient memory to process the entire image in one go, modules may choose to use a \u0026ldquo;tiling strategy\u0026rdquo;, wherein the image is split into smaller parts (tiles) which are processed independently, and then stitched back together at the end. While this allows images to be processed with a much smaller memory footprint, it does also come with some down-sides:\ntiling is always slower \u0026ndash; sometimes up to 10x slower, though for some modules the difference is negligible, tiling is not technically possible for some modules because of the nature of the underlying algorithms For most systems, tiling will probably only be used for full-sized image exports, with interactive work in the darkroom being processed more efficiently. For best performance (and avoidance of tiling modes) you should run darktable alongside as few other applications as possible and configure darktable to use as much of your system and GPU memory as you can.\n🔗performance tuning There are a number of configuration parameters that can help you to fine-tune your system\u0026rsquo;s performance. Some of these parameters are available in preferences \u0026gt; processing \u0026gt; CPU / memory and others need to be modified directly in darktable\u0026rsquo;s configuration file (found in $HOME/.config/darktable/darktablerc).\nThis section provides some guidance on how to adjust these settings.\n🔗how to test In order to determine how much your modifications improve (or not) darktable\u0026rsquo;s performance, you will need one or more sample images to test with, and a method of assessing the speed of the pixelpipe.\nFor sample images, you are advised to use some of the more intensive modules, such as diffuse or sharpen or denoise (profiled). Exports are likely to have more consistent and comparable timings between pipe runs than interactive work (and will also push your hardware more).\nIn order to obtain profiling information you need to start darktable from a terminal with darktable -d opencl -d perf. If you want more information about tiling you should use darktable -d opencl -d tiling -d perf.\nEach time the pixelpipe is processed (when you change module parameters, zoom, pan, export etc.) you will see (in your terminal session) the total time spent in the pixelpipe and the time spent in each of the OpenCL kernels. The most reliable value is the total time spent the in pixelpipe and you should use this to assess your changes.\nNote: The timings given for each individual module are unreliable when running the OpenCL pixelpipe asynchronously (see asyncronous mode below).\nTo allow for efficient processing with OpenCL it is essential that the GPU is kept busy. Any interrupts or a stalled data flow will add to the total processing time. This is especially important for the small image buffers used during interactive work, which can be processed quickly by a fast GPU. However, even short-term stalls of the pixelpipe can easily become a bottleneck.\nOn the other hand darktable\u0026rsquo;s performance during file exports is more or less only governed by the speed of the algorithms and the horse-power of your GPU. Short-term stalls will not have a noticeable effect on the total time of an export.\n🔗darktable resources The \u0026ldquo;darktable resources\u0026rdquo; preference (in preferences \u0026gt; processing \u0026gt; CPU / memory) allows you to choose between four different approaches to allocating your system\u0026rsquo;s resources to darktable. Each of these options controls multiple individual parameters, which are defined independently in $HOME/.config/darktable/darktablerc. You can amend any of these directly within your darktablerc file to tweak values for your selected resource level, though you cannot add your own custom resource level to the preferences drop-down.\nNote: The unrestricted mode really \u0026ldquo;takes it all\u0026rdquo;. This might seem to be the best setting to use but, especially when exporting large images with high quality, unrestricted memory use can cause swapping, which might lead to impaired performance or darktable being silently killed by your operating system.\nEach of the four \u0026ldquo;darktable resources\u0026rdquo; options are defined as follows:\nresource_default=512 8 128 700 resource_large=700 16 128 900 resource_small=128 4 64 400 resource_unrestricted=16384 1024 128 900 More generally, these can be represented as resource_level=a b c d where a - d are defined as follows:\na. system memory for module processing The maximum amount of system memory made available for module processing. Lower values force memory-hungry modules to process images with an increasing number of tiles. This number is a fraction of the total amount of system memory, divided by 1024. For example, on a system with 16GB of total system memory the amount assigned by resource_default (in GB) is 16 * 512 / 1024, or 8GB of system RAM. b. minimum tiling buffer size The minimum size of a single tiling buffer, similarly expressed as a fraction of total system memory. For example, on a system with 16GB of total system memory the amount assigned by resource_default (in GB) is 16 * 8 / 1024, or 0.125GB of system RAM. Note that this setting is largely historic and is no longer of much practical use \u0026ndash; you are advised to leave it at its default value. c. thumbnail cache memory The amount of memory to use for the thumbnail cache. Again, this is expressed as a fraction of total system memory and, on a 16GB system, the amount assigned by resource_default is 16 * 128 / 1024, or 2GB of system RAM. d. OpenCL (GPU) memory The maximum amount of GPU memory made available for module processing. As with system memory, lower values will force memory-hungry modules to process images with an increasing number of tiles. Your GPU memory will likely also be used by other applications on your system. However, in contrast to system memory, your GPU is not able to take advantage of swap files and it is impossible for darktable to know how much memory is available at a given time. If this parameter is set too high, darktable could be forced to fall back to CPU processing (which will be significantly slower but stable and with correctly processed data) or darktable might crash and even make your system unusable. For this reason, the GPU memory parameter fraction also includes an extra 600MB of headroom in an attempt to avoid over-allocation of memory. For example, on a GPU with 6GB of memory, darktable will use approximately (6 - 0.6) * 700 / 1024, or 3.5GB of GPU RAM when using the resource_default level. In addition to the resource levels presented in the UI the following options can be set via the command-line (e.g. darktable --conf resourcelevel=\u0026quot;notebook\u0026quot;). These modes are designed for debugging tiling issues and testing performance of common systems on larger development machines. The following options are provided:\n\u0026ldquo;mini\u0026rdquo; (1GB ram, 2MB single buffer, 128MB thumbnail cache, 200MB OpenCL memory) \u0026ldquo;notebook\u0026rdquo; (4GB ram, 32MB single buffer, 512MB thumbnail cache, 1GB OpenCL memory) \u0026ldquo;reference\u0026rdquo; (8GB ram, 32MB single buffer, 512MB thumbnail cache, 2GB OpenCL memory) 🔗tuning GPU memory usage If you want to make maximal use of your GPU memory for OpenCL, you have three options:\nChoose the \u0026ldquo;large\u0026rdquo; resource level. For a 6GB card, this will use approximately 5GB of GPU memory, leaving 1GB for the rest of your system. (recommended) Alter darktablerc to increase the last number (the OpenCL memory fraction) for your selected resource level. For example, increasing the OpenCL memory fraction to 950 would increase the available memory on a 6GB GPU to approximately 5.3GB. (absolutely not recommended) Set preferences \u0026gt; processing \u0026gt; OpenCL \u0026gt; use all device memory to \u0026ldquo;on\u0026rdquo;, which will use all of your device\u0026rsquo;s memory, less a 600MB headroom. Please see the section below for \u0026ldquo;per device setting\u0026rdquo; of headroom. 🔗balanced OpenCL versus CPU tiling In most cases, running a processing module on a high-powered GPU (the OpenCL codepath) is significantly faster than running the same module using the CPU codepath. However, many users have fast multi-core CPUs with a large amount of system RAM, but a GPU with significantly lower capabilities (typically, integrated graphics with small amounts of dedicated memory). Use of OpenCL code in these cases can lead to excessive tiling, and it is often better to run a module without tiling using the CPU codepath than to attempt to use OpenCL with heavy tiling.\nWhile processing the pipeline, darktable attempts to determine which mode will be best for a given module by estimating the expected workloads for both OpenCL and CPU codepaths. In most cases it will prefer the OpenCL codepath even if that would mean tiling the image, since OpenCL is typically much faster than running the CPU code (often as much as 10 times faster if it is a dedicated card).\nIf the ratio of estimated workloads (CPU vs GPU) is larger than the advantage hint (see below), darktable will use the CPU for processing that module, else it will use the GPU.\n🔗device-specific OpenCL configuration The default darktable settings deliver a reasonable GPU performance on most systems. However, if you want to try to optimize things further, this section describes the relevant configuration parameters (all of which are set in your darktablerc file).\nMost of the OpenCL-related options are managed with a \u0026ldquo;per device\u0026rdquo; strategy. The configuration parameter for each device looks like:\ncldevice_v5_nvidiacudaquadrortx4000=0 250 0 16 16 128 0 0 0.000 0.000 0.500\nor, more generally\ncldevice_version_canonicalname=a b c d e f g h i j k\nAn entry will be automatically created in darktablerc for each newly-detected device when you launch darktable for the first time, with the correct canonical device name and version number. The parameters a - k are defined as follows and can be manually edited:\na. avoid atomics 1 = avoid atomics; 0 = use atomics (default) Atomic operations in OpenCL are a special method of data synchronization and are only used in a few modules. Unfortunately, some old AMD/ATI devices are extremely slow in processing atomics and, on these cards, it is better to process the affected modules on the CPU rather than accepting an ultra-slow GPU codepath. Set this parameter to 1 if you experience slow processing within modules like shadows and highlights, monochrome, local contrast, or global tonemap (deprecated) or if you get intermittent system freezes. Please note that this should not affect any card manufactured since 2015. b. micro nap default 250 In an ideal case you will keep your GPU busy at 100% when processing the pixelpipe. However, if your GPU is also required to update your screen, and darktable is using it at 100%, there may not be sufficient time left for this task. This will usually manifest as jerky GUI updates on panning, zooming or when moving sliders. To resolve this issue darktable can add small pauses into its pixelpipe processing so that the GPU can catch its breath and perform GUI related activities. The \u0026ldquo;micro nap\u0026rdquo; parameter controls the duration of these pauses in microseconds. On all current systems you are safe with the default value. If you are using multiple devices or you are not using your discrete GPU for drawing on your screen, this value can be set to 0 for all non-desktop devices leading to improved performance.\nc. pinned memory 0 = disable pinned transfer (default); 1 = enforce pinned transfer During tiling huge amounts of memory need to be transferred between host and device. On some devices direct memory transfers to and from an arbitrary host memory region may give a large performance penalty. This is especially noticeable when exporting large images on smaller graphics cards or while using newer modules like diffuse or sharpen or the guided laplacians mode in the highlight reconstruction module. There is no safe method or general rule to predict whether or not this parameter will provide a performance benefit, so you will have to experiment for yourself. However, the chance of pinned transfer leading to an improvement is pretty low if your card was manufactured after 2015.\nd. clroundup wh / e. clroundup ht These parameters should be left at this default value \u0026ndash; testing has not shown any benefit to using other values. f. number of event handles default 128 Event handles are used by darktable to monitor the success/failure of kernels and provide profiling info even if the pixelpipe is executed asynchronously. The number of event handles is a limited resource of your OpenCL driver \u0026ndash; while they can be recycled, there is a limited number that can be used at the same time. Unfortunately, there is no way to find out what the resource limits are for a given device (this is due to darktable using the OpenCL V.1.2 API to support all platforms), so darktable uses a conservative guess of 128 by default. On most current devices and drivers you can expect a number of up to 1024 to be safe (for sure if your driver / card reports OpenCL V.2.0 or larger) leading to a slightly better OpenCL performance. If your driver runs out of free handles you will experience failing OpenCL kernels with error message CL_OUT_OF_RESOURCES or even crashes or system freezes. (If you are running into this problem, please open a github issue) A value of 0 will block darktable from using any event handles. This will prevent darktable from properly monitoring the success of your OpenCL kernels but saves some driver overhead leading to a slightly better performance (less than 5%). The consequence is that all failures will lead to garbled output without darktable noticing. This is only recommended if you know for sure that your system runs rock-solid.\ng. asynchronous mode 1 = use asynchronous mode; 0 = don\u0026rsquo;t use (default) This flag controls how often darktable blocks the OpenCL pixelpipe to get a status on success/failure of the kernels that have been run. For optimum latency set this to 1, so that darktable runs the pixelpipe asynchronously and tries to use as few interrupts/events as possible. If you experience OpenCL errors like failing kernels, reset the parameter to 0. This will cause darktable to interrupt after each module so that you can more easily isolate any problems. Issues have been reported with some older AMD/ATI cards (like the HD57xx) which can produce garbled output if this parameter is set to 1. If in doubt, leave it at its default of 0. h. disable device 0 = enable device; 1 = disable device If darktable detects a malfunctioning device it will automatically mark it as such by setting this parameter to 1. If you have a device that reports a lot of errors you can manually disable it by setting this field to 1. If darktable has disabled the device but you are sure it should be used you can re-enable it by setting this field to 0. i. reserved\nj. advantage hint This defines the advantage hint described in the balanced OpenCL versus CPU tiling section. If you have a fast graphics card with plenty of memory you can safely leave this at its default value of 0.000. However, if you want to adapt this number to your own system, you should use the following process: Start darktable with the tiling debug option (darktable -d tiling) and start editing an image in the darkroom. Open the highlight reconstruction module and use the \u0026ldquo;guided laplacians\u0026rdquo; method, setting the \u0026ldquo;diameter of reconstruction\u0026rdquo; to a high value, while ensuring that tiling does not occur (check the debug information in your terminal session while adjusting the slider). Check the execution times of this module with OpenCL on and off (by running darktable -d perf to examine the performance). Set the \u0026ldquo;advantage hint option\u0026rdquo; to approximately (CPU execution time / GPU execution time). k. shared memory fraction Some OpenCL devices don\u0026rsquo;t have dedicated memory but share it with the CPU \u0026ndash; Apple ARM silicon is one example but also onboard devices from Intel, AMD or ARM SOCs. As we want to keep system memory available for caching or CPU codepaths we restrict the amount of all memory used to the given fraction. So with the default of 0.5 and an Apple computer with 16GB of system RAM, OpenCL would be able to make use of 8GB. Note: if darktable detects a \u0026ldquo;buggy\u0026rdquo; device configuration key it will be rewritten back to default values.\n🔗id-specific OpenCL configuration A second device-specific configuration key is also provided, which takes into account both the device name and the device id (in case you have two identical devices). In this case, the usual key name cldevice_version_canonicalname is followed by _idX with X being the device id. For example, if the above example device was referred to as device 0, the second configuration setting would (by default) be cldevice_v5_quadrortx4000_id0=600.\nThis configuration key currently only has a single parameter defined:\nforced headroom (default 600) The amount of memory (in MB) that will not be used by darktable during OpenCL processing. This setting is only valid if you set preferences \u0026gt; processing \u0026gt; OpenCL \u0026gt; use all device memory to \u0026ldquo;on\u0026rdquo;. If you are certain that no apps (or your OS) make use of the specific device you can set this parameter to 0 for the otherwise-unused device so that darktable will use all of that device\u0026rsquo;s memory.\nThe default of 600MB should be fine for most systems. If you find you run into performance problems due to darktable falling back to CPU, try changing it to 800 or larger.\n🔗other configuration keys The following additional configuration keys are also available in darktablerc:\ncldevice_version_canonicalname_building This option is used when compiling OpenCL kernels and may be provided for performance tuning or to work around bugs. You must remove any existing kernels in order to recompile them with the new options. Provide an empty string to recompile without any options. Remove the setting entirely to recompile with default options, default is -cl-fast-relaxed-math for nvidia drivers, all other cards don\u0026rsquo;t have this compiler option set. The -cl-fast-relaxed-math option significantly improves performance but changes maths in the module\u0026rsquo;s processing code possibly leading to different results. For current Intel implementations this compiler flag leads to visibly wrong results, on AMD cards the results are non-conclusive. Some card/driver combinations are fine, some are not. As the AMD drivers constantly change we don\u0026rsquo;t recommend to use it on AMD cards. opencl_mandatory_timeout default 400 If darktable wants to make use of any OpenCL device it has to reserve it for further usage. If that device is current used darktable will wait up to opencl_mandatory_timeout * 5ms before it does a fallback to CPU. Increase this value if you would prefer to use OpenCL (because your card is really fast and your CPU is not). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/mem-performance/","tags":null,"title":"memory \u0026 performance tuning"},{"categories":null,"content":"Drawn and parametric masks can be used in combination to form a single mask that can be applied to a module.\nThere are two main elements which control how individual masks are combined: the polarity setting of each individual mask (defined by the plus or minus buttons) and the setting in the “combine masks” combobox.\nThe \u0026ldquo;combine masks\u0026rdquo; combobox contains the following options, defining how the drawn and parametric masks will be combined:\nexclusive A straightforward method of combining masks, exclusive mode multiplies together the individual pixel values from each of the component masks. For a given pixel, the final mask will have value of 0 if any of the individual masks are 0 at that location and it will only have a value of 1.0 if all masks have a value of 1.0 at that location.\nAny individual mask can exclude a pixel by setting its value to 0, regardless of what the other masks do. Once a pixel is excluded by a mask there is no way for another mask to include it again.\ninclusive Inclusive mode first inverts each individual mask (subtracts its value from 1.0), multiplies the inverted masks together, and finally inverts the combined mask once again. For a given pixel, the final mask will have a value of 1.0 if any of the individual masks are 1.0 at that location and it will only have a value of 0 if all masks have a value of 0 at that location.\nAny individual mask can include a pixel by setting its value to 1.0, regardless of what the other masks do. Once a pixel is fully included by a mask (its value is 1.0) there is no way for another mask to exclude it again.\nexclusive and inclusive inverted modes Using the above combination methods alone would still be rather limiting. We gain maximum flexibility by allowing an additional inversion step for each individual mask. This is governed by the polarity buttons that you find close to the individual channels. Toggling the polarity button of a mask inverts its values (subtracts the original value from 1.0).\nFinally within the “combine masks” combobox you may select the exclusive \u0026amp; inverted or inclusive \u0026amp; inverted options. Each of these options is equivalent to the exclusive and inclusive modes, respectively, but with a final step that inverts the resulting mask.\n🔗typical use cases inclusive mode For this mode you set the “combine masks” combobox to inclusive mode and make sure that all polarity buttons of all the individual channels and of the drawn mask are set to negative (-). Your starting point is a mask where all pixels have a value of zero (no pixel is selected). You now adjust the parametric mask sliders to bring more and more pixels into the selection or you draw shapes on the canvas to select specific areas of your image. exclusive mode In the opposite case you set the “combine masks” combobox to exclusive mode and make sure that all polarity buttons are set to positive (+). Your starting point is a mask with all values at 1.0 (all pixels are selected). You now adjust the parametric mask sliders to exclude parts of your image as needed or directly draw shapes on the canvas to exclude those areas. For your convenience the parametric masks GUI provides a toggle button that inverts all channel polarities and toggles between inclusive and exclusive mode in the “combine masks” combobox.\nFor novice users it is recommended that you stick to the above two use cases. This means that you should decide beforehand how you want to construct your mask.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/masks/drawn-and-parametric/","tags":null,"title":"combining drawn \u0026 parametric masks"},{"categories":null,"content":"The darktable-chart binary is a dedicated utility to create styles out of pairs of images such as RAW+JPEG with in-camera processing. Details about its usage can be found in the using darktable-chart section.\ndarktable-chart can either start a GUI or be used as a command-line program.\ndarktable-chart [--help] [\u0026lt;input Lab pfm file\u0026gt;] [\u0026lt;cht file\u0026gt;] [\u0026lt;reference cgats/it8 or Lab pfm file\u0026gt;] All parameters are optional, however, if you want to supply the second file name you also need to supply the first one. Starting darktable-chart this way opens a special GUI (details can be found in the using darktable-chart section).\n--help Provide usage information and terminate. \u0026lt;input Lab pfm file\u0026gt; Open the utility with the given file as source image. The input file needs to be in Lab Portable Float Map format. \u0026lt;cht file\u0026gt; Specify a chart file describing the layout of the used color reference chart. \u0026lt;reference cgats/it8 or Lab pfm file\u0026gt; Specify the reference values, either as measured values according to the CGATS standard, or as a reference image in Lab Portable Float Map format. Alternatively darktable-chart can be used as a command line program to generate darktable style files using previously saved CSV files.\ndarktable-chart --csv \u0026lt;csv file\u0026gt; \u0026lt;number patches\u0026gt; \u0026lt;output dtstyle file\u0026gt; All parameters are mandatory.\n\u0026lt;csv file\u0026gt; A CSV file previously saved from within darktable-chart. \u0026lt;number of patches\u0026gt; The number of color patches to be used in the color look up table settings of the created style. \u0026lt;output dtstyle file\u0026gt; The name of the style file to be created. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/darktable-chart/","tags":null,"title":"darktable-chart"},{"categories":null,"content":"darktable is a non-destructive editor, which means that all changes are recorded in the library database (with a backup stored in an XMP sidecar file), and the original Raw file is left untouched. You therefore need to export images in order to bake your edits into an output file that can be distributed outside of darktable.\nChoose an export scenario.\nThe export module offers many options, but by far the most common use is to “save a developed raw image as a JPEG”. You can either export the currently-edited image directly from the darkroom view or select one or more images from the lighttable view and export them all at once.\nSelect which images to export (if you are in the lighttable view), open the export module, set target storage to \u0026ldquo;file on disk\u0026rdquo; and select a location to save your images \u0026ndash; by default, they will be exported to a \u0026ldquo;darktable_exported\u0026rdquo; directory within the directory that contains your Raw file(s). Choose a \u0026ldquo;file format\u0026rdquo; of JPEG and keep the default settings.\nClick the \u0026ldquo;export\u0026rdquo; button to save your processed images in the selected location.\nNote: While JPEG is useful for most purposes, if you wish to perform further edits in a raster editor like GIMP or Krita, it is normally better to export in TIFF format.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/workflow/export/","tags":null,"title":"export"},{"categories":null,"content":"From any of the lighttable modes, you can display a fully-zoomed preview of the image that is currently under the mouse pointer by pressing and holding down W. This is useful to more closely inspect an image while rating and selecting images.\nPressing and holding Ctrl+W fully zooms into the image and also identifies any regions of sharpness in the image that may indicate image focus. For this tool to work the input image needs to hold an embedded JPEG thumbnail, which is the case for most raw files.\nRegions in the image with a high level of sharpness are indicated with red borders. If no such regions are found, any regions of moderate sharpness are identified with a blue border. Note that this is not the same as the focus peaking indicator, which is another way to identifying areas of sharpness within an image.\nSometimes pressing W or Ctrl+W may not appear to have any effect \u0026ndash; in such cases, click on the image thumbnail and press the corresponding key again.\nIf you want the full preview to stay in place without having to hold the W key, you can enable sticky preview mode by pressing F. In sticky preview mode, you can zoom and pan within the image in a similar way to the culling mode. Press F or ESC to return to the original view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/lighttable-modes/full-preview/","tags":null,"title":"full preview"},{"categories":null,"content":"Control functionality in the lighttable view and modules.\n🔗general hide built-in presets for utility modules If enabled, only user-defined presets will be shown in presets menu for utility modules \u0026ndash; built-in presets will be hidden (default off). use single-click in the collections module Enable \u0026ldquo;single click\u0026rdquo; mode in the collections module, which allows ranges to be selected (default off). expand a single utility module at a time Controls how utility modules are expanded. If this option is enabled, expanding a module by clicking collapses any other currently expanded panel. If you want to expand a panel without collapsing the others you can do so with Shift+click. Disabling this option inverts the meaning of click and Shift+click (default off). scroll utility modules to the top when expanded With this option enabled the side panels will scroll a utility module to the top of the panel when it is expanded. (default off) rating an image one star twice will not zero out the rating Normally clicking a one star rating twice will set a zero star rating to that image. Check this option to disable this functionality (default off). show scrollbars for center view Choose whether to show scrollbars in the center view of the lighttable (default on). show image time with milliseconds Choose whether to include milliseconds when displaying time values (default off). If set, milliseconds are shown in the image information module and can also be used in the geotagging module. 🔗thumbnails use raw file instead of embedded JPEG from size When generating thumbnails for images that have not yet been processed in the darkroom, if the thumbnail size is greater than this value, generate it by processing the raw image data. If the thumbnail is below this size, use the JPEG preview image embedded in the raw file. Once an image has been processed in the darkroom, thumbnails will always be generated from raw data (you can revert back to the JPEG preview by discarding history). To render thumbnails with the best quality choose \u0026ldquo;always\u0026rdquo;. high quality processing from size If the thumbnail size is greater than this value and is being generated from raw data, it will be processed using the full quality rendering path, which is better but slower (default 720p). To render thumbnails with the best quality, choose \u0026ldquo;always\u0026rdquo;. enable disk backend for thumbnail cache If activated, darktable stores all thumbnails on disk as a secondary cache, and thereby keeps thumbnails accessible if they are dropped from the primary cache. This needs more disk space but speeds up the lighttable view as it avoids the reprocessing of thumbnails (default on). enable disk backend for full preview cache If enabled, darktable writes full preview images to disk (.cache/darktable/) when evicted from the memory cache. Note that this can take a lot of storage (several gigabytes for 20k images) and darktable will never delete cached images. It\u0026rsquo;s safe to delete these manually if you want. Enabling this option will greatly improve lighttable performance when zooming an image in full preview mode (default off). generate thumbnails in background Choose whether to automatically generate thumbnails in the background when the user is in the lighttable view and is inactive (no keyboard/mouse activity). Thumbnails will be generated up to the selected size (default never). Note: You can set the period of inactivity required before thumbnail generation will start by altering the backthumbs_inactivity setting in $HOME/.config/darktable/darktablerc (default 5 seconds).\nreset cached thumbnails Force thumbnails to be regenerated by resetting the database. This may be needed if some thumbnails have been manually removed or have become corrupted (default off). delimiters for size categories Size categories are used to allow different thumbnail overlays to be shown depending on the thumbnail size. A pipe delimited set of values defines at what image sizes the category changes. The default value of \u0026ldquo;120|400\u0026rdquo; means that there will be 3 categories of thumbnail: 0-120px, 120-400px and \u0026gt;400px. pattern for the thumbnail extended overlay text If you have chosen to show extended overlay text over thumbnail images, this setting allows you to define what information is displayed. This pattern can use any of the variables defined in the variables section. You can also include formatting (bold, italic, colors etc). pattern for the thumbnail tooltip (empty to disable) Defines what information is displayed in the tooltip when the mouse hovers over image thumbnails. This pattern can also use the same variables and formatting as the extended overlay text. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/lighttable/","tags":null,"title":"lighttable"},{"categories":null,"content":"Manage the layout and grouping of processing modules and the quick access panel.\nThis maintenance screen can be accessed from the presets menu beside the module search box or module group icons (below the scopes module in the darkroom view). Ctrl+click on the preset menu to open this screen directly.\nSettings are automatically saved when you exit the screen. Click reset to abandon any changes made in the current editing session.\n🔗module controls 🔗global controls The following global controls are available in the top panel of the screen.\npreset Select an existing module group preset. remove Remove the current preset (user-defined presets only). duplicate Duplicate the current preset with a new name. The above example shows a new preset named \u0026ldquo;user defined\u0026rdquo;, which has been created by duplicating the \u0026ldquo;modules: default\u0026rdquo; preset. rename Rename the current preset (user-defined presets only). Right-click to bring up a menu that can be used to copy, paste, select all, delete or insert an emoji). new Create a new preset containing a minimal list of modules. show search line Choose whether to display the search bar below the module group icons show quick access panel Choose whether to display the quick access panel. If checked, a new entry will appear in the bottom panel to allow you to add or remove widgets. show all history modules in active group Select this to show all modules that are present in the history stack within the active group, regardless of whether or not they are actually active. auto-apply this preset Module group presets can be automatically applied based on the type of image being worked on. The check box indicates whether this preset currently has any auto-apply rules. Click on the gear icon to amend the auto-apply settings. See presets for details. 🔗module groups The bottom panel of the screen allows you to alter the quick access panel and module groups for the selected preset (user-defined presets only).\nadd a group Click on the + sign beside the \u0026ldquo;module groups\u0026rdquo; label to add a new group. remove a group Remove a group by clicking on the X button beside the group name. add a module/widget Add a module to a group, or a widget to the quick access panel, by clicking the + sign below the group name. Select the required module/widget from the displayed list. remove a module/widget Remove a module from a group, or a widget from the quick access panel, by clicking the X beside the module/widget name. change a group\u0026rsquo;s icon Change the icon assigned to a group by clicking on the existing group icon and selecting a new one from the displayed list. change the group order Change the order in which the groups are displayed by clicking on the \u0026lt; and \u0026gt; buttons below the group names. rename a group Rename a module group by clicking on the group name and typing. Right-click to bring up a menu that can be used to copy, paste, select all, delete or insert an emoji) ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/organization/manage-module-layouts/","tags":null,"title":"manage module layouts"},{"categories":null,"content":"This section describes how to interact with processing module controls.\n🔗sliders Sliders offer five different methods of interaction, depending on the level of control you require.\nleft-click (set) Click anywhere in the slider area to set the value. You can also click and drag to change it. You don\u0026rsquo;t have to aim for the triangle or even the line \u0026ndash; you can click anywhere in the entire height of the slider, including the label. mouse wheel (adjust) Hover over the slider with your mouse, then use your mouse wheel to adjust the value. You can alter the default speed at which the mouse scroll adjusts a slider by scrolling over that slider while in visual shortcut mapping mode. keyboard arrow keys (adjust) When the slider has focus you can hover over the slider with your mouse, then use your keyboard\u0026rsquo;s arrow keys (←/↓ and →/↑) to adjust the value. In order to give focus to the widget without changing the current value you can right-click, then right-click again. right-click (pop-up edit) When your mouse is over a slider right-clicking enables a multi-functional pop-up below the slider for fine control with your mouse or numerical entry using the keyboard. A bent line extending from the triangular marker moves with your mouse. The closer your mouse pointer is to the triangular marker the coarser the control you have over the value; the further away from the triangular marker the finer your control. Left-click with your mouse to accept the new value and hide the pop-up.\nAlternatively you can type in a new value using your keyboard and commit by hitting the Enter key. You may even supply the new value in the form of an arithmetic expression which darktable will calculate for you \u0026ndash; the previous value is referenced as “x”.\nFor most sliders, the minimum and maximum values displayed are known as \u0026ldquo;soft limits\u0026rdquo; \u0026ndash; they do not represent the minimum/maximum values that you may enter, merely a suggested range of \u0026ldquo;normal\u0026rdquo; values that most users will not need to exceed. As well as these soft limits, each slider also has \u0026ldquo;hard limits\u0026rdquo; which may not be exceeded.\nYou may right-click and type any value up to the hard limits for a given slider. For example, in the rotate and perspective module, the soft limits for angle are -10 to +10 degrees while the hard limits are -180 to +180 degrees; In the exposure module, the soft limits for the exposure slider are -3 to +4 EV while the hard limits are -18 to +18 EV. If you try to enter a value beyond the hard limit, it will be automatically be adjusted to the minimum/maximum allowable value.\ndouble-click (reset) Double-click on a slider or its label to reset back to the default value. Ctrl+double-click to reset its value back to any auto-applied preset (if one applies for the current image). If controls are grouped together within a tabbed interface, you can double-click on the tab\u0026rsquo;s header label to reset all settings in that tab. In addition, the speed of mouse-wheel, arrow-key and click+drag adjustments can be altered:\nhold down the Shift key while adjusting to increase the step size by a factor of 10. hold down the Ctrl key while adjusting to decrease the step size by a factor of 10. Both of these multipliers can be amended in preferences \u0026gt; shortcuts by altering the speed of the fallbacks/value actions.\n🔗comboboxes Click on a combobox to show a list of available options which you can click to select. Occasionally the selection list will open close to the bottom or top of the screen meaning that only some of the items are visible \u0026ndash; simply scroll with your mouse wheel to bring up the full list. Alternatively, you can also use the mouse wheel and keyboard arrow keys to select an option, or start typing to filter the combobox entries.\nAs with sliders, you can double-click the combobox or its label to reset back to the default value, or Ctrl+double-click to reset back to any auto-applied preset.\n🔗pickers Many modules allow parameters to be set using pickers (identified by the icon). Pickers allow you to select sample areas of the image from which to calculate values for module parameters. You can usually choose to select either a \u0026ldquo;point\u0026rdquo; (a single pixel) or an \u0026ldquo;area\u0026rdquo; (a rectangular selection of pixels) from the image, although some modules only allow one mode to be used.\nSelecting pixel(s) will cause the appropriate module value(s) to be updated, and may also cause additional visual feedback (for example, overlaying the range of selected pixels on a tone curve).\nActivate point mode by left-clicking the picker icon and then left-click anywhere on the image to select the pixel from which to calculate values. The selected point will be shown on-screen (with a cross icon) which you can adjust by left-clicking another pixel. Deactivate the picker by left-clicking the picker icon again.\nActivate area mode by either right-clicking or Ctrl+clicking the picker icon and then left-click and drag to select a rectangular area of the image from which to calculate values. The selected area will be shown on-screen as an overlaid rectangle which can be moved by either drawing another rectangle elsewhere or by left-clicking and dragging the corners of the drawn rectangle. Reset the rectangle (to select the whole image) by right-clicking anywhere on the image. Deactivate the picker by right-clicking (or Ctrl+clicking) the picker icon again.\nIn modules where only one mode is available, left-clicking the icon will usually toggle that mode on and off.\n🔗keyboard shortcuts Module parameters can also be adjusted using keyboard shortcuts. See preferences \u0026gt; shortcuts for more information.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/module-controls/","tags":null,"title":"module controls"},{"categories":null,"content":"The first example showed us the very basics of lua and allowed us to check that everything was working properly. Now let\u0026rsquo;s do something a little bit more complex. Let\u0026rsquo;s try to print a list of images that have a \u0026ldquo;red\u0026rdquo; label attached to them. But first of all, what is an image?\nlocal darktable = require \u0026#34;darktable\u0026#34; local debug = require \u0026#34;darktable.debug\u0026#34; print(darktable.debug.dump(darktable.database[1])) Running the code above will produce a lot of output. We will look at it in a moment, but first let\u0026rsquo;s look at the code itself.\nWe know about require darktable. Here, we need to separately require darktable.debug which is an optional section of the API that provides helper functions to help debug lua scripts.\ndarktable.database is a table provided by the API that contains all images in the library database. Each entry in the database is an image object. Image objects are complex objects that allow you to manipulate your image in various ways (all documented in the types_dt_lua_image_t section of the API manual). To display our images, we use darktable.debug.dump which is a function that will take anything as its parameter and recursively dump its content. Since images are complex objects that indirectly reference other complex objects, the resulting output is huge. Below is a cut down example of the output.\ntoplevel (userdata,dt_lua_image_t) : /images/100.JPG publisher (string) : \u0026#34;\u0026#34; path (string) : \u0026#34;/images\u0026#34; move (function) exif_aperture (number) : 2.7999999523163 rights (string) : \u0026#34;\u0026#34; make_group_leader (function) exif_crop (number) : 0 duplicate_index (number) : 0 is_raw (boolean) : false exif_iso (number) : 200 is_ldr (boolean) : true rating (number) : 1 description (string) : \u0026#34;\u0026#34; red (boolean) : false get_tags (function) duplicate (function) creator (string) : \u0026#34;\u0026#34; latitude (nil) blue (boolean) : false exif_datetime_taken (string) : \u0026#34;2014:04:27 14:10:27\u0026#34; exif_maker (string) : \u0026#34;Panasonic\u0026#34; drop_cache (function) title (string) : \u0026#34;\u0026#34; reset (function) create_style (function) apply_style (function) film (userdata,dt_lua_film_t) : /images 1 (userdata,dt_lua_image_t): .toplevel [......] exif_exposure (number) : 0.0062500000931323 exif_lens (string) : \u0026#34;\u0026#34; detach_tag (function): toplevel.film.2.detach_tag exif_focal_length (number) : 4.5 get_group_members (function): toplevel.film.2.get_group_members id (number) : 1 group_with (function): toplevel.film.2.group_with delete (function): toplevel.film.2.delete purple (boolean) : false is_hdr (boolean) : false exif_model (string) : \u0026#34;DMC-FZ200\u0026#34; green (boolean) : false yellow (boolean) : false longitude (nil) filename (string) : \u0026#34;100.JPG\u0026#34; width (number) : 945 attach_tag (function): toplevel.film.2.attach_tag exif_focus_distance (number) : 0 height (number) : 648 local_copy (boolean) : false copy (function): toplevel.film.2.copy group_leader (userdata,dt_lua_image_t): .toplevel As we can see, an image has a large number of fields that provide all sort of information about it. Here, we are interested in the \u0026ldquo;red\u0026rdquo; label. This field is a boolean, and the documentation tells us that it can be written. We now just need to find all images with that field and print them out:\ndarktable = require \u0026#34;darktable\u0026#34; for _,v in ipairs(darktable.database) do if v.red then print(tostring(v)) end end This code should be quite simple to understand at this point, but it contains a few interesting aspects of lua that are worth highlighting:\nipairs is a standard lua function that will iterate through all numeric indices of a table. We use it here because darktable\u0026rsquo;s database has non-numeric indices which are functions to manipulate the database itself (adding or deleting images, for example).\nIterating through a table will return both the key and the value used. It is conventional in lua to use a variable named “_” to store values that we don\u0026rsquo;t care about.\nNote that we use the standard lua function tostring here and not the darktable-specific darktable.debug.dump. The standard function will return a name for the object whereas the debug function will print the content. The debug function would be too verbose here. Once again, it is a great debug tool but it should not be used for anything else.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/printing-labeled-images/","tags":null,"title":"printing labeled images"},{"categories":null,"content":"The “reference values” tab determines the target values to which the source image must to be modified by the resulting style. You can either supply reference values in the form of measured data of your color reference card (mode “cie/it8 file”), or you can supply a photographic image (mode “color chart image”) much in the same way as described above. This second image must also be supplied in Lab Portable Float Map format. There is no need to supply the chart file again as darktable-chart takes the same one as defined under “source image”. You only need to again align the layout grid and the image and potentially adjust the “size” slider.\nIn a typical use case the second image will be based on a JPEG file produced in-camera. This way you can create a style to simulate the in-camera processing within darktable.\nIn the lower text output frame you will see the color values extracted from the available data for each individual color patch. The first column gives the name of the patch, the second and third column show the corresponding color values of the source image in RGB and Lab format, respectively. The fourth column contains the Lab value coming from the reference (or from the chart file if no reference image has been given). Finally, the fifth and sixth columns display how strongly source and reference values deviate in terms of delta-E values.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/darktable-chart/reference-values/","tags":null,"title":"reference values"},{"categories":null,"content":"If rendering with LittleCMS2 is activated (see rendering method) you can define how to handle out-of-gamut colors when converting between color spaces. A selection box in the export, output color profile, and soft proof modules gives you a choice of the following rendering intents:\nperceptual Best suited to photographs as it maintains the relative position of colors. This is usually the best choice. relative colorimetric Out-of-gamut colors are converted to colors having the same lightness, but different saturation. Other colors remain unmodified. saturation Saturation is retained but lightness is slightly changed. absolute colorimetric Keep the white point. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/rendering-intent/","tags":null,"title":"rendering intent"},{"categories":null,"content":"The huge diversity of systems and the marked differences between OpenCL vendors and driver versions makes it impossible to give an comprehensive overview of how to setup OpenCL. We only can give you an example, in this case for NVIDIA driver version 542.29.06 on Fedora 39. We hope that this will serve as a basic introduction and will help you to solve any problems specific to your setup.\nThe principle OpenCL function flow is like this:\ndarktable \u0026gt; libOpenCL.so \u0026gt; libnvidia-opencl.so.1 \u0026gt; kernel driver module(s) \u0026gt; GPU\ndarktable dynamically loads libOpenCL.so \u0026ndash; a system library that must be accessible to the system\u0026rsquo;s dynamic loader (ld.so).\nlibOpenCL.so reads the vendor-specific information file (/etc/OpenCL/vendors/nvidia.icd) to find the library that contains the vendor-specific OpenCL implementation.\nThe vendor-specific OpenCL implementation comes as a library libnvidia-opencl.so.1 (which in our case is a symbolic link to libnvidia-opencl.so.545.29.06).\nlibnvidia-opencl.so.1 needs to talk to the vendor-specific kernel modules nvidia and nvidia_uvm via device special files /dev/nvidia0, /dev/nvidiactl, and /dev/nvidia-uvm.\nAt system startup the required device special files (/dev/nvidia*) need to be created. If this does not happen on your system by default, the easiest way to set them up and make sure all modules are loaded is by installing the nvidia-modprobe package.\nA user account that needs to make use of OpenCL from within darktable must have read/write access to NVIDIA\u0026rsquo;s device special files. On some systems these files allow world read-write access by default, which avoids permission issues but might be debatable in terms of system security. Other systems restrict the access to a user group, e.g. “video”. In this case your user account has to be member of that group.\nTo summarise, the packages that needed to be installed in this specific case were:\nxorg-x11-drv-nvidia xorg-x11-drv-nvidia-libs xorg-x11-drv-nvidia-cuda xorg-x11-drv-nvidia-cuda-libs xorg-x11-drv-nvidia-power akmod-nvidia nvidia-settings nvidia-modprobe nvidia-persistenced opencl-headers opencl-filesystem ocl-icd ocd-icd-devel On Linux systems you might also want the clinfo package giving you a lot of information about your OpenCL system and settings.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/setting-up/","tags":null,"title":"setting up OpenCL"},{"categories":null,"content":"Star ratings and color labels help you to sort and rank images according to your own criteria. An image\u0026rsquo;s star rating and color labels can be displayed over thumbnails in the lighttable view and filmstrip module.\n🔗star ratings You can give an image a rating from zero to five stars. Whenever you import images, each image receives a default rating which you can define in the import module. You can also mark an image as “rejected”.\nThere are several ways to change a rating. While hovering the cursor over an image thumbnail, you can press a number key 0 – 5 to define the number of stars, or press R to “reject” an image. This is probably the fastest way to rate your images on first inspection of a film roll.\nYou can also directly click on the star icons that are overlaid on the thumbnails or in the bottom panel. Click the x to reject.\nAs rejecting an image removes the currently-applied star rating, you can undo the rejection by clicking x or pressing R again.\nSimilarly you can click the first star for a second time to reset the image rating to unranked, or zero stars. This behavior can be changed in preferences \u0026gt; lighttable.\nTo rate multiple images at once, select those images in the lighttable or filmstrip and then press the appropriate shortcut key, or click the desired star rating in the bottom panel of the lighttable view.\nYou can filter images by star rating in the top panel.\n🔗color labels Color labels are another way to classify images, and can be used as an alternative to star ratings or to work alongside them. Each image can carry any combination of one or more color labels (red, yellow, green, blue, or purple).\nYou can set the color labels for a single image by hovering your cursor over the thumbnail and pressing the function keys F1 – F5, which correspond with the labels in the order given above.\nTo set the color labels of one or more images, select the desired images in the lighttable or filmstrip and then press the appropriate shortcut key or click the corresponding color button in the bottom panel. A color label will be added to all selected images if any of them do not currently have the label; otherwise the label will be removed from all selected images. To remove all labels (of any color) from the selected images, press the gray button.\nYou can filter images by color label in the collections module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/digital-asset-management/star-color/","tags":null,"title":"star ratings \u0026 color labels"},{"categories":null,"content":"The top panel appears in all darktable views and provides access to common functions.\n🔗On the left-hand-side filter / sort Choose how to filter and sort the images. Criteria can be altered in the collection filters module or by clicking on the icon. sort order Switch the sort order (ascending / descending). 🔗On the right-hand-side grouping Expand or collapse grouped images. thumbnail overlays Define what information is overlaid on to thumbnails in the lighttable/filmstrip. You can define different settings depending on the thumbnail size. See preferences \u0026gt; lighttable for details of how size delimiters are set. context-sensitive help Click this icon and then click on a control element to be directed to the appropriate online help page. shortcut mapping Click this icon to enter the visual shortcut mapping mode to create keyboard/mouse shortcuts. preferences View and amend darktable\u0026rsquo;s preferences \u0026amp; settings. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/user-interface/top-panel/","tags":null,"title":"top panel"},{"categories":null,"content":"This troubleshooting guide can be used to verify whether or not your camera can be used with tethering. This is done using the same (gphoto2) tool that darktable uses to interface with your camera.\nBefore you start, you first need to find your camera port name. Usually the port \u0026ldquo;usb:\u0026rdquo; is sufficient and is therefore used in the following guide.\n🔗is your camera detected? The following command will verify that your camera is connected to the computer and detected by gphoto2.\nenv LANG=C gphoto2 --auto-detect 🔗check the camera\u0026rsquo;s driver abilities Execute the following command and ensure that the \u0026ldquo;capture choices\u0026rdquo; ability supports “Image” and configuration support is “yes” \u0026ndash; darktable will check these two abilities to decide whether to show the “tethered shoot” button.\nenv LANG=C gphoto2 --port usb: --abilities 🔗remote capture This step will verify that your camera can be remotely controlled \u0026ndash; i.e. that it can capture an image, download it to your computer and display it within darktable.\nenv LANG=C gphoto2 --port usb: --capture-image-and-download 🔗tethered capture This last step tests if your camera supports \u0026ldquo;events\u0026rdquo;, are heavily used by darktable. Running this command will make the gphoto2 process wait for an image capture event which you must manually trigger on your camera. If successful, the image will be downloaded to your computer.\nenv LANG=C gphoto2 --port usb: --capture-tethered 🔗now what? If any of the above steps failed, there are problems with your specific camera and driver. Please file an issue on the gphoto2 github page. Add the following flags to the failed command for better support and attach the log output to your issue:\n--debug --debug-file gphoto2_debug.log If you successfully completed all of the above tests, your camera is probably supported by darktable. If these tests were successful but you nevertheless stumble upon a problem in darktable, please file an issue on the darktable github page. Please attach the log output from the commands above and the log file output produced by starting darktable with the following command:\ndarktable -d camctl 2\u0026gt;1 \u0026gt;camctl.log ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/tethering/troubleshooting/","tags":null,"title":"troubleshooting"},{"categories":null,"content":"While you are editing your image, darktable records all of the modifications you make to that image. This means that it is possible to undo and redo changes to recover a previous editing state. Note that the undo/redo facility is unlimited in the number of steps while editing an image, but is reset each time the darkroom is switched to a new image.\nPress Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/pixelpipe/undo-redo/","tags":null,"title":"undo and redo"},{"categories":null,"content":"So far, all our scripts have done things during startup. This is of limited use and doesn\u0026rsquo;t allow us to react to real user actions. To do more advanced things we need to register a function that will be called on a given event. The most common event to react to is a keyboard shortcut.\ndarktable = require \u0026#34;darktable\u0026#34; local function hello_shortcut(event, shortcut) darktable.print(\u0026#34;Hello, I just received \u0026#39;\u0026#34;..event.. \u0026#34;\u0026#39; with parameter \u0026#39;\u0026#34;..shortcut..\u0026#34;\u0026#39;\u0026#34;) end darktable.register_event(\u0026#34;hello shortcut\u0026#34;, \u0026#34;shortcut\u0026#34;,hello_shortcut, \u0026#34;A shortcut that prints its parameters\u0026#34;) Now start darktable, go to \u0026ldquo;preferences \u0026gt; shortcuts \u0026gt; lua \u0026gt; A shortcut that prints its parameters\u0026rdquo;, assign a shortcut and try it. You should see a nice message printed on the screen.\nLet\u0026rsquo;s look at the code in detail. We first define a function that takes two strings as input parameters. The first one is the type of event triggered (\u0026ldquo;shortcut\u0026rdquo;) and the second is the name of the shortcut (\u0026ldquo;A shortcut that prints its parameters\u0026rdquo;). The function itself calls darktable.print, which will print the message as an overlay in the main window.\nOnce that function is defined, we register it as a shortcut callback. To do that we call darktable.register_event which is a generic function for all types of events. We tell it that we are registering an event of type \u0026ldquo;shortcut\u0026rdquo; with the name \u0026ldquo;hello shortcut\u0026rdquo;, then we give the callback to call and finally, we give the string to use to describe the shortcut in the preferences window.\nLet\u0026rsquo;s try a shortcut that is a little more interactive. This one will look at the images the user is currently interested in (selected or moused-over) and increase their rating:\ndarktable = require \u0026#34;darktable\u0026#34; darktable.register_event(\u0026#34;increase rating\u0026#34;,\u0026#34;shortcut\u0026#34;, function(event,shortcut) local images = darktable.gui.action_images for _,v in pairs(images) do v.rating = v.rating + 1 end end,\u0026#34;Increase the rating of an image\u0026#34;) At this point, most of this code should be self explanatory. Just a couple of notes:\nInstead of declaring a function and referencing it, we declare it directly in the call to darktable.register_event this is strictly equivalent but slightly more compact.\nimage.rating is a field that gives the star rating of any image (between 0 and 5 stars, -1 means rejected).\ndarktable.gui.action_images is a table containing all the images of interest. darktable will act on selected images if any image is selected, and on the image under the mouse if no image is selected. This function makes it easy to follow darktable\u0026rsquo;s UI logic in lua.\nIf you select an image and press your shortcut a couple of times, it will work correctly at first but when you have reached five stars, darktable will start showing the following error on the console:\n\u0026lt;![CDATA[ LUA ERROR : rating too high : 6 stack traceback: [C]: in ? [C]: in ? [C]: in metamethod \u0026#39;newindex\u0026#39; ./configdir/luarc:10: in function \u0026lt;./configdir/luarc:7\u0026gt; [C]: in ? [C]: in ? ]]\u0026gt; This is lua\u0026rsquo;s way of reporting errors. We have attempted to set a rating of 6 to an image, but a rating can only go as high as 5. It would be trivial to add a check, but let\u0026rsquo;s go the complicated way and catch the error instead:\ndarktable.register_event(\u0026#34;increase rating\u0026#34;,\u0026#34;shortcut\u0026#34;, function(event,shortcut) local images = darktable.gui.action_images for _,v in pairs(images) do result,message = pcall(function() v.rating = v.rating + 1 end) if not result then darktable.print_error(\u0026#34;could not increase rating of image \u0026#34;.. tostring(v)..\u0026#34; : \u0026#34;..message) end end end,\u0026#34;Increase the rating of an image\u0026#34;) pcall will run its first argument and catch any exception thrown by it. If there is no exception it will return true plus any result returned by the function. If there is an exception it will return false and the error message of the exception. We simply test these results and print them to the console.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/simple-shortcut/","tags":null,"title":"adding a simple shortcut"},{"categories":null,"content":"The base curve, tone curve and rgb curve modules use curves to control the tones in the image. These modules have some common features that warrant separate discussion.\n🔗nodes In their default state, curves are straight lines, defined by two anchor nodes at the top-right and bottom-left of the graph. You can move the nodes to modify the curve or generate new nodes by clicking on the curve. Ctrl+click to generate a new node at the x-location of the mouse pointer and the corresponding y-location of the current curve \u0026ndash; this adds a node without the risk of accidentally modifying the curve. Up to 20 nodes can be defined per curve. To remove a node, click on it and drag it out of the widget area.\n🔗curve controls The following controls are common to two or more of the above processing modules and are therefore discussed separately here. Please see the individual module documentation for discussion of any additional controls.\ninterpolation method tone curve and rgb curve only Interpolation is the process by which a continuous curve is derived from a few nodes. As this process is never perfect, several methods are offered that can alleviate some of the issues you may encounter.\ncubic spline is, arguably, the most visually pleasing. Since it gives smooth curves, the contrast in the image is better enhanced. However, this method is very sensitive to the nodes\u0026rsquo; position, and can produce cusps and oscillations when the nodes are too close to each other, or when there are too many of them. This method works best when there are only 4 to 5 nodes, evenly spaced. centripetal spline is designed specifically to avoid cusps and oscillations but, as a drawback, it will follow the nodes more loosely. It is very robust, no matter the number of nodes and their spacing, but will produce a more faded and dull contrast. monotonic spline is designed specifically to give a monotonic interpolation, meaning that there will be none of the oscillations the cubic spline may produce. This method is most suitable when you are trying to build an analytical function from a node interpolation (for example: exponential, logarithm, power, etc.). Such functions are provided as presets. It is a good trade-off between the two aforementioned methods. preserve colors If a non-linear tone curve is applied to each of the RGB channels individually, then the amount of tone adjustment applied to each color channel may be different, and this can cause hue shifts. The preserve colors combobox provides different methods of calculating the \u0026ldquo;luminance level\u0026rdquo; of a pixel in order to minimise these shifts. The amount of tone adjustment is calculated based on this luminance value, and then this same adjustment is applied to all three of the RGB channels. Different luminance estimators can affect the contrast in different parts of the image, depending on the characteristics of that image. The user can therefore choose the estimator that provides the best results for the given image. Some of these methods are discussed in detail in the preserve chrominance control in the filmic rgb module. The following options are available: none luminance max RGB average RGB sum RGB norm RGB basic power scale for graph tone curve and base curve only The scale allows you to distort the graph display so that certain graphical properties emerge to help you draw more useful curves. Note that the scaling option only affects the curve display, not the actual parameters stored by the module.\nBy default, a “linear” scale is used (scale factor 0), which uses evenly spaced horizontal and vertical axes. Positive values give the graph a logarithmic scale, compressing high values and dilating low values on both the horizontal and vertical axes, so that nodes in lowlights get more space on the graph and can be controlled more precisely.\nIncreasing the \u0026lsquo;scale for graph\u0026rsquo; slider sets the base of the logarithm used to scale the axes. This allows you to control the amount of compression/dilation operated by the scale. If you draw purely exponential or logarithmic functions from identity lines, setting this value defines the base of such functions.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/curves/","tags":null,"title":"curves"},{"categories":null,"content":"Control functionality in the darkroom view and associated modules.\n🔗general scroll down to increase mask parameters By default, scrolling your mouse up increases the value of the relevant shape parameters in drawn masks. Set this preference to reverse the behavior (default off). middle mouse button zooms to 200% When enabled, clicking the middle mouse button on the image canvas causes the zoom level to toggle between fit, 100% and 200%. When disabled, the middle mouse button toggles between fit and 100%. In the latter case, you can use Ctrl+middle-click to access the 200% zoom level (default on). pattern for the image information line Set the information to be displayed in the image information line. You can use any variables in the variables section as well as $(NL) for a new line. You can also include formatting (bold, italic, colors etc). position of the image information line Choose the darkroom panel in which the image information line is displayed. Choose between “top left” “top right” “top center” “bottom” and “hidden” (default \u0026ldquo;bottom\u0026rdquo;). border around image in darkroom mode Display the center image in darkroom mode with an outside border of the given number of pixels (default 20). show scrollbars for center view Choose whether to show scrollbars in the center view of the darkroom (default off). reduce resolution of preview image Reduce the resolution of the navigation preview image (choose from \u0026ldquo;original\u0026rdquo;, \u0026ldquo;1/2\u0026rdquo;, \u0026ldquo;1/3\u0026rdquo; or \u0026ldquo;1/4\u0026rdquo; size). This may improve the speed of the rendering but take care as it can also hinder accurate color picking and masking (default \u0026ldquo;original\u0026rdquo;). show loading screen between images Show gray loading screen when navigating between images in the darkroom. Switch this option off to just show a simple toast message and leave the previous image in place until the next image is loaded. Note that switching this option off can be very useful to quickly compare duplicate images, however, there might be issues with long loading times (leading you to think the next image has already loaded) and you may observe visual artifacts while the next image is loading (default on). 🔗modules display of individual color channels Control how individual color channels are displayed when activated in the parametric masks feature. You can choose between “false color” and “gray scale” (default \u0026ldquo;false color\u0026rdquo;). hide built-in presets for processing modules If enabled, only user-defined presets will be shown in the presets menu for processing modules \u0026ndash; built-in presets will be hidden (default off). show the guides widget in modules UI Enable this to show the local guides \u0026amp; overlays interface directly within the UI of the modules that support it (default on). expand a single processing module at a time Control how processing modules are expanded in the darkroom. If this option is enabled, expanding a module by clicking collapses any currently expanded module. If you want to expand a module without collapsing the others you can do so with Shift+click. Disabling this option inverts the meaning of click and Shift+click (default on). only collapse modules in current group When choosing to expand a single processing module at a time (using the logic defined in the previous setting), only collapse other modules that appear in the current visible group. Disable this option to ensure that modules in non-visible groups are also collapsed (default on). expand the module when it is activated, and collapse it when disabled Select this option for the darkroom to automatically expand or collapse processing modules when they are enabled or disabled. (default off) scroll processing modules to the top when expanded With this option enabled processing modules are scrolled to the top of the right-hand panel when expanded. (default on) show right-side buttons in processing module headers Choose whether to show the four buttons (mask indicator, multi-instance menu, reset, presets menu) on the right-hand-side of the module header for processing modules. These buttons will always appear when the mouse is over the module. At other times they will be shown or hidden according to this preference selection: always: always show all buttons active: only show the buttons when the mouse is over the module dim: buttons are dimmed when mouse is not over the module auto: hide the buttons when the panel is narrow fade: fade out all buttons when the panel narrows fit: hide all the buttons if the module name doesn\u0026rsquo;t fit smooth: fade out all buttons in one header simultaneously glide: gradually hide individual buttons as needed (default always) show mask indicator in module headers If enabled, an icon will be shown in the header of any processing modules that have a mask applied (default on). prompt for name on addition of new instance If enabled, when creating a new instance of a processing module, a prompt will be immediately displayed allowing you to set a name for the new instance (default off). automatically update module name Automatically update the name (label) on processing modules if the current parameters of the module match those of a saved preset. The module name will only be updated if it hasn\u0026rsquo;t already been manually amended for the current image. It will be set either to the module name from which the preset was made (if the module name was manually adjusted before the preset was created) or to the name of the preset itself (default on). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/darkroom/","tags":null,"title":"darkroom"},{"categories":null,"content":"The darktable-cltest binary checks if there is a usable OpenCL environment on your system that darktable can use. It emits some debug output that is equivalent to calling darktable -d opencl and then terminates.\ndarktable-cltest is called without command line parameters.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/darktable-cltest/","tags":null,"title":"darktable-cltest"},{"categories":null,"content":"Input images are either RGB files (like JPEGs or TIFFs) or camera RAWs. Both store visual information as a combination of primary colors (e.g. red, green and blue) which together describe a light emission to be recreated by a display.\nThe following image illustrates this concept.\nThe left-hand-side of the image depicts a colored light that we need to represent digitally. We can use three ideal color filters to decompose this light into three colored primary lights at different intensities. In order to recreate the original colored light from our ideal decomposition (as illustrated in the center of the image) we simply need to recombine those three primary lights by addition.\nIt should be possible to reproduce the original colored light by taking a set of white lights at the correct intensities and projecting those lights through appropriately colored filters. This experiment can be performed at home using gels and dimmable white bulbs. This is roughly what old color CRT displays did and is how video projectors still work.\nIn photography, the initial decomposition step is performed by the color filter array that sits on top of your camera\u0026rsquo;s sensor. This decomposition is not ideal, so it isn\u0026rsquo;t possible to precisely recreate the original emission with simple addition \u0026ndash; some intermediate scaling is required to adjust the three intensities.\nOn screens, the LED bulbs are dimmed proportionally to each intensity, and the emissions of the three lights are physically added to reconstruct the original emission. Digital images store the intensities of these primary lights as a set of three numbers for each pixel, depicted on the right-hand side of the above image as shades of gray.\nWhile a set of display intensities can be easily combined to recreate an original light on a screen (for example, if we created a synthetic image in-computer) the set of captured intensities from a sensor needs some scaling in order for the on-screen light addition to reasonably reproduce the original light emission. This means that every set of intensities, expressed as an RGB set, must be linked to a set of filters (or primary LED colors) that define a color space \u0026ndash; any RGB set only makes sense with reference to a color space.\nNot only do we need to temper the captured intensities to make them summable again, but if we are to recompose the original light on a display that does not have the same colored filters or primaries as the space in which our RGB set belongs, these intensities need to be rescaled to take into account the differing filters on the display. The mechanism for this scaling is described in color profiles, usually stored within .icc files.\nNote: Color is not a physical property of light \u0026ndash; it exists only in the human brain, as a product of the decomposition of a light emission by the cone cells in the retina, again very similar in principle to the above filtering example. An \u0026ldquo;RGB\u0026rdquo; value should be understood as \u0026ldquo;light emissions encoded on 3 channels connected to 3 primaries\u0026rdquo;, but the primaries themselves may look different from what humans would call \u0026ldquo;red\u0026rdquo;, \u0026ldquo;green\u0026rdquo; or \u0026ldquo;blue\u0026rdquo;.\nThe filters described here are overlapping band-pass filters. Since they overlap, summing them back together would not preserve the energy of the original spectrum so (long story short) we need to dial them down with regard to the retina cone response\nMost of darktable\u0026rsquo;s actual image processing takes place in a large RGB \u0026ldquo;working profile\u0026rdquo; space, with some (mostly older) modules internally working in the CIELab 1976 color space (often just called “Lab”). The final output of the image processing pipeline is once again in an RGB space shaped for either the monitor display or the output file.\nThis process implies that the pixelpipe has two fixed color conversion steps: input color profile and output color profile. In addition there is the demosaic step for raw images, where the colors of each pixel are reconstructed by interpolation.\nEach module has a position in the pixelpipe that tells you which color space the module lives in:\nup to demosaic : The raw image information does not yet constitute an \u0026ldquo;image\u0026rdquo; but merely \u0026ldquo;data\u0026rdquo; about the light captured by the camera. Each pixel carries a single intensity for one primary color, and camera primaries are very different from primaries used in models of human vision. Bear in mind that some of the modules in this part of the pipe can also act on non-raw input images in RGB format (with full information on all three color channels).\nbetween demosaic and input color profile : Image is in RGB format within the color space of the specific camera or input file.\nbetween input color profile and output color profile : Image is in the color space defined by the selected working profile (linear Rec. 2020 RGB by default). As darktable processes images in 4x32-bit floating point buffers, we can handle large working color spaces without risking banding or tonal breaks.\nafter output color profile : Image is in RGB format as defined by the selected display or output ICC profile.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/color-spaces/","tags":null,"title":"darktable's color spaces"},{"categories":null,"content":"Grouping images helps to improve the structure and clarity of your image collection when displayed in the lighttable view.\nYou can combine images into a group by selecting them and clicking the “group” button in the actions on selection module, or by pressing Ctrl+G. Likewise, you can remove selected images from a group by clicking the “ungroup” button, or pressing Ctrl+Shift+G.\nDuplicated images are automatically grouped together. Similarly, if you import multiple images from the same directory, having the same base name, but different extensions (eg. IMG_1234.CR2 and IMG_1234.JPG), those images automatically form a group.\nImages that are members of a group are denoted by a group icon in their thumbnails. Note that this icon is only shown when \u0026ldquo;overlays\u0026rdquo; are displayed on image thumbnails. Thumbnail overlays can be enabled by selecting the star icon in the top panel.\nThis icon also appears as a button, in the top panel of the lighttable view, that can be used to toggle grouping on and off. If grouping is off, all images are displayed as individual thumbnails. If grouping is on, the images in a group are represented by a single thumbnail image (the group leader). If you press the group icon in the group leader\u0026rsquo;s thumbnail, that group is expanded (click a second time to collapse). If you then expand another group, the first group collapses.\nAn expanded group in the filemanager mode of lighttable view is indicated by an orange frame that appears as soon as your mouse pointer hovers over one of the images. This frame surrounds all images in the group.\nYou can define which image is considered to be the group leader by clicking on the group icon of the desired image while that group is expanded. The group icon is shown only if grouping mode is enabled, so to change the group leader, you need to first enable grouping, expand the appropriate group and finally click the group icon of the desired \u0026ldquo;group leader\u0026rdquo; image. The current group leader is shown in a tooltip when you hover over the group icon of an image.\nIf you collapse an image group and then enter darkroom mode (e.g. by double-clicking on the thumbnail), the group leader image will be opened for developing.\nImage groups are also a convenient way to protect an existing history stack against unintentional changes. If you have just finalized an image and want to protect its current version, simply select the image, click “duplicate” in the actions on selection panel, and make sure that grouping is switched on and that the group is collapsed. Now, whenever you open the image group again in the darkroom, only the group leader will be altered. The underlying duplicate will remain unchanged.\nNote: “duplicating images” only generates a copy of an image\u0026rsquo;s history stack, stored in another small XMP file. There is still only one raw file.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/digital-asset-management/grouping/","tags":null,"title":"image grouping"},{"categories":null,"content":"Much of the functionality in darktable can be controlled via keyboard shortcuts, which can be customised in preferences \u0026gt; shortcuts.\nPress the H key (for help) in any darktable view to show a list of all shortcuts that are applicable to the current view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/overview/user-interface/keyboard-shortcuts/","tags":null,"title":"keyboard shortcuts"},{"categories":null,"content":"When a parametric or drawn mask is active, several additional sliders are shown which allow the mask to be further refined.\ndetails threshold This control allows you to alter the opacity of the mask based on the amount of detail in the image. Use this slider to select either areas with lots of detail (positive values) or areas that are flat and lacking in detail (negative values). The default (zero) effectively bypasses details refinement. This is mostly useful to apply sharpening and blurring effects that ignore out-of-focus (bokeh) regions or to sharpen only blurry parts, preventing over-sharpening of in-focus regions. Note: The data used for the detail mask refinement is taken from the demosaic stage in the processing pipeline, and not from the module\u0026rsquo;s input (which is used for the other parametric mask criteria). None of the processing modules after demosaic will have any effect on the detail mask and it is not currently available for non-RAW images.\nfeathering guide Mask feathering smooths a drawn or parametric mask such that the mask\u0026rsquo;s edges automatically align with the edges of features in the image. The smoothing is guided either by the module\u0026rsquo;s input or output (before blending), and may happen before or after the mask blurring, depending on what is selected in the “feathering guide” combobox. Feathering is particularly sensitive to the choice of guide image when used with edge-modifying modules (modules for sharpening or blurring an image). output before blur: feathering is guided using the output image of the module and takes place before the mask is blurred input before blur: feathering is guided using the input image of the module and takes place before the mask is blurred output after blur: feathering is guided using the output image of the module and takes place after the mask has been blurred input after blur: feathering is guided using the input image of the module and takes place after the mask has been blurred feathering radius Adjust the strength of the feathering effect. Feathering works best if the mask\u0026rsquo;s edges already approximately match some edges in the guiding image. The larger the “feathering radius” the better the feathering algorithm can align the mask to more distant edges. If this radius is too large, however, the feathered mask may overshoot (cover regions that the user wants to exclude). Feathering is disabled when the feathering radius is set to 0. blurring radius Blurring the mask creates a softer transition between blended and unblended parts of an image and can be used to avoid artifacts. The blurring radius slider controls the radius of a gaussian blur applied to the final blend mask. The higher the radius, the stronger the blur (set to 0 for an unblurred mask). Mask blur is always applied after feathering if both kinds of mask adjustment are activated. This allows any resulting sharp edges or artifacts to be smoothed. mask opacity The strength of the module\u0026rsquo;s effect is determined by the mask\u0026rsquo;s local opacity. Feathering and blurring the mask may reduce the opacity of the original mask. The “mask opacity” slider allows you to readjust the mask opacity to compensate. If the mask opacity is decreased (negative slider values) less opaque parts are affected more strongly. Conversely, if the mask opacity is increased (positive slider values) more opaque parts are affected more strongly. As a consequence, completely opaque portions of the mask always remain opaque and completely transparent portions always remain transparent. This is to ensure that regions that have been fully excluded from or included in a module\u0026rsquo;s effect (by setting the mask\u0026rsquo;s opacity to 0% or 100%) remain fully excluded or included. mask contrast This slider increases or decreases the mask contrast. This allows you to adjust the transition between the opaque and transparent parts of the mask. temporarily switch off mask Sometimes it is useful to visualize a module\u0026rsquo;s effect without the mask being active. Click on this icon to temporarily deactivate the mask (the selected blend mode and global opacity remain in effect). display mask Click on this icon to display the current mask as a yellow overlay over a black-and-white version of the image. Solid yellow indicates an opacity of 100%; a fully visible gray background image (without yellow overlay) indicates an opacity of 0%. 🔗example: feathering a drawn mask It can be rather tedious to create a drawn mask that precisely covers a particular feature in an image. In this example, we want to enhance the color contrast of the lion sculpture shown in the left image above without affecting the background.\nThe first image above shows the original, unaltered image. The second image shows a rough selection of the sculpture created with a drawn mask. Note that the mask is rather fuzzy and does not precisely follow the outline of the lion sculpture. The third image shows the effect of adjusting the feathering radius, mask opacity and mask contrast, leading to a well matched mask with little effort. In this example the feathering radius has been adjusted to 50 and a blur radius of 5 was chosen to smooth the mask to some degree. The mask opacity and mask contrast have been increased to 0.3 and 0.5, respectively. The final image above shows the end result, where the color enhancement (via the color contrast module) is restricted to only the lion sculpture. Mask feathering works particularly well in this example because the sculpture is well separated from the out-of-focus background. The distinct edge at the border of the sculpture guides the feathering mask adjustment to match the shape of the sculpture.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/masks/refinement-controls/","tags":null,"title":"mask refinement \u0026 additional controls"},{"categories":null,"content":"darktable will detect OpenCL run-time errors automatically. On detecting an error, it will then reprocess everything on the CPU. While this will slow down processing it should not affect the end result.\nThere can be various reasons why OpenCL might fail during the initialization phase. OpenCL depends on hardware requirements and on the presence of certain drivers and libraries. In addition all these have to fit in terms of maker, model and revision number. If anything does not fit (e.g. your graphics driver \u0026ndash; loaded as a kernel module \u0026ndash; does not match the version of your libOpenCL.so) OpenCL support will likely not be available.\nIn this case, the best thing to do is start darktable from a console with darktable -d opencl.\nThis will give additional debugging output about the initialization and use of OpenCL. First, if you find a line that starts with [opencl_init] FINALLY ... that should tell you whether OpenCL support is available for you or not. If initialization failed, look at the messages above for anything that reads like could not be detected or could not be created. Check if there is a hint about where it failed.\nHere are a few cases that have been observed in the past:\ndarktable states that no OpenCL aware graphics card is detected or that the available memory on your GPU is too low and the device is discarded. In that case you might need to buy a new card if you really want OpenCL support.\ndarktable finds your libOpenCL.so but then tell you that it couldn\u0026rsquo;t get a platform. NVIDIA drivers will often give error code -1001 in this case. This happens because libOpenCL.so is only a wrapper library. For the real work further vendor-specific libraries need to be loaded. This has failed for some reason. There is a structure of files in /etc/OpenCL on your system that libOpenCL.so consults to find these libraries. See if you can find something fishy in there and try to fix it. Often the required libraries cannot be found by your system\u0026rsquo;s dynamic loader. Giving full path names might help.\ndarktable states that a context could not be created. This often indicates a version mismatch between the loaded graphics driver and libOpenCL. Check if you have left-over kernel modules or graphics libraries from an older installation and take appropriate action. When in doubt, perform a clean reinstall of your graphics driver. Sometimes, immediately after a driver update, the loaded kernel driver does not match the newly installed libraries. In this case reboot your system before trying again.\ndarktable crashes during startup. This can happen if your OpenCL setup is completely broken or if your driver/library contains a severe bug. If you can\u0026rsquo;t fix it, you can still use darktable with option --disable-opencl, which will skip the entire OpenCL initialization step.\ndarktable fails to compile its OpenCL source files at run-time. In this case you will see a number of error messages looking like typical compiler errors. This could indicate an incompatibility between your OpenCL implementation and darktable\u0026rsquo;s interpretation of the standard. In that case please raise an issue on github and we will try to assist. Please also report if you see significant differences between CPU and GPU processing of an image.\nyou have installed a number of OpenCL drivers meant for the same hardware, this will always lead to severe problems and must strictly be avoided. On Windows systems you often have the Microsoft OpenCLon12 driver installed via the OpenCL Compatibility Pack. Inspect and check at preferences \u0026gt; processing \u0026gt; OpenCL.\nA few emulated-on-CPU implementations of OpenCL also exist, coming as drivers provided by INTEL or AMD. We have observed that they do not provide any speed gain versus the compiler-optimized CPU code. Therefore darktable simply discards these drivers / devices by default.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/problems-solutions/","tags":null,"title":"possible problems \u0026 solutions"},{"categories":null,"content":"If all of the required settings in the \u0026ldquo;source image\u0026rdquo; and \u0026ldquo;reference values\u0026rdquo; tabs are ready you can move on to the “process” tab.\nFirst, you need to tell darktable-chart which of the patches represents the gray ramp. In the screenshot displayed above, the gray ramp is positioned in the lower part of the color reference chart, denoted as \u0026ldquo;GS00\u0026hellip;GS23\u0026rdquo;.\nThe \u0026ldquo;number of final patches\u0026rdquo; input defines how many editable color patches the resulting style will use within the color look up table module.\nClick the “process” button to start the calculation.\nThe quality of the result (in terms of average delta-E and maximum delta-E) is displayed below the button. This data shows how closely the resulting style (when applied to the source image) will be able to match the reference values \u0026ndash; the lower the better.\nOnce you are happy with the result you can click on “export” to save the generated style.\nSupply a style name and a style description under which the style will later appear in darktable. darktable-chart saves the style as a .dtstyle file which can be imported into darktable and shared with others. See styles.\nThe “export raw data as csv” button allows you to save the extracted raw data as a CSV file for debugging purposes or later use. darktable-chart offers a command line option to produce a style with the desired number of final patches from a supplied CSV file (see darktable-chart).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/darktable-chart/process/","tags":null,"title":"process"},{"categories":null,"content":"Wavelets are used to separate (or decompose) an image into a number of distinct layers, each containing a different level of detail. After decomposing an image in this way, a module can limit its processing to one or more of these detail layers, and then piece the layers back together again at the end to form its output. This allows us to be surgical about which features in the image we wish to impact when working with a module.\nSome of the operations that darktable can perform in this way are:\nnoise removal (in the denoise (profiled), raw denoise and contrast equalizer modules) contrast adjustment (in the contrast equalizer module) blurring or removal of unwanted detail (in the retouch module) 🔗theory A wavelet is an oscillating mathematical function that starts and ends at zero. The following diagram shows some simple wavelets of differing sizes.\nThese wavelet functions are used to scan and decompose an image using a mathematical operation called convolution. This picks out details from the image that are on a similar scale to the size of a given wavelet, and builds a number of these detail layers, each corresponding to a different wavelet scale.\nThe following is an example where detail layers have been extracted from the above image. In this case, the images were produced using the retouch module, splitting the image into 8 different layers, and using the module\u0026rsquo;s \u0026ldquo;display wavelet scale\u0026rdquo; button to visualise each of the detail layers:\nThe bars in the wavelet decompose section indicate the layers that have been extracted at different wavelet scales. The darkest rectangle at the left represents the entire image (before decomposition) and the gray boxes each represent one of the decomposed layers. Clicking on the staircase icon below the bar graph enables the layer visualization overlay so that you can see what the currently selected layer looks like.\nLet\u0026rsquo;s take a look at some of the layers generated for the above image.\nAt scale #2, the image contains only very fine details, including the model\u0026rsquo;s eyebrows, eye lashes and the pores of his skin. It doesn\u0026rsquo;t include the coarser details of the image, because those details have been extracted to other layers:\nAt scales #5 and #6 we begin to see larger and larger features:\nBy scale #8 we only see very high-level features such as the overall shape of the model\u0026rsquo;s nose, eye and cheek:\n🔗why use wavelets? Suppose, in the above example, that we wanted to smooth out some of the blotchiness in the model\u0026rsquo;s skin, without losing any of the underlying small-scale texture. Wavelet decomposition makes this a trivial operation - we can simply use the retouch module to apply a Gaussian blur to only the \u0026lsquo;blotchy\u0026rsquo; detail layer(s), leaving all other layers untouched. Once the adjustment is complete, the retouch module simply recombines the adjusted layer with the remaining untouched layers to produce the final image.\nThe sequence of images below shows (1) The original image; (2) The layer (scale 5) that we wish to blur; and (3) The final image after the scale 5 layer has been blurred and the layers recombined:\nAs you can see, the large-scale skin blotches have been removed, but the small-scale details remain untouched.\n🔗interacting with wavelet scales There are two methods by which processing modules allow you to modify their operation using wavelet scales.\n🔗wavelet decomposition As discussed above, the retouch module allows you to choose how many detail levels to split your image into. It decomposes the image into separate layers and allows you to perform operations selectively on each individual layer or on the image as a whole:\nSee the retouch module documentation for more details.\n🔗spline controls The denoise (profiled), raw denoise and contrast equalizer modules allow their effects to be applied more or less to each wavelet scale using splines.\nHere, each node in the graph represents a different level of detail in the image, from coarse detail on the left to fine detail on the right. You can raise or lower each of these nodes with your mouse to increase or decrease the module\u0026rsquo;s effect, respectively, on that wavelet scale.\nTo modify the curve, click slightly above or below the line near to a node and drag up or down. You can change the width of your modification by scrolling with your mouse wheel, which increases or reduces the size of the circle displayed under your mouse pointer. A small circle indicates that the effect of dragging the curve up or down will be isolated mostly to the node being adjusted. A larger circle indicates that the effect will be more broad and will increasingly impact adjacent nodes. When you hover your mouse over the graph, shaded areas indicate the parts of the spline that will be impacted when you attempt to modify the curve.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/wavelets/","tags":null,"title":"wavelets"},{"categories":null,"content":"The darktable team regularly reviews old modules and updates their implementation where issues are found or updated science means that they can be improved. Most of the time we try to update existing modules with new functionality but occasionally that becomes problematic, often due to the overhead of having to maintain multiple versions of the module. In such circumstances a new replacement module is created and the old module becomes deprecated.\nModule deprecation follows a fairly standard process: In the release that deprecates a module, that module can no longer be searched or added to custom module groups. It is moved into the read-only deprecated modules group and a message added to the module to warn of its removal and direct the user to a suitable alternative.\nAfter a year, the module is removed from the deprecated modules group and is then only available for use in old edits (where that module was already active against a given image). Deprecated modules are never fully removed from darktable (in order to retain old edits) but development ceases and you are advised to use supported modules instead if you encounter an issue.\nFor example, modules deprecated in darktable 3.4 will be removed from the deprecated modules group in darktable 3.8 (assuming two major releases each year).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/processing-modules/deprecated/","tags":null,"title":"deprecated modules"},{"categories":null,"content":"The darktable-cmstest binary (Linux only) investigates whether the color management subsystem of your computer is correctly configured and displays some useful information about the installed monitor profile(s).\ndarktable-cmstest is called without command line parameters.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/darktable-cmstest/","tags":null,"title":"darktable-cmstest"},{"categories":null,"content":"So far we have learned to use lua to adapt darktable to our particular workflow. Let\u0026rsquo;s look now at how to use lua to easily export images to an online service. If you are able to upload an image to a service via the command line then you can use lua to integrate this into darktable\u0026rsquo;s user interface.\nIn this next example we will use lua to export via scp. A new storage type will appear in darktable\u0026rsquo;s UI that will export images to a remote target via the copy mechanism in ssh.\ndarktable = require \u0026#34;darktable\u0026#34; darktable.preferences.register(\u0026#34;scp_export\u0026#34;,\u0026#34;export_path\u0026#34;, \u0026#34;string\u0026#34;,\u0026#34;target SCP path\u0026#34;, \u0026#34;Complete path to copy to. Can include user and hostname\u0026#34;,\u0026#34;\u0026#34;) darktable.register_storage(\u0026#34;scp_export\u0026#34;,\u0026#34;Export via scp\u0026#34;, function( storage, image, format, filename, number, total, high_quality, extra_data) if not darktable.control.execute(\u0026#34;scp \u0026#34;..filename..\u0026#34; \u0026#34;.. darktable.preferences.read(\u0026#34;scp_export\u0026#34;, \u0026#34;export_path\u0026#34;,\u0026#34;string\u0026#34;)) then darktable.print_error(\u0026#34;scp failed for \u0026#34;..tostring(image)) end end) darktable.preferences.register will add a new preference to darktable\u0026rsquo;s preferences menu, scp_export and export_path allow us to uniquely identify our preference. These fields are reused when we read the value of the preference. The string field tells the lua engine that the preference is a string. It could also be an integer, a filename or any of the types detailed in the API manual relating to types_lua_pref_type. We then have the label for the preference in the preference menu, the tooltip when hovering over the value and a default value.\ndarktable.register_storage is the call that actually registers a new storage type. The first argument is a name for the storage type, the second is the label that will be displayed in the UI and last is a function to call on each image. This function has a lot of parameters, but filename is the only one we use in this example. It contains the name of a temporary file where the image was exported by darktable\u0026rsquo;s engine.\nThis code will work but it has a couple of limitations. This is just a simple example after all:\nWe use preferences to configure the target path. It would be nicer to add an element to the export UI in darktable. We will detail how to do that in the next section.\nWe do not check the returned value of scp. That command might fail, in particular if the user has not correctly set the preference.\nThis script can\u0026rsquo;t read input from the user. The remote scp must use password-less copy \u0026ndash; scp can\u0026rsquo;t be provided with a password easily, so we will leave it that way.\nThere is no message displayed once the example is done, only the progress bar on the lower left side tells the user that the job is complete.\nWe use darktable.control.execute to call an external program. The normal os.execute would block other lua codes from happening.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/exporting-images/","tags":null,"title":"exporting images with lua"},{"categories":null,"content":"To start with, you need a suitable photo of your color reference card in RAW+JPEG format. It goes beyond the scope of this manual to explain the details of how to take this photo, but in a nutshell you need to make the shot on a sunny day around midday with the light source (the sun) shining at an angle onto the card. You need to avoid any glare in the image. The neutral white color patch in the gray ramp (G00) should end up at the L value specified in the description of your card. Often this is L=92 and requires you to overexpose the shot by about 1/3 EV. Ideally you will make several shots with slightly different exposures and later select the right one in darktable. Make sure that the chart fills up most of the frame. Use a lens with a “normal” focal length (e.g. 50mm equivalent) and stop down a bit to avoid vignetting.\nYou then open the raw file in darktable and disable most modules, especially base curve. Select the standard input matrix in the input color profile module and disable gamut clipping. Select “camera white balance” in the white balance module.\nThere is a special situation if your camera automatically applies some lens corrections (namely vignetting correction) to the resulting JPEG file. In this case you need to activate the lens correction module in darktable so that raw processing matches the JPEG in this respect. However, since darktable\u0026rsquo;s vignetting correction may not exactly match the in-camera correction, it is better to disable this correction in-camera if possible.\nTo output your image go to the export module in the lighttable.\nYou will need to select “Lab” as the output color profile. This color space is not visible in the combobox by default. You first need to enable it by setting allow_lab_output to TRUE in $HOME/.config/darktable/darktablerc. Alternatively, you can start darktable with:\ndarktable --conf allow_lab_output=true Then select “PFM (float)” as the output format and press “export” to generate the source image file.\nYou can produce the corresponding reference (target) image from the JPEG in a similar way. This time you will need to disable all modules and export with the “Lab” output color profile in “PFM (float)” format.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/darktable-chart/making-input-images/","tags":null,"title":"making input images for darktable-chart"},{"categories":null,"content":"darktable allows you to store additional information about your images to allow them to be more easily searched and grouped. This information is stored in darktable\u0026rsquo;s database and XMP sidecar files and can also be included within exported images.\n🔗metadata Metadata (e.g. title, description) is free-format text that usually differs for each image. You can add metadata to images in the metadata editor module.\n🔗tagging Tags are usually shared between multiple images and are used to categorise and group them. You can add tags to images in the tagging module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lighttable/digital-asset-management/metadata-tagging/","tags":null,"title":"metadata and tagging"},{"categories":null,"content":"As described in the previous sections, the final output of a module\u0026rsquo;s mask (the combined effect of any drawn and parameteric masks) is a grayscale raster image representing the extent to which the module\u0026rsquo;s effect should be applied to each pixel. This raster image is stored internally for active modules and can be subsequently reused by other modules in the pixelpipe.\nAs with any mask, if the opacity value for a pixel in a raster mask is zero the module\u0026rsquo;s input passed through the module unchanged. If the opacity is 1.0 the module has its full effect. For each value between 0 and 1.0 the module\u0026rsquo;s effect is applied proportionally at that location.\nYou can choose a raster mask from the combobox. Raster masks can be identified by the name of the module against which they were originally generated.\nNote: Raster masks are generated as part of a module\u0026rsquo;s internal processing. Once a module\u0026rsquo;s processing is complete its mask then becomes available to subsequent modules in the pixelpipe.\nThis has two implications:\nRaster masks cannot be generated by disabled modules since they do not participate in pixelpipe processing. As soon as you disable a module, its mask is no longer available for use.\nRaster masks are passed up the pixelpipe after module processing \u0026ndash; they can only be used by modules that come later in the pipe than the generating module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/darkroom/masking-and-blending/masks/raster/","tags":null,"title":"raster masks"},{"categories":null,"content":"Screens and most image file formats can only encode RGB intensities confined within a certain range. For example, images encoded on 8 bits can only contain values from 0 to 255, images on 10 bits from 0 to 1023, and so on… Graphic standards postulate that the maximum of that range, no matter its actual value, will always represent the maximum brightness that the display medium is able to render, usually between 100 and 160 Cd/m² (or nits) depending on the actual standard. We generally call this maximum \u0026ldquo;100 % display-referred\u0026rdquo;. The minimum of the range, encoded 0 no matter the bit-depth used, becomes then \u0026ldquo;0 % display-referred\u0026rdquo;. 100 % encodes pure white, 0 % encodes pure black.\nThis is a limitation for image processing applications, because it means that any pixel lying outside of this range will be clipped to the nearest bound, resulting in non-recoverable loss of data (colors and/or textures).\nFor the longest time, image processing software too was bounded to this limitation for technical reasons, and some still is, but now by design choice. As a result, they would clip RGB intensities at 100 % display-referred between image operations.\ndarktable uses floating-point arithmetic inside its color pipeline, which means it can handle any RGB value internally, even those outside the display-referred range, as long as it is positive. Only at the very end of the pipeline, before the image is saved to a file or sent to display, are the RGB values clipped if needed.\nPixels that can take values outside of the display range are said to have “unbounded colors”. One could choose to clamp (i.e. confine) those values to the allowed range at every processing step or choose to carry on with them, and clamp them only at the last step in the pipeline. However, it has been found that processing is less prone to artifacts if the unbounded colors are not clamped but treated just like any other color data.\nAt the end of the pipeline, modules like filmic rgb can help you to remap RGB values to the display-referred range while maximizing the data preservation and avoiding hard clipping, which is usually not visually pleasing.\nHowever, at all times in the pipeline, you must ensure that you do not create negative RGB values. RGB intensities encode light emissions and negative light does not exist. Those modules that rely on a physical understanding of light to process pixels will fail if they encounter a non-physical light emission. For safety, negative RGB values are still clipped whenever they might make the algorithms fail, but the visual result might look degraded. Negative values can be produced when abusing the black level in exposure or the offset in color balance and care should be taken when using these modules.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/unbounded-colors/","tags":null,"title":"unbounded colors"},{"categories":null,"content":"darktable supports variable substitution in a number of modules and preference settings. For example:\nDefining file names in the export module Displaying image information in the darkroom\u0026rsquo;s image information line Displaying image information in the lighttable\u0026rsquo;s overlays and tooltips (see preferences \u0026gt; lighttable) Placing text on an image in the watermark processing module 🔗available variables The following variables are available, though they may not all be applicable in every context:\n$(ROLL.NAME) film roll of the input image $(FILE.FOLDER) folder containing the input image $(FILE.NAME) basename of the input image $(FILE.EXTENSION) extension of the input image $(ID) the image id $(VERSION) the duplicate version number $(VERSION.IF_MULTI) same as $(VERSION) but null string if only one version exists $(VERSION.NAME) version name from metadata $(DARKTABLE.VERSION) the version of the running darktable instance $(DARKTABLE.NAME) name of darktable $(SEQUENCE[n,m]) a sequence number within an export job with n digits and starting with m parameters are optional, default is [4,1] $(WIDTH.SENSOR) width of RAW data in pixels before RAW crop $(HEIGHT.SENSOR) height of RAW data in pixels before RAW crop $(WIDTH.RAW) width of RAW data in pixels after RAW crop $(HEIGHT.RAW) height of RAW data in pixels after RAW crop $(WIDTH.CROP) image width in pixels at the end of the pixelpipe, but before export resize $(HEIGHT.CROP) image height in pixels at the end of the pixelpipe, but before export resize $(WIDTH.EXPORT) image width in pixels at the end of the pixelpipe and after export resize $(HEIGHT.EXPORT) image height in pixels at the end of the pixelpipe and after export resize $(WIDTH.MAX) maximum width entered in export module $(HEIGHT.MAX) maximum height entered in export module $(YEAR) year at date of import/export $(YEAR.SHORT) two-digit year at date of import/export $(MONTH) numeric (1-12) month at date of import/export $(MONTH.LONG) full month name at date of import/export $(MONTH.SHORT) abbreviated month name at date of import/export $(DAY) day at date of import/export $(HOUR) hour at time of import/export $(MINUTE) minute at time of import/export $(SECOND) second at time of import/export $(MSEC) millisecond at time of import/export $(EXIF.YEAR) Exif year $(EXIF.YEAR.SHORT) Exif year, two-digit version $(EXIF.MONTH) Exif month, numeric $(EXIF.MONTH.LONG) Exif month, full name $(EXIF.MONTH.SHORT) Exif month, abbreviated name $(EXIF.DAY) Exif day $(EXIF.HOUR) Exif hour $(EXIF.MINUTE) Exif minute $(EXIF.SECOND) Exif second $(EXIF.MSEC) Exif millisecond $(EXIF.DATE.REGIONAL) Exif date using user\u0026#39;s preferred regional date format $(EXIF.TIME.REGIONAL) Exif time using user\u0026#39;s preferred regional date format $(EXIF.ISO) Exif ISO value $(EXIF.EXPOSURE) Exif exposure $(EXIF.EXPOSURE.BIAS) Exif exposure bias $(EXIF.EXPOSURE.PROGRAM) Exif exposure program set in camera $(EXIF.APERTURE) Exif aperture $(EXIF.CROP_FACTOR) Exif crop factor $(EXIF.FLASH) Exif flash setting $(EXIF.FLASH.ICON) flash symbol if Exif information says flash was fired, empty string if not $(EXIF.FOCAL.LENGTH) Exif focal length $(EXIF.FOCAL.LENGTH.EQUIV) Exif 35 mm equivalent focal length $(EXIF.FOCUS.DISTANCE) Exif focus distance $(EXIF.LENS) Exif lens name $(EXIF.MAKER) Exif camera maker $(EXIF.METERING) Exif metering mode $(EXIF.MODEL) Exif camera model $(EXIF.WHITEBALANCE) Exif white balance set in camera $(IMAGE.EXIF) basic exposure information from Exif data (aperture, exposure, ISO) $(IMAGE.ID) the image id (note that this will be 0 during copy\u0026amp;import) $(IMAGE.ID[n]) the image id (note that this will be 0 during copy\u0026amp;import), zero-padded to n digits $(IMAGE.ID.NEXT) the next image id to be assigned (can be used during copy\u0026amp;import) $(IMAGE.ID.NEXT[n]) the next image id to be assigned (can be used during copy\u0026amp;import), zero-padded to n digits $(IMAGE.TAGS) tags list (Xmp.dc.Subject), with any hierarchy flattened $(IMAGE.TAGS.HIERARCHY) tags list (Xmp.dc.Subject), preserving hierarchy $(LONGITUDE) longitude $(LATITUDE) latitude $(ELEVATION) elevation $(GPS.ELEVATION) elevation $(GPS.LATITUDE) latitude $(GPS.LONGITUDE) longitude $(GPS.LOCATION) latitude, longitude, and elevation (omitting any values which are not set) $(GPS.LOCATION.ICON) symbol to indicate that geolocation information is present, empty string if not $(STARS) star rating (text only) $(RATING.ICONS) star rating (using star characters) $(LABELS) colorlabels (color labels as text) $(LABELS.ICONS) colorlabels (color labels as icons) $(MAKER) camera maker $(MODEL) camera model $(LENS) lens $(TITLE) title from metadata $(DESCRIPTION) description from metadata $(CREATOR) creator from metadata $(PUBLISHER) publisher from metadata $(RIGHTS) rights from metadata $(TAGS) tags list (Xmp.dc.Subject) $(CATEGORY[n,category]) tag name of level n [0,9] of selected category (or tag) $(SIDECAR_TXT) content of the text sidecar file (if any) $(FOLDER.PICTURES) pictures folder $(FOLDER.HOME) home folder $(FOLDER.DESKTOP) desktop folder $(OPENCL.ACTIVATED) whether OpenCL is activated $(USERNAME) user name defined by OS $(NL) newline character $(JOBCODE) internal jobcode of current job 🔗string substitution All of the variables support basic string substitution inspired by bash though some of the details differ.\nAll patterns are treated as simple string comparisons. There is no regex support.\nThe following string replacement functions are provided, where var is one of the variables listed above:\n$(var-default) If var is empty, return \u0026#34;default\u0026#34; It is possible to use another variable as \u0026#34;default\u0026#34;, e.g. $(WIDTH.CROP-$(WIDTH.RAW)) $(var+alt_value) If var is set, return \u0026#34;alt_value\u0026#34; else return empty string $(var:offset) Return var starting from offset If offset is negative count from the end of the string $(var:offset:length) Starting from offset, return at most length characters of var If offset is negative the length is counted from the end of var If length is negative this indicates the end of the result, counted from the end of var, and not an actual length $(var#pattern) Remove \u0026#34;pattern\u0026#34; from the start of var $(var%pattern) Remove \u0026#34;pattern\u0026#34; from the end of var $(var/pattern/replacement) Replace the first occurrence of \u0026#34;pattern\u0026#34; in var with \u0026#34;replacement\u0026#34; If \u0026#34;replacement\u0026#34; is empty then \u0026#34;pattern\u0026#34; will be removed $(var//pattern/replacement) Replace all occurrences of \u0026#34;pattern\u0026#34; in var with \u0026#34;replacement\u0026#34; If \u0026#34;replacement\u0026#34; is empty then \u0026#34;pattern\u0026#34; will be removed $(var/#pattern/replacement) If var starts with \u0026#34;pattern then \u0026#34;pattern\u0026#34; is replaced with \u0026#34;replacement\u0026#34; $(var/%pattern/replacement) If var ends with \u0026#34;pattern\u0026#34; then \u0026#34;pattern\u0026#34; is replaced with \u0026#34;replacement\u0026#34; $(var^) Make the first character of var uppercase $(var^^) Make all characters of var uppercase $(var,) Make the first character of var lowercase $(var,,) Make all characters of var lowercase 🔗formatting The image information patterns support markup. For example, adding the following will provide a clear warning (large, red, bold text) when OpenCL has failed to initialise:\n\u0026lt;span alpha='1%'\u0026gt;$(OPENCL_ACTIVATED/no/\u0026lt;span foreground='red' weight='heavy' size='xx-large' alpha='100%'\u0026gt;OPENCL ACTIVATION FAILED\u0026lt;/span\u0026gt;$(NL))\u0026lt;/span\u0026gt;\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/variables/","tags":null,"title":"variables"},{"categories":null,"content":"Our previous example was a bit limited. In particular the use of a preference for the export path wasn\u0026rsquo;t very nice. We can do better than that by adding elements to the user interface in the export dialog.\nUI elements are created via the darktable.new_widget function. This function takes a type of widget as a parameter and returns a new object corresponding to that widget. You can then set various fields in that widget to set its parameters. You will then use that object as a parameter to various functions that will add it to the darktable UI. The following simple example adds a lib in the lighttable view with a simple label:\ndarktable = require \u0026#34;darktable\u0026#34; local my_label = darktable.new_widget(\u0026#34;label\u0026#34;) my_label.label = \u0026#34;Hello, world !\u0026#34; darktable.register_lib(\u0026#34;test\u0026#34;,\u0026#34;test\u0026#34;,false,false,{ [darktable.gui.views.lighttable] = {\u0026#34;DT_UI_CONTAINER_PANEL_LEFT_CENTER\u0026#34;,20}, },my_label) There is a nice syntactic trick to make UI elements code easier to read and write. You can call these objects as functions with a table of key values as an argument. This allows the following example to work. It creates a container widget with two sub-widgets: a label and a text entry field.\nlocal my_widget = darktable.new_widget(\u0026#34;box\u0026#34;){ orientation = \u0026#34;horizontal\u0026#34;, darktable.new_widget(\u0026#34;label\u0026#34;){ label = \u0026#34;here =\u0026gt; \u0026#34; }, darktable.new_widget(\u0026#34;entry\u0026#34;){ tooltip = \u0026#34;please enter text here\u0026#34; } } Now that we know that, let\u0026rsquo;s improve our script a bit.\ndarktable = require \u0026#34;darktable\u0026#34; local scp_path = darktable.new_widget(\u0026#34;entry\u0026#34;){ tooltip = \u0026#34;Complete path to copy to. Can include user and hostname\u0026#34;, text = \u0026#34;\u0026#34;, reset_callback = function(self) self.text = \u0026#34;\u0026#34; end } darktable.register_storage(\u0026#34;scp_export\u0026#34;,\u0026#34;Export via scp\u0026#34;, function( storage, image, format, filename, number, total, high_quality, extra_data) if not darktable.control.execute(\u0026#34;scp \u0026#34;..filename..\u0026#34; \u0026#34;.. scp_path.text ) then darktable.print_error(\u0026#34;scp failed for \u0026#34;..tostring(image)) end end, nil, --finalize nil, --supported nil, --initialize darktable.new_widget(\u0026#34;box\u0026#34;) { orientation = \u0026#34;horizontal\u0026#34;, darktable.new_widget(\u0026#34;label\u0026#34;){ label = \u0026#34;target SCP PATH \u0026#34; }, scp_path, }) ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/building-ui-elements/","tags":null,"title":"building user interface elements"},{"categories":null,"content":"There are some infrequent situations that still can lead to problematic results unless the user takes some action. Some modules in Lab color space, like levels and monochrome, rely on the fact that the L channels carries all lightness information, with the a and b channels purely representing chroma and hue. Unbounded colors with negative L values are especially problematic to these modules and can lead to black pixel artifacts.\nIt has been found that highly saturated blue light sources in the image frame are likely candidates for pixels with negative L values. If you are engaged in stage photography you should pay close attention to such lights appearing in images.\nIn order to mitigate this issue the input color profile module has a gamut clipping option. This option is switched off by default but can be activated if artifacts are observed. Depending on the settings, colors will be confined to one of the available RGB gamuts. In effect black pixel artifacts are prevented at the costs of losing some color dynamics.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/color-artifacts/","tags":null,"title":"possible color artifacts"},{"categories":null,"content":"Control how images are processed.\n🔗image processing always use LittleCMS 2 to apply output color profile If this option is activated, darktable will use the LittleCMS 2 system library to apply the output color profile instead of its own internal routines. This is significantly slower than the default but might give more accurate results in some cases. If the given ICC is LUT-based or contains both a LUT and a matrix, darktable will use LittleCMS 2 to render the colors regardless of this parameter\u0026rsquo;s value (default off).\npixel interpolator (warp) The pixel interpolator used for rotation, lens correction, liquify, crop and final scaling. Whenever we scale or distort an image we have to choose a pixel interpolation algorithm (see wikipedia for details). For warping modules, darktable offers bilinear, bicubic or lanczos2. In general, bicubic is a safe option for most cases and is the default value.\npixel interpolator (scaling) The pixel interpolator used for scaling. The same options are provided as for the warp modules, but with the addition of lanczos3. lanczos3 can cause pixel overshoots leading to artefacts but sometimes gives a more crisp visual appearance. This option is therefore only provided for transforming (scaling) algorithms and is the default value.\nLUT 3D root folder Define the root folder (and sub-folders) containing LUT files used by the LUT 3D module auto-apply pixel workflow defaults Choose which modules and module order are applied to new RAW image edits by default: scene-referred (filmic) (default) assumes that most processing will be performed in a linear RGB color space. Selecting this option automatically enables the filmic rgb, exposure and color calibration modules for new edits and sets the module order to v3.0 RAW.\nThe exposure module includes an automatic exposure adjustment of +0.7 EV (to provide a midtone brightening comparable to the +0.5 to +1.2 EV typically added by in-camera tone curves), and automatically enables the \u0026ldquo;compensate camera exposure\u0026rdquo; option for the filmic workflow. Both of these settings are intended to provide a reasonable starting-point for RAWs produced by a broad range of SLR and mirrorless cameras, but they can be overridden with an automatically-applied preset if the defaults produce consistently dark images for your camera.\nIn the scene-referred workflows, the color calibration module acts in conjunction with the white balance module as the modern way to handle white balance and chromatic adaptation with improved color science. Note that when using the color calibration module, the white balance module needs to be active and set to \u0026ldquo;Camera Reference\u0026rdquo; mode (this will be done automatically and warnings will appear if the two modules have inconsistent settings). When using both modules as prescribed, it is still possible to auto-detect white-balance from a specific area of the image by selecting the CCT picker tool in the CAT tab of color calibration.\nscene-referred (sigmoid) follows the same assumptions and overall flow as scene-referred (filmic), with the exception that it auto-enables the sigmoid module for tone mapping in place of filmic rgb.\ndisplay-referred (legacy) is the legacy mode (used by default in darktable 2.6 and earlier) and assumes that most processing will be performed in the Lab color space. Selecting this option automatically enables the base curve module for tone mapping and sets the module order to legacy. This workflow uses only the white balance module for chromatic adaptation.\nnone sets the module order to v3.0 RAW and uses the white balance module for chromatic adaptation. No other exposure or tone mapping modules are enabled by default.\nauto-apply per camera basecurve presets Use a per-camera base curve by default (if available) instead of the generic manufacturer one. This should only be used in conjunction with the display-referred workflow defined above (default off). detect monochrome previews Enable this option to analyse images during import and tag them with the darkroom|mode|monochrome tag if they are found to be monochrome. The analysis is based on the preview image embedded within the imported file. This makes for a more convenient workflow when working with monochrome images, but it slows down the import, so this setting is disabled by default. show warning messages Enable this option to display warning messages in processing modules where non-standard and possibly harmful settings have been used in the pipeline. Such messages can sometimes be false-positives (because of intentional non-standard settings) and can be disregarded if you know what you are doing. Disable to hide these warnings. (default on). 🔗CPU / memory darktable resources Choose how much of your system and graphics card (GPU) memory will be used by darktable. Four options are provided by default: small takes roughly 20% of your system memory and 40% of your GPU memory. This might be acceptable on very large systems, especially if you\u0026rsquo;re not exporting images. Mostly, though, this can only be recommended if you are using a lot of other demanding applications at the same time as darktable. default takes roughly 60% of your system memory and 70% of your GPU memory. This mode is recommended if you\u0026rsquo;re not exporting a lot of images, have at least 16Gb of system memory and 4Gb of GPU memory, and also are running a lot of other application at the same time as darktable. large takes roughly 75% of your system memory and 90% of your GPU memory. This is the best option if you are only using darktable on your system and/or are exporting a lot of images. unrestricted is not generally recommended. In this mode darktable may attempt to use more memory than your system has available. This might be possible if your system uses swapping when all of its system memory is taken, but it could lead to system instability. Use this mode with care, only when exporting very large images that darktable cannot otherwise handle. See the memory \u0026amp; performance tuning section for more information.\nprefer performance over quality Enable this option to render thumbnails and previews at a lower quality. This increases the rendering speed by a factor of 4, and is useful when working on slower computers (default off). This also improves the performance of slideshow image rendering. 🔗OpenCL activate OpenCL support Your GPU can be used by darktable to significantly speed up processing. The OpenCL interface requires suitable hardware and matching OpenCL drivers on your system. If one of those is not found this option is grayed out. OpenCL support can be switched on and off at any time and takes immediate effect (default on). OpenCL scheduling profile Defines how preview and full pixelpipe tasks are scheduled on OpenCL enabled systems: default: the GPU processes the center view pixelpipe; the CPU processes the preview pipe. very fast GPU: both pixelpipes are processed sequentially on the GPU. multiple GPUs: both pixelpipes are processed in parallel on different GPUs \u0026ndash; see the multiple devices section for more information. use all device memory Enable this option to allow darktable to use all OpenCL memory on all devices except for a safety margin (headroom). The default headroom is 600MB and can also be specified on a per-device basis. OpenCL drivers In most cases darktable is able to find the correct OpenCL driver but this depends on how your operating system handles installation. Generally speaking, darktable must: not use unreliable drivers only have one active driver per hardware device. Problems are typically found where the vendor-provided driver is installed as well as another driver (like rusticl) or (on Windows) where the OpenCLon12 driver has been installed via the OpenCL Compatibility Pack. Toggle-switches are offered for most available drivers, though on more exotic hardware like ARM boards you will have to enable the \u0026ldquo;other platforms\u0026rdquo; fallback option. Select the drivers you want to use from the list. If you suspect that a driver is malfunctioning you can explicitly disable it here.\nSee the memory \u0026amp; performance tuning section for more information.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/processing/","tags":null,"title":"processing"},{"categories":null,"content":"Find and remove entries from the library database referencing images that no longer exist in the filesystem. You must close darktable before running this script.\nThe script can be called with the following command line parameters:\npurge_non_existing_images.sh [-c|--configdir \u0026lt;path\u0026gt;] [-l|--library \u0026lt;path\u0026gt;] [-p|--purge] Run the script with no options to perform a \u0026ldquo;dry run\u0026rdquo;, which generates a report of the missing files without committing any changes to the database.\nThe available options are:\n-c|--configdir \u0026lt;path\u0026gt; Specify the path to the darktable configuration directory to be used by the script. If this option is not provided, the default config directory location will be used. -l|--library \u0026lt;path\u0026gt; Specify the path to the library.db database file to be analysed by the script. If this option is not specified, the default library.db file location will be used. -p|--purge Actually delete any entries in the database that refer to non-existent files. If the option is not provided, a report will be printed without committing any changes to the database. Notes:\nThe script must be run in a unix shell, and the sqlite3 client must be available in the command search path. For Linux systems, this will normally not be an issue.\nFor Windows systems, you will normally need the MSYS2 environment to be installed, as described in the instructions for building darktable in a Windows environment. If you installed darktable using the standard Windows installer package, the location of the script would normally be something like: C:\\Program Files\\darktable\\share\\darktable\\tools\\purge_non_existing_images.sh.\nFor macOS systems, the Terminal application provides a shell, and the sqlite3 client is provided by the operating system by default. If darktable was installed using an application bundle from a dmg image, then the default location for the script would be /Applications/darktable.app/Contents/Resources/share/darktable/tools/purge_non_existing_images.sh\nThe delete operation can\u0026rsquo;t be undone. It is therefore strongly recommended that you take a backup of the database before purging any entries.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/program-invocation/purge_non_existing_images_sh/","tags":null,"title":"purge_non_existing_images.sh"},{"categories":null,"content":"This section defines the perceptual properties of color, both conceptually and quantitatively, in order to characterize and quantify the creative and corrective adjustments made to color in darktable.\n🔗definitions Color properties like \u0026ldquo;saturation\u0026rdquo;, \u0026ldquo;brightness\u0026rdquo; or \u0026ldquo;lightness\u0026rdquo; have passed into common usage but are largely misused and often used to mean different things. In color science, each of these terms has a precise meaning.\nThere are two frameworks within which color properties may be analyzed and described:\nA scene-linear, physiological, framework, that mostly focuses on the response of the retina cone cells, using color spaces such as CIE XYZ 1931 or CIE LMS 2006, A perceptual, psychological, framework that stacks the brain\u0026rsquo;s corrections on top of the retina signal, using color spaces such as CIE Lab 1976, CIE Luv 1976, CIE CAM 2016 and JzAzBz (2017). These two frameworks provide us with metrics and dimensions to analyze color and allow us to change some of its properties while preserving others.\nThe following dimensions of color are used by darktable:\nhue An attribute of visual perception in which an area appears to be similar to one of the colors red, yellow, green, or blue, or to a combination of adjacent pairs of these colors considered in a closed ring. 1 Hue is a shared property between the perceptual and scene-linear frameworks. luminance The density of luminous intensity with respect to a projected area in a specified direction at a specified point on a real or imaginary surface. 2 Luminance is a property of scene-referred frameworks, and is expressed by the Y channel of the CIE XYZ 1931 space. brightness An attribute of visual perception according to which an area appears to emit, transmit or reflect more or less light. 3 lightness The brightness of an area judged relative to the brightness of a similarly illuminated area that appears to be white or highly transmitting. 4 Lightness is the perceptual, non-linear homologue of luminance (roughly equal to the cubic root of luminance Y). Lightness is expressed by the L channel in CIE Lab and Luv 1976 and the J channel in JzAzBz. chroma The colorfulness of an area judged as a proportion of the brightness of a similarly illuminated area that appears gray, white or highly transmitting. 5 Warning: chroma is not short for chrominance, which is the color part of a video signal (the Cb and Cr channels in YCbCr, for example). brilliance The brightness of an area judged relative to the brightness of its surroundings. 6 saturation The colorfulness of an area judged in proportion to its brightness. 7 purity The distance of the pixel chromaticity from the white point in the xy chromaticity plane. Zero purity means the light is achromatic. High purity, at the other extreme, means the light is laser-like, composed of a single wavelength. Colors can be described in many different color spaces, but no matter the color space, each color needs at least 3 components: some metric of luminance or brightness, and 2 metrics of chromaticity (hue and chroma, or opponent color coordinates).\n🔗illustrations While the previous definitions are useful to give a meaning to the words, they don\u0026rsquo;t tell us what we should be looking at. The following charts show luminance, lightness, chroma, brilliance/brightness and saturation varying from a \u0026ldquo;0\u0026rdquo; base color and how the resulting colors degrade:\n(Lightness + Chroma) or (Brilliance/Brightness + Saturation) are two different ways to encode the same reality. They are orthogonal spaces that can be converted from one to another by a simple rotation of the base. This means that chroma evolves at constant lightness, saturation evolves at constant brilliance/brightness, and vice versa:\nLines of equal chroma are vertical (following the patches grid), meaning that chroma has the same direction for all colors in the gamut (see below). However, lines of equal saturation are oblique (drawn dashed on the graph) and all go from black through each color patch, meaning that their directions are particular to each color.\nIncreasing the chroma will therefore move all colors uniformly away from the central gray axis horizontally, while increasing the saturation will close or open the angle of the oblique dashed lines like a flower.\nSimilarly, increasing the lightness will move all colors uniformly up from the horizontal axis, while increasing brilliance/brightness will move them along the lines of equal saturation.\nOn both of the above charts, lightness, chroma, saturation and brilliance are drawn in the JzAzBz color space, which is a perceptual color space suited for an HDR signal, and is used in parametric masks and the color balance RGB module. Luminance is drawn in the CIE XYZ 1931 color space, and represents the effect of an exposure compensation. It shows the same behaviour as brilliance, except that the step size is not perceptually scaled.\nNote: In this section, brilliance and brightness are both used to describe the same dimension. In all rigor, brightness is an absolute metric, whereas brilliance is the brightness of some surface relative to the brightness of its surroundings (that is, how much a surface \u0026ldquo;pops\u0026rdquo; out of its surroundings and looks fluorescent). But in image editing, increasing the brightness of some surface will indeed increase its brilliance too, so the term brilliance is preferred in darktable\u0026rsquo;s user interface for clarity and in reference to its visual effect.\n🔗color dimensions and gamut The gamut is the volume of colors that a certain color space can encompass and encode. It is important to note that, once converted to perceptual spaces, the gamut of any RGB space is not uniform along hues.\nThe following examples show the gamut volume of the sRGB space on hue slices containing the primary red, green and blue lights of the sRGB space, over a lightness-chroma plane with a uniform scale:\nThis shows that increasing the chroma (displacement over the horizontal axis) of some quantity can be safe for some hues at some lightness, but can push other hue-lightness coordinates way out of gamut. For example, we have much more margin in green or magenta than in cyan.\nMany gamut issues at export are actually user-induced and the result of harsh chroma enlarging. For that reason, using brightness-saturation color models may be safer.\n🔗color dimensions and complementary colors Cyan, magenta, yellow (CMY) are complementary colors of red, green, blue (RGB). However, the complementary CMY spaces computed from RGB spaces are not perceptually complementary. To show this, we create a CMY space from sRGB, where cyan has sRGB coordinates (0, 1, 1), magenta (1, 0, 1) and yellow (1, 1, 0), and display it in a lightness-chroma space:\nBy comparing with the hue slices of the primary colors in the previous section, it is easy to see not only that the gamuts don\u0026rsquo;t have the same shapes, but that the colors do not match.\nThis is one more reason to avoid using HSL/HSV spaces (derived from RGB spaces) to perform color editing: since these RGB spaces are not perceptually uniform in the first place, the resulting HSV/HSL spaces are not uniform either. While RGB spaces have some merit based on their connection to physical light, any process involving hue should go directly to perceptual spaces.\n🔗color dimensions and settings Many applications, including darktable, call any settings that affect chroma \u0026ldquo;saturation\u0026rdquo; (for example, in color balance, \u0026ldquo;contrast/brightness/saturation\u0026rdquo;). This is a symptom of software trying to be accessible to non-professionals by using a common language. This is misleading, since saturation does exist and is quite different from chroma. In addition, many video specifications improperly call chroma \u0026ldquo;saturation\u0026rdquo;. Whenever darktable reuses such specifications, it uses the incorrect term from the specification rather than the proper color dimension term.\nCIE definition of hue: https://cie.co.at/eilvterm/17-22-067\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nCIE definition of luminance: https://cie.co.at/eilvterm/17-21-050\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nCIE definition of lightness: https://cie.co.at/eilvterm/17-22-059\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nCIE definition of brightness: https://cie.co.at/eilvterm/17-22-063\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nCIE definition of chroma: https://cie.co.at/eilvterm/17-22-074\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nArticle about brilliance (paywall): https://doi.org/10.1002/col.20128\u0026#160;\u0026#x21a9;\u0026#xfe0e;\nCIE definition of saturation: https://cie.co.at/eilvterm/17-22-073\u0026#160;\u0026#x21a9;\u0026#xfe0e;\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-management/color-dimensions/","tags":null,"title":"darktable's color dimensions"},{"categories":null,"content":"Most image processing applications come from the 1990s and/or inherit a 1990s workflow. These applications processed images encoded with 8 bit unsigned integers because it was more memory- and computationally-efficient. However, due to the use of an integer format (which implies rounding errors) they had to apply a \u0026ldquo;gamma\u0026rdquo; (essentially a transfer function applying a power 1/2.2 or 1/2.4 to encode the RGB values) and increase the bit-depth in the low-lights in order to reduce rounding errors there (humans are very sensitive to low-light details). The 8 bit integer formats are also technically limited to the 0-255 range. Anything outside of this range overflows and is clipped to the nearest bound.\nThese workflows, using bounded RGB representations and possibly non-linear transforms to encode RGB signals, are called \u0026ldquo;display-referred\u0026rdquo;. They rely on the assumption that the image has been prepared for display at an early stage in the processing pipeline, and embed hard-coded assumptions about the RGB values of black, middle-gray and white. Most of the image-processing algorithms used in these workflows have been tuned around these assumptions. For example, the overlay blending mode expects a middle-gray encoded at 50% (or 128 in integer encoding).\nUnfortunately the non-linear scaling, which is mandatory to make the integer encoding work, breaks the natural relationships between pixel values. Hue and saturation change in unpredictable ways, and value relationships between neighbouring pixels are dilated or compressed such that gradients are also altered unpredictably.\nDisplay-referred pipelines therefore break optical filters (lens blurring or deblurring), alpha compositing (which relies on optical and geometrical definitions of occlusion), colors and gradients (local relationships between chrominance and luminance of pixels). They also don\u0026rsquo;t scale well to HDR images, which led to the development of many questionable local and global tonemapping methods and the infamous 2010s \u0026ldquo;HDR look\u0026rdquo;.\nModern computers are not tied to the same computational limitations as those from the 1990s, and can work on pixels whose values are completely unbounded (from 0 up to +infinity) and encoded as real numbers (using floating point formats). These possibilities enable what we call a \u0026ldquo;scene-referred\u0026rdquo; workflow, in which pixels can retain their original radiometric relationships along almost the entire processing pipe. In scene-referred workflow, pixels are prepared for display only at the last stage of the pipeline, in the display transform. This means that the RGB values of the pixels are kept proportional to the intensity of the light emission recorded by the camera on the scene, enabling accurate alpha compositing and optical filter emulations, while also scaling to any dynamic range through the same algorithm (SDR as well as HDR).\nHowever, scene-referred pipelines lose the convenient fixed values of white, middle-gray and black which characterised display-referred pipelines, and setting these values, according to the scene and to the conditions of shooting, now becomes the responsibility of the user. This requires a more complex user interface.\nAlso, because scene-referred values are supposed to be physically-meaningful, pixels cannot have zero intensity. This would mean they have no light at all, and the existence of zero light breaks many physically-accurate algorithms. In fact, white and black mean nothing with regard to the original scene, which is only a collection of luminances at varying intensities. The scene-referred workflow simply aims at remapping some arbitrary scene luminances to what will appear white or black on the output medium.\nVersions of darktable prior to 2.6 had a non-linear display-referred pipeline, assuming that a non-linear transform took place early in the pipe and middle-gray was thereafter encoded as 50%. However, not all modules and filters clipped pixel values above 100%, leaving open the possibility of recovering those values later in the pipe.\nThe filmic module\u0026rsquo;s view transform, introduced in darktable 2.6, was the first step toward a scene-referred pipeline, and deferred the mandatory, non-linear, display preparation to the end of the pipe, along with the ability to set custom black, gray and white values. The color balance module then introduced a way to deal with a variable definition of middle-gray.\nStarting in darktable 3.2, users could choose between two workflows that defined consistent default settings, modules and pipeline order for both display-referred and scene-referred processing.\nIn darktable 3.4, a full scene-referred masking and blending option was introduced, allowing masks to be defined for pixel values above 100% and using only unbounded blending operators.\nSwitching to scene-referred is a cognitive leap for most experienced users, who are used thinking in display-referred ways. In a display-referred workflow, it is customary to anchor the white value and let tone adjustments revolve around that point, trying to maximize brightness while avoiding clipping. In a scene-referred workflow, white and black values are fluid and adapted to the output medium. It is advised that users anchor middle-gray (which will be preserved as-is for any output medium) and let the view transform (filmic) dilate or contract the dynamic range around that point. Because 10 bit HDR white is 4 times as bright as 8 bit SDR white, any rigid definition of \u0026ldquo;white\u0026rdquo; becomes irrelevant. But anchoring for middle-gray is actually more convenient, since it keeps the average brightness of the picture unchanged through the view transform.\nSome modules (levels, rgb levels, tone curve, rgb curve) are inherently incompatible with a scene-referred workflow, because their graphical interface implicitly suggests RGB values that are bounded within the 0-100% range. While the pixel operations they perform can be used in either scene-referred or display-referred workflows because they are unbounded internally, their controlling interface does not allow pixels to be selected outside of the 0-100% range.\nSimilarly, blending modes such as overlay, linear light, soft light, hard light, darken, brighten, etc. all have hard-coded thresholds that internally expect display-referred non-linear encoding.\nIn darktable 3.4 and above, hovering the cursor over a module header shows a tooltip detailing the color spaces, ranges and encodings that the module expects, uses and produces. Here are the definitions of the terms used:\nlinear Pixel values are proportional to the scene radiometric emission, in a way that enables accurate emulation of physical filters. non-linear Pixel values are re-scaled such that low-lights are given a larger encoding range, usually to remap the 18.45% reference middle-gray to a value between 46 and 50%. display-referred Pixel values are expected to lie between 0 and 100% of the display range, where 100% is understood to be the luminance of a 20% reflective white surface (the white patch of a Color Checker) and 0% is understood to be the maximum density of the output medium (saturated black ink or minimum LED panel backlighting). scene-referred Pixel values are expected to be greater than zero up to +infinity. The meaning of specific pixel values needs to be defined at runtime by the user. Scene-referred values don\u0026rsquo;t automatically imply a linear, radiometrically scaled, encoding. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/color-pipeline/","tags":null,"title":"darktable's color pipeline"},{"categories":null,"content":"darktable can use the CPU and one or several OpenCL capable GPUs. Depending on the relative performance of these devices, users can choose among certain scheduling profiles to optimize performance. This is achieved by setting the configuration parameter preferences \u0026gt; processing \u0026gt; OpenCL \u0026gt; OpenCL scheduling profile, which offers the following choices:\ndefault If an OpenCL-capable GPU is found darktable uses it for processing the center image view while the navigation preview window is processed on the CPU in parallel. This is the preferred setting for systems with a reasonably fast CPU and a moderately fast GPU. The exact allocation of devices to the various pixelpipe types can be finetuned with the “opencl_device_priority” configuration parameter (see multiple devices). very fast GPU With this scheduling profile darktable processes the center image view and the preview window on the GPU sequentially. This is the preferred setting for systems with a GPU that strongly outperforms the CPU. multiple GPUs This setting addresses systems with multiple GPUs whose relative performance do not differ significantly. Whenever a processing job is started darktable uses any currently idle GPU but not the CPU. Users of systems with a variety of GPUs will need better control on their relative priority. They would be better off selecting the “default” profile and fine-tuning their system with the “opencl_device_priority” configuration parameter (see multiple devices). On first start-up or after any detected change in the GPU configuration of your system darktable tries to identify the best suited profile for you. You can change it at any time in preferences \u0026gt; processing \u0026gt; OpenCL.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/scheduling-profile/","tags":null,"title":"scheduling profile"},{"categories":null,"content":"Control whether warning messages are shown before undertaking certain activities.\n🔗general ask before removing images from the library Always ask before removing image information from darktable\u0026rsquo;s library database, where the xmp file is retained (default on). ask before deleting images from disk Always ask before deleting an image file (default on). ask before discarding history stack Always ask before discarding the history stack of an image (default on). try to use trash when deleting images Instead of physically deleting images from disk, attempt to put them into the system\u0026rsquo;s trash bin (default on). ask before moving images from film roll folder Always ask before moving an image file (default on). ask before copying images to new film roll folder Always ask before copying an image file to a new location (default on). ask before removing empty folders Always ask before removing any empty folder. This can happen after moving or deleting images (default off). ask before deleting a tag Always ask before deleting a tag from an image (default on). ask before deleting a style Always ask before deleting a style (default on). ask before deleting a preset Always ask before deleting a preset (default on). ask before exporting in overwrite mode Always ask before exporting images in overwrite mode. 🔗other password storage backend to use The backend to use for password storage. Options: “auto” (default), “none”, “libsecret”, “kwallet”, \u0026ldquo;apple_keychain\u0026rdquo; (on macOS), \u0026ldquo;windows_credentials\u0026rdquo; (on Windows). executable for playing audio files Define an external program which is used in the lighttable view to play audio files that some cameras record to keep notes for images (default “aplay”). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/security/","tags":null,"title":"security"},{"categories":null,"content":"So far, all of our lua code has been in luarc. That\u0026rsquo;s a good way to develop your script but not very practical for distribution. We need to make this into a proper lua module. To do that, we save the code in a separate file (scp-storage.lua in this case):\n--[[ SCP STORAGE a simple storage to export images via scp AUTHOR Jérémy Rosen (jeremy.rosen@enst-bretagne.fr) INSTALLATION * copy this file in $CONFIGDIR/lua/ where CONFIGDIR is your darktable configuration directory * add the following line in the file $CONFIGDIR/luarc require \u0026#34;scp-storage\u0026#34; USAGE * select \u0026#34;Export via SCP\u0026#34; in the storage selection menu * set the target directory * export your images LICENSE GPLv2 ]] darktable = require \u0026#34;darktable\u0026#34; dtutils = require \u0026#34;lib/dtutils\u0026#34; dtutils.check_min_api_version(\u0026#34;7.0.0\u0026#34;, ...) local scp_path = darktable.new_widget(\u0026#34;entry\u0026#34;){ tooltip = \u0026#34;Complete path to copy to. Can include user and hostname\u0026#34;, text = \u0026#34;\u0026#34;, reset_callback = function(self) self.text = \u0026#34;\u0026#34; end } darktable.register_storage(\u0026#34;scp_export\u0026#34;,\u0026#34;Export via scp\u0026#34;, function( storage, image, format, filename, number, total, high_quality, extra_data) if not darktable.control.execute(\u0026#34;scp \u0026#34;..filename..\u0026#34; \u0026#34;.. scp_path.text ) then darktable.print_error(\u0026#34;scp failed for \u0026#34;..tostring(image)) end end, nil, --finalize nil, --supported nil, --initialize darktable.new_widget(\u0026#34;box\u0026#34;) { orientation = \u0026#34;horizontal\u0026#34;, darktable.new_widget(\u0026#34;label\u0026#34;){ label = \u0026#34;target SCP PATH \u0026#34; }, scp_path, }) darktable will look for scripts (following the normal lua rules) in the standard directories plus $CONFIGDIR/lua/*.lua. So our script can be called by simply adding require \u0026quot;scp-storage\u0026quot; in the luarc file. A couple of extra notes\u0026hellip;\nThe function dtutils.check_min_api_version will check compatibility for you. \u0026quot;7.0.0\u0026quot; is the API version you have tested your script with and the \u0026ldquo;...\u0026rdquo; will turn into your script\u0026rsquo;s name.\nMake sure to declare all your functions as local so as not to pollute the general namespace.\nMake sure you do not leave debug prints in your code \u0026ndash; darktable.print_error in particular allows you to leave debug prints in your final code without disturbing the console.\nYou are free to choose any license for your script but scripts that are uploaded on darktable\u0026rsquo;s website need to be GPLv2.\nOnce you have filled all the fields, checked your code, you can upload it to our script page here.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/sharing-scripts/","tags":null,"title":"sharing scripts"},{"categories":null,"content":"🔗introduction MIDI is a communication protocol used by many electronic musical instruments (\u0026ldquo;pianos\u0026rdquo;), digital audio studio equipment (\u0026ldquo;control surfaces\u0026rdquo;) and even dedicated \u0026ldquo;photo editing keyboards\u0026rdquo; like the Loupedeck/Loupedeck+ (but not their later products). Such devices commonly feature sets of keys/buttons and sometimes encoders (knobs/rotors) and faders (sliders). Buttons sometimes feature lights, which makes them ideal for toggling features in darktable, because the lights can reflect the current (on/off) status. Encoders and faders are ideal for use with on-screen sliders in processing modules. They can be \u0026ldquo;endless\u0026rdquo; (without a start/end point and without any markings on the knob) allowing greater than 360 degrees rotation, and they may be motorized. This is helpful when switching between images or points in the editing history since the \u0026ldquo;physical\u0026rdquo; position of the encoders/faders always corresponds to the on-screen position. You may also find a ring of LEDs around an encoder that indicates its current value.\n🔗endless encoders; absolute / relative encoding Besides their physical features, these devices are often highly configurable in how they send data. Encoders can send their \u0026ldquo;absolute\u0026rdquo; position when they are turned, as a value in the range 0-127. Darktable will send back the current position of the on-screen slider, which a ring of LEDs would show (if present) or a motorized fader would respond to (by moving the knob). If the encoder is endless, it can also be used at different speeds and higher resolution than just the 128 steps, with either many rotations or less than a full rotation required to move the on-screen slider between extremes.\nEndless encoders without ring lights might send relative movements which can be accelerated when turning quickly. Different encoding modes can be used, and the device might come with software to configure these options. It is important that all encoders use the same settings and send on the same \u0026ldquo;channel\u0026rdquo; as the keys (ideally the first: 0 or 1). By default darktable tries to figure out which channel and encoding is used by listening to the first five messages. After starting a session you should slowly turn a knob left/down so that 5 identical one-step-down messages are sent. If this fails the input system can be reset (by pressing Ctrl+Alt+Shift+i) for another try. On success, a toast message will be shown in the middle of the screen displaying the discovered encoding mode \u0026ndash; 127 (\u0026ldquo;2s Complement\u0026rdquo;) and 63 (\u0026ldquo;Relative Offset\u0026rdquo;) are common.\n🔗usage If your device has been successfully configured and connected, you should see messages like \u0026ldquo;G#\u0026ndash;1 (8) not assigned\u0026rdquo; when you press a button (the first is a musical notation code for the \u0026ldquo;tone\u0026rdquo;, the second a numerical representation) or \u0026ldquo;CC1,up not assigned\u0026rdquo; when adjusting an encoder. You are now ready to assign buttons and encoders to actions. The easiest way to do this for a bunch of them in one go is to press the visual shortcut mapping button (to the left of the preferences button) to enter shortcut visual mapping mode. In this mode, when you hover the mouse over a button or slider, if you then press a key or turn an encoder on the MIDI device, it gets assigned as a shortcut to that widget. You can immediately test it (while staying in mapping mode) by moving the mouse to the middle of the screen (so you don’t accidentally assign it to a different widget) and then repeating the action. Right-click to switch off mapping mode.\nYou might also want to assign buttons to duplicate the Ctrl and Shift key functions. For this, you need the full shortcuts dialog (right-click on the shortcuts button or open preferences and go to the shortcuts tab). In the top (\u0026ldquo;action\u0026rdquo;) list, double-click on \u0026ldquo;global/modifiers\u0026rdquo;. Now press the MIDI button you want to assign to Shift. Double click on \u0026ldquo;global/modifiers\u0026rdquo; again, but this time after assigning a button change the element for the newly created shortcut in the bottom list from \u0026ldquo;shift\u0026rdquo; to \u0026ldquo;ctrl\u0026rdquo;. Now you can use your MIDI device together with your mouse to access most of the functionality in darktable. After ticking \u0026ldquo;enable fallbacks\u0026rdquo; in the shortcuts dialog, holding Ctrl while turning an encoder will slow it down by a factor 10, whereas holding Shift speeds it up.\nSeveral devices produced by Behringer have LEDs in a circle around their encoder knobs. These use different patterns depending on what slider or combobox they are assigned to:\nIf the slider goes from -1 to +1, only the middle LED will be lit at zero. Moving negative will gradually light up the left side, moving positive will light the right side. If the slider goes from 0-100%, you’ll see more LEDs coming on when moving right, until they are all lit at 100%. Other numeric values will use 1 or 2 LEDs to indicate intermediate values. Dropdowns will use 1 LED for the options that fit on the first turn of the dial and 2 on the second turn. 🔗troubleshooting and configuration If you don’t see any \u0026ldquo;not assigned\u0026rdquo; toast at the top of your screen when pressing keys or turning knobs, you’ll want to test if any other MIDI applications can see the device. Under Linux you’ll need to have Alsa installed. After plugging in the device, dmesg should show lines like these:\nusb 1-1: new full-speed USB device number 2 using xhci_hcd ... mc: Linux media interface: v0.10 usbcore: registered new interface driver snd-usb-audio Darktable uses the simple cross-platform layer PortMidi to access the underlying OS API (Alsa, Core Midi, WinMM). If you are self-compiling, make sure you have included this library.\nStarting darktable with the debug parameters -d input will give additional information. It should try to open up to 10 MIDI devices in the order it finds them. On the command line you might see something like this:\n[midi_open_devices] opened midi device \u0026#39;Arturia BeatStep\u0026#39; via \u0026#39;MMSystem\u0026#39; as midi0 [midi_open_devices] opened midi device \u0026#39;BCR2000\u0026#39; via \u0026#39;MMSystem\u0026#39; as midi1 [midi_open_devices] opened midi device \u0026#39;X-TOUCH MINI\u0026#39; via \u0026#39;MMSystem\u0026#39; as midi2 Two issues can arise:\na device you don\u0026rsquo;t want to use might be opened anyway (and potentially cause inappropriate behavior, like starting a fireworks show prematurely \u0026ndash; see this document); or devices might appear in a different order at the next startup (for example because they are plugged into a different usb port). Since configurations are stored with the device number only, reordering would cause an incorrect layout to be picked up. You can fix which devices to load in a specific location and which ones to skip using the configuration parameter preferences \u0026gt; miscellaneous \u0026gt; interface \u0026gt; order or exclude midi devices. To skip loading the BCR2000 in the above example and to fix the other two devices into the number 0 and 2 slots, you could set this config parameter to \u0026ldquo;BeatStep;dontuse;X-TOUCH;-BCR2000\u0026rdquo;. This would leave the BeatStep as device midi0, always leave midi1 unused and would not load the BCR2000 at all, but if any other devices are connected, they would appear as midi3, midi4 and so on. Adding \u0026ldquo;;-\u0026rdquo; at the end would prevent any further devices loading.\nIf you just specify the configuration parameter as a single minus sign \u0026ldquo;-\u0026rdquo;, no devices will be loaded at all.\nFor devices that use relative encoding as mentioned above, you’d have to perform the slow-turn-left procedure on every start-up, or add the found encoding to the configuration string. For example \u0026ldquo;Loupedeck:127\u0026rdquo;.\nSome MIDI controllers have keys with a light beneath them. These can be used to toggle settings and show the current position by having the light on or off. For this to work, darktable checks periodically (a few times a second) whether, say, the position of an on-screen toggle button has been changed, and sends messages to any linked MIDI device buttons to switch their light on or off. But if an unknown device has unintentionally been connected, this could be undesirable. So by default darktable waits until a \u0026ldquo;note\u0026rdquo; message is received from a MIDI button before sending any \u0026ldquo;note\u0026rdquo; light on/off messages back for that (and any lower numbered) button. That way no more buttons are addressed than exist on the device. If you immediately want all button lights to be used (rather than having to press the highest note once for each session) you can specify the number of buttons in the \u0026ldquo;order or exclude MIDI devices\u0026rdquo; preference, for example, \u0026ldquo;BeatStep:63:16\u0026rdquo;.\n🔗supported devices The shortcut mapping system has been most extensively tested with the Behringer devices and contains custom code to deal with their specific features. All other devices are treated as \u0026ldquo;generic midi\u0026rdquo; and may or may not work (well). If you succeed in getting a MIDI device up and running that hasn\u0026rsquo;t been mentioned below, it would be greatly appreciated if you would provide feedback in order to assist others, if any special steps are required. You could do this either by submitting a documentation pull request to amend this page or by filing an issue containing the necessary information.\n🔗Behringer X-touch Mini / Compact These devices should be in Standard Mode (not MC). Layers A \u0026amp; B are somewhat supported, however, since the device does not send a notification when switching between layers, and since lights (both under buttons and the pattern used around the rotors) are set based on which layer darktable believes is active, everything will only be updated completely after you press or turn something in the \u0026ldquo;new\u0026rdquo; layer. Default settings are assumed; if any have been changed they can be restored using this X-Touch Editor\n🔗Behringer BCR2000 / BCF2000 These machines are highly configurable so there are many settings that could complicate the interaction with darktable\u0026rsquo;s MIDI module. The BC Manager tool (available for Windows and MacOS) can be used to configure them. The easiest thing to do is to reset all encoders and buttons to their simplest settings, which can be done (for the BCR2000) using this file. You can send it to the machine with BC Manager or (under Linux) with amidi. There\u0026rsquo;s also a global setting called \u0026ldquo;Deadtime\u0026rdquo; that determines how long the BCR ignores arriving messages after sending out updates. This is to avoid feedback loops, but for darktable it means that it blocks the adjustments sent back immediately after each rotor move. So Deadtime needs to be set to 0.\n🔗Arturia Beatstep Individual rotors can be configured to send absolute (0-127) values or changes (+/- 1,2,3,\u0026hellip; in different encodings). The recommended setting is Relative #1 for all knobs with Knob Acceleration set to Slow (Off) or Medium. Then put the string BeatStep:63:16 in preferences \u0026gt; miscellaneous \u0026gt; interface \u0026gt; order or exclude midi devices. This can be configured with Midi Control Center, available for Windows or MacOS.\n🔗Loupedeck / Loupedeck+ Put the string Loupedeck:127 in \u0026ldquo;preferences \u0026gt; miscellaneous \u0026gt; interface \u0026gt; order or exclude midi devices\u0026rdquo;.\n@jenshannoschwalm has provided a layout that can be imported in the shortcuts dialog/tab. It can be found, with documentation, here https://github.com/darktable-org/darktable/pull/12829#issuecomment-1320264833\n🔗Korg nanoKONTROL2 The device should be configured first using the Korg Kontrol Editor application to be in the CC mode and every button should be set to the Note type and Momentary button behavior. To control the lights in the buttons the LED mode should be set to External. It is important to note that the Track and the Marker buttons do not have leds in them.\nThere is a Kontrol Editor profile available here, which can be loaded using the Windows application to directly configure all these settings to correctly work with darktable.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/midi-device-support/","tags":null,"title":"midi device support"},{"categories":null,"content":"It is possible to send a lua command to darktable via its DBus interface. The method org.darktable.service.Remote.Lua takes a single string parameter which is interpreted as a lua command. The command will be executed in the current lua context and should return either nil or a string. The result will be passed back as the result of the DBus method.\nIf the Lua call results in an error, the DBus method call will return an error org.darktable.Error.LuaError with the lua error message as the message attached to the DBus error.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/calling-from-dbus/","tags":null,"title":"calling lua from dbus"},{"categories":null,"content":"This page defines the style guide for dtdocs and information about how to contribute to the project.\nIt is included in the user manual so that you can see how the page is rendered as well as how it is written. Please go to GitHub to see the source for this page.\nThe manual structure and content have been carefully considered based on the following criteria:\nThe manual should be comprehensive \u0026ndash; it should describe all of the functionality available in darktable It should have a consistent and logical structure and every piece of functionality should have its own logical place within that structure It should be as long as necessary but as short as possible \u0026ndash; brevity is a must It should be objective Functionality should be explained once and only once (with the exception of the basic workflow guidelines in the overview section) Images should be included only where necessary to improve understanding of key principles and should not contain text unless it is unavoidable We are generally not interested in:\nRestructuring the manual Switching markup languages Detailed workflow tutorials (though we are interested in publishing those on the blogs of either darktable.org or pixls.us) We are interested in\nSpelling and grammar corrections Clarification of text Documentation for new features We are always extremely interested in hearing about which sections of the manual did not make sense to you and why, so that we can improve the documentation.\nIn general, if you wish to make a major change, please open an issue and discuss it with the maintainers first. This is to avoid doing work that wouldn\u0026rsquo;t be accepted.\n🔗format This website is authored in pure markdown, using some extensions. It is initially designed to work with the Hugo SSG but intended to be portable enough that it can be easily rendered with another application if required.\nFiles should be rendered in UTF-8 and should not include any column wrapping.\n🔗structure The following shows the structure of an example main chapter with subsections in the dtdocs website.\nexample-chapter/ _index.md section1-with-subsections/ subsection1/ image.png _index.md subsection1.md subsection2.md section2.md section3.md A couple of notes on the above structure:\n_index.md files do not contain any content (they contain metadata only) and are used to render section headers and ToC entries. In the above example example-chapter/_index.md defines the title of the example chapter and the order in which it appears in the main table of contents. Similarly example-chapter/section1-with-subsections/_index.md defines metadata for the first section of the chapter. Media files should be contained in a directory with the same name as the page to which they relate. In this example, example-chapter/section1-with-subsections/subsection1 contains media related to the subsection1.md page. 🔗metadata Metadata for the markdown files is presented at the head of the page using yaml. Any metadata may be defined \u0026ndash; the module reference sections contain quite a lot of specific metadata \u0026ndash; however the following defines some minimal metadata for the example page example-chapter/section1-with-subsections/subsection1.md.\n--- title: Sub Section 1 Title id: subsection1 weight: 10 --- title This should contain the rendered title of your page. To include a colon within a title, enclose the title in double-quotes. id This is the id used to identify the page by Hugo. It should usually be the same name as the file (for content files) or the parent directory (for _index.md files). weight This is an optional metadata field used to define the order in which sections are presented in the Table of Contents. If the weight field is not included, pages will be rendered in alphabetic order by default. For example, to define the sections and subsections of the above example in reverse order, the following metadata would need to be set: example-chapter/ section1-with-subsections/ _index.md # weight: 30 (place section1 page at the end of example-chapter) subsection1.md # weight: 20 (place subsection1 page at the end of section1) subsection2.md # weight: 10 (place subsection2 page at the start of section1) section2.md # weight: 20 (place section2 in the middle of example-chapter) section3.md # weight: 10 (place section3 at the start of example-chapter) 🔗content 🔗general style guidance All content should be authored in plain markdown without shortcodes and HTML should be kept to an absolute minimum, if used at all Minimalism is an absolute must. Fewer words are preferred Markdown files should be as short as possible Follow the naming and capitalization norms present in the GUI of the application \u0026ndash; namely all headers and titles are in lower case, except for the very top-level chapter names. Similarly, use all lower case when referencing module names and controls. Headers in a file should not exceed level three (###) The primary authoring language is English. Avoid idiomatic language where possible as the English version of the documentation may be read by people for whom English is not their native language Assume the reader has the application open while reading the user manual and only include images where they contribute to the explanation of complex functionality Use image callouts if you need to annotate an image (i.e. mark parts of the image with a letter or number and then explain the meaning in some text following the image). Do not place words directly into the image for annotations, as this makes localization difficult. See this page for an example. Changes to the content should be proposed via pull request or a similar mechanism Your submissions will be copy-edited \u0026ndash; don\u0026rsquo;t take it personally 🔗keyboard and mouse shortcuts Reference named keyboard keys using CamelCase (Ctrl, Shift, Alt, Esc, AltGr, CapsLock, PageUp, PageDown) Reference single letter keys in lower case (this avoids confusion between for example, Ctrl+H and Ctrl+Shift+h). Quotation marks might help with clarification (press \u0026ldquo;h\u0026rdquo; to see a list of active shortcuts) Reference mouse actions using lower case, with multiple words joined by a hyphen (scroll, click, single-click, double-click, right-click) Connect combinations of keys/actions with a plus sign (Ctrl+Shift+h, Shift+double-click) 🔗definition lists The standard method of presenting information about darktable module controls is with the use of definition lists.\ngui control name A declaration of what the control does. For example \u0026ldquo;Set the exposure in EV units\u0026rdquo;. You can include as many paragraphs as you like, but try to limit to 2 or 3 where possible.\na control accessed through a button with an icon When a control is activated using an icon, take a screenshot of the icon using the standard darktable theme (darktable-elegant-grey) and add it before the name of the control gui combobox name Comboboxes often have multiple options that all need to be displayed with separate definitions. Use bulleted lists with italics for the combobox values. the first value: What the first value means the second value: What the second value means Definition lists are also used throughout the document, wherever a named piece of functionality needs to be defined. See, for example, darktable-cli.\n🔗notes If you wish to present an important note to the user, use the following format:\nNote: This is an important note.\n🔗fixed-width fonts and code blocks Fixed width fonts (using the ` character) should normally only be used for code blocks and when referencing file names and command line parameters.\n🔗links Internal links must be relative to the current file and must point to a valid markdown (.md) file. Start links with either ./ to represent the current directory or ../ to represent the parent directory.\nLinks to a processing module should be in italics, e.g. exposure Links to a utility module should be in plaintext, e.g. history stack Link to a top level section by referencing the _index.md file, e.g. module reference Link to a tab in the preferences dialog: preferences \u0026gt; general Link to a specific preference setting: preferences \u0026gt; general \u0026gt; interface language Each header within a page can be linked to directly with an anchor link: contributing/notes 🔗images When taking screenshots from the darktable application itself, use the default darktable theme (darktable-elegant-grey).\nSeveral filename suffixes can be used to control how an image is rendered.\nicon To insert an image as an icon, include #icon after the image name in the link. The markdown ![squirrel icon](./contributing/contributing.png#icon) outputs the following: image width You can set the image width to 25, 33, 50, 66, 75 or 100 per cent of the rendered page width by including #wxx after the image name in the link, where xx is the desired width. For example: ![squirrel](./contributing/squirrel.png#w25) outputs ![squirrel](./contributing/squirrel.png#w75) outputs inline With the exception of icons, images are included as block elements by default. You can override this by including #inline after the image name. This can be combined with the width setting as follows. ![squirrel](./contributing/squirrel.png#w25#inline) outputs default By default images are presented as block elements with 100% width. So ![squirrel](./contributing/squirrel.png#w100) and ![squirrel](./contributing/squirrel.png) are equivalent and both output the following: ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/contributing/","tags":null,"title":"contributing to dtdocs"},{"categories":null,"content":"The scheduling of OpenCL devices can be optimized on most systems using the “OpenCL scheduling profile” settings. However, if your system is equipped with more than one GPU, you might want to set the relative device priority manually. To do this you need to select the “default” scheduling profile and change the settings in the “opencl_device_priority” configuration parameter.\nIt is important to understand how darktable uses OpenCL devices. Each processing sequence of an image \u0026ndash; to convert an input to the final output using a history stack \u0026ndash; is run in a pixelpipe. There are five different types of pixelpipe in darktable. One type is responsible for processing the center image view (or full view) in darkroom mode, another pixelpipe processes the preview image (navigation window, also required for histograms and more internal stuff relevant for correct output of the full view). Another preview pixelpipe would be required for showing a second darkroom window. There can be one of each of these three pixelpipes running at any time, with the full and preview pixelpipes running in parallel. In addition there can be multiple parallel pixelpipes performing file exports as well as multiple parallel pixelpipes generating thumbnails. If an OpenCL device is available, darktable dynamically allocates it to one specific pixelpipe for one run and releases it afterwards.\nThe computational demand varies significantly depending on the type of pixelpipe being executed. The preview image and thumbnails are low resolution and can be processed quickly, whereas processing the center image view or the second window is more demanding. A full export pixelpipe is more demanding still.\nThe configuration parameter “opencl_device_priority” holds a string with the following structure:\na,b,c.../d,e,f.../g,h,i.../j,k,l...,m,n,o...\nEach letter represents one specific OpenCL device. There are five fields in the parameter string separated by a slash, each representing one type of pixelpipe. a,b,c... defines the devices that are allowed to process the center image (full) pixelpipe. Likewise devices d,e,f... can process the preview pixelpipe, devices g,h,i... the export pixelpipes, devices j,k,l... the thumbnail pixelpipes and finally devices m,n,o... preview pixelpipe for the second window. An empty field means that no OpenCL device may serve this type of pixelpipe.\ndarktable has an internal numbering system, whereby the first available OpenCL device receives the number 0. All further devices are numbered consecutively. This number, together with the device name, is displayed when you start darktable with darktable -d opencl. You can specify a device either by number or by its canonical name (upper/lower case and whitespace do not matter). If you have more than one device with the same name you need to use the device numbers in order to differentiate them.\nA device specifier can be prefixed with an exclamation mark !, in which case the device is excluded from processing a given pixelpipe. You can also use an asterisk * as a wildcard, representing all devices not previously explicitly mentioned in that group.\nSequence order within a group matters \u0026ndash; darktable will read the list from left to right and whenever it tries to allocate an OpenCL device to a pixelpipe it will scan the devices in that order, taking the first free device it finds.\nIf a pixelpipe process is about to be started and all GPUs in the corresponding group are busy, darktable automatically processes the image on the CPU by default. You can enforce GPU processing by prefixing the list of allowed GPUs with a plus sign +. In this case darktable will not use the CPU but rather suspend processing until the next permitted OpenCL device is available.\ndarktable\u0026rsquo;s default setting for “opencl_device_priority” is */!0,*/*/*/!0,*.\nAny detected OpenCL device is permitted to process the center view image. The first OpenCL device (0) is not permitted to process both preview pixelpipes. As a consequence, if there is only one GPU available on your system, the preview pixelpipes will always be processed on the CPU, keeping your single GPU exclusively for the more demanding center image view. This is a reasonable setting for most systems. No such restrictions apply to export and thumbnail pixelpipes.\nThe default is a good choice if you have only one device. If you have several devices it forms a reasonable starting point. However, as your devices might have quite different levels of processing power, it makes sense to invest some time optimizing your priority list.\nHere is an example. Let\u0026rsquo;s assume we have a system with two devices, a fast Nvidia Quadro RTX 4000 and a slower GeForce GTX 1050. darktable (started with darktable -d opencl) will report the following devices:\n[opencl_init] successfully initialized. [opencl_init] here are the internal numbers and names of OpenCL devices available to darktable: [opencl_init] 0 \u0026#39;NVIDIA GeForce GTX 1050\u0026#39; [opencl_init] 1 \u0026#39;NVIDIA CUDA Quadro RTX 4000\u0026#39; [opencl_init] FINALLY: opencl is AVAILABLE on this system. with the canonical names shown above as nvidiagforcegtx1050 and nvidiacudaquadrortx4000\nHere, the GeForce GTX 1050 is detected as the first device and the Quadro RTX 4000 as the second. This order will normally not change unless the hardware or driver configuration is modified, but it\u0026rsquo;s better to use device names rather than numbers to be on the safe side.\nAs the GTX 1050 is slower than the RTX 4000, an optimized \u0026ldquo;opencl_device_priority\u0026rdquo; could look like:\n!nvidiagforcegtx1050,*/!nvidiacudaquadrortx4000,*/nvidiacudaquadrortx4000,*/nvidiacudaquadrortx4000,*/!nvidiacudaquadrortx4000.\nThe GTX 1050 is explicitly excluded from processing the center image pixelpipe; this is reserved to “all” other devices (i.e. the RTX 4000). Conversely \u0026ndash; for the preview pixelpipes \u0026ndash; the RTX 4000, so that only the GTX 1050 is permitted to do the work.\nFor file export and thumbnail generation we want all hands on deck. However, darktable should first check whether the RTX 4000 device is free, because it\u0026rsquo;s faster. If it is not free, then all other devices \u0026ndash; in fact only the GTX 1050 \u0026ndash; are checked.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/multiple-devices/","tags":null,"title":"multiple devices"},{"categories":null,"content":"As has been mentioned, OpenCL systems come with a huge variety of setups: different GPU manufacturers and models, varying amounts of GPU memory, different drivers, different distributions etc..\nMany of the potential problems will only appear with very specific combinations of these factors. As the darktable developers only have access to a small fraction of these variations, please understand that we might not be able to fix your specific problem. There is not much we can do if we are unable to reproduce your issue.\nIf you are having issues with a specific device (and you have other OpenCL devices available) the first thing to do would be to try disabling just that device \u0026ndash; see memory \u0026amp; performance tuning for more information.\nIf nothing else helps, the best option is probably to start darktable with\ndarktable --disable-opencl\nIn the end there is nothing in darktable that only runs on GPU. Don\u0026rsquo;t let the lack of OpenCL discourage you \u0026ndash; darktable\u0026rsquo;s CPU code is also highly optimized for performance!\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/opencl/still-doesnt-work/","tags":null,"title":"OpenCL still does not run for me"},{"categories":null,"content":"The following options are related to darktable\u0026rsquo;s library database and XMP sidecar files.\n🔗database create database snapshot Specifies how often darktable should create database snapshots. Options are \u0026ldquo;never\u0026rdquo;, \u0026ldquo;once a month\u0026rdquo;, \u0026ldquo;once a week\u0026rdquo;, \u0026ldquo;once a day\u0026rdquo; and \u0026ldquo;on close\u0026rdquo; (default \u0026ldquo;once a week\u0026rdquo;) how many snapshots to keep Number of snapshots to keep after creating a new snapshot, not counting database backups taken when moving between darktable versions. Enter \u0026ldquo;-1\u0026rdquo; to store an unlimited number of snapshots. (default 10) 🔗XMP sidecar files create XMP files XMP sidecar files provide a redundant method of saving the changes that you have made to an image, in addition to the changes saved to darktable\u0026rsquo;s database. This option allows you to choose when files will first be written. Once written, they will subsequently be updated each time you edit or add a tag to the image. Choose from: never: Don\u0026rsquo;t write sidecar files. This can be useful if you are running multiple version of darktable for development/testing purposes but is not normally recommended, on import: A sidecar file will be written as soon as you add an image to darktable\u0026rsquo;s library, after edit: A sidecar will not be written until the first time you edit or add a tag to an image. It\u0026rsquo;s strongly recommended that you choose either \u0026ldquo;on import\u0026rdquo; or \u0026ldquo;after edit\u0026rdquo;. Sidecar files provide a useful fail-safe to prevent data loss if your database becomes corrupted. Backing up your raw file plus the accompanying sidecar file will allow you to fully restore your work at a later date by re-importing your edit history back into darktable (default \u0026ldquo;on import\u0026rdquo;).\nstore XMP tags in compressed format Entries in XMP tags can get rather large and may exceed the available space to store the history stack in some output files on export. This option allows binary XMP tags to be compressed in order to save space. Available options are “never”, “always”, and “only large entries” (default). auto-save interval This preference sets the interval (in seconds) after which the processing history for an image will be automatically saved (while in the darkroom view). Set to zero to disable auto-saving. Note that this option might be ignored for slow drives (default 10s). look for updated XMP files on startup Scan all XMP files on startup and check if any have been updated in the meantime by some other software. If updated XMP files are found, a menu is opened for the user to choose which of the XMP files to reload (replacing darktable\u0026rsquo;s database entries by the XMP file contents) and which of the XMP to overwrite from darktable\u0026rsquo;s database. Activating this option also causes darktable to check for text sidecar files that have been added after import time (default off). ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/storage/","tags":null,"title":"storage"},{"categories":null,"content":"Translation of the darktable documentation is done via our Weblate instance.\nYou can either use Weblate\u0026rsquo;s web UI to translate the documentation or download the translation from Weblate to your computer, edit it, and then upload the changes.\nPlease do all translation work through Weblate. We will not accept pull requests directly on github to update PO files.\n🔗Making a new branch in git Make a new branch to work on it in git. For example: git checkout -b fr-translation-init 🔗Adding a new language to Hugo In the files config.yaml and config-pdf.yaml, locate the languages: line.\nAdd the language you wish to translate. For example, the English looks like this:\nen-us: title: darktable 3.4 user manual weight: 1 Save the files.\n🔗Generating a PO file Do the following steps if you want to update the POT and PO files from the markdown source.\nCreate an empty PO file for your language in the po folder with the file name content.\u0026lt;language\u0026gt;.po. For example: touch po/content.fr-fr.po Run the script to populate the PO file: cd tools/ \u0026amp;\u0026amp; ./generate-translations.sh --no-translations 🔗Generating translated files Do the following steps to generate the website files from a translation.\nGenerate the translated files: cd tools/ \u0026amp;\u0026amp; ./generate-translations.sh --no-update. Check the translation by starting hugo\u0026rsquo;s internal server: hugo server Open a web browser and check the changes. The URL is in the output of the hugo server command. Remove the translated files, as we never check them into git: cd tools/ \u0026amp;\u0026amp; ./generate-translations.sh --rm-translations. 🔗Translating website, epub, and PDF strings There are two themes for the darktable documentation: one for the HTML website and one for the PDF. You\u0026rsquo;ll need to translate the strings for both.\nGo to themes/hugo-darktable-docs-themes/i18n. Copy content of the file en.yaml and name the new file \u0026lt;your language\u0026gt;.yaml. Translate the content of the new yaml file. Check the translated PO file into git, push it to github, and open a pull request to have your changes accepted. Repeat the last four steps for the other themes, themes/hugo-darktable-docs-epub-theme and themes/hugo-darktable-docs-pdf-theme. 🔗Integrating new translations from Weblate The following assumes that you\u0026rsquo;re git working directory is clean, that you have API access to the Weblate instance, that you\u0026rsquo;ve configured the Weblate git repo as a remote in your local dtdocs git repo, and that wlc, the Weblate command line client, is configured.\nCommit any changes in Weblate: wlc commit darktable/dtdocs Lock the Weblate project to prevent further changes: wlc lock darktable/dtdocs In your local dtdocs git repo, create a new branch: git checkout -b po-updates Update the Weblate remote: git remote update weblate Merge the Weblate changes into your locally created branch: git merge weblate/master Squash all the Weblate commits, since there are so many: git reset $(git merge-base master $(git rev-parse --abbrev-ref HEAD)) Stage the changed PO files: git add -A Commit the PO files: git commit -m \u0026quot;Updated with the PO files from weblate.\u0026quot; Update the POT and PO files: cd tools/ \u0026amp;\u0026amp; ./generate-translations.sh --no-translations \u0026amp;\u0026amp; cd .. Stage the POT and PO files: git add -A Commit the POT andPO files: git commit -m \u0026quot;Updated POT and PO files.\u0026quot; Create a Pull Request in Github. After the Pull Request is accepted, reset the Weblate repo to match the dtdocs repo: wlc reset darktable/dtdocs ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/special-topics/translating/","tags":null,"title":"translating dtdocs"},{"categories":null,"content":"Warning: This feature is very experimental. It is known that several elements don\u0026rsquo;t yet work in library mode. Careful testing is highly recommended.\nThe lua interface allows you to use darktable from any lua script. This will load darktable as a library and provide you with most of the lua API (darktable is configured headless, so the functions relating to the user interface are not available).\nAs an example, the following program will print the list of all images in your library:\n#!/usr/bin/env lua package = require \u0026#34;package\u0026#34; package.cpath=package.cpath..\u0026#34;;./lib/darktable/lib?.so\u0026#34; dt = require(\u0026#34;darktable\u0026#34;)( \u0026#34;--library\u0026#34;, \u0026#34;./library.db\u0026#34;, \u0026#34;--datadir\u0026#34;, \u0026#34;./share/darktable\u0026#34;, \u0026#34;--moduledir\u0026#34;, \u0026#34;./lib/darktable\u0026#34;, \u0026#34;--configdir\u0026#34;, \u0026#34;./configdir\u0026#34;, \u0026#34;--cachedir\u0026#34;,\u0026#34;cachedir\u0026#34;, \u0026#34;--g-fatal-warnings\u0026#34;) require(\u0026#34;darktable.debug\u0026#34;) for k,v in ipairs(dt.database) do print(tostring(v)) end Note the third line that points to the location of the libdarktable.so file.\nAlso note that the call to require returns a function that can be called only once and allows you to set darktable\u0026rsquo;s command line parameter. The :memory: parameter to --library is useful here if you don\u0026rsquo;t want to work on your personal library.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/darktable-from-lua/","tags":null,"title":"using darktable from a lua script"},{"categories":null,"content":"Batch-editing is the process of developing images in a semantically-related series that are expected to have a consistent final look, often with the intent of publishing the images in catalogues, magazines or books. It can be a tedious, frustrating and unexciting task, so darktable includes functionality to help make it faster and more reliable.\n🔗preparation 🔗shooting color checkers Shooting a color checker on-location can save a tremendous amount of time during batch post-processing of a series of images. The image of the color checker can be quickly used as a color reference in the post-processing workflow to neutralize any color cast \u0026ndash; Datacolor and X-Rite color checkers (24 and 48) are natively supported.\n🔗prefer consistent lighting conditions If possible, use controlled artificial lighting to maintain consistent lighting over the series of images. This means that you won\u0026rsquo;t have to worry about light color temperature and intensity changes between images. Shoot a new image of the same color checker every time your lighting conditions change.\n🔗prefer manual mode If possible, shooting in manual mode with constant exposure settings will help to remove some variability in the series. In terms of post-processing, any variation means that individual adjustments will be needed on each image, which will hinder your productivity.\n🔗post-processing 🔗concepts The post-processing needs to be split in 2 fully separated parts:\nprimary color-grading, secondary color-grading. Primary color-grading is performed first in the pixel pipeline and in the editing workflow, with modules such as exposure, input color profile and color calibration. Its purpose is to normalize each image to the same neutral ground-truth, in terms of overall brightness, color accuracy and white balance. This stage aims at making all images look similarly boring by removing any color cast and ensuring a perfectly neutral white, and is particularly important if your series uses different cameras. Primary color-grading is not about artistic intent or expression, but simply about preparing a sane and consistent basis for the next stage.\nSecondary color-grading happens next in the pixel pipeline and in the editing workflow. This is where all the artistic expression happens, with modules such as color balance rgb. If and only if the primary color-grading was successful at perfectly neutralizing all images to the same ground-truth, copying and pasting the secondary color-grading steps between images should have exactly the same visual effect on each image, no matter if the images were shot with a different camera or under slightly different lighting conditions.\nIn a nutshell, the whole purpose of the primary color-grading is to ensure the repeatability of the secondary color-grading between images. For example, if a non-neutral white balance is expected in the series, it is much easier to re-introduce non-neutrality in color balance rgb (using the same color shift) on fully-neutralized images, than to fine-tune the primary color-grading individually on each image, especially if several different cameras were used.\n🔗method 🔗profiling the series You will first need to extract a color calibration profile from the image(s) of your color checker. This profile can then be applied to all images shot under the same lighting conditions with the same camera by copying and pasting the development history stack in the lighttable view. This step needs to be repeated for each camera and lighting setup.\nNote: this process only works with the modern chromatic adaptation workflow, which assumes hard-setting the white balance to a D65 (camera reference) illuminant. See the documentation in the color calibration module for more information.\n🔗editing the reference image Choose a reference image that was taken in the lighting conditions closest to those of the color checker image that served as your profiling reference. Your primary color-grading should already be handled by the profile used in the color calibration module (in conjunction with the input color profile module). What remains to complete this stage is to adjust the exposure setting to match the overall brightness that you expect.\nNext, proceed with the filmic rgb white and black relative exposures, as well as the contrast setting. Finish with the secondary color-grading.\nWhen this is done, you can measure the brightness and chromaticity of a control sample, preferably located on a non-moving surface that is consistently lit across your series (and appearing in all the frames). These measurements are taken using the area exposure mapping and color calibration area mapping tools. They will be memorized and will serve as a target for individual images as needed.\n🔗propagating the look You can then propagate your secondary color-grading (including filmic rgb) to all the other images of the series, no matter whether or not they were shot in the same lighting conditions, since you should already have propagated your primary color-grading (calibration profile) to the relevant images. Don\u0026rsquo;t forget to paste the history using append mode or you will overwrite your primary color-grading as well.\nHowever, this alone will not ensure a consistent look for the whole series.\n🔗fine-tune individual settings If there was some variability in your lighting conditions, each image will need some further fine-tuning adjustments. Fortunately, if you have applied the proposed method so far, this should be relatively straightforward.\nFirst, homogenize the exposure using your control sample and the area exposure mapping tool.\nThen, adjust the filmic rgb white relative exposure if needed, preferably using the picker. The contrast should not require any adjustment since it does not depend on the dynamic-range of the image.\nFinally, homogenize the chromatic adaptation, using your control sample and the color calibration area mapping tool.\nThis should get you close enough in most cases. However, if the background has changed, it is possible that these fine adjustments (aimed towards technically normalizing the primary color-grading on an individual basis) are not sufficient to give a perceptually-even look. In this case, you will need an extra step of secondary color-grading, which you are advised to perform on top of the previous one (shared with the other images of the series), in new instances of the relevant modules located later in the pipe. This ensures that the base secondary color-grading stays constant for all images and makes for a better workflow. You are not advised to make large changes in the primary color-grading to manage perceptual discrepancies involving contrast with the background.\n🔗controlling your series The culling mode in the lighttable view will help you to compare images side-by-side when the work is done. To view your reference edit in the darkroom view, you may display the filmstrip and increase its height, or use a snapshot of the reference overlaid on the current image (which will not necessarily have the same size).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/guides-tutorials/batch-editing/","tags":null,"title":"batch-editing images"},{"categories":null,"content":"darktable\u0026rsquo;s Lua API is documented in its own manual with a detailed description of all data structures and functions. You can download the API manual from here.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/lua/api/","tags":null,"title":"lua API"},{"categories":null,"content":"🔗interface load default shortcuts at startup When launching the application, darktable loads default shortcuts first, and then loads user-defined shortcuts on top. This allows default shortcuts to be overridden with a new action but prevents them from being deleted (since the deleted shortcut will be automatically reloaded on the next restart). Deactivate this preference to stop loading default shortcuts on startup \u0026ndash; only load the user-defined ones (including any defaults that you have not subsequently deleted or overridden). This makes deletion easier but also means that you will not benefit from new shortcuts added in future versions without first re-enabling this preference (default on). scale slider step with min/max When activated, the default step-size, when altering sliders, will depend on the current min/max values for that slider (default on). sort built-in presets first Choose how the presets menu is sorted. If this option is enabled, built-in presets are shown first. If the option is disabled, user presets are shown first (default on). mouse wheel scrolls modules side panel by default When enabled, the mouse wheel scrolls side panels by default and Ctrl+Alt+wheel scrolls data entry fields. When disabled, this behavior is reversed (default off). always show panels\u0026rsquo; scrollbars Defines whether the panel scrollbars should be always visible or activated only depending on the panel content (default on). (needs a restart) duration of the ui transitions in ms Defines how long modules and other ui elements will take to transition between states (expand/collapse). Set to 0 to disable animation (default 250ms). position of the scopes module Choose whether to show the scopes module in the left or right panel (default right). (needs a restart) method to use for getting the display profile This option allows the user to force darktable to use a specific method to obtain the current display profile for color management. In the default setting “all”, darktable will choose to query the X display server\u0026rsquo;s xatom or the colord system service. You can set this option to “xatom” or “colord” to enforce a specific method if the two methods give different results. You can run the darktable-cmstest binary to examine your color management subsystem. order or exclude midi devices Semicolon-separated list of device-name fragments. If matched, load the midi device at the id given by the location in the list. If preceded by \u0026ldquo;-\u0026rdquo;, prevent the matched device from loading. You can also add encoding and number of knobs. For example \u0026ldquo;BeatStep:63:16\u0026rdquo;. Please see midi device support for more information. 🔗tags omit hierarchy in simple tag lists When exporting images any hierarchical tags are also added as a simple list of non-hierarchical tags to make them visible to some other programs. When this option is checked darktable will only include the last part of the hierarchy and ignore the rest. So foo|bar|baz will only add baz. 🔗shortcuts with multiple instances It is possible to create multiple instances of many processing modules. In this scenario it is not always obvious which instance should be controlled by keyboard shortcut operations. The following options control rules that are applied (in order) to decide which module instance keyboard shortcuts should be applied to.\nThese rules are also used when clicking and dragging on the scopes module to change exposure.\nprefer focused instance If an instance has focus, apply the shortcut to that instance and ignore any other rules. Note that this option does not impact blending shortcuts, which are always applied to the focused instance (default on). prefer expanded instances If instances of the module are expanded, ignore collapsed instances (default off). prefer enabled instances After applying the above rule, if remaining instances of the module are active, ignore inactive instances (default off). prefer unmasked instances After applying the above rules, if remaining instances of the module are unmasked, ignore masked instances (default off). selection order After applying the above rules, apply the shortcut to the first or last instance remaining (default \u0026ldquo;last instance\u0026rdquo;). 🔗map / geolocalization view pretty print the image location Show a more readable representation of the geo-location in the image information module (default on). 🔗slideshow view waiting time before each picture in slideshow The number of seconds before displaying the next image (default 5) in the slideshow view. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/miscellaneous/","tags":null,"title":"miscellaneous"},{"categories":null,"content":"For help and support with using darktable you are encouraged to ask questions on the main discussion forums at discuss.pixls.us.\nThe official places to obtain information concerning darktable are the following:\ndarktable.org GitHub wiki The following articles provide some useful background information about darktable\u0026rsquo;s scene-referred workflow:\ndarktable 3.0 for dummies in 3 modules darktable 3.0 for dummies \u0026ndash; hardcore edition darktable 3.0: RGB or Lab? Which modules? Help! darktable\u0026rsquo;s filmic FAQ Introducing color calibration module The following resources can provide a deeper understanding of the functionality of some specific processing modules:\nImage processing and the pixel pipeline in darktable 3.0 Filmic RGB v3: remapping any dynamic range in darktable 3.0 Filmic RGB v4: highlights reconstruction in darktable 3.2 Dodging and burning with tone equalizer in darktable 3.0 Noise reduction (profiled) with non-local means in darktable 3.0 Noise reduction (profiled) with wavelets in darktable 3.0 Contrast equalizer modules in darktable Some other YouTube channels with recent content on using darktable are:\nBruce Williams Photography Boris Hajdukovic ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/guides-tutorials/other-resources/","tags":null,"title":"other resources"},{"categories":null,"content":"You can perform almost any action in darktable with a keyboard/mouse shortcut. You can also use various other input devices, including MIDI devices and game controllers \u0026ndash; see the midi device support section for details. These are referred to as external devices or just devices in this guide.\n🔗defining shortcuts A shortcut is a combination of key or button presses and/or mouse or device movements that performs an action in darktable.\nThe recommended way to assign shortcuts to visual elements is the visual shortcut mapping mode.\nA single action may have multiple shortcuts but a single shortcut can only be linked to one action in a given darktable view \u0026ndash; you can\u0026rsquo;t chain actions together except by applying a preset or style. You can, however, set up a single shortcut that does one thing in the lighttable view, say, and another in the darkroom view.\n🔗initiating a shortcut A shortcut must be initiated by either\npressing a key on the keyboard; or pressing a button or moving a knob/joystick on an external device You cannot initiate a shortcut by moving your mouse, or by pressing the left, right or middle mouse buttons, as these actions are used to interact with darktable\u0026rsquo;s UI.\n🔗simple shortcuts A shortcut that only includes button and/or key presses (and not mouse/device movements) is referred to as a simple shortcut.\nA simple shortcut must be initiated as above, but can include:\nOne or more modifier keys (Shift, Ctrl, Alt), held down while executing the remainder of the shortcut Up to three key presses, the last one of which may be a long-press (defined as a key-press longer than your system\u0026rsquo;s double-click duration) Similarly, up to three device-button presses or mouse-button clicks, the last of which may be long Various combinations of keyboard, mouse, and device buttons can be used to create simple shortcuts.\n🔗creating additional modifiers The only valid modifiers are the Shift, Ctrl and Alt keys on the keyboard. You can define additional keys (or device buttons) as modifiers by assigning keys/buttons to the \u0026ldquo;global/modifier\u0026rdquo; action. However, these will merely function as extra Ctrl, Alt or Shift keys \u0026ndash; you cannot create \u0026ldquo;new\u0026rdquo; modifiers.\n🔗extending simple shortcuts with movement For certain actions you can choose to extend a simple shortcut using mouse/device movement. For example you might hold Ctrl+X while scrolling with your mouse to change the value of a slider. The following can be used to extend a simple shortcut:\nMovement of the mouse scroll wheel Horizontal, vertical or diagonal movement of the mouse cursor Movement of a knob/joystick on an external device To extend a simple shortcut, you must hold the final key/button of the simple shortcut while performing the extending mouse/device movement.\nFor external devices you do not need to start with a simple shortcut \u0026ndash; you can directly assign a control knob or joystick to an action \u0026ndash; though this will significantly reduce the flexibility of such devices.\nLong button and key presses cannot be extended, as the length of the click/press is timed using the release of the final button/key \u0026ndash; such shortcuts must be terminated with the raising of the final button/key.\nNote: You may need to switch off the \u0026ldquo;disable touchpad while typing\u0026rdquo; setting if you want to use extended shortcuts with a laptop touchpad.\n🔗actions Shortcuts are used to initiate actions within darktable.\nAn action is usually (but not always) an operation that you might undertake using darktable\u0026rsquo;s point-and-click user interface. For example:\nIncrease, decrease or reset sliders Scroll through dropdown lists Enable, expand or focus modules Click buttons Switch between views Such point-and-click type actions are normally defined as the application of an effect to an element of a widget, where these terms are defined as follows:\nwidget Each visible part of the user interface is known as a widget. For example the darktable application window is a widget, containing side panel widgets, each of which contains module widgets, each of which contains button, slider and dropdown list widgets etc\u0026hellip; When assigning a shortcut to an action, you must first decide which widget it is to be applied to. element An element is the part of a UI widget that is affected by your shortcut. For example, for a slider that has a picker, you can make a shortcut activate the picker button element or change the value element of the slider. For a row of tabs (the row is a single widget) you can select which tab element to activate or use your mouse scroll wheel to scroll through the tabs. effect A shortcut can sometimes have multiple possible effects on a given element. For example, a button can be activated as if it was pressed with a plain mouse-click or as if it was pressed with Ctrl+click. A slider\u0026rsquo;s value can be edited, increased/decreased or reset. 🔗assigning shortcuts to actions There are two primary methods of assigning a shortcut to an action.\n🔗visual shortcut mapping Click on the icon in the top panel of any darktable view to enter visual shortcut mapping mode. If you hold Ctrl while clicking the button, no confirmation will appear when overwriting an existing shortcut mapping.\nThe mouse cursor will change as you hover over UI widgets, to indicate whether or not a mapping can be created:\nA normal mouse cursor (pointer) appears when you hover over a module header, to indicate that you can click to expand the module, An image of a keyboard with a \u0026ldquo;+\u0026rdquo; sign indicates that, in addition to assigning a shortcut, you can also add the widget to the quick access panel in the darkroom (by Ctrl+clicking on it), An image of a keyboard with a \u0026ldquo;\u0026ndash;\u0026rdquo; sign indicates that the widget is already in the quick access panel (Ctrl+click to remove it), An image of a keyboard without a \u0026ldquo;+\u0026rdquo; or \u0026ldquo;\u0026ndash;\u0026rdquo; indicates that a shortcut can be defined for the widget under the cursor but it cannot be added to or removed from the quick access panel, A circle with a line through it (🚫) indicates that there is no mappable widget under the cursor. Press a key combination while hovering over a mappable widget to assign a shortcut to that widget \u0026ndash; a default action will be assigned to that shortcut based on the type of widget and whether you have keyed a simple or extended shortcut. See below for details of some of the default assigned actions.\nLeft-click on a mappable widget to open the shortcut mapping screen for that widget (see below). Left-click anywhere else on the screen to open the shortcut mapping screen, expanded (where possible) based on the part of the screen you have clicked on. This screen can be used to alter the action assigned to a shortcut and to configure shortcuts for non-visual actions. Entering the shortcut mapping screen exits visual shortcut mapping mode.\nYou can assign as many shortcuts as you like in a single mapping session and then exit mapping mode when you are finished by clicking the icon again or right-clicking anywhere on the screen.\nYou can delete a user-defined shortcut mapping by defining it a second time against the same widget. If you attempt to reallocate an existing shortcut to a new action, you will be notified of the conflict and asked whether you wish to replace the existing shortcut.\nFinally, if you scroll with your mouse wheel while in visual mapping mode (without pressing any other buttons/keys) when hovering over a slider, this will change the default speed for that slider \u0026ndash; scroll up to increase and down to decrease. When you leave mapping mode, normal mouse scrolls over that slider will change its value with the adjusted speed.\n🔗shortcut mapping screen The most flexible way to create shortcuts is by using the shortcut mapping screen, which can be accessed from the global preferences dialog or by left-clicking in visual mapping mode. This screen allows access to all available actions, including some that are not directly linked to a UI widget.\nThe top panel of the shortcut mapping screen shows a list of available UI widgets/actions and the bottom panel shows the shortcuts currently assigned to them. You can search the top and bottom panels using the text entry boxes at the bottom of the screen (use the up/down arrow keys to navigate between matches).\nDouble-click an item in the top panel to create a new shortcut for that item, and then enter your desired shortcut (right-click to cancel). Once you have done this, a new entry will appear in the bottom panel showing the shortcut you have created. You can then manually alter the element, effect, speed or instance of the assigned action against that shortcut in the bottom panel. To delete a user-defined shortcut, select it in the bottom panel and press the Delete key.\nSelecting an existing shortcut in the bottom panel will highlight (in bold) the matching action and its parents in the top panel. You can use this to navigate the top panel and find related actions.\nThe following additional options are provided in the shortcut mapping screen:\nexport\u0026hellip; Export the current shortcut mappings for one or all of your devices (keyboard/mouse, midi, game controller) to an external file. The dialog will show you how many shortcuts exist for each device. import\u0026hellip; Import shortcut mappings from an external file for one or all of your devices. When loading a device, you can chose to assign it a different number. This can for example be used to exchange midi layouts. Before loading, you can chose to wipe the specific device first. When loading all from an empty file, this will effectively delete all your shortcuts. restore\u0026hellip; Restore your shortcut mappings to (a) The mappings shipped with darktable by default, (b) The start of your current session, or (c) The point at which the shortcut mapping screen was last opened. When restoring, you can choose to leave any additional shortcuts that were added after the relevant checkpoint as they are, so that only changed shortcuts are restored to their previous meaning. Or you can choose to first clear all shortcuts and just load the restore point. 🔗deleting default shortcuts When you delete a shortcut that has been created by darktable by default, that shortcut is moved to a separate \u0026ldquo;disabled defaults\u0026rdquo; category, in order to prevent it from being reloaded the next time darktable is launched. To reinstate a deleted shortcut, simply delete the shortcut from that category. You will be prompted if reinstating this shortcut overwrites another one that has been created in the meantime.\nAlternatively, you may disable preferences \u0026gt; miscellaneous \u0026gt; interface \u0026gt; load default shortcuts at startup to prevent default shortcuts from being loaded on startup. While this option is disabled, darktable will only load user-defined shortcuts and any defaults that you have not subsequently deleted or overridden.\n🔗common actions The following is a list of some of the actions to which you can assign shortcuts, organized by widget type. This is not an exhaustive list and you are encouraged to browse the shortcut mapping screen for a complete list of available actions. If you assign a shortcut to a widget, it will be given a default action, depending on the type of widget and on whether you have assigned a simple or extended shortcut.\nNote that it is possible to assign a number of actions that have no effect. For example, all sliders include a button element, regardless of whether such a button is actually present alongside a given slider.\n🔗global Actions in the \u0026ldquo;global\u0026rdquo; section of the shortcut mapping screen can be executed from any darktable view. Most of these actions do not have specific elements as they are used to perform one-off operations.\n🔗views Actions in the \u0026ldquo;views\u0026rdquo; section can only be executed from the specified darktable view. As with global actions, most do not have specific elements as they are used to perform one-off operations.\n🔗buttons A button is a clickable icon in the darktable interface. The default action, when assigning a simple shortcut to a button, is to activate that button as if clicked with the left mouse button. You can modify this action to activate the button as if clicked while holding a modifier key.\n🔗toggles A toggle is a button that has a persistent on/off state. It therefore has additional effects to allow you to toggle it or explicitly set its state. As with a normal button the default action, when assigning a simple shortcut to a toggle, is to activate the toggle as if clicked with the left mouse button (which toggles the button on/off).\n🔗utility modules All utility modules have the following elements:\nshow Acts as a toggle that expands and collapses the module. reset Acts as a button that resets all module parameters when activated. The ctrl-activate action can be used to re-apply any automatic presets for that module. presets Allows you to select actions from the presets menu (e.g. edit, update, previous, next). The default action, when assigning a simple shortcut to a preset element, is to display a list of the available presets for selection. Extended shortcuts are not currently available for preset elements. The default action, when assigning a simple shortcut to a utility module, is to toggle the show element (expand/collapse the module).\nIn addition, shortcuts are available for all of the controls on each module as well as any stored presets (see below).\n🔗processing modules Processing modules have the same elements and defaults as utility modules with the following additional elements:\nenable Acts as a toggle that switches the module on and off. focus Acts as a toggle that focuses or defocuses the module. This is useful for modules such as crop or tone equalizer, whose on-screen controls are only activated when those modules have focus. For crop, changes are saved only when the module loses focus. instance Allows you to select actions from the multiple-instance menu (e.g. move up/down, create new instance). The default action, when assigning a simple shortcut to the instance element, is to display a list of the available options for selection; An extended shortcut will move the preferred module instance (see below) up and down the pixelpipe. If an action affects a processing module that can have multiple instances, you can choose which instance to adjust with a given shortcut. By default, all actions will affect the \u0026ldquo;preferred\u0026rdquo; instance, as defined using the settings in preferences \u0026gt; miscellaneous \u0026gt; shortcuts with multiple instances.\nAdditional options are available in the shortcuts mapping screen to adjust the blend parameters (the \u0026lt;blending\u0026gt; section) and module controls (the \u0026lt;focused\u0026gt; section) for the currently-focused module. The latter section allows you to assign shortcuts to the first, second, third (etc.) button, drop-down, slider and tab on the module. The shortcuts will affect different module controls depending on which module currently has focus (as the available list of controls changes).\nYou can also assign scroll shortcuts to the \u0026lsquo;preset\u0026rsquo; menu, which allows you to use your mouse scroll wheel to scroll through the module\u0026rsquo;s presets.\n🔗dropdowns A dropdown is a multi-selection box and has the following elements available:\nselection Allows values to be selected from the dropdown list in various ways. The default action, when assigning a simple shortcut to a dropdown, is to display a popup edit box with a list of the available values for selection; An extended shortcut (including a mouse movement) will scroll through the available values. button A standard button element that allows the button to the right of the dropdown (if present) to be activated. For example, the aspect dropdown in the crop module has a button that allows the crop controls to be changed from portrait to landscape and vice versa. 🔗sliders A slider allows you to continuously alter an integer or decimal value, and has the following elements available:\nvalue Allows the current value of the slider to be altered. The default action, when assigning a simple shortcut to a slider, is to display a popup edit box so you can enter a value; An extended shortcut (including a mouse movement) will change the value up and down. Value elements are also used for modifying some on-screen graphs. When modifying the value element with a shortcut you may not exceed the bounds set in the visual slider. force This is the same as the value element described above, but it allows you to exceed the bounds set in the visual slider. zoom Allows you to change the upper and lower bounds of the visual slider without altering the current value. button A standard button element that allows the button to the right of the slider (if present) to be activated. For example, a slider may include a picker to visually set its value based on selected elements of the image. You can alter the value of a slider more quickly or slowly than normal by defining the speed of the action in the shortcut mapping screen. By default a value (or force) effect is given a speed of 1.0, which means that it is changed at the default rate defined by the given slider. You can alter the slider more quickly by increasing the speed (a speed of 10 makes the action 10x faster) or more slowly by decreasing it (a speed of 0.1 makes the action 10x slower).\n🔗fallbacks Where a widget can have multiple different actions applied to it, it can be tedious to set up individual shortcuts for each one of those actions. To make this process simpler, if you create a simple shortcut a number of effects can be made available by default as extensions to that shortcut. These are known as fallbacks.\nWhile fallbacks are a powerful way to quickly set up multiple actions using predefined and consistent shortcuts, they will assign a lot of actions automatically (which might not be what you want), and can be hard to understand. Fallbacks are therefore disabled by default and you will need to click on the \u0026ldquo;enable fallbacks\u0026rdquo; check box in the shortcuts setup window to enable them.\nTo take a brief example, you could create a simple shortcut (e.g. Ctrl+R) against a processing module. This will automatically set up the following fallback effects using the defined shortcut, extended with mouse-clicks. In each case (except the first) you should hold the initial shortcut while clicking with your mouse. The final mouse-click will apply the action defined below:\nCtrl+R (no mouse-click) to show/hide the module (the default fallback) Ctrl+R+left-click to enable/disable the module Ctrl+R+left-double-click to reset the module Ctrl+R+right-click to show the module\u0026rsquo;s preset menu Ctrl+R+right-double-click to show the module\u0026rsquo;s multiple instance menu Similar fallbacks are defined for many common UI elements and all can be manually overridden.\nSome fallback actions are defined using modifier keys (usually Ctrl+ and Shift+). In this case you must define an initial shortcut without such a modifier in order to be able to use these fallbacks. For example, if you assign Ctrl+R to an action, you cannot use a Ctrl+ fallback. Some default fallbacks of this type are provided for the value element and for horizontal/vertical movements in the (zoomed) central area \u0026ndash; in this case, Shift+ increases the speed to 10.0 and Ctrl+ decreases the speed to 0.1.\nTo see a list of all of the default fallbacks, click the \u0026ldquo;enable fallbacks\u0026rdquo; checkbox in the shortcut mapping screen and select the \u0026ldquo;fallbacks\u0026rdquo; category in the top panel. To see the fallbacks for a given widget (e.g. a slider) just select that widget in the top panel. In both cases an additional item (also named \u0026ldquo;fallbacks\u0026rdquo;) will then appear in the bottom panel containing full details of the available fallbacks.\nFallbacks are only applied if no other shortcut using that combination has been explicitly created. In the above example, if you were to explicitly assign Ctrl+R+left-click to another action, the \u0026ldquo;enable/disable module\u0026rdquo; fallback would be ignored.\nAs with any other shortcut, fallback settings are fully customizable.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/shortcuts/","tags":null,"title":"shortcuts"},{"categories":null,"content":"This menu provides an overview of the presets that are defined for darktable\u0026rsquo;s modules, and allows you to modify some of their properties.\nPre-defined presets (those that are included by default within darktable) are shown with a lock symbol. Their properties cannot be changed.\nUser-defined presets can be imported from exported .dtpreset files using the \u0026ldquo;import\u0026rdquo; button at the bottom of the screen. You can export all user-defined presets to a single directory using the \u0026ldquo;export\u0026rdquo; button.\nDelete a user-defined preset by selecting it and pressing the Delete key.\nEdit a user-defined preset\u0026rsquo;s properties by selecting it and pressing Enter or double-clicking. This will open a dialog that allows the preset to be edited, exported to an external .dtpreset file or deleted.\nSee the creating and editing presets section for more information about the other properties that can be edited in this dialog.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/presets/","tags":null,"title":"presets"},{"categories":null,"content":" lua scripts installer don\u0026rsquo;t show again Check this box to hide the lua scripts installer in the lighttable if no lua scripts are installed. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/preferences-settings/lua-options/","tags":null,"title":"lua options"},{"categories":null,"content":"Perform actions on images that have been selected in the lighttable view.\n🔗module controls The module controls are spread over two tabs for manipulating the image files and the related metadata.\n🔗images tab remove Remove the selected images from the darktable library without deleting them. Removed images can no longer be viewed or edited within darktable but the image files remain on the filesystem along with any XMP sidecar files. As darktable keeps the XMP files up-to-date with your latest development history, you can fully restore your work later by re-importing the images. delete / delete (trash) Remove the selected images from the darktable library and remove any associated XMP sidecar files from the filesystem. If no duplicates of a removed image remain in the darktable library, the image file itself is also deleted. You can control whether this action irrevocably deletes the files or attempts to put them into your system\u0026rsquo;s trash bin with a configuration item in preferences \u0026gt; security. A second configuration item in the same tab allows you to control whether or not to be prompted before deleting images. move Physically move selected images (the image files plus all associated XMP sidecars) to another folder on the filesystem. If an image with the given filename already exists in the target folder the source image will not be moved. copy Physically copy selected images (the image file plus all associated XMP sidecars) to another folder on the filesystem. If an image with the given filename already exists in the target folder it will not be overwritten – instead a new duplicate will be generated with the same history stack as the source image. create hdr Create a high dynamic range image from the selected images, and add the result to the library as a new image in DNG format. Images need to be properly aligned, which implies that they have been taken on a sturdy tripod. You can also generate HDRs with programs like Luminance HDR, and later import them into darktable for further processing. Note that darktable can only create HDR images from raw files. duplicate Create duplicates of the selected images within darktable. Duplicate images share the same image file, but each duplicate has its own XMP sidecar file and a separate entry in darktable\u0026rsquo;s library database. This allows you to test different edits on the same image. rotation Perform a clockwise or counter-clockwise rotation on the selected images. A third button can be used to reset the image rotation to the value stored in the image\u0026rsquo;s Exif data. This feature is directly linked to the orientation processing module \u0026ndash; adjustments made here are automatically converted into a history stack item for that module. copy locally Create local copies of the selected images on the local drive. These copies will then be used when the original images are not accessible (see local copies). resync local copy Synchronize the XMP sidecar of the local copy of each selected image with the copy in external storage, and remove the local copies. Note that if a local copy has been modified and the external storage is not accessible the local copy will not be deleted (see local copies). group Create a new group from the selected images (see image grouping). ungroup Remove the selected images from their group (see image grouping). 🔗metadata tab metadata type checkboxes Choose the types of metadata (ratings, tags, metadata, colors, geo tags) that you want to operate on. copy Copy the chosen types of metadata from the selected image onto the clipboard. If you have more than one image selected, or no images selected, then this button is unavailable. paste Paste any metadata in the clipboard onto the selected images. clear Clear the chosen types of metadata from the selected images. mode When pasting metadata onto images, this option controls whether the metadata on the clipboard should be merged with the existing metadata (merge), or should replace it entirely (overwrite). refresh exif Refresh the Exif data from the source file. Warning: this may overwrite some tags and metadata that you have altered in darktable (such as star ratings). monochrome Flag the image as monochrome, meaning that it will receive any monochrome-specific workflow treatment that is offered by the processing modules. Refer to the developing monochrome images section for more details. color Remove the monochrome flag from the image so that it will receive the default workflow treatment that is normally used when developing color photos. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/selected-image/","tags":null,"title":"actions on selection"},{"categories":null,"content":"Set up an image capture job.\nThis can include sequence, bracket and delayed captures. You are also able to control other camera settings such as focus mode, aperture, shutter speed, ISO and white balance.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/tethering/camera-settings/","tags":null,"title":"camera settings"},{"categories":null,"content":"Highlight areas of the image that may exhibit luminance or gamut clipping.\nWhen an image is sent to a display device, each pixel is normally represented as a set of 3 numbers, representing the intensity of the red, green and blue primary colors in the output color space. Because the output color space is usually closely related to hardware with physical limations, there is a maximum permitted value for the [R,G,B] channels, representing the maximum available intensity for that color space. Similarly, there is also a minimum value below which pixel values will be mapped to zero. When we try to convert from a larger color space to the final output color space, any values exceeding this maximum will be clamped to the maximum value, and any values below the minimum will be clamped to zero. This process is called \u0026ldquo;clipping\u0026rdquo; and it will lead to lost detail, or \u0026ldquo;incorrect\u0026rdquo; colors for any pixels with clipped channels.\nClick the icon to enable the clipping warning.\nThere are two ways in which a pixel might become clipped when represented in the output color space.\nluminance clipping: This can occur when a pixel is too bright to be represented in the output color space. The pixel luminance is calculated as a weighted average of the [R,G,B] channels. If this average exceeds the maximum allowed value, it is an indication of over-exposure. The overall luminance of a pixel can also be too dark to be represented by an [R,G,B] value in the output color space, in which case it will simply be shown as black. We normally deal with luminance clipping by carefully adjusting tone mappings and exposure levels.\ngamut clipping: The output color space defines a set of primary colors that, mixed together in certain ratios, produce the final output color. However, there are only so many colors that can be produced by mixing together a combination of those three primary colors. Highly saturated colors in particular can be difficult to represent, especially for pixels that are very bright or very dark. If there is no set of positive [R,G,B] values that can represent a given color at a given level of brightness, we say that the color is \u0026ldquo;out of gamut\u0026rdquo;, and we need to settle for another color instead that can be represented by permitted [R,G,B] values within the color space. We can handle gamut clipping by being careful not to over-saturate colors in the highlights and shadows, and possibly by using some color grading/color mapping techniques.\nThe \u0026ldquo;clipping warning\u0026rdquo; module is used to highlight those pixels that cannot be accurately represented in the output color space, either due to luminance or gamut clipping. Prior to darktable 3.4, the clipping highlighted any pixels that exceeded the maximum allowed value on any of the [R,G,B] channels, or that had been completely crushed to black. From darktable 3.4 onwards, the clipping warning indicator has some additional modes to help you to differentiate between luminance and gamut clipping, so that you can make better decisions about how to address any issues.\nAs the clipping warning runs at the end of the preview pixelpipe, it receives data in display color space then converts it to histogram color space. If you are using a display color space that is not \u0026ldquo;well behaved\u0026rdquo; (this is common for a device profile), then colors that are outside of the gamut of the display profile will clip or distort.\nThe clipping warning module, described here, warns you about clipping caused by image processing and the limitations of the output color space. It should not be confused with the following similar tools:\nThe raw overexposed warning indicates where pixels in the original raw file are clipped due to physical limitations in the dynamic range of the camera sensor. This module highlights information that was permanently lost at the point of image capture, and you need to deal with it as best you can using highlight recovery techniques.\nThe gamut check module also provides information about clipping arising from image processing. It is based on the external littleCMS library, and is more or less equivalent to the full gamut mode in the clipping warning module. The downsides of the gamut check module are that it doesn\u0026rsquo;t allow you to distinguish between clipping caused by luminance and gamut mapping, and it is much slower than the clipping warning indicator.\n🔗module controls Right-click on the clipping icon to show the following options:\nclipping preview mode Choose the type of clipping that you want to highlight: any RGB channel: Provides an over-clipping indication if any one of the three [R,G,B] channels exceeds the maximum permitted value for the histogram color space, or an under-clipping indication if the three [R,G,B] channels are too dark and are all forced to black. This was the default mode prior to darktable version 3.4. luminance only: Indicates any pixels that are clipped because their luminance falls outside of the range set in the \u0026ldquo;upper threshold\u0026rdquo; and \u0026ldquo;lower threshold\u0026rdquo; sliders. If this happens, it generally means that tone mapping or exposure settings have been poorly set saturation only: Indicates where over-saturated colors have pushed one or more of the [R,G,B] channels towards a value outside the permitted range of the histogram color space, even though the overall luminance of the pixel may lie within acceptable limits. This means that the pixel\u0026rsquo;s color is impossible to represent in the histogram color space, and can arise from poorly set gamut mapping or saturation settings, full gamut: Shows a combination of the three previous options. This is the default mode from darktable 3.4 onwards, and it gives the most complete indication of potentially problematic pixels. color scheme By default, the indicator marks pixels with red where the upper threshold is exceeded (over-clipping) and with blue where the lower threshold is breached (under-clipping). This color scheme can be changed to black \u0026amp; white or purple \u0026amp; green for \u0026ldquo;over \u0026amp; under\u0026rdquo; indicators, which may be useful to improve visibility for some images. lower threshold Expressed in EV relative to the white point (which is nominally EV = 0). If the [R,G,B] channels all fall below this value, an under-clipping indicator is shown warning that the pixel may be end up being crushed to black. Use the following reference to set this threshold, depending on your intended output medium: 8-bit sRGB clips blacks at \u0026ndash;12.69 EV 8-bit Adobe RGB clips blacks at \u0026ndash;19.79 EV 16-bit sRGB clips blacks at \u0026ndash;20.69 EV fine art matte prints typically produce black at \u0026ndash;5.30 EV color glossy prints typically produce black at \u0026ndash;8.00 EV black \u0026amp; white glossy prints typically produce black at \u0026ndash;9.00 EV upper threshold How close a pixel should be to the upper limit before being flagged by the clipping warning, expressed as a percentage (default 98%). In the case of gamut checks, this controls how close the saturation of the pixel is allowed to get to the limits of the color space\u0026rsquo;s gamut before a clipping indication is flagged. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/clipping/","tags":null,"title":"clipping warning"},{"categories":null,"content":"Filter the collection of images displayed in the lighttable view and filmstrip panel using image attributes, optionally pinning filters to the top panel for quick access.\nOnce you have defined a collection of images with the collections module, the collection filters module allows you to define additional filters and sort criteria. For example, you might wish to show all images in a given folder using the collections module and then define additional quick filters to narrow-down by star rating and/or color label.\n🔗filtering attributes For information about the image attributes you can select, please see the documentation for the collections module.\nNote that only a subset of filters is currently implemented \u0026ndash; more will be added in future versions of darktable.\n🔗default settings By default, three filters (range rating, color label and text search are defined within this module. By default these filters select all images (i.e. show images with any star rating or color label) and are all pinned to the top panel for quick access. This default setting is also available as the \u0026ldquo;initial setting\u0026rdquo; preset.\n🔗module controls 🔗adding new filters To add a new filter to the module, click on the \u0026ldquo;new rule\u0026rdquo; button and select an image attribute to use.\n🔗combining multiple filters When you use multiple filters, the first item on the filter header allows you to define how the filter is combined with the previous one.\nand Narrow down search. An image is only retained if it also fulfills the new criteria. or Add more images. Images from the collection that fulfill the new criteria are added. and not Exclude images. Images that fulfill the new criteria are removed. Note: The and/or/not operators have a defined order of precedence such that \u0026ldquo;not\u0026rdquo; is executed first, then \u0026ldquo;and\u0026rdquo; and finally \u0026ldquo;or\u0026rdquo;. This means, for example, that if you define complex filters like \u0026ldquo;A and B or C and not D\u0026rdquo; these will be implemented as \u0026ldquo;(A and B) or (C and (not D))\u0026rdquo;.\n🔗removing or deactivating filters You can remove or temporarily deactivate a specific filter using the buttons on the right of the filter header (see screenshots in the following sections). If a filter is pinned to the top panel, you will need to unpin it before removing or deactivating.\n🔗pinning into the top toolbar The pin button on the right of the filter header allows you to pin a filter to the top panel. To avoid unwanted actions, pinned filters can\u0026rsquo;t be removed or deactivated.\n🔗resetting filters Clicking on the module reset button will remove all un-pinned filters and reset all others to their default values. If you want to also remove the pinned filters, you can Ctrl+click on the reset button.\n🔗returning to a previous set of filters You can return to a previously-defined set of filters by clicking on the history button at the bottom of the module and selecting from the resulting list.\n🔗filter widgets A number of filter widgets have been created for use within this module. Since some of these widgets use non-standard interfaces, their usage is explained in the following sections:\n🔗color labels The following image shows the color labels widget, set to filter images having yellow or green color labels:\nYou can interact with this filter widget as follows:\nClick on a color label to include images with that label Ctrl+click on a color label to include images without that label Click or Ctrl+click on the gray icon to act on all color labels simultaneously Use the last button to define how to handle the selection of multiple color labels. Select (and) to filter images having all of the selected color labels; Select (or) to filter images with at least one of the selected color labels. 🔗rating This is the classic rating selection widget that used to be shown in darktable\u0026rsquo;s top panel by default.\nThis widget is composed of a pair of comboboxes. The combobox on the right (always visible) is used to choose a number of stars, plus some additional options (\u0026ldquo;all\u0026rdquo;, \u0026ldquo;unstarred only\u0026rdquo;, \u0026ldquo;rejected only\u0026rdquo;, \u0026ldquo;all except rejected\u0026rdquo;). The combobox to the left (only shown when a star rating is chosen in the right-hand combobox) is used to choose an operator (\u0026lt;, \u0026lt;=, =, \u0026gt;, \u0026gt;=, ≠).\n🔗range rating This new widget also allows you to select images by star rating, this time using a new \u0026ldquo;range\u0026rdquo; widget. The following image shows the widget with ratings of 2-4 stars selected.\nYou can choose a new range of ratings to filter by clicking and dragging over the widget\u0026rsquo;s interface. You can also access pre-defined ranges by right-clicking and selecting from the popup menu. The number of applicable images is also shown against each entry in this menu.\n🔗range filters for numeric attributes Numeric attributes (aperture, exposure, focal length, iso, aspect ratio) are filtered using a widget that shows a histogram of the number of images available depending on the value of the given attribute (similar to the timeline in the lighttable view).\nFor example, the following image shows the widget when used for selecting by aperture:\nAs with the range rating filter, you can select a range of values to filter by clicking and dragging on the widget. You can also access predefined ranges by right-clicking and selecting from the popup menu. The number of applicable images is also shown against each entry in this menu.\nYou can also use the \u0026ldquo;min\u0026rdquo; and \u0026ldquo;max\u0026rdquo; text entry fields in the main module interface to manually define the bounds of the selection.\n🔗date attributes As with numeric and rating range filters, date/time filters are represented using a \u0026ldquo;range\u0026rdquo; widget. You can select a range of values by clicking and dragging on the widget, and use the right-click menu for more options.\nYou can also use the \u0026ldquo;min\u0026rdquo; and \u0026ldquo;max\u0026rdquo; text entry fields in the main module interface to manually define the bounds of the selection (right-click for more options).\nThe date/time format used by this module is YYYY:MM:DD HH:MM:SS (only the year values are mandatory).\nThe keyword now is allowed in the max field (to define the current date/time).\nYou can also use \u0026ldquo;relative\u0026rdquo; date/time values by preceding text entries with + or -. This allows you to set the maximum or minimum bound of the range relative to the other bound. As an example if you set the min value to -0000:01 and the max value to 2022:04:15, this will select images taken during the month before April 15th 2022.\n🔗filename The filename filter allows you to search images by their filename and/or extension. You can either enter the name or extension (with the leading .) manually or use the right-click menu to select.\nWithin the extension field, you can also use the keywords RAW (to select all handled RAW file extensions), NOT RAW (to select all non-RAW file extensions), LDR (to select low-dynamic-range extensions) or HDR (to select high-dynamic-range extensions).\n🔗camera, lens The camera and lens filters are presented text entry fields into which you can enter text to filter by. Alternatively, you can right-click on the text box to see a list of cameras or lenses to select from.\n🔗text search You can search images using any of their text properties (path, filename, filmroll, tags, metadata, camera, maker) using the text search filter. The search is performed \u0026ldquo;on-the-fly\u0026rdquo; and the widget is dimmed during the search process.\nBy default darktable performs a \u0026ldquo;fuzzy\u0026rdquo; search (wildcards are automatically added to the start and the end of the text). If you want to search for an exact match, you can enclose it with double-quotes (\u0026quot;match this exactly\u0026quot;).\n🔗sorting The bottom part of the module allows you to define the sort order of the images when displayed in the lighttable and filmstrip views. As with the filter criteria, you can add multiple rules to this section. However, only the first-selected sort criteria is pinned to the top panel (this cannot be unpinned).\nAs with filter criteria, the history button allows you to access any previously-used sort criteria.\nThe button to the right of the attribute selection allows you to choose whether to sort that criteria in ascending or descending order.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/collection-filters/","tags":null,"title":"collection filters"},{"categories":null,"content":"Filter the images shown in the lighttable view and filmstrip panel using image attributes. This set of filtered images is known as a collection.\nImporting images into darktable stores information about them (filename, path, Exif data, data from XMP sidecar files etc.) in darktable\u0026rsquo;s library database. A collection may be defined by applying filtering rules to these attributes, thus creating a subset of images to display in the lighttable view and the filmstrip module.\nThe default collection is based on the film roll attribute and displays all images of the last imported or selected film roll.\n🔗filtering attributes The images in a collection can be filtered using the following image attributes:\n🔗files film roll The name of the film roll to which the image belongs (which is the same as the name of the folder in which the image resides). Ctrl+Shift+click on a film roll to switch to the corresponding folder. Right-click to remove the contents of the film roll from the darktable library or tell darktable that its location has changed in the file system. folder The folder (file path) where the image file is located. Click on a folder to include the contents of that folder and all sub-folders in the collection; Shift+click to include only the images in the selected folder; Ctrl+click to show only the images from any sub-folders; Ctrl+Shift+click to switch to the corresponding film roll. Right-click on a folder name to remove its contents from the darktable library or tell darktable that its location has changed in the file system. filename The image\u0026rsquo;s filename. 🔗metadata tag Any tag that is attached to the image. Untagged images are grouped under the \u0026ldquo;not tagged\u0026rdquo; entry. When activated, a hierarchical list of known tags is displayed title The image\u0026rsquo;s metadata “title” field. description The image\u0026rsquo;s metadata “description” field. creator The image\u0026rsquo;s metadata “creator” field. publisher The image\u0026rsquo;s metadata “publisher” field. rights The image\u0026rsquo;s metadata “rights” field. notes The image\u0026rsquo;s metadata \u0026ldquo;notes\u0026rdquo; field. version name The image\u0026rsquo;s metadata \u0026ldquo;version name\u0026rdquo; field. rating The image\u0026rsquo;s star rating color label Any color label attached to the image (\u0026ldquo;red\u0026rdquo;, \u0026ldquo;yellow\u0026rdquo;, \u0026ldquo;green\u0026rdquo;, \u0026ldquo;blue\u0026rdquo;, \u0026ldquo;purple\u0026rdquo;). geotagging The geo location of the image (see locations). 🔗times capture date The date the photo was taken, in the format YYYY:MM:DD. capture time The date \u0026amp; time the photo was taken, in the format YYYY:MM:DD hh:mm:ss. import time The date/time the file was imported, in the format YYYY:MM:DD hh:mm:ss. modification time The date/time the file was last changed, in the format YYYY:MM:DD hh:mm:ss. export time The date/time the file was last expoted, in the format YYYY:MM:DD hh:mm:ss. print time The date/time the file was last printed, in the format YYYY:MM:DD hh:mm:ss. 🔗capture details camera The Exif data entry describing the camera make and model. lens The description of the lens, as derived from Exif data. aperture The aperture, as derived from Exif data. exposure The shutter speed, as derived from Exif data. focal length The focal length, as derived from Exif data. ISO The ISO, as derived from Exif data. aspect ratio The aspect ratio of the image, including any cropping within darktable. 🔗darktable grouping Choose between \u0026ldquo;group followers\u0026rdquo; and \u0026ldquo;group leaders\u0026rdquo;. local copy Show files that are, or are not copied locally. history Choose images whose history stacks have been altered or not. module Filter based on the processing modules that have been applied to the image. module order Choose images with \u0026ldquo;v3.0\u0026rdquo;, \u0026ldquo;legacy\u0026rdquo; or \u0026ldquo;custom\u0026rdquo; module orders. 🔗module controls 🔗defining filter criteria The top line of the module can be used to define filter criteria for your collection as follows:\nimage attribute The combobox on the left allows you to choose which attribute to use to filter your collection. search pattern In the text field to the right of the attribute combobox, you can write a matching pattern. This pattern is compared against all database entries with the selected attribute. The filtering mechanism detects a match if any image\u0026rsquo;s attribute contains the pattern in its full text. You may use % as wildcard character. The collection will be limited to only the matching images. Leave the text field empty to match all images having that attribute. Where applicable, a tooltip will appear if you hover over the attribute or search pattern to provide additional information. Attributes with numerical or date/time attributes can be used in combination with comparative and range operators. Use \u0026lt;, \u0026lt;=, \u0026gt;, \u0026gt;=, \u0026lt;\u0026gt;, or = to select images with attributes less than, less than or equal, greater than, greater than or equal, not equal, or equal to the given value, respectively. An expression in the form [from;to] can be used to select using a range of values.\nselect by value As well as defining filter criteria using a search pattern, you can also manually choose from a list of values (for the chosen attribute) taken from the currently-matching set of images. Making such a selection will automatically populate the \u0026ldquo;search pattern\u0026rdquo; field. The box below the search pattern will list values for the selected attribute that are present in the currently-selected images. This list is continuously updated as you type. You may also choose a sorting criteria by scrolling through the list and double-clicking.\nIf you enable single-click mode (see preferences \u0026gt; lighttable) you can select with a single-click rather than double-click. This mode also allows you to select a range of values with the mouse. This only works for numerical and date-time attributes.\n🔗combining multiple filters You can combine multiple filters together to create more complex collections of images using a series of rules. A rule is a combination of a filter criteria along with a logical operation that defines how that criteria is combined with any previous rules.\nClick on the button (to the right of the search field) to open a menu with the following options:\nclear this rule Remove the current rule, or reset it if this is the only rule defined. narrow down search Add a new rule, which is combined with the previous rule(s) in a logical AND operation. An image is only retained as part of the collection if it also fulfills the new criteria. add more images Add a new rule, which is combined with the previous rule(s) in a logical OR operation. Images that fulfill the new criteria are added to the collection. exclude images Add a new rule, which is combined with the previous rule(s) in a logical EXCEPT operation. Images that fulfill the new criteria are removed from the collection. The logical operators defining how rules are combined are indicated with icons to the right of each added rule: AND by the symbol, OR by the symbol, and EXCEPT by the symbol. Click on any of these icons to change the logical operation for that rule.\n🔗updating the folder path of moved images While it is best to not touch imported files behind darktable\u0026rsquo;s back, this module can help you to recover from situations when you have moved or renamed image folders after importing them. The collections module has a feature that allows you to update darktable\u0026rsquo;s library database with the new folder location. The process is as follows:\nSet the image attribute combobox to \u0026ldquo;folder\u0026rdquo; or \u0026ldquo;film roll\u0026rdquo;. The original film roll or folder name will be displayed with strikethrough formatting to emphasize that it can not be located. Right-click on the folder or film roll name, select “search filmroll\u0026hellip;”, and then select the new location of the folder. 🔗returning to a previous collection You can return to a previously-defined collection by clicking on the history button at the bottom of the module or using the recently used collections module \u0026ndash; see the preferences section for more details.\n🔗preferences The \u0026ldquo;preferences\u0026hellip;\u0026rdquo; option in the presets menu allows you to adjust the behavior of the collections module as follows:\ndo not set the \u0026lsquo;uncategorized\u0026rsquo; entry for tags Do not set the \u0026lsquo;uncategorized\u0026rsquo; category for tags that do not have children (default off). tag case sensitivity Set whether tags should be case sensitive or not \u0026ndash; without the sqlite ICU extension this will only apply to the 26 latin letters (default insensitive). number of collections to be stored Set the number of recent collections to show in the history popup (if present). hide the history button and show a specific module instead Choose how to view your collections history \u0026ndash; you can either use the history button in this module or use the recently used collections module. number of folder levels to show in lists The number of folder levels to show in film roll names, starting from the right (default 1). sort film rolls by Sort film rolls by either the \u0026ldquo;folder name\u0026rdquo; (path) or the \u0026ldquo;import time\u0026rdquo; (the date the film rolls were first imported) (default \u0026ldquo;import time\u0026rdquo;). sort collections descending Sort the following collections in descending order: \u0026ldquo;film roll\u0026rdquo; (when sorted by folder), \u0026ldquo;folder\u0026rdquo;, date/time (e.g. date/time taken) (default on) ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/collections/","tags":null,"title":"collections"},{"categories":null,"content":"Assess colors and brightness in your image using ISO 12646:2008 recommended viewing conditions.\nWhen developing an image, the way we perceive brightness, contrast and saturation is influenced by the surrounding ambient conditions. If an image is displayed against a dark background, this can have a number of adverse effects on our perception of that image:\nExaggeration of the perceived exposure makes the image seems brighter than it really is. This is nicely illustrated by the Adelson checkerboard shadow effect. A decrease in the perceived saturation in the image makes the colors seem less rich than they really are (the Hunt effect). A decrease in the perceived contrast in the image makes the tones seem flatter than they really are (Bartleson-Breneman effect 3) The end result is that the final image can end up being too dark and overly-processed in terms of contrast and color saturation. To avoid this, the \u0026ldquo;ISO 12646:2008\u0026rdquo; standard makes some recommendations about the conditions under which the colors of an image should be assessed. The color assessment module in the darkroom places a frame around the image to help the user better assess the colors in the image, along the lines of those recommendations.\nWhen the color assessment button is selected in the bottom panel, the image is zoomed out so that a thick mid-gray border appears around the image to act as a reference against which to compare the image\u0026rsquo;s tones. A thinner white border is placed immediately around the image to give the eyes a basis for comparison when looking at parts of the image that are meant to be a bright white.\nAlthough the color assessment mode provides a mid-gray surrounding to the image, it is recommended that you also set your user interface (in preferences \u0026gt; general) to one of the \u0026ldquo;grey\u0026rdquo; themes. These themes are designed to provide a user interface that is close to middle gray (it is actually slightly darker to allow better contrast with the text in the user interface). When one of these themes is used together with the color assessment mode, this will help to avoid the above perception issues.\nColor assessment mode can also be toggled by pressing Ctrl+B.\nYou can modify the distance from the edge of the center panel to the edge of the image by adjusting the darkroom/ui/iso12464_border entry in the $HOME/.config/darktable/darktablerc file. In the same file you can modify the size of the white border (in percent) by adjusting the darkroom/ui/iso12464_ratio entry.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/color-assessment/","tags":null,"title":"color assessment"},{"categories":null,"content":"View and create multiple versions of the current image. Each version can be edited independently without affecting other versions \u0026ndash; all versions use the same underlying image file, but the editing history of each version is stored in its own independent XMP sidecar file.\nThe duplicate manager lists each version of the current darkroom image along with its preview thumbnail. Hold down the left mouse button on a thumbnail to temporarily show that version in the center view. Double-click to switch to that version and edit it.\nThe buttons at the bottom of the module allow you to create new duplicates of the current image. You can either create a \u0026lsquo;virgin\u0026rsquo; version (with an empty history stack) using the \u0026ldquo;original\u0026rdquo; button or an exact duplicate of the current edit using the \u0026ldquo;duplicate\u0026rdquo; button.\nA version number is displayed to the right of each thumbnail. Click in the area below the version number to enter a description against that version of the image. This description is stored in the version name metadata tag, which can also be edited within the metadata editor module in the lighttable view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/duplicate-manager/","tags":null,"title":"duplicate manager"},{"categories":null,"content":"Export selected images.\nWhen used in the darkroom view, the currently-edited image will be exported if no other images are selected in the filmstrip.\nFiles can be exported to a file on disk, email, various online storage locations, a web album, or a book template.\n🔗module controls 🔗storage options target storage The type of location to store your selected images. A number of different back-ends are implemented, including file on disk, LaTeX book template and various web albums. Depending on the selected target, you will be asked to provide additional information, such as filenames or account name and password. filename template Define the folder and file to which the image will be exported. This can be automatically generated using several pre-defined variables. See the variables section for details. output directory selector The button beside the filename template entry opens a dialog to select the parent directory for export. on conflict Choose what to do if the generated filename conflicts with an existing file on export: create unique filename: Automatically choose a unique new file name by appending an integer to name of the conflicting file. overwrite: Automatically overwrite existing files. This option will present you with a confirmation dialog in order to protect you from accidental data loss \u0026ndash; you can disable this in preferences \u0026gt; security \u0026gt; ask before exporting in overwrite mode. Note: This dialog is not presented per-file but as a one-off confirmation before the export job starts. overwrite if changed: Automatically overwrite existing files if the last export timestamp stored in darktable\u0026rsquo;s database does not match the last changed date/time on the existing file. skip: Do not export images where the destination filename already exists. 🔗format options file format Choose the file format for the exported image. Additional options will appear (below) depending on the selected format. quality The quality of the exported file. Higher values lead to larger file sizes. The default quality (95) is a good setting for very high quality exports (e.g. for archiving or printing purposes). If you need a good compromise between size and quality (e.g. for online image display or uploads) you should consider a value of “90” instead. bit depth The number of bits used for each color channel. More bits means less posterization/color banding. compression The type of compression to use. compression level For export formats where compression can be specified, the compression level specifies how much compression to apply. The higher the level, the more the data will be compressed, at the cost of more CPU cycles. b\u0026amp;w image For TIFF export format, it is possible to save a monochrome image. This setting controls whether the resulting file encodes the shades of gray as separate RGB channels, or as a single grayscale channel. The latter option will result in smaller files. 🔗global options set size Choose how to measure the maximum size of your exported image in pixels (for file): Enter the maximum width and height in pixels. in cm (for print): Enter the maximum width and height in cm and define the image\u0026rsquo;s dpi. The equivalent size in pixels will be automatically calculated. in inch (for print): Enter the maximum width and height in inches and define the image\u0026rsquo;s dpi. The equivalent size in pixels will be automatically calculated. by scale (for file): Enter a multiplier to specify by how much the exported image should be scaled compared to the input image. For example, entering a value of 0.5 will result in an output image with half the width and height (in pixels) of the original image. dpi If units of cm or inches are chosen, set the dpi of the output image. The dpi will also be stored in the Exif data of the exported image. It will be automatically set to 300 if \u0026ldquo;in pixels\u0026rdquo; or \u0026ldquo;by scale\u0026rdquo; is chosen. max size Set the maximum width and height of the exported image(s) in pixels, cm or inches (depending on the selected unit) \u0026ndash; zero means that no constraint will be set on that dimension. Exported images will be constrained so as not to exceed either of these values, while retaining the correct aspect ratio. Set both to zero to export with the original dimensions (after cropping). If the entered values exceed the original dimensions darktable will either export with the original dimensions or upscale the image, depending on the \u0026ldquo;allow upscaling\u0026rdquo; parameter. allow upscaling Set to “yes” to perform an upscaling step if the user-defined maximum width and height exceed the original dimensions of the image. If set to “no” the exported image\u0026rsquo;s dimensions will not exceed the dimensions of the original image (after cropping). high quality resampling Set this to \u0026lsquo;yes\u0026rsquo; to perform high quality resampling on the image. The image will be processed in full resolution and only downscaled at the very end. This can sometimes result in better quality, but will always be slower. store masks Store masks as additional layers (for TIFF format) or channels (for EXR and XCF formats) in the exported image. profile The output color profile. Select “image settings” if you want the settings in the output color profile module of the individual images to be respected. intent This option lets you define the intent \u0026ndash; the way in which darktable will handle out-of-gamut colors. See rendering intent for a more detailed description of the available options. style Choose a style which darktable will combine with the existing history stack to generate the output image. These history items are only added temporarily \u0026ndash; the original history stack is not overwritten. You can use this feature to add processing steps and parameters that you want to be applied specifically to images before export. For example you may define a style that adds a stronger level of sharpening when you produce scaled-down JPEG files for the internet or add a certain level of exposure compensation to all of your output images. mode When applying a style during export this option defines whether the history stack items of that style replace the original history stack of the image or are appended to it. Technically speaking, in append mode history stack items of the style will constitute separate instances of the respective modules on top of any existing ones (see also multiple instances). As a consequence the original history stack will remain in effect with the new items being applied in addition. This way you can apply an overall adjustment (e.g. exposure) to a number of exported images while respecting the settings of each individual image. export Press this button to start a background job to export all selected images. A bar at the bottom of the left hand panel displays the progress of the export job. Furthermore a notification message pops up reporting the completion of each individual export. You may click on the pop-up to make it disappear. You may abort the export job by clicking on the \u0026ldquo;x\u0026rdquo; icon located close to the progress bar. Note: Images that are selected but currently hidden (because they are members of a collapsed group) will not be exported.\n🔗metadata preferences The “preferences…” option in the presets menu brings up a dialog where you can configure what metadata to include in exported files:\nThe parameters entered into this dialog are saved along with other export parameters to user presets and the last entered values are retained when darktable is closed.\n🔗general settings The left-hand-side of this dialog allows you to choose which groups of metadata are to be exported with the image. The following options are available:\nexif data Export the source image\u0026rsquo;s Exif data. metadata Export metadata defined in the metadata editor module. Only metadata fields that are tagged as visible and are not tagged as private will be exported. geo tags Export geo tags. tags Export tags created in the tagging module (to Xmp.dc.Subject). Three additional options can also be selected: private tags: Export private tags synonyms: Export tag synonyms omit hierarchy: Only export the last part of hierarchical tags hierarchical tags Export hierarchical tags (to Xmp.lr.Hierarchical Subject) develop history Export the entire development history (history stack and shapes) where supported (e.g. JPEG, JPEG2000, TIFF). The development history will be stored as XMP tags within the output file. This information can later be used to reconstruct the parameters and settings that were used to produce the exported image. Caution: For various reasons embedding XMP tags into output files may fail without notice, e.g. if certain size limits are exceeded. Users are therefore advised to not rely on this feature for their backup strategy. To back up your data always make sure to save your input (raw) file as well as all of darktable\u0026rsquo;s XMP sidecar files.\n🔗per metadata settings The right-hand-side of this dialog allows you to define formulas to populate image metadata. The formulas defined here have priority over the settings in the left-hand-side of the dialog. The first column identifies the entry to be edited. The second column allows you to define how to calculate the value for that metadata entry using a formula.\nSee the variables section for details of the variables you can use in your metadata formula. Press Enter to validate the formula. Leave the formula empty to prevent a given metadata entry from being exported (Exif.GPSInfo.GPSVersionID in the above example).\nUse the “\u0026ndash;” icon to remove a metadata entry from the list and the “+” icon to add a new one from a predefined list of available metadata tags.\nClick on the \u0026ldquo;add\u0026rdquo; button to add a metadata entry to the list.\nThe formulas allow you virtually define all the metadata you need to qualify your images in tagging and export the values in the XMP or IPTC tags of your choice. The exported tags can be different from one export to the next depending on the destination of the images. Tags and Categories are displayed separately in image information.\nRemember that a tag set up as a category is never exported.\n🔗tips To prevent a specific metadata field from being exported, add it to the list and leave the formula empty. To force a specific exif metadata field to be exported when exif export is disabled, add it to the list and enter = into the formula. 🔗examples example 1 A first level tag called places is set as a category, and is followed by four levels of information (or keywords): country, region, city and location (e.g. places|France|Nord|Lille|rue Nationale). Each level can be retrieved (when it is defined) by one of the variables $(CATEGORY0(places)), $(CATEGORY1(places)), $(CATEGORY2(places)) and $(CATEGORY3(places)). In this example, the returned values are \u0026ldquo;France\u0026rdquo;, \u0026ldquo;Nord\u0026rdquo;, \u0026ldquo;Lille\u0026rdquo; and \u0026ldquo;rue Nationale\u0026rdquo;, respectively. These keywords can also be retrieved as simple tags using the variable $(TAGS). The last keyword level defined (the leaf) is displayed in image information, here \u0026ldquo;rue Nationale\u0026rdquo;. example 2 A first level tag called creator is followed by the name of the photographer, both set as categories: creator|firstname lastname. The formula copyrights ($(YEAR) $(CATEGORY0(creator))) builds the text associated with image rights. Here, image information displays \u0026ldquo;creator: firstname lastname\u0026rdquo; as categories. Neither creator nor \u0026ldquo;firstname lastname\u0026rdquo; appear in the tags list and they are not exported as simple tags. Note: tagging is not appropriate to define free text metadata, like a title or a description, which may be specific to each image. Use the metadata editor for this type of information.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/export/","tags":null,"title":"export"},{"categories":null,"content":"The filmstrip can be used to quickly switch between images. The images shown are the same as those displayed in the lighttable view and are defined by the currently-selected collection.\nThe filmstrip can be switched on and off using the shortcut Ctrl+F. The height of the filmstrip panel can be changed by clicking and dragging its top border.\nQuickly navigate through the images in the filmstrip by scrolling with the mouse. Increase scroll speed with Shift+scroll. Change the height of the filmstrip with Ctrl+scroll or by clicking+dragging the top of the panel. In the darkroom you can change the photo currently being processed by clicking on another image in the filmstrip.\nIn the darkroom, the image currently being processed is selected and highlighted. Hover over an image on the filmstrip with your mouse to select it (in order to act on it with a keyboard shortcut) without changing the image being processed.\nIf you wish to select multiple images in the filmstrip, use Alt+click to select the first image, followed by either Ctrl+click to select or de-select further images, or Shift+click to select a range of images.\nThe following shortcuts can be used to select images in the filmstrip:\nCtrl+A selects all images in the filmstrip\nCtrl+Shift+A deselects all images\nCtrl+I inverts the current selection\nThe following shortcuts can be used to perform operations on the selected images\nF1, F2, F3, F4, F5 adds or removes a color label (red, yellow, green, blue, purple, respectively). A color label will be added if any selected image does not currently have the label; otherwise the label will be removed\n0, 1, 2, 3, 4, 5 sets the star rating\nR rejects the image(s)\nCtrl+D duplicates the image(s)\nCtrl+C copies the full history stack\nCtrl+V pastes all of the copied history stack\nCtrl+Shift+C selectively copies the history stack\nCtrl+Shift+V selectively pastes from the copied history stack\nSee the lighttable\u0026rsquo;s history stack module documentation for more information about the copy and paste functionality.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/filmstrip/","tags":null,"title":"filmstrip"},{"categories":null,"content":"Search for a location on the map. You must be connected to the internet to use this feature.\nTo use this module, type in a place name or address, press Enter and a list of results will be shown. Click on an item in the list and the map will zoom to that location. An outline covering that location or a pin pointing at the location will be displayed.\nAn outline (polygon) can be used to create a user location. Check the max polygon points parameter in the map settings module to ensure that sufficient points are available for a polygon to be displayed.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/map/find-location/","tags":null,"title":"find location"},{"categories":null,"content":"Identify which parts of the image contain high contrast details such as edges and textures, which are usually a useful guide to sharpness and therefore focus.\nActivate the module by clicking on the icon. The sharpest parts of the image will be highlighted with a yellow, green and blue overlay:\nFocus peaking works by filtering out most of the image noise, measuring the intensity gradients in the image and calculating average and standard deviation statistics. When the gradient of an edge differs significantly from the mean, the associated pixels are marked with a \u0026ldquo;heat map\u0026rdquo; indicating how sharp the edge is.\nyellow represents a large (6σ) jump in gradient, indicating a very sharp edge. green represents a medium (4σ) jump in gradient, indicating a reasonably sharp edge. blue represents a small (2σ) jump in gradient, indicating a slightly sharp edge. Note: While the algorithm in this module generally does a good job of locating the sharpest parts of an image, it does not necessarily detect whether an image is sharp. Additionally, as it uses local contrast to detect sharpness, it will also highlight the edges of dark objects against bright backgrounds (and vice versa) even if those edges are blurred. Because it runs at the end of the pixelpipe, it may also detect the results of any sharpening you have performed within darktable.\nThe following example image was taken with a wide aperture to give a shallow depth of field, and you can see how the camera has focused on the chinese character written on the second red lantern along from the front. There are also stems of the pink flowers that fall within the area of acceptable sharpness around the focal plane, and these have also been marked up with yellow and green.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/focus-peaking/","tags":null,"title":"focus peaking"},{"categories":null,"content":"Highlight areas of the image that may exhibit gamut clipping.\nClick the icon to activate the gamut check display mode for your image. This function highlights, in cyan, all pixels that are out of gamut with respect to the selected softproof profile. You can also activate gamut check with the keyboard shortcut Ctrl+G. A message “gamut check” on the bottom left of your image tells you that you are in gamut check display mode. Gamut check and soft proof are mutually exclusive modes.\nRight-click on the icon to open a dialog with configuration parameters \u0026ndash; these are the same as for the soft proof option.\nYou might also like to consider using the clipping warning, which also provides under- and over-exposure warnings as well as a gamut check similar to that offered by this module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/gamut/","tags":null,"title":"gamut check"},{"categories":null,"content":"Import and apply GPX track data to a selection of images.\nThis module is common to the lighttable and map views. The map view provides an enhanced mode that allows you to preview the position of the images along the GPS tracks while adjusting the images\u0026rsquo; date/time offset and time zone.\n🔗workflow overview A GPS receiver calculates its current position based on information it receives from satellites, and records it in a GPX file together with the current date and time. The Exif data of the images also contains a time stamp defined by the camera settings. The geotagging module takes the time stamp of the image, looks up the position in the GPX file at that time, and stores the appropriate coordinates (latitude/longitude/elevation) in its database and the image\u0026rsquo;s XMP sidecar file.\nTwo problems may occur during this process:\nIn contrast to GPS devices, most cameras don\u0026rsquo;t record the time accurately. The time stored in the Exif data does not include the time zone. Most people set their camera to local time, whereas GPS devices store the time in the UTC (Universal Time, Coordinated, i.e. Greenwich (London)) time zone. If the time zones of the camera and GPX file differ, than the related location will be wrong. If your image already shows the correct date/time and carries the UTC time stamp, you can directly apply the GPX track file without further adjustments.\nOtherwise follow the following process to correlate the time of the images and GPS track files\nFix the camera time setting for a single image by manually entering the correct date/time for that image into the date/time field. A good way to do this accurately is to take a photograph of a reliable time source. This can be any precise clock or, even better, the time displayed on your GPS device (bearing in mind that GPS devices normally show the local time, even though they store universal time). The difference (offset) between the time entered and the time stored in the image\u0026rsquo;s Exif data will be shown in the date/time offset field.\nPress the lock button to lock the calculated offset in the module.\nSelect all of the images you wish to adjust and click apply offset to apply the calculated offset to those images.\nIf the camera time zone is not UTC, set the time zone in the camera time zone field.\nWith the time setting corrected, you can now apply GPX tracking data using the apply GPX track file button.\n🔗module controls (common) date/time This field is initialized with the date/time read from the first selected image (format yyyy:mm:dd hh:mm:ss) and can be modified to correct the date/time for that image. The individual date/time fields can be altered by scrolling over them with your mouse. If any field reaches its limit, the neighboring fields are automatically updated. For example, if you go over 60 on the minute field, the hour field will automatically be incremented. It is also possible to use milliseconds in this module if you enable preferences \u0026gt; lighttable \u0026gt; show image time with milliseconds. original date/time The original date/time of the image is shown here for reference. date/time offset The calculated difference between the original date/time and that keyed in the date/time field. If the calculated difference is greater than 99 days 23 hours 59 minutes and 59 seconds, the offset is invalidated. lock button If the lock button is activated, the offset value is frozen. If you subsequently change the selected image(s), the new image date/time is updated using the locked offset. This allows you to apply the same offset to multiple groups of images. apply offset button Apply the offset to selected images. apply date/time button It is sometimes useful to be able to set the absolute date/time for an image, for example where this information is missing. This button allows you to apply the date/time entered in the date/time field to the selected images, without considering the previous value. You can use Ctrl+Z to undo any unwanted changes. camera time zone Select the camera\u0026rsquo;s time zone. Start typing to show a list of permitted values. apply GPX track file (lighttable view only) Apply a GPX track file. Click the corresponding button and navigate to the GPX file. You can use Ctrl+Z to undo any unwanted changes. Within the file chooser window, the preview button lists the tracks of the selected GPX file along with the following information: track name, start and end date/time (local time), number of track points and number of selected images that will be geotagged. 🔗module controls (map view) GPX file The path of the GPX file selected. track list This table shows the start date/time of each track, along with the number of track points and the number of matching images. When a check button is activated, the related track is displayed on the map. A check button in the table header allows you to select or de-select all of the tracks at once. Hover over a row with your mouse to display the start and end times both in local time (LT) and UTC. preview images If checked, the matching images are displayed on the map along the visible tracks. select images If you don\u0026rsquo;t wish to apply an offset to all of the selected images, but only to the matching images, use this button to select images. If you don\u0026rsquo;t want to lose the current offset you may want to lock it before changing the selection. counts A count of the number of matching images and the number selected is displayed to the right of the select images button. apply geo-location This button is displayed when the offset is null. The apply geo-location button applies the GPX data to matching images on selected tracks. apply offset and geo-location This button is displayed once an offset has been entered. As a reminder, the apply offset button applies the offset to all selected images. Unlike apply offset, the apply offset and geo-location button applies the offset and the GPX data to matching images on selected tracks. You can use Ctrl+Z to undo any unwanted changes (twice in case of apply offset and geo-location).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/geotagging/","tags":null,"title":"geotagging"},{"categories":null,"content":"Take color samples from the current darkroom image, display their values in multiple ways and compare colors from different locations.\nThe color picker is activated by pressing the picker icon. The module\u0026rsquo;s parameters will remain in effect until you leave the darkroom mode.\nBesides the global color picker described here, many darktable modules (e.g. tone curve) also contain local pickers which are used to set individual module parameters. You should be aware that these two forms of picker do not always work in the same color space. The global color picker works in the histogram color space and takes its samples after the complete pixelpipe has been processed. Local pickers run in the color space of the module in which they are activated and reflect the input or output data of that module within the pixelpipe.\nYou can right-click on the sampled color values to copy them to the clipboard.\nAs the global color picker runs at the end of the preview pixelpipe, it receives data in display color space then converts it to histogram color space. If you are using a display color space which is not \u0026ldquo;well behaved\u0026rdquo; (this is common for a device profile), then colors that are outside of the gamut of the display profile will clip or distort.\nHover over any of the color values to show a tooltip containing more detailed information about the picked color or live color sample. This information includes RGB and Lab values as well as an approximate color name. An attempt is also made to detect skin tones and provide an appropriate description. Skin tone detection needs proper Lightness scaling (44 to 48% for African and 58 to 64% for all others) and neutral white balance.\n🔗module controls point/area mode The global color picker can be activated in point or area mode with the picker icon. In point mode only a small spot under your cursor is taken as a sample. In area mode darktable samples the area within a drawn rectangle. mean/min/max If samples are taken in area mode, darktable will calculate mean, minimum and maximum color channel values. This combobox allows you to select which of those are displayed. For obvious statistical reasons mean, min and max are identical for the single sample of point mode. color swatch / color values A color swatch representing the sampled point or area is displayed alongside numerical values. Clicking on the swatch will toggle on/off a much larger swatch for easier viewing. The global color picker works in display RGB color space, though you may choose (by selecting from the drop-down) to translate these numerical values into another color space. Beware that values in other color spaces are approximated here \u0026ndash; depending on the display color profile there may be some deviations from the actual values.\nlive samples The sampled colors (in either area or point mode) can be stored as live samples by pressing the \u0026ldquo;add\u0026rdquo; button. A color swatch and numerical values will be shown for each stored sample. You can change the numerical value (mean, min, max) and color space to display. Newly created live samples are not locked. If you change your image processing those changes will be reflected in the live samples. This can be used to see how an altered parameter affects different parts of the image. Clicking on a live sample\u0026rsquo;s color swatch locks it and a lock symbol is displayed. Further image changes will then no longer affect the sample. You can use this to compare two live samples by locking just one of them, thus providing a before and after comparison.\nIf you hover the mouse over the \u0026ldquo;delete\u0026rdquo; button of one of the live sample entries, the selected region for that sample will be highlighted in the image preview.\ndisplay samples on image/vectorscope When this checkbox is ticked, live sample locations are visually indicated on the image and the vectorscope view of the scopes module. restrict scope to selection When this checkbox is ticked, only the values of the selected area or point are taken into account by the regular and waveform views of the scopes module. This allows you to see what tonal values are present in the selected area. When using a picker in a processing module, this option restricts the scope to the picked area from the processing module instead of the global color picker. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/global-color-picker/","tags":null,"title":"global color picker"},{"categories":null,"content":"A number of commonly-used compositional guides can be overlaid on your image while you are editing. These can be enabled either globally (all the time) or locally (when certain modules are active).\nOther darkroom functionality also draws colored overlay lines on the image (for example, drawn masks). An option is also provided to change the color of those overlays (see below).\n🔗global guides Left-click the icon in the bottom bar to globally display guide overlays. The overlays will remain switched on until you click the button a second time to switch them off.\nRight-click the icon to show the settings dialog (see below).\n🔗local guides A more common use is to switch the guides on only when a specific module is activated. The following control is added by default to all modules that crop/distort the image (currently crop, crop and rotate, orientation, framing, liquify, lens correction and rotate and perspective):\nTick the box to show guide overlays whenever the module is active. Click the icon on the right to show the settings dialog (see below).\n🔗global guide overlay settings Please note that, while you can choose to switch guide overlays on and off either globally or locally, the following settings are stored globally and cannot be set independently for each module.\ntype The type of compositional guide lines to display. flip Some guides are asymmetrical. This option allows you to flip such guides horizontally/vertically. horizontal lines, vertical lines, subdivisions When the grid overlay type is selected, set the parameters of the grid. overlay color The color of the overlay lines. Note that this impacts any lines that are drawn directly over the image, for example, drawn masks. contrast The contrast between the lightest and darkest parts of any overlays \u0026ndash; usually, the contrast between the \u0026ldquo;on\u0026rdquo; and \u0026ldquo;off\u0026rdquo; parts of dashed lines. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/guides-overlays/","tags":null,"title":"guides \u0026 overlays"},{"categories":null,"content":"Process the image in the darkroom view using \u0026ldquo;high quality mode\u0026rdquo;, so that the displayed image reflects the appearance of a full-sized export.\nActivate this mode by clicking the icon at the bottom of the darkroom view.\nNote that while this mode provides the most accurate representation of the processed image, it also results in signficant performance degredation. Please see the types of pixelpipe section for a full discussion.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/high-quality-processing/","tags":null,"title":"high quality processing"},{"categories":null,"content":"View and modify the history stack of the current darkroom image.\nThis module lists every change of state (activate/de-activate/move/change parameters) for all processing modules that have been modified for the current image. Select a point in the stack to return to that point in the development history of the image. Shift+click an item in the history stack to expand that module in the right-hand module panel without changing the current edit.\nCaution: If you select a module in the history stack and then make further modifications to the image, all edits above the currently selected step will be discarded. It is easy to lose development work on an image in this way! You can usually use Ctrl+Z to undo such changes.\nIt is safe to quit the program, leave the darkroom mode, or switch to another image after having selected some earlier state in the history stack module. When returning to that image you will find the history stack panel in the state where you left it.\nHover the mouse over an item in the history stack to show a tooltip with details of all changes that were made in that module compared to its previous or default state. This can help you to track down adjustments that were made unintentionally.\nClick “compress history stack” to generate the shortest history stack that reproduces the current image. This causes all edits above the currently-selected step to be discarded. If any module appears multiple times in the remainder of the stack, these will be compressed into a single step in the history.\nClick \u0026ldquo;compress history stack\u0026rdquo; while holding the Ctrl key to truncate the history stack without compressing it i.e. discard all modules above the currently selected one but leaving the remainder of the history stack unchanged.\nClick the \u0026ldquo;reset parameters\u0026rdquo; button in the module header to discard the entire history stack and reactivate any default modules. This can also be achieved by selecting the \u0026ldquo;original image\u0026rdquo; history item and clicking \u0026ldquo;compress history stack\u0026rdquo;.\nThe button to the right of the \u0026ldquo;compress history stack\u0026rdquo; button allows you to create a new style from the history stack of the current image, which can then be applied to other images. Use the first line of the popup dialog window to name your style and the second to add a searchable description. You will be prompted to choose which of the modules from the current history stack to include in the style.\nOnce created, styles can be managed and applied to other images with the lighttable\u0026rsquo;s styles module. You can also assign shortcut keys to your styles (see preferences \u0026gt; shortcuts) and apply the associated style to all selected images by pressing the shortcut key whenever you are in the lighttable or darkroom view.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/history-stack/","tags":null,"title":"history stack"},{"categories":null,"content":"Manipulate the history stack of one or more selected images.\n🔗module controls selective copy\u0026hellip; Copy parts of the history stack from the selected image. A dialog will appear, from which you will be able to select which history stack items you want to copy. For any module, you may also choose to \u0026ldquo;reset\u0026rdquo; that module\u0026rsquo;s parameters \u0026ndash; this will cause the module to be copied but with all controls set to their initial (default) state (as if you had clicked the module reset button). If more than one image is selected, the history stack is taken from the image that was selected first. Double-click on a history item to copy that item only and immediately close the dialog.\ncopy Copy the complete history stack from the selected image. If more than one image is selected, the history stack is taken from the image that was selected first. Information relating to internal display encoding and mask management is considered unsafe to automatically copy to other images and will therefore not be copied when using this button.\nThe following modules are excluded from the copy operation:\norientation lens correction raw black/white point rotate pixels scale pixels white balance deprecated modules You can override all of these exclusions by using \u0026ldquo;selective paste\u0026hellip;\u0026rdquo; and choosing which modules to paste to the target image(s).\ncompress history Compress the history stack of the selected image. If any module appears multiple times in the history stack, these occurrences will be compressed into a single step in the history. Beware: this action can not be undone! discard history Physically delete the history stack of the selected images. Beware: this action can not be undone! selective paste\u0026hellip; Paste parts of a copied history stack onto all selected images. As with the selective copy button, a dialog appears from which you may choose the items to paste (or \u0026ldquo;reset\u0026rdquo;) from the source history stack. paste Paste all items of a copied history stack onto all selected images. mode This setting defines how the paste actions behave when applied to an image that already has a history stack. In simple terms the “overwrite” mode deletes the previous history stack before pasting, whereas “append” concatenates the two history stacks together. A copied history stack can have multiple entries of the same module (with the same name or different names) and pasting behaves differently for these entries in append and overwrite modes.\nIn append mode, for each module in the copied history stack, if there is a module in the destination image with the same name it will be replaced. If there is no such module, a new instance will be created. In both cases the pasted instance is placed on top of the history stack. If a particular module appears multiple times in either history stack only the last occurrence of that module will be processed.\nIn overwrite mode the behavior is the same except that the history of the destination image is deleted before the paste operation commences. The “copy all”/“paste all” actions in this mode will precisely duplicate the copied history stack to the destination images (including any duplicate occurrences).\nNote: If you use the \u0026ldquo;copy\u0026rdquo; button (copy all safe modules) followed by the \u0026ldquo;paste\u0026rdquo; button (paste all copied modules), the paste will always be done in overwrite mode, regardless of the setting of this parameter. Similarly when performing the same operation using keyboard shortcuts.\nNotes Automatic module presets are only added to an image when it is first opened in the darkroom or its history stack is discarded. If you use overwrite mode to paste history stack entries to images that haven\u0026rsquo;t previously been opened in the darkroom then the next time that image is opened in the darkroom, automatic presets will be applied to the image. It may therefore seem as if the “overwrite” mode did not accurately duplicate the existing history stack, but in this case, those automatic modules were added subsequently. The append mode allows you to later reconstruct your pre-existing history stack (because previous history items are retained in the stack of the destination image). However, in “overwrite” mode all previous edits are irrevocably lost. The mode setting is retained when you quit darktable \u0026ndash; if you change it for a one-off copy and paste, make sure to change it back again. load sidecar file Open a dialog box which allows you to import the history stack from a selected XMP file. The imported history stack is used to completely replace the current history stack(s) of the selected image(s). Caution: this operation can not be undone! Images that were exported by darktable typically contain the full history stack if the file format supports embedded metadata (see the export module for details of this feature and its limitations). You can load an exported image as a sidecar file in the same way as you can with an XMP file. This feature allows you to recover all parameter settings if you have accidentally lost or overwritten the XMP file. All you need is the source image, typically a raw, and the exported file.\nwrite sidecar files Write XMP sidecar files for all selected images. The filename is generated by appending “.xmp” to the name of the underlying input file. By default darktable generates and updates sidecar files automatically whenever you work on an image and change the history stack. You can disable automatic sidecar file generation in preferences \u0026gt; storage. This can be useful when you are running multiple versions of darktable (so that edits in each version do not conflict with one another) however, in general, disabling this feature is not recommended.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/history-stack/","tags":null,"title":"history stack"},{"categories":null,"content":"Display information embedded within an image\u0026rsquo;s Exif data as well as a number of additional data fields defined by darktable.\nWhen hovering with the mouse over image thumbnails, the displayed data is automatically updated to show information about the image currently under the mouse cursor.\nWhen several images are selected and the focus is not on a single image, the module only displays information that is the same for all images. If any fields differ between the images, the text \u0026ldquo;\u0026lt;various values\u0026gt;\u0026rdquo; is displayed instead.\nWhile you are in the lighttable view, you can double-click on the filmroll field for a given image to show all images in that image\u0026rsquo;s film roll.\n🔗preferences The “preferences…” option in the presets menu brings up a dialog with a list of all fields that are available for display.\nThe visible checkbox allows you to choose which fields to display. You can also drag and drop one row at a time to change the display order.\nThese preferences can be saved as module presets. Press the module\u0026rsquo;s reset button to make all available information visible and displayed in its default order.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/image-information/","tags":null,"title":"image information"},{"categories":null,"content":"Display information about the current image in a darkroom panel.\nThe contents of this line can be set in preferences \u0026gt; darkroom. See the variables section for information about the variables that can be used here. You can also insert a newline with $(NL).\nThe image information line can be displayed in the top, bottom, left or right panel depending on an additional configuration item in preferences \u0026gt; darkroom.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/image-info-line/","tags":null,"title":"image information line"},{"categories":null,"content":"Add images to the darktable library, optionally copying them from another location on the filesystem or from a connected camera.\nSee supported file formats for more information.\n🔗module controls The following buttons are shown in the module\u0026rsquo;s UI by default:\nadd to library Add existing images to the darktable library without copying or moving files. If you only add a single image to the library it will be automatically loaded in the darkroom. copy \u0026amp; import Create copies of images from the filesystem and then add those copies to the darktable library. When a camera is detected, a new section will appear in the module for that device. If you hover your mouse over the camera label, a tooltip will display information about the camera (model, firmware version etc.)\nDepending on the capabilities of the camera, the following additional buttons may be displayed:\nmount camera Mount the camera for exclusive use by darktable. This button only appears if the camera is not currently mounted and is not locked by another process. copy \u0026amp; import from camera Create copies of images from the connected camera and then add those images to the darktable library. This button only appears if the camera is currently mounted. tethered shoot Open the tethering view so that you can take images with your connected camera using darktable. This button only appears if the camera is currently mounted. unmount camera Unmount the camera and release it for use by other applications. This button only appears if the camera is currently mounted. 🔗module parameters Click on the \u0026ldquo;parameters\u0026rdquo; label or the expander button beside it to display the following additional options.\nAll parameters are retained from one session to the next and can be saved as module presets.\nignore exif rating Check this option to ignore any rating stored within the image\u0026rsquo;s Exif data and instead use a hard-coded value (below). initial rating Initial star rating (from 0 to 5) to use for all newly-imported images (default 1). apply metadata Check this option to automatically set metadata fields and/or tags at import time (see below). metadata If the \u0026ldquo;apply metadata\u0026rdquo; box is checked, a list of the visible metadata fields is presented for completion (see metadata editor for details). Any populated strings are automatically added to the imported images. You can also choose from any presets saved within the metadata editor module. Double-click on a label to reset the corresponding field. Double-click on the \u0026ldquo;metadata presets\u0026rdquo; label to reset all fields.\nIf preferences \u0026gt; storage \u0026gt; create XMP files is set to \u0026ldquo;never\u0026rdquo;, an additional column \u0026ldquo;from XMP\u0026rdquo; is presented so that you can choose to prevent the import of metadata from XMP files.\ntags If you want to add further tags by default when importing images, you can provide them here as a comma separated list. As with metadata you can also choose from any presets saved within the tagging module. 🔗import dialog Each of the three import buttons (add to library, copy \u0026amp; import, copy \u0026amp; import from camera) uses a similar dialog for the import process, described in this section.\nThe following example screenshot is taken from the \u0026ldquo;add to library\u0026rdquo; button:\n🔗common functionality 🔗places and folders The import dialog is intended to allow you to set up common import locations, to make subsequent imports as simple as possible. When you first open the dialog, darktable attempts to add some common locations (home, pictures, mounted devices) to the places pane. You can add new places to the list by clicking on the + button and you can remove places from the list by right-clicking on them. If you wish to restore a default location that you have deleted, you can do this with the reset button.\nWhen you choose a place, the folder tree is automatically populated (into the folders pane) from the root directory of the selected place. You can then navigate the folder tree and select a folder for import. The last selected place/folder is automatically reloaded the next time you open the dialog.\nIn the example screenshot above, you can see that a \u0026ldquo;place\u0026rdquo; has been created for the root of the Photos folder and a sub-folder within that structure has been selected. This is the recommended workflow for the import process \u0026ndash; you should not have to create new places very often.\n🔗files Once you have selected a folder, the files pane will automatically be populated with a list of the files found in that folder. By default, all files in the chosen folder are selected.\nYou can view thumbnails for any of the images by clicking on the icon. In addition, buttons are available at the bottom of the screen to select \u0026ldquo;all\u0026rdquo; files or \u0026ldquo;none\u0026rdquo;.\nOnce you are happy with your selection, press Enter or click on the button at the bottom-right of the screen to import (this button will be named differently depending on the type of import being performed).\nPress Escape or click the \u0026ldquo;cancel\u0026rdquo; button to exit without importing.\n🔗common options The following additional options are common to all import dialogs:\nrecursive directory Check this option to import images in the selected folder and all subfolders. It is recommended that you not use this option to import a large number of images at the same time. The import process causes darktable to generate thumbnails for all of the imported images, but in the end it will only be able to keep the most recent in its cache. It is therefore better to import images in smaller chunks to avoid the performance penalty this imposes. ignore JPEG images Check this option if there are JPEG images in the same folder that you do not wish to import. This option is usually used where the camera stores RAW+JPEG and you only want to work on the RAW files, leaving the JPEG images untouched. 🔗add to library The \u0026ldquo;add to library\u0026rdquo; button allows you to add one or more existing images to the darktable library from the local filesystem. This process does not copy or move images but merely adds their details to the library database and creates XMP sidecar files for them.\nselect only new pictures Tick this box to restrict the initial selection (when the dialog is loaded) to only those images that have not already been loaded into the darktable library. If you attempt to reload existing images into the darktable library, data for those images will be reloaded from the XMP sidecar files. A button is also available at the bottom of the dialog to select only \u0026ldquo;new\u0026rdquo; images for the currently-selected folder. Note: \u0026ldquo;Add to library\u0026rdquo; does not create duplicates of your image files in a separate folder structure but processes them in-situ. The \u0026ldquo;add to library\u0026rdquo; process simply adds details of those images to darktable\u0026rsquo;s library database (and creates an XMP sidecar file if applicable) allowing the images to be viewed and developed.\nThis means that if you delete images from disk after having added them, darktable cannot access them any more. Moreover, darktable does not watch for changes in the filesystem. Any new images will not be shown until they are explicitly imported.\n🔗copy \u0026amp; import This option copies images from another location on your filesystem (including mounted storage devices) and then adds the copied images to the darktable library. Using this option, if an existing XMP sidecar file is available for the image, it will not be read or copied and a new XMP will be created.\nThe following additional options are available to control the file and directory naming of the copied files. By default, only the \u0026ldquo;import job\u0026rdquo; option is shown \u0026ndash; click on the \u0026ldquo;naming rules\u0026rdquo; label or the expander icon beside it to show additional options:\nimport job The name of the import job (populated into the $(JOBCODE) variable). override todays\u0026rsquo;s date Enter a valid date/time (in YYYY-MM-DD[Thh:mm:ss] format) if you want to override the current date/time used when expanding the variables $(YEAR), $(MONTH), $(DAY), $(HOUR), $(MINUTE) and $(SECONDS). Leave the field empty otherwise. base directory naming pattern The base directory part of the naming pattern (default $(PICTURES_FOLDER)/Darktable). Click on the icon beside the input field to choose a directory manually. sub directory naming pattern The sub directory part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(JOBCODE)). keep original filename Check this box to keep the original filename instead of using the pattern below when importing. file naming pattern The file name part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(SEQUENCE).$(FILE_EXTENSION)). keep this window open Keep the window open after the import is complete, allowing multiple imports but with different naming options. Most of these options can also be set in preferences \u0026gt; import. See this section for more information about the available variables.\n🔗copy \u0026amp; import from camera This option copies files from a connected camera to the local filesystem and then adds the copied images to the darktable library. It provides the same naming options as the \u0026ldquo;copy \u0026amp; import\u0026rdquo; dialog but does not allow places or folders to be selected.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/import/","tags":null,"title":"import"},{"categories":null,"content":"Control your camera\u0026rsquo;s live view mode.\nFunctionality such as focus control, rotation, guides and overlays are supported.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/tethering/live-view/","tags":null,"title":"live view"},{"categories":null,"content":"Create areas or locations and organize them as hierarchical tags.\nA location is shown as a shape on the map when selected. Initially each location is represented as a square or circle and can be changed to a rectangle or ellipse by adjusting the shape\u0026rsquo;s width and/or height.\nA location can also be created from an OpenStreetMap region (city/country) polygon. To achieve this, first make sure the max polygon points parameter is large enough (some country polygons use more than 150,000 points). Then select the desired location in the find location module. When the corresponding region shape is displayed, a polygon symbol becomes available in the \u0026ldquo;shape\u0026rdquo; control (see below). Select it to create the new location.\nEach location is stored as tag entry under the geotagging collection in the collections module. The pipe “|” character can be used to insert a new level (a group of locations).\n🔗module controls shape Select the circle or rectangle symbol to choose the default shape for new locations. A polygon symbol is available when a shape is displayed by the find location module. new location / new sub-location When no location is selected you can use the new location button to create a location at root level. When a location is selected use the new sub-location button to create a sub-location within the selected location. show all Show or hide all locations that lie within the visible area of the current map. 🔗actions on the locations list click Select or de-select a location. If the location is not currently visible on the map, the map is automatically centered on that location. Ctrl+click Edit the name of the location. Press Enter to save changes or Esc to close the editing window without saving. right-click Open a sub-menu which allows you to: Edit the name of the location. Delete the location. Update the filmstrip \u0026ndash; the filmstrip will be populated with all images in the selected location. Switch to the lighttable view and show a collection that contains all images in the selected location. 🔗actions on locations in the map Note: The following actions have no effect on polygon locations.\nclick and drag Move the location shape to a new position on the map. Ctrl+click or Ctrl+Shift+click Move an image or a group of images and place them inside a location shape. mouse scroll When inside a location shape (but not over an image), increase or decrease the size of that shape. When hovering over an image, cycle through the thumbnails of images located at that position on the map. When outside a location shape (and not over an image) zoom the map in or out. Shift+scroll Increase or decrease the width of the location shape. Ctrl+scroll Increase or decrease the height of the location shape. click on a location shape Select a different location when the show all checkbox is selected. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/map/locations/","tags":null,"title":"locations"},{"categories":null,"content":"As described in lua scripts, darktable provides powerful scripting capabilities to extend its functionality and integrate with other software. Many such scripts are already available. The Lua script installer module helps to install them without the need for manual configuration. The first time it is run, instructions are displayed in the module.\nFor the module to be able to install the scripts, you will need to have git installed and available on your path. You can get it from git-scm.com.\nThe officially supported scripts are documented here.\nThe module can be disabled with an option in preferences \u0026gt; lua options.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/lua-scripts-installer/","tags":null,"title":"lua scripts installer"},{"categories":null,"content":"Select preferred map data from various providers. Some will provide additional layers (satellite view etc.) which you can toggle.\n🔗module controls map source Choose the provider to source map information from. max polygon points The find location module doesn\u0026rsquo;t display polygons with more points than this for performance reasons. Usually a country polygon has between 50,000 and 150,000 points. show OSD Choose whether to display the OSD controls at the top-left of the center view. filtered images Check this box to display only the images from the current collection (those shown in the filmstrip) in the center view. Un-check the box to display all images in the current library, where those images have associated GPS data. You can also toggle this option by pressing Ctrl+S. max images The maximum number of thumbnails to display on the map. group size factor Increase or decrease the size of area that causes images to be grouped. min images per group The minimum number of images that need to be placed in the same position in order to automatically create an image group for them. thumbnail display Define what information to show on the map display thumbnails: Display image thumbnails along with a counter. count: Just display the number of images (to free space on the map). Hover over the number of images to show the corresponding thumbnail(s). A count-only marker behaves the same way as a normal image thumbnail, in terms of color coding, scrolling, drag and drop etc. none: Show nothing. You can also cycle through these options by pressing Shift+S. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/map/map-settings/","tags":null,"title":"map settings"},{"categories":null,"content":"Manage all drawn masks and shapes for the current image.\nThis module can be used to create, rename, edit and delete shapes. You can alter the shapes in a drawn mask, group shapes together, and combine them using set operators.\nThe top line of the mask manager panel contains buttons that can be used to create new shapes. These are the same as in the drawn mask interface of the processing modules.\nThe panel below these buttons displays a list of all masks and individual shapes defined for the current image.\nGroups of shapes forming a drawn mask are displayed with a headline in the form \u0026ldquo;grp \u0026lt;module_name\u0026gt;\u0026rdquo; to indicate the module in which they are used, with the constituent shapes listed below. The list of mask groups is followed by a list of all individual shapes that have been generated in the context of the current image (which also repeats the shapes that are part of a group). If a shape is in use by any drawn masks this is indicated by a symbol to the right of the shape name.\n🔗shapes By default each shape receives an automatically generated name, consisting of the shape type (\u0026ldquo;brush\u0026rdquo;, \u0026ldquo;circle\u0026rdquo;, \u0026ldquo;ellipse\u0026rdquo;, \u0026ldquo;path\u0026rdquo;, \u0026ldquo;gradient\u0026rdquo;) and an automatically-incremented integer. You can rename a shape by double-clicking on its current name. It is a good habit to give shapes and groups meaningful names, especially if you intend to reuse the same selection in different masks.\nIf any shape has a reduced opacity this will be shown to the right of the shape name. An icon representing the chosen set operator (mode) is shown to the left (except for the first shape in a group, which has no prior shape to be combined with).\nClick on a shape name to show the selected shape on the image canvas with all of its controls, allowing you to edit the properties of just that shape. This is especially useful where there are many overlapping shapes within a mask, making it difficult to select the right one with the mouse. Similarly if you select a shape on-screen from within the mask controls of a processing module, that shape will also be selected in the mask manager.\nRight-click on a shape name to show a menu containing additional options (explained below).\nNote: darktable retains all shapes that have ever been defined for the current image unless you explicitly remove them. If you choose to include develop history when exporting an image, all defined shapes will be exported with the image. Beware that if the list of shapes is very long the space required to store those shapes might exceed the size limit of certain file formats. This can cause XMP tag creation to fail during export.\n🔗masks \u0026amp; groups Drawn masks are constructed by adding a group of shapes to the image in the order that they are listed (from bottom to top \u0026ndash; the same order as processing modules are displayed). Each shape adjusts the existing mask using one of five logical set operators (see below). Because order is important it is also possible to move shapes up and down the list via the right-click menu.\nClick on the name of a group in the mask manager to expand that group, showing a list of its constituent shapes \u0026ndash; the corresponding shapes will be shown on the center image. Similarly if you choose to show a drawn mask from within a processing module, the corresponding group will be expanded within the mask manager.\nRight-click on a group name to display a menu with options to add new or existing shapes to the group, or to clean up unused shapes. You can also choose to delete the group.\nRight-click on any of the constituent shapes to control how that shape contributes to the overall group mask as follows:\nremove from group Remove the shape from the current mask. use inverted shape Invert the polarity of the selected shape. mode Choose how this shape will be combined with the preceding mask by selecting one of the five set operators defined below. The currently-selected mode is highlighted with a check mark. move up/down Move the shape up or down the list. You can also create your own groups using existing shapes by selecting the shapes you wish to group, right-clicking them and choosing \u0026ldquo;group the forms\u0026rdquo;.\n🔗properties Expand the properties section to change the properties (opacity, size, rotation, feather, hardness) of the currently selected shape(s).\nIf a group is selected, the soft limits of the sliders are automatically adjusted in an attempt to prevent irreversible distortions (where some of the shapes are clamped at their extreme values but others can still be adjusted, so that reversing the move does not return all shapes to their previous configuration). However, like any soft limits, these can be overridden (forced) if you are happy to accept the consequences.\nIf a pen (e.g. Wacom) is detected, some additional options are also displayed to control how it is used by darktable:\npressure Controls how the pressure reading of a graphics tablet impacts newly generated drawn mask brush strokes. You can control the brush width, hardness and opacity. “Absolute” control means that the pressure reading directly defines the attribute with a value between 0% and 100%. “Relative” means that the pressure reading adjusts the attribute between zero and the pre-defined default value (default off). smoothing Sets the level for smoothing of drawn mask brush strokes. Stronger smoothing leads to fewer nodes and easier editing at the expense of lower accuracy. 🔗set operators (modes) Set operators are used to define how grouped shapes are combined. In the following examples (with the exception of \u0026ldquo;sum\u0026rdquo;) we will use a mask that combines a gradient followed by a path, to demonstrate the effect of each set operator when applied to the path shape:\nAs a convention in the following explanations we say that a pixel is \u0026ldquo;selected\u0026rdquo; in a mask or shape if it has an opacity greater than zero.\nsum (default for brush shapes) The shape adds to the existing mask by increasing its opacity by the opacity of the drawn shape. This allows multiple shapes (e.g. brush strokes) with low opacity to be layered on top of one another to increase the strength of the overall mask (e.g. for dodge and burn operations). The resulting opacity of a given pixel is the sum of the opacity of the individual shapes that intersect with that pixel, up to a maximum of 100%. union (default for non-brush shapes) The shape adds to the existing mask in such a way that the resulting mask contains the pixels that are either selected in the existing mask or in the added shape. In overlapping areas the maximum value is taken: intersection The shape adds to the existing mask in such a way that the resulting mask contains only pixels that are selected in both the existing mask and the added shape. In overlapping areas the minimum value is used. In the given example we use this operator to “imprint” the path with a gradient: difference In the non-overlapping area the existing mask is unchanged. In the resulting mask, pixels are selected only if they are selected in the existing mask but not in the added shape. This set operator can be chosen if you want to “cut out” a region from within an existing selection: exclusion The resulting mask selects all pixels that are selected in the existing mask and not in the added shape or vice versa. This is equivalent to an “exclusive or”: ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/mask-manager/","tags":null,"title":"mask manager"},{"categories":null,"content":"Edit the metadata of selected images.\nMetadata is freeformat text (title, description, creator, publisher, rights etc.) that describes your images.\nWhen several images are selected having different values for a given metadata field, the module displays for that field \u0026ndash; if you choose to apply changes, these fields will not be changed. If you right-click on the field the different values are listed at the end of the contextual menu. Select one of the values in the menu to apply that value to all of the selected images \u0026ndash; the change will be saved once you press the \u0026ldquo;apply\u0026rdquo; button or the Enter/Tab key.\n🔗module controls reset Delete visible (see below) metadata from the selected images. metadata entry fields A separate field is displayed for each metadata item. Hold Ctrl while scrolling with your mouse to increase the height of a field. Press Ctrl+Enter to insert a new line. Double-click on a field\u0026rsquo;s label to delete the contents of that field. apply Apply new settings from the metadata entry fields to the selected images. 🔗keyboard You may use the keyboard to navigate and apply changes while any of the metadata entry boxes have focus:\nThe Tab key saves the current field and moves the cursor to the next field. When the last field is reached, the Tab key returns focus to the first field.\nShift+Tab works the same as Tab, but in the opposite direction.\nThe Enter key saves the current field without moving the cursor.\n🔗preferences The \u0026ldquo;preferences…\u0026rdquo; option in the presets menu brings up a dialog where you can configure how metadata is handled within darktable. For each metadata item, two check boxes allow you to restrict how metadata is handled:\nvisible Show or hide this metadata field. Hidden fields are not included in exported images. private Keep this metadata field private. Private fields are not included in exported images. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/metadata-editor/","tags":null,"title":"metadata editor"},{"categories":null,"content":"Change the order of the processing modules in the darkroom using presets.\nWhen processing an image, the active modules are applied in a specific order, which is shown in the right-hand panel of the darkroom view. This module provides information about the current ordering of the processing modules in the pixelpipe. The name of the currently-selected preset is shown in the module header (or \u0026ldquo;custom\u0026rdquo; if the user has manually modified the order). The following presets are available for selection.\nv3.0 RAW This is the default module order for scene-referred RAW development workflow. v3.0 JPEG This is the default module order for JPEG development. legacy This module order is used for the legacy display-referred workflow. You will also see this order displayed for any images you previously edited in darktable prior to version 3.0. Note: changing the order of modules in the pixelpipe is not a cosmetic change to the presentation of the GUI \u0026ndash; it has real consequences to how the image will be processed. Please do not change the order of the modules unless you have a specific technical reason and understand why this is required from an image processing perspective.\nFor more information about changing module order please refer to the pixelpipe \u0026amp; module order.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/module-order/","tags":null,"title":"module order"},{"categories":null,"content":"Zoom and pan the current image.\nThe navigation panel (displayed on the top left hand side of the darkroom) shows a full preview of the current image with a rectangle showing the area that is currently visible in the central panel. You can interact with this module using your mouse in the same way as you can interact with the main image (scroll to zoom in/out, middle-click to cycle through zoom levels, click+drag to pan). Alternatively, the current zoom scale is displayed in a combobox to the bottom-right of the preview \u0026ndash; click to choose from a number of common zoom levels or type a number to set the zoom level manually.\nThe navigation panel can be toggled on/off with a keyboard shortcut (Ctrl+Shift+N by default).\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/navigation/","tags":null,"title":"navigation"},{"categories":null,"content":"Manage settings for the print view and initiate printing.\n🔗module controls 🔗printer printer Select one of the installed printers. media The type of media loaded on the printer (Plain Paper, Luster Photo Paper, etc.). profile The printer\u0026rsquo;s ICC profile for the loaded paper. This is the profile specific to the printer and paper. This profile is the last color space transformation applied to the picture whose goal is to create a high quality print. intent The print rendering intent (“perceptual”, “relative colorimetric”, “saturation” or “absolute colorimetric”). See rendering intent for more details. black point compensation Whether to adjust the black point of the output profile, which is often lighter than the input profile. This should be “on” when the intent is set to “relative colorimetric”. 🔗page paper size The size of the paper on which to print. orientation Portrait or landscape (note that darktable chooses the best fit by default). units The unit to use for setting the margins: “mm”, “cm”, or “inch”. margins Set each margin separately, or all together by clicking on the middle “lock” button. display grid Select the grid size using the entry field (expressed in the currently selected unit). Tick the option to display the grid on the canvas. snap to grid Help setting the image areas by snapping them to the grid for proper alignment. borderless mode required Indicates whether the printer borderless mode is to be activated. This item is activated when the user\u0026rsquo;s margins are smaller than the printer hardware margins. Note that it is only an indicator as it does not activate the borderless mode automatically. 🔗image layout image width/height This information field displays the actual image width and height (given with the selected units) on the paper. scale factor This information field displays the scaling of the image to fit on the paper. If this value is less than 1 the image is down-scaled, otherwise it is up-scaled. This is an important factor to watch \u0026ndash; a value that is too large (up-scale) may result in a low quality print. The corresponding dpi (dots per inch) is also displayed. alignment Select the alignment of the image on its area. new image area button Create a new image area. Drag and drop on the canvas to place it. If the option snap to grid is activated the area can be easily aligned to the grid lines. An image can be placed into this area by dragging it from the filmstrip and dropping it on the new area. delete image area button Remove the currently selected image area from the composition. clear layout button Remove all the image areas leaving the canvas empty. The following four fields represent the position of currently selected area on the page \u0026ndash; the top/left corner on the first line and the width/height of the area on the second line.\nWhen hovering an image area its position and size are displayed. It is also possible to grab the side and corner of the area to change the size or to drag the whole area to change its position.\nThe page layout can be recorded using a preset.\n🔗print settings profile The export profile to use. This profile is the entry point used for the next transformation using the printer\u0026rsquo;s ICC profile. Usually it is better to prefer a large gamut (e.g. Adobe RGB) rather than a smaller one (e.g. sRGB). intent The rendering intent to use when exporting the image. For more information see rendering intent. style Choose a style to apply when exporting the image \u0026ndash; defaults to “none”. See the export module for a more detailed discussion of applying a style during export. mode Whether the chosen style should be appended to the existing history stack or replace it completely. See the export module for more details. 🔗print button When clicked, the images are first exported using the selected options, then composed on the page and finally sent to the printer.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/print/print-settings/","tags":null,"title":"print settings"},{"categories":null,"content":"Highlight areas of the image where color channels of the raw input file are clipped.\nClipped color channels imply an overexposed image with loss of information in the affected areas. Some of this information may be recoverable using the highlight reconstruction, color reconstruction or filmic rgb modules.\nClick on the icon to show/hide the warning overlay. Right-click on the icon to open a dialog containing the following configuration parameters.\nmode Choose how to mark clipped areas: mark with CFA color: Display a pattern of the respective primary colors (red, green, and blue) to indicate which color channels are clipped. mark with solid color: Mark clipped areas with a user defined solid color (see below) independent of the affected color channels. false color: Set clipped color channels to zero in the affected areas. color scheme Choose the solid color for the mark with solid color mode. clipping threshold Set the threshold defining what values are considered to be overexposed. You can safely leave this slider at its default value of 1.0 (white level) in most cases. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/raw-overexposed/","tags":null,"title":"raw overexposed warning"},{"categories":null,"content":"Display a list of recently used collections generated by the collections module.\nThis module may be hidden, depending on the preferences set in the collections module.\nClick on an entry to reopen the selected collection. This also updates the collections module with the appropriate filter criteria and rules.\n🔗preferences The \u0026ldquo;preferences\u0026hellip;\u0026rdquo; option in the presets menu allows you to adjust the behavior of the recent collections module as follows:\nnumber of recent collections to be stored The number of recent collections to store and display in the recent collections module (default 10) prefer a history button in the collections module Set whether you prefer to use this module or the history button in the collections module. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/recent-collections/","tags":null,"title":"recently used collections"},{"categories":null,"content":"This module provides various graphical depictions of the developed image\u0026rsquo;s light levels or chromaticity.\nHover the mouse over the module to reveal buttons that can be used to adjust the display. The buttons on the left-hand-side are used to choose the display mode, from left-to-right: vectorscope, waveform, rgb parade and histogram. The buttons on the right-hand-side control how the plot for the current scope is drawn.\nThe height of the scopes module can be changed by clicking-and-dragging on the bottom edge or by holding down Shift+Alt while scrolling the mouse. The visibility of the module can be toggled with a keyboard shortcut (default Ctrl+Shift+H).\nThe scopes module is at the top of the right-hand panel by default but can be moved to the left-hand panel with preferences \u0026gt; miscellaneous \u0026gt; position of the scopes module.\nFor performance reasons, scopes are calculated from the image preview (the image displayed in the navigation module) rather than the higher quality image displayed in the center view. The preview is calculated at a lower resolution and may use shortcuts to bypass more time-consuming image processing steps. Hence the display may not accurately represent fine detail in the image, and may deviate in other ways from the final developed image.\n🔗histogram The histogram shows the distribution of pixels by lightness for each color channel.\nThe horizontal axis runs from 0% to 100% lightness for each channel. The vertical axis gives the count of pixels having the given lightness.\nIn its default state, data for all three RGB color channels is displayed. The red, green and blue colored buttons on the right-hand-side can be used to toggle the display of each color channel.\nThe first button on the right-hand-side toggles between logarithmic and linear rendering of the vertical axis (pixel count) data.\n🔗waveform The waveform scope shows similar data to the histogram, but allows you to view that data in a spatial context.\nIn the \u0026ldquo;standard\u0026rdquo; horizontal waveform, the horizontal axis of the waveform represents the horizontal axis of the image \u0026ndash; the right-hand side of the waveform represents the right-hand side of the image and the left-hand side of the waveform represents the left-hand side of the image.\nThe vertical axis represents the distribution of pixels by lightness for each channel \u0026ndash; the dotted line at the top represents 100% lightness (values above this may be clipped), the dotted line in the middle represents 50% lightness, and the bottom of the waveform represents 0% lightness.\nThe brightness of each point on the waveform represents the number of pixels at the given position (the horizontal axis) having the given lightness (the vertical axis). The brighter the point, the more pixels at that position have that lightness.\nAs with the histogram, you can selectively display each of the red, green, and blue channels, by clicking on the appropriate buttons.\nThe first button on the right-hand-side toggles the display between horizontal (above) and vertical (below) mode:\nIn the vertical waveform, the vertical axis of the plot represents the vertical axis of the image, and the horizontal axis represents the distribution of pixels by lightness. The vertical waveform can be useful for portrait-format images, or simply to understand an image in a different way.\nSee Of Histograms and Waveforms for more on darktable\u0026rsquo;s waveform scope.\n🔗rgb parade The RGB parade scope shows the same data as the waveform, but with the red, green, and blue channels presented side-by-side.\nAs with the waveform, clicking the button on the right-hand-side of the module toggles between horizontal (above) and vertical (below) mode:\nThe RGB parade can be useful for matching the intensities of the red, green, and blue channels. It can also help to understand the differences between, and individual qualities of, each channel.\n🔗vectorscope The vectorscope shows chromaticity without regard to either lightness or spatial data.\nThe distance from the center of the graph represents chroma and the angle represents hue. Areas of the graph are colored depending on the chromaticity of the color to which they correspond in the image. The graph represents color \u0026ldquo;volume\u0026rdquo; by rendering the more frequently used colors in lighter tones.\nThe graph includes a \u0026ldquo;hue ring\u0026rdquo; representing the maximum chroma of each hue (in bounded RGB) of the current histogram profile. The RGB primary/secondary colors are marked by circles around the edge of the hue ring.\n🔗color harmony and additional vectorscope controls The vectorscope provides some additional controls beyond those provided by the other modes, which deserve separate discussion. Hovering over the scopes module while in vectorscope mode shows the following additional buttons:\nClick the right-most button to toggle the chroma scale between linear and logarithmic mode.\nClick the second-to-right-most button to toggle the color space of the vectorscope between CIELUV, JzAzBz or RYB \u0026ndash; as previously mentioned, these color spaces exclude any luminosity component in this module. The CIELUV graph will be faster to calculate, and is a well-known standard, though JzAzBz may be more perceptually accurate.\nFinally, along the left-hand edge of the module are a series of buttons that allow the selected color harmony indicator to be overlaid on the vectorscope graphic. For example, the following shows the \u0026ldquo;triad\u0026rdquo; color harmony:\nRotate the display of the overlaid harmony guides by hovering over the scopes module and scrolling with the mouse scroll wheel. Hold Ctrl while scrolling to rotate more slowly. Hold Shift while scrolling to change the area covered by the guide overlays.\nThe type and position of the chosen harmony guides is saved alongside each image\u0026rsquo;s editing data (in the XMP file and database) so can be restored whenever you return to the image for further editing.\nA full description of how to use this functionality is out of scope of this reference section, however, the following overview gives a basic guide as to how to use this mode to improve the color harmonies within the image.\nWith the global color picker, take live samples of the key colored areas of the image. The choice of these is purely artistic, depending on the feeling you wish to convey. Choose (in the global color picker) to display the chosen samples on the RYB vectorscope.\nChoose the color harmony type that you wish to implement (or the closest to the actual distribution of picked live samples). Rotate (with Ctrl+scroll) until the picked samples fall roughly inside (or near) the harmony guides.\nIf some of the picked samples fall outside of the guide lines, perform manipulations of the image\u0026rsquo;s colors until they fall within the guides. You can use any processing module to achieve this but multiple masked instances of color balance rgb usually provide the best results.\nBear in mind that these controls are provided as a basic guide to achieving color harmony \u0026ndash; do not try to force colors into the guides at the expense of the overall look of the image. For some useful examples of how to use this functionality, please see the pull request that implemented the original change.\n🔗caveats The hue ring is not a gamut check, as a color can be within the hue ring, yet out of gamut due to its darkness/lightness. When adjusting an image based upon a color checker, faster and more accurate results will come from using calibrate with a color checker in the color calibration module. The vectorscope does not have a \u0026ldquo;skin tone line\u0026rdquo;, which is a flawed generalization rather than a universal standard. The vectorscope represents a colorimetric encoding of an image, which inevitably diverges from a viewer\u0026rsquo;s perception of the image. 🔗exposure adjustment The histogram, waveform, and RGB parade scopes can be used to directly alter the exposure and black level of the exposure module.\nFor the histogram, click towards the right-hand side of the histogram and then drag right to increase or drag left to decrease the exposure. In a similar manner you can control the black level by clicking and dragging in the left-hand side.\nFor horizontal waveform and RGB parade, drag the upper portion of the scope up/down to increase/decrease exposure. Drag the lower portion up/down to increase/decrease the black level.\nFor vertical waveform and RGB parade scopes, the corresponding regions are to the right (exposure) and left (black level).\nYou can also scroll in the appropriate area \u0026ndash; rather than dragging \u0026ndash; to adjust exposure and black point. Double-click in the scope to reset the exposure module\u0026rsquo;s parameters to their defaults.\n🔗histogram profile Image data is converted to the histogram profile before the scope data is calculated. You can choose this profile by right-clicking on the soft-proof or gamut check icons in the bottom module and then selecting the profile of interest. When soft-proof or gamut check is enabled, the scope is shown in the soft proof profile.\nAs the scopes module runs at the end of the preview pixelpipe, it receives data in display color space. If you are using a display color space that is not \u0026ldquo;well behaved\u0026rdquo; (this is common for a device profile), then colors that are outside of the gamut of the display profile may be clipped or distorted.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/scopes/","tags":null,"title":"scopes"},{"categories":null,"content":"Select images in the lighttable according to simple criteria.\n🔗module controls select all Select all images in the current collection. select none De-select all images. invert selection Select all images in the current collection that are not currently selected. select film roll Select all images in the current collection that are in the same film roll as the currently-selected images. select untouched Select all images in the current collection that have not yet been developed. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/select/","tags":null,"title":"selection"},{"categories":null,"content":"Set a session jobcode to allow the creation of a new film roll.\nA session is a sequence of exposures taken in tethering mode and placed into a single film roll. A new session means the creation of a new film roll.\nThe session module allows you to set a jobcode, which can be used to create your new film roll. See preferences \u0026gt; import \u0026gt; session options for details about how to create new film rolls using the $(JOBCODE) variable in the session module.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/tethering/session/","tags":null,"title":"session"},{"categories":null,"content":"Store development snapshots and compare with the current edit.\nSnapshots can be taken at any point in the development process and later overlaid onto the current center view. This allows you to undertake a side by side comparison (by default left=snapshot, right=active edit) while you are tuning parameters of a module. It can also be combined with the history stack module to compare a snapshot against different stages of development.\nTo take a snapshot, click on the take snapshot button. Above the button you will see a list of the snapshots that have been taken for this editing session. The name of each snapshot reflects the name of the module selected in the history stack and its position at the time the snapshot was taken. You can choose your own label for a snapshot by Ctrl+clicking on the snapshot name \u0026ndash; this will be displayed after the module name, separated with a bullet.\nClick on the name of a snapshot to show it \u0026ndash; this enables a split view between the saved snapshot image and the current state of the processed image. You can control the position of the split-line by clicking and dragging the line with your mouse. If you hover over the split-line with your mouse, a small rotation icon will appear on the center of the line. Click this icon to change between vertical and horizontal split view \u0026ndash; the positions of the snapshot and current image will be rotated anti-clockwise allowing you to choose whether they appear to the top, bottom, left or right of the screen.\nAt all times, an arrow containing the letter \u0026ldquo;S\u0026rdquo; is displayed to indicate which side of the image is the snapshot and which is the current edit.\nYou can pan or zoom the image while using the snapshot view using your keyboard or mouse. To pan with the mouse you will need to hold the \u0026ldquo;a\u0026rdquo; key while clicking and dragging (this key can be configured in preferences \u0026gt; shortcuts \u0026gt; views \u0026gt; darkroom \u0026gt; force pan \u0026amp; zoom with mouse).\nClick on the name of the snapshot again to disable the overlay and return to your editing session. Click the module\u0026rsquo;s reset button to remove all existing snapshots.\nNote: Snapshots are retained for the duration of your darktable session. This means that you can also use snapshots to compare with another image. Just navigate to that image and enable the snapshot view as normal. When you do this, an arrow appears in the snapshot name to indicate it was not taken from the current image \u0026ndash; hover over the name with your mouse to see the originating image name in a tooltip.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/snapshots/","tags":null,"title":"snapshots"},{"categories":null,"content":"View your image rendered using a selected color profile.\nClick the icon to activate the soft proof display mode on your image. This allows you to preview your image rendered using a printer profile to see how colors will end up on the final print. You can also activate soft proof with the keyboard shortcut Ctrl+S. A message “soft proof\u0026quot; on the bottom left of your image tells you that you are in soft proof display mode.\nRight-click on the icon to open a dialog with the following configuration parameters. For each of these parameters, the list of available profiles is read from $DARKTABLE/share/darktable/color/out and $HOME/.config/darktable/color/out (where $DARKTABLE represents darktable\u0026rsquo;s installation directory and $HOME your home directory). Note that these color/out directories are not created by the darktable install; if you need to use one, you must create it yourself.\ndisplay profile Set the color profile for the display. The option “system display profile” is the preferred setting when working with a calibrated display. The profile is taken either from your system\u0026rsquo;s color manager or from your X display server. The method darktable uses to detect your system display profile can be changed in preferences \u0026gt; miscellaneous. For more information see the display profile section. preview display profile Set the color profile for the preview image if you are using a second window. intent Set the rendering intent for your display \u0026ndash; only available if rendering with LittleCMS2 is activated. See rendering intent for a list of available options. This option appears twice \u0026ndash; once for the \u0026ldquo;display profile\u0026rdquo; and once for the \u0026ldquo;preview display profile\u0026rdquo;. softproof profile Set the color profile for soft proofing. Typically these profiles are supplied by your printer or generated during printer profiling. histogram profile Set the color profile of the histogram. None of the available options are ideal, however, \u0026ldquo;system display profile\u0026rdquo; is probably the least bad setting, since all other profiles are derived from the display color space and at least the values will conform to what you see on screen. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/darkroom/soft-proof/","tags":null,"title":"soft proof"},{"categories":null,"content":"Create named styles from selected images\u0026rsquo; history stacks and apply styles to selected images.\nStyles can either be created within this panel or in the history stack module in the darkroom.\nA list of all available styles is displayed in the module. A search field above the list allows you to locate a style by name or description. This module also allows styles to be edited and deleted.\nDouble-click on a style name to apply that style to all selected images. A style may also be applied to all selected images by pressing a shortcut key assigned to it (see preferences \u0026gt; shortcuts) while in the lighttable or darkroom view.\nHover over the style name with your mouse to view a preview of the first selected image with that style applied.\nRemove all styles by clicking on the module\u0026rsquo;s reset button.\nPlease note that styles also include the active state of each module. You can use this to create your own default settings, which you can then activate on-demand. Simply set your desired defaults for each module, disable the module, and save the style.\n🔗module controls create duplicate When applying a style to images, tick this box to create a duplicate of each image before applying the chosen style to that duplicate. Disable this option to apply the chosen style directly to the selected images. Beware that in this case any existing history stack is overwritten (depending on the mode \u0026ndash; see below) and cannot be recovered. mode As with the history stack module, this combobox allows you to either \u0026ldquo;append\u0026rdquo; the style to the current history stack or to \u0026ldquo;overwrite\u0026rdquo; the history stack of the target image. create Create new style(s) using the history stack of the selected image(s). For each selected image a style creation window is shown. You must supply a unique name for each new style and you can also add an optional description. You will be provided with the option to select which history stack items you want to include in the created style. For any module, you may also choose to \u0026ldquo;reset\u0026rdquo; that module\u0026rsquo;s parameters \u0026ndash; this will cause the module to be included in the style but with all controls set to their initial (default) state (as if you had clicked the module reset button).\nThe panel supports a hierarchical view, meaning that you can create categories using the pipe symbol “|” as a separator. For example “print|tone curve +0.5 EV” will create a \u0026ldquo;print\u0026rdquo; category with a style of \u0026ldquo;tone curve +0.5 EV\u0026rdquo; below it.\nedit Select \u0026ldquo;edit\u0026rdquo; to bring up a dialog which allows you to include or exclude specific items from the stack of an existing style. Check the “duplicate” option if you want to create a new style, instead of overwriting the existing one, in which case you will need to provide a unique name for the new style. remove Delete the selected style, without any further prompt. import Import a previously saved style. Styles are stored as XML files with the extension .dtstyle. If a style with the same name already exists, you will be asked if you wish to overwrite. export Save the selected style to disk as a .dtstyle file. This allows styles to be published and shared with other users. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/styles/","tags":null,"title":"styles"},{"categories":null,"content":"Manage tags attached to images.\nTags provide a means of adding information to images using a keyword dictionary. You can also manage tags as a hierarchical tree, which can be useful when their number becomes large.\nTags are physically stored in XMP sidecar files as well as in darktable\u0026rsquo;s library database and can be included in exported images.\n🔗definitions The following definitions assume that you have set up a single tag named \u0026ldquo;places|France|Nord|Lille\u0026rdquo;.\ntag A tag is a descriptive string that may be attached to an image. A tag can be a single term or a sequence of connected terms forming a path, separated by the pipe symbol. For example, \u0026ldquo;places|France|Nord|Lille\u0026rdquo; defines a single tag, where each term in the path forms a smaller subset of those before it. You can attach as many tags to an image as you like. You can assign properties (name, private, category, synonyms and image order) to a tag.\nnode Any path that forms part of a tag is a node. In the above example, \u0026ldquo;places\u0026rdquo;, \u0026ldquo;places|France\u0026rdquo;, \u0026ldquo;places|France|Nord\u0026rdquo; and \u0026ldquo;places|France|Nord|Lille\u0026rdquo; are all nodes. In the hierarchical tree view, the nodes form the branches and leaves of the tree. free node Any node that is not explicitly defined as a tag is called a free node. In the above example, \u0026ldquo;places\u0026rdquo;, \u0026ldquo;places|France\u0026rdquo; and \u0026ldquo;places|France|Nord\u0026rdquo; are all free nodes. You cannot set any properties, except “name”, for a free node and you cannot add a free node to an image. See the “multiple tags” section below for more information. category Any tag can be flagged by the user as being a “category”. 🔗multiple tags The above definitions considered a simple example – a single tag and its properties. Consider instead the scenario where the following four pipe-delimited tags are each separately defined in darktable.\nplaces|France|Nord|Lille places|France|Nord places|France places|England|London In this case the nodes are\nplaces places|France places|France|Nord places|France|Nord|Lille places|England places|England|London The only free nodes are \u0026ldquo;places\u0026rdquo; and \u0026ldquo;places|England\u0026rdquo;. Both of these free nodes are also (by implication) categories.\nYou can attach any of these tags to any image. Any tags attached to an image, except category tags, can be included when that image is exported.\nIf you attach the \u0026ldquo;places|France|Nord|Lille\u0026rdquo; tag to an image, the \u0026ldquo;places|France|Nord\u0026rdquo; and \u0026ldquo;places|France\u0026rdquo; tags are also implicitly attached to that image (you don’t need to attach them manually). Note that this is only true here because those additional tags have been separately defined \u0026ndash; the \u0026ldquo;places\u0026rdquo; node is not included because it is a \u0026ldquo;free node\u0026rdquo; (not a tag).\n🔗module sections The tagging module consists of two sections\nThe upper attached tags section (with the attach/detach buttons under it)\nThe lower tag dictionary section (with the new/import\u0026hellip;/export\u0026hellip; buttons under it)\n🔗attached tags section The attached tags section displays tag(s) attached to image(s), where those images are\nunder your mouse cursor (if hovering over an image in the lighttable view); or\ncurrently selected (if not hovering over an image)\nAutomatically generated darktable tags (with names starting “darktable|”) cannot be selected.\nAt the bottom of the attached tags section are the following buttons, from left to right:\nattach If a tag is selected in the tag dictionary section, attach this tag to the selected images. detach If a tag is selected in the attached tags list, detach that tag from the selected images. A tag can also be detached if you right click on the tag name and select detach from the pop-up menu. hidden tags Choose whether to view any hidden tags that darktable has automatically attached to the selected images. sort Choose whether to sort the attached tags list alphabetically or by the count shown in brackets next to the tag (this count indicates how many of the selected images have that tag attached to them). parents Choose whether or not to show the parent categories of the tag. You can adjust the height of the attached tags window by holding Ctrl and scrolling with your mouse wheel.\n🔗tag dictionary section The tag dictionary section displays all of the tags that are available in darktable\u0026rsquo;s database. At the top of the tag dictionary section is a text box where tag names can be entered. Below this is a list of available tags, which may also include indicator symbols to the left of the tag names. The meanings of these symbols are as follows:\na check mark [✓] indicates that the tag is attached to all of the selected images\na minus sign [\u0026ndash;] indicates that the tag is attached to at least one of the selected images. If the symbol is next to a node name in the hierarchical tree view, it means that one of the child tags under that node is attached to at least one of the selected images.\nif no indicator symbol is present, this means that the tag is not attached to any of the selected images, or that the node has no child tags attached to any of the selected images.\nIn the hierarchical tree view, a name in italics represents either a free node or a category.\nBelow the tag dictionary list are the following buttons, from left to right:\nnew Create a new tag, using the name that has been entered into the text entry box at the top of the tag dictionary section. import\u0026hellip; Import tags from a Lightroom keyword file. export\u0026hellip; Export all tags to a Lightroom keyword file. suggestions Show a list of suggested keywords based on the keywords already associated with the selected images (see the preferences section). CAUTION: This view queries the database so might be slow. list/tree Toggle the display of tags between the straight list view and hierarchical tree view. You can adjust the height of the tag dictionary window by holding Ctrl while scrolling with your mouse wheel.\n🔗usage The following sections describe the operations that can be performed with tags.\n🔗text entry The text entry box (shown under the attach/detach buttons) has multiple purposes.\nIf the tag dictionary list is in list view mode (rather than tree view mode), then typing the first few characters of a tag will bring up a list of suggestions. You can then scroll down with the arrow keys and press Enter to select one of the suggestions. Pressing Enter a second time will attach it to the selected images. You can also edit the name of the tag before pressing Enter \u0026ndash; in this case the tag will be created if it doesn\u0026rsquo;t already exist in the database.\nTyping some partial text into the text entry box allows you filters the set of tags shown in the tag dictionary window to those whose name or synonym matches the entered text. Press Enter to attach a tag with the entered name to the selected images. If that tag name does not yet exist in the database, it will be created before being attached.\nThe pop-up menu entry “copy to entry” can be used to copy a selected tag to the text entry box. You can then edit this name and press Enter to create a new tag with that name, making it easy to create multiple tags with similar names.\n🔗create tag There are several ways to create a new tag:\nImport a text file. You can import one or more text files in the Lightroom tagging file format. You can also export your tags, edit the exported file, then re-import it. The import function updates existing tags and creates new tags as required. If you change the name of a tag in an imported file, it will be treated as a new tag.\nImport already-tagged images. This method does not offer any flexibility to change tag names or categories during the import process.\nUse the “create tag” sub-menu. A tag can be created manually, under an existing one (hierarchical) or at the root level.\nUse the “set as a tag“ sub-menu. You can set a free node (e.g. ”places|England”) as a tag so that it gets implicitly attached to all images tagged with its sub-tags (e.g. ”places|England|London”).\nType into the text box and press the “new” button or the Enter key. Hierarchical tags are created using the pipe symbol “|” to separate nodes. Note that the entered tag is also attached to any selected images.\nA number of tags are automatically generated by darktable when certain actions are undertaken. For example, the tags “darktable|exported” and “darktable|styles|your_style” can be used to identify images that have been exported and had styles applied, respectively.\n🔗edit/rename tag The tag dictionary can be maintained via the \u0026ldquo;edit\u0026hellip;\u0026rdquo; and \u0026ldquo;change path\u0026hellip;\u0026rdquo; items in the right-click pop-up menu.\nThe \u0026ldquo;edit\u0026hellip;\u0026rdquo; operation allows you to change the name of a tag, though you cannot change which node it belongs to (you cannot use the pipe \u0026ldquo;|\u0026rdquo; symbol in the tag name field). The command is aborted if you try to enter a tag name that already exists. You can set the private and category flags and define synonyms for the tag (see below). These attributes are recorded in the XMP-dc Subject and XMP-lr Hierarchical Subject metadata entries, respectively. You can control which tags are included in exports by changing settings in the export module.\nA tag set as “private” is, by default, not exported.\nA tag set as “category” is not exported in XMP-dc Subject. However it is exported in XMP-lr Hierarchical Subject as this XMP metadata holds the organization of your tags.\n“synonyms” enrich the tag information and are mainly used to assist search engines. For example “juvenile”, “kid” or “youth” can be set as synonyms of “child”. Synonyms can also be used to translate tag names to other languages.\nThe \u0026ldquo;change path\u0026hellip;\u0026rdquo; operation is only available in the tree view mode, and it shows the number of tagged images which would be impacted by a change to the name of this node. The change path window lets the user change the full path of the node, including the nodes to which it belongs (nodes can be specified using the pipe \u0026ldquo;|\u0026rdquo; symbol). This operation is powerful, but please take care as it can have a significant impact on the metadata of your images. The operation is aborted if the requested change causes a conflict with an existing tag.\nA quick way to organize the tag structure is to drag and drop the nodes. In the tree view mode, you can drag any node and drop it on top of any other node. The first node and its descendants, if any, become descendants of the second node. Dragging over a node automatically opens that node (to avoid opening a node, drag over the node selection indicator instead). To place a node at the root level, drag it onto the top of the tagging window. If the requested change causes a conflict with an existing tag, the operation is aborted.\n🔗attach tag There are a number of ways to attach an existing tag to a group of selected images:\nclick on a tag in the tag dictionary window to select it, then click on the attach button. right-click on a tag in the tag dictionary window, to show a pop-up menu, then select the “attach tag” menu item. double-click on a tag in the tag dictionary window. right-click on a tag shown in the attached tags view to show a pop-up menu. If some of the selected images do not currently have that tag, the \u0026ldquo;attach tag to all\u0026rdquo; menu item can be used to attach that tag to all the selected images. Type into the text box and press the \u0026ldquo;new\u0026rdquo; button or the Enter key. This will create the tag if it doesn\u0026rsquo;t already exist, and attach it to the selected images. Press Ctrl+T to open a small text box at the bottom of the central view of the lighttable. Type in the name of a tag and press Enter. The tag will be created if it doesn\u0026rsquo;t exist, and attached to all the selected images. Drag an image or group of images and drop it onto the desired tag. When hovering over the images in the ligthtable you can check which tags are attached to the image, either by looking at the attached tags window in the tagging module, or in the tags attribute in the image information module.\n🔗detach tag There are several ways to remove a tag from a group of selected images:\nclick on a tag in the attached tag window of the tagging module to select the tag, then click on the detach button. double-click on a tag in the attached tag window. right-click on a tag in the attached tag window, to show a pop-up menu, and select \u0026ldquo;detach\u0026rdquo;. 🔗delete tag It is possible to completely remove a tag from all images (whether selected or not) and delete the tag from the database. Because this could impact a large number of images, a warning will be displayed indicating how many images currently have this tag attached. Take this warning seriously as there is no way to undo this action (except by restoring your database and/or XMP sidecar files from a backup). A tag in tag dictionary window can be deleted in the following ways:\nright-click on a tag in the tag dictionary window, to show a pop-up menu, and choose \u0026ldquo;delete tag\u0026rdquo;. right-click on a branch node in the tag dictionary window, to show a pop-up menu, and choose \u0026ldquo;delete node\u0026rdquo; to delete the selected node together with any child nodes. 🔗import / export The “import” button allows you to choose a text file (which must comply with the Lightroom tag text file format) and import its content. If a tag in the imported file already exists, its properties will be updated, otherwise a new tag will be created.\nThe “export” button exports your entire tag dictionary into a text file of your choice (Lightroom tag text file format).\n🔗keyboard The following keys can be used within the tagging module:\nThe Tab key can be used to navigate between the attached tags view, the text entry box, and the tag dictionary view. Pressing Tab from within the text entry field selects the first matching tag in the tag dictionary view (if any).\nThe Down arrow key is equivalent to the Tab key, when pressed while inside the text entry field.\nShift+Tab does the same as the Tab key but navigates in the opposite direction. Pressing Shift+Tab from within the text entry field selects the first user tag in the attached tags view (if any).\nThe Enter key can be used within the tag dictionary view to attach the selected tag, keeping focus on the attached tag (similar to when a tag is attached using the mouse).\nPressing Shift+Enter from within the tag dictionary view returns focus to the text entry field.\nThe Delete / BackSpace keys can be used within the attached tags view to detach the selected tag.\n🔗navigation To see the images bearing a particular tag in the tag dictionary window, right-click on the tag name and choose \u0026ldquo;go to tag collection\u0026rdquo; in the resulting pop-up menu. This opens a collection in the collections module showing all images containing this tag. You can also select other tags in the collections module by double-clicking on the collection for the other tag.\nTo return to the collection that was selected before opening a tag collection select the \u0026ldquo;go back to work\u0026rdquo; item from the pop-up menu. This will allow you to return to the original collection, as long as you haven\u0026rsquo;t selected any other collections in the meantime.\n🔗preferences The \u0026ldquo;preferences…\u0026rdquo; option in the presets menu brings up a dialog where you can tweak the behavior of the tag suggestions list. The tag suggestions list comprises two parts, with the best-matched tags on one side and the most-recently-attached tags on the other. The following options are available:\nsuggested tags level of confidence Level of confidence used to include the tag in the suggestions list (default 50): 0: display all associated tags, 99: match tags with a 99% confidence level, 100: this is essentially an unreachable level of confidence and so returns no matching tags. Use 100% to disable the best-matched tag suggestion list (faster). number of recently attached tags Number of recently attached tags to include in the suggestions list (default 20). A value of \u0026ldquo;-1\u0026rdquo; can be used to disable the the most-recently-attached suggestions list. ","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/shared/tagging/","tags":null,"title":"tagging"},{"categories":null,"content":"View your images by the date/time they were taken.\nIn the lighttable filemanager view, you can show/hide the timeline module in the bottom panel with the shortcut Ctrl+F.\nWithin the timeline, you can show the next and previous dates by scrolling your mouse; Ctrl+scroll to zoom in/out.\nYou can also use the timeline to select images by date range by clicking and dragging your mouse.\n","date":"0001-01-01T00:00:00Z","href":"/dtdocs/en/module-reference/utility-modules/lighttable/timeline/","tags":null,"title":"timeline"}] \ No newline at end of file diff --git a/en/index.xml b/en/index.xml new file mode 100644 index 0000000000..f94bd7707d --- /dev/null +++ b/en/index.xml @@ -0,0 +1,1712 @@ + + + + darktable on darktable user manual + https://darktable-org.github.io/dtdocs/en/ + Recent content in darktable on darktable user manual + Hugo + en + + + astrophoto denoise + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/astrophoto-denoise/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/astrophoto-denoise/ + Remove image noise while preserving structure. This is accomplished by averaging each pixel with some surrounding pixels in the image. The weight of such a pixel in the averaging process depends on the similarity of its neighborhood with the neighborhood of the pixel being denoised. A patch with a defined size is used to measure that similarity. As denoising is a resource-intensive process, it slows down pixelpipe processing significantly. Consider activating this module late in your workflow. + + + base curve + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/base-curve/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/base-curve/ + Simulate the in-camera JPEG by applying a characteristic base curve to the image. darktable comes with a number of base curve presets that attempt to mimic the curves of various camera manufacturers. These presets are automatically applied according to the manufacturer ID found in the image&rsquo;s Exif data. Camera-specific base curve presets are also available for some camera models. This module will be enabled by default if preferences &gt; processing &gt; auto-apply pixel workflow defaults is set to &ldquo;display-referred&rdquo;. + + + bloom + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/bloom/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/bloom/ + Create a soft bloom effect. This module works by blurring the highlights and then blending the result with the original image. Note: This module performs blurs in Lab color space, and is no longer recommended. Instead, use the tone equalizer module or the exposure module with a parametric mask. 🔗module controls size The spatial extent of the bloom effect. threshold The threshold for the brightness increase. strength The strength of the overlighting. + + + blurs + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/blurs/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/blurs/ + Simulate physically-accurate blurs in scene-referred RGB space. 🔗blur types Three types of blur are provided: lens blur: Simulates a lens diaphragm with a configurable number of blades and blade curvature to create synthetic bokeh. motion blur: Simulates the effect of camera motion with a configurable path. gaussian blur: This is not really an optical blur but can be used for denoising or for creative effects using blend modes A diagram at the top of the module shows the shape of the blurring operator (known as the point spread function). + + + censorize + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/censorize/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/censorize/ + Degrade parts of the image in an aesthetically pleasing way, in order to anonymize people/objects or hide body parts. Censorize works in linear RGB color space to apply a physically-accurate gaussian blur and gaussian luminance noise. Aside from anonymization, this module can also be used for a wide range of creative purposes, for example: Combine a simple blur with a multiply blend mode to create a realistic bloom (Orton effect). Combine a simple blur with a subtract blending mode and low opacity to create an unsharp mask, similar to the sharpen module but in an RGB scene-referred space. + + + chromatic aberrations + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/chromatic-aberrations/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/chromatic-aberrations/ + Correct chromatic aberrations. In contrast to the raw chromatic aberrations module, this module does not require raw data as input. 🔗workflow To obtain the best result, you are advised to proceed as follows: Attenuate the chromatic aberrations as much as possible in the lens correction module using the TCA sliders. Increase the strength slider in this module to better see its effect. Increase the radius until the chromatic aberrations disappear. If this is insufficient, try enabling the &ldquo;very large chromatic aberrations&rdquo; setting. + + + color balance + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance/ + A versatile tool for adjusting the image&rsquo;s color balance. This module can be used to revert parasitic color casts or to enhance the visual atmosphere of an image using color grading, a popular technique in the cinema industry. For scene-referred workflow, you should consider using the improved color balance rgb module instead. 🔗overview The color balance module allows you to shift colors selectively by luminance range (shadows, mid-tones, and highlights). It can do this using two different methods: + + + color balance rgb + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance-rgb/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance-rgb/ + An advanced module which brings color-grading tools from cinematography into the photographic scene-referred pipeline. This module is not suitable for beginners with no prior knowledge of color theory, who might want to stick to the global chroma and global vibrance settings until they have a good understanding of the dimensions of color. 🔗introduction Color-grading is an important part of image editing. It can help to remove unwanted color casts and can also deliver a creative color twist that will add atmosphere to your images. + + + color calibration + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-calibration/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-calibration/ + A fully-featured color-space correction, white balance adjustment and channel mixer module. This simple yet powerful module can be used in the following ways: To adjust the white balance (chromatic adaptation), working in tandem with the white balance module. Here, the white balance module makes some initial adjustments (required for the demosaic module to work effectively), and the color calibration module then calculates a more perceptually-accurate white balance after the input color profile has been applied. + + + color contrast + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-contrast/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-contrast/ + A simplified control for changing the contrast or separation of colors between the green/magenta and blue/yellow axes in Lab color space. Higher values increase color contrast, lower values decrease it. 🔗module controls green-magenta contrast Change the green-magenta color contrast. This is equivalent to raising or lowering the steepness of the a* curve in Lab. Lower values desaturate greens and magenta, while higher values increase their saturation. blue-yellow contrast Change the blue-yellow color contrast. + + + color correction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-correction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-correction/ + Modify the global image saturation to give the image a tint or as an alternative method to split-tone the image. Note: Use the color balance rgb module for color modifications. 🔗module controls color board For split toning move the white dot to the desired highlight tint and then select a tint for shadows with the dark spot. For a simple global tint set both spots to the same color. saturation Correct the global saturation. + + + color equalizer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-equalizer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-equalizer/ + Selectively adjust the hue, saturation, and/or brightness of pixels based on their current hue. This module is an attempt to recreate some of the functionality of the color zones module in the scene-referred part of the pipeline whilst overcoming some of that module&rsquo;s limitations. Specifically, the color zones module is prone to increase chroma/luma noise, and introduce artefacts or harsh transitions. These are somewhat mitigated within color equalizer with the following additions: + + + color look up table + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-look-up-table/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-look-up-table/ + A generic color look up table implemented in Lab space. The input to this module is a list of source and target points and the complete mapping is interpolated using splines. The resulting look up tables (LUTs) are editable by hand and can be created using the darktable-chart utility to match given input (such as hald-cluts and RAW/JPEG with in-camera processing pairs). See using darktable-chart for details. 🔗module controls color board The color board grid shows a list of colored patches. + + + color mapping + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-mapping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-mapping/ + Transfer the look and feel of one image to another. This module statistically analyses the color characteristics of a source and target image. The colors of the source image are then mapped to corresponding colors on the target image. Two steps are required to use this module: Open the source image in the darkroom view and acquire its color characteristics by pressing the “acquire as source” button. A set of color clusters is generated and displayed in the “source clusters” area. + + + color reconstruction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-reconstruction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-reconstruction/ + Recover color information in blown-out highlights. Due to the nature of digital sensors, overexposed highlights lack valid color information. Most frequently they appear neutral white or exhibit some color cast, depending on what other image processing steps are involved. This module can be used to “heal” overexposed highlights by replacing their colors with better fitting ones. The module acts on pixels whose luminance exceeds a user-defined threshold. Replacement colors are taken from neighboring pixels. + + + color zones + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-zones/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-zones/ + Selectively adjust the lightness, chroma and hue of pixels based on their current lightness, chroma and hue. This module works in CIE LCh color space, which separates pixels into lightness, chroma and hue components. It allows you to manipulate the lightness, chroma and hue of targeted groups of pixels through the use of curves. You first need to choose whether you wish to adjust (select) pixels based on their lightness, chroma or hue. + + + colorize + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/colorize/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/colorize/ + Add a solid layer of color to the image. 🔗module controls hue The hue of the color layer. saturation The saturation of shadow tones. lightness The lightness of the color layer. source mix Controls how the lightness of the input image is mixed with the color layer. Setting this to zero will result in a uniformly colored plane. + + + composite + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/composite/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/composite/ + Create a composite image by overlaying an already-processed image on top of the current image. Drag and drop a processed image from the filmstrip onto the &ldquo;drop image from filmstrip here&rdquo; box to overlay the chosen image, and then alter the various placement and adjustment attributes of the image being overlaid. The full history stack of the overlayed image is used by the module, so if you want to drastically change the overlaid image beyond the controls of this module, you should first edit that image separately. + + + contrast equalizer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-equalizer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-equalizer/ + Adjust luminance and chroma contrast in the wavelet domain. This versatile module can be used to achieve a variety of effects, including bloom, denoise, clarity, and local contrast enhancement. It works in the wavelet domain and its parameters can be tuned independently for each wavelet detail scale. The module operates in CIE LCh color space and so is able to treat luminosity and chromaticity independently. A number of presets are provided, which should help you to understand the capabilities of the module. + + + crop + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop/ + Crop an image using on-screen guides. This module appears later in the pipeline than the deprecated crop and rotate module, meaning that the full image can remain available for source spots in the retouch module. For best results, you are advised to use the rotate and perspective module to perform rotation and perspective correction (if required), and then perform final creative cropping with this module. Whenever this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines. + + + darktable + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable/ + The darktable binary starts darktable with its GUI and full functionality. This is the standard way to use darktable. darktable can called with the following command line parameters: darktable [-d {all,act_on,cache,camctl,camsupport,common,control, dev,expose,fswatch,imageio,input,ioporder,lighttable,lua, masks,memory,nan,opencl,params,perf,pipe,print,pwstorage, signal,sql,tiling,undo,verbose}] [--d-signal &lt;signal&gt;] [--d-signal-act &lt;all,raise,connect,disconnect,print-trace&gt;] [--disable-pipecache] [&lt;input file&gt;|&lt;image folder&gt;] [--version] [--disable-opencl] [--configdir &lt;user config directory&gt;] [--library &lt;library file&gt;] [--datadir &lt;data directory&gt;] [--moduledir &lt;module directory&gt;] [--tmpdir &lt;tmp directory&gt;] [--cachedir &lt;user cache directory&gt;] [--localedir &lt;locale directory&gt;] [--luacmd &lt;lua command&gt;] [--noiseprofiles &lt;noiseprofiles json file&gt;] [--conf &lt;key&gt;=&lt;value&gt;] [-t &lt;num openmp threads&gt;] All parameters are optional. + + + demosaic + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/demosaic/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/demosaic/ + Control how raw files are demosaiced. 🔗bayer filters The sensor cells of a digital camera are not color-sensitive &ndash; they are only able to record different levels of lightness. In order to obtain a color image, each cell is covered by a color filter (red, green or blue) that primarily passes light of that color. This means that each pixel of the raw image only contains information about a single color channel. + + + denoise (profiled) + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/denoise-profiled/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/denoise-profiled/ + An easy to use and highly efficient denoise module, adapted to the individual noise profiles of a wide range of camera sensors. One issue with a lot of denoising algorithms is that they assume that the variance of the noise is independent of the luminosity of the signal. By profiling the noise characteristics of a camera&rsquo;s sensor at different ISO settings, the variance at different luminosities can be assessed, and the denoising algorithm can be adjusted to more evenly smooth out the noise. + + + developing monochrome images + https://darktable-org.github.io/dtdocs/en/guides-tutorials/monochrome/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/guides-tutorials/monochrome/ + Photography has a long history of producing monochrome images, and many still enjoy this aspect of photography. While there are some specialized/modified cameras with a truly monochrome sensor, most still use a regular camera to capture a color image and transform it into a monochrome image during post-processing. There are two main approaches to this conversion: A physical approach, where we attempt to simulate how a silver-based photographic film emulsion would react to the light captured at the scene. + + + diffuse or sharpen + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/diffuse/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/diffuse/ + Diffusion is a family of physical processes by which particles move and spread gradually with time, from a source that generates them. In image processing, diffusion mostly occurs in two places: diffusion of photons through lens glass (blur) or humid air (hazing), diffusion of pigments in wet inks or watercolors. In both cases, diffusion makes the image less sharp by &ldquo;leaking&rdquo; particles and smoothing local variations. The diffuse or sharpen module uses a generalized physical model to describe several kinds of diffusion, and can be used by image makers to either simulate or revert diffusion processes. + + + dither or posterize + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/dither-or-posterize/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/dither-or-posterize/ + This module eliminates some of the banding artifacts that can result when darktable&rsquo;s internal 32-bit floating point data is transferred into discrete 8-bit or 16-bit integer output format for display or export. It can also be used for creative posterization effects. Although not an inherent problem in any of darktable&rsquo;s modules, some operations may provoke banding if they produce a lightness gradient in the image. To mitigate possible artifacts you should consider activating dithering when using the vignetting or graduated density modules. + + + enlarge canvas + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/enlarge-canvas/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/enlarge-canvas/ + Increase the size of the image canvas and fill the additional area with the selected color. 🔗module controls percent left The amount of enlargement to the left of the image. percent right The amount of enlargement to the right of the image. percent top The amount of enlargement to the top of the image. percent bottom The amount of enlargement to the bottom of the image. color The color with which to fill the additional area. + + + exposure + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/exposure/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/exposure/ + Increase or decrease the overall brightness of an image. This module has two modes of operation: manual Set the exposure and black level manually automatic (RAW images only) Use an analysis of the image&rsquo;s histogram to automatically set the exposure. Darktable automatically selects the exposure compensation that is required to shift the selected percentile to the selected target level (see definitions below). This mode is particularly useful for automatically altering a large number of images to have the same exposure. + + + filemanager + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/filemanager/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/filemanager/ + In the default mode images are displayed in a grid with an adjustable number of images per row. 🔗controls zoom The number of images in each row can be altered using the slider in the bottom panel, or by holding Ctrl while scrolling over the center view with your mouse. navigate You can navigate through the images using the arrow keys (←/→/↑/↓) or by scrolling with your mouse. Press the Home key to scroll to the top of the collection, the End key to scroll to the bottom, and PageUp/PageDown to scroll up/down by a page. + + + filmic rgb + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/filmic-rgb/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/filmic-rgb/ + Remap the tonal range of an image by reproducing the tone and color response of classic film. This module can be used either to expand or to contract the dynamic range of the scene to fit the dynamic range of the display. It protects colors and contrast in the mid-tones, recovers the shadows, and compresses bright highlights and dark shadows. Highlights will need extra care when details need to be preserved (e. + + + framing + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/framing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/framing/ + Generate a frame around the image. The frame consists of a border (with a user-defined color) and a frame line within that border (with a second user-defined color). Various options are available to control the geometry and color of the frame. 🔗module controls border size The size of the frame as a percentage of the underlying full image. aspect The aspect ratio of the final module output (i.e. the underlying image plus the frame). + + + graduated density + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/graduated-density/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/graduated-density/ + Simulate a graduated density filter in order to correct exposure and color in a progressive manner. A line is shown on screen allowing the position and rotation of the gradient to be modified with the mouse. This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate these issues. 🔗module controls density Set the density of the filter (EV). A low value underexposes slightly whereas a high value creates a strong filter. + + + grain + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/grain/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/grain/ + Simulate the grain of analog film. The grain is processed on the L channel of Lab color space. 🔗module controls coarseness The grain size, scaled to simulate an ISO number. strength The strength of the effect. + + + haze removal + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/haze-removal/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/haze-removal/ + Automatically reduce the effect of dust and haze in the atmosphere. This module may also be employed more generally to give pictures a color boost specifically in low-contrast regions of the image. Haze absorbs light from objects in the scene but it is also a source of diffuse background light. The haze removal module first estimates, for each image region, the amount of haze in the scene. It then removes the diffuse background light according to its local strength and recovers the original object light. + + + highlight reconstruction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highlight-reconstruction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highlight-reconstruction/ + Attempt to reconstruct color information for pixels that are clipped in one or more RGB channel. 🔗clipping Clipping occurs when the amount of captured light exceeds either the capacity of a camera&rsquo;s sensor to record that light (photosite saturation) or the capacity of the Raw file to store it (digital clipping). Once a pixel is clipped we can no longer know the precise brightness of that pixel &ndash; only that it is equal to or greater than the maximum value that pixel can store. + + + highpass + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highpass/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highpass/ + A high pass filter. This module is primarily intended to be used in combination with a blend mode. For example, try using the module with a blend mode of &ldquo;soft light&rdquo; for high pass sharpening. Note: This module performs blurs in Lab color space, which can result in undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for fine sharpness or the local contrast module for general sharpness. + + + hot pixels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/hot-pixels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/hot-pixels/ + Automatically detect and eliminate hot pixels. Hot pixels are pixels which have failed to record a light level correctly. Detected hot pixels are replaced by an average of their neighbors. 🔗module controls threshold How strong a pixel&rsquo;s value needs to deviate from that of its neighbors to be regarded as a hot pixel. strength The blending strength of the hot pixels with their surrounding. detect by 3 neighbours Extend the detection of hot pixels &ndash; regard a pixel as hot if a minimum of only three (instead of four) neighbor pixels deviate by more than the threshold level. + + + input color profile + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/input-color-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/input-color-profile/ + Define how darktable will interpret the colors of the image. This module takes the color space used by the image source (e.g. camera, scanner) and converts the pixel encodings to a standardized working color space. This means that subsequent modules in the pipeline don&rsquo;t need to be concerned with the specifics of the input device, and can work with and convert to/from a common working color space. Where an image has been captured in a raw file, the input color profile module will normally apply either a standard or enhanced color matrix specific for that camera model, which will be used to map the colors into the working profile color space. + + + introduction + https://darktable-org.github.io/dtdocs/en/overview/workflow/introduction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/introduction/ + This section is intended to provide you with a flavor of what darktable can do and offer a suggested end-to-end processing workflow. New users should start by working through this introduction and following the links provided for further details. Please note that this is not an exhaustive guide and many useful topics are not covered. You are advised to read through the reference sections of this manual once you are familiar with the basics. + + + lens correction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lens-correction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lens-correction/ + Automatically correct for (or simulate) lens distortion, transverse chromatic aberrations (TCA) and vignetting. You can choose to either use lens correction data embedded in your Raw file (where present/supported) or correction data provided by the external Lensfun library. Additional controls are also provided for manual vignetting correction, in case the profiles for your lens are insufficient or missing. Note that if TCA correction is enabled in this module, also using raw chromatic aberrations may cause artifacts from over-correction. + + + liquify + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/liquify/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/liquify/ + Move pixels around by applying freestyle distortions to parts of the image using points, lines and curves. As you might want to use source data from any part of the image you will be shown the uncropped image (possibly with the cropping rectangle overlaid as a guide) while the module is active. 🔗nodes Each of liquify&rsquo;s tools is based on nodes. A point consists of a single node and a line or curve consists of a sequence of linked nodes defining a path. + + + local contrast + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/local-contrast/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/local-contrast/ + Enhance the image&rsquo;s local contrast. This is achieved using either a local laplacian (default) or unnormalized bilateral filter. Both modes work exclusively on the L channel from Lab. The local laplacian filter has been designed to be robust against unwanted halo effects and gradient reversals along edges. 🔗module controls mode Choice of local laplacian filter or bilateral grid. The following sections define the controls available for each of these modes. 🔗bilateral grid coarseness Adjust the coarseness of the details to be adjusted. + + + lowlight vision + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowlight-vision/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowlight-vision/ + Simulate human lowlight vision. This module can also be used to perform a day-to-night conversion. The idea is to calculate a scotopic vision image, which is perceived by the rods rather than the cones in the eyes under low light. Scotopic lightness is then mixed with photopic value (regular color image pixel) using some blending function. This module can also simulate the Purkinje effect by adding some blueness to the dark parts of the image. + + + lowpass + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowpass/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowpass/ + Apply a low pass filter (for example, a Gaussian blur) to the image, while controlling the output contrast and saturation. This module is primarily intended to be used in combination with a blend mode. For example, try using the local contrast mask preset with the overlay blend mode. Note: This module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for blurring or the tone equalizer module for dynamic range compression. + + + LUT 3D + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lut-3d/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lut-3d/ + Transform RGB values with a 3D LUT file. A 3D LUT is a tridimensional table that is used to transform a given RGB value into another RGB value. It is normally used for film simulation and color grading. This module accepts .cube, .3dl, .png (haldclut) and .gmz files. Uncompressed 3D LUT data is not saved in the database or the XMP file, but is instead saved to the 3D LUT file path inside the 3D LUT root folder. + + + module header + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-header/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-header/ + At the top of each processing module is the module header. Click on the module name to expand the module and display the parameters that control its operation. By default darktable will only allow one processing module to be expanded at a time &ndash; if you click the header of another module, the previously-opened module&rsquo;s controls are collapsed. If you want to expand more than one module, you may expand further modules by Shift+clicking on the header and all previously expanded modules will remain open. + + + monochrome + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/monochrome/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/monochrome/ + Quickly convert an image to black &amp; white using a variable color filter. To use this module, first reduce the filter size (to concentrate its effect) and move it across the hue palette to find the best filter value for your desired image rendition. Then gradually expand the filter to include more hues and achieve more natural tonality. Although this module is easy to use, better results can usually be obtained by using the film emulation presets in the color calibration module. + + + negadoctor + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/negadoctor/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/negadoctor/ + Process scanned film negatives. You can obtain an image of a negative using a film scanner, or by photographing it against a white light (e.g. a light table or computer monitor) or off-camera flash. 🔗preparation If the image of the negative was obtained using a digital camera, then in order to obtain accurate colors in the final image, you will need to take the following points into consideration: When taking the photograph, adjust the exposure to fully utilise the entire dynamic range of your camera sensor &ndash; i. + + + orientation + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + Rotate the image 90 degrees at a time or flip the image horizontally and/or vertically. The module is enabled by default and the orientation (rotation) is automatically set based on the image&rsquo;s Exif data. The orientation can also be set using the actions on selection module in the lighttable view. 🔗module controls transform Double click the label to reset to the default transformations rotate counter-clockwise Rotate the image 90 degrees counter-clockwise rotate clockwise Rotate the image 90 degrees clockwise flip horizontally Flip the image (mirror) horizontally flip vertically Flip the image (mirror) vertically show guides Tick the box to show guide overlays whenever the module is activated. + + + output color profile + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/output-color-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/output-color-profile/ + Manage the output profile for export and the rendering intent to be used when mapping between color spaces. darktable comes with pre-defined profiles sRGB, Adobe RGB, XYZ and linear RGB. You can provide additional profiles by placing them in $DARKTABLE/share/darktable/color/out and $HOME/.config/darktable/color/out (where $DARKTABLE is the darktable installation directory and $HOME is your home directory). Note that these color/out directories are not created by the darktable install; if you need to use one, you must create it yourself. + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/overview/ + Masks allow you to limit the effect of a module so that it only applies to certain parts of the image. A mask can be regarded as a grayscale image where each pixel has a value between 0 and 1.0 (or between 0% and 100%). This value is the opacity and is used to determine how much a module affects each pixel. The following sections explain how to construct masks in darktable. + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/overview/ + Each processing module takes its input from the preceding module in the pixelpipe, performs its operation on the image data, and then hands the output to the next module in the pixelpipe. A module&rsquo;s output data can optionally be reprocessed (combined) with its input data before being handed to the next module. This additional processing step is called blending &ndash; input and output data is reprocessed using algorithms called blending operators or blend modes. + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/organization/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/overview/ + Processing modules are organized and accessed via the right-hand panel in the darkroom: Click on the icons at the top of this panel to reveal, from left to right, quick access panel A customizable panel allowing quick access to commonly-used module controls. active modules A group containing the modules that are currently active in the pixelpipe. Right-click to show all modules that are present in the history stack within the active group, regardless of whether or not they are actually active. + + + overview + https://darktable-org.github.io/dtdocs/en/darkroom/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/overview/ + The darkroom view is where you develop your images. The center panel contains the image currently being edited. 🔗zoom Middle-click on the center panel cycle between &ldquo;fit to screen&rdquo;, 1:1 and 2:1 zoom. Alternatively you can zoom between 1:1 and &ldquo;fit to screen&rdquo; by scrolling with your mouse. Scroll while holding the Ctrl key to extend the zoom range to between 2:1 and 1:10. + + + overview + https://darktable-org.github.io/dtdocs/en/lighttable/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/overview/ + The lighttable view allows you to view and manage your image collection. The centre view contains thumbnails of your images &ndash; how they are displayed depends on which mode you are working in. While the mouse is over an image thumbnail or images are selected, there are a number of actions you can perform with keyboard shortcuts: F1, F2, F3, F4, F5 adds or removes a color label (red, yellow, green, blue, purple, respectively). + + + overview + https://darktable-org.github.io/dtdocs/en/lua/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/overview/ + Lua scripts can be used to define actions for darktable to perform when an event is triggered. One example might be calling an external application during file export in order to apply additional processing steps outside of darktable. Lua is an independent project founded in 1993, providing a powerful, fast, lightweight, embeddable scripting language. Lua is widely used by many open source applications, in commercial programs, and for games programming. + + + overview + https://darktable-org.github.io/dtdocs/en/map/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/map/overview/ + The map view allows you to see where your geo-tagged images were taken, and to add location information to non-geo-tagged images. The map view shows a world map with the images in the current collection pinned to their geo-tagged location (if available). This requires that images are tagged with location information. Some newer cameras, including smartphones, are already equipped with GPS receivers. Other cameras may need additional GPS hardware to do this. + + + overview + https://darktable-org.github.io/dtdocs/en/module-reference/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/overview/ + The modules in this reference section are broken down into two distinct types: processing modules Processing modules are used exclusively in the darkroom view. Each module performs a processing operation on the image before passing its output to the next module for further processing. Together this sequence of processing steps forms the pixelpipe. utility modules Utility modules may be used in any darktable view. They are not directly involved in processing the pixels of an image but perform other ancillary functions (managing image metadata and tags, editing history, modifying pixel pipeline order, snapshots and duplicates, image export etc. + + + overview + https://darktable-org.github.io/dtdocs/en/preferences-settings/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/overview/ + darktable comes with a number of user-configurable preferences. These can be adjusted in the preferences dialog, which can be reached by clicking the gear icon on the right of the top panel. Preferences are separated into tabs, each of which is described in more detail in the following sections. When opened from within the lighttable or darkroom views, the appropriate tab will be loaded by default to allow you to modify that view&rsquo;s settings. + + + overview + https://darktable-org.github.io/dtdocs/en/print/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/print/overview/ + This view allows you to print your images. Because printing is not easy, there are many technical aspects to be taken into account. After selecting an image in the lighttable view you can enter the print settings module to adjust printer settings and initiate printing. This module supports the printer&rsquo;s ICC profile, which is somewhat mandatory if you want to obtain a high quality print close to the image displayed on the screen. + + + overview + https://darktable-org.github.io/dtdocs/en/slideshow/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/slideshow/overview/ + The slideshow view allows you to watch a slideshow of your current collection with the associated filtering rules and sort order applied. To learn more about how to define the collection and filtering rules, see the section on collections. Select the sort criteria and sort order of the images in the top panel. The next section provides more details on the usage of the slideshow view. + + + overview + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/overview/ + darktable employs a fully color managed workflow: Input color specifications are taken from embedded or user-supplied ICC profiles or (in the case of raw files) from a library of camera-specific color matrices. darktable automatically reads the display profile of your monitor (if properly configured) for accurate on-screen color rendition. Multiple-screen setups are fully supported as long as a system service like colord is in place and properly configured to inform darktable of the correct monitor profile. + + + overview + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/overview/ + darktable-chart is a tool for extracting luminance and color values from images of color reference cards such as IT8.7/1 charts. Its main purpose is to compare a source image (typically a largely unprocessed raw image) to a target image (typically a JPEG image created in-camera) and produce a darktable style that is able to use the luminance and color values of the source image to produce the target image. This style employs the tone curve module, the input color profile module, and the color look up table module for that purpose. + + + overview + https://darktable-org.github.io/dtdocs/en/tethering/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/overview/ + The tethering view allows you to capture images directly into darktable from a connected camera. To use the tethering feature you first need to connect your camera to your PC using a USB cable. Your computer might ask to mount or view the connected camera. Do not mount or view the camera. If your camera is mounted or viewed automatically, you will need to “unmount/eject” the camera before darktable can access it. + + + raw black/white point + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-black-white-point/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-black-white-point/ + Define camera-specific black and white points. This module is activated automatically for all raw images. Default settings are applied for all supported cameras. Changes to the defaults are not normally required. 🔗module controls black level 0-3 The camera-specific black level of the four pixels in the RGGB Bayer pattern. Pixels with values lower than this level are not considered to contain valid data. white point The camera-specific white level. All pixels with values above this are likely to be clipped and will be handled accordingly in the highlight reconstruction module. + + + raw chromatic aberrations + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-chromatic-aberrations/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-chromatic-aberrations/ + Correct chromatic aberrations of raw images. This module currently only works for raw images recorded with a Bayer sensor (the sensor used in the majority of cameras) &ndash; for other types of image, you should use the chromatic aberrations module instead. The module will also not apply any corrections to any photos that have been identified as monochrome (see developing monochrome images for more information). This module expects good white balance data (provided by the white balance module) for best results. + + + raw denoise + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-denoise/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-denoise/ + Perform denoising on raw image data before it is demosaiced. This module has been ported from dcraw. 🔗module controls noise threshold The threshold for noise detection. Higher values lead to stronger noise removal and greater loss of image detail. coarse/fine curves The noise of an image is usually a combination of fine-grained and coarse-grained noise. These curves allow the image to be denoised more or less depending on the coarseness of the visible noise. + + + retouch + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/retouch/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/retouch/ + Remove unwanted elements from your image by cloning, healing, blurring and filling using drawn shapes. This module extends the capabilities of the deprecated spot removal module (equivalent to this module&rsquo;s &ldquo;clone&rdquo; tool) by including a &ldquo;heal&rdquo; tool (based on the heal tool from GIMP), as well as &ldquo;fill&rdquo; and &ldquo;blur&rdquo; modes. It can also take advantage of wavelet decomposition, allowing the image to be separated into layers of varying detail (from coarse to fine) which can be selectively retouched before being recombined to produce the output image. + + + rgb curve + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-curve/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-curve/ + A classic digital photography tool to alter an image&rsquo;s tones using curves. This module is very similar to the tone curve module but works in RGB color space. Activate the picker on the left to show the picked values in the graph (Ctrl+click or right-click to use the picker in area mode). Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the widget. + + + rgb levels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-levels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-levels/ + Adjust black, white and mid-gray points in RGB color space. This module is silmilar to the levels module, which works in Lab color space. The rgb levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in lightness (in &ldquo;RGB, linked channels&rdquo; mode) or independently for each of the R, G and B channels (in &ldquo;RGB, independent channels&rdquo; mode). + + + rgb primaries + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-primaries/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-primaries/ + Adjust the hue and purity of the RGB primary colors (i.e. which red, green and blue they represent), while leaving uncolored (gray) pixels unchanged. In addition to preserving gray pixels, the opponency relationships between the colors are also preserved under this adjustment: If you increase the purity of the blue primary, the opponent yellow&rsquo;s intensity increases to balance things out; If you twist the blue hue toward cyan, the opponent yellow is twisted toward orange. + + + rotate and perspective + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-perspective/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-perspective/ + Automatically correct for converging lines, a form of perspective distortion. The underlying mechanism is inspired by Markus Hebel&rsquo;s ShiftN program. This module also allows for the rotation of the image to be adjusted. Perspective distortions are a natural effect when projecting a three dimensional scene onto a two dimensional plane and cause objects close to the viewer to appear larger than objects further away. Converging lines are a special case of perspective distortions frequently seen in architectural photographs &ndash; parallel lines, when photographed at an angle, are transformed into converging lines that meet at some vantage point within or outside of the image frame. + + + rotate pixels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-pixels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-pixels/ + The sensors of some cameras (such as the Fujifilm FinePix S2Pro, F700, and E550) have a diagonally oriented Bayer pattern instead of the usual orthogonal layout. Without correction this would lead to a tilted image with black corners. This module applies the required rotation. darktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled. The module has no controls. + + + scale pixels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/scale-pixels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/scale-pixels/ + Some cameras (such as the Nikon D1X) have rectangular instead of the usual square sensor cells. Without correction this would lead to distorted images. This module applies the required scaling. darktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled. The module has no controls. + + + shadows and highlights + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/shadows-and-highlights/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/shadows-and-highlights/ + Modify the tonal range of the shadows and highlights of an image by enhancing local contrast. Note: This module performs blurs in Lab color space, which can result in a number of issues when the parameters are pushed hard, including halos, high local contrast in highlights, and hue shifts towards blue in the shadows. You are advised to use the tone equalizer module instead. 🔗module controls shadows Control the effect on shadows. + + + sharpen + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sharpen/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sharpen/ + Sharpen the details in the image using a standard UnSharp Mask (USM). This module works by increasing the contrast around edges and thereby enhancing the impression of sharpness of an image. This module is applied to the L channel in Lab color space. Note: The USM algorithm used in this module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead use the presets offered by the contrast equalizer module for deblurring or the local contrast module for general sharpness. + + + sidecar files + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar/ + darktable is a non-destructive image editor and opens all images in read-only mode. Any data created within darktable (metadata, tags, and image processing steps) is stored in separate .XMP sidecar files. These files are stored alongside the original Raw files and allow darktable to store information about the images as well as the full editing history without touching the original raw files. When you import an image into darktable for the first time, an XMP file is automatically generated. + + + sigmoid + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sigmoid/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sigmoid/ + Remap the tonal range of an image using a modified generalized log-logistic curve. This module can be used to expand or contract the dynamic range of the scene to fit the dynamic range of the display. Note: Modules placed before sigmoid in the pipeline operate in scene-referred space. Modules after sigmoid work in display-referred space. 🔗usage Please take note of the following guidelines while using this module within your workflow: + + + soften + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/soften/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/soften/ + Create a softened image using the Orton effect. Michael Orton achieved his results on slide film by using two exposures of the same scene, one well exposed and one overexposed. He then used a darkroom technique to blend these two images into a final image where the overexposed image was blurred. This module is a near-copy of Orton&rsquo;s analog process into the digital domain. 🔗module controls size The size of blur of the overexposed image. + + + split-toning + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/split-toning/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/split-toning/ + Create a two color linear toning effect where the shadows and highlights are represented by two different colors. The split-toning module does not convert images to black and white and has limited benefits on color images. In order to perform traditional split-toning, the input to this module should therefore be monochrome. 🔗module controls shadows and highlights color Set the desired hue and saturation for both shadows and highlights. Clicking on the colored squares will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define a color in RGB color space. + + + surface blur + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/surface-blur/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/surface-blur/ + Smooth image surfaces while preserving sharp edges using a bilateral filter. This module can be used to denoise images, however you should be aware that bilateral filters are susceptible to overshoots and darktable offers much better alternatives. For example, the astrophoto denoise module uses a non-local means denoising algorithm, and the denoise (profiled) module provides a choice between non-local means and wavelet denoising algorithms. The surface blur module blurs noise within the surfaces of an image by averaging pixels with their neighbors, taking into account not only their geometric distance but also their distance on the range scale (i. + + + the anatomy of a processing module + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-anatomy-of-a-module/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-anatomy-of-a-module/ + The basic element of image processing in darktable is the processing module. In order to process a raw image a number of such modules act on the input image in sequence, each performing a different operation on the image data. For those familiar with Adobe Photoshop, the concept of a processing module in darktable is analogous to that of an adjustment layer in that both make an incremental adjustment to the image, building on top of the adjustments that came before. + + + the background + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/background/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/background/ + Processing high resolution images is a demanding task requiring a modern computer. In terms of both memory and CPU power, getting the best out of a typical 15, 20 or 25 megapixel image can quickly take your computer to its limits. darktable&rsquo;s requirements are no exception. All calculations are performed on 4 x 32bit floating point numbers. This is slower than “ordinary” 8 or 16 bit integer algebra, but eliminates all problems of tonal breaks or loss of information. + + + tone curve + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-curve/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-curve/ + A classic digital photography tool to alter the tones of an image&rsquo;s using curves. This module is very similar to the rgb curve module but works in Lab color space. Activate the picker to show the picked values on the displayed histogram. Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the graph. 🔗module controls Please refer to the curves section for more details about how to modify curves including the interpolation method, scale for graph and preserve colors controls. + + + tone equalizer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-equalizer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-equalizer/ + Dodge and burn while preserving local contrast. When used together with filmic rgb, this module replaces the need for other tone-mapping modules such as the base curve, shadows and highlights, tone curve and zone system (deprecated) modules. It works in linear RGB space and utilizes a user-defined mask to guide the dodging and burning adjustments, helping to preserve local contrast within the image. The following diagram describes how the tone equalizer works: + + + unbreak input profile + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/unbreak-input-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/unbreak-input-profile/ + Add a correction curve to image data. This is required if you have selected certain input profiles in the input color profile module. If you decide to use an ICC profile from the camera manufacturer in the input color profile module, a correction curve frequently needs to be pre-applied to image data to prevent the final output from looking too dark. This extra processing is not required if you use darktable&rsquo;s standard or enhanced color matrices. + + + velvia + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/velvia/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/velvia/ + Resaturate pixels in a weighted manner that gives more weight to blacks, whites and less saturated pixels. Note: This module causes hue and brightness shifts that can be difficult to manage. Instead, use the color balance rgb module for color modifications. 🔗module controls strength The strength of the effect mid-tones bias Reduce the effect on mid-tones in order to avoid unnatural skin tones. Reducing the mid-tone bias decreases mid-tone protection and makes the overall velvia effect stronger. + + + views + https://darktable-org.github.io/dtdocs/en/overview/user-interface/views/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/views/ + The functionality in darktable is separated into six different views: lighttable Manage images and collections. darkroom Develop a single image. map Show geo-tagged images on a map and manually geo-tag new images. print Send images to a printer. slideshow Display images as a slideshow, processing them on-the-fly. tethering Remotely capture and save images taken with a connected camera. You can switch between views by clicking the view name at the top of the right-hand panel (the currently active view is highlighted) or by using one of the following keyboard shortcuts: + + + vignetting + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vignetting/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vignetting/ + Apply a vignetting effect to the image. Vignetting is a modification of the brightness and saturation at the borders of the image in a specified shape. Many of the parameters listed below can also be modified with a graphical control that overlays the image when the module has focus, showing the shape and extent of the effect. Note: This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate this. + + + watermark + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/watermark/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/watermark/ + Render a vector-based overlay onto your image. Watermarks are standard SVG documents and can be designed using Inkscape. You can also use bitmap (PNG) images. The SVG processor in darktable can also substitute strings within an SVG document, allowing image-dependent information to be included in the watermark. User-designed watermarks should be placed into the directory $HOME/.config/darktable/watermarks. Once in place, use the reload button update the list of available watermarks. The following is a list of variable strings that are supported for substitution within an SVG document. + + + white balance + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/white-balance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/white-balance/ + Adjust the white balance of the image by altering the temperature and tint, defining a coefficient for each RGB channel, or choosing from list of predefined white balance settings. The default settings for this module are derived from the camera white balance stored in the image&rsquo;s Exif data. White balance is not intended as a &ldquo;creative&rdquo; module &ndash; its primary goal is to technically correct the white balance of the image ensuring that neutral colored objects in the scene are rendered with neutral colors in the image. + + + (deprecated) basic adjustments + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/basic-adjustments/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/basic-adjustments/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the quick access panel instead. A convenience module that combines controls from exposure, highlight reconstruction, color balance and vibrance into a single module. While this module can provide a quick and convenient way to make simple adjustments to an image, it must be used with care. Normally exposure adjustments should come before input color profile in the pixelpipe, and color adjustments should come after. + + + (deprecated) channel mixer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/channel-mixer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/channel-mixer/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the color calibration module instead. A simple yet powerful tool to manage color channels. This module accepts red, green and blue channels as an input and provides red, green, blue, gray, hue, saturation and lightness channels as output. It allows you to independently control how much each input channel contributes to each output channel. + + + (deprecated) contrast brightness saturation + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-brightness-saturation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-brightness-saturation/ + Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the color balance rgb module instead. A very basic tool for adjusting the contrast, brightness and saturation of an image. Please note that a number of other modules provide much more versatile methods of adjusting these parameters. All module controls default to a neutral position (zero) and provide the ability to increase or decrease the relevant parameter + + + (deprecated) crop and rotate + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop-rotate/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop-rotate/ + Please note that this module is deprecated from darktable 3.8 and should no longer be used for new edits. Please use the crop module to crop the image, the rotate and perspective module to perform rotation and keystone correction, and the orientation module to flip the image on the horizontal/vertical axes. Crop, rotate, and correct perspective distortions using on-screen guides. Whenever the user interface of this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines. + + + (deprecated) defringe + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/defringe/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/defringe/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the chromatic aberrations module instead. Remove color fringing, which often results from Longitudinal Chromatic Aberrations (LCA), also known as Axial Chromatic Aberrations. This module uses edge-detection. Where pixels are detected as a fringe, the color is rebuilt from less saturated neighboring pixels. 🔗module controls operation mode global average: This mode is usually the fastest but might show slightly incorrect previews at high magnification. + + + (deprecated) fill light + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/fill-light/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/fill-light/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module or the exposure module with a drawn mask. Locally modify exposure based on pixel lightness. This module pushes exposure by increasing lightness with a Gaussian curve of a specified width, centered on a given lightness. 🔗module controls exposure The fill-light exposure (EV) center The median lightness impacted by the fill-light. + + + (deprecated) global tonemap + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/global-tonemap/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/global-tonemap/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the filmic rgb module instead. Compress the tonal range of an HDR image into the limited tonal range of a typical LDR output file. Global tonemap processes each pixel of an HDR image, without taking the local surrounding into account. This is generally faster than local tone mapping (deprecated), but might lead to less convincing results with very high-dynamic-range scenes. + + + (deprecated) invert + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/invert/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/invert/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the negadoctor module instead. Invert scanned negatives. 🔗module controls color of film material Clicking on the colored field will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define an RGB color. You can also activate the picker to take a color probe from your image – preferably from the unexposed border of your negative. + + + (deprecated) levels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/levels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/levels/ + Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the rgb levels module instead. Adjust black, white and mid-gray points. The levels tool offers two modes of operation: manual The levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in absolute values of image lightness (the L value from Lab). + + + (deprecated) spot removal + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/spot-removal/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/spot-removal/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the &ldquo;cloning&rdquo; tool in the retouch module instead. Correct areas of an image (the target) using details from another area of the image (the source). This module uses some of the shapes that are available for drawn masks (circles, ellipses and paths), and the user interface is similar. + + + (deprecated) tone mapping + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-mapping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-mapping/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module instead. Compress the tonal range of HDR images so that they fit into the limits of an LDR image, using Durand&rsquo;s 2002 algorithm. The underlying algorithm uses a bilateral filter to decompose an image into a coarse base layer and a detail layer. The contrast of the base layer is compressed, while the detail layer is preserved, then both layers are re-combined. + + + (deprecated) vibrance + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vibrance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vibrance/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the vibrance control in the color balance rgb module instead. Saturate and reduce the lightness of the most saturated pixels to make the colors more vivid. 🔗module controls vibrance The amount of vibrance to apply to the image. + + + (deprecated) zone system + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/zone-system/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/zone-system/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer or multiple instances of the exposure module with parametric masks to narrow down on a zone. Adjust the lightness of an image using Ansel Adams&rsquo; zone system. The lightness of the image (the L channel in Lab color space) is divided into a number of zones ranging from pure black to pure white. + + + basic principles: luarc files + https://darktable-org.github.io/dtdocs/en/lua/basic-principles/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/basic-principles/ + At startup, darktable will automatically run the Lua scripts $DARKTABLE/share/darktable/luarc and $HOME/.config/darktable/luarc (where $DARKTABLE represents the darktable installation directory and $HOME represents your home directory). This is the only time darktable will run Lua scripts by itself. These scripts can register callbacks to perform actions on various darktable events. This callback mechanism is the primary method of triggering lua actions. + + + blend modes + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/blend-modes/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/blend-modes/ + Blend modes define how the input and output of a module are combined (blended) together before the module&rsquo;s final output is passed to the next module in the pixelpipe. Classic blending modes, designed for display-referred RGB (constrained to 0-100%), implicitly define a fulcrum at 50% (gray) or 100% (white) in their algorithms, depending on the blend mode. Because scene-referred is not subject to these restrictions, this fulcrum needs to be explicitly defined by the user when performing blending operations in the &ldquo;RGB (scene)&rdquo; color space. + + + collections & film rolls + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/collections/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/collections/ + A collection is a set of images matching a given selection criteria. The most basic kind of collection is a film roll, which contains all of the images that have been imported from a specific folder on disk. Whenever you import images from the filesystem, those images are organized in a film roll whose name is derived from that of their parent folder. You can easily construct other kinds of collection based on various image attributes (Exif data, filename, tags etc. + + + darkroom view layout + https://darktable-org.github.io/dtdocs/en/darkroom/darkroom-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/darkroom-view-layout/ + 🔗left panel From top to bottom: navigation Navigate and zoom the center view. snapshots Take and view snapshots for comparison with the current edit. duplicate manager View and manage duplicates. global color picker Select and display color information taken from parts of the image. tagging Manage tags. image information Display information about the current image. mask manager View and edit drawn shapes. export Export selected images to local files or external services. + + + darktable-cli + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cli/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cli/ + The darktable-cli binary starts the command line interface variant of darktable which allows images to be exported. This variant does not open any display &ndash; it works in pure console mode without launching a GUI. This mode is particularly useful for servers running background jobs. darktable-cli can be called with the following command line parameters: darktable-cli [&lt;input file or folder&gt;] [&lt;xmp file&gt;] &lt;output file or folder&gt; [--width &lt;max width&gt;] [--height &lt;max height&gt;] [--hq &lt;0|1|true|false&gt;] [--upscale &lt;0|1|true|false&gt;] [--style &lt;style name&gt;] [--style-overwrite] [--apply-custom-presets &lt;0|1|false|true&gt;] [--out-ext &lt;extension&gt;] [--import &lt;file or dir&gt;] [--icc-type &lt;type&gt;] [--icc-file &lt;file&gt;] [--icc-intent &lt;intent&gt;] [--verbose] [--help [option]] [--core &lt;darktable options&gt;] The user must supply an input filename and an output filename. + + + display profile + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/display-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/display-profile/ + For darktable to faithfully render colors on screen it needs to find the correct display profile for your monitor. In general this requires your monitor to be properly calibrated and profiled, and it needs the profile to be correctly installed on your system. darktable queries your X display server&rsquo;s xatom as well as the system service colord (if available) for the right profile. If required you can enforce a specific method in preferences &gt; miscellaneous. + + + drawn masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn/ + With the drawn mask feature you can construct a mask by drawing shapes directly onto the image canvas. Shapes can be used alone or in combination. Once a shape has been drawn on an image it can be adjusted, removed, or reused in other modules. Shapes are stored internally as vectors and are rendered with the required resolution during pixelpipe processing. Shapes are expressed in the coordinate system of the original image and are transformed along with the rest of the image by any active distorting modules in the pipe (lens correction, rotate and perspective for example). + + + general + https://darktable-org.github.io/dtdocs/en/preferences-settings/general/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/general/ + Control the overall look and feel of darktable. interface language Set the language of the user interface. This includes the option to enable sentence case (en@truecase) for English. The system default is marked with an * (needs a restart) theme Set the theme for the user interface. Aside from any aesthetic considerations, the recommended interface color for color evaluation is middle gray. Visual perception is affected by ambient brightness, and a low user interface brightness causes all kinds of illusions. + + + how OpenCL works + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/how-opencl-works/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/how-opencl-works/ + As you can imagine, the hardware architecture of GPUs can vary significantly. There are different manufacturers, and even different generations of GPUs from the same manufacturer may not be comparable. At the same time GPU manufacturers don&rsquo;t normally disclose all the hardware details of their products to the public. One of the consequences of this is the need to use proprietary drivers under Linux, if you want to take full advantage of your graphics card. + + + import & review + https://darktable-org.github.io/dtdocs/en/overview/workflow/import-review/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/import-review/ + Before you can do anything in darktable you must first add some images files to the library using the import module in the lighttable view. This will create entries for your images in darktable&rsquo;s library database so that it can keep track of the changes you make. There are three ways to import images, each accessible through buttons in the import module: add to library This option adds images to the library without copying or moving &ndash; your original files will stay in their current location and will not be altered. + + + importing sidecar files generated by other applications + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar-import/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar-import/ + When importing an image, darktable automatically checks if it is accompanied by a sidecar file. As well as looking for files named &lt;basename&gt;.&lt;extension&gt;.xmp and &lt;basename&gt;_&lt;number&gt;.&lt;extension&gt;.xmp (darktable&rsquo;s XMP file naming formats) darktable also checks for the presence of a file in the form &lt;basename&gt;.xmp (the naming format for Lightroom&rsquo;s XMP sidecar files). Files with the latter naming format will be read by darktable but will not be written to. Once the image has been imported, darktable will generate an additional XMP file using its own naming convention. + + + lighttable view layout + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-view-layout/ + 🔗left panel From top to bottom: import Import images from the filesystem or a connected camera. collections Filter the images displayed in the lighttable center panel &ndash; also used to control the images displayed in the filmstrip and timeline modules. recently used collections View recently used collections of images. image information Display image information. lua scripts installer (optional) Install lua scripts. 🔗right panel From top to bottom: selection Select images in the lighttable using simple criteria. + + + map view layout + https://darktable-org.github.io/dtdocs/en/map/map-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/map/map-view-layout/ + 🔗left panel These modules are identical to the lighttable view. From top to bottom: collections Filter the list of images displayed in the map view. recently used collections View recently used collections of images. image information Display image information. 🔗right panel Here you can find the modules specific to the map view. From top to bottom: find location Search for a place on map. locations Manage a hierarchical list of location tags and their corresponding regions on the map. + + + module groups + https://darktable-org.github.io/dtdocs/en/darkroom/organization/module-groups/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/module-groups/ + A number of pre-defined module groups are shipped with darktable and are selectable as presets. These are summarized below. All of these presets (with the exception of modules: deprecated and search only) also include the quick access panel. All except the modules: deprecated group include the search bar. 🔗modules: all This preset contains all modules, sorted according to the traditional module groupings used prior to darktable 3.4, as follows: base modules The minimal set of modules normally required to render a presentable image. + + + multiple instances + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/multiple-instances/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/multiple-instances/ + Many of darktable&rsquo;s modules can be applied more than once in the pixelpipe. Each instance of a module behaves independently, taking its input from the module below it in the pixelpipe and delivering its output to the next module. As with the base instance of a module, all instances can be moved independently within the pixelpipe either by holding Ctrl+Shift while dragging &amp; dropping or by choosing &ldquo;move up&rdquo; or &ldquo;move down&rdquo; in the multiple instances drop-down menu. + + + print view layout + https://darktable-org.github.io/dtdocs/en/print/print-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/print/print-view-layout/ + The central area displays the image layout on the paper (the white area). Some gray borders may be displayed around the image to represent the printable area (the page minus the borders) not filled by the image. The filmstrip below the image allows you to select more images. 🔗overlays When the mouse is over the bounding box of an image, its width and height are shown along its top and left, respectively. + + + screen layout + https://darktable-org.github.io/dtdocs/en/overview/user-interface/screen-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/screen-layout/ + The layout of all darktable views is similar and consists of a center area with panels at the edges: center area : Contains information and functionality specific to the current view. left panel : Contains modules primarily used to provide information. right panel : Contains modules primarily used for image processing. top banner : Contains information about the current darktable version and allows you to switch between views. Also used by some modules to show additional hints and messages. + + + supported file formats + https://darktable-org.github.io/dtdocs/en/overview/supported-file-formats/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/supported-file-formats/ + darktable supports a huge number of file formats from various camera manufacturers. In addition darktable can read a wide range of low- and high-dynamic-range images &ndash; mainly for data exchange between darktable and other software. In order for darktable to consider a file for import, it must have one of the following extensions (case independent): 3FR, ARI, ARW, BAY, BMQ, CAP, CINE, CR2, CR3, CRW, CS1, DC2, DCR, DNG, GPR, ERF, FFF, EXR, IA, IIQ, JPEG, JPG, JXL, K25, KC2, KDC, MDC, MEF, MOS, MRW, NEF, NRW, ORF, PEF, PFM, PNG, PXN, QTK, RAF, RAW, RDC, RW1, RW2, SR2, SRF, SRW, STI, TIF, TIFF, X3F + + + tethering view layout + https://darktable-org.github.io/dtdocs/en/tethering/tethering-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/tethering-view-layout/ + 🔗left panel image information Display image information. 🔗right panel From top to bottom: scopes A graphical depiction of the current image&rsquo;s light levels and colors. This module can be moved to the left-hand panel if desired (see preferences &gt; miscellaneous &gt; position of the scopes module). session Session settings. live view Live view settings. camera settings Camera settings. metadata editor Edit metadata for selected images. tagging Tag selected images. 🔗bottom panel From left to right: + + + the pixelpipe & module order + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/ + The ordered sequence of processing modules operating on an input file to generate an output image is known as the &ldquo;pixelpipe&rdquo;. The order of the pixelpipe is represented graphically by the order in which modules are presented in the user interface &ndash; the pixelpipe starts with a RAW image at the bottom of the module list, and applies the processing modules one by one, piling up layer upon layer of processing from the bottom up, until it reaches the top of the list, where it outputs the fully processed image. + + + usage + https://darktable-org.github.io/dtdocs/en/slideshow/usage/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/slideshow/usage/ + The slideshow view is still in an early stage of development with only a basic set of features. If you don&rsquo;t need the auto-advance mode, you could even use the sticky preview feature instead. spacebar start and stop auto-advance mode which automatically switches to the next images every five seconds by default. ESC leave slideshow mode and return to lighttable view. + or increase delay between each image. up arrow - or decrease delay between each image. + + + usage + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/usage/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/usage/ + The tool is organized into three tabs in the upper part and a text output frame in the lower part. The first tab is used to define the source image, the second tab defines the reference (target) and the third tab contains the controls to generate the resulting darktable style. + + + zoomable lighttable + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/zoomable-lighttable/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/zoomable-lighttable/ + The zoomable lighttable mode provides an alternative way to navigate large collections of images, but with some similarities to the filemanager mode (described below). 🔗controls zoom Scroll with the mouse wheel to zoom in and out of the lighttable (compared to Ctrl+scroll in filemanager mode). Zooming the thumbnails does not change the number of thumbnails per row, so the lighttable can exceed the visible area on all sides. navigate Hold down the left mouse button and drag to move the lighttable around and navigate through your collection. + + + a simple lua example + https://darktable-org.github.io/dtdocs/en/lua/a-simple-example/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/a-simple-example/ + Let&rsquo;s start with a simple example that will print some code on the console. Create a file called luarc in darktable&rsquo;s configuration directory (usually $HOME/.config/darktable/) and add the following line to it: print(&#34;Hello World !&#34;) Start darktable and you will see the sentence &ldquo;Hello World !&rdquo; printed on the console. Nothing fancy but it&rsquo;s a start. At this point, there is nothing darktable-specific in the script. We simply use Lua&rsquo;s standard print function to print a string. + + + activating OpenCL in darktable + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/activate-opencl/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/activate-opencl/ + Using OpenCL in darktable requires that your PC is equipped with a suitable graphics card and that it has the required libraries in place. Most modern graphics cards from NVIDIA, Intel or AMD come with full OpenCL support. The OpenCL compiler is normally shipped as part of the proprietary graphics driver and is used as a dynamic library called libOpenCL.so. This library must be in a folder where it can be found by your system&rsquo;s dynamic linker. + + + culling + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/culling/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/culling/ + Culling mode allows you to display images side by side for easy comparison. 🔗controls zoom In culling mode, you can zoom into images (up to 100%) by holding Ctrl while scrolling with the mouse wheel. Pan within zoomed images with click+drag. By default, zooming and panning are synchronized between all visible images. If you want to zoom or pan only a specific image, add the Shift modifier to the above actions. + + + darktable-generate-cache + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-generate-cache/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-generate-cache/ + The darktable-generate-cache binary updates darktable&rsquo;s thumbnail cache. Invoke this program to generate all missing thumbnails in the background when your computer is idle. darktable-generate-cache can be called with the following command line parameters: darktable-generate-cache [-h, --help] [--version] [--min-mip &lt;0-8&gt;] [-m, --max-mip &lt;0-8&gt;] [--min-imgid &lt;N&gt;] [--max-imgid &lt;N&gt;] [--core &lt;darktable options&gt;] All parameters are optional. If started without parameters darktable-generate-cache uses reasonable defaults. -h, --help Display usage information and terminate. --version Display copyright and version information and terminate. + + + examples + https://darktable-org.github.io/dtdocs/en/tethering/examples/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/examples/ + The following sections show two typical use cases for the tethering view. 🔗studio setup with screening This is a pretty common use case. You have your studio and subject set up, the camera is connected to your computer and tethering view is active in darktable. You work at the camera and take images. Whenever you like, you can review the images directly on your computer monitor instead of using the camera LCD. + + + filmstrip + https://darktable-org.github.io/dtdocs/en/overview/user-interface/filmstrip/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/filmstrip/ + The filmstrip, when enabled, is shown at the bottom of the screen (except in the lighttable view, where it is replaced with the timeline module) and displays the images from the current collection (set in the lighttable view). You can navigate the filmstrip by scrolling with the mouse wheel. The filmstrip allows you to interact with images while you are not in the lighttable view. For example, while developing an image in darkroom mode, you can switch to another image by clicking its thumbnail in the filmstrip. + + + import + https://darktable-org.github.io/dtdocs/en/preferences-settings/import/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/import/ + Control default file naming conventions used when importing images. 🔗session options The following options define the default naming pattern for use in the &ldquo;copy &amp; import&rdquo; or &ldquo;copy &amp; import from camera&rdquo; options in the import module, or when taking photos in the tethering view. The naming pattern consists of three parts: a base part defining the parent folder, a session part defining a sub directory (which is specific to the individual import session), and a file name part defining the filename structure for each imported image. + + + local copies + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/local-copies/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/local-copies/ + Many users have huge image collections stored on extra hard drives in their desktop computer, or on an external storage medium (RAID NAS, external hard drives etc.). It is a common requirement to develop a number of images while travelling using a laptop and then later synchronize them back to the original storage medium. However, copying images manually from the main storage to the laptop and back is cumbersome and prone to errors. + + + parametric masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/parametric/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/parametric/ + The parametric mask feature offers fine-grained selective control over how individual pixels are masked. It does this by automatically generating an intermediate blend mask from user-defined parameters. These parameters are color coordinates rather than the geometrical coordinates used in drawn masks. For each data channel of a module (e.g. Lab, RGB) and several virtual data channels (e.g. hue, saturation) you can construct a per-channel opacity function. Depending on each pixel&rsquo;s value for a given data channel this function calculates a blending factor between 0 and 1 (100%) for that pixel. + + + presets + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/presets/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/presets/ + Presets allow you to store commonly-used module settings for future use. Some modules already come with pre-defined (internal) presets and you may also define your own (user-defined). Both internal and user-defined presets can be shown by clicking the presets menu in the module header. Most of the functionality described here applies to processing modules only. However, presets can also be used with some utility modules. When used with utility modules, the functionality to auto-apply or auto-show presets based on image Exif data is not available. + + + process + https://darktable-org.github.io/dtdocs/en/overview/workflow/process/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/process/ + This section is intended to get you comfortable processing images in the darkroom view using a scene-referred workflow. You are advised to follow the guidelines provided below, up to the end of the image processing in 3 modules section and then choose other areas to learn as-and-when you need to use those techniques in your images. 🔗getting started 🔗take a well-exposed photograph Good image processing techniques start in the camera &ndash; a well-exposed image (without blown highlights or heavily crushed blacks) will always make post-processing much more straightforward. + + + quick access panel + https://darktable-org.github.io/dtdocs/en/darkroom/organization/quick-access-panel/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/quick-access-panel/ + The quick access panel allows you to access widgets from a number of processing modules all in one place. You can add new widgets to the panel by right-clicking on the &ldquo;hamburger&rdquo; icon at the top-left of the panel using the manage module layouts screen Ctrl+clicking on a widget in a processing module while in visual shortcut mapping mode Click on the icon to the right of the module name to open the full version of that module. + + + rendering method + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-method/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-method/ + darktable can render colors either with its own internal algorithms or by using the external library LittleCMS2. darktable&rsquo;s internal method is, by an order of magnitude, faster than the external one. The external option gives you a choice of the rendering intent and might offer a slightly higher accuracy in some cases. You can change the default method in preferences &gt; processing &gt; always use LittleCMS 2 to apply output color profile + + + source image + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/source-image/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/source-image/ + In the “source image” tab you set your source image, which requires two elements. The first element is an input file in Lab Portable Float Map format (extension .pfm). The source file represents the largely unmodified data as the camera sees it. Information about how to take photos of a color reference card and produce a .pfm output file are described below. The second element is a chart file that contains a formal description of the underlying color reference card&rsquo;s layout (extension . + + + the history stack + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/history-stack/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/history-stack/ + The history stack stores the entire editing history for a given image, in the order in which those edits were applied. It is saved to darktable&rsquo;s library database and the image&rsquo;s XMP sidecar file and persists between editing sessions. Each time a processing module is enabled, disabled, moved or amended a new entry is added to the top of the history stack. The history stack can be queried and modified within the history stack module in the darkroom. + + + thumbnails + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/thumbnails/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/thumbnails/ + Each image in the current collection is represented by a thumbnail in the lighttable view and filmstrip module. A cache of the most recently used thumbnails is stored in a file on disk and loaded into memory at startup. 🔗thumbnail creation A thumbnail is created when an image is imported into darktable for the first time, after an image has been modified in the darkroom, or when revisiting an image whose thumbnail is no longer available. + + + undo/redo + https://darktable-org.github.io/dtdocs/en/lighttable/undo-redo/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/undo-redo/ + Most changes made within the lighttable are recorded and can be reverted to a previous state. This includes modifications to color labels, ratings, geo-localization, tags, metadata, orientation, copy/paste of history, image duplication, or application of a style. Note that the facility to undo/redo actions is unlimited in the number of steps while in the lighttable view, but it is reset each time you switch to a different view. Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any). + + + memory & performance tuning + https://darktable-org.github.io/dtdocs/en/special-topics/mem-performance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/mem-performance/ + 🔗memory requirements Processing a Raw image in darktable requires a great deal of system memory. A simple calculation makes this clear: For a 20 megapixel image, darktable requires a 4x32-bit floating point cell to store each pixel, meaning that each full image of this size will require approximately 300MB of memory just to store the image data. In order to actually process this image through a given module, darktable needs at least two buffers (input and output) of this size, with more complex modules potentially requiring several additional buffers for intermediate data. + + + combining drawn & parametric masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn-and-parametric/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn-and-parametric/ + Drawn and parametric masks can be used in combination to form a single mask that can be applied to a module. There are two main elements which control how individual masks are combined: the polarity setting of each individual mask (defined by the plus or minus buttons) and the setting in the “combine masks” combobox. The &ldquo;combine masks&rdquo; combobox contains the following options, defining how the drawn and parametric masks will be combined: + + + darktable-chart + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-chart/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-chart/ + The darktable-chart binary is a dedicated utility to create styles out of pairs of images such as RAW+JPEG with in-camera processing. Details about its usage can be found in the using darktable-chart section. darktable-chart can either start a GUI or be used as a command-line program. darktable-chart [--help] [&lt;input Lab pfm file&gt;] [&lt;cht file&gt;] [&lt;reference cgats/it8 or Lab pfm file&gt;] All parameters are optional, however, if you want to supply the second file name you also need to supply the first one. + + + export + https://darktable-org.github.io/dtdocs/en/overview/workflow/export/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/export/ + darktable is a non-destructive editor, which means that all changes are recorded in the library database (with a backup stored in an XMP sidecar file), and the original Raw file is left untouched. You therefore need to export images in order to bake your edits into an output file that can be distributed outside of darktable. Choose an export scenario. The export module offers many options, but by far the most common use is to “save a developed raw image as a JPEG”. + + + full preview + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/full-preview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/full-preview/ + From any of the lighttable modes, you can display a fully-zoomed preview of the image that is currently under the mouse pointer by pressing and holding down W. This is useful to more closely inspect an image while rating and selecting images. Pressing and holding Ctrl+W fully zooms into the image and also identifies any regions of sharpness in the image that may indicate image focus. For this tool to work the input image needs to hold an embedded JPEG thumbnail, which is the case for most raw files. + + + lighttable + https://darktable-org.github.io/dtdocs/en/preferences-settings/lighttable/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/lighttable/ + Control functionality in the lighttable view and modules. 🔗general hide built-in presets for utility modules If enabled, only user-defined presets will be shown in presets menu for utility modules &ndash; built-in presets will be hidden (default off). use single-click in the collections module Enable &ldquo;single click&rdquo; mode in the collections module, which allows ranges to be selected (default off). expand a single utility module at a time Controls how utility modules are expanded. + + + manage module layouts + https://darktable-org.github.io/dtdocs/en/darkroom/organization/manage-module-layouts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/organization/manage-module-layouts/ + Manage the layout and grouping of processing modules and the quick access panel. This maintenance screen can be accessed from the presets menu beside the module search box or module group icons (below the scopes module in the darkroom view). Ctrl+click on the preset menu to open this screen directly. Settings are automatically saved when you exit the screen. Click reset to abandon any changes made in the current editing session. + + + module controls + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-controls/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-controls/ + This section describes how to interact with processing module controls. 🔗sliders Sliders offer five different methods of interaction, depending on the level of control you require. left-click (set) Click anywhere in the slider area to set the value. You can also click and drag to change it. You don&rsquo;t have to aim for the triangle or even the line &ndash; you can click anywhere in the entire height of the slider, including the label. + + + printing labeled images + https://darktable-org.github.io/dtdocs/en/lua/printing-labeled-images/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/printing-labeled-images/ + The first example showed us the very basics of lua and allowed us to check that everything was working properly. Now let&rsquo;s do something a little bit more complex. Let&rsquo;s try to print a list of images that have a &ldquo;red&rdquo; label attached to them. But first of all, what is an image? local darktable = require &#34;darktable&#34; local debug = require &#34;darktable.debug&#34; print(darktable.debug.dump(darktable.database[1])) Running the code above will produce a lot of output. + + + reference values + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/reference-values/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/reference-values/ + The “reference values” tab determines the target values to which the source image must to be modified by the resulting style. You can either supply reference values in the form of measured data of your color reference card (mode “cie/it8 file”), or you can supply a photographic image (mode “color chart image”) much in the same way as described above. This second image must also be supplied in Lab Portable Float Map format. + + + rendering intent + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-intent/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-intent/ + If rendering with LittleCMS2 is activated (see rendering method) you can define how to handle out-of-gamut colors when converting between color spaces. A selection box in the export, output color profile, and soft proof modules gives you a choice of the following rendering intents: perceptual Best suited to photographs as it maintains the relative position of colors. This is usually the best choice. relative colorimetric Out-of-gamut colors are converted to colors having the same lightness, but different saturation. + + + setting up OpenCL + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/setting-up/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/setting-up/ + The huge diversity of systems and the marked differences between OpenCL vendors and driver versions makes it impossible to give an comprehensive overview of how to setup OpenCL. We only can give you an example, in this case for NVIDIA driver version 542.29.06 on Fedora 39. We hope that this will serve as a basic introduction and will help you to solve any problems specific to your setup. The principle OpenCL function flow is like this: + + + star ratings & color labels + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/star-color/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/star-color/ + Star ratings and color labels help you to sort and rank images according to your own criteria. An image&rsquo;s star rating and color labels can be displayed over thumbnails in the lighttable view and filmstrip module. 🔗star ratings You can give an image a rating from zero to five stars. Whenever you import images, each image receives a default rating which you can define in the import module. You can also mark an image as “rejected”. + + + top panel + https://darktable-org.github.io/dtdocs/en/overview/user-interface/top-panel/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/top-panel/ + The top panel appears in all darktable views and provides access to common functions. 🔗On the left-hand-side filter / sort Choose how to filter and sort the images. Criteria can be altered in the collection filters module or by clicking on the icon. sort order Switch the sort order (ascending / descending). 🔗On the right-hand-side grouping Expand or collapse grouped images. thumbnail overlays Define what information is overlaid on to thumbnails in the lighttable/filmstrip. + + + troubleshooting + https://darktable-org.github.io/dtdocs/en/tethering/troubleshooting/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/troubleshooting/ + This troubleshooting guide can be used to verify whether or not your camera can be used with tethering. This is done using the same (gphoto2) tool that darktable uses to interface with your camera. Before you start, you first need to find your camera port name. Usually the port &ldquo;usb:&rdquo; is sufficient and is therefore used in the following guide. 🔗is your camera detected? The following command will verify that your camera is connected to the computer and detected by gphoto2. + + + undo and redo + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/undo-redo/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/undo-redo/ + While you are editing your image, darktable records all of the modifications you make to that image. This means that it is possible to undo and redo changes to recover a previous editing state. Note that the undo/redo facility is unlimited in the number of steps while editing an image, but is reset each time the darkroom is switched to a new image. Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any). + + + adding a simple shortcut + https://darktable-org.github.io/dtdocs/en/lua/simple-shortcut/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/simple-shortcut/ + So far, all our scripts have done things during startup. This is of limited use and doesn&rsquo;t allow us to react to real user actions. To do more advanced things we need to register a function that will be called on a given event. The most common event to react to is a keyboard shortcut. darktable = require &#34;darktable&#34; local function hello_shortcut(event, shortcut) darktable.print(&#34;Hello, I just received &#39;&#34;..event.. &#34;&#39; with parameter &#39;&#34;. + + + curves + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/curves/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/curves/ + The base curve, tone curve and rgb curve modules use curves to control the tones in the image. These modules have some common features that warrant separate discussion. 🔗nodes In their default state, curves are straight lines, defined by two anchor nodes at the top-right and bottom-left of the graph. You can move the nodes to modify the curve or generate new nodes by clicking on the curve. Ctrl+click to generate a new node at the x-location of the mouse pointer and the corresponding y-location of the current curve &ndash; this adds a node without the risk of accidentally modifying the curve. + + + darkroom + https://darktable-org.github.io/dtdocs/en/preferences-settings/darkroom/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/darkroom/ + Control functionality in the darkroom view and associated modules. 🔗general scroll down to increase mask parameters By default, scrolling your mouse up increases the value of the relevant shape parameters in drawn masks. Set this preference to reverse the behavior (default off). middle mouse button zooms to 200% When enabled, clicking the middle mouse button on the image canvas causes the zoom level to toggle between fit, 100% and 200%. When disabled, the middle mouse button toggles between fit and 100%. + + + darktable-cltest + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cltest/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cltest/ + The darktable-cltest binary checks if there is a usable OpenCL environment on your system that darktable can use. It emits some debug output that is equivalent to calling darktable -d opencl and then terminates. darktable-cltest is called without command line parameters. + + + darktable's color spaces + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-spaces/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-spaces/ + Input images are either RGB files (like JPEGs or TIFFs) or camera RAWs. Both store visual information as a combination of primary colors (e.g. red, green and blue) which together describe a light emission to be recreated by a display. The following image illustrates this concept. The left-hand-side of the image depicts a colored light that we need to represent digitally. We can use three ideal color filters to decompose this light into three colored primary lights at different intensities. + + + image grouping + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/grouping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/grouping/ + Grouping images helps to improve the structure and clarity of your image collection when displayed in the lighttable view. You can combine images into a group by selecting them and clicking the “group” button in the actions on selection module, or by pressing Ctrl+G. Likewise, you can remove selected images from a group by clicking the “ungroup” button, or pressing Ctrl+Shift+G. Duplicated images are automatically grouped together. Similarly, if you import multiple images from the same directory, having the same base name, but different extensions (eg. + + + keyboard shortcuts + https://darktable-org.github.io/dtdocs/en/overview/user-interface/keyboard-shortcuts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/keyboard-shortcuts/ + Much of the functionality in darktable can be controlled via keyboard shortcuts, which can be customised in preferences &gt; shortcuts. Press the H key (for help) in any darktable view to show a list of all shortcuts that are applicable to the current view. + + + mask refinement & additional controls + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/refinement-controls/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/refinement-controls/ + When a parametric or drawn mask is active, several additional sliders are shown which allow the mask to be further refined. details threshold This control allows you to alter the opacity of the mask based on the amount of detail in the image. Use this slider to select either areas with lots of detail (positive values) or areas that are flat and lacking in detail (negative values). The default (zero) effectively bypasses details refinement. + + + possible problems & solutions + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/problems-solutions/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/problems-solutions/ + darktable will detect OpenCL run-time errors automatically. On detecting an error, it will then reprocess everything on the CPU. While this will slow down processing it should not affect the end result. There can be various reasons why OpenCL might fail during the initialization phase. OpenCL depends on hardware requirements and on the presence of certain drivers and libraries. In addition all these have to fit in terms of maker, model and revision number. + + + process + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/process/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/process/ + If all of the required settings in the &ldquo;source image&rdquo; and &ldquo;reference values&rdquo; tabs are ready you can move on to the “process” tab. First, you need to tell darktable-chart which of the patches represents the gray ramp. In the screenshot displayed above, the gray ramp is positioned in the lower part of the color reference chart, denoted as &ldquo;GS00&hellip;GS23&rdquo;. The &ldquo;number of final patches&rdquo; input defines how many editable color patches the resulting style will use within the color look up table module. + + + wavelets + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/wavelets/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/wavelets/ + Wavelets are used to separate (or decompose) an image into a number of distinct layers, each containing a different level of detail. After decomposing an image in this way, a module can limit its processing to one or more of these detail layers, and then piece the layers back together again at the end to form its output. This allows us to be surgical about which features in the image we wish to impact when working with a module. + + + deprecated modules + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/deprecated/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/deprecated/ + The darktable team regularly reviews old modules and updates their implementation where issues are found or updated science means that they can be improved. Most of the time we try to update existing modules with new functionality but occasionally that becomes problematic, often due to the overhead of having to maintain multiple versions of the module. In such circumstances a new replacement module is created and the old module becomes deprecated. + + + darktable-cmstest + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cmstest/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cmstest/ + The darktable-cmstest binary (Linux only) investigates whether the color management subsystem of your computer is correctly configured and displays some useful information about the installed monitor profile(s). darktable-cmstest is called without command line parameters. + + + exporting images with lua + https://darktable-org.github.io/dtdocs/en/lua/exporting-images/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/exporting-images/ + So far we have learned to use lua to adapt darktable to our particular workflow. Let&rsquo;s look now at how to use lua to easily export images to an online service. If you are able to upload an image to a service via the command line then you can use lua to integrate this into darktable&rsquo;s user interface. In this next example we will use lua to export via scp. A new storage type will appear in darktable&rsquo;s UI that will export images to a remote target via the copy mechanism in ssh. + + + making input images for darktable-chart + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/making-input-images/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/making-input-images/ + To start with, you need a suitable photo of your color reference card in RAW+JPEG format. It goes beyond the scope of this manual to explain the details of how to take this photo, but in a nutshell you need to make the shot on a sunny day around midday with the light source (the sun) shining at an angle onto the card. You need to avoid any glare in the image. + + + metadata and tagging + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/metadata-tagging/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/metadata-tagging/ + darktable allows you to store additional information about your images to allow them to be more easily searched and grouped. This information is stored in darktable&rsquo;s database and XMP sidecar files and can also be included within exported images. 🔗metadata Metadata (e.g. title, description) is free-format text that usually differs for each image. You can add metadata to images in the metadata editor module. 🔗tagging Tags are usually shared between multiple images and are used to categorise and group them. + + + raster masks + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/raster/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/raster/ + As described in the previous sections, the final output of a module&rsquo;s mask (the combined effect of any drawn and parameteric masks) is a grayscale raster image representing the extent to which the module&rsquo;s effect should be applied to each pixel. This raster image is stored internally for active modules and can be subsequently reused by other modules in the pixelpipe. As with any mask, if the opacity value for a pixel in a raster mask is zero the module&rsquo;s input passed through the module unchanged. + + + unbounded colors + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/unbounded-colors/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/unbounded-colors/ + Screens and most image file formats can only encode RGB intensities confined within a certain range. For example, images encoded on 8 bits can only contain values from 0 to 255, images on 10 bits from 0 to 1023, and so on… Graphic standards postulate that the maximum of that range, no matter its actual value, will always represent the maximum brightness that the display medium is able to render, usually between 100 and 160 Cd/m² (or nits) depending on the actual standard. + + + variables + https://darktable-org.github.io/dtdocs/en/special-topics/variables/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/variables/ + darktable supports variable substitution in a number of modules and preference settings. For example: Defining file names in the export module Displaying image information in the darkroom&rsquo;s image information line Displaying image information in the lighttable&rsquo;s overlays and tooltips (see preferences &gt; lighttable) Placing text on an image in the watermark processing module 🔗available variables The following variables are available, though they may not all be applicable in every context: + + + building user interface elements + https://darktable-org.github.io/dtdocs/en/lua/building-ui-elements/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/building-ui-elements/ + Our previous example was a bit limited. In particular the use of a preference for the export path wasn&rsquo;t very nice. We can do better than that by adding elements to the user interface in the export dialog. UI elements are created via the darktable.new_widget function. This function takes a type of widget as a parameter and returns a new object corresponding to that widget. You can then set various fields in that widget to set its parameters. + + + possible color artifacts + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-artifacts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-artifacts/ + There are some infrequent situations that still can lead to problematic results unless the user takes some action. Some modules in Lab color space, like levels and monochrome, rely on the fact that the L channels carries all lightness information, with the a and b channels purely representing chroma and hue. Unbounded colors with negative L values are especially problematic to these modules and can lead to black pixel artifacts. + + + processing + https://darktable-org.github.io/dtdocs/en/preferences-settings/processing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/processing/ + Control how images are processed. 🔗image processing always use LittleCMS 2 to apply output color profile If this option is activated, darktable will use the LittleCMS 2 system library to apply the output color profile instead of its own internal routines. This is significantly slower than the default but might give more accurate results in some cases. If the given ICC is LUT-based or contains both a LUT and a matrix, darktable will use LittleCMS 2 to render the colors regardless of this parameter&rsquo;s value (default off). + + + purge_non_existing_images.sh + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/purge_non_existing_images_sh/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/purge_non_existing_images_sh/ + Find and remove entries from the library database referencing images that no longer exist in the filesystem. You must close darktable before running this script. The script can be called with the following command line parameters: purge_non_existing_images.sh [-c|--configdir &lt;path&gt;] [-l|--library &lt;path&gt;] [-p|--purge] Run the script with no options to perform a &ldquo;dry run&rdquo;, which generates a report of the missing files without committing any changes to the database. The available options are: + + + darktable's color dimensions + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-dimensions/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-dimensions/ + This section defines the perceptual properties of color, both conceptually and quantitatively, in order to characterize and quantify the creative and corrective adjustments made to color in darktable. 🔗definitions Color properties like &ldquo;saturation&rdquo;, &ldquo;brightness&rdquo; or &ldquo;lightness&rdquo; have passed into common usage but are largely misused and often used to mean different things. In color science, each of these terms has a precise meaning. There are two frameworks within which color properties may be analyzed and described: + + + darktable's color pipeline + https://darktable-org.github.io/dtdocs/en/special-topics/color-pipeline/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-pipeline/ + Most image processing applications come from the 1990s and/or inherit a 1990s workflow. These applications processed images encoded with 8 bit unsigned integers because it was more memory- and computationally-efficient. However, due to the use of an integer format (which implies rounding errors) they had to apply a &ldquo;gamma&rdquo; (essentially a transfer function applying a power 1/2.2 or 1/2.4 to encode the RGB values) and increase the bit-depth in the low-lights in order to reduce rounding errors there (humans are very sensitive to low-light details). + + + scheduling profile + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/scheduling-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/scheduling-profile/ + darktable can use the CPU and one or several OpenCL capable GPUs. Depending on the relative performance of these devices, users can choose among certain scheduling profiles to optimize performance. This is achieved by setting the configuration parameter preferences &gt; processing &gt; OpenCL &gt; OpenCL scheduling profile, which offers the following choices: default If an OpenCL-capable GPU is found darktable uses it for processing the center image view while the navigation preview window is processed on the CPU in parallel. + + + security + https://darktable-org.github.io/dtdocs/en/preferences-settings/security/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/security/ + Control whether warning messages are shown before undertaking certain activities. 🔗general ask before removing images from the library Always ask before removing image information from darktable&rsquo;s library database, where the xmp file is retained (default on). ask before deleting images from disk Always ask before deleting an image file (default on). ask before discarding history stack Always ask before discarding the history stack of an image (default on). try to use trash when deleting images Instead of physically deleting images from disk, attempt to put them into the system&rsquo;s trash bin (default on). + + + sharing scripts + https://darktable-org.github.io/dtdocs/en/lua/sharing-scripts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/sharing-scripts/ + So far, all of our lua code has been in luarc. That&rsquo;s a good way to develop your script but not very practical for distribution. We need to make this into a proper lua module. To do that, we save the code in a separate file (scp-storage.lua in this case): --[[ SCP STORAGE a simple storage to export images via scp AUTHOR Jérémy Rosen (jeremy.rosen@enst-bretagne.fr) INSTALLATION * copy this file in $CONFIGDIR/lua/ where CONFIGDIR is your darktable configuration directory * add the following line in the file $CONFIGDIR/luarc require &#34;scp-storage&#34; USAGE * select &#34;Export via SCP&#34; in the storage selection menu * set the target directory * export your images LICENSE GPLv2 ]] darktable = require &#34;darktable&#34; dtutils = require &#34;lib/dtutils&#34; dtutils. + + + midi device support + https://darktable-org.github.io/dtdocs/en/special-topics/midi-device-support/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/midi-device-support/ + 🔗introduction MIDI is a communication protocol used by many electronic musical instruments (&ldquo;pianos&rdquo;), digital audio studio equipment (&ldquo;control surfaces&rdquo;) and even dedicated &ldquo;photo editing keyboards&rdquo; like the Loupedeck/Loupedeck+ (but not their later products). Such devices commonly feature sets of keys/buttons and sometimes encoders (knobs/rotors) and faders (sliders). Buttons sometimes feature lights, which makes them ideal for toggling features in darktable, because the lights can reflect the current (on/off) status. Encoders and faders are ideal for use with on-screen sliders in processing modules. + + + calling lua from dbus + https://darktable-org.github.io/dtdocs/en/lua/calling-from-dbus/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/calling-from-dbus/ + It is possible to send a lua command to darktable via its DBus interface. The method org.darktable.service.Remote.Lua takes a single string parameter which is interpreted as a lua command. The command will be executed in the current lua context and should return either nil or a string. The result will be passed back as the result of the DBus method. If the Lua call results in an error, the DBus method call will return an error org. + + + contributing to dtdocs + https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ + This page defines the style guide for dtdocs and information about how to contribute to the project. It is included in the user manual so that you can see how the page is rendered as well as how it is written. Please go to GitHub to see the source for this page. The manual structure and content have been carefully considered based on the following criteria: The manual should be comprehensive &ndash; it should describe all of the functionality available in darktable It should have a consistent and logical structure and every piece of functionality should have its own logical place within that structure It should be as long as necessary but as short as possible &ndash; brevity is a must It should be objective Functionality should be explained once and only once (with the exception of the basic workflow guidelines in the overview section) Images should be included only where necessary to improve understanding of key principles and should not contain text unless it is unavoidable We are generally not interested in: + + + multiple devices + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/multiple-devices/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/multiple-devices/ + The scheduling of OpenCL devices can be optimized on most systems using the “OpenCL scheduling profile” settings. However, if your system is equipped with more than one GPU, you might want to set the relative device priority manually. To do this you need to select the “default” scheduling profile and change the settings in the “opencl_device_priority” configuration parameter. It is important to understand how darktable uses OpenCL devices. Each processing sequence of an image &ndash; to convert an input to the final output using a history stack &ndash; is run in a pixelpipe. + + + OpenCL still does not run for me + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/still-doesnt-work/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/still-doesnt-work/ + As has been mentioned, OpenCL systems come with a huge variety of setups: different GPU manufacturers and models, varying amounts of GPU memory, different drivers, different distributions etc.. Many of the potential problems will only appear with very specific combinations of these factors. As the darktable developers only have access to a small fraction of these variations, please understand that we might not be able to fix your specific problem. There is not much we can do if we are unable to reproduce your issue. + + + storage + https://darktable-org.github.io/dtdocs/en/preferences-settings/storage/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/storage/ + The following options are related to darktable&rsquo;s library database and XMP sidecar files. 🔗database create database snapshot Specifies how often darktable should create database snapshots. Options are &ldquo;never&rdquo;, &ldquo;once a month&rdquo;, &ldquo;once a week&rdquo;, &ldquo;once a day&rdquo; and &ldquo;on close&rdquo; (default &ldquo;once a week&rdquo;) how many snapshots to keep Number of snapshots to keep after creating a new snapshot, not counting database backups taken when moving between darktable versions. Enter &ldquo;-1&rdquo; to store an unlimited number of snapshots. + + + translating dtdocs + https://darktable-org.github.io/dtdocs/en/special-topics/translating/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/translating/ + Translation of the darktable documentation is done via our Weblate instance. You can either use Weblate&rsquo;s web UI to translate the documentation or download the translation from Weblate to your computer, edit it, and then upload the changes. Please do all translation work through Weblate. We will not accept pull requests directly on github to update PO files. 🔗Making a new branch in git Make a new branch to work on it in git. + + + using darktable from a lua script + https://darktable-org.github.io/dtdocs/en/lua/darktable-from-lua/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/darktable-from-lua/ + Warning: This feature is very experimental. It is known that several elements don&rsquo;t yet work in library mode. Careful testing is highly recommended. The lua interface allows you to use darktable from any lua script. This will load darktable as a library and provide you with most of the lua API (darktable is configured headless, so the functions relating to the user interface are not available). As an example, the following program will print the list of all images in your library: + + + batch-editing images + https://darktable-org.github.io/dtdocs/en/guides-tutorials/batch-editing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/guides-tutorials/batch-editing/ + Batch-editing is the process of developing images in a semantically-related series that are expected to have a consistent final look, often with the intent of publishing the images in catalogues, magazines or books. It can be a tedious, frustrating and unexciting task, so darktable includes functionality to help make it faster and more reliable. 🔗preparation 🔗shooting color checkers Shooting a color checker on-location can save a tremendous amount of time during batch post-processing of a series of images. + + + lua API + https://darktable-org.github.io/dtdocs/en/lua/api/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/api/ + darktable&rsquo;s Lua API is documented in its own manual with a detailed description of all data structures and functions. You can download the API manual from here. + + + miscellaneous + https://darktable-org.github.io/dtdocs/en/preferences-settings/miscellaneous/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/miscellaneous/ + 🔗interface load default shortcuts at startup When launching the application, darktable loads default shortcuts first, and then loads user-defined shortcuts on top. This allows default shortcuts to be overridden with a new action but prevents them from being deleted (since the deleted shortcut will be automatically reloaded on the next restart). Deactivate this preference to stop loading default shortcuts on startup &ndash; only load the user-defined ones (including any defaults that you have not subsequently deleted or overridden). + + + other resources + https://darktable-org.github.io/dtdocs/en/guides-tutorials/other-resources/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/guides-tutorials/other-resources/ + For help and support with using darktable you are encouraged to ask questions on the main discussion forums at discuss.pixls.us. The official places to obtain information concerning darktable are the following: darktable.org GitHub wiki The following articles provide some useful background information about darktable&rsquo;s scene-referred workflow: darktable 3.0 for dummies in 3 modules darktable 3.0 for dummies &ndash; hardcore edition darktable 3.0: RGB or Lab? Which modules? Help! darktable&rsquo;s filmic FAQ Introducing color calibration module The following resources can provide a deeper understanding of the functionality of some specific processing modules: + + + shortcuts + https://darktable-org.github.io/dtdocs/en/preferences-settings/shortcuts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/shortcuts/ + You can perform almost any action in darktable with a keyboard/mouse shortcut. You can also use various other input devices, including MIDI devices and game controllers &ndash; see the midi device support section for details. These are referred to as external devices or just devices in this guide. 🔗defining shortcuts A shortcut is a combination of key or button presses and/or mouse or device movements that performs an action in darktable. + + + presets + https://darktable-org.github.io/dtdocs/en/preferences-settings/presets/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/presets/ + This menu provides an overview of the presets that are defined for darktable&rsquo;s modules, and allows you to modify some of their properties. Pre-defined presets (those that are included by default within darktable) are shown with a lock symbol. Their properties cannot be changed. User-defined presets can be imported from exported .dtpreset files using the &ldquo;import&rdquo; button at the bottom of the screen. You can export all user-defined presets to a single directory using the &ldquo;export&rdquo; button. + + + lua options + https://darktable-org.github.io/dtdocs/en/preferences-settings/lua-options/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/lua-options/ + lua scripts installer don&rsquo;t show again Check this box to hide the lua scripts installer in the lighttable if no lua scripts are installed. + + + actions on selection + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/selected-image/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/selected-image/ + Perform actions on images that have been selected in the lighttable view. 🔗module controls The module controls are spread over two tabs for manipulating the image files and the related metadata. 🔗images tab remove Remove the selected images from the darktable library without deleting them. Removed images can no longer be viewed or edited within darktable but the image files remain on the filesystem along with any XMP sidecar files. As darktable keeps the XMP files up-to-date with your latest development history, you can fully restore your work later by re-importing the images. + + + camera settings + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/camera-settings/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/camera-settings/ + Set up an image capture job. This can include sequence, bracket and delayed captures. You are also able to control other camera settings such as focus mode, aperture, shutter speed, ISO and white balance. + + + clipping warning + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/clipping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/clipping/ + Highlight areas of the image that may exhibit luminance or gamut clipping. When an image is sent to a display device, each pixel is normally represented as a set of 3 numbers, representing the intensity of the red, green and blue primary colors in the output color space. Because the output color space is usually closely related to hardware with physical limations, there is a maximum permitted value for the [R,G,B] channels, representing the maximum available intensity for that color space. + + + collection filters + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collection-filters/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collection-filters/ + Filter the collection of images displayed in the lighttable view and filmstrip panel using image attributes, optionally pinning filters to the top panel for quick access. Once you have defined a collection of images with the collections module, the collection filters module allows you to define additional filters and sort criteria. For example, you might wish to show all images in a given folder using the collections module and then define additional quick filters to narrow-down by star rating and/or color label. + + + collections + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collections/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collections/ + Filter the images shown in the lighttable view and filmstrip panel using image attributes. This set of filtered images is known as a collection. Importing images into darktable stores information about them (filename, path, Exif data, data from XMP sidecar files etc.) in darktable&rsquo;s library database. A collection may be defined by applying filtering rules to these attributes, thus creating a subset of images to display in the lighttable view and the filmstrip module. + + + color assessment + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/color-assessment/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/color-assessment/ + Assess colors and brightness in your image using ISO 12646:2008 recommended viewing conditions. When developing an image, the way we perceive brightness, contrast and saturation is influenced by the surrounding ambient conditions. If an image is displayed against a dark background, this can have a number of adverse effects on our perception of that image: Exaggeration of the perceived exposure makes the image seems brighter than it really is. This is nicely illustrated by the Adelson checkerboard shadow effect. + + + duplicate manager + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/duplicate-manager/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/duplicate-manager/ + View and create multiple versions of the current image. Each version can be edited independently without affecting other versions &ndash; all versions use the same underlying image file, but the editing history of each version is stored in its own independent XMP sidecar file. The duplicate manager lists each version of the current darkroom image along with its preview thumbnail. Hold down the left mouse button on a thumbnail to temporarily show that version in the center view. + + + export + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/export/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/export/ + Export selected images. When used in the darkroom view, the currently-edited image will be exported if no other images are selected in the filmstrip. Files can be exported to a file on disk, email, various online storage locations, a web album, or a book template. 🔗module controls 🔗storage options target storage The type of location to store your selected images. A number of different back-ends are implemented, including file on disk, LaTeX book template and various web albums. + + + filmstrip + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/filmstrip/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/filmstrip/ + The filmstrip can be used to quickly switch between images. The images shown are the same as those displayed in the lighttable view and are defined by the currently-selected collection. The filmstrip can be switched on and off using the shortcut Ctrl+F. The height of the filmstrip panel can be changed by clicking and dragging its top border. Quickly navigate through the images in the filmstrip by scrolling with the mouse. + + + find location + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/find-location/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/find-location/ + Search for a location on the map. You must be connected to the internet to use this feature. To use this module, type in a place name or address, press Enter and a list of results will be shown. Click on an item in the list and the map will zoom to that location. An outline covering that location or a pin pointing at the location will be displayed. An outline (polygon) can be used to create a user location. + + + focus peaking + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/focus-peaking/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/focus-peaking/ + Identify which parts of the image contain high contrast details such as edges and textures, which are usually a useful guide to sharpness and therefore focus. Activate the module by clicking on the icon. The sharpest parts of the image will be highlighted with a yellow, green and blue overlay: Focus peaking works by filtering out most of the image noise, measuring the intensity gradients in the image and calculating average and standard deviation statistics. + + + gamut check + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/gamut/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/gamut/ + Highlight areas of the image that may exhibit gamut clipping. Click the icon to activate the gamut check display mode for your image. This function highlights, in cyan, all pixels that are out of gamut with respect to the selected softproof profile. You can also activate gamut check with the keyboard shortcut Ctrl+G. A message “gamut check” on the bottom left of your image tells you that you are in gamut check display mode. + + + geotagging + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/geotagging/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/geotagging/ + Import and apply GPX track data to a selection of images. This module is common to the lighttable and map views. The map view provides an enhanced mode that allows you to preview the position of the images along the GPS tracks while adjusting the images&rsquo; date/time offset and time zone. 🔗workflow overview A GPS receiver calculates its current position based on information it receives from satellites, and records it in a GPX file together with the current date and time. + + + global color picker + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/global-color-picker/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/global-color-picker/ + Take color samples from the current darkroom image, display their values in multiple ways and compare colors from different locations. The color picker is activated by pressing the picker icon. The module&rsquo;s parameters will remain in effect until you leave the darkroom mode. Besides the global color picker described here, many darktable modules (e.g. tone curve) also contain local pickers which are used to set individual module parameters. You should be aware that these two forms of picker do not always work in the same color space. + + + guides & overlays + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/guides-overlays/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/guides-overlays/ + A number of commonly-used compositional guides can be overlaid on your image while you are editing. These can be enabled either globally (all the time) or locally (when certain modules are active). Other darkroom functionality also draws colored overlay lines on the image (for example, drawn masks). An option is also provided to change the color of those overlays (see below). 🔗global guides Left-click the icon in the bottom bar to globally display guide overlays. + + + high quality processing + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/high-quality-processing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/high-quality-processing/ + Process the image in the darkroom view using &ldquo;high quality mode&rdquo;, so that the displayed image reflects the appearance of a full-sized export. Activate this mode by clicking the icon at the bottom of the darkroom view. Note that while this mode provides the most accurate representation of the processed image, it also results in signficant performance degredation. Please see the types of pixelpipe section for a full discussion. + + + history stack + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/history-stack/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/history-stack/ + View and modify the history stack of the current darkroom image. This module lists every change of state (activate/de-activate/move/change parameters) for all processing modules that have been modified for the current image. Select a point in the stack to return to that point in the development history of the image. Shift+click an item in the history stack to expand that module in the right-hand module panel without changing the current edit. + + + history stack + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/history-stack/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/history-stack/ + Manipulate the history stack of one or more selected images. 🔗module controls selective copy&hellip; Copy parts of the history stack from the selected image. A dialog will appear, from which you will be able to select which history stack items you want to copy. For any module, you may also choose to &ldquo;reset&rdquo; that module&rsquo;s parameters &ndash; this will cause the module to be copied but with all controls set to their initial (default) state (as if you had clicked the module reset button). + + + image information + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/image-information/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/image-information/ + Display information embedded within an image&rsquo;s Exif data as well as a number of additional data fields defined by darktable. When hovering with the mouse over image thumbnails, the displayed data is automatically updated to show information about the image currently under the mouse cursor. When several images are selected and the focus is not on a single image, the module only displays information that is the same for all images. + + + image information line + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/image-info-line/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/image-info-line/ + Display information about the current image in a darkroom panel. The contents of this line can be set in preferences &gt; darkroom. See the variables section for information about the variables that can be used here. You can also insert a newline with $(NL). The image information line can be displayed in the top, bottom, left or right panel depending on an additional configuration item in preferences &gt; darkroom. + + + import + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/import/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/import/ + Add images to the darktable library, optionally copying them from another location on the filesystem or from a connected camera. See supported file formats for more information. 🔗module controls The following buttons are shown in the module&rsquo;s UI by default: add to library Add existing images to the darktable library without copying or moving files. If you only add a single image to the library it will be automatically loaded in the darkroom. + + + live view + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/live-view/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/live-view/ + Control your camera&rsquo;s live view mode. Functionality such as focus control, rotation, guides and overlays are supported. + + + locations + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/locations/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/locations/ + Create areas or locations and organize them as hierarchical tags. A location is shown as a shape on the map when selected. Initially each location is represented as a square or circle and can be changed to a rectangle or ellipse by adjusting the shape&rsquo;s width and/or height. A location can also be created from an OpenStreetMap region (city/country) polygon. To achieve this, first make sure the max polygon points parameter is large enough (some country polygons use more than 150,000 points). + + + lua scripts installer + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/lua-scripts-installer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/lua-scripts-installer/ + As described in lua scripts, darktable provides powerful scripting capabilities to extend its functionality and integrate with other software. Many such scripts are already available. The Lua script installer module helps to install them without the need for manual configuration. The first time it is run, instructions are displayed in the module. For the module to be able to install the scripts, you will need to have git installed and available on your path. + + + map settings + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/map-settings/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/map-settings/ + Select preferred map data from various providers. Some will provide additional layers (satellite view etc.) which you can toggle. 🔗module controls map source Choose the provider to source map information from. max polygon points The find location module doesn&rsquo;t display polygons with more points than this for performance reasons. Usually a country polygon has between 50,000 and 150,000 points. show OSD Choose whether to display the OSD controls at the top-left of the center view. + + + mask manager + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/mask-manager/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/mask-manager/ + Manage all drawn masks and shapes for the current image. This module can be used to create, rename, edit and delete shapes. You can alter the shapes in a drawn mask, group shapes together, and combine them using set operators. The top line of the mask manager panel contains buttons that can be used to create new shapes. These are the same as in the drawn mask interface of the processing modules. + + + metadata editor + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/metadata-editor/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/metadata-editor/ + Edit the metadata of selected images. Metadata is freeformat text (title, description, creator, publisher, rights etc.) that describes your images. When several images are selected having different values for a given metadata field, the module displays for that field &ndash; if you choose to apply changes, these fields will not be changed. If you right-click on the field the different values are listed at the end of the contextual menu. Select one of the values in the menu to apply that value to all of the selected images &ndash; the change will be saved once you press the &ldquo;apply&rdquo; button or the Enter/Tab key. + + + module order + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/module-order/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/module-order/ + Change the order of the processing modules in the darkroom using presets. When processing an image, the active modules are applied in a specific order, which is shown in the right-hand panel of the darkroom view. This module provides information about the current ordering of the processing modules in the pixelpipe. The name of the currently-selected preset is shown in the module header (or &ldquo;custom&rdquo; if the user has manually modified the order). + + + navigation + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/navigation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/navigation/ + Zoom and pan the current image. The navigation panel (displayed on the top left hand side of the darkroom) shows a full preview of the current image with a rectangle showing the area that is currently visible in the central panel. You can interact with this module using your mouse in the same way as you can interact with the main image (scroll to zoom in/out, middle-click to cycle through zoom levels, click+drag to pan). + + + print settings + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/print-settings/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/print-settings/ + Manage settings for the print view and initiate printing. 🔗module controls 🔗printer printer Select one of the installed printers. media The type of media loaded on the printer (Plain Paper, Luster Photo Paper, etc.). profile The printer&rsquo;s ICC profile for the loaded paper. This is the profile specific to the printer and paper. This profile is the last color space transformation applied to the picture whose goal is to create a high quality print. + + + raw overexposed warning + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/raw-overexposed/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/raw-overexposed/ + Highlight areas of the image where color channels of the raw input file are clipped. Clipped color channels imply an overexposed image with loss of information in the affected areas. Some of this information may be recoverable using the highlight reconstruction, color reconstruction or filmic rgb modules. Click on the icon to show/hide the warning overlay. Right-click on the icon to open a dialog containing the following configuration parameters. mode Choose how to mark clipped areas: mark with CFA color: Display a pattern of the respective primary colors (red, green, and blue) to indicate which color channels are clipped. + + + recently used collections + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/recent-collections/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/recent-collections/ + Display a list of recently used collections generated by the collections module. This module may be hidden, depending on the preferences set in the collections module. Click on an entry to reopen the selected collection. This also updates the collections module with the appropriate filter criteria and rules. 🔗preferences The &ldquo;preferences&hellip;&rdquo; option in the presets menu allows you to adjust the behavior of the recent collections module as follows: number of recent collections to be stored The number of recent collections to store and display in the recent collections module (default 10) prefer a history button in the collections module Set whether you prefer to use this module or the history button in the collections module. + + + scopes + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/scopes/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/scopes/ + This module provides various graphical depictions of the developed image&rsquo;s light levels or chromaticity. Hover the mouse over the module to reveal buttons that can be used to adjust the display. The buttons on the left-hand-side are used to choose the display mode, from left-to-right: vectorscope, waveform, rgb parade and histogram. The buttons on the right-hand-side control how the plot for the current scope is drawn. The height of the scopes module can be changed by clicking-and-dragging on the bottom edge or by holding down Shift+Alt while scrolling the mouse. + + + selection + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/select/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/select/ + Select images in the lighttable according to simple criteria. 🔗module controls select all Select all images in the current collection. select none De-select all images. invert selection Select all images in the current collection that are not currently selected. select film roll Select all images in the current collection that are in the same film roll as the currently-selected images. select untouched Select all images in the current collection that have not yet been developed. + + + session + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/session/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/session/ + Set a session jobcode to allow the creation of a new film roll. A session is a sequence of exposures taken in tethering mode and placed into a single film roll. A new session means the creation of a new film roll. The session module allows you to set a jobcode, which can be used to create your new film roll. See preferences &gt; import &gt; session options for details about how to create new film rolls using the $(JOBCODE) variable in the session module. + + + snapshots + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/snapshots/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/snapshots/ + Store development snapshots and compare with the current edit. Snapshots can be taken at any point in the development process and later overlaid onto the current center view. This allows you to undertake a side by side comparison (by default left=snapshot, right=active edit) while you are tuning parameters of a module. It can also be combined with the history stack module to compare a snapshot against different stages of development. + + + soft proof + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/soft-proof/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/soft-proof/ + View your image rendered using a selected color profile. Click the icon to activate the soft proof display mode on your image. This allows you to preview your image rendered using a printer profile to see how colors will end up on the final print. You can also activate soft proof with the keyboard shortcut Ctrl+S. A message “soft proof&quot; on the bottom left of your image tells you that you are in soft proof display mode. + + + styles + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/styles/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/styles/ + Create named styles from selected images&rsquo; history stacks and apply styles to selected images. Styles can either be created within this panel or in the history stack module in the darkroom. A list of all available styles is displayed in the module. A search field above the list allows you to locate a style by name or description. This module also allows styles to be edited and deleted. Double-click on a style name to apply that style to all selected images. + + + tagging + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/tagging/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/tagging/ + Manage tags attached to images. Tags provide a means of adding information to images using a keyword dictionary. You can also manage tags as a hierarchical tree, which can be useful when their number becomes large. Tags are physically stored in XMP sidecar files as well as in darktable&rsquo;s library database and can be included in exported images. 🔗definitions The following definitions assume that you have set up a single tag named &ldquo;places|France|Nord|Lille&rdquo;. + + + timeline + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/timeline/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/timeline/ + View your images by the date/time they were taken. In the lighttable filemanager view, you can show/hide the timeline module in the bottom panel with the shortcut Ctrl+F. Within the timeline, you can show the next and previous dates by scrolling your mouse; Ctrl+scroll to zoom in/out. You can also use the timeline to select images by date range by clicking and dragging your mouse. + + + diff --git a/en/lighttable/digital-asset-management/collections/index.html b/en/lighttable/digital-asset-management/collections/index.html new file mode 100644 index 0000000000..b93b4ad400 --- /dev/null +++ b/en/lighttable/digital-asset-management/collections/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - collections & film rolls + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / digital asset management / collections & film rolls + +
+ + + + +
+ +

+ collections & film rolls +

+ + + +

A collection is a set of images matching a given selection criteria.

+

The most basic kind of collection is a film roll, which contains all of the images that have been imported from a specific folder on disk. Whenever you import images from the filesystem, those images are organized in a film roll whose name is derived from that of their parent folder.

+

You can easily construct other kinds of collection based on various image attributes (Exif data, filename, tags etc.) in the collections module. Multiple criteria can be logically combined to narrow or extend your collection.

+

darktable retains a list of the most recently used collections for quick access. These can be accessed from the recent collections module.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/digital-asset-management/grouping/index.html b/en/lighttable/digital-asset-management/grouping/index.html new file mode 100644 index 0000000000..9f49e373cd --- /dev/null +++ b/en/lighttable/digital-asset-management/grouping/index.html @@ -0,0 +1,3039 @@ + + + + + +darktable user manual - image grouping + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / digital asset management / image grouping + +
+ + + + +
+ +

+ image grouping +

+ + + +

Grouping images helps to improve the structure and clarity of your image collection when displayed in the lighttable view.

+

You can combine images into a group by selecting them and clicking the “group” button in the actions on selection module, or by pressing Ctrl+G. Likewise, you can remove selected images from a group by clicking the “ungroup” button, or pressing Ctrl+Shift+G.

+

Duplicated images are automatically grouped together. Similarly, if you import multiple images from the same directory, having the same base name, but different extensions (eg. IMG_1234.CR2 and IMG_1234.JPG), those images automatically form a group.

+

Images that are members of a group are denoted by a group icon + + + + + + + + +top panel_grouping icon + + in their thumbnails. Note that this icon is only shown when “overlays” are displayed on image thumbnails. Thumbnail overlays can be enabled by selecting the star icon in the top panel.

+

This icon also appears as a button, in the top panel of the lighttable view, that can be used to toggle grouping on and off. If grouping is off, all images are displayed as individual thumbnails. If grouping is on, the images in a group are represented by a single thumbnail image (the group leader). If you press the group icon in the group leader’s thumbnail, that group is expanded (click a second time to collapse). If you then expand another group, the first group collapses.

+

An expanded group in the filemanager mode of lighttable view is indicated by an orange frame that appears as soon as your mouse pointer hovers over one of the images. This frame surrounds all images in the group.

+

You can define which image is considered to be the group leader by clicking on the group icon of the desired image while that group is expanded. The group icon is shown only if grouping mode is enabled, so to change the group leader, you need to first enable grouping, expand the appropriate group and finally click the group icon of the desired “group leader” image. The current group leader is shown in a tooltip when you hover over the group icon of an image.

+

If you collapse an image group and then enter darkroom mode (e.g. by double-clicking on the thumbnail), the group leader image will be opened for developing.

+

Image groups are also a convenient way to protect an existing history stack against unintentional changes. If you have just finalized an image and want to protect its current version, simply select the image, click “duplicate” in the actions on selection panel, and make sure that grouping is switched on and that the group is collapsed. Now, whenever you open the image group again in the darkroom, only the group leader will be altered. The underlying duplicate will remain unchanged.

+
+

Note: “duplicating images” only generates a copy of an image’s history stack, stored in another small XMP file. There is still only one raw file.

+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/digital-asset-management/grouping/top-panel_grouping.png b/en/lighttable/digital-asset-management/grouping/top-panel_grouping.png new file mode 100644 index 0000000000..1a25cdaf2e Binary files /dev/null and b/en/lighttable/digital-asset-management/grouping/top-panel_grouping.png differ diff --git a/en/lighttable/digital-asset-management/index.html b/en/lighttable/digital-asset-management/index.html new file mode 100644 index 0000000000..46627dfdf3 --- /dev/null +++ b/en/lighttable/digital-asset-management/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - digital asset management + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Lighttable / digital asset management + +
+ + + + +
+ +

digital asset management

+ +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/digital-asset-management/index.xml b/en/lighttable/digital-asset-management/index.xml new file mode 100644 index 0000000000..37b3a1bc55 --- /dev/null +++ b/en/lighttable/digital-asset-management/index.xml @@ -0,0 +1,46 @@ + + + + digital asset management on darktable user manual + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/ + Recent content in digital asset management on darktable user manual + Hugo + en + + + collections & film rolls + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/collections/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/collections/ + A collection is a set of images matching a given selection criteria. The most basic kind of collection is a film roll, which contains all of the images that have been imported from a specific folder on disk. Whenever you import images from the filesystem, those images are organized in a film roll whose name is derived from that of their parent folder. You can easily construct other kinds of collection based on various image attributes (Exif data, filename, tags etc. + + + thumbnails + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/thumbnails/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/thumbnails/ + Each image in the current collection is represented by a thumbnail in the lighttable view and filmstrip module. A cache of the most recently used thumbnails is stored in a file on disk and loaded into memory at startup. 🔗thumbnail creation A thumbnail is created when an image is imported into darktable for the first time, after an image has been modified in the darkroom, or when revisiting an image whose thumbnail is no longer available. + + + star ratings & color labels + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/star-color/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/star-color/ + Star ratings and color labels help you to sort and rank images according to your own criteria. An image&rsquo;s star rating and color labels can be displayed over thumbnails in the lighttable view and filmstrip module. 🔗star ratings You can give an image a rating from zero to five stars. Whenever you import images, each image receives a default rating which you can define in the import module. You can also mark an image as “rejected”. + + + image grouping + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/grouping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/grouping/ + Grouping images helps to improve the structure and clarity of your image collection when displayed in the lighttable view. You can combine images into a group by selecting them and clicking the “group” button in the actions on selection module, or by pressing Ctrl+G. Likewise, you can remove selected images from a group by clicking the “ungroup” button, or pressing Ctrl+Shift+G. Duplicated images are automatically grouped together. Similarly, if you import multiple images from the same directory, having the same base name, but different extensions (eg. + + + metadata and tagging + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/metadata-tagging/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/metadata-tagging/ + darktable allows you to store additional information about your images to allow them to be more easily searched and grouped. This information is stored in darktable&rsquo;s database and XMP sidecar files and can also be included within exported images. 🔗metadata Metadata (e.g. title, description) is free-format text that usually differs for each image. You can add metadata to images in the metadata editor module. 🔗tagging Tags are usually shared between multiple images and are used to categorise and group them. + + + diff --git a/en/lighttable/digital-asset-management/metadata-tagging/index.html b/en/lighttable/digital-asset-management/metadata-tagging/index.html new file mode 100644 index 0000000000..df27968e0a --- /dev/null +++ b/en/lighttable/digital-asset-management/metadata-tagging/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - metadata and tagging + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / digital asset management / metadata and tagging + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ metadata and tagging +

+ + + +

darktable allows you to store additional information about your images to allow them to be more easily searched and grouped. This information is stored in darktable’s database and XMP sidecar files and can also be included within exported images.

+

🔗metadata

+

Metadata (e.g. title, description) is free-format text that usually differs for each image. You can add metadata to images in the metadata editor module.

+

🔗tagging

+

Tags are usually shared between multiple images and are used to categorise and group them. You can add tags to images in the tagging module.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/digital-asset-management/star-color/index.html b/en/lighttable/digital-asset-management/star-color/index.html new file mode 100644 index 0000000000..ef93e3e281 --- /dev/null +++ b/en/lighttable/digital-asset-management/star-color/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - star ratings & color labels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / digital asset management / star ratings & color labels + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ star ratings & color labels +

+ + + +

Star ratings and color labels help you to sort and rank images according to your own criteria. An image’s star rating and color labels can be displayed over thumbnails in the lighttable view and filmstrip module.

+

🔗star ratings

+

You can give an image a rating from zero to five stars. Whenever you import images, each image receives a default rating which you can define in the import module. You can also mark an image as “rejected”.

+

There are several ways to change a rating. While hovering the cursor over an image thumbnail, you can press a number key 0 – 5 to define the number of stars, or press R to “reject” an image. This is probably the fastest way to rate your images on first inspection of a film roll.

+

You can also directly click on the star icons that are overlaid on the thumbnails or in the bottom panel. Click the x to reject.

+

As rejecting an image removes the currently-applied star rating, you can undo the rejection by clicking x or pressing R again.

+

Similarly you can click the first star for a second time to reset the image rating to unranked, or zero stars. This behavior can be changed in preferences > lighttable.

+

To rate multiple images at once, select those images in the lighttable or filmstrip and then press the appropriate shortcut key, or click the desired star rating in the bottom panel of the lighttable view.

+

You can filter images by star rating in the top panel.

+

🔗color labels

+

Color labels are another way to classify images, and can be used as an alternative to star ratings or to work alongside them. Each image can carry any combination of one or more color labels (red, yellow, green, blue, or purple).

+

You can set the color labels for a single image by hovering your cursor over the thumbnail and pressing the function keys F1 – F5, which correspond with the labels in the order given above.

+

To set the color labels of one or more images, select the desired images in the lighttable or filmstrip and then press the appropriate shortcut key or click the corresponding color button in the bottom panel. A color label will be added to all selected images if any of them do not currently have the label; otherwise the label will be removed from all selected images. To remove all labels (of any color) from the selected images, press the gray button.

+

You can filter images by color label in the collections module.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/digital-asset-management/thumbnails/index.html b/en/lighttable/digital-asset-management/thumbnails/index.html new file mode 100644 index 0000000000..7502adb224 --- /dev/null +++ b/en/lighttable/digital-asset-management/thumbnails/index.html @@ -0,0 +1,3051 @@ + + + + + +darktable user manual - thumbnails + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / digital asset management / thumbnails + +
+ + + + +
+ +

+ thumbnails +

+ + + +

Each image in the current collection is represented by a thumbnail in the lighttable view and filmstrip module. A cache of the most recently used thumbnails is stored in a file on disk and loaded into memory at startup.

+

🔗thumbnail creation

+

A thumbnail is created when an image is imported into darktable for the first time, after an image has been modified in the darkroom, or when revisiting an image whose thumbnail is no longer available.

+

When an image is imported for the first time darktable can either try to extract an embedded thumbnail from the input image (most raw files contain these, usually in JPEG format) or process the raw image itself using default settings. You can define how darktable obtains its thumbnails in preferences > lighttable > thumbnails.

+

Extracting an embedded thumbnail from the input image is usually very fast. However, these thumbnails have been generated by the raw converter of the camera and do not represent darktable’s “view” of that image. You will notice the difference as soon as you open the image in the darkroom mode, at which point darktable replaces the thumbnail with its own internally processed version.

+

After import darktable automatically generates thumbnails for new images as they are needed. When importing a large set of new images, thumbnail generation can slow down navigation in the lighttable view. Alternatively you may terminate darktable and generate the thumbnail cache separately by running darktable-generate-cache. This program will generate all missing thumbnails in one go.

+

As the thumbnail cache has a pre-defined maximum size it will eventually get filled up. If new thumbnails are subsequently added, old thumbnails are dropped from the cache. However, darktable will keep all thumbnails on disk if the corresponding disk backend option is activated in preferences > lighttable > thumbnails. Access to the thumbnails in this secondary cache is slower than the primary cache, but still much faster than reprocessing thumbnails from scratch. The size of the secondary cache is limited only by the available disk space.

+

Thumbnails are never removed from the secondary cache. You can manually clean the secondary cache by recursively deleting all images in the $HOME/.cache/darktable/mipmaps-xyz.d folder (where xyz denotes an alphanumeric identifier of the cache). After clearing the secondary cache you can simply allow darktable to re-generate thumbnails as needed, or you can generate all thumbnails in one go with darktable-generate-cache.

+

If you choose not to activate the disk backend and select too small a cache size, darktable may become unresponsive, you may experience continuous regeneration of thumbnails when you navigate your collection or flickering of thumbnail images. A good choice of cache size is 512MB or higher (see memory & performance tuning for more information).

+

All thumbnails are fully color managed. Colors are rendered accurately on screen as long as your system is properly set up to hand over the right monitor profile to darktable. For more information see the color management section.

+

🔗skulls

+

If for some reason darktable is unable to generate a thumbnail, it displays an image of a skull + + + + + + + + +skull icon + + instead. Don’t panic!

+

There are three main reasons this could happen:

+
    +
  • +

    Missing image file: darktable remembers all images it has ever imported, as long as they have not been removed from your database. If darktable wants to create a thumbnail but is not able to open the input file, a skull is displayed instead. Users are advised to remove images from the database using the actions on selection module before physically removing them from disk. Alternatively you may occasionally run the script purge_non_existing_images.sh from darktable’s toolset to clean-up your database.

    +
  • +
  • +

    Invalid image format: While the extension of an image may seem to be supported by darktable, its contents could be either an unsupported image format or a corrupt file.

    +
  • +
  • +

    Low memory: If darktable runs out of memory while generating a thumbnail, it will warn you and display a skull. This can happen if darktable is run with sub-optimal settings, especially on a 32-bit system. See memory & performance tuning for more information.

    +
  • +
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/digital-asset-management/thumbnails/skull.png b/en/lighttable/digital-asset-management/thumbnails/skull.png new file mode 100644 index 0000000000..1b1ea40e34 Binary files /dev/null and b/en/lighttable/digital-asset-management/thumbnails/skull.png differ diff --git a/en/lighttable/index.html b/en/lighttable/index.html new file mode 100644 index 0000000000..1e70bbd43b --- /dev/null +++ b/en/lighttable/index.html @@ -0,0 +1,3043 @@ + + + + + +darktable user manual - Lighttable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Lighttable + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

Lighttable

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/index.xml b/en/lighttable/index.xml new file mode 100644 index 0000000000..fedc0a780b --- /dev/null +++ b/en/lighttable/index.xml @@ -0,0 +1,32 @@ + + + + Lighttable on darktable user manual + https://darktable-org.github.io/dtdocs/en/lighttable/ + Recent content in Lighttable on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/lighttable/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/overview/ + The lighttable view allows you to view and manage your image collection. The centre view contains thumbnails of your images &ndash; how they are displayed depends on which mode you are working in. While the mouse is over an image thumbnail or images are selected, there are a number of actions you can perform with keyboard shortcuts: F1, F2, F3, F4, F5 adds or removes a color label (red, yellow, green, blue, purple, respectively). + + + lighttable view layout + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-view-layout/ + 🔗left panel From top to bottom: import Import images from the filesystem or a connected camera. collections Filter the images displayed in the lighttable center panel &ndash; also used to control the images displayed in the filmstrip and timeline modules. recently used collections View recently used collections of images. image information Display image information. lua scripts installer (optional) Install lua scripts. 🔗right panel From top to bottom: selection Select images in the lighttable using simple criteria. + + + undo/redo + https://darktable-org.github.io/dtdocs/en/lighttable/undo-redo/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/undo-redo/ + Most changes made within the lighttable are recorded and can be reverted to a previous state. This includes modifications to color labels, ratings, geo-localization, tags, metadata, orientation, copy/paste of history, image duplication, or application of a style. Note that the facility to undo/redo actions is unlimited in the number of steps while in the lighttable view, but it is reset each time you switch to a different view. Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any). + + + diff --git a/en/lighttable/lighttable-modes/culling/index.html b/en/lighttable/lighttable-modes/culling/index.html new file mode 100644 index 0000000000..fe8d231e8e --- /dev/null +++ b/en/lighttable/lighttable-modes/culling/index.html @@ -0,0 +1,3046 @@ + + + + + +darktable user manual - culling + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / lighttable modes / culling + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ culling +

+ + + +

Culling mode allows you to display images side by side for easy comparison.

+

🔗controls

+
+
zoom
+
In culling mode, you can zoom into images (up to 100%) by holding Ctrl while scrolling with the mouse wheel.
+
Pan within zoomed images with click+drag.
+
By default, zooming and panning are synchronized between all visible images. If you want to zoom or pan only a specific image, add the Shift modifier to the above actions.
+
navigate
+
Use the mouse wheel or arrow keys (←/→) to scroll through your collection.
+
+

🔗modes

+

There are two different culling modes, which define how many images are shown at the same time: “fixed” and “dynamic”. Switch between these while in culling mode by pressing the “<” key.

+
+
fixed mode
+
The number of images displayed is always the same, independent of the selection length. This number can be set with a slider on the bottom panel.
+
+

In this mode, you will navigate through all selected images. If no selection is set (or if only one image is selected), you will navigate through all images.

+
+
+

The default keyboard shortcut to enter culling in fixed mode is X.

+
+
dynamic mode
+
All of the selected images are shown. If no selection is set (or if only one image is selected) the last value from fixed mode is used.
+
+

The default keyboard shortcut to enter culling in dynamic mode is Ctrl+X.

+
+
+
+

Hint: To enhance performance when loading zoomed images, you can enable (preferences > processing > cpu/gpu/memory > enable disk backend for full preview cache). Bear in mind that this can occupy a lot of disk space.

+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/lighttable-modes/filemanager/index.html b/en/lighttable/lighttable-modes/filemanager/index.html new file mode 100644 index 0000000000..b4717e23c6 --- /dev/null +++ b/en/lighttable/lighttable-modes/filemanager/index.html @@ -0,0 +1,3026 @@ + + + + + +darktable user manual - filemanager + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / lighttable modes / filemanager + +
+ + + + +
+ +

+ filemanager +

+ + + +

In the default mode images are displayed in a grid with an adjustable number of images per row.

+

🔗controls

+
+
zoom
+
The number of images in each row can be altered using the slider in the bottom panel, or by holding Ctrl while scrolling over the center view with your mouse.
+
navigate
+
You can navigate through the images using the arrow keys (←/→/↑/↓) or by scrolling with your mouse. Press the Home key to scroll to the top of the collection, the End key to scroll to the bottom, and PageUp/PageDown to scroll up/down by a page.
+
select
+
You can select the image under the pointer by clicking on its thumbnail or by pressing Enter. A range of images can be selected by clicking on the first image and then Shift+clicking on the last one. Images can be added or removed from a selection by Ctrl+clicking on their thumbnails or by pressing Spacebar.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/lighttable-modes/full-preview/index.html b/en/lighttable/lighttable-modes/full-preview/index.html new file mode 100644 index 0000000000..48fe3fab46 --- /dev/null +++ b/en/lighttable/lighttable-modes/full-preview/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - full preview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / lighttable modes / full preview + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ full preview +

+ + + +

From any of the lighttable modes, you can display a fully-zoomed preview of the image that is currently under the mouse pointer by pressing and holding down W. This is useful to more closely inspect an image while rating and selecting images.

+

Pressing and holding Ctrl+W fully zooms into the image and also identifies any regions of sharpness in the image that may indicate image focus. For this tool to work the input image needs to hold an embedded JPEG thumbnail, which is the case for most raw files.

+

Regions in the image with a high level of sharpness are indicated with red borders. If no such regions are found, any regions of moderate sharpness are identified with a blue border. Note that this is not the same as the focus peaking indicator, which is another way to identifying areas of sharpness within an image.

+

Sometimes pressing W or Ctrl+W may not appear to have any effect – in such cases, click on the image thumbnail and press the corresponding key again.

+

If you want the full preview to stay in place without having to hold the W key, you can enable sticky preview mode by pressing F. In sticky preview mode, you can zoom and pan within the image in a similar way to the culling mode. Press F or ESC to return to the original view.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/lighttable-modes/index.html b/en/lighttable/lighttable-modes/index.html new file mode 100644 index 0000000000..90d0b76c1d --- /dev/null +++ b/en/lighttable/lighttable-modes/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - lighttable modes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Lighttable / lighttable modes + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

lighttable modes

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/lighttable-modes/index.xml b/en/lighttable/lighttable-modes/index.xml new file mode 100644 index 0000000000..128516f7d3 --- /dev/null +++ b/en/lighttable/lighttable-modes/index.xml @@ -0,0 +1,39 @@ + + + + lighttable modes on darktable user manual + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/ + Recent content in lighttable modes on darktable user manual + Hugo + en + + + filemanager + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/filemanager/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/filemanager/ + In the default mode images are displayed in a grid with an adjustable number of images per row. 🔗controls zoom The number of images in each row can be altered using the slider in the bottom panel, or by holding Ctrl while scrolling over the center view with your mouse. navigate You can navigate through the images using the arrow keys (←/→/↑/↓) or by scrolling with your mouse. Press the Home key to scroll to the top of the collection, the End key to scroll to the bottom, and PageUp/PageDown to scroll up/down by a page. + + + zoomable lighttable + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/zoomable-lighttable/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/zoomable-lighttable/ + The zoomable lighttable mode provides an alternative way to navigate large collections of images, but with some similarities to the filemanager mode (described below). 🔗controls zoom Scroll with the mouse wheel to zoom in and out of the lighttable (compared to Ctrl+scroll in filemanager mode). Zooming the thumbnails does not change the number of thumbnails per row, so the lighttable can exceed the visible area on all sides. navigate Hold down the left mouse button and drag to move the lighttable around and navigate through your collection. + + + culling + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/culling/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/culling/ + Culling mode allows you to display images side by side for easy comparison. 🔗controls zoom In culling mode, you can zoom into images (up to 100%) by holding Ctrl while scrolling with the mouse wheel. Pan within zoomed images with click+drag. By default, zooming and panning are synchronized between all visible images. If you want to zoom or pan only a specific image, add the Shift modifier to the above actions. + + + full preview + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/full-preview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/full-preview/ + From any of the lighttable modes, you can display a fully-zoomed preview of the image that is currently under the mouse pointer by pressing and holding down W. This is useful to more closely inspect an image while rating and selecting images. Pressing and holding Ctrl+W fully zooms into the image and also identifies any regions of sharpness in the image that may indicate image focus. For this tool to work the input image needs to hold an embedded JPEG thumbnail, which is the case for most raw files. + + + diff --git a/en/lighttable/lighttable-modes/zoomable-lighttable/index.html b/en/lighttable/lighttable-modes/zoomable-lighttable/index.html new file mode 100644 index 0000000000..eaef798df2 --- /dev/null +++ b/en/lighttable/lighttable-modes/zoomable-lighttable/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - zoomable lighttable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Lighttable / lighttable modes / zoomable lighttable + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ zoomable lighttable +

+ + + +

The zoomable lighttable mode provides an alternative way to navigate large collections of images, but with some similarities to the filemanager mode (described below).

+

🔗controls

+
+
zoom
+
Scroll with the mouse wheel to zoom in and out of the lighttable (compared to Ctrl+scroll in filemanager mode).
+
Zooming the thumbnails does not change the number of thumbnails per row, so the lighttable can exceed the visible area on all sides.
+
navigate
+
Hold down the left mouse button and drag to move the lighttable around and navigate through your collection.
+
select
+
As with the filemanager mode, you can select the image under the pointer by clicking on its thumbnail or by pressing Enter. A range of images can be selected by clicking on the first image and then Shift+clicking on the last one. Images can be added to or removed from a selection by Ctrl+clicking on their thumbnails or by pressing Spacebar.
+
+
+

Hint: you may find that image thumbnails are slow to load when zooming quickly through a large collection. One way to speed up the navigation is to generate a cache containing all the thumbnails using the darktable-generate-cache command.

+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/lighttable-view-layout/index.html b/en/lighttable/lighttable-view-layout/index.html new file mode 100644 index 0000000000..ce424d380a --- /dev/null +++ b/en/lighttable/lighttable-view-layout/index.html @@ -0,0 +1,3099 @@ + + + + + +darktable user manual - lighttable view layout + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Lighttable / lighttable view layout + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ lighttable view layout +

+ + + +

🔗left panel

+

From top to bottom:

+
+
import
+
Import images from the filesystem or a connected camera.
+
collections
+
Filter the images displayed in the lighttable center panel – also used to control the images displayed in the filmstrip and timeline modules.
+
recently used collections
+
View recently used collections of images.
+
image information
+
Display image information.
+
lua scripts installer (optional)
+
Install lua scripts.
+
+

🔗right panel

+

From top to bottom:

+
+
selection
+
Select images in the lighttable using simple criteria.
+
actions on selection
+
Perform actions on selected images.
+
history stack
+
Manipulate the history stack of selected images.
+
styles
+
Store an image’s history stack as a named style and apply it to other images.
+
metadata editor
+
Edit metadata for selected images.
+
tagging
+
Tag selected images.
+
geotagging
+
Import and apply GPX track data to selected images.
+
export
+
Export selected images to local files or external services.
+
+

🔗bottom panel

+

+ + + + + + + + +lighttable-bottom-panel + +

+

From left to right:

+
+
star ratings
+
Apply star ratings to images.
+
color labels
+
Apply color labels to images.
+
mode selector
+
Choose a lighttable mode.
+
zoom
+
Adjust the size of thumbnails.
+
+ + + + + + + + +focus icon + + enable focus-peaking mode
+
Highlight the parts of the image that are in focus.
+
+ + + + + + + + +display icon + + set display profile
+
Set the display profile of your monitor(s).
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/lighttable-view-layout/lighttable-bottom-panel.png b/en/lighttable/lighttable-view-layout/lighttable-bottom-panel.png new file mode 100644 index 0000000000..82aa646714 Binary files /dev/null and b/en/lighttable/lighttable-view-layout/lighttable-bottom-panel.png differ diff --git a/en/lighttable/lighttable-view-layout/lighttable-bottom-panel_display.png b/en/lighttable/lighttable-view-layout/lighttable-bottom-panel_display.png new file mode 100644 index 0000000000..1854670b94 Binary files /dev/null and b/en/lighttable/lighttable-view-layout/lighttable-bottom-panel_display.png differ diff --git a/en/lighttable/lighttable-view-layout/lighttable-bottom-panel_focus.png b/en/lighttable/lighttable-view-layout/lighttable-bottom-panel_focus.png new file mode 100644 index 0000000000..a68a03e8f2 Binary files /dev/null and b/en/lighttable/lighttable-view-layout/lighttable-bottom-panel_focus.png differ diff --git a/en/lighttable/overview/index.html b/en/lighttable/overview/index.html new file mode 100644 index 0000000000..f3666b19dc --- /dev/null +++ b/en/lighttable/overview/index.html @@ -0,0 +1,3053 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Lighttable / overview + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ overview +

+ + + +

The lighttable view allows you to view and manage your image collection.

+

The centre view contains thumbnails of your images – how they are displayed depends on which mode you are working in.

+

While the mouse is over an image thumbnail or images are selected, there are a number of actions you can perform with keyboard shortcuts:

+
    +
  • +

    F1, F2, F3, F4, F5 adds or removes a color label (red, yellow, green, blue, purple, respectively). A color label will be added if any selected image does not currently have the label; otherwise the label will be removed

    +
  • +
  • +

    0, 1, 2, 3, 4, 5 sets the star rating

    +
  • +
  • +

    R rejects the image(s)

    +
  • +
  • +

    Ctrl+D duplicates the image(s)

    +
  • +
  • +

    Ctrl+C copies the full history stack

    +
  • +
  • +

    Ctrl+V pastes all of the copied history stack

    +
  • +
  • +

    Ctrl+Shift+C selectively copies the history stack

    +
  • +
  • +

    Ctrl+Shift+V selectively pastes from the copied history stack

    +
  • +
  • +

    D opens the image in the darkroom view for developing

    +
  • +
  • +

    W fully zooms into the current image while the key is pressed

    +
  • +
  • +

    Ctrl+W fully zooms into the current image and show areas in focus

    +
  • +
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lighttable/undo-redo/index.html b/en/lighttable/undo-redo/index.html new file mode 100644 index 0000000000..2cc5f57208 --- /dev/null +++ b/en/lighttable/undo-redo/index.html @@ -0,0 +1,3017 @@ + + + + + +darktable user manual - undo/redo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Lighttable / undo/redo + +
+ + + + +
+ +

+ undo/redo +

+ + + +

Most changes made within the lighttable are recorded and can be reverted to a previous state. This includes modifications to color labels, ratings, geo-localization, tags, metadata, orientation, copy/paste of history, image duplication, or application of a style. Note that the facility to undo/redo actions is unlimited in the number of steps while in the lighttable view, but it is reset each time you switch to a different view.

+

Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any).

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/a-simple-example/index.html b/en/lua/a-simple-example/index.html new file mode 100644 index 0000000000..ada63375f9 --- /dev/null +++ b/en/lua/a-simple-example/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - a simple lua example + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / a simple lua example + +
+ + + + +
+ +

+ a simple lua example +

+ + + +

Let’s start with a simple example that will print some code on the console. Create a file called luarc in darktable’s configuration directory (usually $HOME/.config/darktable/) and add the following line to it:

+
print("Hello World !")
+

Start darktable and you will see the sentence “Hello World !” printed on the console. Nothing fancy but it’s a start.

+

At this point, there is nothing darktable-specific in the script. We simply use Lua’s standard print function to print a string. That’s nice and all, but we can do better than that. To access the darktable API you first need to require it and save the returned object in a variable. Once this is done you can access the darktable API as subfields of the returned object. All of this is documented in darktable’s Lua API reference manual.

+
local darktable = require "darktable"
+darktable.print_error("Hello World !")
+

Run the script and … nothing happens. The function darktable.print_error is just like print but will only print the message if you have enabled lua traces by running darktable with “darktable -d lua” on the command line. This is the recommended way to do traces in a darktable lua script.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/api/index.html b/en/lua/api/index.html new file mode 100644 index 0000000000..c4498e8975 --- /dev/null +++ b/en/lua/api/index.html @@ -0,0 +1,3016 @@ + + + + + +darktable user manual - lua API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / lua API + +
+ + + + +
+ +

+ lua API +

+ + + +

darktable’s Lua API is documented in its own manual with a detailed description of all data structures and functions. You can download the API manual from here.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/basic-principles/index.html b/en/lua/basic-principles/index.html new file mode 100644 index 0000000000..a369261963 --- /dev/null +++ b/en/lua/basic-principles/index.html @@ -0,0 +1,3017 @@ + + + + + +darktable user manual - basic principles: luarc files + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / basic principles: luarc files + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ basic principles: luarc files +

+ + + +

At startup, darktable will automatically run the Lua scripts $DARKTABLE/share/darktable/luarc and $HOME/.config/darktable/luarc (where $DARKTABLE represents the darktable installation directory and $HOME represents your home directory).

+

This is the only time darktable will run Lua scripts by itself. These scripts can register callbacks to perform actions on various darktable events. This callback mechanism is the primary method of triggering lua actions.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/building-ui-elements/index.html b/en/lua/building-ui-elements/index.html new file mode 100644 index 0000000000..b37d22ed2f --- /dev/null +++ b/en/lua/building-ui-elements/index.html @@ -0,0 +1,3057 @@ + + + + + +darktable user manual - building user interface elements + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / building user interface elements + +
+ + + + +
+ +

+ building user interface elements +

+ + + +

Our previous example was a bit limited. In particular the use of a preference for the export path wasn’t very nice. We can do better than that by adding elements to the user interface in the export dialog.

+

UI elements are created via the darktable.new_widget function. This function takes a type of widget as a parameter and returns a new object corresponding to that widget. You can then set various fields in that widget to set its parameters. You will then use that object as a parameter to various functions that will add it to the darktable UI. The following simple example adds a lib in the lighttable view with a simple label:

+
darktable = require "darktable"
+
+local my_label = darktable.new_widget("label")
+my_label.label = "Hello, world !"
+
+darktable.register_lib("test","test",false,false,{
+    [darktable.gui.views.lighttable] = {"DT_UI_CONTAINER_PANEL_LEFT_CENTER",20},
+  },my_label)
+

There is a nice syntactic trick to make UI elements code easier to read and write. You can call these objects as functions with a table of key values as an argument. This allows the following example to work. It creates a container widget with two sub-widgets: a label and a text entry field.

+
local my_widget = darktable.new_widget("box"){
+  orientation = "horizontal",
+  darktable.new_widget("label"){ label = "here => " },
+  darktable.new_widget("entry"){ tooltip = "please enter text here" }
+}
+

Now that we know that, let’s improve our script a bit.

+
darktable = require "darktable"
+
+local scp_path = darktable.new_widget("entry"){
+  tooltip = "Complete path to copy to. Can include user and hostname",
+  text = "",
+  reset_callback = function(self) self.text = "" end
+}
+
+darktable.register_storage("scp_export","Export via scp",
+  function( storage, image, format, filename,
+     number, total, high_quality, extra_data)
+    if not darktable.control.execute("scp "..filename.." "..
+      scp_path.text
+    ) then
+      darktable.print_error("scp failed for "..tostring(image))
+    end
+  end,
+  nil, --finalize
+  nil, --supported
+  nil, --initialize
+  darktable.new_widget("box") {
+    orientation = "horizontal",
+    darktable.new_widget("label"){ label = "target SCP PATH " },
+    scp_path,
+})
+
+ + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/calling-from-dbus/index.html b/en/lua/calling-from-dbus/index.html new file mode 100644 index 0000000000..bae68dd747 --- /dev/null +++ b/en/lua/calling-from-dbus/index.html @@ -0,0 +1,3017 @@ + + + + + +darktable user manual - calling lua from dbus + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / calling lua from dbus + +
+ + + + +
+ +

+ calling lua from dbus +

+ + + +

It is possible to send a lua command to darktable via its DBus interface. The method org.darktable.service.Remote.Lua takes a single string parameter which is interpreted as a lua command. The command will be executed in the current lua context and should return either nil or a string. The result will be passed back as the result of the DBus method.

+

If the Lua call results in an error, the DBus method call will return an error org.darktable.Error.LuaError with the lua error message as the message attached to the DBus error.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/darktable-from-lua/index.html b/en/lua/darktable-from-lua/index.html new file mode 100644 index 0000000000..303cf6f5fe --- /dev/null +++ b/en/lua/darktable-from-lua/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - using darktable from a lua script + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / using darktable from a lua script + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ using darktable from a lua script +

+ + + +

Warning: This feature is very experimental. It is known that several elements don’t yet work in library mode. Careful testing is highly recommended.

+

The lua interface allows you to use darktable from any lua script. This will load darktable as a library and provide you with most of the lua API (darktable is configured headless, so the functions relating to the user interface are not available).

+

As an example, the following program will print the list of all images in your library:

+
#!/usr/bin/env lua
+package = require "package"
+package.cpath=package.cpath..";./lib/darktable/lib?.so"
+
+dt = require("darktable")(
+"--library", "./library.db",
+"--datadir", "./share/darktable",
+"--moduledir", "./lib/darktable",
+"--configdir", "./configdir",
+"--cachedir","cachedir",
+"--g-fatal-warnings")
+
+require("darktable.debug")
+
+for k,v in ipairs(dt.database) do
+   print(tostring(v))
+end
+

Note the third line that points to the location of the libdarktable.so file.

+

Also note that the call to require returns a function that can be called only once and allows you to set darktable’s command line parameter. The :memory: parameter to --library is useful here if you don’t want to work on your personal library.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/exporting-images/index.html b/en/lua/exporting-images/index.html new file mode 100644 index 0000000000..3e93f4c166 --- /dev/null +++ b/en/lua/exporting-images/index.html @@ -0,0 +1,3052 @@ + + + + + +darktable user manual - exporting images with lua + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / exporting images with lua + +
+ + + + +
+ +

+ exporting images with lua +

+ + + +

So far we have learned to use lua to adapt darktable to our particular workflow. Let’s look now at how to use lua to easily export images to an online service. If you are able to upload an image to a service via the command line then you can use lua to integrate this into darktable’s user interface.

+

In this next example we will use lua to export via scp. A new storage type will appear in darktable’s UI that will export images to a remote target via the copy mechanism in ssh.

+
darktable = require "darktable"
+
+darktable.preferences.register("scp_export","export_path",
+  "string","target SCP path",
+  "Complete path to copy to. Can include user and hostname","")
+
+darktable.register_storage("scp_export","Export via scp",
+  function( storage, image, format, filename,
+     number, total, high_quality, extra_data)
+    if not darktable.control.execute("scp "..filename.." "..
+      darktable.preferences.read("scp_export",
+         "export_path","string")) then
+      darktable.print_error("scp failed for "..tostring(image))
+    end
+end)
+

darktable.preferences.register will add a new preference to darktable’s preferences menu, scp_export and export_path allow us to uniquely identify our preference. These fields are reused when we read the value of the preference. The string field tells the lua engine that the preference is a string. It could also be an integer, a filename or any of the types detailed in the API manual relating to types_lua_pref_type. We then have the label for the preference in the preference menu, the tooltip when hovering over the value and a default value.

+

darktable.register_storage is the call that actually registers a new storage type. The first argument is a name for the storage type, the second is the label that will be displayed in the UI and last is a function to call on each image. This function has a lot of parameters, but filename is the only one we use in this example. It contains the name of a temporary file where the image was exported by darktable’s engine.

+

This code will work but it has a couple of limitations. This is just a simple example after all:

+
    +
  • +

    We use preferences to configure the target path. It would be nicer to add an element to the export UI in darktable. We will detail how to do that in the next section.

    +
  • +
  • +

    We do not check the returned value of scp. That command might fail, in particular if the user has not correctly set the preference.

    +
  • +
  • +

    This script can’t read input from the user. The remote scp must use password-less copy – scp can’t be provided with a password easily, so we will leave it that way.

    +
  • +
  • +

    There is no message displayed once the example is done, only the progress bar on the lower left side tells the user that the job is complete.

    +
  • +
  • +

    We use darktable.control.execute to call an external program. The normal os.execute would block other lua codes from happening.

    +
  • +
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/index.html b/en/lua/index.html new file mode 100644 index 0000000000..fdacfa537a --- /dev/null +++ b/en/lua/index.html @@ -0,0 +1,3085 @@ + + + + + +darktable user manual - Scripting with Lua + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/index.xml b/en/lua/index.xml new file mode 100644 index 0000000000..a1311d9533 --- /dev/null +++ b/en/lua/index.xml @@ -0,0 +1,88 @@ + + + + Scripting with Lua on darktable user manual + https://darktable-org.github.io/dtdocs/en/lua/ + Recent content in Scripting with Lua on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/lua/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/overview/ + Lua scripts can be used to define actions for darktable to perform when an event is triggered. One example might be calling an external application during file export in order to apply additional processing steps outside of darktable. Lua is an independent project founded in 1993, providing a powerful, fast, lightweight, embeddable scripting language. Lua is widely used by many open source applications, in commercial programs, and for games programming. + + + basic principles: luarc files + https://darktable-org.github.io/dtdocs/en/lua/basic-principles/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/basic-principles/ + At startup, darktable will automatically run the Lua scripts $DARKTABLE/share/darktable/luarc and $HOME/.config/darktable/luarc (where $DARKTABLE represents the darktable installation directory and $HOME represents your home directory). This is the only time darktable will run Lua scripts by itself. These scripts can register callbacks to perform actions on various darktable events. This callback mechanism is the primary method of triggering lua actions. + + + a simple lua example + https://darktable-org.github.io/dtdocs/en/lua/a-simple-example/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/a-simple-example/ + Let&rsquo;s start with a simple example that will print some code on the console. Create a file called luarc in darktable&rsquo;s configuration directory (usually $HOME/.config/darktable/) and add the following line to it: print(&#34;Hello World !&#34;) Start darktable and you will see the sentence &ldquo;Hello World !&rdquo; printed on the console. Nothing fancy but it&rsquo;s a start. At this point, there is nothing darktable-specific in the script. We simply use Lua&rsquo;s standard print function to print a string. + + + printing labeled images + https://darktable-org.github.io/dtdocs/en/lua/printing-labeled-images/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/printing-labeled-images/ + The first example showed us the very basics of lua and allowed us to check that everything was working properly. Now let&rsquo;s do something a little bit more complex. Let&rsquo;s try to print a list of images that have a &ldquo;red&rdquo; label attached to them. But first of all, what is an image? local darktable = require &#34;darktable&#34; local debug = require &#34;darktable.debug&#34; print(darktable.debug.dump(darktable.database[1])) Running the code above will produce a lot of output. + + + adding a simple shortcut + https://darktable-org.github.io/dtdocs/en/lua/simple-shortcut/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/simple-shortcut/ + So far, all our scripts have done things during startup. This is of limited use and doesn&rsquo;t allow us to react to real user actions. To do more advanced things we need to register a function that will be called on a given event. The most common event to react to is a keyboard shortcut. darktable = require &#34;darktable&#34; local function hello_shortcut(event, shortcut) darktable.print(&#34;Hello, I just received &#39;&#34;..event.. &#34;&#39; with parameter &#39;&#34;. + + + exporting images with lua + https://darktable-org.github.io/dtdocs/en/lua/exporting-images/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/exporting-images/ + So far we have learned to use lua to adapt darktable to our particular workflow. Let&rsquo;s look now at how to use lua to easily export images to an online service. If you are able to upload an image to a service via the command line then you can use lua to integrate this into darktable&rsquo;s user interface. In this next example we will use lua to export via scp. A new storage type will appear in darktable&rsquo;s UI that will export images to a remote target via the copy mechanism in ssh. + + + building user interface elements + https://darktable-org.github.io/dtdocs/en/lua/building-ui-elements/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/building-ui-elements/ + Our previous example was a bit limited. In particular the use of a preference for the export path wasn&rsquo;t very nice. We can do better than that by adding elements to the user interface in the export dialog. UI elements are created via the darktable.new_widget function. This function takes a type of widget as a parameter and returns a new object corresponding to that widget. You can then set various fields in that widget to set its parameters. + + + sharing scripts + https://darktable-org.github.io/dtdocs/en/lua/sharing-scripts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/sharing-scripts/ + So far, all of our lua code has been in luarc. That&rsquo;s a good way to develop your script but not very practical for distribution. We need to make this into a proper lua module. To do that, we save the code in a separate file (scp-storage.lua in this case): --[[ SCP STORAGE a simple storage to export images via scp AUTHOR Jérémy Rosen (jeremy.rosen@enst-bretagne.fr) INSTALLATION * copy this file in $CONFIGDIR/lua/ where CONFIGDIR is your darktable configuration directory * add the following line in the file $CONFIGDIR/luarc require &#34;scp-storage&#34; USAGE * select &#34;Export via SCP&#34; in the storage selection menu * set the target directory * export your images LICENSE GPLv2 ]] darktable = require &#34;darktable&#34; dtutils = require &#34;lib/dtutils&#34; dtutils. + + + calling lua from dbus + https://darktable-org.github.io/dtdocs/en/lua/calling-from-dbus/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/calling-from-dbus/ + It is possible to send a lua command to darktable via its DBus interface. The method org.darktable.service.Remote.Lua takes a single string parameter which is interpreted as a lua command. The command will be executed in the current lua context and should return either nil or a string. The result will be passed back as the result of the DBus method. If the Lua call results in an error, the DBus method call will return an error org. + + + using darktable from a lua script + https://darktable-org.github.io/dtdocs/en/lua/darktable-from-lua/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/darktable-from-lua/ + Warning: This feature is very experimental. It is known that several elements don&rsquo;t yet work in library mode. Careful testing is highly recommended. The lua interface allows you to use darktable from any lua script. This will load darktable as a library and provide you with most of the lua API (darktable is configured headless, so the functions relating to the user interface are not available). As an example, the following program will print the list of all images in your library: + + + lua API + https://darktable-org.github.io/dtdocs/en/lua/api/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/lua/api/ + darktable&rsquo;s Lua API is documented in its own manual with a detailed description of all data structures and functions. You can download the API manual from here. + + + diff --git a/en/lua/overview/index.html b/en/lua/overview/index.html new file mode 100644 index 0000000000..4e7b425e15 --- /dev/null +++ b/en/lua/overview/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / overview + +
+ + + + +
+ +

+ overview +

+ + + +

Lua scripts can be used to define actions for darktable to perform when an event is triggered. One example might be calling an external application during file export in order to apply additional processing steps outside of darktable.

+

Lua is an independent project founded in 1993, providing a powerful, fast, lightweight, embeddable scripting language. Lua is widely used by many open source applications, in commercial programs, and for games programming.

+

darktable uses Lua version 5.4. Describing the principles and syntax of Lua is beyond the scope of this usermanual. For a detailed introduction see the Lua reference manual.

+

The following sections will provide you with a brief introduction to how Lua scripts can be used within darktable.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/printing-labeled-images/index.html b/en/lua/printing-labeled-images/index.html new file mode 100644 index 0000000000..9532942752 --- /dev/null +++ b/en/lua/printing-labeled-images/index.html @@ -0,0 +1,3093 @@ + + + + + +darktable user manual - printing labeled images + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / printing labeled images + +
+ + + + +
+ +

+ printing labeled images +

+ + + +

The first example showed us the very basics of lua and allowed us to check that everything was working properly. Now let’s do something a little bit more complex. Let’s try to print a list of images that have a “red” label attached to them. But first of all, what is an image?

+
local darktable = require "darktable"
+local debug = require "darktable.debug"
+print(darktable.debug.dump(darktable.database[1]))
+

Running the code above will produce a lot of output. We will look at it in a moment, but first let’s look at the code itself.

+

We know about require darktable. Here, we need to separately require darktable.debug which is an optional section of the API that provides helper functions to help debug lua scripts.

+

darktable.database is a table provided by the API that contains all images in the library database. Each entry in the database is an image object. Image objects are complex objects that allow you to manipulate your image in various ways (all documented in the types_dt_lua_image_t section of the API manual). To display our images, we use darktable.debug.dump which is a function that will take anything as its parameter and recursively dump its content. Since images are complex objects that indirectly reference other complex objects, the resulting output is huge. Below is a cut down example of the output.

+
toplevel (userdata,dt_lua_image_t) : /images/100.JPG
+   publisher (string) : ""
+   path (string) : "/images"
+   move (function)
+   exif_aperture (number) : 2.7999999523163
+   rights (string) : ""
+   make_group_leader (function)
+   exif_crop (number) : 0
+   duplicate_index (number) : 0
+   is_raw (boolean) : false
+   exif_iso (number) : 200
+   is_ldr (boolean) : true
+   rating (number) : 1
+   description (string) : ""
+   red (boolean) : false
+   get_tags (function)
+   duplicate (function)
+   creator (string) : ""
+   latitude (nil)
+   blue (boolean) : false
+   exif_datetime_taken (string) : "2014:04:27 14:10:27"
+   exif_maker (string) : "Panasonic"
+   drop_cache (function)
+   title (string) : ""
+   reset (function)
+   create_style (function)
+   apply_style (function)
+   film (userdata,dt_lua_film_t) : /images
+      1 (userdata,dt_lua_image_t): .toplevel
+      [......]
+   exif_exposure (number) : 0.0062500000931323
+   exif_lens (string) : ""
+   detach_tag (function): toplevel.film.2.detach_tag
+   exif_focal_length (number) : 4.5
+   get_group_members (function): toplevel.film.2.get_group_members
+   id (number) : 1
+   group_with (function): toplevel.film.2.group_with
+   delete (function): toplevel.film.2.delete
+   purple (boolean) : false
+   is_hdr (boolean) : false
+   exif_model (string) : "DMC-FZ200"
+   green (boolean) : false
+   yellow (boolean) : false
+   longitude (nil)
+   filename (string) : "100.JPG"
+   width (number) : 945
+   attach_tag (function): toplevel.film.2.attach_tag
+   exif_focus_distance (number) : 0
+   height (number) : 648
+   local_copy (boolean) : false
+   copy (function): toplevel.film.2.copy
+   group_leader (userdata,dt_lua_image_t): .toplevel
+

As we can see, an image has a large number of fields that provide all sort of information about it. Here, we are interested in the “red” label. This field is a boolean, and the documentation tells us that it can be written. We now just need to find all images with that field and print them out:

+
darktable = require "darktable"
+for _,v in ipairs(darktable.database) do
+  if v.red then
+    print(tostring(v))
+  end
+end
+

This code should be quite simple to understand at this point, but it contains a few interesting aspects of lua that are worth highlighting:

+
    +
  • +

    ipairs is a standard lua function that will iterate through all numeric indices of a table. We use it here because darktable’s database has non-numeric indices which are functions to manipulate the database itself (adding or deleting images, for example).

    +
  • +
  • +

    Iterating through a table will return both the key and the value used. It is conventional in lua to use a variable named “_” to store values that we don’t care about.

    +
  • +
  • +

    Note that we use the standard lua function tostring here and not the darktable-specific darktable.debug.dump. The standard function will return a name for the object whereas the debug function will print the content. The debug function would be too verbose here. Once again, it is a great debug tool but it should not be used for anything else.

    +
  • +
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/sharing-scripts/index.html b/en/lua/sharing-scripts/index.html new file mode 100644 index 0000000000..cbfe7a7b45 --- /dev/null +++ b/en/lua/sharing-scripts/index.html @@ -0,0 +1,3083 @@ + + + + + +darktable user manual - sharing scripts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / sharing scripts + +
+ + + + +
+ +

+ sharing scripts +

+ + + +

So far, all of our lua code has been in luarc. That’s a good way to develop your script but not very practical for distribution. We need to make this into a proper lua module. To do that, we save the code in a separate file (scp-storage.lua in this case):

+
--[[
+SCP STORAGE
+a simple storage to export images via scp
+
+AUTHOR
+Jérémy Rosen (jeremy.rosen@enst-bretagne.fr)
+
+INSTALLATION
+* copy this file in $CONFIGDIR/lua/ where CONFIGDIR
+is your darktable configuration directory
+* add the following line in the file $CONFIGDIR/luarc
+  require "scp-storage"
+
+USAGE
+* select "Export via SCP" in the storage selection menu
+* set the target directory 
+* export your images
+
+LICENSE
+GPLv2
+
+]]
+
+darktable = require "darktable"
+dtutils = require "lib/dtutils"
+
+dtutils.check_min_api_version("7.0.0", ...)
+
+local scp_path = darktable.new_widget("entry"){
+  tooltip = "Complete path to copy to. Can include user and hostname",
+  text = "",
+  reset_callback = function(self) self.text = "" end
+}
+
+darktable.register_storage("scp_export","Export via scp",
+  function( storage, image, format, filename,
+     number, total, high_quality, extra_data)
+    if not darktable.control.execute("scp "..filename.." "..
+      scp_path.text
+    ) then
+      darktable.print_error("scp failed for "..tostring(image))
+    end
+  end,
+  nil, --finalize
+  nil, --supported
+  nil, --initialize
+  darktable.new_widget("box") {
+    orientation = "horizontal",
+    darktable.new_widget("label"){ label = "target SCP PATH " },
+    scp_path,
+})
+

darktable will look for scripts (following the normal lua rules) in the standard directories plus $CONFIGDIR/lua/*.lua. So our script can be called by simply adding require "scp-storage" in the luarc file. A couple of extra notes…

+
    +
  • +

    The function dtutils.check_min_api_version will check compatibility for you. "7.0.0" is the API version you have tested your script with and the “...” will turn into your script’s name.

    +
  • +
  • +

    Make sure to declare all your functions as local so as not to pollute the general namespace.

    +
  • +
  • +

    Make sure you do not leave debug prints in your code – darktable.print_error in particular allows you to leave debug prints in your final code without disturbing the console.

    +
  • +
  • +

    You are free to choose any license for your script but scripts that are uploaded on darktable’s website need to be GPLv2.

    +
  • +
+

Once you have filled all the fields, checked your code, you can upload it to our script page here.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/lua/simple-shortcut/index.html b/en/lua/simple-shortcut/index.html new file mode 100644 index 0000000000..fccb29234e --- /dev/null +++ b/en/lua/simple-shortcut/index.html @@ -0,0 +1,3077 @@ + + + + + +darktable user manual - adding a simple shortcut + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Scripting with Lua / adding a simple shortcut + +
+ + + + +
+ +

+ adding a simple shortcut +

+ + + +

So far, all our scripts have done things during startup. This is of limited use and doesn’t allow us to react to real user actions. To do more advanced things we need to register a function that will be called on a given event. The most common event to react to is a keyboard shortcut.

+
darktable = require "darktable"
+
+local function hello_shortcut(event, shortcut)
+darktable.print("Hello, I just received '"..event..
+       "' with parameter '"..shortcut.."'")
+end
+
+darktable.register_event("hello shortcut",
+       "shortcut",hello_shortcut,
+       "A shortcut that prints its parameters")
+

Now start darktable, go to “preferences > shortcuts > lua > A shortcut that prints its parameters”, assign a shortcut and try it. You should see a nice message printed on the screen.

+

Let’s look at the code in detail. We first define a function that takes two strings as input parameters. The first one is the type of event triggered (“shortcut”) and the second is the name of the shortcut (“A shortcut that prints its parameters”). The function itself calls darktable.print, which will print the message as an overlay in the main window.

+

Once that function is defined, we register it as a shortcut callback. To do that we call darktable.register_event which is a generic function for all types of events. We tell it that we are registering an event of type “shortcut” with the name “hello shortcut”, then we give the callback to call and finally, we give the string to use to describe the shortcut in the preferences window.

+

Let’s try a shortcut that is a little more interactive. This one will look at the images the user is currently interested in (selected or moused-over) and increase their rating:

+
darktable = require "darktable"
+
+darktable.register_event("increase rating","shortcut",
+  function(event,shortcut)
+    local images = darktable.gui.action_images
+    for _,v in pairs(images) do
+      v.rating = v.rating + 1
+    end
+  end,"Increase the rating of an image")
+

At this point, most of this code should be self explanatory. Just a couple of notes:

+
    +
  • +

    Instead of declaring a function and referencing it, we declare it directly in the call to darktable.register_event this is strictly equivalent but slightly more compact.

    +
  • +
  • +

    image.rating is a field that gives the star rating of any image (between 0 and 5 stars, -1 means rejected).

    +
  • +
  • +

    darktable.gui.action_images is a table containing all the images of interest. darktable will act on selected images if any image is selected, and on the image under the mouse if no image is selected. This function makes it easy to follow darktable’s UI logic in lua.

    +
  • +
+

If you select an image and press your shortcut a couple of times, it will work correctly at first but when you have reached five stars, darktable will start showing the following error on the console:

+
<![CDATA[
+LUA ERROR : rating too high : 6
+stack traceback:
+   [C]: in ?
+   [C]: in ?
+   [C]: in metamethod 'newindex'
+   ./configdir/luarc:10: in function <./configdir/luarc:7>
+   [C]: in ?
+   [C]: in ?
+  ]]>
+

This is lua’s way of reporting errors. We have attempted to set a rating of 6 to an image, but a rating can only go as high as 5. It would be trivial to add a check, but let’s go the complicated way and catch the error instead:

+
darktable.register_event("increase rating","shortcut",
+  function(event,shortcut)
+    local images = darktable.gui.action_images
+    for _,v in pairs(images) do
+      result,message = pcall(function()
+        v.rating = v.rating + 1
+        end)
+      if not result then
+        darktable.print_error("could not increase rating of image "..
+          tostring(v).." : "..message)
+      end
+    end
+  end,"Increase the rating of an image")
+

pcall will run its first argument and catch any exception thrown by it. If there is no exception it will return true plus any result returned by the function. If there is an exception it will return false and the error message of the exception. We simply test these results and print them to the console.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/map/index.html b/en/map/index.html new file mode 100644 index 0000000000..5a5a1dadbd --- /dev/null +++ b/en/map/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - Map + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Map + +
+ +
+ +
+ + + +
+
+ + +
+ +

Map

+ +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/map/index.xml b/en/map/index.xml new file mode 100644 index 0000000000..995da67114 --- /dev/null +++ b/en/map/index.xml @@ -0,0 +1,25 @@ + + + + Map on darktable user manual + https://darktable-org.github.io/dtdocs/en/map/ + Recent content in Map on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/map/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/map/overview/ + The map view allows you to see where your geo-tagged images were taken, and to add location information to non-geo-tagged images. The map view shows a world map with the images in the current collection pinned to their geo-tagged location (if available). This requires that images are tagged with location information. Some newer cameras, including smartphones, are already equipped with GPS receivers. Other cameras may need additional GPS hardware to do this. + + + map view layout + https://darktable-org.github.io/dtdocs/en/map/map-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/map/map-view-layout/ + 🔗left panel These modules are identical to the lighttable view. From top to bottom: collections Filter the list of images displayed in the map view. recently used collections View recently used collections of images. image information Display image information. 🔗right panel Here you can find the modules specific to the map view. From top to bottom: find location Search for a place on map. locations Manage a hierarchical list of location tags and their corresponding regions on the map. + + + diff --git a/en/map/map-view-layout/index.html b/en/map/map-view-layout/index.html new file mode 100644 index 0000000000..34965161c1 --- /dev/null +++ b/en/map/map-view-layout/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - map view layout + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Map / map view layout + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ map view layout +

+ + + +

🔗left panel

+

These modules are identical to the lighttable view. From top to bottom:

+
+
collections
+
Filter the list of images displayed in the map view.
+
recently used collections
+
View recently used collections of images.
+
image information
+
Display image information.
+
+

🔗right panel

+

Here you can find the modules specific to the map view. From top to bottom:

+
+
find location
+
Search for a place on map.
+
locations
+
Manage a hierarchical list of location tags and their corresponding regions on the map.
+
map settings
+
Choose the map provider and set up various map display parameters.
+
tagging
+
Tag selected images.
+
geotagging
+
Apply GPX track data to selected images.
+
+

🔗bottom panel

+
+
filmstrip
+
Drag images from the filmstrip onto the map as described in the map overview.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/map/overview/index.html b/en/map/overview/index.html new file mode 100644 index 0000000000..63f8574e88 --- /dev/null +++ b/en/map/overview/index.html @@ -0,0 +1,3033 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Map / overview + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ overview +

+ + + +

The map view allows you to see where your geo-tagged images were taken, and to add location information to non-geo-tagged images.

+

The map view shows a world map with the images in the current collection pinned to their geo-tagged location (if available). This requires that images are tagged with location information. Some newer cameras, including smartphones, are already equipped with GPS receivers. Other cameras may need additional GPS hardware to do this.

+

Even if your camera doesn’t support this feature, there is an alternative method – darktable can match the Exif date/time in your image(s) to a separate GPX data tracking file created by a GPS tracker, that has recorded your movements. GPS trackers can be purchased as standalone handheld devices or you can install a GPS tracker app on your smartphone. Location tagging with GPS tracking data can be done using the geotagging module, in the lighttable and map views.

+

🔗center map view

+

In the center of the map view you will see a world map.

+

Map data is taken from open map sources on the internet. As such, new map data is only available if you are connected to the internet – darktable keeps a disk cache of previously loaded map data.

+

You can navigate within the map using your mouse. Left-click and drag to move the map. Use the scroll-wheel to zoom in and out.

+

On-screen controls and displays are available to help you find your way. A navigation area is located on top left of the map – use this as an alternative to mouse-dragging and scrolling. The scale of the map is displayed at the bottom-left. At the bottom-right you can see the geographical coordinates for the center of the map.

+

Images that already have geo-location attributes in their metadata are displayed as small icons on the map. Images close to each other are grouped and a count of grouped images is displayed on the bottom-left corner.

+

In order to assign geo coordinates to an image, activate the filmstrip on the lower panel (press Ctrl+F). You can assign a geo location to an image by dragging the image icon from the film-strip and positioning it on the map – darktable will record the new location (latitude and longitude ) as part of the image metadata. This data will be included in exported images.

+

In order to remove location data from an image simply drag it from the map and drop it onto the filmstrip.

+

Images close to each other are grouped under a single image group. You can use the map settings module to control the grouping as needed. The number displayed on the bottom left of the thumbnail is the number of images inside the group. A white number means that all images in the group are at exactly the same location, whereas a yellow number means they are not. Use the mouse scroll wheel while hovering over a group of images to scroll through the thumbnails of the images in that group.

+

Normally, images in the center map view have black borders. If an image is selected in the filmstrip, then the corresponding image on the map will be highlighted with a white border.

+

Click+drag to adjust the location of an image. Shift+click to move a complete group of images.

+

The left and right panels provide additional controls (see map view layout).

+

🔗undo/redo

+

All image movements in the map view are recorded by darktable. It is possible to undo or redo such changes to recover a previous state. Note that this undo/redo facility is unlimited while moving images but it is reset each time you leave the map view.

+

Press Ctrl+Z to undo the last modification and Ctrl+Y to redo the last undone modification (if any).

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/index.html b/en/module-reference/index.html new file mode 100644 index 0000000000..fccdd0c80b --- /dev/null +++ b/en/module-reference/index.html @@ -0,0 +1,3029 @@ + + + + + +darktable user manual - Module Reference + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Module Reference + +
+ +
+ +
+ + + +
+
+ + +
+ +

Module Reference

+ +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/index.xml b/en/module-reference/index.xml new file mode 100644 index 0000000000..29ffa071e5 --- /dev/null +++ b/en/module-reference/index.xml @@ -0,0 +1,18 @@ + + + + Module Reference on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/ + Recent content in Module Reference on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/module-reference/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/overview/ + The modules in this reference section are broken down into two distinct types: processing modules Processing modules are used exclusively in the darkroom view. Each module performs a processing operation on the image before passing its output to the next module for further processing. Together this sequence of processing steps forms the pixelpipe. utility modules Utility modules may be used in any darktable view. They are not directly involved in processing the pixels of an image but perform other ancillary functions (managing image metadata and tags, editing history, modifying pixel pipeline order, snapshots and duplicates, image export etc. + + + diff --git a/en/module-reference/overview/index.html b/en/module-reference/overview/index.html new file mode 100644 index 0000000000..64a2812e27 --- /dev/null +++ b/en/module-reference/overview/index.html @@ -0,0 +1,3042 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Module Reference / overview + +
+ + + + +
+ +

+ overview +

+ + + +

The modules in this reference section are broken down into two distinct types:

+
+
processing modules
+
Processing modules are used exclusively in the darkroom view. Each module performs a processing operation on the image before passing its output to the next module for further processing. Together this sequence of processing steps forms the pixelpipe.
+
utility modules
+
Utility modules may be used in any darktable view. They are not directly involved in processing the pixels of an image but perform other ancillary functions (managing image metadata and tags, editing history, modifying pixel pipeline order, snapshots and duplicates, image export etc.).
+
+

The two types of modules have a few aspects in common, described below.

+

🔗module header

+

Each module has a header at the top, normally consisting of the following elements:

+
+
module name
+
Click on the name to expand or collapse the rest of the module and show/hide its controls.
+
reset parameters button
+
This normally appears to the right of the module name and is used to reset the state of the module back to its original condition.
+
presets menu
+
This normally appears at the far right of the module header. The presets menu is predominantly used in processing modules, but many of the utility modules allow presets to be defined as well. You can also access this menu by right-clicking anywhere on the module header.
+
+

Processing modules contain additional elements in their module header, as described in the processing module header section.

+

🔗module resizing

+

🔗utility modules

+

Some utility modules contain lists of information that can grow as more entries are added. To help manage screen real-estate, it is possible to increase or decrease the maximum number of entries that can be displayed before a scroll bar is added. To alter the maximum number of entries, place the mouse over an entry in the list, and hold Shift+Alt while scrolling your mouse wheel. If the list currently contains more entries than this maximum, a scrollbar will appear so that you can access the hidden entries. Alternatively you can click+drag the bottom of the scrollable area with your mouse.

+
+

Note: It is not possible to extend these areas beyond the number of entries currently shown. If you attempt to do so using Shift+Alt+scroll, the maximum number of entries will increase, and a toast message will appear informing you of the new maximum. However, the module itself will not be resized unless its content exceeds this maximum.

+
+

🔗processing modules

+

Some processing modules contain drawn graphical elements that can take up too much or too little screen space depending on the width of your side panels. These drawing areas usually default to a 16:9 aspect ratio and can be similarly resized by hovering over them and holding Ctrl while scrolling.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/astrophoto-denoise/index.html b/en/module-reference/processing-modules/astrophoto-denoise/index.html new file mode 100644 index 0000000000..e11fb9290c --- /dev/null +++ b/en/module-reference/processing-modules/astrophoto-denoise/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - astrophoto denoise + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / astrophoto denoise + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ astrophoto denoise +

+ + + +

Remove image noise while preserving structure.

+

This is accomplished by averaging each pixel with some surrounding pixels in the image. The weight of such a pixel in the averaging process depends on the similarity of its neighborhood with the neighborhood of the pixel being denoised. A patch with a defined size is used to measure that similarity.

+

As denoising is a resource-intensive process, it slows down pixelpipe processing significantly. Consider activating this module late in your workflow.

+

🔗module controls

+
+
patch size
+
The radius of the patch used for similarity evaluation.
+
strength
+
The strength of the denoising.
+
luma
+
The amount of denoising to apply to luma. Select carefully in order not to lose too much structure.
+
chroma
+
The amount of denoising to apply to chroma. You can be much more aggressive with this parameter.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/base-curve/index.html b/en/module-reference/processing-modules/base-curve/index.html new file mode 100644 index 0000000000..eaf27da4ee --- /dev/null +++ b/en/module-reference/processing-modules/base-curve/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - base curve + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / base curve + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ base curve +

+ + + +

Simulate the in-camera JPEG by applying a characteristic base curve to the image.

+

darktable comes with a number of base curve presets that attempt to mimic the curves of various camera manufacturers. These presets are automatically applied according to the manufacturer ID found in the image’s Exif data. Camera-specific base curve presets are also available for some camera models.

+

This module will be enabled by default if preferences > processing > auto-apply pixel workflow defaults is set to “display-referred”. A second option in the preferences dialog allows you to choose whether darktable should attempt to apply a camera-specific base curve (if found) or the generic manufacturer one.

+

🔗module controls

+

Please refer to the curves section for more details about how to modify curves including the scale for graph and preserve colors controls.

+
+
fusion
+
Trigger the exposure fusion feature (see this Wikipedia article). This feature allows you to merge the image with one or two copies of itself after applying the current base curve and boosting its exposure by a selected number of EV units. The resulting image is thus a combination of two or three different exposures of the original image.
+
Use this feature to compress the dynamic range of extremely underexposed images or for true HDR input. For best results, use the exposure module to apply a suitable adjustment for correctly exposed highlights.
+
exposure shift (fusion)
+
The exposure difference between the merged images in EV units (default 1). This slider is only visible if the exposure fusion feature is activated.
+
exposure bias (fusion)
+
Determines how the multiple exposures are computed. With a bias of 1 (the default), the image is fused with overexposed copies of itself. With a bias of -1, it is fused with underexposed copies. A bias of 0 attempts to preserve the overall lightness of the image by combining both over- and underexposed copies of the image. This slider is only visible if the exposure fusion feature is activated.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/basic-adjustments/index.html b/en/module-reference/processing-modules/basic-adjustments/index.html new file mode 100644 index 0000000000..5b40cc599f --- /dev/null +++ b/en/module-reference/processing-modules/basic-adjustments/index.html @@ -0,0 +1,3052 @@ + + + + + +darktable user manual - (deprecated) basic adjustments + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) basic adjustments + +
+ + + + +
+ +

+ (deprecated) basic adjustments +

+ + + +
+

Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the quick access panel instead.

+
+

A convenience module that combines controls from exposure, highlight reconstruction, color balance and vibrance into a single module.

+

While this module can provide a quick and convenient way to make simple adjustments to an image, it must be used with care. Normally exposure adjustments should come before input color profile in the pixelpipe, and color adjustments should come after. Because the basic adjustments module combines all of these functions into a single operation in the pixelpipe, it may not play nicely with other modules. Therefore, if you plan to use basic adjustments with other modules, please instead consider using the exposure + base curve / tone curve / filmic rgb + color balance modules so that these operations occur in the correct places in the pixelpipe.

+

🔗module controls

+
+
black level correction
+
Equivalent to black level correction in the exposure module, this slider defines the threshold at which dark gray values are cut off to pure black. Reducing this can bring some dark colors back into gamut. Increasing this slider may appear to increase the contrast and pop of an image, but it can push dark colors out of gamut, and clipped data cannot be recovered further down the pixel pipe. To control the contrast in the shadows, it is better to use other modules such as tone curve or levels, which mitigate these negative impacts further down the pixel pipeline.
+
exposure
+
Adjust exposure compensation. Adding 1 EV of exposure compensation is equivalent to doubling the exposure time in camera, opening the aperture by 1 stop, or doubling the ISO.
+
+

Positive exposure corrections will make the image brighter. As a side effect noise level is increased. Depending on the basic noise level of your camera and the ISO value of your image, positive exposure compensations with up to 1EV or 2EV should still give reasonable results.

+
+
+

Negative exposure corrections will make the image darker. Given the nature of digital images this can not correct for fully blown out highlights but allows you to reconstruct data if only some of the RGB channels are clipped (see the highlight reconstruction module for information on how to deal with clipped pixels).

+
+
highlight compression
+
Compress the highlights of the image in order to recover detail.
+
contrast
+
Equivalent to the contrast slider in the color balance module, this is used to increase the separation of luminance values around a fulcrum point, in effect making the tone curve steeper. The middle gray slider sets the fulcrum point for the contrast, and any pixels whose luminance matches this middle gray point will be unaffected. Pixels brighter than the middle gray point will become even brighter, and pixels darker than the middle gray point will become even darker.
+
preserve colors
+
If a non-linear tone curve is applied to each of the RGB channels individually, then the amount of tone adjustment applied to each color channel may be different, and this can cause hue shifts. Therefore, the preserve colors menu provides different methods of calculating the “luminance level” of a pixel. The amount of tone adjustment is calculated based on this luminance value, and then this same adjustment is applied to all three of the RGB channels. Different luminance estimators can affect the contrast in different parts of the image, depending on the specific characteristics of that image. The user can therefore choose a particular estimator that provides the best results for the given image.
+
middle gray
+
Set the fulcrum point for the contrast slider. This is equivalent to the contrast fulcrum slider on the color balance module. If the contrast slider is set to 0 this slider will not have any effect.
+
brightness
+
Equivalent to increasing the gamma factor slider in the color balance module. Moving the slider to the right will increase the brightness of the image, with an emphasis on the mid-tones.
+
saturation
+
Equivalent to the output saturation slider on the color balance module, this slider affects the saturation, or brilliance and intensity of the colors. Moving the slider to the right will increase the amount of color in the image; moving the slider to the left will reduce the amount of color in the image.
+
vibrance
+
Accentuate the colors of the image without adding unnatural colors, as it’s often the case with the saturation slider. It works by reducing the lightness of already saturated pixels to make the colors more vivid. You can also achieve some interesting effects by combining it with the saturation slider to target more or less saturated areas of the image.
+
auto
+
Automatically adjust the exposure, taking into account the entire image, or use the picker to select a rectangular area of the image – the exposure will be automatically adjusted based on the selected region. This allows you to prioritise which parts of the image should be well-exposed.
+
clip
+
This affects the number of pixels that will be clipped to black or white during the auto-exposure calculation. Moving this slider to the right will allow more pixels to be clipped and increase the contrast; moving this slider to the left will compress the image more and lower the contrast.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/bloom/index.html b/en/module-reference/processing-modules/bloom/index.html new file mode 100644 index 0000000000..7ad7d8f91e --- /dev/null +++ b/en/module-reference/processing-modules/bloom/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - bloom + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ bloom +

+ + + +

Create a soft bloom effect.

+

This module works by blurring the highlights and then blending the result with the original image.

+
+

Note: This module performs blurs in Lab color space, and is no longer recommended. Instead, use the tone equalizer module or the exposure module with a parametric mask.

+
+

🔗module controls

+
+
size
+
The spatial extent of the bloom effect.
+
threshold
+
The threshold for the brightness increase.
+
strength
+
The strength of the overlighting.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/blurs/index.html b/en/module-reference/processing-modules/blurs/index.html new file mode 100644 index 0000000000..c264257547 --- /dev/null +++ b/en/module-reference/processing-modules/blurs/index.html @@ -0,0 +1,3084 @@ + + + + + +darktable user manual - blurs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ blurs +

+ + + +

Simulate physically-accurate blurs in scene-referred RGB space.

+

🔗blur types

+

Three types of blur are provided:

+
    +
  1. lens blur: Simulates a lens diaphragm with a configurable number of blades and blade curvature to create synthetic bokeh.
  2. +
  3. motion blur: Simulates the effect of camera motion with a configurable path.
  4. +
  5. gaussian blur: This is not really an optical blur but can be used for denoising or for creative effects using blend modes
  6. +
+

A diagram at the top of the module shows the shape of the blurring operator (known as the point spread function). The module will turn each luminous point from the scene into a blot shaped like the displayed blurring operator, with the size of the blot defined by the blur radius.

+

🔗module controls

+

🔗general

+
+
blur radius
+
The spreading size of the blur.
+
blur type
+
Choose between the different blur variants (above).
+
+

🔗controls specific to lens blur

+
+
diaphragm blades
+
The number of blades that the diaphragm is composed of. Older lenses used typically 5 or 7 blades, newer lenses typically use 9 or 11 blades. In any case, real lenses have an odd number of blades and any number greater than 11 blades comes very close to producing a perfect disc. If you degenerate the diaphragm settings with the concavity to create a star or an asterisk, this control defines how many branches it has.
+
concavity
+
+
+
    +
  • a concavity greater than 1 but lower than number of blades - 1 turns the shape into a star.
  • +
+
+
    +
  • a concavity greater than number of blades - 1 but lower than number of blades turns the shape into an asterisk, when decreasing linearity below 1.
  • +
+
+
    +
  • a concavity greater than or equal to number of blades degenerates the shape into a “burst pattern”.
  • +
+
+
linearity
+
    +
  • a linearity of 0 creates a disc, no matter the number of blades or the concavity.
  • +
+
+
    +
  • a linearity of 1 makes all the outer bounds of the shape straight.
  • +
+
+
    +
  • a linearity between 0 and 1 makes the outer bounds of the shape more or less curved.
  • +
+
+
rotation
+
Allows the shape to be rotated with respect to its center – mostly useful with a small number of blades, when a particular orientation is needed.
+
+

🔗controls specific to motion blur

+
+
direction
+
The orientation of the motion’s path in angular degrees. 0° is horizontal motion.
+
curvature
+
The curvature of the motion. Zero produces a straight line, a negative value produces a concave curvature, a positive value produces a convex curvature.
+
offset
+
Shifts along the motion path following its curve. This is useful to select a portion of the curved path that is symmetrical, which produces a coma shape (example 1: direction = -45°, curvature = +2, offset = +0.5 ; example 2 : direction = -45°, curvature = +1, offset = +1).
+
+

🔗caveats

+

This module is implemented using a “naive” convolution, which is a slow algorithm. Faster approaches are available (using FFT) but not yet implemented. The GPU implementation, through OpenCL, should hide this issue somewhat. In any case, the runtime of the module will increase with the square of the blur radius.

+

The blurring process does not take scene depth and depth-of-field into account, but blurs the whole image as a flat object. It is therefore not suitable for creating fake depth-of-field. Using darktable’s general masking will only partially work to isolate the foreground of an image, since it will still be blurred into the background.

+

🔗tips and tricks

+

All images are usually (even a tiny bit) noisy. If you blur only a part of the image, the blurred region will look suspiciously clean compared to the rest of the image. It is therefore a good idea to add a bit of noise on top of the blurred part to blend it with the rest, using either the grain or the censorize modules.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/censorize/index.html b/en/module-reference/processing-modules/censorize/index.html new file mode 100644 index 0000000000..4df0629a02 --- /dev/null +++ b/en/module-reference/processing-modules/censorize/index.html @@ -0,0 +1,3042 @@ + + + + + +darktable user manual - censorize + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / censorize + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ censorize +

+ + + +

Degrade parts of the image in an aesthetically pleasing way, in order to anonymize people/objects or hide body parts.

+

Censorize works in linear RGB color space to apply a physically-accurate gaussian blur and gaussian luminance noise.

+

Aside from anonymization, this module can also be used for a wide range of creative purposes, for example:

+
    +
  • Combine a simple blur with a multiply blend mode to create a realistic bloom (Orton effect).
  • +
  • Combine a simple blur with a subtract blending mode and low opacity to create an unsharp mask, similar to the sharpen module but in an RGB scene-referred space.
  • +
  • Add noise to create artificial grain.
  • +
+
+

Note: The anonymizing methods provided by this module are not forensically safe in order to favor aesthetics. Some forensic techniques may still be able to reconstruct the censorized content based on its structure, especially for simple shapes and text (e.g. license plates, street numbers).

+

If forensically safe anonymization is required, the only way to achieve this is to paint the surfaces with a solid color.

+

The darktable team does not accept responsibility for poorly anonymized pictures leading to the identification of individuals or personal property.

+
+

🔗workflow

+

You are advised to leave the module’s controls at their default values while you mask the areas of the image that you wish to censorize, in order that the details of the image remain visible.

+

🔗module controls

+
+
input blur radius
+
The strength of the first pass of the gaussian blur.
+
pixellation radius
+
The size of the “big pixels” created after the first pass of gaussian blur.
+
output blur radius
+
The strength of the second pass of the gaussian blur, applied after the pixellation.
+
noise level
+
The strength (standard deviation) of the luminance gaussian noise applied after the second pass of the gaussian blur. Adding noise can fake details in the blurred regions and make content detection more difficult for artificial intelligence algorithms.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/channel-mixer/index.html b/en/module-reference/processing-modules/channel-mixer/index.html new file mode 100644 index 0000000000..4b0cbddde5 --- /dev/null +++ b/en/module-reference/processing-modules/channel-mixer/index.html @@ -0,0 +1,3065 @@ + + + + + +darktable user manual - (deprecated) channel mixer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) channel mixer + +
+ + + + +
+ +

+ (deprecated) channel mixer +

+ + + +
+

Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the color calibration module instead.

+
+

A simple yet powerful tool to manage color channels.

+

This module accepts red, green and blue channels as an input and provides red, green, blue, gray, hue, saturation and lightness channels as output. It allows you to independently control how much each input channel contributes to each output channel.

+

🔗RGB matrix multiplication

+

You can think of the channel mixer as a type of matrix multiplication between a 3x3 matrix and the input [R G B] values.

+
┌ R_out ┐     ┌ Rr Rg Rb ┐     ┌ R_in ┐
+│ G_out │  =  │ Gr Gg Gb │  X  │ G_in │
+└ B_out ┘     └ Br Bg Bb ┘     └ B_in ┘
+

If, for example, you’ve been provided with a matrix to transform from one color space to another, you can enter the matrix coefficients into the channel mixer as follows:

+
    +
  • set the destination to red then set the Rr, Rg & Rb values using the red, green and blue sliders
  • +
  • set the destination to green then set the Gr, Gg & Gb values using the red, green and blue sliders
  • +
  • set the destination to blue then set the Br, Bg & Bb values using the red, green and blue sliders
  • +
+

By default, channel mixer just copies the input [R G B] channels straight over to the matching output channels. This is equivalent to multiplying by the identity matrix:

+
┌ R_out ┐     ┌ 1  0  0 ┐      ┌ R_in ┐
+│ G_out │  =  │ 0  1  0 │   X  │ G_in │
+└ B_out ┘     └ 0  0  1 ┘      └ B_in ┘
+

As an example use case, the following matrix is useful for taming ugly out-of-gamut blue LED lights by making them more magenta:

+
┌  1.00  -0.18  0.18 ┐ 
+│ -0.20   1.00  0.20 │
+└  0.05  -0.05  1.00 ┘ 
+

In this case it is useful to use a parameteric mask to limit the effect of the channel mixer to just the problematic colors.

+

A more intuitive take for what the channel mixer sliders do:

+
    +
  • for the red destination, adjusting sliders to the right will make the R, G or B areas of the image more red. Moving the slider to the left will make those areas more cyan.
  • +
  • for the green destination, adjusting sliders to the right will make the R, G or B areas of the image more green. Moving the slider to the left will make those areas more magenta.
  • +
  • for the blue destination, adjusting sliders to the right will make the R, G or B areas of the image more blue. Moving the slider to the left will make those areas more yellow.
  • +
+

🔗monochrome

+

Another very useful application of the channel mixer is the ability to mix the channels together to produce a grayscale output – a monochrome image. Use the gray destination, and set the red, green and blue sliders to control how much each channel contributes to the brightness of the output. This is equivalent to the following matrix multiplication:

+
GRAY_out  =   [ r  g  b ]  X  ┌ R_in ┐
+                              │ G_in │
+                              └ B_in ┘
+

When dealing with skin tones, the relative weights of the three channels will affect the level of detail in the image. Placing more weight on red (e.g. [0.9, 0.3, -0.3]) will make for smooth skin tones, whereas emphasising green (e.g. [0.4, 0.75, -0.15]) will bring out more detail. In both cases the blue channel is reduced to avoid emphasising unwanted skin texture.

+

Different types of traditional black and white film have differing sensitivities to red, green and blue colors, and this can be simulated by setting the gray destination coefficients appropriately. The channel mixer module has a number of built-in presets that can be used to achieve this.

+

🔗module controls

+
+
destination
+
Select the destination channel that will be affected by the slider settings immediately below. The red, green and blue destination channels are used for color mixing as described in the matrix multiplication section above. The gray channel is used for making grayscale images as described in the monochome section above. It is also possible to define the R, G & B input channels to produce HSL (hue, saturation and lightness) values on the output, although this is a very specialised application.
+
red
+
Defines how much the red input channel should contribute to the selected destination channel.
+
green
+
Defines how much the green input channel should contribute to the selected destination channel.
+
blue
+
Defines how much the blue input channel should contribute to the selected destination channel.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/chromatic-aberrations/index.html b/en/module-reference/processing-modules/chromatic-aberrations/index.html new file mode 100644 index 0000000000..dd92b127ce --- /dev/null +++ b/en/module-reference/processing-modules/chromatic-aberrations/index.html @@ -0,0 +1,3047 @@ + + + + + +darktable user manual - chromatic aberrations + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / chromatic aberrations + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ chromatic aberrations +

+ + + +

Correct chromatic aberrations.

+

In contrast to the raw chromatic aberrations module, this module does not require raw data as input.

+

🔗workflow

+

To obtain the best result, you are advised to proceed as follows:

+
    +
  1. Attenuate the chromatic aberrations as much as possible in the lens correction module using the TCA sliders.
  2. +
  3. Increase the strength slider in this module to better see its effect.
  4. +
  5. Increase the radius until the chromatic aberrations disappear. If this is insufficient, try enabling the “very large chromatic aberrations” setting.
  6. +
  7. Choose the guide that gives the best result in term of sharpness and artifacts.
  8. +
  9. Reduce the strength to avoid washing out the colors too much.
  10. +
+

For more complicated cases you could also try the following:

+
    +
  • Use several instances with different correction modes – for example, a first instance in “brighten only” mode, and a second in “darken only” mode.
  • +
  • Use several instances with low strength to correct the chromatic aberrations a little at a time without degrading colors too much.
  • +
  • Use the module with parametric or drawn masks.
  • +
  • Use RGB red, green and blue blend modes to restrict the effect to a particular channel.
  • +
+

🔗module controls

+
+
guide
+
The color channel that will be used as a reference for the correction.
+
radius
+
The radius of the effect. Increase until chromatic aberrations are eliminated. This is the most important slider of the module.
+
strength
+
This slider acts as a safeguard and can help to preserve colorful areas that do not suffer from chromatic aberrations. Increase for stronger correction, decrease for stronger preservation.
+
correction mode
+
Allows you to restrict the effect to brighten or darken pixels only. For full control, this can be used in combination with R, G, B blend modes and multiples instances.
+
very large chromatic aberrations
+
Makes the algorithm iterative to help in reducing very large chromatic aberrations.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-balance-rgb/index.html b/en/module-reference/processing-modules/color-balance-rgb/index.html new file mode 100644 index 0000000000..80cac5d050 --- /dev/null +++ b/en/module-reference/processing-modules/color-balance-rgb/index.html @@ -0,0 +1,3180 @@ + + + + + +darktable user manual - color balance rgb + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color balance rgb + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ color balance rgb +

+ + + +

An advanced module which brings color-grading tools from cinematography into the photographic scene-referred pipeline.

+

This module is not suitable for beginners with no prior knowledge of color theory, who might want to stick to the global chroma and global vibrance settings until they have a good understanding of the dimensions of color.

+

🔗introduction

+

Color-grading is an important part of image editing. It can help to remove unwanted color casts and can also deliver a creative color twist that will add atmosphere to your images. In the days of film photography, most of the color ambiance was obtained with the film emulsion and the developing chemicals, with some color timing being performed under the enlarger with color heads. This consumed expensive resources and was mostly reserved for the cinema industry, where the job was performed by a colorist.

+

In the digital age, where raw images look flat and even, color-grading assumes the same role that film emulsions did, by re-introducing color shifts for aesthetic purposes. It can also serve to harmonize the color palette of a series of images (which may have been shot under different conditions) to achieve a consistent global look. For this task, the vectorscope is also extremely useful.

+

Colorists usually split color-grading into two distinct steps:

+
    +
  1. Primary color-grading aims to fix unwanted color casts and create a neutral starting point,
  2. +
  3. Secondary color-grading gives the image its final look and atmosphere.
  4. +
+

Primary color-grading is best left to the color calibration module, which operates in a physical framework better suited to illuminant correction. Color balance RGB, on the other hand, is mostly concerned with secondary color-grading. Performing a truly neutral primary color-grading should make the secondary color-grading easy to transfer between images (via styles, presets or copy & paste) with a similar effect.

+

🔗general principles

+

The color balance RGB module is an improvement over the American Society of Cinematographers Color Decision List (ASC CDL), and uses alpha masks to allow the effect to be properly split between shadows and highlights. The classic CDL acts on the entire luminance range, and each of its parameters is given more weight on some parts of the image only as a side-effect of the mathematics.

+

This module works, for the most part (4 ways, chroma, vibrance, contrast), in a linear RGB color space designed specifically for color-grading. This color space exhibits a uniform spacing of perceptual hues while retaining a physically-scaled luminance1. The perceptual part of the module (saturation and brilliance) works in the JzAzBz2 color space, which provides a perceptual scaling of both lightness and chromaticity suitable for HDR images. Both color spaces ensure that saturation and chroma changes take place at constant hue, which is not the case for most other saturation operators in darktable (notably in the older color balance module).

+

The color balance RGB module expects a scene-referred linear input and produces a scene-referred RGB output, which may or may not be linear, depending on the module settings (contrast and power will delinearize the output).

+

At its output, color balance RGB checks that the graded colors fit inside the pipeline RGB color space (Rec. 2020 by default) and applies a soft saturation clipping at constant hue, aiming to retarget out-of-gamut color to the nearest in-gamut color by scaling both chroma and lightness. This prevents the chroma and saturation settings from pushing colors outside of the valid range and allows more drastic adjustments to be safely used.

+

Note that this module abides by the CIE definitions of chroma and saturation, as explained in the dimensions of color section.

+

🔗module controls

+

🔗master tab

+
+
hue shift
+
Rotate all colors in the image by an angle over the chromaticity plane, at constant luminance and chroma. You can use this control to remove spilled colored light on a subject or to quickly change the color of some object. This setting is usually best applied locally, using masks.
+
global vibrance
+
This affects the chroma dimension of color over the entire image, prioritizing those colors with low chroma. This allows the chroma of neutral colors to be increased without exaggerating already-colorful pixels.
+
contrast
+
This setting is applied on the luminance channel at constant hue and chroma. The fulcrum setting (in the masks tab, under contrast gray fulcrum) allows you to set the neutral point of the contrast curve:
+
    +
  • at the fulcrum, the contrast curve leaves the luminance unchanged,
  • +
+
+
    +
  • below the fulcrum, the contrast curve decreases the luminance for positive contrast values, or increases it for negative values,
  • +
+
+
    +
  • above the fulcrum, the contrast curve increases the luminance for positive contrast values, or decreases it for negative values.
  • +
+
+
+

The fulcrum has a value of 18.45% by default, which is consistent with the current scene-referred workflow and should fit most use cases (assuming that global brightness has been fixed as recommended using the exposure module).

+
+
+

The contrast algorithm gives natural results that mimic the central part of the contrast curve of analog film. However, it will also increase the image’s dynamic range, which may void filmic settings in the pipe. For global contrast adjustments, you should normally use the tone equalizer module – the color balance RGB contrast slider is best used with masks, e.g. for selective corrections over the foreground or background.

+
+
+

🔗linear chroma grading

+

Linear chroma grading affects the chroma dimension proportionally to its input value, at constant hue and luminance. It does this globally, with a flat coefficient (using the global chroma), as well as on each of the shadows, mid-tones and highlights masks (defined in the masks tab under luminance ranges).

+

🔗perceptual saturation grading

+

Perceptual saturation grading affects both the luminance and the chroma dimensions, in a perceptual space, proportionally to its input value, at constant hue. It does this globally, with a flat coefficient (using the global saturation), as well as on each of the shadows, mid-tones and highlights masks (defined in the masks tab under luminance ranges).

+

🔗perceptual brilliance grading

+

Perceptual brilliance grading affects both the luminance and the chroma dimensions, in a perceptual space, proportionally to its input value, at constant hue, and in a direction orthogonal to the saturation. Its effect is close to that of changing exposure, but scaled perceptually. It does this globally, with a flat coefficient (using the global saturation), as well as on each of the shadows, mid-tones and highlights masks (defined in the masks tab under luminance ranges).

+

🔗4 ways tab

+

Each of the settings in the 4 ways tab is composed of the same three components, which define a color using independent coordinates:

+
    +
  1. luminance,
  2. +
  3. hue,
  4. +
  5. chroma.
  6. +
+

Color input like this defines a color shift applied to the image globally or over the specified luminance range.

+

Each hue slider has a picker, which may be used to compute the opponent color of the selected region. This is useful to revert unwanted color casts (e.g. skin redness), since shifting the color to its opponent cast neutralizes it.

+

🔗global offset

+

This is equivalent to the ASC CDL offset and falls back to adding a constant RGB value to all pixels, quite like the black offset in the exposure module. This control does not use masking.

+

🔗shadows lift

+

This is conceptually equivalent to the lift from lift/gamma/gain, although implemented differently, and falls back to multiplying the masked pixels by a constant RGB value. It is applied using the shadows mask.

+

🔗highlights gain

+

This is equivalent to the ASC CDL slope, and falls back to multiplying a the masked pixels by a constant RGB value. It is applied using the highlights mask.

+

🔗global power

+

This is equivalent to the ASC CDL power, and falls back to applying a constant RGB exponent. It is not masked and needs to be normalized, since the power function has a different behaviour above and below 1, and we are in an unbounded pipeline where white is typically greater than 1. The normalization parameter is available in the masks tab under white fulcrum.

+

🔗masks tab

+

This tab defines auxiliary controls for the previous tabs. Masking controls typically don’t require any user modification since the defaults are calibrated to suit most needs and fulfil the normal scene-referred pixel pipeline expectations. You should only need to change these settings in specific scenarios.

+

🔗luminance ranges

+

The graphs show the opacity (on the y axis) of the 3 luminance masks relative to the pixel luminance (on the x axis). The darkest curve represents the shadows mask, the brightest represents the highlights mask, and the third curve represents the mid-tones mask.

+

Only the shadows and highlights masks can be controlled directly – the mid-tones mask is computed indirectly from the others and acts as an adjustment variable.

+
+
shadows fall-off
+
Control the softness or hardness of the transition from fully opaque (100%) to fully transparent (0%) for the shadows mask.
+
mask middle-gray fulcrum
+
Set the luminance value where all three masks have 50% opacity. In practice, this is used to define how the image is separated into shadows and highlights.
+
highlights fall-off
+
Control the softness or hardness of the transition from fully opaque (100%) to fully transparent (0%) for the highlights mask.
+
+

For each of these settings, a mask button, provided to the right of the slider, displays the appropriate mask (shadows, mid-tones, highlights), overlaid as a checker board. The still-visible area of the image (not hidden by the mask) is the area that will be affected by the shadows, mid-tones and highlights sliders in the other tabs.

+

All mask previews display the output of the module, including any color changes made, so you can also activate them while editing, to see only the affected part of the image.

+

Luminance masks are computed at the input of the module, which means that they are insensitive to any luminance changes made inside the module.

+

🔗thresholds

+
+
white fulcrum
+
Set the white point luminance in EV. This is used to normalize the power setting in the 4 ways tab. Display-referred implementations of power functions assume that white is at 100%, which removes the need for normalization. For scene-referred purposes this needs to be taken into account.
+
+

The picker to the right of the slider automatically sets the white fulcrum to the maximum luminance from the selected region, which should be sufficient in most cases.

+
+
contrast gray fulcrum
+
Set the fulcrum for the contrast setting in the master tab. This corresponds to the luminance value that will be left unchanged by the contrast adjustment. This setting usually matches the middle-gray linear value. If you followed the scene-referred workflow recommendations and set the global brightness early in the pipeline, using the exposure module, the correct value should usually be around 18-20%.
+
+

The picker to the right of the slider automatically sets the contrast gray fulcrum to the average luminance from the selected region. This relies on the assumption that the average luminance is usually close to middle-gray, which is not true if you have specular highlights or primary light sources in the frame, or for low/high-key images.

+
+
+

🔗saturation formula

+

Note that this setting is not really appropriate for the masks tab (since it is not technically related to the masks) but is placed here because it is not meant to be used regularly and in the spirit of saving some display real-estate. Two options are provided:

+
+
JzAzBz (2021)
+
This mode is the original saturation algorithm. It uses the JzAzBz uniform color space (UCS) to compute the saturation. This color space is not meant for color changes and its lightness does not account for the Helmholtz-Kohlrausch effect, which states that colorful colors will look brighter than neutral or near-neutral colors (greys and pastels) having the same luminance. It also suffers from non-smooth behaviour near black, with colors being darkened too much.
+
darktable UCS (2022)
+
The darktable Uniform Color Space has been designed from the ground up, using psychoperceptual measurement datasets, for the sole purpose of the color manipulation (saturation) performed by this module. This color space does account for the Helmholtz-Kohlrausch effect and has a built-in gamut mapping formula that is more accurate and efficient than can be achieved in JzAzBz. It displays a smoother behaviour which makes saturation changes more even across the lightness range.
+
+

🔗mask preview settings

+

These settings apply to the mask previews, displayed by clicking the mask buttons in the luminance ranges section. These settings are saved globally, so will be applied to all subsequent images unless changed.

+
+
checker board color 1 and 2
+
Set the two colors for the background checker board mask underlay. You can set them to opponent colors of the current image to aid legibility.
+
checker board size
+
Set the width of the checker board cells in pixels (adjusted according to the display’s DPI setting).
+
+

🔗FAQ

+

🔗saturation or chroma?

+

As described in the dimensions of color section, saturation and chroma roam the (lightness, chroma) plane in different directions. In addition, the chroma of color balance RGB uses a scene-referred linear space, while the saturation uses a perceptual space, which rescales color for even spacing.

+

In practice, you should use the chroma setting if you want to preserve the scene-linearity of the light emission and/or keep the luminance unchanged. However, these changes might affect some hues more heavily than others, due to the fact that the color space is not fully perceptually-scaled.

+

Saturation is closer to the effect of mixing white paint with some base color. Reducing the saturation of red will degrade it to pink, while reducing its chroma will degrade to a gray shade at the same luminance. Saturation is perhaps a more intuitive way to interact with color, due to its connection with painting.

+

Choosing one or the other is mostly a matter of deciding where on the (lightness, chroma) graph you want to push your colors, and where they are to begin with. To reach pastel colors, saturation is the way to go. To reach laser-like colors (almost monochromatic), at the risk of looking synthetic, chroma is the way to go.

+

🔗what is the connection with lift/gamma/gain?

+

The lift/gamma/gain algorithm relies on a display-referred color space, since it assumes a bounded and symmetric dynamic range, with white point at 100% and gray at 50%. As such, it is simply unusable in a scene-referred space. However, the only incompatible part is the lift. The gamma is exactly the ASC CDL power, and the gain is exactly the ASC CDL slope.

+

The color balance RGB module simply has two slopes instead of one: the gain, applied on the highlights extracted from the whole image by a mask, and the lift, applied similarly but on the shadows.

+

🔗changing contrast

+

While color balance RGB is mostly about color (other modules handle the global contrast in chromaticity-preserving ways) luminance is as much a part of color as hue or chroma, and it needs to be dealt with here too, because the perception of saturation relies on it. If you wish to turn red into pink, for example, reducing its chroma will turn it gray, so you need to increase its luminance as well.

+

There are several ways to change the contrast in color balance RGB, either locally (with masks) or globally (without):

+
    +
  • in the master tab, use the contrast setting (possibly alongside the contrast gray fulcrum in the masks tab). Be aware that this will raise the white point and therefore increase the dynamic range of the image, which may void filmic settings later in the pipeline.
  • +
  • in perceptual saturation grading, desaturate highlights and resaturate shadows to produce a luminance contrast boost,
  • +
  • in perceptual brilliance grading, add brilliance in the highlights and remove brilliance in the shadows to produce to a luminance contrast boost,
  • +
  • in the 4 ways tab, set the shadows lift luminance to negative values and the highlights gain luminance to positive values, which also produces a luminance contrast boost.
  • +
+

The difference between these methods is how the effect will be weighted relative to the input of the module. You are advised to do the majority of luminance contrast adjustments in the filmic and tone equalizer modules, and then undertake final changes in color balance RGB while examining the colors.

+

🔗internal processing

+

The following is the internal order of operations within the module:

+
    +
  1. Transform from pipeline RGB to Kirk/Filmlight Ych space,
  2. +
  3. Apply hue shift at constant chroma and constant luminance,
  4. +
  5. Compute luminance masks with Y,
  6. +
  7. Apply the linear chroma and vibrance settings at constant hue and luminance,
  8. +
  9. Transform to Kirk/Filmlight RGB space,
  10. +
  11. Apply the 4 ways settings (except luminance power),
  12. +
  13. Transform to Kirk/Filmlight Yrg space,
  14. +
  15. Apply luminance power and contrast on Y,
  16. +
  17. Transform to JzAzBz space,
  18. +
  19. Apply the perceptual saturation and perceptual brilliance settings,
  20. +
  21. Soft-clip the chroma using pipeline RGB gamut at constant hue and lightness,
  22. +
  23. Transform back to pipeline RGB.
  24. +
+

🔗caveats

+

Setting the global chroma to -100% will not produce a real monochrome image, as is customary with other algorithms. The reason for this is that the RGB space used has a D65 white point defined in CIE LMS 2006 space, while darktable uses a white point defined in CIE XYZ 1931 space, and there is no exact conversion between these spaces. The result will therefore be a slightly tinted black & white image. If your intent is to get a real black & white image using the luminance channel, the color calibration module offers a B&W : luminance-based preset that does exactly the same thing but without the white-point discrepancy.

+

This module has its gamut-mapping (against pipeline RGB) permanently enabled. This means that if your original image contains some largely out-of-gamut colors to start with, simply enabling color balance RGB with no particular setting will slightly alter its colors. This is probably for the best.

+

The maximum saturation allowed in the pipeline working RGB space is recorded for each hue when initializing the module, and is later cached in a LUT (look-up table) to save performance. If the working profile is later changed, color balance RGB is not notified, meaning that it will not update its cached hue/saturation LUT. To force a LUT update, you can simply change any setting in the color balance RGB module, then change it back again. It is not recommended that you change the working RGB space half-way through an editing session, as this could result in unexpected chroma and hue changes.

+

For performance reasons, the non-linear conversions from and to the working RGB space are bypassed, meaning that the internal colorimetry will be wrong when using non-linear color spaces. Note that there is no reason to use non-linear spaces as working RGB since they make alpha blending more challenging for no benefit.

+
+
+
    +
  1. +

    Richard A. Kirk, Chromaticity coordinates for graphic arts based on CIE 2006 LMS with even spacing of Munsell colours, 2019. https://doi.org/10.2352/issn.2169-2629.2019.27.38 ↩︎

    +
  2. +
  3. +

    Safdar et al., Perceptually uniform color space for image signals including high dynamic range and wide gamut, 2017. https://doi.org/10.1364/OE.25.015131 ↩︎

    +
  4. +
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-balance/index.html b/en/module-reference/processing-modules/color-balance/index.html new file mode 100644 index 0000000000..23f0fea11b --- /dev/null +++ b/en/module-reference/processing-modules/color-balance/index.html @@ -0,0 +1,3098 @@ + + + + + +darktable user manual - color balance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color balance + +
+ + + + +
+ +

+ color balance +

+ + + +

A versatile tool for adjusting the image’s color balance.

+

This module can be used to revert parasitic color casts or to enhance the visual atmosphere of an image using color grading, a popular technique in the cinema industry. For scene-referred workflow, you should consider using the improved color balance rgb module instead.

+

🔗overview

+

The color balance module allows you to shift colors selectively by luminance range (shadows, mid-tones, and highlights). It can do this using two different methods:

+
+
lift, gamma, gain
+
The classic method, which allows a more separated control of shadows versus highlights.
+
slope, offset, power
+
The new standard defined by the American Society of Cinematographers Color Decision List (ASC CDL) and more suited to scene-referred editing.
+
+

The master settings affect the whole image. They are not available in lift, gamma, gain (sRGB) mode. The slider ranges are limited to usual values ([50%; 150%] for saturation, [-50%; 50%] for contrast), but higher and lower values can be defined via keyboard input after right-clicking on the corresponding slider.

+

For better efficiency, in slope, offset, power mode it is recommended that you set the slope first, then the offset, and finally the power, in that order. The name of the mode can be use as a mnemonic to remember the order.

+

The shadows parameter has a far heavier effect in slope, offset, power mode than in lift, gamma, gain mode. When switching from the former to the latter, you should adapt the saturation in shadows, dividing by around 10.

+
+

Note: Although this module acts on RGB colors its location in the pixelpipe puts it into the Lab color space. Accordingly the module converts from Lab to RGB, performs its color adjustments, and then converts back to Lab.

+
+

🔗presets

+

Several presets are provided in this module to help you to better understand how it can best be used. The “teal/orange color-grading” preset is a very popular look in cinema and is a good showcase model. It is meant to be used with two instances combined with masks. The first instance will exclude skin tones and will shift neutral colors toward teal blue. The second will partially revert the first one and add more vibrance to skin tones only. Together they will create separation between subject and background. The masking and blending parameters will need to be tweaked to suit every image.

+

Other presets provide Kodak film emulations. In this way you can recreate any film look you like using color balance.

+

🔗module controls

+
+
mode
+
lift, gamma, gain (sRGB) is the legacy mode from darktable 2.4 and earlier. In this mode, the color transformations are applied in sRGB color space encoded with the sRGB gamma (average gamma of 2.2).
+
+

lift, gamma, gain (ProPhoto RGB) is the same as the previous mode but works in ProPhoto RGB space, encoded linearly. In this mode, the RGB parameters are corrected in XYZ luminance (Y channel) internally so they affect only the color, and only the “factors” adjust the luminance.

+
+
+

slope, offset, power (ProPhoto RGB) applies the ASC CDL in ProPhoto RGB space, encoded linearly. As with the previous mode, the RGB parameters are corrected in XYZ luminance internally. In this mode, the slope parameter acts as an exposure compensation, the offset acts as a black level correction, and the power acts as a gamma correction. All parameters will have some impact on the whole luminance range but the slope will mostly affect the highlights, the offset will mostly affect the shadows, and the power will mostly affect the mid-tones.

+
+
color control sliders
+
This combobox selection affects the user interface used for the shadows, mid-tones and highlights controls.
+
+

RGBL controls allow direct access to the RGB parameters that will be sent to the algorithm and internally adjusted in XYZ luminance, depending on the mode used. They are the only ones stored in darktable’s development history.

+
+
+

HSL controls are more intuitive, but are only an interface: the hues and saturations are computed dynamically from and to the RGB parameters and never stored. During the HSL to RGB conversion, the HSL lightness is always assumed to be 50%, so the RGB parameters are always balanced to avoid lightness changes. However, during the RGB to HSL conversion, the HSL lightness is not corrected.

+
+
+

As a consequence, editing in RGB, then in HSL, then again in RGB will not retain the original RGB parameters, but will normalize them so their HSL lightness is 50%. The difference is barely noticeable in most cases, especially using the modes that already correct the RGB parameters internally in XYZ luminance.

+
+
+

In both modes, additional “factor” sliders act on all RGB channels at once. Their effect is similar to the controls of the levels module and affect only the luminance.

+
+
input saturation
+
A saturation correction applied before the color balance. This can be used to dampen colors before adjusting the balance, to make difficult images easier to process. When you entirely desaturate the image, this creates a luminance-based monochrome image that can be used as a luminance mask, to create color filters with the color balance settings, like a split-toning or sepia effect (when used with blending modes).
+
output saturation
+
A saturation correction applied after the color balance. This is useful once you have found a proper hue balance but find the effect too heavy, so you can adjust the global saturation at once instead of editing each channel saturation separately at the expense of possibly messing up the colors.
+
contrast / contrast fulcrum
+
The contrast slider allows the luminance separation to be increased. The fulcrum value defines the luminance value that will not be affected by the contrast correction, so the contrast will roll over the fulcrum. Luminance values above the fulcrum will be amplified almost linearly. Luminance values below the fulcrum value will be compressed with a power function (creating a toe). This correction comes after the output saturation and is applied on all RGB channels separately, so hues and saturations might not be preserved in case of dramatic settings (shadows might be resaturated, highlights might be desaturated, and some color shift is to be expected).
+
shadows, mid-tones, highlights
+
Depending on the mode used, the shadows settings will control either the lift or the offset, the mid-tones settings will control either the gamma or the power, and the highlights settings will control either the gain or the slope. Parameters are transferred unaltered when you change the mode.
+
+

In RGBL mode, the RGB sliders’ range is limited to [-0.5; 0.5]. In HSL mode, the saturation sliders range is limited to [0%; 25%]. Values outside of these bounds can be defined with keyboard input by right-clicking on the slider.

+
+
+
+

Note: The shadows, mid-tones and highlights sliders can take up a great deal of space in the color balance module. The overall layout of these sliders can therefore be cycled through three different layouts by clicking on the shadows, mid-tones, highlights heading.

+
+
+
optimize luma
+
The picker beside the optimize luma label will select the whole image and optimize the factors for shadows, mid-tones and highlights so that the average luminance of the image is 50% Lab, the maximum is 100% and the minimum is 0%, at the output of this module. This is essentially histogram normalization, similar to that performed by the levels module. The optimizer is only really accurate when used in slope, offset, power mode.
+
+

If you want more control, you can define three control patches by using the pickers beside each factor slider to sample luminance in selected areas. The shadows picker samples the minimum luminance, the mid-tones picker samples the average luminance, and the highlights picker samples the maximum luminance. The most sensitive parameter is the mid-tones factor, since selecting a slightly different area can lead to dramatic parameter changes. Using the factors pickers alone, without triggering the luma optimization, will allow you to perform adjustments without general optimization, but each parameter is always computed taking the other two into account. Once patches are selected, the label changes to read “optimize luma from patches”. To reset one patch, you can just redo the selection. Patches are not saved in the parameters and are retained only during the current session.

+
+
+

It is important to note that the luminance adjustment targets only the output of the color balance module and does not account for adjustments performed in other modules later in the pixelpipe (e.g. filmic rgb, tone curve, color zones, levels). Using the color balance module to remap the luminance globally on the image is not recommended because it does not preserve the original colors – modules such as tone curve or filmic rgb are better suited for this purpose. Luminance adjustments in color balance are better performed, in combination with color adjustments, using masks.

+
+
neutralize colors
+
In an image where some areas are exposed to direct sunlight and some areas are exposed to reflected light (shadows), or where several artificial light sources are present simultaneously, shadows and highlights often have different color temperatures. These images are particularly difficult to correct since no general white balance will match all the colors at once. The color neutralization optimizer aims at helping you find the complementary color for shadows, mid-tones, and highlights so that all the color casts are reverted, and the average color of the image is a neutral gray.
+
+

As with the luma optimization, the picker beside the neutralize colors label will trigger a general optimization over the whole image. This works fairly well in landscape photography, or for any photograph with a full spectrum of colors and luminances.

+
+
+

For night and events photography, this will most likely fail and you will need to manually input the sampling areas with the picker beside each hue slider. For the highlights sample, use a color exposed to spotlights that should be neutral white or light gray. For the shadows sample, use a color exposed to ambient light that should be neutral black or dark gray. For the mid-tones sample, use a color exposed by both ambient and spotlights.

+
+
+

The success of the optimization depends on the quality of the samples. Not every set of samples will converge to a good solution and you need to ensure that the color patches you choose are really a neutral color in real life. In many cases the optimizer will output the correct hue but an excessive saturation that will need some extra tweaking. In some cases, no valid optimization will be delivered and you will need to reset the saturation parameters and start over, or simply stop after the patches selection. Note that in the auto-optimization, the maximum saturation is 25%, which might not be enough in very few cases but will avoid inconsistent results in most.

+
+
+

If you select color patches from the hue pickers without triggering the optimization, the software will only perform one round of optimization and then stop. This allows you to control each luminance range separately and avoid divergence of the solution in corner cases. The hue and saturation corrections are computed taking into account the two other luminance ranges and three factors, and will always output the complementary color of the selected area. If you want to reinforce the color of the area instead, you can then add 180° to the computed hue. Once patches are selected, the label changes to read “neutralize colors from patches”. To reset one patch you can just redo the selection. Patches are not saved in the parameters and are retained only during the current session. The parameters found by the automatic neutralization are accurate only in slope, offset, power mode, but can work to some extent in lift, gamma, gain mode too.

+
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-calibration/color-checker.png b/en/module-reference/processing-modules/color-calibration/color-checker.png new file mode 100644 index 0000000000..aa87fd2209 Binary files /dev/null and b/en/module-reference/processing-modules/color-calibration/color-checker.png differ diff --git a/en/module-reference/processing-modules/color-calibration/index.html b/en/module-reference/processing-modules/color-calibration/index.html new file mode 100644 index 0000000000..1ca3ad5eea --- /dev/null +++ b/en/module-reference/processing-modules/color-calibration/index.html @@ -0,0 +1,3435 @@ + + + + + +darktable user manual - color calibration + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color calibration + +
+ +
+ + +
+ + +
+ +

+ color calibration +

+ + + + + +

A fully-featured color-space correction, white balance adjustment and channel mixer module.

+

This simple yet powerful module can be used in the following ways:

+
    +
  • +

    To adjust the white balance (chromatic adaptation), working in tandem with the white balance module. Here, the white balance module makes some initial adjustments (required for the demosaic module to work effectively), and the color calibration module then calculates a more perceptually-accurate white balance after the input color profile has been applied.

    +
  • +
  • +

    As a simple RGB channel mixer, adjusting the R, G and B output channels based on the R, G and B input channels, to perform cross-talk color-grading.

    +
  • +
  • +

    To adjust the color saturation and brightness of the image, based on the relative strength of the R, G and B channels of each pixel.

    +
  • +
  • +

    To produce a grayscale output based on the relative strengths of the R, G and B channels, in a way similar to the response of black and white film to a light spectrum.

    +
  • +
  • +

    To improve the color accuracy of the input color profile using a color checker chart.

    +
  • +
+

🔗White Balance in the Chromatic Adaptation Transformation (CAT) tab

+

Chromatic adaptation aims to predict how all surfaces in the scene would look if they had been lit by another illuminant. What we actually want to predict, though, is how those surfaces would have looked if they had been lit by the same illuminant as your monitor, in order to make all colors in the scene match the change of illuminant. White balance, on the other hand, aims only at ensuring that whites and grays are really neutral (R = G = B) and doesn’t really care about the rest of the color range. White balance is therefore only a partial chromatic adaptation.

+

Chromatic adaptation is controlled within the Chromatic Adaptation Transformation (CAT) tab of the color calibration module. When used in this way the white balance module is still required as it needs to perform a basic white balance operation (connected to the input color profile values). This technical white balancing (“camera reference” mode) is a flat setting that makes grays lit by a standard D65 illuminant look achromatic, and makes the demosaicing process more accurate, but does not perform any perceptual adaptation according to the scene. The actual chromatic adaptation is then performed by the color calibration module, on top of those corrections performed by the white balance and input color profile modules. The use of custom matrices in the input color profile module is therefore discouraged. Additionally, the RGB coefficients in the white balance module need to be accurate in order for this module to work in a predictable way.

+

The color calibration and white balance modules can be automatically applied to perform chromatic adaptation for new edits by setting the chromatic adaptation workflow option (preferences > processing > auto-apply chromatic adaptation defaults) to “modern”. If you prefer to perform all white balancing within the white balance module, a “legacy” option is also provided. Neither option precludes the use of other modules (such as color balance RGB) for creative color grading further along the pixel pipeline.

+

By default, color calibration performs chromatic adaptation by:

+
    +
  • reading the RAW file’s Exif data to fetch the scene white balance set by the camera,
  • +
  • adjusting this setting using the camera reference white balance from the white balance module,
  • +
  • further adjusting this setting with the input color profile in use (standard matrix only).
  • +
+

For consistency, the color calibration module’s default settings always assume that the standard matrix is used in the input color profile module – any non-standard settings in this module are ignored. However, color calibration’s defaults can read any auto-applied preset in the white balance module.

+

It is also worth noting that, unlike the white balance module, color calibration can be used with masks. This means that you can selectively correct different parts of the image to account for differing light sources.

+

To achieve this, create an instance of the color calibration module to perform global adjustments using a mask to exclude those parts of the image that you wish to handle differently. Then create a second instance of the module reusing the mask from the first instance (inverted) using a raster mask.

+

🔗CAT tab workflow

+

The default illuminant and color space used by the chromatic adaptation are initialised from the Exif metadata of the RAW file “as set in camera”.

+

Alternatively you can use the picker (to the right of the color patch) to select a neutral color from the image or, if one is unavailable, select the entire image. In this case, the algorithm finds the average color within the chosen area and sets that color as the illuminant. This method relies on the “gray-world” assumption, which predicts that the average color of a natural scene will be neutral. This method will not work for artificial scenes, for example those with painted surfaces.

+
    +
  • Select “as shot in camera” to restore the camera defaults and re-read the RAW Exif.
  • +
+

The color patch shows the color of the currently calculated illuminant projected into sRGB space. The aim of the chromatic adaptation algorithm is to turn this color into pure white, which does not necessarily means shifting the image toward its perceptual opponent color. If the illuminant is properly set, the image will be given the same tint as shown in the color patch when the module is disabled.

+

To the left of the color patch is the CCT (correlated color temperature) approximation. This is the closest temperature, in kelvin, to the illuminant currently in use. In most image processing software it is customary to set the white balance using a combination of temperature and tint. However, when the illuminant is far from daylight, the CCT becomes inaccurate and irrelevant, and the CIE (International Commission on Illumination) discourages its use in such conditions. The CCT reading informs you of the closest CCT match found:

+
    +
  • When the CCT is followed by “(daylight)”, this means that the current illuminant is close to an ideal daylight spectrum ± 0.5 %, and the CCT figure is therefore meaningful. In this case, you are advised to use the “D (daylight)” illuminant.
  • +
  • When the CCT is followed by “(black body)”, this means that the current illuminant is close to an ideal black body (Planckian) spectrum ± 0.5 %, and the CCT figure is therefore meaningful. In this case, you are advised to use the “Planckian (black body)” illuminant.
  • +
  • When the CCT is followed by “(invalid)”, this means that the CCT figure is meaningless and wrong, because we are too far from either a daylight or a black body light spectrum. In this case, you are advised to use the custom illuminant. The chromatic adaptation will still perform as expected (see the note below), so the “(invalid)” tag only means that the current illuminant color is not accurately tied to the displayed CCT. This tag is nothing to be concerned about – it is merely there to tell you to stay away from the daylight and planckian illuminants because they will not behave as you might expect.
  • +
+

When one of the above illuminant detection methods is used, the module checks where the calculated illuminant sits using the two idealized spectra (daylight and black body) and chooses the most accurate spectrum model to use in its illuminant parameter. The user-interface will change accordingly:

+
    +
  • A temperature slider will be provided if the detected illuminant is close to a D (daylight) or Planckian (black body) spectrum, for which the CCT is meaningful.
  • +
  • Hue and chroma sliders in CIE 1976 Luv space are offered for the custom illuminant, which allows direct selection of the illuminant color in a perceptual framework without any intermediate assumption.
  • +
+
+

Note: Internally, the illuminant is represented by its absolute chromaticity coordinates in CIE xyY color space. The illuminant selection options in the module are merely interfaces to set up this chromaticity from real-world relationships and are intended to make this process faster. It does not matter to the algorithm if the CCT is tagged “invalid” – this just means that the relationship between the CCT and the corresponding xyY coordinates is not physically accurate. Regardless, the color set for the illuminant, as displayed in the patch, will always be honored by the algorithm.

+
+

When switching from one illuminant to another, the module attempts to translate the previous settings to the new illumninant as accurately as possible. Switching from any illuminant to custom preserves your settings entirely, since the custom illuminant is a general case. Switching between other modes, or from custom to any other mode, will not precisely preserve your settings from the previous mode due to rounding errors.

+

Other hard-coded illuminants are available (see below). Their values come from standard CIE illuminants and are absolute. You can use them directly if you know exactly what kind of light bulb was used to illuminate the scene and if you trust your camera’s input profile and reference (D65) coefficients to be accurate. Otherwise, see caveats below.

+

🔗CAT tab controls

+
+
adaptation
+
The working color space in which the module will perform its chromatic adaptation transform and channel mixing. The following options are provided:
+
+
    +
  • Linear Bradford (1985): This is accurate for illuminants close to daylight and is compatible with the ICC v4 standard, but produces out-of-gamut colors for more difficult illuminants.
  • +
+
+
    +
  • CAT16 (2016): This is the default option and is more robust in avoiding imaginary colors while working with large gamut or saturated cyan and purple. It is more accurate than the Bradford CAT in most cases.
  • +
+
+
    +
  • Non-linear Bradford (1985): This can sometimes produce better results than the linear version but is unreliable.
  • +
+
+
    +
  • XYZ: This is the least accurate method and is generally not recommended except for testing and debugging purposes.
  • +
+
+
    +
  • none (disable): Disable any adaptation and use the pipeline working RGB space.
  • +
+
+
illuminant
+
The type of illuminant assumed to have lit the scene. Choose from the following:
+
+
    +
  • same as pipeline (D50): Do not perform chromatic adaptation in this module instance but just perform channel mixing, using the selected adaptation color space.
  • +
+
+
    +
  • CIE standard illuminant: Choose from one of the CIE standard illuminants (daylight, incandescent, fluorescent, equi-energy, or black body), or a non-standard “LED light” illuminant. These values are all pre-computed – as long as your camera sensor is properly profiled, you can just use them as-is. For illuminants that lie near the Planckian locus, an additional “temperature” control is also provided (see below).
  • +
+
+
    +
  • custom: If a neutral gray patch is available in the image, the color of the illuminant can be selected using the picker, or can be manually specified using hue and saturation sliders (in LCh perceptual color space). The color swatch next to the picker shows the color of the calculated illuminant used in the CAT compensation. The picker can also be used to restrict the area used for AI detection (below).
  • +
+
+
    +
  • (AI) detect from image surfaces: This algorithm obtains the average color of image patches that have a high covariance between chroma channels in YUV space and a high intra-channel variance. In other words, it looks for parts of the image that appear as though they should be gray, and discards flat colored surfaces that may be legitimately non-gray. It also discards chroma noise as well as chromatic aberrations.
  • +
+
+
    +
  • (AI) detect from image edges: Unlike the white balance module’s auto-white-balancing which relies on the “gray world” assumption, this method auto-detects a suitable illuminant using the “gray edge” assumption, by calculating the Minkowski p-norm (p = 8) of the laplacian and trying to minimize it. That is to say, it assumes that edges should have the same gradient over all channels (gray edges). It is more sensitive to noise than the previous surface-based detection method.
  • +
+
+
    +
  • as shot in camera: Calculate the illuminant based on the white balance settings provided by the camera.
  • +
+
+
temperature
+
Adjust the color temperature of the illuminant. Move the slider to the right to assume a more blue illuminant, which will make the white-balanced image appear warmer/more red. Move the slider to the left to assume a more red illuminant, which makes the image appear cooler/more blue after compensation.
+
+

This control is only provided for illuminants that lie near the Planckian locus and provides fine-adjustment along that locus. For other illuminants the concept of “color temperature” doesn’t make sense, so no temperature slider is provided.

+
+
hue
+
For custom white balance, set the hue of the illuminant color in LCh color space (derived from CIE Luv space).
+
chroma
+
For custom white balance, set the chroma (or saturation) of the illuminant color in LCh color space (derived from CIE Luv space).
+
gamut compression
+
Most camera sensors are slightly sensitive to invisible UV wavelengths, which are recorded on the blue channel and produce “imaginary” colors. Once corrected by the input color profile, these colors will end up out of gamut (that is, it may no longer be possible to represent certain colors as a valid [R,G,B] triplet with positive values in the working color space) and produce visual artifacts in gradients. The chromatic adaptation may also push other valid colors out of gamut, at the same time pushing any already out-of-gamut colors even further out of gamut.
+
Gamut compression uses a perceptual, non-destructive, method to attempt to compress the chroma while preserving the luminance as-is and the hue as close as possible, in order to fit the whole image into the gamut of the pipeline working color space. One example where this feature is very useful is for scenes containing blue LED lights, which are often quite problematic and can result in ugly gamut clipping in the final image.
+
clip negative RGB from gamut
+
Remove any negative RGB values (set them to zero). This helps to deal with bad black level as well as the blue channel clipping issues that may occur with blue LED lights. This option is destructive for color (it may change the hue) but ensures a valid RGB output no matter what. It should never be disabled unless you want to take care of the gamut mapping manually and understand what you are doing. In that case, use the black level correction in the exposure module to get rid of any negative RGB (RGB means light, which is energy, and which should always be a positive quantity), then increase the gamut compression until no solid black patches remain in the image. Proper denoising may help getting rid of odd RGB values too. Note that this approach may still be insufficient to recover some deep and luminous shades of blue.
+
+
+

Note 1: It has been reported that some OpenCL drivers don’t play well when negative RGB values are present in the pixel pipeline, because many pixel operators use logarithms and power functions (filmic, color balance, all the CIE Lab <-> CIE XYZ color space conversions), which are not defined for negative numbers. Although the inputs are sanitized before sensitive operations, it is not enough for some OpenCL drivers, which will output isolated NaN (Not a Number) values. These NaN values may be subsequently spread by local filters (blurring and sharpening operations, like sharpness, local contrast, contrast equalizer, low pass, high pass, surface blur, and filmic highlights reconstruction), resulting in large black, gray or white squares.

+

In all these cases, you must enable the “clip negative RGB from gamut” option in the color calibration module.

+

Note 2: A common case for failure of the color algorithms in color calibration (especially the gamut compression) is pixels that have a luminance value of 0 (Y channel of the CIE 1931 XYZ space), but non-zero chromaticity values (X and Z channels of the CIE 1931 XYZ space). This case is a numerical oddity that matches no physical reality (a pixel with no luminance should have no chromaticity either), will produce a division by zero in xyY and Yuv color spaces, and will create NaN RGB values as a result. This issue is not corrected inside color calibration because it is a symptom of a bad input profiling and/or a bad black point level, and needs to be addressed manually either by adjusting the input color profile with the channel mixer or in the exposure module’s black level correction.

+
+

🔗CAT warnings

+

The chromatic adaptation in this module relies on a number of assumptions about the earlier processing steps in the pipeline in order to work correctly, and it can be easy to inadvertently break those assumptions in subtle ways. To help you to avoid these kinds of mistakes, the color calibration module will show warnings in the following circumstances.

+
    +
  • +

    If the color calibration module is set up to perform chromatic adaptation but the white balance module is not set to “camera reference”, warnings will be shown in both modules. These errors can be resolved either by setting the white balance module to “camera reference” or by disabling chromatic adaptation in the color calibration module. Note that some sensors may require minor corrections within the white balance module in which case these warnings can be ignored.

    +
  • +
  • +

    If two or more instances of color calibration have been created, each attempting to perform chromatic adaptation, an error will be shown on the second instance. This could be a valid use case (for instance where masks have been set up to apply different white balances to different non-overlapping areas of the image) in which case the warnings can be ignored. For most other cases, chromatic adaptation should be disabled in one of the instances to avoid double-corrections.

    +

    By default, if an instance of the color calibration module is already performing chromatic adaptation, each new instance you create will automatically have its adaptation set to “none (bypass)” to avoid this “double-correction” error.

    +
  • +
+

The chromatic adaptation modes in color calibration can be disabled by either setting the adaptation to “none (bypass)” or setting the illuminant to “same as pipeline (D50)” in the CAT tab.

+

These warnings are intended to prevent common and easy mistakes while using the automatic default presets in the module in a typical RAW editing workflow. When using custom presets and some specific workflows, such as editing film scans or JPEGs, these warnings can and should be ignored.

+

Advanced users can disable module warnings in preferences > processing > show warning messages.

+

🔗channel mixing

+

The remainder of this module is a standard channel mixer, allowing you to adjust the output R, G, B, colorfulness, brightness and gray of the module based on the relative strengths of the R, G and B input channels.

+

Channel mixing is performed in the color space defined by the adaptation control on the CAT tab. For all practical purposes, these CAT spaces are particular RGB spaces tied to human physiology and proportional to the light emissions in the scene, but they still behave in the same way as any other RGB space. The use of any of the CAT spaces can make the channel mixer tuning process easier, due to their connection with human physiology, but it is also possible to mix channels in the RGB working space of the pipeline by setting the adaptation to “none (bypass)”. To perform channel mixing in one of the adaptation color spaces without chromatic adaptation, set the illuminant to “same as pipeline (D50)”.

+
+

Note: The actual colors of the CAT or RGB primaries used for the channel mixing, projected to sRGB display space, are painted in the background of the RGB sliders, so you can get a sense of the color shift that will result from your altered settings.

+
+

Channel mixing is a process that defines a boosting/muting factor for each channel as a ratio of all the original channels. Instead of entering a single flat correction that ties the output value of a channel to its input value (for example, R_output = R_input × correction), the correction to each channel is dependent on the input of all of the channels for each pixel (for example, R_output = R_input × R_correction + G_input × G_correction + B_input × B_correction). Thus a pixel’s channels contribute to each other (a process known as “cross-talk”) which is equivalent to rotating the primary colors of the color space in 3D. This is, in effect, digital simulation of physical color filters.

+

Although rotating primary colors in 3D is ultimately equivalent to applying a general hue rotation, the connection between the RGB corrections and the resulting perceptual hue rotation is not directly predictable, which makes the process non-intuitive. “R”, “G” and “B” should be taken as a mixture of 3 lights that we dial up and down, not as a set of colors or hues. Also, since RGB tristimulus does not decouple luminance and chrominance, but is an additive lighting setup, the “G” channel is more strongly tied to human luminance perception than the “R” and “B” ones. All pixels have a non-zero G channel, which implies that any correction to the G channel is likely to affect all pixels.

+

The channel mixing process is therefore tied to a physical interpretation of the RGB tristimulus (as additive lights), which makes it well-suited for primary color grading and illuminant corrections, and blends the color changes smoothly. However, trying to understand and predict it from a perceptual point of view (luminance, hue and saturation) is going to fail and is discouraged.

+
+

Note: The “R”, “G” and “B” labels on the channels of the color spaces in this module are merely conventions formed out of habit. These channels do not necessarily look “red”, “green” and “blue”, and users are advised against trying to make sense out of them based on their names. This is a general principle that applies to any RGB space used in any application.

+
+

🔗R, G and B tabs

+

At its most basic level, you can think of the R, G and B tabs of the color calibration module as a type of matrix multiplication between a 3x3 matrix and the input [R G B] values. This is in fact very similar to what a matrix-based ICC color profile does, except that the user can input the matrix coefficients via the darktable GUI rather than reading the coefficients from an ICC profile file.

+
┌ R_out ┐     ┌ Rr Rg Rb ┐     ┌ R_in ┐
+│ G_out │  =  │ Gr Gg Gb │  X  │ G_in │
+└ B_out ┘     └ Br Bg Bb ┘     └ B_in ┘
+

If, for example, you’ve been provided with a matrix to transform from one color space to another, you can enter the matrix coefficients into the channel mixer as follows:

+
    +
  • select the R tab and then set the Rr, Rg & Rb values using the R, G and B input sliders
  • +
  • select the G tab and then set the Gr, Gg & Gb values using the R, G and B input sliders
  • +
  • select the B tab and then set the Br, Bg & Bb values using the R, G and B input sliders
  • +
+

By default, the mixing function in color calibration just copies the input [R G B] channels straight over to the matching output channels. This is equivalent to multiplying by the identity matrix:

+
┌ R_out ┐     ┌ 1  0  0 ┐      ┌ R_in ┐
+│ G_out │  =  │ 0  1  0 │   X  │ G_in │
+└ B_out ┘     └ 0  0  1 ┘      └ B_in ┘
+

For a more intuitive understanding of how the mixing sliders on the R, G and B tabs behave, consider the following:

+
    +
  • for the R destination channel, adjusting sliders to the right will make the R, G or B areas of the image more “red”. Moving the slider to the left will make those areas more “cyan”.
  • +
  • for the G destination channel, adjusting sliders to the right will make the R, G or B areas of the image more “green”. Moving the slider to the left will make those areas more “magenta”.
  • +
  • for the B destination channel, adjusting sliders to the right will make the R, G or B areas of the image more “blue”. Moving the slider to the left will make those areas more “yellow”.
  • +
+

🔗R, G and B tab controls

+

The following controls are shown for each of the R, G and B tabs:

+
+
input R/G/B
+
Choose how much the input R, G and B channels influence the output channel relating to the tab concerned.
+
normalize channels
+
Select this checkbox to normalize the coefficients to try to preserve the overall brightness of this channel in the final image as compared to the input image.
+
+

🔗brightness and colorfulness tabs

+

The brightness and colorfulness (color saturation) of pixels in an image can also be adjusted based on the R, G and B input channels. This uses the same basic algorithm that the filmic rgb module uses for tone mapping (which preserves RGB ratios) and for mid-tones saturation (which massages them).

+
+
saturation algorithm
+
This control allows you to upgrade the saturation algorithm to the new 2021 version, for edits produced prior to darktable 3.6 – it will not appear for edits that already use the latest version.
+
+

🔗colorfulness tab controls

+
+
input R/G/B
+
Adjust the color saturation of pixels, based on the R, G and B channels of those pixels. For example, adjusting the input R slider will affect the color saturation of pixels containing a lot of “R” more than pixels containing only a small amount of “R”.
+
normalize channels
+
Select this checkbox to try to keep the overall saturation constant between the input and output images.
+
+

🔗brightness tab controls

+
+
input R/G/B
+
Adjust the brightness of certain colors in the image, based on the R, G and B channels of those colors. For example, adjusting the input R slider will affect the brightness of colors containing a lot of R channel much more than colors containing only a small amount of R channel. When darkening/brightening a pixel, the ratio of the R, G and B channels for that pixel is maintained, in order to preserve the hue.
+
normalize channels
+
Select this checkbox to try to keep the overall brightness constant between the input and output images.
+
+

🔗gray tab

+

Another very useful application of color calibration is the ability to mix the channels together to produce a grayscale output – a monochrome image. Select the gray tab, and set the R, G and B sliders to control how much each channel contributes to the brightness of the output. This is equivalent to the following matrix multiplication:

+
GRAY_out  =   [ r  g  b ]  X  ┌ R_in ┐
+                              │ G_in │
+                              └ B_in ┘
+

When dealing with skin tones, the relative weights of the three channels will affect the level of detail in the image. Placing more weight on R (e.g. [0.9, 0.3, -0.3]) will make for smooth skin tones, whereas emphasising G (e.g. [0.4, 0.75, -0.15]) will bring out more detail. In both cases the B channel is reduced to avoid emphasising unwanted skin texture.

+

🔗gray tab controls

+
+
input R/G/B
+
Choose how much each of the R, G and B channels contribute to the gray level of the output. The image will only be converted to monochrome if the three sliders add up to some non-zero value. Adding more B will tend to bring out more details, adding more R will tend to smooth skin tones.
+
normalize channels
+
Select this checkbox to try to keep the overall brightness constant as the sliders are adjusted.
+
+

🔗area color mapping

+

The area mapping feature is designed to help with batch-editing a series of images in an efficient way. In this scenario, you typically develop a single reference image for the whole batch and then copy&paste the development stack to all of the other images in the batch.

+

Unfortunately, the color temperature of the illuminating light often changes slightly between shots, even within the same series captured in the same conditions. This can be the result of a cloud passing by the sun in natural light, or a different ratio between colored bounce light and main light. Each image will still need some individual fine-tuning if you want a perfectly even look over the whole series, and this can be both time-consuming and frustrating.

+

Area color mapping allows you to define a target chromaticity (hue and chroma) for a particular region of the image (the control sample), which you then match against the same target chromaticity in other images. The control sample can either be a critical part of your subject that needs to have constant color, or a non-moving and consistently-lit surface over your series of images.

+

The mapping process consists of two steps.

+

🔗step 1: set the target

+

There are two ways of setting the target chromaticity for your control sample:

+
    +
  1. if you know or expect an arbitrary color for the control sample (for example, a gray card, a color chart, a product or a logo of a specified color), you can set its L, h and c values directly, in Lch derived from CIE Lab 1976 space,
  2. +
  3. if you simply want to match the development of your reference image, set the area mode to measure, then enable the picker (to the right of the color patch) and draw a rectangle over your control sample. The input column will then be updated with the L, h, c values of the control sample before the color correction, and the target column will show the resulting L, h, c values of the control sample after the current calibration setting is applied.
  4. +
+

If you reset the L, h, c values, the default value is a neutral color at 50% lightness (middle-gray) – this can be useful to quickly set the average white balance of any image. If you want to match the control sample against neutral gray, you only need to reset the chroma slider because the lightness and hue settings have no effect on chromaticity for neutral grays.

+

Note that the target value is not reset when you reset the module itself, but is stored indefinitely in darktable’s configuration and will be available on next launch as well as for the next image you develop. Additionally, the position of the selected rectangle is also stored for ease of use when applying the picked correction value to multiple similar images (see below under “match the target”), though you may redraw the rectangle if the position of the target object changes between images.

+

The take channel mixing into account option lets you choose where the target is sampled. If disabled, the target color is measured immediately after the CAT (Chromatic Adaptation Transform) step, which takes place before any channel mixing. This means that if you have a calibrated profile in effect within the channel mixer, this profile will be discarded. If enabled, the target color is measured after the CAT and the channel mixing steps, including any calibrated profile. This is the recommended option for most use cases.

+
+

Note: If you are defining your target from a gray patch, you should know that the gray patch on color checkers is never entirely neutral. For example, Datacolor Spyder has a slightly warm gray (hue = 20°, chroma = 1.2) while X-Rite pre-2014 has a colder but more neutral gray (hue = 240°, chroma = 0.3) and X-Rite post-2014 is almost perfectly neutral (hue = 133°, chroma = 0.2). In general, it is not desirable to match the control sample against a perfectly neutral gray target, and it is actually wrong to do so when using gray cards and color checkers as a control sample.

+
+

🔗step 2 : match the target

+

When you open a new image, the area mode is automatically reset to correction. Using the picker attached to the color patch, you can then directly reselect your control sample in the new image. The proper illuminant settings required for the control sample to match the memorized target chromaticity will be automatically computed, and the setting will be updated in the same operation.

+

The take channel mixing into account option will need to be set the same as when the measurement of the target was performed to ensure consistent results. Note that the target matching only defines the illuminant settings used in the Chromatic Adaptation Transform – it does not alter the channel mixer settings, since the calibration is handled in the color checker calibration tool. However, the channel mixer settings can be used or discarded in the computation of the illuminant settings, depending on this option.

+

This operation can be repeated as many times as you have images in your series with no further work.

+

🔗step 3: deactivate color mapping

+

The settings you configured in step 1 are “sticky” – they will stay active until you manually turn them off by resetting lightness to 50 and chroma to 0. Until then, every time you use this module (even after closing and restarting darktable), those settings will affect the results of an auto-whitebalance operation. To remind you that color mapping is active, especially while the section is collapsed, the heading will change from “area color mapping” to “area color mapping (active)” whenever chroma is nonzero or lightness is other than 50.

+
+

Note: Perfectly matching your control sample against the target chromaticity may still not yield a similar perceptual result, even if the numbers are exactly the same. The ratio of lightness between the control sample and its surrounding, as well as the color contrasts at play in the frame, will alter the perception of colors in ways that are very difficult to model. To build an intuition of this problem, see the gray strawberries illusion.

+
+

🔗extracting settings using a color checker

+

Since the channel mixer is essentially an RGB matrix (similar to the input color profile used for RAW images) it can be used to improve the color accuracy of the input color profile by computing ad-hoc color calibration settings.

+

These computed settings aim to minimize the color difference between the scene reference and the camera recording in a given lighting situation. This is equivalent to creating a generic ICC color profile but here, the profile is instead stored as module settings that can be saved as presets or styles, to be shared and reused between images. Such profiles are meant to complement and refine the generic input profile but do not replace it.

+

This feature can assist with:

+
    +
  • handling difficult illuminants, such as low CRI light bulbs, for which a mere white balancing will never suffice,
  • +
  • digitizing artworks or commercial products where an accurate rendition of the original colors is required,
  • +
  • neutralizing a number of different cameras to the same ground-truth, in multi-camera photo sessions, in order to obtain a consistent base look and share the color editing settings with a consistent final look,
  • +
  • obtaining a sane color pipeline from the start, nailing white balance and removing any bounced-light color cast at once, with minimal effort and time.
  • +
+

🔗supported color checker targets

+

Users are not currently permitted to use custom targets, but a limited number of verified color checkers (from reputable manufacturers) are supported:

+
    +
  • X-Rite / Gretag MacBeth Color Checker 24 (pre- and post-2014),
  • +
  • Datacolor SpyderCheckr 24 (pre- and post-2018),
  • +
  • Datacolor SpyderCheckr 48 (pre- and post-2018),
  • +
  • Datacolor SpyderCheckr Photo.
  • +
+

Users are discouraged from obtaining cheap, off-brand, color targets as color constancy between batches cannot possibly be asserted at such prices. Inaccurate color checkers will only defeat the purpose of color calibration and possibly make things worse.

+

IT7 and IT8 charts are not supported since they are hardly portable and not practical for use on-location for ad-hoc profiles. These charts are better suited for creating generic color profiles, undertaken using a standard illuminant, for example with Argyll CMS.

+
+

Note: X-Rite changed the formula of their pigments in 2014 and Datacolor in 2018, which slightly altered the color of the patches. Both formulas are supported in darktable, but you should be careful to choose the correct reference for your target. If in doubt, try both and choose the one that yields the lowest average delta E after calibration.

+
+

🔗prerequisites

+

In order to use this feature you will need to take a test shot of a supported color checker chart, on-location, under appropriate lighting conditions:

+
    +
  • frame the chart in the center 50% of the camera’s field, to ensure that the image is free of vignetting,
  • +
  • ensure that the main light source is far enough from the chart to give an even lighting field over the surface of the chart,
  • +
  • adjust the angle between the light, chart and lens to prevent reflections and gloss on the color patches,
  • +
  • for the best quality profile you should capture an image with the appropriate brightness. To achieve this, take a few bracketed images (between -1 and +1 EV) of your color checker and load them into darktable, ensuring that all modules between color calibration and output color profile are disabled. Choose the image where the white patch has a brightness L of 94-96% in CIE Lab space or a luminance Y of 83-88% in CIE XYZ space (use the global color picker). This step is not strictly necessary – alternatively you can take a single image and apply the exposure compensation as recommended in the profile report.
  • +
+

If the lighting conditions are close to a standard D50 to D65 illuminant (direct natural light, no colored bounced light), the color checker shot can be used to produce a generic profile that will be suitable for any daylight illuminant with only a slight adjustment of the white balance.

+

If the lighting conditions are peculiar and far from standard illuminants, the color checker shot will be only usable as an ad-hoc profile for pictures taken in the same lighting conditions.

+

🔗usage

+

The settings used in color calibration depend on the chosen CAT space and on any color settings defined earlier in the pipe within the white balance and input color profile modules. As such, the results of the profiling (e.g. the RGB channel mixing coefficients) are valid only for a rigid set of CAT space, white balance and input color profile settings. If you wish to create a generic style with your profile, don’t forget that you will need to include the settings from these modules as well.

+

Use the following process to create your profile preset/style:

+
    +
  1. Enable the lens correction module to correct any vignetting that might mislead the calibration,
  2. +
  3. On the bottom of the color calibration module, click on the arrow near the calibrate with a color checker label, to show the controls,
  4. +
  5. Pick the correct model and manufacturer of your color checker from the chart drop-down,
  6. +
  7. In the image preview, an overlay of the chart’s patches will appear. Drag the corners of the chart so that they match the visual references (dots or crosses) around the target, to compensate for any perspective distortion,
  8. +
  9. Click the refresh button to compute the profile,
  10. +
  11. Check the Profile quality report. If it is “good”, you can click on the validation button. If not, try changing the optimization strategy and refresh the profile again.
  12. +
  13. Save the profile in a preset or style, or simply copy & paste the module settings to all of the pictures taken under the same lighting conditions, from within the lighttable view or filmstrip.
  14. +
+
+

Note: You don’t need to use the standard matrix in the input color profile module when performing a calibration, but be aware that the “as shot in camera” default white balance will not work properly with any other profile, and that you will need to always use the same input profile whenever you reuse such calibration settings.

+
+

🔗reading the profile report

+

The profile report helps you to assess the quality of the calibration. The settings in color calibration are only a “best fit” optimization and will never be 100% accurate for the whole color spectrum. We therefore need to track “how inaccurate” it is in order to know whether we can trust this profile or not.

+

Bad profiles can happen and will do more harm than good if used.

+

🔗delta E and the quality report

+

The CIE delta E 2000 (ΔE) is used as a perceptual metric of the error between the reference color of the patches and the color obtained after each step of calibration:

+
    +
  • ΔE = 0 means that there is no error – the obtained color is exactly the reference color. Unfortunately, this will never happen in practice.
  • +
  • ΔE = 2.3 is defined as the Just Noticeable Difference (JND).
  • +
  • ΔE < 2.3 means that the average observer will not be able to tell the difference between the expected reference color and the obtained color. This is a satisfactory result.
  • +
  • ΔE > 2.3 means that the color difference between the expected reference and the obtained color is noticeable for the average observer. This is unsatisfactory but sometimes unavoidable.
  • +
+

The quality report tracks the average and maximum ΔE at the input of the module (before anything is done), after the chromatic adaptation step (white balance only), and at the output of the module (white balance and channel mixing). At each step, the ΔE should be lower than at the previous step, if everything goes as planned.

+

🔗profile data

+

The data generated by the profiling process comprises the RGB 3×3 matrix and the detected illuminant. These are expressed in the CAT adaptation space defined in the CAT tab and are provided in case you want to export these coefficients to other software. If the detected illuminant is daylight or black body, the matrix should be fairly generic and reusable for other daylight and black body illuminants with the addition of a small white balance adjustment.

+

🔗normalization values

+

These are the settings that you should define, as-is, for the exposure and black level correction parameters in the exposure module, in order to obtain the lowest possible error in your profile. This step is optional and is useful only when the utmost precision is required, but beware that it can produce negative RGB values that will be clipped at various points in the pipeline.

+

🔗overlay

+

+ + + + + + + + +color checker + +

+

The chart overlay displays a disc in the center of each color patch, which represents the expected reference value of that patch, projected into the display RGB space. This helps you to visually assess the difference between the reference and the actual color without having to bother with ΔE values. This visual clue will be reliable only if you set the exposure module as instructed in the normalization values of the profile report.

+

Once the profile has been calibrated, some of the square patches will be crossed in the background by one or two diagonals:

+
    +
  • patches that are not crossed have ΔE < 2.3 (JND), meaning they are accurate enough that the average observer will be unable to notice the deviation,
  • +
  • patches crossed with one diagonal have 2.3 < ΔE < 4.6, meaning that they are mildly inaccurate,
  • +
  • patches crossed with two diagonals have ΔE > 4.6 (2 × JND), meaning that they are highly inaccurate.
  • +
+

This visual feedback will help you to set up the optimization trade-off to check which colors are more or less accurate.

+

🔗enhancing the profile

+

Because any calibration is merely a “best fit” optimization (using a weighted least-squares method) it is impossible to have all patches within our ΔE < 2.3 tolerance. Some compromise will therefore be required.

+

The optimize for parameter allows you to define an optimization strategy that attempts to increase the profile accuracy in some colors at the expense of others. The following options are available:

+
    +
  • none: Don’t use an explicit strategy but rely on the implicit strategy defined by the color checker manufacturer. For example, if the color checker has mostly low-saturation patches, the profile will be more accurate for less-saturated colors.
  • +
  • neutral colors: Give priority to grays and less-saturated colors. This is useful for desperate cases involving cheap fluorescent and LED lightings, having low CRI. However, it may increase the error in highly-saturated colors more than not having any profile.
  • +
  • saturated colors: Give priority to primary colors and highly-saturated colors. This is useful in product and commercial photography, to get brand colors right.
  • +
  • skin and soil colors, foliage colors, sky and water colors: Give priority to the chosen hue range. This is useful if the subject of your pictures is clearly defined and has a typical color.
  • +
  • average delta E: Attempt to make the color error uniform across the color range and minimize the average perceptual error. This is useful for generic profiles.
  • +
  • maximum delta E: Attempt to minimize outliers and large errors, at the expense of the average error. This can be useful to get highly saturated blues back into line.
  • +
+

No matter what you do, strategies that favor a low average ΔE will usually have a higher maximum ΔE, and vice versa. Also, blues are always the more challenging color range to get correct, so the calibration usually falls back to protecting blues at the expense of everything else, or everything else at the expense of blues.

+

The ease of obtaining a proper calibration depends on the quality of the scene illuminant (daylight and high CRI illuminants should always be preferred), the quality of the primary input color profile, the black point compensation set in the exposure module, but first and foremost on the mathematical properties of the camera sensor’s filter array.

+

🔗profile checking

+

It is possible to use the color space check button (first on the left, at the bottom of the module) to perform a single ΔE computation of the color checker reference against the output of the color calibration module. This can be used in the following ways:

+
    +
  1. To check the accuracy of a profile calculated in particular conditions against a color checker shot in different conditions.
  2. +
  3. To evaluate the performance of any color correction performed earlier in the pipe, by setting the color calibration parameters to values that effectively disable it (CAT adaptation to none, everything else set to default), and just use the average ΔE as a performance metric.
  4. +
+

🔗caveats

+

The ability to use standard CIE illuminants and CCT-based interfaces to define the illuminant color depends on sound default values for the standard matrix in the input color profile module as well as reasonable RGB coefficients in the white balance module.

+

Some cameras, most notably those from Olympus and Sony, have unexpected white balance coefficients that will always make the detected CCT invalid even for legitimate daylight scene illuminants. This error most likely comes from issues with the standard input matrix, which is taken from the Adobe DNG Converter.

+

It is possible to alleviate this issue, if you have a computer screen calibrated for a D65 illuminant, using the following process:

+
    +
  1. Display a white surface on your screen, for example by opening a blank canvas in any photo editing software you like
  2. +
  3. Take a blurry (out of focus) picture of that surface with your camera, ensuring that you don’t have any “parasite” light in the frame, you have no clipping, and are using an aperture between f/5.6 and f/8,
  4. +
  5. Open the picture in darktable and extract the white balance by using the picker tool in the white balance module on the center area of the image (non-central regions might be subject to chromatic aberrations). This will generate a set of 3 RGB coefficients.
  6. +
  7. Save a preset for the white balance module with these coefficients and auto-apply it to any color RAW image created by the same camera.
  8. +
+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-contrast/index.html b/en/module-reference/processing-modules/color-contrast/index.html new file mode 100644 index 0000000000..eb15fac831 --- /dev/null +++ b/en/module-reference/processing-modules/color-contrast/index.html @@ -0,0 +1,3024 @@ + + + + + +darktable user manual - color contrast + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color contrast + +
+ + + + +
+ +

+ color contrast +

+ + + +

A simplified control for changing the contrast or separation of colors between the green/magenta and blue/yellow axes in Lab color space. Higher values increase color contrast, lower values decrease it.

+

🔗module controls

+
+
green-magenta contrast
+
Change the green-magenta color contrast. This is equivalent to raising or lowering the steepness of the a* curve in Lab. Lower values desaturate greens and magenta, while higher values increase their saturation.
+
blue-yellow contrast
+
Change the blue-yellow color contrast. This is equivalent to raising or lowering the steepness of the b* curve in Lab. Lower values desaturate blues and yellows, while higher values increase their saturation.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-correction/index.html b/en/module-reference/processing-modules/color-correction/index.html new file mode 100644 index 0000000000..dd61dd23e5 --- /dev/null +++ b/en/module-reference/processing-modules/color-correction/index.html @@ -0,0 +1,3027 @@ + + + + + +darktable user manual - color correction + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color correction + +
+ +
+ + +
+ + +
+ +

+ color correction +

+ + + +

Modify the global image saturation to give the image a tint or as an alternative method to split-tone the image.

+
+

Note: Use the color balance rgb module for color modifications.

+
+

🔗module controls

+
+
color board
+
For split toning move the white dot to the desired highlight tint and then select a tint for shadows with the dark spot. For a simple global tint set both spots to the same color.
+
saturation
+
Correct the global saturation.
+
+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-equalizer/index.html b/en/module-reference/processing-modules/color-equalizer/index.html new file mode 100644 index 0000000000..f6ae259a38 --- /dev/null +++ b/en/module-reference/processing-modules/color-equalizer/index.html @@ -0,0 +1,3067 @@ + + + + + +darktable user manual - color equalizer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color equalizer + +
+ + + + +
+ +

+ color equalizer +

+ + + +

Selectively adjust the hue, saturation, and/or brightness of pixels based on their current hue.

+

This module is an attempt to recreate some of the functionality of the color zones module in the scene-referred part of the pipeline whilst overcoming some of that module’s limitations. Specifically, the color zones module is prone to increase chroma/luma noise, and introduce artefacts or harsh transitions. These are somewhat mitigated within color equalizer with the following additions:

+
    +
  • a fixed number of equally-spaced adjustment nodes means a smoother adjustment curve
  • +
  • a guided filter is used, which attempts to smooth out changes by taking into account both the hue of the neighboring pixels and their overall saturation
  • +
+

The provided tabs can be used (either individually or in combination) to adjust the hue, saturation, and/or brightness at each of the color nodes. While the distance between nodes cannot be changed (see above), if you wish to target a specific hue that does not currently lie on a node, the “node placement” slider can be used to move all of the nodes simultaneously. The picker can be used to display the color of a “picked” pixel or area on the curve adjustment section of the module to allow specific colors to be targeted.

+
+

Note: While the above mitigations can reduce the noise/artefacts generated by this module, they will not always be entirely successful, and you are therefore advised to use this module with care. Try not to make very large changes, and look at some of the options for tweaking the guided filter (below) if introduced noise is excessive.

+
+

🔗module controls

+

🔗hue/saturation/brightness adjustment curves

+

The main controls of this module are the hue/saturation/brightness adjustment curves. Use each of these tabs to adjust the hue, saturation, or brightness of pixels based on their current hue. Click and drag the color nodes (up/down) to alter the properties of pixels with the given hue. You can also adjust nodes using the scroll wheel on your mouse and, as with sliders, you can change the speed of the adjustment by combining the scroll with Ctrl (to adjust more slowly) or Shift (to adjust more quickly).

+

You can also adjust the color nodes using sliders, which can be shown/hidden by middle-clicking on the curve adjustment section of the module with your mouse.

+

As with sliders, you can also right-click on a node/slider to perform fine adjustments (see module controls/sliders for more details).

+

Use the picker to choose a pixel or area on the image and show the hue of that pixel/area on the adjustment curve.

+
+
node placement
+
Adjust the position of all of the nodes simultaneously (move them left/right).
+
+
+

Note: The slider color names will not change when you move the nodes with the “node placement” slider.

+
+

🔗options

+

🔗general

+
+
white level
+
Set the upper bound of brightness corrections that can be made with the module – the module will not allow brightness of any pixels to be greater than this value. Use the picker to set based on a point/area on the image. This should usually be kept at its default value.
+
hue curve (N/A for saturation/brightness curves)
+
Control how the hue adjustment curve is interpolated between nodes. Values greater than 1 make the transitions between the nodes more gradual. Values less than 1 create sharper transitions, allowing for more precise adjustments to individual hues, while affecting neighbouring areas/colors less. Be aware that lower values can increase the likelihood of introducing noise or artefacts.
+
+

🔗guided filter

+

In order to reduce the amount of noise/artefacts, this module uses a guided filter by default. The guided filter attempts to smooth out changes by taking into account both the hue of the neighboring pixels and their overall saturation. This guided filter is ultimately a compromise between adjustment precision (targeting colors more specifically) and avoidance of artefacts (which will generally require less precise targeting). The following options allow the guided filter to be adjusted and visualised in order to better manage these compromises:

+
+
use guided filter
+
Toggle the guided filter on/off.
+
hue analysis radius
+
Choose how much to take neighboring pixels into account when accounting for hue in the guided filter. The default value (1.5px) is a compromise intended to ensure that individual “noisy” pixels (whose color differs significantly from their neighbors) don’t become more noisy as a result of any adjustments. Increase this value to smooth out any introduced noise (such as Moiré). However, be aware that very large values can cause halos and other artefacts at edges.
+
saturation threshold
+
Since this module is intended to perform operations based on a pixel’s hue, it is usually desirable to restrict its operation to only those pixels that have the highest saturation (and for it to have more of an effect on more highly-saturated pixels). The saturation threshold can be used to choose how saturated a pixel must be before its properties can be adjusted by the module. Decrease to allow adjustment of less-saturated pixels. Increase to restrict adjustment of less-saturated pixels.
+
visualize weighting function (saturation)
+
The first “visualization” button (to the right of the “saturation threshold” slider) can be used to see which pixels might be impacted by the operation of this module, based on their saturation, and by how much. Pixels with lower saturation, which will not be adjusted, are shown in shades of blue. Pixels with higher saturation, which might be adjusted (depending on the adjustment curves), are shown in shades of red. The more saturated the red/blue, the more/less (respectively) a pixel will be affected by any adjustment. +

This visualization only depends on a pixel’s saturation, and will not change when you alter the hue/saturation/brightness adjustment curves. It is also affected by the “contrast” setting (below).

+
+
contrast
+
Regulate the steepness of the saturation adjustment curve. This is used in conjunction with the “saturation threshold” slider to determine how much a pixel might be adjusted based on its saturation. The generated curve is shown overlaid on the image when the “visualise weighting function” button is toggled. Positive values result in a steeper transition (highly-saturated pixels are more likely to be changed, low-saturation pixels are less likely to be changed). Negative values result in a shallower transition (highly-saturated pixels are less likely to be changed, low-saturation pixels are more likely to be changed)
+
effect radius
+
Set the radius of the applied parameters in the guided filter. Larger values will smooth the effects of any adjustments, and will better retain pre-existing detail within the image, though can cause bleeding at edges that will need to be mitigated by other means.
+
visualize changed output for the selected tab
+
The second “visualization” button (to the right of the “effect radius” slider) can be used to visualize the overall effect of the adjustments made in the current tab, taking into account both the guided filter and the adjustment curve. Red pixels indicate where the value of the chosen adjustment (hue/saturation/brightness) has increased. Blue pixels indicate where the value of the adjustment has decreased.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-look-up-table/index.html b/en/module-reference/processing-modules/color-look-up-table/index.html new file mode 100644 index 0000000000..2d87921ef2 --- /dev/null +++ b/en/module-reference/processing-modules/color-look-up-table/index.html @@ -0,0 +1,3040 @@ + + + + + +darktable user manual - color look up table + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color look up table + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ color look up table +

+ + + +

A generic color look up table implemented in Lab space.

+

The input to this module is a list of source and target points and the complete mapping is interpolated using splines. The resulting look up tables (LUTs) are editable by hand and can be created using the darktable-chart utility to match given input (such as hald-cluts and RAW/JPEG with in-camera processing pairs). See using darktable-chart for details.

+

🔗module controls

+
+
color board
+
The color board grid shows a list of colored patches. The colors of the patches are the source points. The target color of the selected patch is shown as offsets which are controlled by sliders beneath the color board. An outline is drawn around patches that have been altered (where the source and target colors differ).
+
+

Click a patch to select it, or use the combo box or picker. The currently-selected patch is marked with a white square, and its number is displayed in the combo box below.

+
+
+

By default, the module will load the 24 patches of a classic color checker and initialise the mapping to identity (no change to the image). Configurations with more than 24 patches are shown in a 7x7 grid.

+
+
interaction
+
To modify the color mapping, you can change the source and target colors, though the main use is to change the target colors.
+
+

Start with an appropriate palette of source colors (either from the presets menu or from a style you have downloaded). You can then change the lightness (L), green-red (a), blue-yellow (b), or saturation (c) of the patches’ target values with the sliders.

+
+
+

To change the source color of a patch you can select a new color from your image by using the picker and Shift+click on the patch you want to replace.

+
+
+

Double-click a patch to reset it; Right-click a patch to delete it; Shift+click on empty space to add a new patch (with the currently picked color as the source).

+
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-mapping/index.html b/en/module-reference/processing-modules/color-mapping/index.html new file mode 100644 index 0000000000..f79666ac43 --- /dev/null +++ b/en/module-reference/processing-modules/color-mapping/index.html @@ -0,0 +1,3035 @@ + + + + + +darktable user manual - color mapping + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color mapping + +
+ + + + +
+ +

+ color mapping +

+ + + +

Transfer the look and feel of one image to another.

+

This module statistically analyses the color characteristics of a source and target image. The colors of the source image are then mapped to corresponding colors on the target image.

+

Two steps are required to use this module:

+
    +
  1. Open the source image in the darkroom view and acquire its color characteristics by pressing the “acquire as source” button. A set of color clusters is generated and displayed in the “source clusters” area. Each cluster is represented by a set of color swatches with the mean value in the center surrounded by swatches indicating the variance within that cluster. The clusters are sorted in ascending order by their weight (the number of pixels that contribute to each of them).
  2. +
  3. Open the target image in the darkroom view. The previously collected source clusters should be stored; if they are not yet displayed, press the reset button. Now press the “acquire as target” button to generate a corresponding set of color clusters for your target image, which are then displayed in the “target clusters” area.
  4. +
+

When both source and target clusters are collected an automatic color mapping is applied to the target image. In its default settings the overall effect is quite exaggerated. A set of sliders gives you control of the effect’s strength. You can also use the normal blend mode along with the opacity slider to tame the effect. As the color mapping module comes early in the pixelpipe, you can also finetune the colors with later modules.

+

🔗module controls

+
+
acquire as source/target
+
Press these buttons to generate color clusters for the source and target image, respectively. The processing takes a few seconds during which the GUI will be unresponsive.
+
number of clusters
+
The number of color clusters to use. This should roughly correlate to the number of dominant colors in the image. The clusters are acquired through a statistical sampling process to represent the colors that occur most commonly throughout the image. The random nature of the sampling process means that you might get different results each time you acquire the clusters, especially if you have a larger number of clusters and/or a complex color palette in the image. If you change this parameter all the collected color clusters are reset and must be re-acquired.
+
color dominance
+
This parameter controls the mapping between source and target clusters. At the minimum value, the mapping is based on color proximity. This typically leads to very subtle effects on the target image. At the maximum value, the mapping is based on the relative weight of the color clusters – dominant colors of the source image are mapped to dominant colors of the target image. This typically leads to a very strong effect. Intermediate values incrementally shift between these extremes.
+
histogram equalization
+
Modify the target image’s contrast by matching its histogram with the histogram of the source image. This slider controls the extent of this effect.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-reconstruction/index.html b/en/module-reference/processing-modules/color-reconstruction/index.html new file mode 100644 index 0000000000..566a6084b3 --- /dev/null +++ b/en/module-reference/processing-modules/color-reconstruction/index.html @@ -0,0 +1,3046 @@ + + + + + +darktable user manual - color reconstruction + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color reconstruction + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ color reconstruction +

+ + + +

Recover color information in blown-out highlights.

+

Due to the nature of digital sensors, overexposed highlights lack valid color information. Most frequently they appear neutral white or exhibit some color cast, depending on what other image processing steps are involved. This module can be used to “heal” overexposed highlights by replacing their colors with better fitting ones. The module acts on pixels whose luminance exceeds a user-defined threshold. Replacement colors are taken from neighboring pixels. Both the spatial distance and the luminance distance (range) are taken into account for color selection.

+

Due to a limitation of the underlying algorithm, reconstructed colors may sometimes be displayed incorrectly if you zoom into the image in the darkroom view. If this happens you might observe a magenta shift in highlight areas close to high contrast edges, or you might see colorless highlight areas when used alongside the “reconstruct color” method of the highlight reconstruction module. These artifacts only influence on-screen image display – the final output remains unaffected. It is recommended that you finetune the parameters of this module only when viewing the fully zoomed-out image.

+

Note that similar functionality is also available in the reconstruct tab of the filmic rgb module.

+

🔗module controls

+
+
threshold
+
The color reconstruction module replaces the color of all target pixels having luminance values above this threshold. Only pixels with luminance values below the threshold are taken as valid source pixels for replacement colors. Setting this parameter too high will cause the module to have no effect on any pixels. Setting it too low will minimize the “pool” of replacement colors – if no suitable colors are available, the original colors are retained. This parameter therefore exhibits a “sweet spot” characteristic with an optimum setting depending on the individual image.
+
spatial extent
+
The spatial distance that source pixels may have from target pixels in order for them to contribute to color replacement. Higher values cause ever more distant pixels to contribute. This increases the chance of finding a replacement color but can make the replacement color less well suited for the reconstruction.
+
range extent
+
The range difference (in luminance) that source pixels may have from target pixels in order for them to contribute to color replacement. Higher values cause more pixels to contribute even if their luminance differs more strongly from the target pixels. This again increases the chance of finding a replacement color but at the same time increases the risk of unfitting colors creeping in.
+
precedence
+
This combobox defines whether certain replacement colors shall take precedence over others as follows:
+
+
    +
  • off (default): All pixels contribute equally
  • +
+
+
    +
  • saturated colors: Pixels contribute according to their chromaticity – the more highly-saturated a color, the more it contributes
  • +
+
+
    +
  • hue: Give precedence to a specific hue (see below)
  • +
+
+
hue
+
This slider is only visible if you set the precedence to “hue”. It allows you to select a preferred hue for replacement colors. This only has an effect if the preferred hue is actually present within the selected spatial and range distance of the target pixels (see above). A typical use case is repairing highlights on human skin in situations where diverging colors are in close proximity (e.g. textiles or hair with a luminance close that of to skin). Setting a hue preference on skin tones prevents these other colors from creeping in.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/color-zones/color-zones-adjust-chroma.png b/en/module-reference/processing-modules/color-zones/color-zones-adjust-chroma.png new file mode 100644 index 0000000000..854031813f Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-adjust-chroma.png differ diff --git a/en/module-reference/processing-modules/color-zones/color-zones-adjust-hue.png b/en/module-reference/processing-modules/color-zones/color-zones-adjust-hue.png new file mode 100644 index 0000000000..30df57893a Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-adjust-hue.png differ diff --git a/en/module-reference/processing-modules/color-zones/color-zones-adjust-lightness.png b/en/module-reference/processing-modules/color-zones/color-zones-adjust-lightness.png new file mode 100644 index 0000000000..32ee5766df Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-adjust-lightness.png differ diff --git a/en/module-reference/processing-modules/color-zones/color-zones-choose-chroma.png b/en/module-reference/processing-modules/color-zones/color-zones-choose-chroma.png new file mode 100644 index 0000000000..d37ff5a160 Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-choose-chroma.png differ diff --git a/en/module-reference/processing-modules/color-zones/color-zones-choose-hue.png b/en/module-reference/processing-modules/color-zones/color-zones-choose-hue.png new file mode 100644 index 0000000000..c0c8aad425 Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-choose-hue.png differ diff --git a/en/module-reference/processing-modules/color-zones/color-zones-choose-lightness.png b/en/module-reference/processing-modules/color-zones/color-zones-choose-lightness.png new file mode 100644 index 0000000000..ee9d035eb9 Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-choose-lightness.png differ diff --git a/en/module-reference/processing-modules/color-zones/color-zones-overview.png b/en/module-reference/processing-modules/color-zones/color-zones-overview.png new file mode 100644 index 0000000000..bf1718239c Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/color-zones-overview.png differ diff --git a/en/module-reference/processing-modules/color-zones/icon-mask.png b/en/module-reference/processing-modules/color-zones/icon-mask.png new file mode 100644 index 0000000000..ed3b3ee7be Binary files /dev/null and b/en/module-reference/processing-modules/color-zones/icon-mask.png differ diff --git a/en/module-reference/processing-modules/color-zones/index.html b/en/module-reference/processing-modules/color-zones/index.html new file mode 100644 index 0000000000..c8dc5db19e --- /dev/null +++ b/en/module-reference/processing-modules/color-zones/index.html @@ -0,0 +1,3174 @@ + + + + + +darktable user manual - color zones + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / color zones + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ color zones +

+ + + +

Selectively adjust the lightness, chroma and hue of pixels based on their current lightness, chroma and hue.

+

This module works in CIE LCh color space, which separates pixels into lightness, chroma and hue components. It allows you to manipulate the lightness, chroma and hue of targeted groups of pixels through the use of curves.

+

You first need to choose whether you wish to adjust (select) pixels based on their lightness, chroma or hue. You can then use three curves, on their respective tabs, to adjust the lightness, chroma and hue of ranges of pixels selected via this method.

+
+

Note: This module should be used with care, as transitions between colors may not be graceful. Instead, use the color balance rgb module with a parametric mask.

+
+

🔗pixel selection method

+

The color zones module offers three different methods for selecting which pixels you want to adjust. They are:

+
+
select by hue (default)
+
Select pixels to manipulate based on their hue. For example, you may want to darken a blue sky, or to change a red porche into a yellow one. The following image shows the full range of hues that you can choose to operate on:
+
+

+ + + + + + + + +color zones choose hue + +

+
+
select by lightness
+
Select pixels to manipulate based on their lightness. For example, you may want to make your shadows brighter, or to make your highlights more yellow. The following image shows the range of lightness levels that you can choose to operate on, from dark to light:
+
+

+ + + + + + + + +color zones choose lightness + +

+
+
select by chroma
+
Select pixels to manipulate based on their chroma. For example, you may want to tone down the chroma of some already highly saturated pixels, or to change their hue. The following image shows the range of chroma levels that you can choose to operate on, from a completely unsaturated monochrome gray through to the most highly saturated color:
+
+

+ + + + + + + + +color zones choose chroma + +

+
+
+

🔗pixel manipulation curves

+

Once you have chosen a pixel selection method, the selected range of lightness, chroma or hue levels will appear along the horizontal axis of the three pixel manipulation curves, which can be viewed and adjusted by choosing the appropriate tab (lightness, chroma, hue).

+

If, for example, you were to choose to select by hue (the default), the horizontal axis (below the manipulation curves) would show the range of hues you can work with, and the three pixel manipulation curves would appears as follows:

+
+
lightness
+
By adjusting the lightness curve up or down in a given (hue) location, you can brighten or darken pixels matching hues where the curve has been raised or lowered, respectively. The example below reduces the lightness of the blue parts of the image:
+
+

+ + + + + + + + +color zones adjust lightness + +

+
+
chroma
+
By adjusting the chroma curve up or down in a given (hue) location, you can desaturate (make less colorful) or resaturate (make more colorful) pixels matching hues where the curve has been raised or lowered, respectively. The example below reduces the chroma of the red parts of the image:
+
+

+ + + + + + + + +color zones adjust chroma + +

+
+
hue
+
By adjusting the hue curve up or down in a given (hue) location, you can shift the hue of pixels matching hues where the curve has been raised or lowered, allowing you to replace one color with another. The example below shifts the blue parts of the image to green:
+
+

+ + + + + + + + +color zones adjust hue + +

+
+
+

The curves work similarly in the lightness- and chroma-based selection modes as well. See the section on curves to see how spline curves work in general.

+

Note that these examples are somewhat contrived in order to illustrate the module’s usage. In practical use, they would likely need to be combined with drawn and/or parametric masks to further isolate their effect.

+

🔗range selection

+

When adjusting the pixel manipulation curves, it can sometimes be difficult to judge exactly where on the horizontal axis pixels will fall. To the right of the tab controls are a pair of pickers that can be used to assist with this.

+

If you click the left-hand picker and choose a pixel in the image, you will see a dark vertical line showing where that pixel falls on the horizontal axis. If you Ctrl+click or right-click on the same picker you can choose a rectangular area from the image – the range of values represented within the selected rectangle will be shaded vertically, with a similar dark line showing the median value.

+

If you click on the right-hand picker, you can similarly choose a rectangular area on the image and the display will be shown as described above (a shaded area with a dark vertical line). However, in this case the picker will also automatically add some control points to the curve for you, representing the highlighted range (see below). Simply drag on the center node to raise or lower the curve within the selected range. Alternatively, hold Ctrl while selecting a range to automatically create a positive curve (push up the selected range) or hold Shift while selecting to create a negative curve (pushed down).

+

+ + + + + + + + +color zones overview + +

+

🔗module controls

+

The following controls are available in the color zones module:

+
+
lightness, chroma & hue tabs
+
Each tab displays a pixel manipulation curve to allow you to alter “lightness”, “chroma”, or “hue” based on the pixel selection method.
+
edit by area
+
Choose how to interact with the curve. This setting is disabled by default, allowing the control points for the curve to be freely placed. Check the box to fall back to the legacy “edit by area” mode, which functions in a similar way to the spline curve controls used in wavelet modules.
+
+ + + + + + + + +mask-icon + + mask display
+
Enable the mask display to highlight pixels that have been affected by color zones adjustments in yellow.
+
select by
+
Define the horizontal axis (the range of values to work on). You can choose between “lightness”, “chroma”, and “hue” (the default). Changing this parameter resets all pixel manipulation curves to their default state (horizontal straight lines). If you want to work on multiple ranges, you need to create additional instances of the module.
+
process mode
+
Choose between a “smooth” (default) or “strong” processing mode. The default mode is less likely to cause artifacts.
+
mix
+
Use this parameter to tune the strength of the overall effect.
+
interpolation method
+
Define how the curve is interpolated using the user-defined control points. See the curves section for more details.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/colorize/index.html b/en/module-reference/processing-modules/colorize/index.html new file mode 100644 index 0000000000..115976027b --- /dev/null +++ b/en/module-reference/processing-modules/colorize/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - colorize + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / colorize + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ colorize +

+ + + +

Add a solid layer of color to the image.

+

🔗module controls

+
+
hue
+
The hue of the color layer.
+
saturation
+
The saturation of shadow tones.
+
lightness
+
The lightness of the color layer.
+
source mix
+
Controls how the lightness of the input image is mixed with the color layer. Setting this to zero will result in a uniformly colored plane.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/composite/index.html b/en/module-reference/processing-modules/composite/index.html new file mode 100644 index 0000000000..5d2673440b --- /dev/null +++ b/en/module-reference/processing-modules/composite/index.html @@ -0,0 +1,3038 @@ + + + + + +darktable user manual - composite + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / composite + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ composite +

+ + + +

Create a composite image by overlaying an already-processed image on top of the current image.

+

Drag and drop a processed image from the filmstrip onto the “drop image from filmstrip here” box to overlay the chosen image, and then alter the various placement and adjustment attributes of the image being overlaid.

+

The full history stack of the overlayed image is used by the module, so if you want to drastically change the overlaid image beyond the controls of this module, you should first edit that image separately.

+

🔗module controls

+
+
drop image from filmstrip here
+
The image to overlay onto the currently edited image (dragged from the filmstrip).
+
opacity
+
The percentage of transparency applied to the overlaid image.
+
rotation
+
The amount to turn the overlaid image. Rotation is around the alignment point.
+
scale
+
The amount to shrink the overlaid image.
+
scale on
+
The criteria on which to base the overlaid image scaling.
+
alignment
+
The area on which to align the overlaid image.
+
x offset
+
The amount to move the overlaid image horizontally.
+
y offset
+
The amount to move the overlaid image vertically.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/contrast-brightness-saturation/index.html b/en/module-reference/processing-modules/contrast-brightness-saturation/index.html new file mode 100644 index 0000000000..5491a4a096 --- /dev/null +++ b/en/module-reference/processing-modules/contrast-brightness-saturation/index.html @@ -0,0 +1,3033 @@ + + + + + +darktable user manual - (deprecated) contrast brightness saturation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) contrast brightness saturation + +
+ + + + +
+ +

+ (deprecated) contrast brightness saturation +

+ + + +
+

Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the color balance rgb module instead.

+
+

A very basic tool for adjusting the contrast, brightness and saturation of an image. Please note that a number of other modules provide much more versatile methods of adjusting these parameters.

+

All module controls default to a neutral position (zero) and provide the ability to increase or decrease the relevant parameter

+
+

Note: This module works in Lab color space and is prone to halos. Instead, use the color balance rgb module.

+
+

🔗module controls

+
+
contrast
+
The contrast
+
brightness
+
The brightness
+
saturation
+
The saturation
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-chroma-high.png b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-chroma-high.png new file mode 100644 index 0000000000..d579007d54 Binary files /dev/null and b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-chroma-high.png differ diff --git a/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-chroma-orig.png b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-chroma-orig.png new file mode 100644 index 0000000000..5bd8a54cf1 Binary files /dev/null and b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-chroma-orig.png differ diff --git a/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-edge.png b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-edge.png new file mode 100644 index 0000000000..22a711f7da Binary files /dev/null and b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-edge.png differ diff --git a/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-luma-high.png b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-luma-high.png new file mode 100644 index 0000000000..43135e3ab6 Binary files /dev/null and b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-luma-high.png differ diff --git a/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-luma-orig.png b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-luma-orig.png new file mode 100644 index 0000000000..90171a64f9 Binary files /dev/null and b/en/module-reference/processing-modules/contrast-equalizer/contrast-equalizer-luma-orig.png differ diff --git a/en/module-reference/processing-modules/contrast-equalizer/index.html b/en/module-reference/processing-modules/contrast-equalizer/index.html new file mode 100644 index 0000000000..51131d9a0e --- /dev/null +++ b/en/module-reference/processing-modules/contrast-equalizer/index.html @@ -0,0 +1,3102 @@ + + + + + +darktable user manual - contrast equalizer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / contrast equalizer + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ contrast equalizer +

+ + + +

Adjust luminance and chroma contrast in the wavelet domain.

+

This versatile module can be used to achieve a variety of effects, including bloom, denoise, clarity, and local contrast enhancement.

+

It works in the wavelet domain and its parameters can be tuned independently for each wavelet detail scale. The module operates in CIE LCh color space and so is able to treat luminosity and chromaticity independently.

+

A number of presets are provided, which should help you to understand the capabilities of the module.

+

🔗module controls

+

The contrast equalizer module decomposes the image into various detail scales. On each detail scale, you can independently adjust the contrast and denoise splines for lightness (“luma”) and chromaticity (“chroma”, or color saturation), as well as adjusting the edge-awareness (“edges”) of the wavelet transform. The luma, chroma and edges splines are provided on separate tabs, and some examples of their usage are given in the following sections.

+

Below the spline graphs is a mix slider, which can be used to adjust the strength of the effect, and even to invert the graph (with negative values). While your mouse is over the spline graph, the curve will be displayed as if the mix slider was set to 1.0, to allow for easier editing. When you move your mouse away, the graph will be re-adjusted to account for the mix slider.

+

In the background of the curve you can see a number of alternating light and dark stripes. These represent the levels of detail that are visible at your current zoom scale – any details without these stripes are too small to be seen your current view. Adjustments made to control points within the striped section may produce a visible effect (depending on the strength of the adjustment). Adjustments outside of the striped region will not. Zoom in to see higher levels of detail and make adjustments to the more detailed areas of the image.

+
+

Tip: if you are having trouble visualising which parts of the curve will affect which details in the image, you can set the blend mode to “difference”. This will make the image go black except for those areas where the output of the module differs from the input. By raising the curve at one of the control points, you will be able to see which details in the image are represented by that point.

+
+

🔗luma tab

+

The luma tab allows you to adjust the local contrast in the image’s luminance (brightness). Adjustments are represented by a white spline that begins as a horizontal line running across the centre of the graph (indicating that no change will be made). Raise or lower this spline at the left end of the graph to increase or decrease the local contrast of coarse detail in the image. Perform similar adjustments towards the right side of the graph to adjust the local contrast of the fine details in the image.

+

When you hover the mouse pointer over the graph, a white circle indicates the radius of influence of the mouse pointer – the size of this circle can be adjusted by scrolling with the mouse wheel. The larger the circle of influence, the more control points will be affected when you adjust the curve. A highlighted region in the background shows what the spline would look like if you pushed the currently-hovered control point all the way to the top or bottom on the graph – see the screenshot below for examples of these features. For more information see the wavelets section.

+

The following image shows the default state of the contrast equalizer module before any adjustments have been made:

+

+ + + + + + + + +contrast-equalizer-luma-orig + +

+

Raising the two control points at the right-hand end of the graph will increase the sharpness of the fine details (the eye and feathers of the bird) while leaving coarser details (the rocks in the background) largely unaffected. The example below has been exaggerated to better illustrate the effect.

+

+ + + + + + + + +contrast-equalizer-luma-high + +

+

Increasing the local contrast can also amplify the luma noise in the image. A second spline located at the bottom of the graph can be used to denoise the selected detail scales. Raise this spline (by clicking just above one of the triangles at the bottom of the graph and dragging the line upwards) to reduce noise at the given wavelet scale. In the example above, the dark denoising spline has been raised at the fine-detail end of the graph.

+

🔗chroma tab

+

The chroma tab allows the color contrast or saturation to be adjusted at the selected wavelet scales. See the following example:

+

+ + + + + + + + +contrast-equalizer-chroma-orig + +

+

Say you wanted to bring out the green color of the anthers at the end of the stamen. The pink petals of the flowers are already quite saturated, but using contrast equalizer you can selectively boost the saturation on the small scale of the anthers without impacting the saturation of the petals. By raising the third control point from the right, you can target the saturation of the anthers only:

+

+ + + + + + + + +contrast-equalizer-chroma-high + +

+

As in the luma tab, the chroma tab also has a denoising spline at the bottom of the graph. This can be used to handle chroma noise at different scales within the image. Chroma denoising can generally be more aggressive on larger wavelet scales and has less effect on a smaller scale.

+

🔗edge tab

+

The basic wavelet à trous transform has been enhanced in the contrast equalizer to be “edge-aware”, which can help to reduce the gradient reversals and halo artifacts that the basic algorithm can produce. The edges tab does not directly act on the edges in an image; rather it adjusts the edge awareness feature of the wavelet transform. If you have not adjusted the luma or chroma splines, adjusting the edge awareness spline will have no effect.

+

To see the sorts of artifacts that the edges curve tries to combat, here is an example taken from the original paper “Edge-Optimized À-Trous Wavelets for Local Contrast Enhancement with Robust Denoising” (Hanika, Damertz and Lensch 2011):

+

+ + + + + + + + +contrast-equalizer-edge + +

+

In the image on the left, the edges spline has been reduced to a minimum, effectively disabling the edge awareness and resulting in halos. In the middle image, the edges spline has been increased too much, resulting in gradient reversals. In the image on the right the edges spline has been set somewhere in between the two extremes, resulting in nice clean edges.

+

Usually the default central position of the spline is a good starting point, but if there are objectionable artifacts around the edges, this control can be helpful in mitigating them. Some experimentation will be required.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/crop-rotate/index.html b/en/module-reference/processing-modules/crop-rotate/index.html new file mode 100644 index 0000000000..3dd7de9924 --- /dev/null +++ b/en/module-reference/processing-modules/crop-rotate/index.html @@ -0,0 +1,3141 @@ + + + + + +darktable user manual - (deprecated) crop and rotate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) crop and rotate + +
+ + + + +
+ +

+ (deprecated) crop and rotate +

+ + + +
+

Please note that this module is deprecated from darktable 3.8 and should no longer be used for new edits. Please use the crop module to crop the image, the rotate and perspective module to perform rotation and keystone correction, and the orientation module to flip the image on the horizontal/vertical axes.

+
+

Crop, rotate, and correct perspective distortions using on-screen guides.

+

Whenever the user interface of this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines.

+

+ + + + + + + + +screen controls + +

+

Resize the crop by dragging the border and corner handles.

+

Move the crop rectangle by clicking and dragging inside the crop area. Constrain movement to the horizontal/vertical axis by holding Ctrl/Shift, respectively while dragging. Commit changes by giving focus to another module.

+

If you intend to use the retouch module, you are recommended to use rotate and perspective for rotation and/or keystone correction only, performing creative cropping in the crop module. This process ensures that the entire image is available for source spots in retouch, since the crop module is placed after retouch in the pixelpipe.

+
+

Note: Some of the tools in this module (angle adjustment and perspective distortion correction) require the original image data to be interpolated. For best sharpness results set “lanczos3” as the pixel interpolator in preferences > processing.

+
+

🔗module controls

+

The crop and rotate module controls are split between two tabs as follows:

+

🔗main tab

+
+
flip
+
Flip the image on the horizontal, vertical or both axes.
+
angle
+
Correct the rotation angle to level an image by setting a numerical value in degrees or using the mouse. To use the mouse, right-click and drag to draw a line along a suitable horizontal or vertical feature. As soon as you release the mouse button the image is rotated so that the line you drew matches the horizontal or vertical axis.
+
keystone
+
Correct perspective distortions. This tool is useful, for example, when you shoot a high building from the ground with a short focal length, aiming upwards with your camera. The combobox allows you to select the type of correction you want to use:
+
    +
  • vertical: Limit the correction to vertical lines
  • +
+
+
    +
  • horizontal: Limit the correction to horizontal lines
  • +
+
+
    +
  • full: Correct horizontal and vertical lines at the same time
  • +
+
+
+

Depending on the selected correction type you will see two or four straight adjustment lines overlaid on your image. Two red circles on each line allow you to modify the line positions with your mouse. Each line additionally carries a “symmetry” button. If activated (and highlighted in red) all movements of the affected line will be mirrored by the opposite line.

+
+
+

In order to correct perspective distortions, you need to find suitable horizontal and/or vertical features in your image and align the adjustment lines with them. When finished, press the “OK” button located close to the center of the image – corrections will be applied immediately. You can return to the module and refine your corrections by selecting “correction applied” in the keystone combobox.

+
+
+

+ + + + + + + + +keystone set + + + + + + + + + + +keystone applied + +

+
+
automatic cropping
+
Automatically crop the image to avoid black edges on the image borders. This is useful when rotating the image.
+
aspect
+
Set the aspect ratio of the crop, constraining the width:height ratio of the crop rectangle to the chosen aspect. Many common numerical ratios are pre-defined. A few special aspect ratios deserve explanation:
+
    +
  • freehand: Crop without any restrictions
  • +
+
+
    +
  • original image: Retain the aspect ratio of the original image
  • +
+
+
    +
  • square: Constrains the aspect ratio to be 1:1
  • +
+
+
    +
  • golden cut: The golden ratio (1.62:1)
  • +
+
+
+

You can also enter any other ratio after opening the combobox by typing it in the form of “x:y” or as a decimal (e.g. “0.5” to apply a ratio of 2:1).

+
+
+

If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form “plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y” in darktable’s configuration file $HOME/.config/darktable/darktablerc. Here “foo” defines the name of the new aspect ratio and “x” and “y” the corresponding numerical values (x and y must be integers). Note that you can only add new entries for ratios not already present in the drop-down list.

+
+
+

Finally, the button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio.

+
+
+
+

Note: When resizing an image in freehand mode you may retain the currently-set aspect ratio by holding Shift while dragging on any of the resize controls.

+
+
+
show guides
+
Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.
+
+

🔗margins tab

+

These sliders allow you to directly set how much of the image to crop from each side. They are automatically updated if you move or resize the crop area on the image using the mouse.

+
+
left
+
The percentage of the image that should be cropped from the left side.
+
right
+
The percentage of the image that should be cropped from the right side.
+
top
+
The percentage of the image that should be cropped from the top.
+
bottom
+
The percentage of the image that should be cropped from the bottom.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/crop-rotate/keystone-applied.png b/en/module-reference/processing-modules/crop-rotate/keystone-applied.png new file mode 100644 index 0000000000..a49053535a Binary files /dev/null and b/en/module-reference/processing-modules/crop-rotate/keystone-applied.png differ diff --git a/en/module-reference/processing-modules/crop-rotate/keystone-set.png b/en/module-reference/processing-modules/crop-rotate/keystone-set.png new file mode 100644 index 0000000000..9354c41ce8 Binary files /dev/null and b/en/module-reference/processing-modules/crop-rotate/keystone-set.png differ diff --git a/en/module-reference/processing-modules/crop-rotate/screen-controls.png b/en/module-reference/processing-modules/crop-rotate/screen-controls.png new file mode 100644 index 0000000000..d730816770 Binary files /dev/null and b/en/module-reference/processing-modules/crop-rotate/screen-controls.png differ diff --git a/en/module-reference/processing-modules/crop/index.html b/en/module-reference/processing-modules/crop/index.html new file mode 100644 index 0000000000..555d5944df --- /dev/null +++ b/en/module-reference/processing-modules/crop/index.html @@ -0,0 +1,3083 @@ + + + + + +darktable user manual - crop + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+ +
+ + + +
+
+ + +
+ +

+ crop +

+ + + +

Crop an image using on-screen guides.

+

This module appears later in the pipeline than the deprecated crop and rotate module, meaning that the full image can remain available for source spots in the retouch module. For best results, you are advised to use the rotate and perspective module to perform rotation and perspective correction (if required), and then perform final creative cropping with this module.

+

Whenever this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines.

+

+ + + + + + + + +screen controls + +

+

Resize the crop by dragging the border and corner handles.

+

Move the crop rectangle by clicking and dragging inside the crop area. Constrain movement to the horizontal/vertical axis by holding Ctrl/Shift, respectively while dragging. Commit changes by giving focus to another module.

+

🔗module controls

+

The crop module controls are split into two sections as follows:

+

🔗crop settings

+
+
aspect
+
Set the aspect ratio of the crop, constraining the width:height ratio of the crop rectangle to the chosen aspect. Many common numerical ratios are pre-defined. A few special aspect ratios deserve explanation:
+
    +
  • freehand: Crop without any restrictions
  • +
+
+
    +
  • original image: Retain the aspect ratio of the original image
  • +
+
+
    +
  • square: Constrains the aspect ratio to be 1:1
  • +
+
+
    +
  • golden cut: The golden ratio (1.62:1)
  • +
+
+
+

You can also enter any other ratio after opening the combobox by typing it in the form of “x:y” or as a decimal (e.g. “0.5” to apply a ratio of 2:1).

+
+
+

The button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio.

+
+
+

If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form “plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y” in darktable’s configuration file $HOME/.config/darktable/darktablerc. Here “foo” defines the name of the new aspect ratio and “x” and “y” the corresponding numerical values (x and y must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. You can not use fractions as the actual crop size, however you can for the name. For example, if you want an aspect ratio of 1.91:1, add the following to your darktablerc file: plugins/darkroom/clipping/extra_aspect_ratios/1.91:1=191:100

+
+
+
+

Note: When resizing an image in freehand mode you may retain the currently-set aspect ratio by holding Shift while dragging on any of the resize controls.

+
+

🔗margins

+

These sliders allow you to directly set how much of the image to crop from each side. They are automatically updated if you move or resize the crop area on the image using the mouse.

+

As this section is rarely used, it is collapsed by default.

+
+
left
+
The percentage of the image that should be cropped from the left side.
+
right
+
The percentage of the image that should be cropped from the right side.
+
top
+
The percentage of the image that should be cropped from the top.
+
bottom
+
The percentage of the image that should be cropped from the bottom.
+
+

🔗guides

+

Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/crop/screen-controls.png b/en/module-reference/processing-modules/crop/screen-controls.png new file mode 100644 index 0000000000..d730816770 Binary files /dev/null and b/en/module-reference/processing-modules/crop/screen-controls.png differ diff --git a/en/module-reference/processing-modules/defringe/index.html b/en/module-reference/processing-modules/defringe/index.html new file mode 100644 index 0000000000..d6a5b285df --- /dev/null +++ b/en/module-reference/processing-modules/defringe/index.html @@ -0,0 +1,3036 @@ + + + + + +darktable user manual - (deprecated) defringe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) defringe + +
+ + + + +
+ +

+ (deprecated) defringe +

+ + + +
+

Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the chromatic aberrations module instead.

+
+

Remove color fringing, which often results from Longitudinal Chromatic Aberrations (LCA), also known as Axial Chromatic Aberrations.

+

This module uses edge-detection. Where pixels are detected as a fringe, the color is rebuilt from less saturated neighboring pixels.

+

🔗module controls

+
+
operation mode
+
global average: This mode is usually the fastest but might show slightly incorrect previews at high magnification. It might also protect the wrong regions of color too much or too little by comparison with local average.
+
+

local average: This mode is slower because it computes local color references for every pixel. However it might protect color better than global average and allows for rebuilding color where actually required.

+
+
+

static threshold: This mode does not use a color reference but directly uses the threshold as given by the user.

+
+
edge detection radius
+
The algorithm uses the difference between the input image and a gaussian-blurred version of the same image to detect edges. This parameter controls the spatial extent of the gaussian blur used in the edge detection. Try increasing this value if you want a stronger detection of the fringes or the thickness of the fringe edges is too high.
+
threshold
+
The threshold over which a pixel is counted as a “fringe”. Try lowering this value if there is not enough fringe detected and increasing it if too many pixels are desaturated.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/demosaic/index.html b/en/module-reference/processing-modules/demosaic/index.html new file mode 100644 index 0000000000..25ad2c1fd5 --- /dev/null +++ b/en/module-reference/processing-modules/demosaic/index.html @@ -0,0 +1,3070 @@ + + + + + +darktable user manual - demosaic + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / demosaic + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ demosaic +

+ + + +

Control how raw files are demosaiced.

+

🔗bayer filters

+

The sensor cells of a digital camera are not color-sensitive – they are only able to record different levels of lightness. In order to obtain a color image, each cell is covered by a color filter (red, green or blue) that primarily passes light of that color. This means that each pixel of the raw image only contains information about a single color channel.

+

Color filters are commonly arranged in a mosaic pattern known as a Bayer filter array. A demosaic algorithm reconstructs the missing color channels by interpolation with data from the neighboring pixels. For further reading see the Wikipedia articles on demosaicing and the Bayer filter.

+

Darktable offers several demosaic algorithms, each with it’s own characteristics. The differences between them are often very subtle and might only be visible while pixel-peeping. However, as the program works on a pixel-by-pixel basis and demosaic generates the base data for the other modules, the choice of the algorithm can have a visually significant effect on the quality of very fine details in the image. This can include the appearance of false maze patterns as well as the rendering quality of colored edges.

+

Demosaic interpolation algorithms are often prone to produce artifacts, typically visible as Moiré patterns when zooming into the image. The chosen algorithm might handle pre-existing Moiré- or Maze-like patterns in the raw data in a better or worse way. In these circumstances VNG4 and LMMSE are often more stable.

+

The following demosaic algorithms are available for sensors with Bayer filters:

+
    +
  • +

    PPG used to be darktable’s default demosaic algorithm. It is fast, but other algorithms generally yield better results.

    +
  • +
  • +

    AMaZE and RCD offer better reconstruction of high-frequency content (finer details, edges, stars) but might struggle with color reconstruction overshoots or added noise in areas of low contrast. While AMaZE often retains more high-frequency details it is also more prone to color overshoots than RCD. Since RCD now offers similar performance to PPG, but with better results, it is now the default algorithm.

    +
  • +
  • +

    LMMSE is better suited for use on high ISO and noisy images than AMaZE or RCD, both of which tend to generate overshooting artefacts when applied to such images. It can also be useful to manage images that exhibit Moiré patterns with other algorithms.

    +
  • +
  • +

    VNG4 is better suited for use on images with low-frequency content (e.g. low contrast regions such as sky) but, compared to AMaZE and RCD, it causes loss of some high-frequency details and can sometimes add local color shifts. VNG4 is no longer recommended – for most images, other available algorithms provide better results.

    +
  • +
+
+

Note: The performance of the demosaic algorithms differs significantly, AMaZE being by far the slowest.

+
+

🔗sensors without bayer filters

+

There are a few cameras whose sensors do not use a Bayer filter. Cameras with an “X-Trans” sensor have their own set of demosaic algorithms. The default algorithm for X-Trans sensors is Markesteijn 1-pass, which produces fairly good results. For slightly better quality (at the cost of much slower processing), choose Markesteijn 3-pass. Though VNG is faster than Markesteijn 1-pass on some computers, it is more prone to artifacts.

+

🔗special algorithms

+

passthrough (monochrome) is only useful for cameras that have had the color filter array physically removed from the sensor (e.g. scratched off). Demosaic algorithms usually reconstruct missing color channels by interpolation with data from the neighboring pixels. However, if the color filter array is not present, there is nothing to interpolate, so this algorithm simply sets all the color channels to the same value, resulting in a monochrome image. This method avoids the interpolation artifacts that the standard demosaic algorithms might introduce.

+

photosite_color is not meant to be used for image processing. It takes the raw photosite data and presents it as red, blue or green pixels. This is designed for debugging purposes in order to see the raw data and can assist with analysis of errors produced by the other demosaic algorithms.

+

🔗dual demosaic algorithms

+

Some images have areas best demosaiced using an algorithm that preserves high frequency information (like AMaZE or RCD) and other areas that might profit from an algorithm more suited to low frequency content (like VNG4).

+

In dual demosaic algorithms (e.g. RCD + VNG4) the sensor data is demosaiced twice, first by RCD, AMaZE or Markesteijn 3-pass and then by VNG4. Both sets of demosaiced data are retained for subsequent processing.

+

The data from the high frequency algorithm is then analysed for local data change and, using a threshold (there is a bit more of maths involved here), the output image is written pixel-by-pixel for each color channel using data from each demosaic algorithm weighed by the local data change.

+

In general, areas with greater detail are demosaiced by the algorithm best suited to that purpose (RCD, AMaZe, Markesteijn 3-pass) and any flat areas (like blue sky) are demosaiced using the second algorithm (VNG4).

+

The ’local data change’ is technically implemented as a gaussian-blurred single channel selection mask calculated from a combination of the threshold value and the pixels’ luminance.

+

🔗selecting the threshold

+

An automatically-calculated threshold is difficult to implement. Instead, the “display blending mask” button can be used to display the selection mask so you can control the selection of the algorithm manually. The brighter the pixel in the displayed mask, the more the output is taken from the high-frequency algorithm.

+

🔗module controls

+
+
method
+
The demosaic algorithm to use (see above).
+
edge threshold (PPG only)
+
The threshold for an additional median pass. Defaults to “0” which disables median filtering.
+
LMMSE refine (LMMSE only)
+
Refinement steps for use with the LMMSE demosaic algorithm. Median steps average the output. Refinement steps add some recalculation of red and blue channels. While the refinement options work well for luma noise, they may decrease quality on images with heavy chroma noise.
+
color smoothing
+
Activate a number of additional color smoothing passes. Defaults to “off”.
+
match greens
+
In some cameras the green filters have slightly varying properties. This parameter adds an additional equalization step to suppress artifacts. Available options are “disabled”, “local average”, “full average” and “full and local average”. This option is not shown for X-Trans sensors.
+
switch dual threshold (dual demosaic modes only)
+
Set the contrast threshold for dual demosaic modes. Lower values favor the high frequency demosaic algorithm and higher values favor the low frequency algorithm.
+
display blending mask (dual demosaic modes only)
+
Show the blending mask that is used to differentiate between high and low frequency areas (adjusted by the “switch dual threshold” parameter). For each pixel, the brighter the mask, the more the module’s output is taken from the high frequency demosaic algorithm.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/denoise-profiled/denoise-rgb.png b/en/module-reference/processing-modules/denoise-profiled/denoise-rgb.png new file mode 100644 index 0000000000..0c9ce33111 Binary files /dev/null and b/en/module-reference/processing-modules/denoise-profiled/denoise-rgb.png differ diff --git a/en/module-reference/processing-modules/denoise-profiled/denoise-y0u0v0.png b/en/module-reference/processing-modules/denoise-profiled/denoise-y0u0v0.png new file mode 100644 index 0000000000..824e52d962 Binary files /dev/null and b/en/module-reference/processing-modules/denoise-profiled/denoise-y0u0v0.png differ diff --git a/en/module-reference/processing-modules/denoise-profiled/index.html b/en/module-reference/processing-modules/denoise-profiled/index.html new file mode 100644 index 0000000000..fabd1d1a92 --- /dev/null +++ b/en/module-reference/processing-modules/denoise-profiled/index.html @@ -0,0 +1,3109 @@ + + + + + +darktable user manual - denoise (profiled) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / denoise (profiled) + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ denoise (profiled) +

+ + + +

An easy to use and highly efficient denoise module, adapted to the individual noise profiles of a wide range of camera sensors.

+

One issue with a lot of denoising algorithms is that they assume that the variance of the noise is independent of the luminosity of the signal. By profiling the noise characteristics of a camera’s sensor at different ISO settings, the variance at different luminosities can be assessed, and the denoising algorithm can be adjusted to more evenly smooth out the noise.

+

Currently, darktable has sensor noise profiles for over 300 popular camera models from all the major manufacturers. If you generate your own noise profile for a camera that is not yet supported by darktable, be sure to share it with the darktable development team so they can include it in the next release! Please see darktable’s camera support page for more information.

+

🔗modes

+

The denoise (profiled) module implements two algorithms, each of which is available in either an easy-to-use “auto” mode, or a more advanced manual mode with additional controls:

+
+
non-local means
+
This algorithm works in the spatial domain in much the same way as the astrophoto denoise module. It averages each pixel with some surrounding pixels in the image. The weight of such a pixel in the averaging process depends on the similarity of its neighborhood with the neighborhood of the pixel being denoised. A patch with a defined size is used to measure that similarity.
+
+

Note that this algorithm is quite resource-intensive.

+
+
wavelets (default)
+
This algorithm works in the wavelet domain, and provides a simplified user interface. Wavelet decomposition allows you to adjust the denoise strength depending on the coarseness of the noise in the image. This mode can be used in either Y0U0V0 color mode (which allows you to independently control luminance and chroma noise) or RGB color mode (which allows you to independently control noise for each RGB channel).
+
+

The wavelet algorithm is less resource-intensive than non-local means.

+
+
+

🔗luma versus chroma noise

+

Both “non-local means” and “wavelet” algorithms can efficiently tackle luma (lightness) noise and chroma (color) noise.

+

In the past, it was suggested that you use two separate instances of this module to tackle chroma and luma noise independently (using chroma and lightness blending modes). This is no longer recommended, since the denoise (profiled) module is placed before the input color profile module in the pixelpipe (so that the profile parameters are accurate) and color blending modes should only be used after the input color profile has been applied.

+

The new algorithms in this module now provide their own methods to separately handle luma and chroma noise, and in both cases this can be handled with a single module instance.

+

🔗module controls

+

The denoise (profiled) module provides some controls that are independent of the algorithm used. These are described first, before moving on to the algorithm-specific controls.

+

When describing the controls specific to an algorithm, we will first cover the simplified interface, and then move on to the more advanced controls for that algorithm.

+

Note that sliders are provided with minimum and maximum values by default. However, these are only soft limits and, where needed, higher values can be entered by right-clicking on the slider and typing a new value.

+

🔗common controls

+
+
profile
+
darktable automatically determines the camera model and ISO based on the Exif data of your raw file, and searches for a corresponding profile in its database. If your image has an intermediate ISO value, settings will be interpolated between the two closest datasets in the database, and this interpolated setting will show up as the first line in the combo box. You can also manually override this selection if necessary. Re-selecting the top-most entry in the combo box will return you to the default profile.
+
mode
+
Choose which denoising algorithm to use (see above), and whether to present the simplified (“auto”) or full manual interface for that algorithm.
+
whitebalance-adaptive transform
+
As the white balance amplifies each of the RGB channels differently, each channel exhibits different noise levels. This checkbox makes the selected algorithm adapt to the white balance adjustments. This option should be disabled on the second instance if you have applied a first instance with a color blend mode.
+
adjust autoset parameters (auto modes only)
+
Automatically adjust all the other parameters on the current denoising algorithm using a single slider. This is particularly useful when you have had to increase the exposure on an underexposed image, which normally introduces additional noise (as if you had taken the shot with a higher ISO). This control compensates for that by using settings similar to those used for a higher ISO image. The “effective ISO” used by the denoise algorithm is the actual ISO used, multiplied by the value of this slider.
+
strength
+
Fine-tune the strength of the denoising. The default value has been chosen to maximize the peak signal-to-noise ratio. It’s mostly a matter of taste – whether you prefer a low noise level at the cost of fine details, or you accept more noise to better preserve fine detail.
+
preserve shadows (advanced mode only)
+
Lower this control to denoise the shadows more aggressively. Usually, as noise increases, you will need to decrease this parameter.
+
bias correction (advanced mode only)
+
Correct any color cast that may appear in the shadows. Increase this value if dark shadows appear too green, decrease if they appear too purple.
+
+

🔗non-local means auto sliders

+
+
central pixel weight (details)
+
Control the amount of detail that should be preserved by the denoising algorithm. By default, this will have a low value, meaning that the algorithm will treat both luma and chroma noise equally. Move this slider to the right to reduce the amount of luma denoising, so that the algorithm will primarily affect chroma noise. By adjusting this slider together with the strength slider, you can find a good balance between luma and chroma denoising.
+
+

🔗non-local means advanced sliders

+

When you take non-local means out of auto mode, the adjust autoset parameters slider is replaced with the following controls. You can use the auto-adjust slider to arrive at some initial settings then, when you switch to manual mode, the sliders will show the equivalent manual settings. You can then continue to fine-tune the manual settings from the auto-set starting point.

+
+
patch size
+
Control the size of the patches being matched when deciding which pixels to average – see astrophoto denoise for more information. Increase this for images with more noise but be aware that high values may smooth out fine edges. The effect of this slider on processing time is minimal.
+
search radius
+
Control how far away from a pixel the algorithm will attempt to find similar patches. Increasing the value can give better results for very noisy images when coarse grain noise is visible, but the processing time is hugely impacted by this parameter (the processing time increases with the square of this parameter). A lower value will make execution faster, a higher value will make it slower. It most cases it is better to use the scattering parameter, which has a similar effect but without the heavy processing cost.
+
scattering (coarse-grain noise)
+
Like the search radius, this slider controls how far from a pixel the algorithm will attempt to find similar patches. However, it does this without increasing the number of patches considered. As such, processing time will stay about the same. Increasing the value will reduce coarse grain noise, but may smooth local contrast. This slider is particularly effective at reducing chroma noise.
+
+

🔗wavelet curves

+

Wavelet curves are shown when one of the “wavelet” modes is selected.

+

The noise in an image usually consists of both fine grain and coarse grain noise, to varying degrees. The wavelet curves allow the strength of the denoising to be adjusted depending on the coarseness of the visible noise. The left end of the curve will act on very coarse grain noise, while the right of the curve will act on very fine grain noise. Raising the curve will increase the amount of smoothing, while lowering the curve will decrease it.

+

For example, you can preserve very-fine-grain noise by pulling the right-most part of the curve down. When tackling chroma noise (e.g. on a U0V0 curve, or on a second module instance with a color blend mode) you can safely raise the right side of the curve, since colors do not change a lot on fine scales. This can be useful if you see some noisy isolated pixels with the wrong color.

+

🔗wavelets Y0U0V0 color mode

+

The preferred way to use wavelets is with the Y0U0V0 color mode. This mode separates the denoising curves into luminance (Y0) and color (U0V0) components. You can then use the Y0 curve to control the level of luma denoising, and the U0V0 curve to control the level of chroma denoising.

+

+ + + + + + + + +denoise-y0u0v0 + +

+

🔗wavelets RGB color mode

+

Before the Y0U0V0 color mode was introduced, wavelet-based denoising could only be performed directly on the R, G and B channels, either together or individually.

+

+ + + + + + + + +denoise-rgb + +

+

If you want to denoise the RGB channels independently, the best way to do this is to use an instance of the color calibration module placed immediately before the denoise (profiled) module so that it outputs a gray channel based on the red channel only, then denoise that monochrome image using the red wavelet curve. Repeat this procedure for the blue and green channels. This procedure is time-consuming, but gives the best result because looking at the color of a noisy pixel is not a reliable way to determine which channel to adjust. For example, a noisy red pixel could be due to a noise peak on the red channel, but could also be due to a noise lull on the blue and green channels.

+

The issue with independently denoising the RGB channels is that there can still be some residual chroma noise at the end that requires excessive smoothing to eliminate. This was in fact one of the key motivations behind implementing the Y0U0V0 color mode.

+

🔗wavelets advanced sliders

+

When you take wavelets out of auto mode, the adjust autoset parameters slider is replaced with the preserve shadows and bias correction controls listed above in the common controls section.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/diffuse/index.html b/en/module-reference/processing-modules/diffuse/index.html new file mode 100644 index 0000000000..d88e5ea505 --- /dev/null +++ b/en/module-reference/processing-modules/diffuse/index.html @@ -0,0 +1,3160 @@ + + + + + +darktable user manual - diffuse or sharpen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / diffuse or sharpen + +
+ + + + +
+ +

+ diffuse or sharpen +

+ + + +

Diffusion is a family of physical processes by which particles move and spread gradually with time, from a source that generates them. In image processing, diffusion mostly occurs in two places:

+
    +
  • diffusion of photons through lens glass (blur) or humid air (hazing),
  • +
  • diffusion of pigments in wet inks or watercolors.
  • +
+

In both cases, diffusion makes the image less sharp by “leaking” particles and smoothing local variations.

+

The diffuse or sharpen module uses a generalized physical model to describe several kinds of diffusion, and can be used by image makers to either simulate or revert diffusion processes.

+

As it is a highly technical module, several presets are provided to demonstrate its use for various purposes.

+

Diffusion can be removed in order to:

+
    +
  • recover the original image from sensors with an anti-aliasing filter or mitigate the blur created by most demosaicing algorithms (use one of the sharpen demosaicing presets and move the module before the input color profile module in the pipeline),
  • +
  • reverse static lens blurring/defocusing (use one of the lens deblur presets),
  • +
  • remove atmospheric haze (use the dehaze preset),
  • +
  • add extra acutance for better legibility (use the local contrast preset).
  • +
+

Note that motion blurs cannot be reverted by undoing the diffusion process, as they are not diffusive in nature.

+

Diffusion can be added in order to:

+
    +
  • create a bloom or Orton effect (use the bloom preset),
  • +
  • inpaint missing or damaged parts of an image (use the inpaint highlights preset),
  • +
  • denoise in an edge-preserving way (use one of the denoise presets)
  • +
  • apply a surface blur (use the surface blur preset).
  • +
+

Since the process is physical, even its glitches may be used for creative purposes. For example, you can:

+
    +
  • simulate line drawing or watercolor (use the simulate line drawing and simulate watercolor presets),
  • +
  • create random patterns and textures by increasing noise (over time, with iterations, noise will connect with neighbors to create random specks).
  • +
+
+

Note: This module is highly resource-intensive, as it is actually an anisotropic, multiscale, partial differential equation solver. The module’s runtime increases with the number of iterations and OpenCL is therefore strongly recommended. Some “fast” presets are also provided for use on systems without OpenCL.

+
+

🔗concepts

+

🔗time

+

Diffusion is a time-dependent process: the more time it has, the further the particles can spread. In this module, time is simulated using the number of iterations (the number of times the algorithm runs on top of itself). More iterations can make reconstruction (deblurring, denoising, dehazing) more accurate if properly set, but can also cause it to degenerate.

+

🔗direction

+

Natural diffusion usually takes place from points with a high potential (high energy or high concentration of particles) to those with a low potential (low energy or low concentration of particles). In an image, this means that diffusion always occurs from the brightest pixels to the darkest.

+

This particular implementation can simulate natural diffusion, using what is called an isotropic diffusion (all directions have the same weight, like heat diffusion), but can also force a weighted direction parallel to the gradients (forcing diffusion across object edges and creating ghost edges), or a weighted direction perpendicular to the gradients, called isophote (forcing diffusion to be contained inside edges, like in a droplet of watercolor). The relative weight of each direction (gradient and isophote) is user-defined and can be found in the direction section of the module.

+

🔗speed

+

Depending how fluid the environment is, particles can move more or less freely and therefore more or less fast. The speed of diffusion can be set in the speed section of the module.

+

When performing reconstruction (denoising, deblurring, dehazing), it is advisable to use smaller speeds for better accuracy. This prevents numerical overshoots (and therefore degeneration of the solution) and may require more iterations. For small numbers of iterations, higher speeds may be used. Note that large blurs need many iterations for proper reconstruction, so the speed should be adjusted to avoid degenerating the solution.

+

All speeds are added (first to fourth orders), and the sums “first order + second order” and “third order + fourth order” should never exceed ±100%, unless you want to produce glitch art.

+

🔗scale

+

Natural diffusion is supposed to happen only to the closest neighboring coordinates. That is, at each iteration, each pixel should only interact with its 9 nearest neighbors.

+

Here, we fast-track things a bit to save time and reuse the multi-scale wavelets scheme from the contrast equalizer module, so that we can diffuse at different scales. The maximal scale of diffusion is defined by the radius span parameter.

+

Regardless of the diffusion, a sharpness parameter allows you to increase or decrease the details at each scale, much like the spline controls of the contrast equalizer. Along with the edge sensitivity slider, this provides the same features as the contrast equalizer module (luma and edges tabs) but in a scene-referred RGB space.

+

🔗module controls

+

🔗properties

+
+
iterations
+
The number of times the algorithm should run on top of itself. High values slow the module down but allow more accurate reconstructions, provided that the diffusion speeds are low enough.
+
central radius
+
The main scale of the diffusion. Zero causes the diffusion to act more heavily on fine details (used for deblurring and denoising). Non-zero values define the size of details to be heavily diffused (used to increase local contrast).
+
radius span
+
This allows you to select the band of details radii to act on, around the central radius. The span of diffusion defines a range of detail scales (between center - span and center + span) within which the diffusion is confined. High values diffuse on a large band of radii, at the expense of computation time. Low values diffuse closer around the central radius. If you plan to deblur, the radius span should be approximately the width of your lens blur and the central radius should be zero. If you plan to increase the local contrast, but don’t want to affect sharpness or noise, the radius span should be 3/4 of your central radius maximum.
+
+

The radii are expressed in pixels of the full-resolution image, so copy+pasting settings between images of different resolution may lead to slightly different results, except for pixel-level sharpness.

+

For electrical engineers, what is set here is a band-pass filter in wavelets space, using a gaussian frequential window centered on central radius with a fall-off (standard deviation) of radius span. Wavelet scales are analogous to harmonic frequencies and each wavelet scale defines the radius of the details to act on.

+

🔗speed (sharpen ↔ diffuse)

+

In the following controls, positive values apply diffusion, negative values undo diffusion (i.e. sharpen) and zero does nothing.

+
+
1st order speed (gradient)
+
The speed of diffusion of the low-frequency wavelet layers in the direction defined by the 1st order anisotropy setting.
+
2nd order speed (laplacian)
+
The speed of diffusion of the low-frequency wavelet layers in the direction defined by the 2nd order anisotropy setting.
+
3rd order speed (gradient of laplacian)
+
The speed of diffusion of the high-frequency wavelet layers in the direction defined by the 3rd order anisotropy setting.
+
4th order speed (laplacian of laplacian)
+
The speed of diffusion of the high-frequency wavelet layers in the direction defined by the 4th order anisotropy setting.
+
+

🔗direction

+

In the following controls, positive values cause diffusion to avoid edges (isophotes), negative values make diffusion follow gradients more closely, and zero affects both equally (isotropic).

+
+
1st order anisotropy
+
The direction of diffusion of the low-frequency wavelet layers relative to the orientation of the gradient of the low-frequency (1st order speed setting).
+
2nd order anisotropy
+
The direction of diffusion of the low-frequency wavelet layers relative to the orientation of the gradient of the high-frequency (2nd order speed setting).
+
3rd order anisotropy
+
The direction of diffusion of the high-frequency wavelet layers relative to the orientation of the gradient of the low-frequency (3rd order speed setting).
+
4th order anisotropy
+
The direction of diffusion of the high-frequency wavelet layers relative to the orientation of the gradient of the high-frequency (4th order speed setting).
+
+

🔗edge management

+
+
sharpness
+
Apply a gain on wavelet details, regardless of properties set above. Zero does nothing, positive values sharpen, negative values blur. This is mostly useful as an adjustment variable when blooming or blurring, to retain some sharpness while adding a glow around edges. You are not advised to use this for sharpening alone, since there is nothing to prevent halos or fringes with this setting.
+
edge sensitivity
+
Apply a penalty over the diffusion speeds when edges are detected. This detection uses the local variance around each pixel. Zero disables the penalty, higher values make the penalty stronger and more sensitive to edges. Increase if you notice edge artifacts like fringes and halos.
+
edge threshold
+
Define a variance threshold, which affects mostly low-variance areas (dark or blurry areas, or flat surfaces). Positive values will increase the penalty for low-variance areas, which is good for sharpening or increasing local contrast without crushing blacks. Negative values will decrease the penalty for low-variance areas, which is good for denoising or blurring with a maximal effect on black and blurry regions.
+
+

🔗diffusion spatiality

+
+
luminance masking threshold
+
This control is useful if you want to in-paint highlights. For values greater than 0%, the diffusion will only occur in regions with a luminance greater than this setting. Note that gaussian noise will be added in these regions to simulate particles and initialize the in-painting.
+
+

🔗workflow

+

The main difficulty with this module is that while its output can vary dramatically depending on its input paramaters, these parameters have no intuitive link to everyday life. Users are likely to be overwhelmed, unless they are already familiar with Fourier partial differential equations. This section proposes some ways to approach this module without the burden of having to understand the underlying theory.

+

🔗general advice

+

If you intend to deblur your image using this module, always start by properly correcting any chromatic aberrations and noise in the image, since the deblurring may magnify these artifacts. It is also important that you don’t have clipped black pixels in your image. These can be corrected with the black level correction of the exposure module.

+

Since it works on separate RGB channels, it is better to apply this module after color calibration, so that you start with a fully neutral, white-balanced, input image. Note that increasing local contrast or sharpness will also lead to a slight color contrast and saturation boost, which is usually a good thing. Since it uses a variance-based regularization to detect edges, it is also better to put this module before any non-linear operation.

+

🔗starting with presets

+

The provided presets have been tuned by the developer and tested on a range of images for typical purposes. The easiest way is simply to start from the presets, and then tweak them as needed:

+
    +
  • if the effect seems too strong, decrease the number of iterations,
  • +
  • if edge artifacts appear, increase the edge sensitivity,
  • +
  • if deblurring starts to affect valid blurry parts (bokeh), reduce the radius,
  • +
  • if deblurring seems correct in bright areas but excessive in dark areas, increase the edges threshold,
  • +
  • if deblurring clips black pixels, lower the black level correction in exposure module,
  • +
  • fine-tune the sharpness to your taste.
  • +
+

🔗starting from scratch

+

The module’s default settings are entirely neutral and will do nothing to your image. The spirit of the module is that each order affects the texture of the image in a particular way.

+

Start by tuning the first order parameters (speed and anisotropy) to get an initial base. Then adjust the radius. This will affect coarser textures (either blur or sharpen them). Remember that the first order acts on the low frequencies of the wavelet scale and follows a direction parallel or perpendicular to the gradient of the low frequencies.

+

Next, start to tune the second order parameters (speed and anisotropy). The second order also acts on the low frequencies of the wavelet scale but this time follows a direction parallel or perpendicular to the gradient of the high frequencies, which can either be the direction of maximal sharpness or of noise. This can be used to reduce noise (using the second order in diffusion mode, with positive values) when you used the first order in sharpening mode (with negative values).

+

These two steps can be performed on the zoomed-out image. Remember that, while great care has been taken to make the algorithm’s visual result fairly scale-invariant, the preview will be exact only when zoomed 1:1. In any case, anything happening at pixel level (radius < 2px) will not be visible for zoom levels lower than 50%.

+

At this point, you may want to tweak the edge sensitivity to take care of any edge artifacts. In theory, diffusing in the isophote direction ensures that diffusion is contained inside edges, but this is not sufficient when corners and sharp convex shapes are present in the image.

+

When the edge sensitivity control has been adjusted to produce satisfying results, the image usually becomes quite soft. In most cases it will be necessary, at this point, to increase the number of iterations in order to compensate. This will come with a performance penalty so tread carefully with the performance/quality trade-off depending on your hardware. If you can’t increase the number of iterations, you will have to increase the diffusing speed.

+

The final step is to fine-tune the third and fourth order, which take care of the high frequencies of each wavelet scale. You will need to be a lot more gentle with these settings than for the first and second orders, as they can cause noise to blow-up really fast.

+

The third order follows the gradient or isophote direction of the low frequency layer, so can be used to guide the high frequency diffusion in a direction that is more likely to be legitimate regarding real edges (and less prone to catch noise).

+

The fourth order follows the gradient or isophote direction of the high frequency layer and is more likely to catch noise. Diffusing on the fourth order is the best way to reduce noise without affecting sharpness too much, either as a stand-alone denoiser, or as a regularization step in a deblurring process.

+

🔗using multiple instances for image reconstruction

+

Noise post-filtering may benefit from introducing a diffusion process – this can be applied as an extra step after the denoise (profiled) module.

+

Conversely, the following optical issues may benefit from reconstruction by undoing the diffusion process:

+
    +
  1. blur introduced by a sensor’s low-pass filter (LPF) and/or anti-aliasing performed by the demosaic module,
  2. +
  3. static lens blur,
  4. +
  5. haze/fog,
  6. +
  7. light diffusion (using a diffuser that is too large), leading to even lighting and lack of local contrast on the subject.
  8. +
+

While more than one of these issues can affect the same picture at the same time, it is better to try to fix them separately using multiple instances of the module. When doing so, ensure the issues are corrected from coarse scale to fine scale, and that denoising always happens first. That is, your instances should appear in the following pipe order:

+
    +
  1. denoise,
  2. +
  3. local contrast enhancement,
  4. +
  5. dehaze,
  6. +
  7. lens blur correction,
  8. +
  9. sensor and demosaic correction.
  10. +
+

Starting with the coarser-scale reconstructions reduces the probability of introducing or increasing noise when performing the finer-scale reconstructions. This is unintuitive because these processes don’t happen in this order during the formation of the image. For the same reason, denoising should always happen before any attempt at sharpening or increasing acutance.

+

🔗notes and warnings

+

While this module is designed to be scale-invariant, its output can only be guaranteed at 100% zoom and high quality or full-size export. Results at lower zoom levels or export dimensions may or may not match your expectations.

+

When setting a deblurring algorithm, try to bear in mind that many of the greatest images in the history of photography were taken with lenses that were not remotely as sharp as those available today. Although the current trend is to build and sell increasingly sharp lenses and have software apply insane amounts of sharpening on top, this fashion does not lead to better imagery and makes the retouching process more tedious. Soft focus and a bit of blurriness have some poetic merits too, which surgically-sanitized HD images may fail to convey.

+

It should be noted that global contrast (using simple tone curves or black/white levels) also affects our perception of sharpness, which is quite different from optical sharpness (optical resolution). Human eyes are only sensitive to local contrast, which may come from optical sharpness (e.g absence of diffusion – thin edges) as well as from amplified tonal transitions. If some global tone mapping is in place to increase the contrast, the image will look sharper. If a tone mapping is used to decrease the contrast, the image will look more blurry. In none of these cases are the actual edges of objects affected in any way, and the perceptual consequences are pure illusion.

+

Part of the aging process is a loss of eyesight. The amount of sharpening that people over 50 find pleasing may not be the same as for people in their 20s. It is worth considering sharpening to obtain a plausible result (matching your everyday perception) rather than a pleasing result (that may look good only to people with the same eyesight as yours).

+

Finally, assessing the sharpness of images zoomed to 1:1 (100%) or more is a foolish task. In museums, exhibitions and even on screen, the general audience looks at images as a whole, not with a magnifying glass. Moreover, in most practical uses, photographs rarely exceed a resolution of 3000×2000 pixels (roughly a 300 DPI print at A4/Letter dimensions) which, for 24 megapixel sensors, means downscaling by a factor of 4. When examining a 24 megapixel file at 1:1, you are actually looking at an image that will never exist. Sharpening at pixel level, in this context, is a waste of time and CPU cycles.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/dither-or-posterize/index.html b/en/module-reference/processing-modules/dither-or-posterize/index.html new file mode 100644 index 0000000000..7f1664a59c --- /dev/null +++ b/en/module-reference/processing-modules/dither-or-posterize/index.html @@ -0,0 +1,3035 @@ + + + + + +darktable user manual - dither or posterize + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / dither or posterize + +
+ +
+ + +
+ + +
+ +

+ dither or posterize +

+ + + +

This module eliminates some of the banding artifacts that can result when darktable’s internal 32-bit floating point data is transferred into discrete 8-bit or 16-bit integer output format for display or export. It can also be used for creative posterization effects.

+

Although not an inherent problem in any of darktable’s modules, some operations may provoke banding if they produce a lightness gradient in the image. To mitigate possible artifacts you should consider activating dithering when using the vignetting or graduated density modules. This is especially relevant for images with extended homogeneous areas such as cloudless sky. Also watch out for banding artifacts when using a gradient drawn mask.

+

Viewing an image dithered into a very low bit depth from some distance (e.g. “Floyd-Steinberg 1-bit b&w”) will give the impression of a homogeneous grayscale image. darktable attempts to mimic this impression when rendering zoomed-out images in the center view, the navigation window and thumbnails. This is accomplished by dithering those images into a higher number of grayscale levels. Note that, as a consequence, the scopes module – the data for which is derived from the navigation window – will show this increased number of levels and is therefore not a full match to the output image.

+

🔗module controls

+
+
method
+
Choose the dithering method to use.
+
+

Floyd-Steinberg (default): Systematically distribute quantization errors over neighboring pixels. This method can be selected with some typical output bit depths. Alternatively, you can select Floyd-Steinberg auto, which automatically adapts to the desired output format.

+
+
+

random dithering: This method just adds some level of randomness to break sharp tonal value bands.

+
+
+

posterization: This method quantizes the pixel values into the indicated number of distinct levels per color channel (similar to Floyd-Steinberg) but does not redistribute the quantization errors, producing a posterization effect. Selecting two levels per channel produces eight possible output colors, three levels produces 27 colors (3x3x3), and so on. Use other modules affecting colors or tone curves (such as tone equalizer or color balance rgb) to fine-tune which pixels produce which posterized colors. You can also use various blending modes to control the colors of the result.

+
+
damping (“random” method only)
+
Controls the level of added random noise expressed as a damping factor in a 10*log 2 basis. A value of -80 is a good fit for 8-bit output formats as it corresponds to a maximum change of one of the 256 possible levels; -160 is a good fit for for 16-bit output.
+
+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/enlarge-canvas/index.html b/en/module-reference/processing-modules/enlarge-canvas/index.html new file mode 100644 index 0000000000..4f95760300 --- /dev/null +++ b/en/module-reference/processing-modules/enlarge-canvas/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - enlarge canvas + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / enlarge canvas + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ enlarge canvas +

+ + + +

Increase the size of the image canvas and fill the additional area with the selected color.

+

🔗module controls

+
+
percent left
+
The amount of enlargement to the left of the image.
+
percent right
+
The amount of enlargement to the right of the image.
+
percent top
+
The amount of enlargement to the top of the image.
+
percent bottom
+
The amount of enlargement to the bottom of the image.
+
color
+
The color with which to fill the additional area.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/exposure/index.html b/en/module-reference/processing-modules/exposure/index.html new file mode 100644 index 0000000000..9e5d6eebf4 --- /dev/null +++ b/en/module-reference/processing-modules/exposure/index.html @@ -0,0 +1,3064 @@ + + + + + +darktable user manual - exposure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / exposure + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ exposure +

+ + + +

Increase or decrease the overall brightness of an image.

+

This module has two modes of operation:

+
+
manual
+
Set the exposure and black level manually
+
automatic (RAW images only)
+
Use an analysis of the image’s histogram to automatically set the exposure. Darktable automatically selects the exposure compensation that is required to shift the selected percentile to the selected target level (see definitions below). This mode is particularly useful for automatically altering a large number of images to have the same exposure. A typical use case of automatic mode is deflickering of time-lapse photographs.
+
+

🔗module controls

+
+
mode
+
Choose the mode of operation (automatic/manual).
+
compensate camera exposure (manual mode)
+
Automatically remove the camera exposure bias (taken from the image’s Exif data).
+
exposure (manual mode)
+
Increase (move to the right) or decrease (move to the left) the exposure value (EV). To adjust by more than the default limits shown on the slider, right click and enter the desired value up to +/-18 EV (see module controls).
+
The picker tool on the right sets the exposure such that the average of the selected region matches the target lightness defined in area exposure mapping options.
+
percentile (automatic mode)
+
Define a location in the histogram to use for automatic exposure correction. A percentile of 50% denotes a position in the histogram where 50% of pixel values are above and 50% of pixel values are below that exposure.
+
target level (automatic mode)
+
Define the target level for automatic exposure correction (EV) relative to the white point of the camera.
+
black level correction (manual and automatic modes)
+
Adjust the black level point to unclip negative RGB values.
+
+
+

Note: Do not use the black level correction to add more density in blacks as this can clip near-black colors out of gamut by generating negative RGB values. This can cause problems with some modules later in the pixelpipe. Instead, use a tone mapping curve to add density to the blacks. For example, you can use the relative black exposure slider on the scene tab of the filmic rgb module, or establish a deeper toe in the base curve module.

+
+

🔗area exposure mapping

+

The area mapping feature is designed to help with batch-editing a series of images in an efficient way. In this scenario, you typically develop a single reference image for the whole batch and then copy&paste the development stack to all of the other images in the batch.

+

Unfortunately, the light often changes slightly between shots, even within the same series captured in the same conditions. This can be the result of a cloud passing by the sun in natural light, surface reflections having less “shine” from a different angle, or simply due to unavoidable variability in the mechanical diaphragm aperture. Each image will still need some individual fine-tuning if you want a perfectly even look over the whole series, and this can be both time-consuming and frustrating.

+

Area exposure mapping allows you to define a target brightness, in terms of exposure, for a particular region of the image (the control sample), which you then match against the same target brightness in other images. The control sample can either be a critical part of your subject that needs to have constant brightness, or a non-moving and consistently-lit surface over your series of images.

+

The mapping process consists of two steps.

+

🔗step 1: set the target

+

There are two ways of setting the target brightness for your control sample:

+
    +
  1. if you know or expect an arbitrary lightness for the control sample (for example, a gray card, a color chart, a product or a logo of a specified brightness), you can set its L value directly, in CIE Lab 1976 space,
  2. +
  3. if you simply want to match the development of your reference image, set the area mode to measure, then enable the picker (to the right of the exposure slider) and draw a rectangle over your control sample. The input column will then be updated with the lightness value of the control sample before the exposure correction, and the target column will show the resulting lightness of the control sample after the current exposure setting is applied.
  4. +
+

If you reset the lightness value, the default value is 50% (middle-gray) – this can be useful to quickly set the average exposure of any image.

+

Note that the target value is not reset when you reset the module itself, but is stored indefinitely in darktable’s configuration and will be available on next launch as well as for the next image you develop.

+

🔗step 2 : match the target

+

When you open a new image, the area mode is automatically reset to correction. Using the picker attached to the exposure slider, you can then directly reselect your control sample in the new image. The proper exposure setting required for the control sample to match the memorized target lightness will be automatically computed, and the setting will be updated in the same operation.

+

This operation can be repeated as many times as you have images in your series with no further work.

+
+

Note 1: Trying to match lightness of moving parts of a subject across frames can prove tricky because they can have legitimate changes in their illumination as their orientation changes with respect to the main light source. For example, a part of the face can be fully lit in some frames and partially shaded in others. An inconsistently-lit control sample will generally not provide a robust reference for lightness matching across a series and may result in more work than manually matching it with visual feedback.

+

Note 2: The exposure module works (by default) in the scene-referred, linear, camera RGB part of the pixel pipeline, before the input color profile is applied. However, the conversion from camera RGB to CIE Lab 1976 space relies on the input color profile. All of the lightness L metrics given in the area mapping settings will use the input profile defined later in the input color profile module to perform the conversion accurately, but the conversion itself assumes a linear (RAW) signal and will not work for JPEG and PNG images (which are non-linearly encoded before the input color profile module). If you want to use this feature on non-RAW images, you will need to move the exposure module to after input color profile or to use the module order preset v3.0 for JPEG/non-RAW input.

+

Note 3: Perfectly matching your control sample against the target lightness may still not yield a similar perceptual result, even if the numbers are exactly the same. For example, if your subject sits in front of a background made of some bright parts and some dark parts, the ratio of bright areas / dark areas will affect the perception of contrast and brightness. If this ratio changes across your series, the subject brightness will not appear constant even though the lightness value is exactly constant. For more details, see the checker shadow illusion and the Chubb illusion.

+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/fill-light/index.html b/en/module-reference/processing-modules/fill-light/index.html new file mode 100644 index 0000000000..0e875a7dd8 --- /dev/null +++ b/en/module-reference/processing-modules/fill-light/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - (deprecated) fill light + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) fill light + +
+ + + + +
+ +

+ (deprecated) fill light +

+ + + +
+

Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module or the exposure module with a drawn mask.

+
+

Locally modify exposure based on pixel lightness.

+

This module pushes exposure by increasing lightness with a Gaussian curve of a specified width, centered on a given lightness.

+

🔗module controls

+
+
exposure
+
The fill-light exposure (EV)
+
center
+
The median lightness impacted by the fill-light. The lightness must be set manually but a picker can be used to provide a guide based on a sample from the image. The lightness of the selected point/area is displayed in the gradient bar.
+
width
+
The width of the Gaussian curve. This number is expressed in zones, with the full range being 10 zones.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/filmic-rgb/filmic-dynamic-range-map.png b/en/module-reference/processing-modules/filmic-rgb/filmic-dynamic-range-map.png new file mode 100644 index 0000000000..b4619a95ab Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/filmic-dynamic-range-map.png differ diff --git a/en/module-reference/processing-modules/filmic-rgb/filmic-look-mapping-lin.png b/en/module-reference/processing-modules/filmic-rgb/filmic-look-mapping-lin.png new file mode 100644 index 0000000000..ea8bf42147 Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/filmic-look-mapping-lin.png differ diff --git a/en/module-reference/processing-modules/filmic-rgb/filmic-look-mapping-log.png b/en/module-reference/processing-modules/filmic-rgb/filmic-look-mapping-log.png new file mode 100644 index 0000000000..9234a6f2cf Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/filmic-look-mapping-log.png differ diff --git a/en/module-reference/processing-modules/filmic-rgb/filmic-look-only.png b/en/module-reference/processing-modules/filmic-rgb/filmic-look-only.png new file mode 100644 index 0000000000..7dca6b18fd Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/filmic-look-only.png differ diff --git a/en/module-reference/processing-modules/filmic-rgb/index.html b/en/module-reference/processing-modules/filmic-rgb/index.html new file mode 100644 index 0000000000..4d85e9e51d --- /dev/null +++ b/en/module-reference/processing-modules/filmic-rgb/index.html @@ -0,0 +1,3428 @@ + + + + + +darktable user manual - filmic rgb + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / filmic rgb + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ filmic rgb +

+ + + + + +

Remap the tonal range of an image by reproducing the tone and color response of classic film.

+

This module can be used either to expand or to contract the dynamic range of the scene to fit the dynamic range of the display. It protects colors and contrast in the mid-tones, recovers the shadows, and compresses bright highlights and dark shadows. Highlights will need extra care when details need to be preserved (e.g. clouds).

+

The module is derived from another module of the same name in Blender 3D modeller by T. J. Sobotka. While it is primarily intended to recover high-dynamic-range images from raw sensor data it can be used with any image in place of the base curve module. The following video (by the developer of this module) provides a useful introduction: filmic rgb: remap any dynamic range in darktable 3.

+

filmic rgb is the successor to the filmic module from darktable 2.6. While the underlying principles have not changed much, the default settings and their assumptions have, so users of the previous version should not expect a 1:1 translation of their workflow to the new version.

+
+

Note: Despite the technical look of this module, the best way to set it up is to assess the quality of the visual result. Do not overthink the numbers that are presented in the GUI to quantify the strength of the effects.

+
+

🔗prerequisites

+

In order to get the best from this module, your images need some preparation:

+
+
capturing (ETTR)
+
In-camera, it is recommended that you use a technique known as “Expose To The Right” (ETTR). This means exposing the shot so that the exposure is as bright as possible without clipping the highlights. It is called “exposing to the right” because the in-camera histogram should be touching all the way up to the right hand side without peaking at the right hand side (which could indicate clipping). This technique ensures you make maximum use of the dynamic range of your camera’s sensor.
+
+

The default auto-exposure metering mode in your camera will normally expose the image so that the average brightness in the image tends towards middle-gray. Sometimes, for scenes dominated by light tones, the camera will underexpose the image to bring those light tones more towards middle-gray. For scenes dominated by dark tones, it may overexpose the image and end up clipping the highlights. In such cases you can use the exposure compensation dial in your camera to raise or lower the exposure – the darktable exposure module can automatically take this into account when processing your image.

+
+
+

In some cases (e.g. specular highlights reflecting off shiny objects) it may be acceptable to have some clipping, but be aware that any clipped data in your image is irrevocably lost. Where data has been clipped, filmic rgb offers a “highlight reconstruction” feature to help mitigate the effects of the clipping and blend it smoothly with the rest of the image. The settings for this feature are on the reconstruct tab. Some cameras also offer a “highlight priority” exposure metering mode that can help to maximise exposure while protecting the highlights, and many offer features such as “zebras” or “blinkies” in the live view to alert the photographer when parts of the image are being clipped.

+
+
adjust for the mid-tones
+
In the exposure module, adjust the exposure until the mid-tones are clear enough. Don’t worry about losing the highlights at this point – they will be recovered as part of the filmic processing. However, it is important to avoid negative pixels in black areas else the computations performed by filmic rgb may produce unpredictable results. For some camera models (Canon, mainly), rawspeed (the raw decoding library of darktable) may set an exaggerated black level, resulting in crushed blacks and negative pixel values. If so, brighten the blacks by setting a negative black level correction value in the exposure module.
+
white balance, denoise, demosaic
+
If you plan on using filmic rgb’s auto-tuners, use the white balance module to first correct any color casts and obtain neutral colors. In RGB color spaces, luminance and chrominance are linked, and filmic rgb’s luminance detection relies on accurate measurements of both. If your image is very noisy, add an initial step of denoising to improve the black exposure readings, and use a high quality demosaic algorithm. You don’t need to worry about noise if you are planning to set up filmic manually, without using the auto-tuners.
+
disable tone mapping modules
+
If you plan to use one of filmic rgb’s chrominance preservation modes, avoid using base curve and the various tone mapping modules. These may produce unpredictable color shifts that would make the chrominance preservation useless. None of these modules should be required when using filmic rgb.
+
+

🔗usage

+

The filmic rgb module is designed to map the dynamic range of the photographed scene (RAW image) to the dynamic range of the display.

+

This mapping is defined in three steps, each handled in a separate tab in the interface:

+
    +
  • +

    The scene tab contains the “input” settings of the scene, defining what constitutes white and black in the photographed scene.

    +
  • +
  • +

    The reconstruct tab offers tools to handle blown highlights.

    +
  • +
  • +

    The look tab contains the artistic intent of the mapping that is applied to the input parameters (as defined in the scene tab). This part of the module applies an S-shaped parametric curve to enhance the contrast of the mid-tones and remap the gray value to the middle-gray of the display. This is similar to what the base curve and tone curve modules do. As a general guideline, you should aim to increase the latitude as much as possible without clipping the extremes of the curve.

    +
  • +
  • +

    The display tab defines the output settings required to map the transformed image to the display. In typical use cases, the parameters in this tab rarely require adjustment.

    +
  • +
  • +

    The options tab includes some optional advanced settings and parameters.

    +
  • +
+

filmic rgb tends to compress local contrast, so after you have finished adjusting settings here, you may wish to compensate for this using the local contrast module. You may also want to increase the saturation in the color balance rgb module, and perhaps to further adjust the tones using the tone equalizer.

+

The ranges of filmic rgb’s sliders are limited to typical and safe values, but you can enter values outside of these limits by right-clicking and entering values with the keyboard.

+
+

Note: filmic rgb cannot be set with entirely neutral parameters (resulting in a “no-operation”) – as soon as the module is enabled, the image is always at least slightly affected. You can, however, come close to neutral with the following settings:

+
    +
  • in the look tab, set contrast to 1.0, latitude to 99 % and mid-tones saturation to 0 %,
  • +
  • in the options tab, set contrast in shadows and in highlights to soft.
  • +
+

In this configuration, filmic will only perform a logarithmic tone mapping between the bounds set in the scene tab.

+
+

🔗graphic display

+

The graphic display at the top of the filmic rgb module offers multiple views to help you to understand its functionality. You can cycle through these views using the + + + + + + + + +view-icon + + icon to the right of the graph display. You can also toggle the labels on the axes on and off using the + + + + + + + + +legend-icon + + icon.

+

The following views are available:

+
+
look only
+
This is the default view. The main bright curve shows how the dynamic range of the scene (in EV) is compressed into the display-referred output range. The orange dot shows the middle-gray point, the white dots either side mark out the latitude range, and the orange part of the curve at the bottom and top indicates an overshoot problem with the spline (the look tab has some controls to deal with this).
+
+

+ + + + + + + + +filmic-rgb-look-only + +

+
+
look + mapping (linear)
+
This view shows the mapping of input values [0,1] to output values in linear space, including the dynamic range mapping and the output transfer function. Note that in a scene-referred workflow, input values are allowed to exceed 1, however the graph only shows in/out values in the interval [0,1] in order to make the shape of the graph comparable to other tone curve mapping tools such as base curve or tone curve. The actual value of the scene white point is shown in brackets on the X axis (expressed as a percentage of an input value of 1).
+
+

+ + + + + + + + +filmic-rgb-look-mapping-lin + +

+
+
look + mapping (log)
+
The same as the previous view, but plotted in log space.
+
+

+ + + + + + + + +filmic-rgb-look-mapping-lin + +

+
+
dynamic range mapping
+
This view is inspired by the Ansel Adams Zone System, showing how the zones in the input scene (EV) are mapped to the output. Middle gray from the scene is always mapped to 18% in the output (linear) space, and the view shows how the tonal ranges towards the extremes of the scene exposure range are compressed into a smaller number of zones in the display space, leaving more room for the mid-tones to be spread out over the remaining zones. The latitude range is represented by the darker gray portion in the middle.
+
+

+ + + + + + + + +filmic-rgb-look-mapping-lin + +

+
+
+
+

Note: When some parameters are too extreme, resulting in an unfeasible curve, filmic rgb will sanitize them internally. Sanitizing is illustrated in two ways on the look views:

+
    +
  • A dot becoming red indicates that the linear part of the curve is pushed too far towards the top or the bottom. In the look tab, reduce the latitude or recenter the linear part using the shadows ↔ highlights balance parameter.
  • +
  • A dot becoming a half circle indicates that contrast is too low given the dynamic range of the image. Increase contrast in the look tab, or the dynamic range in the scene tab.
  • +
+
+

🔗module controls

+

🔗scene

+

The controls in the scene tab are similar in principle to those of the levels module (black, gray, white). The difference is that levels assumes display-referred pixels values (between 0 and 100%), whereas filmic allows you to work on scene-referred pixels (between –infinity EV and +infinity EV), which forces the use of a different interface.

+
+
middle-gray luminance (hidden by default)
+
This setting allows you to decide what luminance in the scene should be considered the reference middle-gray (which will be remapped to 18% in display). Use the picker tool to read the average luminance over the drawn area. If you have a photograph of a gray card or a color chart (IT8 chart or colorchecker) shot in the scene lighting conditions, then the gray picker tool can be used to quickly sample the luminance of the gray patch on that image. In other situations, the picker can be used to sample the average luminance of the subject.
+
+

This has an effect on the picture that is analogous to a brightness correction. Values close to 100% do not compress the highlights but fail to recover shadows. Values close to 0% greatly recover the shadows but compress the highlights more harshly and result in local-contrast losses.

+
+
+

When modifying the middle-gray luminance, the white and black exposures are automatically adjusted accordingly, to prevent the dynamic range from clipping and to help you set the right parameter faster. If you are not happy with the auto adjustment performed by the gray slider, you can correct the white and black exposure parameters afterwards.

+
+
+
+

Note: You are not advised to use this control to set middle-gray, hence it is now hidden by default. You should instead use the exposure module to set the middle-gray level (see usage, above). However, if you wish to make this slider visible, you can enable it with the use custom mid-gray values checkbox in the options tab.

+
+
+
white relative exposure
+
The number of stops (EV) between the scene middle-gray luminance and the scene luminance to be remapped to display white (peak-white). This is the right bound of the scene dynamic range that will be represented on the display – everything brighter than this value on the scene will be clipped (pure white) on the display. The picker tool reads the maximum luminance in RGB space over the drawn area, assumes it is pure white, and sets the white exposure parameter to remap the maximum to 100% luminance.
+
black relative exposure
+
The number of stops (EV) between the scene middle-gray luminance and the scene luminance to be remapped to display black (maximum density). This is the left bound of the scene dynamic range that will be represented on the display – everything darker than this value on the scene will be clipped (pure black) on the display. The picker tool reads the minimum luminance in RGB space over the drawn area, assumes it is pure black, and sets the black exposure parameter to remap the minimum to 0% luminance. The black picker measurement is very sensitive to noise, and cannot identify whether the minimum luminance is pure black (actual data) or just noise. It works better on low ISO pictures and with high quality demosaicing. When the picker puts the black exposure at –16 EV, this is a sign that the measurement has failed and you will need to adjust it manually.
+
+

The black relative exposure allows you to choose how far you want to recover lowlights.

+
+
dynamic range scaling and auto-tune
+
The auto-tune picker combines the above pickers, and allows you to set the white and black exposures at the same time, using the maximum of the drawn region as the white and the minimum as the black. This gives good results in landscape photography but usually fails for portraits and indoor scenes.
+
+

When no true white and black are available on the scene, the maximum and minimum RGB values read on the image are not valid assumptions any more. Dynamic range scaling symmetrically shrinks or enlarges the detected dynamic range and the current parameters. This works with both pickers, and adjusts the current values of white and black relative exposures.

+
+
+
+

Note: There is no direct relationship between your camera sensor’s dynamic range (to be found in DxoMark.com or PhotonsToPhotos.org measurements) and the dynamic range in filmic (scene white EV – scene black EV). Many things happen before filmic in the pipeline (for example a black raw offset that could map black to 0) such that filmic sees a theoretically infinite dynamic range at its input. This has to do only with pixel encoding manipulation in software, not actual sensor capabilities.

+

The scene-referred workflow forces a black level correction of –0.0002, in the exposure module, which ensures that the dynamic range seen by filmic’s input is around 12.3 EV most of the time. Decrease this value even more if setting the black relative exposure in filmic to –16 EV fails to unclip blacks.

+
+

🔗reconstruct

+

This tab provides controls that blend transitions between unclipped and clipped areas within an image and can also help to reconstruct colors from adjacent pixels. It is designed to handle spotlights that could not possibly be unclipped when taking the shot (such as naked light bulbs or the sun disc in the frame) and aims at diffusing their edges as film would do. It is not designed to recover large areas of clipped pixels or in-paint missing parts of the image.

+

It can sometimes be useful to disable the highlight reconstruction module in order to provide additional data to the reconstruction algorithm (highlight reconstruction clips highlight data by default). You should note that this can lead to magenta highlights, which will need to be handled with the gray/colorful details slider.

+

Firstly, a mask needs to be set up to identify the parts of the image that will be affected by the highlights reconstruction. There are then some additional controls to fine-tune some of the trade-offs made by the reconstruction algorithm.

+

🔗highlights clipping

+

These controls allow you to choose which areas of the image are impacted by the highlight reconstruction algorithms.

+
+
threshold
+
Any pixels brighter than this threshold will be affected by the reconstruction algorithm. The units are in EV, relative to the white point set in the scene tab. By default, this control is set to +3 EV, meaning that pixels need to be at least +3 EV brighter than the white point set in the scene tab in order for the highlight reconstruction to have any effect. In practise, this means that highlight reconstruction is effectively disabled by default (for performance reasons – it should only be enabled when required). Therefore, to use the highlights reconstruction feature, first click the display highlight reconstruction mask icon to show the mask, and lower this threshold until the highlight areas you want to reconstruct are selected in white by the mask. It may be useful to first review the image using the raw overexposed warning to show you which pixels in the raw file have been clipped, and whether those pixels are clipped on just one RGB channel or all of them.
+
transition
+
Use this control to soften the transition between clipped and valid pixels. Moving this control to the right will increase the amount of blur in the mask, so that the transition between clipped and non-clipped areas is softer. This allows for a smoother blending between the clipped and non-clipped regions. Moving this control to the left will reduce the blur in the mask, making the transition in the mask much sharper and therefore reducing the amount of feathering between clipped and non-clipped areas.
+
display highlight reconstruction mask
+
Click on the icon to the right of this label to toggle the display of the highlight reconstruction mask. It is recommended that you turn this on while adjusting the above controls.
+
+

🔗balance

+

These controls allow you to balance the trade-offs between the various reconstruction algorithms.

+
+
structure ↔ texture
+
Use this to control whether the reconstruction algorithm should favor painting in a smooth color gradient (structure), or trying to reconstruct the texture using sharp details extracted from unclipped pixel data (texture). By default, the control is in the middle at 0%, which favors both strategies equally. If you have lots of areas where all three channels are clipped, there is no texture detail available to reconstruct, so it is better to move the slider to the left to favor color reconstruction. If you have lots of areas where only one or two channels are clipped, then there may be some texture detail in the unclipped channel(s), and moving the slider to the right will place more emphasis on trying to reconstruct texture using this unclipped data.
+
bloom ↔ reconstruct
+
Use this to control whether the algorithm tries to reconstruct sharp detail in the clipped areas (reconstruct), or apply a blur that approximates the blooming effect you get with traditional film (bloom). By default, this is set to 100%, which tries to maximise the sharpness of the detail in the clipped areas. Move this slider to the left if you want to introduce more blur in these areas. Introducing more blur will usually tend to darken the highlights as a by-product, which may lead to a more colorful reconstruction.
+
gray ↔ colorful details
+
Use this to control whether the algorithm favors the recovery of monochromatic highlights (gray) or colorful details. Move the slider to the right if you want more color in the highlights. Move the slider to the left if you want to reduce the saturation of the highlights. It can be helpful to reduce the saturation in the highlights if you start seeing magenta or out-of-gamut colors.
+
+

🔗look

+

When working on the look tab, it is recommended that you monitor the S-curve spline on the look only graph. This curve starts from the scene/display black levels at the bottom left of the graph, and should smoothly increase up to the scene/display white levels at the top right. Sometimes, if the constraints on the S-curve are too tight, the splines in the shadows and/or highlights regions can “overshoot” the limits of the display, and an orange warning is shown on those parts of the spline.

+

If you see the orange warning indicator at either end of the S-curve, corrective actions should be performed to bring the S-curve back to a smooth monotonically increasing curve. This may involve:

+
    +
  • +

    reducing the latitude and/or contrast,

    +
  • +
  • +

    adjusting the shadows/highlights slider to shift the latitude and allow more room for the spline,

    +
  • +
  • +

    ensuring that the scene-referred black and white relative exposure sliders on the scene tab have been properly set for the characteristics of the scene,

    +
  • +
  • +

    setting one or both of the contrast settings on the options tab to safe or hard.

    +
  • +
+

If the target black luminance setting on the display tab is non-zero, this can also make it difficult for filmic rgb to find a smooth monotonic spline, and reducing this can also help to relax the constraints. See the display section to understand the implications of this.

+
+
contrast
+
The filmic S-curve is created by computing the position of virtual nodes from the module parameters and interpolating them. This is similar to how the tone curve module operates, but here, the nodes cannot be moved manually. The curve is split into three parts – a middle linear part, and two extremities that transition smoothly from the slope of the middle part to the ends of the exposure range.
+
+

The contrast slider controls the slope of the middle part of the curve, as illustrated in the graph display. The larger the dynamic range, the greater the contrast should be set to, in order preserve a natural-looking image. This parameter mostly affects the mid-tones. Note that global contrast has an impact on the acutance (perceived sharpness) – a low-contrast image will look unsharp even though it is optically sharp in the sense of the Optical Transfer Function (OTF).

+
+
+

Setting the contrast to 1 almost completely disables the S-curve, though there will be a very small residual effect from the splines in the highlights and shadows.

+
+
hardness (previously target power factor function)
+
Known as the target power factor function slider in older versions of filmic rgb, this slider is hidden by default, and is adjusted automatically based on values in the scene tab. To make this slider visible, you need to uncheck auto adjust hardness in the options tab.
+
+

This parameter is the power function applied to the output transfer function, and it is often improperly called the gamma (which can mean too many things in imaging applications, so we should stop using that term). It is used to raise or compress the mid-tones to account for display non-linearities or to avoid quantization artifacts when encoding in 8 bit file formats. This is a common operation when applying ICC color profiles (except for linear RGB spaces, like Rec. 709 or Rec. 2020, which have a linear “gamma” of 1.0). However, at the output of filmic rgb, the signal is logarithmically encoded, which is not something ICC color profiles know to handle. As a consequence, if we let them apply a gamma of 1/2.2 on top, it will result in a double-up, which would cause the middle-gray to be remapped to 76% instead of 45% as it should in display-referred space.

+
+
latitude
+
The latitude is the range between the two nodes enclosing the central linear portion of the curve, expressed as a percentage of the dynamic range defined in the scene tab (white relative exposure minus black relative exposure). It is the luminance range that is remapped in priority, and it is remapped to the luminance interval defined by the contrast parameter. It is usually advisable to keep the latitude as large as possible, while avoiding clipping. If clipping is observed, you can compensate by either decreasing the latitude, shifting the latitude interval with the shadow ↔ highlights balance parameter, or decreasing the contrast.
+
+

The latitude also defines the range of luminances that are not desaturated at the extremities of the luminance range (See mid-tones saturation).

+
+
shadows ↔ highlights balance
+
By default, the latitude is centered in the middle of the dynamic range. If this produces clipping at one end of the curve, the balance parameter allows you to slide the latitude along the slope, towards the shadows or towards the highlights. This allows more room to be given to one extremity of the dynamic range than to the other, if the properties of the image demand it.
+
mid-tones saturation / extreme luminance saturation / highlights saturation mix
+
At extreme luminances, the pixels will tend towards either white or black. Because neither white nor black have color associated with them, the saturation of these pixels must be 0%. In order to gracefully transition towards this 0% saturation point, pixels outside the mid-tone latitude range are progressively desaturated as they approach the extremes. The darker curve in the filmic rgb graph indicates the amount of desaturation that is applied to pixels outside the latitude range. Moving the slider to the right pushes the point where desaturation will start to be applied towards the extremes, resulting in a steeper desaturation curve. If pushed too far, this can result in fringing around the highlights. Moving the slider to the left brings the point at which color desaturation will start to be applied closer to the center, resulting in a gentler desaturation curve. If you would like to see more color saturation in the highlights, and you have checked that the white relative exposure in the scene tab is not yet clipping those highlights, move the mid-tones saturation slider to the right to increase the saturation.
+
+

Please note that this desaturation strategy has changed compared to previous versions of filmic rgb (which provided a different slider control labelled extreme luminance saturation). You can revert to the previous desaturation behaviour by selecting “v3 (2019)” in the color science setting on the options tab. Since filmic v6 and v7 use accurate gamut mapping to the output color space, the desaturation curve is removed and the extreme luminance desaturation becomes a method to control the bleaching of highlights.

+
+
+

This control is set to 0 by default and it is now recommended that saturation is handled earlier in the pipeline. A preset “add basic colorfulness” has been added to the color balance rgb module for this purpose.

+
+
+

🔗display

+

The parameters in this tab should rarely require adjustment.

+
+
target black luminance
+
The destination parameters set the target luminance values used to remap the tones. The default parameters should work 99% of the time, the remaining 1% being when you output in linear RGB space (Rec. 709, Rec. 2020) for media handling log-encoded data. These settings should therefore be used with caution because darktable does not allow separate pipelines for display preview and file output.
+
+

The target black luminance parameter sets the ground-level black of the target medium. By default it is set to the minimum non-zero value that can be encoded by the available number of bits in the output color space. Reducing it to zero means that some non-zero luminances will be mapped to 0 in the output, potentially losing some detail in the very darkest parts of the shadows. Increasing this slider will produce raised, faded blacks that can provide something of a “retro” look.

+
+
target middle-gray
+
This is the middle-gray of the output medium that is used as a target for the S-curve’s central node. On gamma-corrected media, the actual gray is computed with the gamma correction (middle-gray^(1/gamma)), so a middle-gray parameter of 18% with a gamma of 2.2 gives an actual middle-gray target of 45.87%.
+
target white luminance
+
This parameter allows you to set the ceiling level white of the target medium. Set it lower than 100% if you want dampened, muted whites to achieve a retro look.
+
+

To avoid double-ups and washed-out images, filmic rgb applies a “gamma” compression reverting the output ICC gamma correction, so the middle-gray is correctly remapped at the end. To remove this compression, set the destination power factor to 1.0 and the middle-gray destination to 45%.

+
+
+

🔗options

+
+
color science
+
This setting defaults to v7 (2023) for new images, and defines the algorithms used by the filmic rgb module (e.g. the extreme luminance desaturation strategy). To revert to the behavior of previous versions of filmic rgb, set this parameter to v3 (2019), v4 (2020) or v5 (2021). The difference between these methods lies in the way in which they handle desaturation close to pure black and pure white (see the background section for details). If you have previously edited an image using older versions of filmic rgb, the color science setting will be kept at the earlier version number in order to provide backward compatibility for those edits. v7 (2023) removes the preserve chrominance option (see background).
+
preserve chrominance (not available with color science v7)
+
Define how the chrominance should be handled by filmic rgb – either not at all, or using one of the three provided norms.
+
+

When applying the S-curve transformation independently on each color, the proportions of the colors are modified, which modifies the properties of the underlying spectrum, and ultimately the chrominance of the image. This is what happens if you choose “no” in the preserve chrominance parameter. This value may yield seemingly “better” results than the other values, but it may negatively impact later parts of the pipeline, for example, when it comes to global saturation.

+
+
+

The other values of this parameter all work in a similar way. Instead of applying the S-curve to the R, G and B channels independently, filmic rgb, divides all the three components by a norm (N), and applies the S-curve to N. This way, the relationship between the channels is preserved.

+
+
+

The value of the preserve chrominance parameter indicates which norm is used (the value used for N):

+
+
+
    +
  • no means that the ratios between the RGB channels are not preserved. This will tend to saturate the shadows and desaturate the highlights, and can be helpful when there are out-of-gamut blues or reds.
  • +
+
+
+
    +
  • max RGB is the maximum value of the R, G and B channels. This is the same behaviour as the original version of the filmic rgb module. It tends to darken the blues, especially skies, and to yield halos or fringes, especially if some channels are clipped. It can also flatten the local contrast somewhat.
  • +
+
+
+
    +
  • luminance Y is a linear combination of the R, G and B channels. It tends to darken and increase local contrast in the reds, and tends not to behave so well with saturated and out-of-gamut blues.
  • +
+
+
+
    +
  • RGB power norm is the sum of the cubes of the R, G, and B channels, divided by the sum of their squares (R³ + G³ + B³)/(R² + G² + B²). It is usually a good compromise between the max RGB and the luminance Y values.
  • +
+
+
+
    +
  • RGB euclidean norm has the property of being RGB-space-agnostic, so it will yield the same results regardless of which working color profile is used. It weighs more heavily on highlights than the power norm and gives more highlights desaturation, and is probably the closest to a color film look.
  • +
+
+
+

There is no “right” choice for the norm, and the appropriate choice depends strongly on the image to which it is applied. You are advised to experiment and decide for yourself which setting gives the most pleasing result with the fewest artifacts.

+
+
contrast in highlights
+
This control selects the desired curvature at the highlights end of the filmic rgb spline curve. The default setting (safe) is guaranteed not to over- or under-shoot but has quite muted contrast near white. Selecting hard places a tighter constraint on the slope of the spline, which makes the curve sharper and hence introduces more tonal compression in the highlights. Selecting soft loosens this constraint, resulting in a gentler curve with less tonal compression in the highlights.
+
contrast in shadows
+
This control selects the desired curvature at the shadows end of the filmic rgb spline curve. The default setting (safe) is guaranteed not to over- or under-shoot but has quite muted contrast near black. Selecting hard places a tighter constraint on the slope of the spline, which makes the curve sharper and hence introduces more tonal compression in the shadows. Selecting soft loosens this constraint, resulting in a gentler curve with less tonal compression in the shadows.
+
use custom middle-gray values
+
Enabling this setting makes the middle-gray luminance slider visible on the scene tab. With the current version of filmic rgb, you are advised to use the exposure module to set the middle-gray level, so this setting is disabled by default (and the middle-gray luminance slider is hidden).
+
auto-adjust hardness
+
By default, this setting is enabled, and filmic rgb will automatically calculate the power function (aka “gamma”) to be applied on the output transfer curve. If this setting is disabled, a hardness slider will appear on the look tab so that value can be manually set.
+
iterations of high-quality reconstruction
+
Use this setting to increase the number of passes of the highlight reconstruction algorithm. More iterations means more color propagation into clipped areas from pixels in the surrounding neighbourhood. This can produce more neutral highlights, but it also costs more in terms of processing power. It can be useful in difficult cases where there are magenta highlights due to channel clipping.
+
+

The default reconstruction works on separate RGB channels and has only one iteration applied, whereas the high quality reconstruction uses a different algorithm that works on RGB ratios (which is a way of breaking down chromaticity from luminance) and can use several iterations to graduately propagate colors from neighbouring pixels into clipped areas. However, if too many iterations are used, the reconstruction can denegenerate, which will result in far colors being improperly inpainted into clipped objects (color bleeding) – for example white clouds being inpainted with blue sky, or the sun disc shot through trees being inpainted with leaf-green.

+
+
add noise in highlights
+
This artificially introduces noise into the reconstructed highlights to prevent them from looking too smooth compared to surrounding areas that may already contain noise. This can help to blend the reconstructed areas more naturally with the surrounding non-clipped areas.
+
type of noise
+
This specifies the statistical distribution of the added noise. It can be helpful to match the look of the artificially generated noise with the naturally occurring noise in the surrounding areas from the camera’s sensor. The poissonian noise is the closest to natural sensor noise but is less visually pleasing than gaussian, which is probably closer to film grain. Also note that most denoising modules will turn the sensor noise from poissonian to slightly gaussian, so you should pick the variant that blends better into the actual noise in your image.
+
+

🔗background

+

The color science parameter (in the options tab) defines the strategy that is used to desaturate colors near pure white (maximum display emission) and pure black (minimum display emission). The problem can be explained with the graph below, which represents the gamut of the sRGB color space at the constant hue of its green primary, with varying lightness (vertical axis) and chroma (horizontal axis):

+

+ + + + + + + + +Gamut cone + +

+

As we approach pure black and pure white, the chroma available in gamut shrinks considerably until it reaches zero for lightness = 0 and lightness = 100% of the medium emission. This means that very bright (or very dark) colors cannot be very saturated at the same time if we want them to fit in gamut, with the gamut being imposed by the printing or displaying device we use.

+

If colors are left unmanaged and are allowed to escape gamut, they will be clipped to valid values at the time of conversion to display color space. The problem is that this clipping is generally not hue-preserving and definitely not luminance-preserving, so highlights will typically shift to yellow and appear darker than they should, when evaluated against their neighborhood.

+

To overcome this, filmic has used various strategies over the years (the so-called color sciences) to desaturate extreme luminances, forcing a zero saturation at minimum and maximum lightness and a smooth desaturation gradient. These strategies were all intended to minimize the hue shifts that come with gamut clipping.

+

Since all of these strategies were approximations (and often over-conservative ones) v6 (2022) introduces a more accurate and measured approach. It performs a test-conversion to display color space, checks if the resulting color fits within the [0; 100]% range, and if it doesn’t, computes the maximum saturation available in gamut at this luminance and hue, finally clipping the color to this value. This ensures a minimal color distortion, allowing for more saturated colors and better use of the available gamut, but also enforces a constant hue throughout the whole tone mapping and gamut mapping operation.

+

This gamut mapping uses the output color profile as a definition of the display color space and automatically adjusts to any output space. However, only matrix or matrix + curve(s) ICC profiles are supported. LUT ICC profiles are not supported and, if used, will make the gamut mapping default to the pipeline working space (Rec. 2020 by default).

+

Note that the hue used as a reference for the gamut mapping is the hue before any tone mapping, sampled at the input of filmic. This means that even the none chrominance preservation mode (applied on individual RGB channels regardless of their ratios) preserves hue in v6. This mode will only desaturate highlights more than the other modes, and a mechanism is in place to prevent it from resaturating shadows – this behaviour can be bypassed by increasing the extreme luminance saturation setting.

+

v7 (2023) improves over v6 (2022) by replacing the chroma preservation methods with a single slider. Chroma preservation methods aim at anchoring saturation and hue across the tone-mapping operation, by preserving RGB ratios compared to a norm. The choice of norm is important when it comes to managing how the gamut is used and how the contrast of bright objects (relative to their neighborhood) is rendered by the tone-mapper. Several norms have been proposed since filmic v1 (2018), none being objectively better and only one of which (max RGB) has some theoretical justification (allowing display peak primary colors to be reached after the transform).

+

The approach in v7 is to offer a mix between the max RGB norm and the no-preservation option (where the output hue and saturation are still forced to their input values). The proportions of the mix are driven by the highlights saturation mix setting as follows:

+
    +
  • -50% is strictly equivalent to the v6 no-preservation option,
  • +
  • +50% is strictly equivalent to the v6 max RGB option,
  • +
  • 0% is an average of no-preservation and max RGB,
  • +
  • intermediate values are weighted averages between no-preservation and max RGB,
  • +
  • values beyond ±50% (up to ±200%) are linear extrapolations.
  • +
+

Positive values favor saturated highlights and are generally suitable for skies, but need to be handled with care for portraits (producing accurate skin tones), whereas negative values favor bleaching of highlights.

+

The highlights saturation mix slider provides fine control over the amount of saturation vs. bleaching expected in the highlights. Regardless of this setting, the saturation algorithm will never permit the output saturation to be higher than the input saturation. This setting is not designed for creative purposes, but only to drive the complicated trade-off that comes from remapping RGB values from one color space to another, each having different gamuts and dynamic ranges.

+

🔗caveats

+

🔗color artifacts

+

As filmic versions 6 and 7 are so far the best approach for retaining saturated colors at constant hue, they are also much less forgiving to invalid colors like chromatic aberrations and clipped magenta highlights, which are much better hidden (albeit not solved) by simple curves applied on individual channels (no chrominance preservation) with no care given to their ratios.

+

It is not the purpose of a tone mapping and gamut mapping operators to reconstruct damaged signals, and these flaws need to be corrected earlier in the pipeline with the specialized modules provided. However, there is a mechanism in filmic v6 that ensures that any color brighter than the white relative exposure degrades to pure white, so a quick workaround is to simply set the white relative exposure to a value slightly lower than the exposure of the clipped parts. In other words: if it is clipped at the input, let it be clipped at the output. Chrominance preservation options that work the best for this purpose are the luminance and euclidean norms, or simply none.

+

🔗inconsistent output

+

With filmic v6, if you export the same image to sRGB and Adobe RGB color spaces, and then compare both images side by side on a large-gamut screen (that can cover Adobe RGB), the sRGB export should have more desaturated highlights than the Adobe RGB version. Since the sRGB color space is shorter than Adobe RGB, its gamut boundary is closer to the neutral grey axis, and therefore the maximum allowed chroma is lower for any given luminance. This is by no means a bug but rather is proof that the gamut mapping is actually doing its job.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/filmic-rgb/legend-icon.png b/en/module-reference/processing-modules/filmic-rgb/legend-icon.png new file mode 100644 index 0000000000..ae09640598 Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/legend-icon.png differ diff --git a/en/module-reference/processing-modules/filmic-rgb/sRGB-green.png b/en/module-reference/processing-modules/filmic-rgb/sRGB-green.png new file mode 100644 index 0000000000..e07e96e7cb Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/sRGB-green.png differ diff --git a/en/module-reference/processing-modules/filmic-rgb/view-icon.png b/en/module-reference/processing-modules/filmic-rgb/view-icon.png new file mode 100644 index 0000000000..eeaccf74c0 Binary files /dev/null and b/en/module-reference/processing-modules/filmic-rgb/view-icon.png differ diff --git a/en/module-reference/processing-modules/framing/index.html b/en/module-reference/processing-modules/framing/index.html new file mode 100644 index 0000000000..154e054102 --- /dev/null +++ b/en/module-reference/processing-modules/framing/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - framing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / framing + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ framing +

+ + + +

Generate a frame around the image.

+

The frame consists of a border (with a user-defined color) and a frame line within that border (with a second user-defined color). Various options are available to control the geometry and color of the frame.

+

🔗module controls

+
+
border size
+
The size of the frame as a percentage of the underlying full image.
+
aspect
+
The aspect ratio of the final module output (i.e. the underlying image plus the frame). Right-click on the slider to enter a custom aspect as a ratio (e.g. “6:5”).
+
orientation
+
The orientation of the frame (portrait/landscape). Select ‘auto’ for darktable to choose the most reasonable orientation based on the underlying image.
+
horizontal/vertical position
+
Select from a set of pre-defined ratios to control where the underlying image will be positioned on the horizontal/vertical axis. You can also right click and enter your own ratio as “x/y”.
+
frame line size
+
The percentage of the frame line size, relative to the border size at its smallest part.
+
frame line offset
+
The position of the frame line, relative to the underlying image. Choose 0% for a frame line that touches the image. Choose 100% for a frame line that touches the outer border.
+
border color / frame line color
+
A pair of color selectors which allow the border and frame line colors to be defined. Clicking on the colored field will open a color selector dialog which offers a choice of commonly-used colors, or allows you to define a color in RGB color space. You can also activate a picker to take a color probe from the image.
+
show guides
+
Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/global-tonemap/index.html b/en/module-reference/processing-modules/global-tonemap/index.html new file mode 100644 index 0000000000..254e4769de --- /dev/null +++ b/en/module-reference/processing-modules/global-tonemap/index.html @@ -0,0 +1,3035 @@ + + + + + +darktable user manual - (deprecated) global tonemap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) global tonemap + +
+ + + + +
+ +

+ (deprecated) global tonemap +

+ + + +
+

Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the filmic rgb module instead.

+
+

Compress the tonal range of an HDR image into the limited tonal range of a typical LDR output file.

+

Global tonemap processes each pixel of an HDR image, without taking the local surrounding into account. This is generally faster than local tone mapping (deprecated), but might lead to less convincing results with very high-dynamic-range scenes.

+

🔗module controls

+
+
operator
+
The operator to use. Reinhard, Filmic and Drago global tonemap operators are available. Depending on the selected operator, different parameters can be adjusted.
+
+

Some operators are fully self-adjusting, and do not require specific controls.

+
+
bias (Drago operator only)
+
This parameter influences the contrast of the output image. It is an essential parameter for adjusting the compression of high values and the visibility of details in dark areas. A value of 0.85 is recommended as a starting point.
+
target (Drago operator only)
+
A scale factor to adjust the global image brightness to the brightness of the intended display. It is measured in cd/m, and should match the brightness of your output device. Higher values lead to a brighter image, while lower values lead to a darker image.
+
detail (all operators)
+
This parameter controls how much detail is preserved from the original input image and transferred back into the output image after tonemapping.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/graduated-density/index.html b/en/module-reference/processing-modules/graduated-density/index.html new file mode 100644 index 0000000000..68f5aa7c91 --- /dev/null +++ b/en/module-reference/processing-modules/graduated-density/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - graduated density + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / graduated density + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ graduated density +

+ + + +

Simulate a graduated density filter in order to correct exposure and color in a progressive manner.

+

A line is shown on screen allowing the position and rotation of the gradient to be modified with the mouse.

+

This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate these issues.

+

🔗module controls

+
+
density
+
Set the density of the filter (EV). A low value underexposes slightly whereas a high value creates a strong filter.
+
hardness
+
The progressiveness of the gradient. A low value creates a smooth transition, whereas a high value makes the transition more abrupt.
+
rotation
+
The rotation of the filter. Negative values rotate clockwise. The rotation can also be set by dragging the end of the gradient line with the mouse.
+
hue
+
Choose a hue to add a color cast to the gradient.
+
saturation
+
The saturation of the color cast to add to the gradient (defaults to a neutral color cast of 0)
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/grain/index.html b/en/module-reference/processing-modules/grain/index.html new file mode 100644 index 0000000000..976c044516 --- /dev/null +++ b/en/module-reference/processing-modules/grain/index.html @@ -0,0 +1,3024 @@ + + + + + +darktable user manual - grain + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+ +
+ + + +
+
+ + +
+ +

+ grain +

+ + + +

Simulate the grain of analog film. The grain is processed on the L channel of Lab color space.

+

🔗module controls

+
+
coarseness
+
The grain size, scaled to simulate an ISO number.
+
strength
+
The strength of the effect.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/haze-removal/index.html b/en/module-reference/processing-modules/haze-removal/index.html new file mode 100644 index 0000000000..e2e680dd68 --- /dev/null +++ b/en/module-reference/processing-modules/haze-removal/index.html @@ -0,0 +1,3026 @@ + + + + + +darktable user manual - haze removal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / haze removal + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ haze removal +

+ + + +

Automatically reduce the effect of dust and haze in the atmosphere. This module may also be employed more generally to give pictures a color boost specifically in low-contrast regions of the image.

+

Haze absorbs light from objects in the scene but it is also a source of diffuse background light. The haze removal module first estimates, for each image region, the amount of haze in the scene. It then removes the diffuse background light according to its local strength and recovers the original object light.

+

Setting both of the module’s controls to unity maximizes the amount of haze removal but is also likely to produce some artifacts. Removing the atmospheric light entirely may render the image flat and result in an unnatural looking style. Optimal values are typically below unity and are rather image dependent, but also a matter of personal aesthetic preferences.

+

🔗module controls

+
+
strength
+
The amount of haze removal. At unity, the module removes 100 percent of the detected haze up to the specified distance. Negative values increase the amount of haze in the image.
+
distance
+
Limit the distance up to which haze is removed. For small values, haze removal is restricted to the foreground of the image. Haze is removed from the entire image if the distance parameter is set to unity. If the strength is negative the distance control has no effect.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/highlight-reconstruction/index.html b/en/module-reference/processing-modules/highlight-reconstruction/index.html new file mode 100644 index 0000000000..4c91eb698b --- /dev/null +++ b/en/module-reference/processing-modules/highlight-reconstruction/index.html @@ -0,0 +1,3090 @@ + + + + + +darktable user manual - highlight reconstruction + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / highlight reconstruction + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ highlight reconstruction +

+ + + +

Attempt to reconstruct color information for pixels that are clipped in one or more RGB channel.

+

🔗clipping

+

Clipping occurs when the amount of captured light exceeds either the capacity of a camera’s sensor to record that light (photosite saturation) or the capacity of the Raw file to store it (digital clipping). Once a pixel is clipped we can no longer know the precise brightness of that pixel – only that it is equal to or greater than the maximum value that pixel can store.

+

Ideally, the photosite saturation point would be the same as the value at which digital clipping occurs (to make maximum use of the camera’s dynamic range) but these values often differ between cameras. Darktable uses a camera’s “white point” to determine whether or not a given channel is clipped. If the white point is set incorrectly for a given camera, this can lead to valid pixels being clipped and can adversely impact the effectiveness of this module.

+

When a camera captures light (using a normal Bayer sensor) each pixel represents a single color (R,G,B), which is then interpolated by the demosaic module to calculate the color of neighboring pixels. The result will often be pixels (in the demosaiced image) that are clipped in some (R,G,B) channels but not others.

+

If these pixels are left partially clipped it can result in unrealistic colors appearing in the image. These incorrect colors can then be further skewed by the white balance module, which adjusts the ratios of the R, G, and B channels to account for the overall color of the scene. For example, where only the G channel is clipped (and R and B are close to clipping) the white balance module can cause the R and B channels to be adjusted above the clipping point of the G channel leading to pink highlights that would otherwise have been white.

+

The crude method to resolve this is to clip the R and B channels to the clipping point of the G channel (the “clip highlights” reconstruction method), but this can result in the loss of valid pixel data that may be useful in highlight reconstruction, and may also cause other artefacts and hue shifts.

+

🔗highlight reconstruction methods

+

A number of highlight reconstruction methods are provided within this module. These methods all use unclipped channels and/or adjacent pixels to reconstruct the missing data.

+
+
inpaint opposed (default)
+
Restore clipped pixels by using an average of adjacent unclipped pixels to estimate the correct color. This works well for the majority of images but may fail where the clipped areas are adjacent to areas of a different color.
+
segmentation based
+
A more sophisticated algorithm that uses adjacent unclipped pixels to estimate the correct color, by treating each clipped area separately (as an individual segment). The color of each clipped segment is estimated by analysing the color ratios of the adjacent pixels. Pixels that are too dark or appear to be an edge are rejected by the algorithm. If all surrounding pixels are rejected, that segment is reconstructed using the “inpaint opposed” method (above). Segments that are close together are often parts of the same object and so can be treated as if they were a single segment.
+
+

Segmentation based reconstruction is able to rebuild large areas where all channels are clipped by examining the surrounding gradients. However, you should think of this method more as a way to “disguise” clipped areas with something plausible, rather than a way to “magically” repair them.

+
+
guided laplacians
+
Use an algorithm (derived from the diffuse or sharpen module) to replicate details from valid channels into clipped channels and to propagate color gradients from valid surrounding regions into clipped regions. This is a computationally-intensive method designed for maximum smoothness and seamless blending of the reconstructed regions into their neighborhood, and is designed primarily to reconstruct spotlights and specular reflections. This mode is available for Bayer sensors only.
+
clip highlights
+
Clamp all pixels to the white level (i.e. clip the remaining color channels). This method is most useful in cases where clipped highlights occur in naturally desaturated objects (e.g. clouds).
+
reconstruct in LCh
+
Analyse each pixel with at least one clipped channel and attempt to correct the clipped pixel (in LCh color space) using the values of the other (3 for Bayer or 8 for X-Trans) pixels in the affected sensor block. The reconstructed highlights will still be monochrome, but brighter and with more detail than with “clip highlights”. This method works fairly well with a high-contrast base curve, which renders highlights desaturated. As with clip highlights this method is a good option for naturally desaturated objects.
+
reconstruct color
+
Use an algorithm that transfers color information from unclipped surroundings into the clipped highlights. This method works very well on areas with homogeneous colors and is especially useful on skin tones with smoothly fading highlights. Please note that this method can produce maze-like artifacts on highlights behind high-contrast edges, for example well-exposed fine structures in front of an overexposed background.
+
+
+

Note: When using the highlight reconstruction included with the filmic rgb module it may be better to avoid using this module in clip highlights mode (so that filmic rgb has more information to work with).

+
+

🔗module controls

+

🔗common controls

+
+
method
+
The method used to reconstruct highlights.
+
clipping threshold
+
Pixels above this value are considered to be clipped.
+
+

Click the icon beside the slider to visualise what areas of the image are considered to be clipped (the clipping mask). If the clipping mask does not match the RAW overexposed warning, you may need to correct this value.

+
+
+

🔗“guided laplacians” mode

+
+
noise level
+
Add Poisson noise (natural photon noise such as you would find in sensor readings) to the clipped regions. For high-ISO images, the valid regions of the image will be noisy, but the reconstructed clipped areas will be smooth, which may look odd. Adding some noise in the reconstruction helps to visually blend the result with the rest of the image.
+
iterations
+
The guided laplacians mode is an iterative process that extrapolates gradients and details from the neighborhood. Each new iteration refines the previous reconstruction but adds more computations that will make the module slower. The default number of iterations should provide reasonable results but you can increase if magenta highlights are not completely recovered – increase this parameter gradually but carefully, to manage the speed/quality trade-off.
+
inpaint a flat color
+
Inpainting a flat color is an algorithmic trick that may help recover magenta highlights in difficult cases (large blown areas) by smoothing RGB ratios. It can be seen as a “reconstruction booster” that may reduce the number of iterations required to entirely remove magenta in clipped highlights. However, this also makes the reconstruction less accurate and can lead to non-smooth reconstructed edges and unrelated colors being inpainted (e.g. blue sky or green leaves bleeding into white clouds). Use this setting with caution.
+
diameter of the reconstruction
+
The guided laplacians mode uses a multi-scale algorithm that tries to recover details from each scale independently. The diameter of the reconstruction is the largest scale used by the algorithm. Large scales will increase memory consumption as well as runtimes, and may also cause unrelated colors or details to be inpainted in clipped regions. You are advised to use a diameter roughly twice as large as the largest clipped area to be reconstructed. It is also possible that a given diameter may not suit all clipped areas, in which case you should use several instances at different scales and mask the clipped areas accordingly.
+
+

🔗“segmentation based” mode

+
+
clipping threshold
+
Since this controls the number of pixels that are considered to be clipped, it also changes the size of the resulting segments and the location of the adjacent pixels used for the reconstruction. For accurate adjustment, you can use the exposure module to ensure that no highlights are clipped in the histogram (or the image you see on screen). Then raise the clipping threshold until the highlights are no longer white and slowly lower it again until they look acceptable.
+
combine
+
The radius at which close segments are combined and considered to be part of the same segment. Increase (to combine more segments) when different parts of the same object have been incorrectly reconstructed to different colors. Decrease (to separate segments) when different objects have been incorrectly reconstructed to the same color. Click on the button beside the slider to see the outlines of the resulting segments.
+
candidating
+
Choose whether to prefer choosing candidate pixels (used to obtain color data) with segmentation analysis (high values) or inpaint opposed (low values). Click the button beside the slider to show the segments that are considered to have good candidates.
+
rebuild
+
Choose how to rebuild areas that have all channels clipped. The “small” and “large” modes are tuned for segment sizes less than 25 and greater than 100 pixels in diameter, respectively. The “flat” modes attempt to ignore narrow un-clipped features (powerlines, branches) to avoid gradients. Finally, the “generic” modes attempt to find the best settings for each segment.
+
+

🔗“guided laplacians” mode and filmic’s highlight reconstruction

+

It is important to note that the highlight reconstruction module is quite early in the pixel pipeline – before input color profile and the full chromatic adaptation in color calibration (if you use the modern chromatic adaptation workflow). A common trick to solve clipped highlights is to simply desaturate them to white but, because white is not defined before the full chromatic adaptation and the input color profiling, it is not possible to use this trick here. Technically, there is no color yet at this point in the pipeline, only an arbitrary 3D signal.

+

The guided laplacians approach has been designed specifically to be immune to white-balance discrepancies and to avoid any concept or method related to color (so there is no explicit desaturation). It only handles gradients (transitions) in the signal and aims at connecting them smoothly, in order to fill the missing parts. This process is quite heavy though, since it falls into the category of supervised machine learning (gradient-based optimization through multi-scale curvature), which is a sub-branch of artificial intelligence.

+

Filmic’s highlight reconstruction uses a simpler color propagation algorithm coupled with a desaturation option that can favor an achromatic reconstruction. Not only does it know about color (because it comes after the full color profiling and chromatic adaptation) but it also uses a simplified and faster version of the algorithm used by the guided laplacians approach. Namely, this variant will not try as hard to restore details and will favor a smooth blur instead.

+

The filmic reconstruction is good enough for very large clipped patches and offers the benefit of being able to degrade to white as a last resort. It is also better and faster to inpaint solid color into clipped areas, at the expense of details. Its main drawback is that it is not as selective in the source of the colors being inpainted in clipped parts, so it may inpaint unrelated colors.

+

All in all, you are advised to use the guided laplacians highlight reconstruction mode to:

+
    +
  1. smooth the boundaries of clipped areas,
  2. +
  3. recover spotlights and clipped areas of diameter below approximately 256px (on the full-resolution RAW),
  4. +
  5. remove chromatic aberrations, which can occur during demosaicing (the next module in the pipeline) at the boundary between clipped and valid regions.
  6. +
+

If you find yourself having to increase the diameter of reconstruction past 512px to get a full recovery from magenta, the best approach is usually to cap the diameter to 512px, do the most you can with this setting, and then enable filmic’s highlight reconstruction to finish the work. This will give more bearable run-times with a very similar result.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/highpass/index.html b/en/module-reference/processing-modules/highpass/index.html new file mode 100644 index 0000000000..b74a8aa788 --- /dev/null +++ b/en/module-reference/processing-modules/highpass/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - highpass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / highpass + +
+ + + + +
+ +

+ highpass +

+ + + +

A high pass filter.

+

This module is primarily intended to be used in combination with a blend mode. For example, try using the module with a blend mode of “soft light” for high pass sharpening.

+
+

Note: This module performs blurs in Lab color space, which can result in undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for fine sharpness or the local contrast module for general sharpness.

+
+

🔗Module Controls

+
+
sharpness
+
The sharpness of the filter
+
contrast boost
+
The contrast boost
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/hot-pixels/index.html b/en/module-reference/processing-modules/hot-pixels/index.html new file mode 100644 index 0000000000..d304500df6 --- /dev/null +++ b/en/module-reference/processing-modules/hot-pixels/index.html @@ -0,0 +1,3029 @@ + + + + + +darktable user manual - hot pixels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / hot pixels + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ hot pixels +

+ + + +

Automatically detect and eliminate hot pixels.

+

Hot pixels are pixels which have failed to record a light level correctly. Detected hot pixels are replaced by an average of their neighbors.

+

🔗module controls

+
+
threshold
+
How strong a pixel’s value needs to deviate from that of its neighbors to be regarded as a hot pixel.
+
strength
+
The blending strength of the hot pixels with their surrounding.
+
detect by 3 neighbours
+
Extend the detection of hot pixels – regard a pixel as hot if a minimum of only three (instead of four) neighbor pixels deviate by more than the threshold level.
+
mark fixed pixels
+
Visually mark the corrected pixels on the image and display a count of hot pixels that have been fixed.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/index.html b/en/module-reference/processing-modules/index.html new file mode 100644 index 0000000000..31339634ee --- /dev/null +++ b/en/module-reference/processing-modules/index.html @@ -0,0 +1,3576 @@ + + + + + +darktable user manual - processing modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Module Reference / processing modules + +
+ +
+
+ + + +
+ +
+ + +
+ +

processing modules

+ +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/index.xml b/en/module-reference/processing-modules/index.xml new file mode 100644 index 0000000000..b66e29a115 --- /dev/null +++ b/en/module-reference/processing-modules/index.xml @@ -0,0 +1,578 @@ + + + + processing modules on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/ + Recent content in processing modules on darktable user manual + Hugo + en + + + astrophoto denoise + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/astrophoto-denoise/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/astrophoto-denoise/ + Remove image noise while preserving structure. This is accomplished by averaging each pixel with some surrounding pixels in the image. The weight of such a pixel in the averaging process depends on the similarity of its neighborhood with the neighborhood of the pixel being denoised. A patch with a defined size is used to measure that similarity. As denoising is a resource-intensive process, it slows down pixelpipe processing significantly. Consider activating this module late in your workflow. + + + base curve + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/base-curve/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/base-curve/ + Simulate the in-camera JPEG by applying a characteristic base curve to the image. darktable comes with a number of base curve presets that attempt to mimic the curves of various camera manufacturers. These presets are automatically applied according to the manufacturer ID found in the image&rsquo;s Exif data. Camera-specific base curve presets are also available for some camera models. This module will be enabled by default if preferences &gt; processing &gt; auto-apply pixel workflow defaults is set to &ldquo;display-referred&rdquo;. + + + bloom + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/bloom/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/bloom/ + Create a soft bloom effect. This module works by blurring the highlights and then blending the result with the original image. Note: This module performs blurs in Lab color space, and is no longer recommended. Instead, use the tone equalizer module or the exposure module with a parametric mask. 🔗module controls size The spatial extent of the bloom effect. threshold The threshold for the brightness increase. strength The strength of the overlighting. + + + blurs + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/blurs/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/blurs/ + Simulate physically-accurate blurs in scene-referred RGB space. 🔗blur types Three types of blur are provided: lens blur: Simulates a lens diaphragm with a configurable number of blades and blade curvature to create synthetic bokeh. motion blur: Simulates the effect of camera motion with a configurable path. gaussian blur: This is not really an optical blur but can be used for denoising or for creative effects using blend modes A diagram at the top of the module shows the shape of the blurring operator (known as the point spread function). + + + censorize + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/censorize/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/censorize/ + Degrade parts of the image in an aesthetically pleasing way, in order to anonymize people/objects or hide body parts. Censorize works in linear RGB color space to apply a physically-accurate gaussian blur and gaussian luminance noise. Aside from anonymization, this module can also be used for a wide range of creative purposes, for example: Combine a simple blur with a multiply blend mode to create a realistic bloom (Orton effect). Combine a simple blur with a subtract blending mode and low opacity to create an unsharp mask, similar to the sharpen module but in an RGB scene-referred space. + + + chromatic aberrations + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/chromatic-aberrations/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/chromatic-aberrations/ + Correct chromatic aberrations. In contrast to the raw chromatic aberrations module, this module does not require raw data as input. 🔗workflow To obtain the best result, you are advised to proceed as follows: Attenuate the chromatic aberrations as much as possible in the lens correction module using the TCA sliders. Increase the strength slider in this module to better see its effect. Increase the radius until the chromatic aberrations disappear. If this is insufficient, try enabling the &ldquo;very large chromatic aberrations&rdquo; setting. + + + color balance + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance/ + A versatile tool for adjusting the image&rsquo;s color balance. This module can be used to revert parasitic color casts or to enhance the visual atmosphere of an image using color grading, a popular technique in the cinema industry. For scene-referred workflow, you should consider using the improved color balance rgb module instead. 🔗overview The color balance module allows you to shift colors selectively by luminance range (shadows, mid-tones, and highlights). It can do this using two different methods: + + + color balance rgb + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance-rgb/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance-rgb/ + An advanced module which brings color-grading tools from cinematography into the photographic scene-referred pipeline. This module is not suitable for beginners with no prior knowledge of color theory, who might want to stick to the global chroma and global vibrance settings until they have a good understanding of the dimensions of color. 🔗introduction Color-grading is an important part of image editing. It can help to remove unwanted color casts and can also deliver a creative color twist that will add atmosphere to your images. + + + color calibration + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-calibration/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-calibration/ + A fully-featured color-space correction, white balance adjustment and channel mixer module. This simple yet powerful module can be used in the following ways: To adjust the white balance (chromatic adaptation), working in tandem with the white balance module. Here, the white balance module makes some initial adjustments (required for the demosaic module to work effectively), and the color calibration module then calculates a more perceptually-accurate white balance after the input color profile has been applied. + + + color contrast + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-contrast/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-contrast/ + A simplified control for changing the contrast or separation of colors between the green/magenta and blue/yellow axes in Lab color space. Higher values increase color contrast, lower values decrease it. 🔗module controls green-magenta contrast Change the green-magenta color contrast. This is equivalent to raising or lowering the steepness of the a* curve in Lab. Lower values desaturate greens and magenta, while higher values increase their saturation. blue-yellow contrast Change the blue-yellow color contrast. + + + color correction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-correction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-correction/ + Modify the global image saturation to give the image a tint or as an alternative method to split-tone the image. Note: Use the color balance rgb module for color modifications. 🔗module controls color board For split toning move the white dot to the desired highlight tint and then select a tint for shadows with the dark spot. For a simple global tint set both spots to the same color. saturation Correct the global saturation. + + + color equalizer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-equalizer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-equalizer/ + Selectively adjust the hue, saturation, and/or brightness of pixels based on their current hue. This module is an attempt to recreate some of the functionality of the color zones module in the scene-referred part of the pipeline whilst overcoming some of that module&rsquo;s limitations. Specifically, the color zones module is prone to increase chroma/luma noise, and introduce artefacts or harsh transitions. These are somewhat mitigated within color equalizer with the following additions: + + + color look up table + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-look-up-table/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-look-up-table/ + A generic color look up table implemented in Lab space. The input to this module is a list of source and target points and the complete mapping is interpolated using splines. The resulting look up tables (LUTs) are editable by hand and can be created using the darktable-chart utility to match given input (such as hald-cluts and RAW/JPEG with in-camera processing pairs). See using darktable-chart for details. 🔗module controls color board The color board grid shows a list of colored patches. + + + color mapping + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-mapping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-mapping/ + Transfer the look and feel of one image to another. This module statistically analyses the color characteristics of a source and target image. The colors of the source image are then mapped to corresponding colors on the target image. Two steps are required to use this module: Open the source image in the darkroom view and acquire its color characteristics by pressing the “acquire as source” button. A set of color clusters is generated and displayed in the “source clusters” area. + + + color reconstruction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-reconstruction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-reconstruction/ + Recover color information in blown-out highlights. Due to the nature of digital sensors, overexposed highlights lack valid color information. Most frequently they appear neutral white or exhibit some color cast, depending on what other image processing steps are involved. This module can be used to “heal” overexposed highlights by replacing their colors with better fitting ones. The module acts on pixels whose luminance exceeds a user-defined threshold. Replacement colors are taken from neighboring pixels. + + + color zones + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-zones/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-zones/ + Selectively adjust the lightness, chroma and hue of pixels based on their current lightness, chroma and hue. This module works in CIE LCh color space, which separates pixels into lightness, chroma and hue components. It allows you to manipulate the lightness, chroma and hue of targeted groups of pixels through the use of curves. You first need to choose whether you wish to adjust (select) pixels based on their lightness, chroma or hue. + + + colorize + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/colorize/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/colorize/ + Add a solid layer of color to the image. 🔗module controls hue The hue of the color layer. saturation The saturation of shadow tones. lightness The lightness of the color layer. source mix Controls how the lightness of the input image is mixed with the color layer. Setting this to zero will result in a uniformly colored plane. + + + composite + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/composite/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/composite/ + Create a composite image by overlaying an already-processed image on top of the current image. Drag and drop a processed image from the filmstrip onto the &ldquo;drop image from filmstrip here&rdquo; box to overlay the chosen image, and then alter the various placement and adjustment attributes of the image being overlaid. The full history stack of the overlayed image is used by the module, so if you want to drastically change the overlaid image beyond the controls of this module, you should first edit that image separately. + + + contrast equalizer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-equalizer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-equalizer/ + Adjust luminance and chroma contrast in the wavelet domain. This versatile module can be used to achieve a variety of effects, including bloom, denoise, clarity, and local contrast enhancement. It works in the wavelet domain and its parameters can be tuned independently for each wavelet detail scale. The module operates in CIE LCh color space and so is able to treat luminosity and chromaticity independently. A number of presets are provided, which should help you to understand the capabilities of the module. + + + crop + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop/ + Crop an image using on-screen guides. This module appears later in the pipeline than the deprecated crop and rotate module, meaning that the full image can remain available for source spots in the retouch module. For best results, you are advised to use the rotate and perspective module to perform rotation and perspective correction (if required), and then perform final creative cropping with this module. Whenever this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines. + + + demosaic + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/demosaic/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/demosaic/ + Control how raw files are demosaiced. 🔗bayer filters The sensor cells of a digital camera are not color-sensitive &ndash; they are only able to record different levels of lightness. In order to obtain a color image, each cell is covered by a color filter (red, green or blue) that primarily passes light of that color. This means that each pixel of the raw image only contains information about a single color channel. + + + denoise (profiled) + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/denoise-profiled/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/denoise-profiled/ + An easy to use and highly efficient denoise module, adapted to the individual noise profiles of a wide range of camera sensors. One issue with a lot of denoising algorithms is that they assume that the variance of the noise is independent of the luminosity of the signal. By profiling the noise characteristics of a camera&rsquo;s sensor at different ISO settings, the variance at different luminosities can be assessed, and the denoising algorithm can be adjusted to more evenly smooth out the noise. + + + diffuse or sharpen + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/diffuse/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/diffuse/ + Diffusion is a family of physical processes by which particles move and spread gradually with time, from a source that generates them. In image processing, diffusion mostly occurs in two places: diffusion of photons through lens glass (blur) or humid air (hazing), diffusion of pigments in wet inks or watercolors. In both cases, diffusion makes the image less sharp by &ldquo;leaking&rdquo; particles and smoothing local variations. The diffuse or sharpen module uses a generalized physical model to describe several kinds of diffusion, and can be used by image makers to either simulate or revert diffusion processes. + + + dither or posterize + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/dither-or-posterize/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/dither-or-posterize/ + This module eliminates some of the banding artifacts that can result when darktable&rsquo;s internal 32-bit floating point data is transferred into discrete 8-bit or 16-bit integer output format for display or export. It can also be used for creative posterization effects. Although not an inherent problem in any of darktable&rsquo;s modules, some operations may provoke banding if they produce a lightness gradient in the image. To mitigate possible artifacts you should consider activating dithering when using the vignetting or graduated density modules. + + + enlarge canvas + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/enlarge-canvas/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/enlarge-canvas/ + Increase the size of the image canvas and fill the additional area with the selected color. 🔗module controls percent left The amount of enlargement to the left of the image. percent right The amount of enlargement to the right of the image. percent top The amount of enlargement to the top of the image. percent bottom The amount of enlargement to the bottom of the image. color The color with which to fill the additional area. + + + exposure + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/exposure/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/exposure/ + Increase or decrease the overall brightness of an image. This module has two modes of operation: manual Set the exposure and black level manually automatic (RAW images only) Use an analysis of the image&rsquo;s histogram to automatically set the exposure. Darktable automatically selects the exposure compensation that is required to shift the selected percentile to the selected target level (see definitions below). This mode is particularly useful for automatically altering a large number of images to have the same exposure. + + + filmic rgb + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/filmic-rgb/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/filmic-rgb/ + Remap the tonal range of an image by reproducing the tone and color response of classic film. This module can be used either to expand or to contract the dynamic range of the scene to fit the dynamic range of the display. It protects colors and contrast in the mid-tones, recovers the shadows, and compresses bright highlights and dark shadows. Highlights will need extra care when details need to be preserved (e. + + + framing + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/framing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/framing/ + Generate a frame around the image. The frame consists of a border (with a user-defined color) and a frame line within that border (with a second user-defined color). Various options are available to control the geometry and color of the frame. 🔗module controls border size The size of the frame as a percentage of the underlying full image. aspect The aspect ratio of the final module output (i.e. the underlying image plus the frame). + + + graduated density + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/graduated-density/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/graduated-density/ + Simulate a graduated density filter in order to correct exposure and color in a progressive manner. A line is shown on screen allowing the position and rotation of the gradient to be modified with the mouse. This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate these issues. 🔗module controls density Set the density of the filter (EV). A low value underexposes slightly whereas a high value creates a strong filter. + + + grain + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/grain/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/grain/ + Simulate the grain of analog film. The grain is processed on the L channel of Lab color space. 🔗module controls coarseness The grain size, scaled to simulate an ISO number. strength The strength of the effect. + + + haze removal + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/haze-removal/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/haze-removal/ + Automatically reduce the effect of dust and haze in the atmosphere. This module may also be employed more generally to give pictures a color boost specifically in low-contrast regions of the image. Haze absorbs light from objects in the scene but it is also a source of diffuse background light. The haze removal module first estimates, for each image region, the amount of haze in the scene. It then removes the diffuse background light according to its local strength and recovers the original object light. + + + highlight reconstruction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highlight-reconstruction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highlight-reconstruction/ + Attempt to reconstruct color information for pixels that are clipped in one or more RGB channel. 🔗clipping Clipping occurs when the amount of captured light exceeds either the capacity of a camera&rsquo;s sensor to record that light (photosite saturation) or the capacity of the Raw file to store it (digital clipping). Once a pixel is clipped we can no longer know the precise brightness of that pixel &ndash; only that it is equal to or greater than the maximum value that pixel can store. + + + highpass + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highpass/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highpass/ + A high pass filter. This module is primarily intended to be used in combination with a blend mode. For example, try using the module with a blend mode of &ldquo;soft light&rdquo; for high pass sharpening. Note: This module performs blurs in Lab color space, which can result in undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for fine sharpness or the local contrast module for general sharpness. + + + hot pixels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/hot-pixels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/hot-pixels/ + Automatically detect and eliminate hot pixels. Hot pixels are pixels which have failed to record a light level correctly. Detected hot pixels are replaced by an average of their neighbors. 🔗module controls threshold How strong a pixel&rsquo;s value needs to deviate from that of its neighbors to be regarded as a hot pixel. strength The blending strength of the hot pixels with their surrounding. detect by 3 neighbours Extend the detection of hot pixels &ndash; regard a pixel as hot if a minimum of only three (instead of four) neighbor pixels deviate by more than the threshold level. + + + input color profile + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/input-color-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/input-color-profile/ + Define how darktable will interpret the colors of the image. This module takes the color space used by the image source (e.g. camera, scanner) and converts the pixel encodings to a standardized working color space. This means that subsequent modules in the pipeline don&rsquo;t need to be concerned with the specifics of the input device, and can work with and convert to/from a common working color space. Where an image has been captured in a raw file, the input color profile module will normally apply either a standard or enhanced color matrix specific for that camera model, which will be used to map the colors into the working profile color space. + + + lens correction + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lens-correction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lens-correction/ + Automatically correct for (or simulate) lens distortion, transverse chromatic aberrations (TCA) and vignetting. You can choose to either use lens correction data embedded in your Raw file (where present/supported) or correction data provided by the external Lensfun library. Additional controls are also provided for manual vignetting correction, in case the profiles for your lens are insufficient or missing. Note that if TCA correction is enabled in this module, also using raw chromatic aberrations may cause artifacts from over-correction. + + + liquify + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/liquify/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/liquify/ + Move pixels around by applying freestyle distortions to parts of the image using points, lines and curves. As you might want to use source data from any part of the image you will be shown the uncropped image (possibly with the cropping rectangle overlaid as a guide) while the module is active. 🔗nodes Each of liquify&rsquo;s tools is based on nodes. A point consists of a single node and a line or curve consists of a sequence of linked nodes defining a path. + + + local contrast + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/local-contrast/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/local-contrast/ + Enhance the image&rsquo;s local contrast. This is achieved using either a local laplacian (default) or unnormalized bilateral filter. Both modes work exclusively on the L channel from Lab. The local laplacian filter has been designed to be robust against unwanted halo effects and gradient reversals along edges. 🔗module controls mode Choice of local laplacian filter or bilateral grid. The following sections define the controls available for each of these modes. 🔗bilateral grid coarseness Adjust the coarseness of the details to be adjusted. + + + lowlight vision + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowlight-vision/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowlight-vision/ + Simulate human lowlight vision. This module can also be used to perform a day-to-night conversion. The idea is to calculate a scotopic vision image, which is perceived by the rods rather than the cones in the eyes under low light. Scotopic lightness is then mixed with photopic value (regular color image pixel) using some blending function. This module can also simulate the Purkinje effect by adding some blueness to the dark parts of the image. + + + lowpass + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowpass/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowpass/ + Apply a low pass filter (for example, a Gaussian blur) to the image, while controlling the output contrast and saturation. This module is primarily intended to be used in combination with a blend mode. For example, try using the local contrast mask preset with the overlay blend mode. Note: This module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for blurring or the tone equalizer module for dynamic range compression. + + + LUT 3D + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lut-3d/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lut-3d/ + Transform RGB values with a 3D LUT file. A 3D LUT is a tridimensional table that is used to transform a given RGB value into another RGB value. It is normally used for film simulation and color grading. This module accepts .cube, .3dl, .png (haldclut) and .gmz files. Uncompressed 3D LUT data is not saved in the database or the XMP file, but is instead saved to the 3D LUT file path inside the 3D LUT root folder. + + + monochrome + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/monochrome/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/monochrome/ + Quickly convert an image to black &amp; white using a variable color filter. To use this module, first reduce the filter size (to concentrate its effect) and move it across the hue palette to find the best filter value for your desired image rendition. Then gradually expand the filter to include more hues and achieve more natural tonality. Although this module is easy to use, better results can usually be obtained by using the film emulation presets in the color calibration module. + + + negadoctor + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/negadoctor/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/negadoctor/ + Process scanned film negatives. You can obtain an image of a negative using a film scanner, or by photographing it against a white light (e.g. a light table or computer monitor) or off-camera flash. 🔗preparation If the image of the negative was obtained using a digital camera, then in order to obtain accurate colors in the final image, you will need to take the following points into consideration: When taking the photograph, adjust the exposure to fully utilise the entire dynamic range of your camera sensor &ndash; i. + + + orientation + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + Rotate the image 90 degrees at a time or flip the image horizontally and/or vertically. The module is enabled by default and the orientation (rotation) is automatically set based on the image&rsquo;s Exif data. The orientation can also be set using the actions on selection module in the lighttable view. 🔗module controls transform Double click the label to reset to the default transformations rotate counter-clockwise Rotate the image 90 degrees counter-clockwise rotate clockwise Rotate the image 90 degrees clockwise flip horizontally Flip the image (mirror) horizontally flip vertically Flip the image (mirror) vertically show guides Tick the box to show guide overlays whenever the module is activated. + + + output color profile + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/output-color-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/output-color-profile/ + Manage the output profile for export and the rendering intent to be used when mapping between color spaces. darktable comes with pre-defined profiles sRGB, Adobe RGB, XYZ and linear RGB. You can provide additional profiles by placing them in $DARKTABLE/share/darktable/color/out and $HOME/.config/darktable/color/out (where $DARKTABLE is the darktable installation directory and $HOME is your home directory). Note that these color/out directories are not created by the darktable install; if you need to use one, you must create it yourself. + + + raw black/white point + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-black-white-point/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-black-white-point/ + Define camera-specific black and white points. This module is activated automatically for all raw images. Default settings are applied for all supported cameras. Changes to the defaults are not normally required. 🔗module controls black level 0-3 The camera-specific black level of the four pixels in the RGGB Bayer pattern. Pixels with values lower than this level are not considered to contain valid data. white point The camera-specific white level. All pixels with values above this are likely to be clipped and will be handled accordingly in the highlight reconstruction module. + + + raw chromatic aberrations + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-chromatic-aberrations/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-chromatic-aberrations/ + Correct chromatic aberrations of raw images. This module currently only works for raw images recorded with a Bayer sensor (the sensor used in the majority of cameras) &ndash; for other types of image, you should use the chromatic aberrations module instead. The module will also not apply any corrections to any photos that have been identified as monochrome (see developing monochrome images for more information). This module expects good white balance data (provided by the white balance module) for best results. + + + raw denoise + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-denoise/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-denoise/ + Perform denoising on raw image data before it is demosaiced. This module has been ported from dcraw. 🔗module controls noise threshold The threshold for noise detection. Higher values lead to stronger noise removal and greater loss of image detail. coarse/fine curves The noise of an image is usually a combination of fine-grained and coarse-grained noise. These curves allow the image to be denoised more or less depending on the coarseness of the visible noise. + + + retouch + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/retouch/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/retouch/ + Remove unwanted elements from your image by cloning, healing, blurring and filling using drawn shapes. This module extends the capabilities of the deprecated spot removal module (equivalent to this module&rsquo;s &ldquo;clone&rdquo; tool) by including a &ldquo;heal&rdquo; tool (based on the heal tool from GIMP), as well as &ldquo;fill&rdquo; and &ldquo;blur&rdquo; modes. It can also take advantage of wavelet decomposition, allowing the image to be separated into layers of varying detail (from coarse to fine) which can be selectively retouched before being recombined to produce the output image. + + + rgb curve + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-curve/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-curve/ + A classic digital photography tool to alter an image&rsquo;s tones using curves. This module is very similar to the tone curve module but works in RGB color space. Activate the picker on the left to show the picked values in the graph (Ctrl+click or right-click to use the picker in area mode). Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the widget. + + + rgb levels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-levels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-levels/ + Adjust black, white and mid-gray points in RGB color space. This module is silmilar to the levels module, which works in Lab color space. The rgb levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in lightness (in &ldquo;RGB, linked channels&rdquo; mode) or independently for each of the R, G and B channels (in &ldquo;RGB, independent channels&rdquo; mode). + + + rgb primaries + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-primaries/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-primaries/ + Adjust the hue and purity of the RGB primary colors (i.e. which red, green and blue they represent), while leaving uncolored (gray) pixels unchanged. In addition to preserving gray pixels, the opponency relationships between the colors are also preserved under this adjustment: If you increase the purity of the blue primary, the opponent yellow&rsquo;s intensity increases to balance things out; If you twist the blue hue toward cyan, the opponent yellow is twisted toward orange. + + + rotate and perspective + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-perspective/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-perspective/ + Automatically correct for converging lines, a form of perspective distortion. The underlying mechanism is inspired by Markus Hebel&rsquo;s ShiftN program. This module also allows for the rotation of the image to be adjusted. Perspective distortions are a natural effect when projecting a three dimensional scene onto a two dimensional plane and cause objects close to the viewer to appear larger than objects further away. Converging lines are a special case of perspective distortions frequently seen in architectural photographs &ndash; parallel lines, when photographed at an angle, are transformed into converging lines that meet at some vantage point within or outside of the image frame. + + + rotate pixels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-pixels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-pixels/ + The sensors of some cameras (such as the Fujifilm FinePix S2Pro, F700, and E550) have a diagonally oriented Bayer pattern instead of the usual orthogonal layout. Without correction this would lead to a tilted image with black corners. This module applies the required rotation. darktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled. The module has no controls. + + + scale pixels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/scale-pixels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/scale-pixels/ + Some cameras (such as the Nikon D1X) have rectangular instead of the usual square sensor cells. Without correction this would lead to distorted images. This module applies the required scaling. darktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled. The module has no controls. + + + shadows and highlights + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/shadows-and-highlights/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/shadows-and-highlights/ + Modify the tonal range of the shadows and highlights of an image by enhancing local contrast. Note: This module performs blurs in Lab color space, which can result in a number of issues when the parameters are pushed hard, including halos, high local contrast in highlights, and hue shifts towards blue in the shadows. You are advised to use the tone equalizer module instead. 🔗module controls shadows Control the effect on shadows. + + + sharpen + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sharpen/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sharpen/ + Sharpen the details in the image using a standard UnSharp Mask (USM). This module works by increasing the contrast around edges and thereby enhancing the impression of sharpness of an image. This module is applied to the L channel in Lab color space. Note: The USM algorithm used in this module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead use the presets offered by the contrast equalizer module for deblurring or the local contrast module for general sharpness. + + + sigmoid + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sigmoid/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sigmoid/ + Remap the tonal range of an image using a modified generalized log-logistic curve. This module can be used to expand or contract the dynamic range of the scene to fit the dynamic range of the display. Note: Modules placed before sigmoid in the pipeline operate in scene-referred space. Modules after sigmoid work in display-referred space. 🔗usage Please take note of the following guidelines while using this module within your workflow: + + + soften + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/soften/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/soften/ + Create a softened image using the Orton effect. Michael Orton achieved his results on slide film by using two exposures of the same scene, one well exposed and one overexposed. He then used a darkroom technique to blend these two images into a final image where the overexposed image was blurred. This module is a near-copy of Orton&rsquo;s analog process into the digital domain. 🔗module controls size The size of blur of the overexposed image. + + + split-toning + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/split-toning/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/split-toning/ + Create a two color linear toning effect where the shadows and highlights are represented by two different colors. The split-toning module does not convert images to black and white and has limited benefits on color images. In order to perform traditional split-toning, the input to this module should therefore be monochrome. 🔗module controls shadows and highlights color Set the desired hue and saturation for both shadows and highlights. Clicking on the colored squares will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define a color in RGB color space. + + + surface blur + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/surface-blur/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/surface-blur/ + Smooth image surfaces while preserving sharp edges using a bilateral filter. This module can be used to denoise images, however you should be aware that bilateral filters are susceptible to overshoots and darktable offers much better alternatives. For example, the astrophoto denoise module uses a non-local means denoising algorithm, and the denoise (profiled) module provides a choice between non-local means and wavelet denoising algorithms. The surface blur module blurs noise within the surfaces of an image by averaging pixels with their neighbors, taking into account not only their geometric distance but also their distance on the range scale (i. + + + tone curve + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-curve/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-curve/ + A classic digital photography tool to alter the tones of an image&rsquo;s using curves. This module is very similar to the rgb curve module but works in Lab color space. Activate the picker to show the picked values on the displayed histogram. Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the graph. 🔗module controls Please refer to the curves section for more details about how to modify curves including the interpolation method, scale for graph and preserve colors controls. + + + tone equalizer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-equalizer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-equalizer/ + Dodge and burn while preserving local contrast. When used together with filmic rgb, this module replaces the need for other tone-mapping modules such as the base curve, shadows and highlights, tone curve and zone system (deprecated) modules. It works in linear RGB space and utilizes a user-defined mask to guide the dodging and burning adjustments, helping to preserve local contrast within the image. The following diagram describes how the tone equalizer works: + + + unbreak input profile + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/unbreak-input-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/unbreak-input-profile/ + Add a correction curve to image data. This is required if you have selected certain input profiles in the input color profile module. If you decide to use an ICC profile from the camera manufacturer in the input color profile module, a correction curve frequently needs to be pre-applied to image data to prevent the final output from looking too dark. This extra processing is not required if you use darktable&rsquo;s standard or enhanced color matrices. + + + velvia + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/velvia/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/velvia/ + Resaturate pixels in a weighted manner that gives more weight to blacks, whites and less saturated pixels. Note: This module causes hue and brightness shifts that can be difficult to manage. Instead, use the color balance rgb module for color modifications. 🔗module controls strength The strength of the effect mid-tones bias Reduce the effect on mid-tones in order to avoid unnatural skin tones. Reducing the mid-tone bias decreases mid-tone protection and makes the overall velvia effect stronger. + + + vignetting + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vignetting/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vignetting/ + Apply a vignetting effect to the image. Vignetting is a modification of the brightness and saturation at the borders of the image in a specified shape. Many of the parameters listed below can also be modified with a graphical control that overlays the image when the module has focus, showing the shape and extent of the effect. Note: This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate this. + + + watermark + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/watermark/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/watermark/ + Render a vector-based overlay onto your image. Watermarks are standard SVG documents and can be designed using Inkscape. You can also use bitmap (PNG) images. The SVG processor in darktable can also substitute strings within an SVG document, allowing image-dependent information to be included in the watermark. User-designed watermarks should be placed into the directory $HOME/.config/darktable/watermarks. Once in place, use the reload button update the list of available watermarks. The following is a list of variable strings that are supported for substitution within an SVG document. + + + white balance + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/white-balance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/white-balance/ + Adjust the white balance of the image by altering the temperature and tint, defining a coefficient for each RGB channel, or choosing from list of predefined white balance settings. The default settings for this module are derived from the camera white balance stored in the image&rsquo;s Exif data. White balance is not intended as a &ldquo;creative&rdquo; module &ndash; its primary goal is to technically correct the white balance of the image ensuring that neutral colored objects in the scene are rendered with neutral colors in the image. + + + (deprecated) basic adjustments + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/basic-adjustments/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/basic-adjustments/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the quick access panel instead. A convenience module that combines controls from exposure, highlight reconstruction, color balance and vibrance into a single module. While this module can provide a quick and convenient way to make simple adjustments to an image, it must be used with care. Normally exposure adjustments should come before input color profile in the pixelpipe, and color adjustments should come after. + + + (deprecated) channel mixer + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/channel-mixer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/channel-mixer/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the color calibration module instead. A simple yet powerful tool to manage color channels. This module accepts red, green and blue channels as an input and provides red, green, blue, gray, hue, saturation and lightness channels as output. It allows you to independently control how much each input channel contributes to each output channel. + + + (deprecated) contrast brightness saturation + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-brightness-saturation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-brightness-saturation/ + Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the color balance rgb module instead. A very basic tool for adjusting the contrast, brightness and saturation of an image. Please note that a number of other modules provide much more versatile methods of adjusting these parameters. All module controls default to a neutral position (zero) and provide the ability to increase or decrease the relevant parameter + + + (deprecated) crop and rotate + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop-rotate/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop-rotate/ + Please note that this module is deprecated from darktable 3.8 and should no longer be used for new edits. Please use the crop module to crop the image, the rotate and perspective module to perform rotation and keystone correction, and the orientation module to flip the image on the horizontal/vertical axes. Crop, rotate, and correct perspective distortions using on-screen guides. Whenever the user interface of this module is in focus, the full uncropped image will be shown, overlaid with crop handles and optional guiding lines. + + + (deprecated) defringe + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/defringe/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/defringe/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the chromatic aberrations module instead. Remove color fringing, which often results from Longitudinal Chromatic Aberrations (LCA), also known as Axial Chromatic Aberrations. This module uses edge-detection. Where pixels are detected as a fringe, the color is rebuilt from less saturated neighboring pixels. 🔗module controls operation mode global average: This mode is usually the fastest but might show slightly incorrect previews at high magnification. + + + (deprecated) fill light + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/fill-light/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/fill-light/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module or the exposure module with a drawn mask. Locally modify exposure based on pixel lightness. This module pushes exposure by increasing lightness with a Gaussian curve of a specified width, centered on a given lightness. 🔗module controls exposure The fill-light exposure (EV) center The median lightness impacted by the fill-light. + + + (deprecated) global tonemap + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/global-tonemap/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/global-tonemap/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the filmic rgb module instead. Compress the tonal range of an HDR image into the limited tonal range of a typical LDR output file. Global tonemap processes each pixel of an HDR image, without taking the local surrounding into account. This is generally faster than local tone mapping (deprecated), but might lead to less convincing results with very high-dynamic-range scenes. + + + (deprecated) invert + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/invert/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/invert/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the negadoctor module instead. Invert scanned negatives. 🔗module controls color of film material Clicking on the colored field will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define an RGB color. You can also activate the picker to take a color probe from your image – preferably from the unexposed border of your negative. + + + (deprecated) levels + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/levels/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/levels/ + Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the rgb levels module instead. Adjust black, white and mid-gray points. The levels tool offers two modes of operation: manual The levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in absolute values of image lightness (the L value from Lab). + + + (deprecated) spot removal + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/spot-removal/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/spot-removal/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the &ldquo;cloning&rdquo; tool in the retouch module instead. Correct areas of an image (the target) using details from another area of the image (the source). This module uses some of the shapes that are available for drawn masks (circles, ellipses and paths), and the user interface is similar. + + + (deprecated) tone mapping + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-mapping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-mapping/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module instead. Compress the tonal range of HDR images so that they fit into the limits of an LDR image, using Durand&rsquo;s 2002 algorithm. The underlying algorithm uses a bilateral filter to decompose an image into a coarse base layer and a detail layer. The contrast of the base layer is compressed, while the detail layer is preserved, then both layers are re-combined. + + + (deprecated) vibrance + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vibrance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vibrance/ + Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the vibrance control in the color balance rgb module instead. Saturate and reduce the lightness of the most saturated pixels to make the colors more vivid. 🔗module controls vibrance The amount of vibrance to apply to the image. + + + (deprecated) zone system + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/zone-system/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/zone-system/ + Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer or multiple instances of the exposure module with parametric masks to narrow down on a zone. Adjust the lightness of an image using Ansel Adams&rsquo; zone system. The lightness of the image (the L channel in Lab color space) is divided into a number of zones ranging from pure black to pure white. + + + diff --git a/en/module-reference/processing-modules/input-color-profile/index.html b/en/module-reference/processing-modules/input-color-profile/index.html new file mode 100644 index 0000000000..9d50c00988 --- /dev/null +++ b/en/module-reference/processing-modules/input-color-profile/index.html @@ -0,0 +1,3039 @@ + + + + + +darktable user manual - input color profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / input color profile + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ input color profile +

+ + + +

Define how darktable will interpret the colors of the image.

+

This module takes the color space used by the image source (e.g. camera, scanner) and converts the pixel encodings to a standardized working color space. This means that subsequent modules in the pipeline don’t need to be concerned with the specifics of the input device, and can work with and convert to/from a common working color space.

+

Where an image has been captured in a raw file, the input color profile module will normally apply either a standard or enhanced color matrix specific for that camera model, which will be used to map the colors into the working profile color space. If color space information is embedded in the image, the input color profile module will use this information when mapping the colors to the working profile color space. The user can also explicitly specify a color space for the incoming image, and can even supply a custom ICC color profile specifically made for the input device.

+

As part of the mapping from the input color space to the working profile space, the colors can be confined to a certain gamut using the gamut clipping options, which can help to mitigate some (infrequent) color artifacts. This is also influenced by the chosen rendering intent.

+

Note that the final color profile that will be used when exporting the image is controlled by the output color profile module.

+

🔗module controls

+
+
input profile
+
The profile or color matrix to apply. A number of matrices are provided along with an enhanced color matrix for some camera models. The enhanced matrices are designed to provide a look that is closer to that of the camera manufacturer.
+
+

You can also supply your own input ICC profiles and put them into $DARKTABLE/share/darktable/color/in or $HOME/.config/darktable/color/in (where $DARKTABLE is the darktable installation directory and $HOME is your home directory). Note that these color/in directories are not created by the darktable install; if you need to use one, you must create it yourself. One common source of ICC profiles is the software that is shipped with your camera, which often contains profiles specific to your camera model. You may need to activate the unbreak input profile module to use your own profiles.

+
+
+

If your input image is a low dynamic range file like JPEG, or a raw file in DNG format, it might already contain an embedded ICC profile, which darktable will use by default. You can restore this default by selecting “embedded icc profile”. If you hover your mouse over the input profile combobox on such an image, details of the embedded profile will be shown in a tooltip.

+
+
working profile
+
The working profile used by darktable’s processing modules. Each module can specify an alternative space that it will work in, and this will trigger a conversion. By default darktable will use “linear Rec. 2020 RGB”, which is a good choice in most cases.
+
gamut clipping
+
Activate a color clipping mechanism. In most cases you can leave this control in its default “off” state. However, if your image shows some specific features such as highly saturated blue light sources, gamut clipping might be useful to avoid black pixel artifacts. See possible color artifacts for more information.
+
+

Choose from a list of RGB profiles. Input colors with a saturation that exceeds the permissible range of the selected profile are automatically clipped to a maximum value. “linear Rec. 2020 RGB” and “Adobe RGB (compatible)” allow for a broader range of unclipped colors, while “sRGB” and “linear Rec. 709 RGB” produce a tighter clipping. Select the profile that prevents artifacts while still maintaining the highest color dynamics.

+
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/invert/index.html b/en/module-reference/processing-modules/invert/index.html new file mode 100644 index 0000000000..3b972f1046 --- /dev/null +++ b/en/module-reference/processing-modules/invert/index.html @@ -0,0 +1,3025 @@ + + + + + +darktable user manual - (deprecated) invert + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) invert + +
+ + + + +
+ +

+ (deprecated) invert +

+ + + +
+

Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the negadoctor module instead.

+
+

Invert scanned negatives.

+

🔗module controls

+
+
color of film material
+
Clicking on the colored field will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define an RGB color. You can also activate the picker to take a color probe from your image – preferably from the unexposed border of your negative.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/lens-correction/index.html b/en/module-reference/processing-modules/lens-correction/index.html new file mode 100644 index 0000000000..071988959c --- /dev/null +++ b/en/module-reference/processing-modules/lens-correction/index.html @@ -0,0 +1,3106 @@ + + + + + +darktable user manual - lens correction + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / lens correction + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ lens correction +

+ + + +

Automatically correct for (or simulate) lens distortion, transverse chromatic aberrations (TCA) and vignetting.

+

You can choose to either use lens correction data embedded in your Raw file (where present/supported) or correction data provided by the external Lensfun library.

+

Additional controls are also provided for manual vignetting correction, in case the profiles for your lens are insufficient or missing.

+

Note that if TCA correction is enabled in this module, also using raw chromatic aberrations may cause artifacts from over-correction.

+

🔗Lensfun correction data

+

If your system’s Lensfun library has no correction profile for the automatically identified camera/lens combination, the controls for the three photometric parameters (below) are replaced with a warning message. You may try to find the right profile yourself by searching for it in the menu.

+

If your lens is present in the list but has not been correctly identified, this may require some adjustment within the exiv2 program (see this post for details). Note that you may need to re-import the images once such adjustments have been made as the lens name is retrieved as part of the import process.

+

By default, only lenses that are directly compatible with your camera’s mount are listed and automatically identified. If you are using lenses for a different mount with an adapter (for example a Four Thirds lens adapted to a Micro Four Thirds body), then you must run the lensfun-add-adapter tool to enable those lenses.

+

If you can’t find your lens, check if it is in the list of currently supported lenses, and try running the lensfun-update-data tool. If there is still no matching profile for your lens, a lens calibration service is offered by Torsten Bronger, one of darktable’s users. Alternatively you may visit the Lensfun project to learn how to generate your own set of correction parameters. Don’t forget to share your profile with the Lensfun team!

+

🔗module controls

+
+
correction method
+
Choose which method to use to correct distortions. Additional controls will be provided depending on the option selected:
+
+
    +
  • “Lensfun database”: Use corrections provided by the Lensfun project.
  • +
+
+
    +
  • “embedded metadata”: Use corrections embedded in the metadata of the Raw file. This is only available if supported metadata is found.
  • +
+
+
    +
  • “only manual vignette”: Do not perform any automatic correction but provide manual vignette correction.
  • +
+
+
corrections
+
Choose which corrections (distortion, TCA, vignetting) to apply. Change this from its default “all”, if your camera has already performed some internal corrections (e.g. vignetting), or if you plan to undertake some corrections with a separate program.
+
corrections done
+
Occasionally, for a given camera/lens combination, only some of the possible corrections are supported. This message box appears at the bottom of the module to indicate which corrections have actually been applied to the image.
+
show guides
+
Tick the box at the bottom of the module to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.
+
+

🔗Lensfun controls

+

The following controls are provided for the “Lensfun” correction method only:

+
+
camera
+
The camera make and model as determined by the image’s Exif data. You can override this manually and select your camera from a hierarchical menu. Only lenses with correction profiles matching the selected camera will be shown.
+
lens
+
The lens make and model as determined by the image’s Exif data. You can override this manually and select your lens from a hierarchical menu. This is mainly required for pure mechanical lenses, but may also be needed for off-brand / third party lenses.
+
photometric parameters (focal length, aperture, focal distance)
+
Lens corrections depend on certain photometric parameters that are read from the image’s Exif data: focal length (for distortion, TCA, vignetting), aperture (for TCA, vignetting) and focal distance (for vignetting). Many cameras do not record focal distance in their Exif data, in which case you will need to set this manually.
+
+

You can manually override all automatically selected parameters. Either take one of the predefined values from the drop-down menu or, with the drop-down menu still open, just type in your own value.

+
+
target geometry
+
In addition to correcting lens flaws, this module can change the projection type of your image. Set this combobox to the desired projection type (e.g. “rectilinear”, “fisheye”, “panoramic”, “equirectangular”, “orthographic”, “stereographic”, “equisolid angle”, “Thoby fisheye”). To correct the aspect ratio of an anamorphic lens, use the rotate and perspective module.
+
scale
+
Adjust the scaling factor of your image to avoid black corners. Press the auto scale button (to the right of the slider) for darktable to automatically find the best fit.
+
mode
+
The default behavior of this module is to correct lens flaws. Switch this combobox to “distort” in order to instead simulate the flaws/distortions of a specific lens (inverted effect).
+
TCA overwrite
+
Check this box to override the automatic correction parameters for TCA. This will expose the TCA red and TCA blue parameters below. Un-check the box to revert back to automatic corrections.
+
TCA red; TCA blue
+
Override the correction parameters for TCA. You can also use these sliders to manually set the parameters if the lens profile does not include TCA correction. Look out for colored seams at features with high contrast edges and adjust the TCA parameters to minimize those seams.
+
+
+

Note: TCA corrections will not be applied to images that have been identified as monochrome (see developing monochrome images for more information).

+

Note: The lens correction module will fill in missing data at the borders by repeating the borders’ pixels. For strong corrections, this filling can be visible (especially on noisy images). Crop the image if necessary.

+
+

🔗embedded metadata controls

+

The following controls are provided for the “embedded metadata” correction method only:

+
+
use latest algorithm
+
This control appears for images using an older version of the “embedded metadata” correction algorithm. Check this box to irreversibly change to the newer algorithm.
+
+

The following controls can be revealed by clicking the “fine-tuning” button:

+
+
distortion
+
Fine-tune the distortion / chromatic aberration correction.
+
vignetting
+
Fine-tune the vignetting correction.
+
TCA red
+
Fine-tune the red chromatic aberration correction.
+
TCA blue
+
Fine-tune the blue chromatic aberration correction.
+
image scale
+
Override the image scaling.
+
+

🔗manual vignette correction

+

Full vignetting correction is unavailable or inadequate for many lenses, whether using embedded metadata or the Lensfun database. Click on the “manual vignetting correction” button to provide additional adjustments via the following controls.

+
+
strength
+
the overall strength of the effect.
+
radius
+
the amount of the image that is unchanged by the correction.
+
steepness
+
the steepness of the correction effect outside of the radius.
+
+

The effect of the correction can be visualised by clicking on the mask button beside the strength slider.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/levels/index.html b/en/module-reference/processing-modules/levels/index.html new file mode 100644 index 0000000000..d1e00558d0 --- /dev/null +++ b/en/module-reference/processing-modules/levels/index.html @@ -0,0 +1,3050 @@ + + + + + +darktable user manual - (deprecated) levels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) levels + +
+ + + + +
+ +

+ (deprecated) levels +

+ + + +
+

Please note that this module is deprecated from darktable 4.4 and should no longer be used for new edits. Please use the rgb levels module instead.

+
+

Adjust black, white and mid-gray points.

+

The levels tool offers two modes of operation:

+
+
manual
+
The levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in absolute values of image lightness (the L value from Lab).
+
+

Moving the black and white bars to match the left and right borders of the histogram will make the output image span the full available tonal range, increasing the image’s contrast.

+
+
+

Moving the middle bar will modify the mid-tones. Move it to the left to make the image look brighter and move it to the right to make it darker. This is often referred to as changing the image’s gamma.

+
+
+

Three pickers are available for sampling the black, white and gray points from the image. The “auto” button auto-adjusts the black and white point and puts the gray point exactly in the mean between them.

+
+
automatic
+
The module automatically analyses the histogram of the image, detects the left and right histogram borders, and lets you define the black point, the gray point and the white point in terms of percentiles relative to these borders.
+
+
+

Note: Under certain conditions, especially with highly saturated blue light sources, the levels module may produce black pixel artifacts. See the “gamut clipping” option of the input color profile module for information about how to mitigate this issue.

+
+

🔗module controls

+
+
mode
+
The mode of operation (automatic or manual).
+
black (automatic mode only)
+
The black point in percentiles relative to the left border of the histogram.
+
gray
+
The gray point in percentiles relative to the left and right borders of the histogram after having applied the black point and white point corrections.
+
white
+
The white point in percentiles relative to the right border of the histogram.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/liquify/index.html b/en/module-reference/processing-modules/liquify/index.html new file mode 100644 index 0000000000..3049fd9f02 --- /dev/null +++ b/en/module-reference/processing-modules/liquify/index.html @@ -0,0 +1,3166 @@ + + + + + +darktable user manual - liquify + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / liquify + +
+ +
+ + +
+ + +
+ +

+ liquify +

+ + + +

Move pixels around by applying freestyle distortions to parts of the image using points, lines and curves.

+

As you might want to use source data from any part of the image you will be shown the uncropped image (possibly with the cropping rectangle overlaid as a guide) while the module is active.

+

🔗nodes

+

Each of liquify’s tools is based on nodes. A point consists of a single node and a line or curve consists of a sequence of linked nodes defining a path.

+

Each instance of the liquify module is limited to a maximum of 100 nodes – for more nodes, use additional instances. However, please note that the liquify module consumes a lot of system resources.

+

Drag the central point of a node to move the node around. The radius describes the area of the effect (distortion occurs only within this radius). To change the radius drag the handle at the circumference. A strength vector starting from the center describes the direction of the distortion, and its strength is depicted by the length of the vector. Change the vector by dragging its arrow head.

+

🔗points

+

A point consists of a single node and strength vector.

+

Click the point icon to activate the point tool and then click on the image to place it. Hold Ctrl while clicking on the point icon to add multiple points without having to click the icon again each time. Right-click to exit creation mode.

+

🔗point modes

+

The strength vector of a point has three different modes. These can be toggled by holding Ctrl and clicking on the arrowhead of the strength vector.

+
+
linear
+
A linear distortion inside the circle, starting from the opposite side of the strength vector and following the vector’s direction. This is the default mode.
+
+

+ + + + + + + + +linear + +

+
+
radial growing
+
The strength vector’s effect is radial, starting with a strength of 0% in the center and increasing away from the center. This mode is depicted by an additional circle with the arrow pointing outwards.
+
+

+ + + + + + + + +radial growing + +

+
+
radial shrinking
+
The strength vector’s effect is radial, starting with a strength of 100% in the center and decreasing away from the center. This mode is depicted by an additional circle with the arrow pointing inwards.
+
+

+ + + + + + + + +radial shrinking + +

+
+
+

🔗feathering

+
+
default mode
+
By default the strength varies linearly from 0% to 100% between the center and the radius of the control point. It is possible to modify the feathering effect by clicking on the center of the circle.
+
+

+ + + + + + + + +default + +

+
+
feathered mode
+
In “feathered” mode, two control circles are displayed, which can be modified independently to feather the strength of the effect. Note that clicking the center of the circle again hides the feathering controls but does not return to the default mode.
+
+

+ + + + + + + + +feathered + +

+
+
+

🔗removing points

+

A point can be removed by right-clicking on the center of the node.

+

🔗lines and curves

+

Lines and curves are sequences of points linked together by straight or curved lines. The effect is interpolated by a set of associated strength vectors.

+

Click the appropriate icon to activate the line or curve tool and then click on the image to place a sequence of points forming the path. Right-click anywhere when the last point has been placed in order to finish drawing the line/curve.

+

Hold Ctrl while clicking on the line/curve icon to add multiple lines/curves without having to click the icon again each time. Right-click a second time to exit creation mode after the final line or curve has been completed.

+
+
lines
+
+ + + + + + + + +lines + +
+
curves
+
+ + + + + + + + +curves + +
+
+

Ctrl+click on a line or curve segment to add a new control point. Ctrl+right-click on the center of a node to remove a control point.

+

Right-click on a segment to remove the shape completely. Ctrl+Alt+click on a segment to change that segment from a line to a curve and vice versa.

+

🔗link modes

+

Ctrl+click on the center of a node to change the way the points of a curve are linked together. There are four modes, which correspond to different ways of handling the steepness of the bezier curve using control handles:

+
+
autosmooth
+
This is the default mode, in which control handles are not displayed – controls are automatically computed to give a smooth curve.
+
cusp
+
Control handles can be moved independently. This mode is depicted by a triangle symbol in the node’s center.
+
smooth
+
Control handles always give a smooth curve. This mode is depicted by a diamond symbol in the node’s center.
+
symmetrical
+
Control handles are always moved together. This mode is depicted by a square symbol in the node’s center.
+
+

🔗view and edit nodes

+

Click the node tool icon to activate or deactivate the node edit tool. This displays all currently-defined distortion objects and their controls. Alternatively you can right-click on the image at any time for the same effect.

+

🔗warps and nodes count

+

This information field displays the number of warps (individual distortion objects) and nodes currently in use.

+

🔗show guides

+

Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.

+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/liquify/liquify_ex1.png b/en/module-reference/processing-modules/liquify/liquify_ex1.png new file mode 100644 index 0000000000..4b4ad9f781 Binary files /dev/null and b/en/module-reference/processing-modules/liquify/liquify_ex1.png differ diff --git a/en/module-reference/processing-modules/liquify/liquify_ex2.png b/en/module-reference/processing-modules/liquify/liquify_ex2.png new file mode 100644 index 0000000000..3cef07a2e3 Binary files /dev/null and b/en/module-reference/processing-modules/liquify/liquify_ex2.png differ diff --git a/en/module-reference/processing-modules/liquify/liquify_ex3.png b/en/module-reference/processing-modules/liquify/liquify_ex3.png new file mode 100644 index 0000000000..02d8745587 Binary files /dev/null and b/en/module-reference/processing-modules/liquify/liquify_ex3.png differ diff --git a/en/module-reference/processing-modules/liquify/liquify_ex4.png b/en/module-reference/processing-modules/liquify/liquify_ex4.png new file mode 100644 index 0000000000..e7938eae88 Binary files /dev/null and b/en/module-reference/processing-modules/liquify/liquify_ex4.png differ diff --git a/en/module-reference/processing-modules/liquify/liquify_ex5.png b/en/module-reference/processing-modules/liquify/liquify_ex5.png new file mode 100644 index 0000000000..073754d8a9 Binary files /dev/null and b/en/module-reference/processing-modules/liquify/liquify_ex5.png differ diff --git a/en/module-reference/processing-modules/liquify/liquify_ex6.png b/en/module-reference/processing-modules/liquify/liquify_ex6.png new file mode 100644 index 0000000000..7090d975e5 Binary files /dev/null and b/en/module-reference/processing-modules/liquify/liquify_ex6.png differ diff --git a/en/module-reference/processing-modules/local-contrast/index.html b/en/module-reference/processing-modules/local-contrast/index.html new file mode 100644 index 0000000000..8bd6d7e00f --- /dev/null +++ b/en/module-reference/processing-modules/local-contrast/index.html @@ -0,0 +1,3061 @@ + + + + + +darktable user manual - local contrast + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / local contrast + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ local contrast +

+ + + +

Enhance the image’s local contrast.

+

This is achieved using either a local laplacian (default) or unnormalized bilateral filter. Both modes work exclusively on the L channel from Lab. The local laplacian filter has been designed to be robust against unwanted halo effects and gradient reversals along edges.

+

🔗module controls

+
+
mode
+
Choice of local laplacian filter or bilateral grid. The following sections define the controls available for each of these modes.
+
+

🔗bilateral grid

+
+
coarseness
+
Adjust the coarseness of the details to be adjusted.
+
contrast
+
Control how strongly the algorithm distinguishes between brightness levels. Increase this parameter for a more contrasty look.
+
detail
+
Add or remove detail. Higher values increase local contrast.
+
+

🔗local laplacian

+

To understand the parameters of the local laplacian filter, one can think of it as applying a curve to the image, similar to the following graph:

+

+ + + + + + + + +local laplacian curve + +

+

This curve is applied to the image in a way that works locally and avoids halo artifacts.

+

The local laplacian mode also supports shadow lifting and highlight compression, similar to the shadows and highlights module.

+
+
detail
+
Add or remove detail. Higher values increase local contrast. This inserts an S shaped element in the center of the curve, to increase or decrease local contrast.
+
highlights
+
This affects one end of the S shaped contrast curve, effectively increasing or compressing contrast in the highlights. A low value pulls the highlights down.
+
shadows
+
Similar to the highlights parameter, this affects the other end of the contrast curve, and increases or decreases contrast in the shadows. A higher value gives more contrast in the shadows. A lower value lifts the shadows and can effectively simulate a fill light. Note that this is done with local manipulation of the image. However, this means that a completely dark image cannot be brightened in this way – only dark objects in front of bright objects are affected.
+
mid-tone range
+
This controls the extent of the S shaped part of the contrast curve. A larger value makes the S wider, and thus classifies more values as mid-tones and fewer values as highlights and shadows. In higher dynamic range settings it can be useful to reduce this value to achieve stronger range compression, by lowering the contrast in the highlights and the shadows. Note however, that for really strong HDR scenarios this may work best in combination with a base curve that pre-compresses the range, perhaps with an approximately logarithmic curve. The exposure fusion feature in the base curve module may lead to more pleasing results at times, but is also more prone to halo effects.
+
+

This setting can cause banding artifacts in the image if pushed to extreme values. This is due to the way in which darktable computes the fast approximation of the local laplacian filter.

+
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/local-contrast/local-laplacian-curve.png b/en/module-reference/processing-modules/local-contrast/local-laplacian-curve.png new file mode 100644 index 0000000000..f9d86bc14a Binary files /dev/null and b/en/module-reference/processing-modules/local-contrast/local-laplacian-curve.png differ diff --git a/en/module-reference/processing-modules/lowlight-vision/index.html b/en/module-reference/processing-modules/lowlight-vision/index.html new file mode 100644 index 0000000000..3e2a2ef79e --- /dev/null +++ b/en/module-reference/processing-modules/lowlight-vision/index.html @@ -0,0 +1,3026 @@ + + + + + +darktable user manual - lowlight vision + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / lowlight vision + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ lowlight vision +

+ + + +

Simulate human lowlight vision. This module can also be used to perform a day-to-night conversion.

+

The idea is to calculate a scotopic vision image, which is perceived by the rods rather than the cones in the eyes under low light. Scotopic lightness is then mixed with photopic value (regular color image pixel) using some blending function. This module can also simulate the Purkinje effect by adding some blueness to the dark parts of the image.

+

This module comes with several presets, which can be used to get a better idea of how the module works.

+

🔗module controls

+
+
curve
+
The horizontal axis represents pixel lightness from dark (left) to bright (right). The vertical axis represents the kind of vision from night vision (bottom) to day vision (top).
+
blue
+
Set the blue hint in shadows (Purkinje effect).
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/lowpass/index.html b/en/module-reference/processing-modules/lowpass/index.html new file mode 100644 index 0000000000..289cc0c9ef --- /dev/null +++ b/en/module-reference/processing-modules/lowpass/index.html @@ -0,0 +1,3042 @@ + + + + + +darktable user manual - lowpass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / lowpass + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ lowpass +

+ + + +

Apply a low pass filter (for example, a Gaussian blur) to the image, while controlling the output contrast and saturation.

+

This module is primarily intended to be used in combination with a blend mode. For example, try using the local contrast mask preset with the overlay blend mode.

+
+

Note: This module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead, use the contrast equalizer module for blurring or the tone equalizer module for dynamic range compression.

+
+

🔗module controls

+
+
radius
+
The radius of the blur.
+
soften with
+
The blur algorithm to use:
+
    +
  • gaussian blur: Blur all image channels (L, a, b)
  • +
+
+
    +
  • bilateral filter: Blur the L channel only, while preserving edges
  • +
+
+
contrast
+
Higher absolute values increase contrast. Lower absolute values reduce contrast. Negative values result in an inverted negative image. A value of zero leads to a neutral plane.
+
brightness
+
Negative values darken the image. Positive values lighten the image.
+
saturation
+
The color saturation. Negative values result in complementary colors by inverting the a/b channels. Higher absolute values increase color saturation. Lower absolute values reduce color saturation. A value of zero fully desaturates the image.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/lut-3d/index.html b/en/module-reference/processing-modules/lut-3d/index.html new file mode 100644 index 0000000000..05a9b32a26 --- /dev/null +++ b/en/module-reference/processing-modules/lut-3d/index.html @@ -0,0 +1,3035 @@ + + + + + +darktable user manual - LUT 3D + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / LUT 3D + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ LUT 3D +

+ + + +

Transform RGB values with a 3D LUT file.

+

A 3D LUT is a tridimensional table that is used to transform a given RGB value into another RGB value. It is normally used for film simulation and color grading.

+

This module accepts .cube, .3dl, .png (haldclut) and .gmz files. Uncompressed 3D LUT data is not saved in the database or the XMP file, but is instead saved to the 3D LUT file path inside the 3D LUT root folder. It is therefore important to back up your 3D LUT folder properly – sharing an image with its XMP is pointless if the recipient doesn’t also have the same 3D LUT file in their own 3D LUT folder.

+

The compressed format .gmz is only available when GMIC is installed. This format can hold a full library of LUTs, and LUT data loaded from this type of file can be saved to the database and XMP files.

+
+

Note: the module clips all values outside of the range [0,1]. You may have to reduce the range of the input before applying.

+
+

🔗usage

+

LUTs are most commonly used in darktable for color grading or film look simulation. For this reason, by default, the module is placed after the filmic rgb module in the pixelpipe and should be applied to a neutral image (without first applying a specific look). While you can find hundreds of free LUTs on the internet, you should note that not all of them are compatible with the darktable environment and workflow – incompatible LUTs will not produce the advertised look. To limit the risk, a color grading LUT should have been created to work with one of the available “application color spaces” (see below), for both the input and the output of the module.

+

Camera log LUTs (as F-log or S-Log3) are different to color-grading and film-look-simulation LUTs, and are intended to convert the camera log raw data into something (linear raw data or other color space) that darktable is able to understand. In this case the LUT 3D module should be manually placed between the demosaic and input color profile modules. Once you have done this, you can no longer choose an “application color space”. The “input profile” of input color profile module should be aligned with the output of the LUT. Please note that this use case has not yet been tested.

+

🔗module controls

+
+
file selection
+
Choose the 3D LUT file to use. File selection is inactive if the 3D LUT root folder has not been defined in preferences > processing.
+
application color space
+
A 3D LUT is defined relative to a specific color space. Choose the color space for which the selected 3D LUT file has been built. Cube files are usually related to Rec. 709 while most others are related to sRGB.
+
interpolation
+
This defines how to calculate output colors when input colors are not exactly on a node of the RGB cube described by the 3D LUT. There are three interpolation methods available: tetrahedral (default), trilinear and pyramid. Usually you won’t see any difference between interpolation methods except with smaller sized LUTs.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/monochrome/index.html b/en/module-reference/processing-modules/monochrome/index.html new file mode 100644 index 0000000000..17816cebaf --- /dev/null +++ b/en/module-reference/processing-modules/monochrome/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - monochrome + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / monochrome + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ monochrome +

+ + + +

Quickly convert an image to black & white using a variable color filter.

+

To use this module, first reduce the filter size (to concentrate its effect) and move it across the hue palette to find the best filter value for your desired image rendition. Then gradually expand the filter to include more hues and achieve more natural tonality.

+

Although this module is easy to use, better results can usually be obtained by using the film emulation presets in the color calibration module.

+
+

Note: Under certain conditions, especially highly saturated blue light sources in the frame, this module may produce black pixel artifacts. Use the gamut clipping option of the input color profile module to mitigate this issue.

+
+

🔗module controls

+
+
filter size/position
+
The default central location of the filter has a neutral effect but dragging it to an alternate position applies a filter analogous to taking a b&w photograph through a conventional color filter.
+
+

A picker can be activated to automatically set the position and size of the filter based on the selected portion of the image. Scroll the mouse wheel to change the filter size, making the filter’s range of hues more or less selective.

+
+
highlights
+
Control how much to retain highlights.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/negadoctor/index.html b/en/module-reference/processing-modules/negadoctor/index.html new file mode 100644 index 0000000000..3943fdfbdd --- /dev/null +++ b/en/module-reference/processing-modules/negadoctor/index.html @@ -0,0 +1,3088 @@ + + + + + +darktable user manual - negadoctor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / negadoctor + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ negadoctor +

+ + + +

Process scanned film negatives.

+

You can obtain an image of a negative using a film scanner, or by photographing it against a white light (e.g. a light table or computer monitor) or off-camera flash.

+

🔗preparation

+

If the image of the negative was obtained using a digital camera, then in order to obtain accurate colors in the final image, you will need to take the following points into consideration:

+
    +
  • +

    When taking the photograph, adjust the exposure to fully utilise the entire dynamic range of your camera sensor – i.e. “expose-to-the-right”, so that the histogram in your camera touches the right hand side without clipping the image.

    +
  • +
  • +

    Ensure the white balance is correctly set up to compensate for the light source used to illuminate the negative. You can take a profiling picture of the light source with no film negative in front of it, and then use the “from image area” feature in the white balance module to obtain a reference white-balance setting. This reference white balance setting can then be made into a style or simply pasted onto the images taken from your film negatives.

    +
  • +
  • +

    Apply the standard or enhanced camera matrix in the input color profile module.

    +
  • +
+

When scanning or photographing your film negative, make sure you include some unexposed part of the film within the captured image. This is required to set the Dmin parameter (see below). If this is not possible (e.g. your film holder completely obscures the unexposed parts of the film), you can take a separate image of an unexposed part of the film, measure the Dmin parameter from that image, and then paste that setting to the rest of the images from that film.

+

When developing the scanned/photographed film negatives, it is recommended that you disable any tone mapping modules such as filmic rgb and base curve.

+

The working profile parameter in darktable’s input color profile module should be set to either linear Rec. 2020 RGB, or to an ICC profile representing the actual color space of your film emulsion. Some examples of such ICC profiles may be found in the following forum posts:

+ +
+

Note: if you want to use the tone equalizer with negadoctor, you’ll need to move the tone equalizer module after negadoctor in the pixelpipe, since the tone equalizer is not designed to work with negatives.

+
+

🔗module controls

+

It is strongly recommended that you set the parameters following the order in which they are presented in the GUI. Start by setting the film stock, then work through each of the tabs (film properties, corrections, print properties) in order, working from top to bottom in each tab.

+

When using ,pickers be careful to avoid including dust and scratches, which can skew the data taken from the sampled region.

+
+
film stock
+
The first step is to choose “color” or “black and white” in the film stock drop-down. If you select “black and white”, any sliders that are only used for color will be hidden from view.
+
+

🔗film properties

+

This tab contains a number of basic settings. If, after adjusting these settings, your image is still not quite as you would like it, you can make further adjustments on the corrections tab. These are technical settings, and serve a similar purpose to the scene tab in the filmic rgb module, in that they adjust the black and white points and hence define the dynamic range of the negative.

+
+
color of the film base
+
Sample an area of the base film stock from your scan. This is the area just outside of the image (an unexposed part of the film). If you are working with black and white negatives, you can leave this slider at its default value (white). If working on color film, click the picker to the right of the color bar, which will create a bounding box covering about 98% of your image. Then, click and drag across an area of your negative which contains only unexposed film stock. This will automatically calculate values for the D min slider(s). It is likely at this point that your image will still look too dark, but you can correct this later.
+
D min
+
If the film stock is set to “black and white”, this slider indicates the minimum value corresponding to the unexposed film stock. If the film stock is set to “color”, this control will consist of 3 separate sliders, one for each of the red, green and blue channels.
+
D max
+
This slider represents the dynamic range of your film, and it effectively sets the film’s white point. Dragging this slider to the left will make the negative brighter. Dragging it to the right will make the negative darker. When adjusting this slider manually, it’s a good idea to closely watch your histogram to ensure that you don’t clip the highlights (where the histogram has been pushed over too far off the right hand side of the graph). If you click the picker icon (on the right) negadoctor will automatically calculate this value to ensure maximal use of the histogram without clipping. To use the picker, click and drag to draw a rectangle across only the exposed parts of the negative. Don’t include the unexposed film stock, as this will skew the result.
+
scan exposure bias
+
This slider allows you to set the black point. It is a technical adjustment that ensures a proper zeroing of the RGB values and a spreading of the histogram between [0, 1] values for robustness in the operations that follow. Dragging this to the left will make the negative brighter. Dragging to the right will make the negative darker. When adjusting this slider manually, it’s a good idea to closely watch your histogram to ensure that you don’t clip the shadows (where the histogram is pushed too far off the left hand side of the graph). If you click the picker negadoctor will automatically calculate any required offset. To use the picker, select a region in the darkest lowlights, or select the entire image without including any unexposed film stock. Double-check the histogram to ensure the left part of it doesn’t clip.
+
+

🔗corrections

+

This tab contains sliders that allow you to make color cast corrections within both the shadow and highlight regions.

+

The settings on this tab should not be needed for most well-preserved negatives. It is mostly useful for old and poorly-preserved negatives with a decayed film base that introduces undesirable color casts.

+

The other case where these color cast corrections may be needed is if the white balance properties of the light used to scan the film negative are significantly different to the light source under which the original film camera took the shot. For example, if you illuminate the film with an LED light, but the original shot was taken under daylight, this may require some additional color cast corrections.

+
+
shadows color cast
+
These three sliders allow you to correct for color casts in the shadows by adjusting the red, green and blue channels individually. Use the picker to set the sliders automatically by selecting a neutral gray shadow region requiring correction. Because the shadows sliders can also affect color casts in the highlights, it is important to finish setting the shadows sliders before moving on to the highlights sliders.
+
highlights white balance
+
These three sliders allow you to correct the white balance in the highlights by adjusting the red, green and blue channels individually. Use the picker to set the sliders automatically by selecting a neutral gray region in the highlights that is not properly balanced.
+
+ +

This tab contains settings that mimic the tonal effect of the photochemical papers that would have been used to create the hard copy image if you were not developing the photo digitally. These are creative settings, and serve a similar overall purpose to the creative tone curve settings on the look tab of the filmic rgb module.

+

The print exposure, paper black and paper grade are analogous to the slope, offset and power controls in the color balance module (which in turn is based on the ASC CDL standard). These settings define a creative tone curve to enforce your contrast intent after the inversion, at the end of the module. The equation governing this slope/offset/power behaviour is:

+

RGB_out = ( RGB_in × exposure + black ) ᵍʳᵃᵈᵉ

+
+
paper black (density correction)
+
For this slider, select the picker and click and drag to select a region that encompasses only the exposed part of the film negative. If you can see unexposed film stock around the edges of your image, ensure that these areas are excluded from the drawn rectangle when calculating the paper black setting. Paper black represents the density of the blackest silver-halide crystal available on the virtual paper. In the analog development process, this black density always results in non-zero luminance, but the digital pipeline usually expects black to be encoded with a zero RGB value. This slider setting lets you remap paper black to pipeline black via an offset. You can use the picker to select a region of the image that should be mapped to black in the final image.
+
paper grade (gamma)
+
This slider is your gamma (contrast) control, and it defaults to a value of 4. If all has gone well, this value (4) minus the value of D max (from the “film properties” tab) should normally leave you with a value between 2 and 3.
+
paper gloss (specular highlights)
+
This slider is essentially a highlights compression tool. As you drag this slider to the left, you will see in the histogram that the highlight values are being compressed (pushed to the left). Adjust this accordingly, so that your highlights are not clipped in the histogram. You can also use this to simulate a matte photo print with low-contrast highlights.
+
print exposure adjustment
+
This slider offers one final opportunity to correct any clipping of the highlights. If you have followed all the previous instructions carefully, you shouldn’t need to adjust this setting. Note that you can increase the print exposure while at the same time decreasing the paper gloss, which allows you to brighten the mid-tones without losing any highlights. You can use the picker to select the brightest highlights, or select the entire image without including any unexposed film stock. This will set the exposure so that the brightest part of the selected region is not clipped. Double-check the histogram to make sure that the right part of the histogram doesn’t clip.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/orientation/flip-horizontal.png b/en/module-reference/processing-modules/orientation/flip-horizontal.png new file mode 100644 index 0000000000..1c9ebda42a Binary files /dev/null and b/en/module-reference/processing-modules/orientation/flip-horizontal.png differ diff --git a/en/module-reference/processing-modules/orientation/flip-vertical.png b/en/module-reference/processing-modules/orientation/flip-vertical.png new file mode 100644 index 0000000000..a9f8e89119 Binary files /dev/null and b/en/module-reference/processing-modules/orientation/flip-vertical.png differ diff --git a/en/module-reference/processing-modules/orientation/index.html b/en/module-reference/processing-modules/orientation/index.html new file mode 100644 index 0000000000..4556642a67 --- /dev/null +++ b/en/module-reference/processing-modules/orientation/index.html @@ -0,0 +1,3078 @@ + + + + + +darktable user manual - orientation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / orientation + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ orientation +

+ + + +

Rotate the image 90 degrees at a time or flip the image horizontally and/or vertically.

+

The module is enabled by default and the orientation (rotation) is automatically set based on the image’s Exif data.

+

The orientation can also be set using the actions on selection module in the lighttable view.

+

🔗module controls

+
+
transform
+
Double click the label to reset to the default transformations
+
+ + + + + + + + +rotate counter-clockwise + + rotate counter-clockwise
+
Rotate the image 90 degrees counter-clockwise
+
+ + + + + + + + +rotate clockwise + + rotate clockwise
+
Rotate the image 90 degrees clockwise
+
+ + + + + + + + +flip horizontally + + flip horizontally
+
Flip the image (mirror) horizontally
+
+ + + + + + + + +flip vertically + + flip vertically
+
Flip the image (mirror) vertically
+
show guides
+
Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/orientation/rotate-clockwise.png b/en/module-reference/processing-modules/orientation/rotate-clockwise.png new file mode 100644 index 0000000000..1f0b995c4e Binary files /dev/null and b/en/module-reference/processing-modules/orientation/rotate-clockwise.png differ diff --git a/en/module-reference/processing-modules/orientation/rotate-counter-clockwise.png b/en/module-reference/processing-modules/orientation/rotate-counter-clockwise.png new file mode 100644 index 0000000000..e66df71e3f Binary files /dev/null and b/en/module-reference/processing-modules/orientation/rotate-counter-clockwise.png differ diff --git a/en/module-reference/processing-modules/output-color-profile/index.html b/en/module-reference/processing-modules/output-color-profile/index.html new file mode 100644 index 0000000000..8611ba9bbb --- /dev/null +++ b/en/module-reference/processing-modules/output-color-profile/index.html @@ -0,0 +1,3026 @@ + + + + + +darktable user manual - output color profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / output color profile + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ output color profile +

+ + + +

Manage the output profile for export and the rendering intent to be used when mapping between color spaces.

+

darktable comes with pre-defined profiles sRGB, Adobe RGB, XYZ and linear RGB. You can provide additional profiles by placing them in $DARKTABLE/share/darktable/color/out and $HOME/.config/darktable/color/out (where $DARKTABLE is the darktable installation directory and $HOME is your home directory). Note that these color/out directories are not created by the darktable install; if you need to use one, you must create it yourself.

+

The output color profile may also be defined within the export module.

+

🔗module controls

+
+
output intent
+
The rendering intent for output/export. Rendering intent can only be selected when using LittleCMS2 to apply the output color profile (this can be changed in preferences > processing). If darktable’s internal rendering routines are used, this option is hidden. For more details see rendering intent.
+
output profile
+
The profile used to render colors for output/export. The profile data will be embedded into the output file (if supported by the file format) allowing other applications to correctly interpret its colors. As not all applications are aware of color profiles, the general recommendation is to stick to sRGB unless you know what you are doing and have a good reason to do otherwise.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/raw-black-white-point/index.html b/en/module-reference/processing-modules/raw-black-white-point/index.html new file mode 100644 index 0000000000..a9a80161f1 --- /dev/null +++ b/en/module-reference/processing-modules/raw-black-white-point/index.html @@ -0,0 +1,3027 @@ + + + + + +darktable user manual - raw black/white point + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / raw black/white point + +
+ + + + +
+ +

+ raw black/white point +

+ + + +

Define camera-specific black and white points.

+

This module is activated automatically for all raw images. Default settings are applied for all supported cameras. Changes to the defaults are not normally required.

+

🔗module controls

+
+
black level 0-3
+
The camera-specific black level of the four pixels in the RGGB Bayer pattern. Pixels with values lower than this level are not considered to contain valid data.
+
white point
+
The camera-specific white level. All pixels with values above this are likely to be clipped and will be handled accordingly in the highlight reconstruction module.
+
flat field correction
+
Use flat field correction to compensate for lens shading. This field only appears for applicable Raw files and will automatically use any GainMap embedded in the Raw. You can choose to disable this correction if desired.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/raw-chromatic-aberrations/index.html b/en/module-reference/processing-modules/raw-chromatic-aberrations/index.html new file mode 100644 index 0000000000..b4a5d6b8dd --- /dev/null +++ b/en/module-reference/processing-modules/raw-chromatic-aberrations/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - raw chromatic aberrations + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / raw chromatic aberrations + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ raw chromatic aberrations +

+ + + +

Correct chromatic aberrations of raw images.

+

This module currently only works for raw images recorded with a Bayer sensor (the sensor used in the majority of cameras) – for other types of image, you should use the chromatic aberrations module instead.

+

The module will also not apply any corrections to any photos that have been identified as monochrome (see developing monochrome images for more information).

+

This module expects good white balance data (provided by the white balance module) for best results. In most cases the default settings are sufficient.

+

Note that if this module is enabled, then TCA correction in the lens correction module should be disabled, as the two modules will conflict with one another.

+

🔗module controls

+
+
iterations
+
The number of iterations. For most images, “twice” is sufficient, and is the default value. Occasionally, increasing this control can give better results.
+
avoid colorshift
+
If the module causes tinting – often pink or greenish – tick this box to apply a correction.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/raw-denoise/index.html b/en/module-reference/processing-modules/raw-denoise/index.html new file mode 100644 index 0000000000..05353d9169 --- /dev/null +++ b/en/module-reference/processing-modules/raw-denoise/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - raw denoise + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / raw denoise + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ raw denoise +

+ + + +

Perform denoising on raw image data before it is demosaiced.

+

This module has been ported from dcraw.

+

🔗module controls

+
+
noise threshold
+
The threshold for noise detection. Higher values lead to stronger noise removal and greater loss of image detail.
+
coarse/fine curves
+
The noise of an image is usually a combination of fine-grained and coarse-grained noise. These curves allow the image to be denoised more or less depending on the coarseness of the visible noise. The left of the curve will act on very coarse grain noise, while the right of the curve will act on very fine grain noise.
+
+

Raising the curve will result in more smoothing, while lowering it will result in less smoothing. As an example, you can preserve very fine-grained noise by pulling down the rightmost point of the curve to the minimum value.

+
+
+

If you are tackling chroma noise with a blend mode, you can raise the rightmost part of the curve quite high, as colors do not change a lot on fine grain scales. This will help especially if you see some isolated pixel left un-denoised.

+
+
+

The best way to use the R, G, and B curves is to examine each of the channels in turn using the color calibration module in gray mode, denoise that channel, and then repeat for the other channels. This way, you can take into account the fact that some channels may be noisier than others. Beware that guessing which channel is noisy without actually seeing the channels individually is not straightforward and can be counterintuitive. A pixel which is completely red may not be caused by noise on the R channel, but actually by noise on G and B channels.

+
+
+

See the wavelet section for more details.

+
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/retouch/index.html b/en/module-reference/processing-modules/retouch/index.html new file mode 100644 index 0000000000..4f4625ffef --- /dev/null +++ b/en/module-reference/processing-modules/retouch/index.html @@ -0,0 +1,3339 @@ + + + + + +darktable user manual - retouch + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / retouch + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ retouch +

+ + + +

Remove unwanted elements from your image by cloning, healing, blurring and filling using drawn shapes.

+

This module extends the capabilities of the deprecated spot removal module (equivalent to this module’s “clone” tool) by including a “heal” tool (based on the heal tool from GIMP), as well as “fill” and “blur” modes. It can also take advantage of wavelet decomposition, allowing the image to be separated into layers of varying detail (from coarse to fine) which can be selectively retouched before being recombined to produce the output image.

+

As you might want to use source data from any part of the image you will be shown the uncropped image (possibly with the cropping rectangle overlaid as a guide) while the module is active.

+

🔗clone and heal

+

Cloning allows a part of the image (the target) to be hidden by replacing it with an area copied from elsewhere in the image (the source). For example, you may wish to remove a small cloud from a blue sky:

+

+ + + + + + + + +retouch-original + +

+

The simplest way to do this is with the cloning tool + + + + + + + + +retouch-clone-icon + +. The following example uses a circular shape to clone out the cloud using the circle of blue sky beside it:

+

+ + + + + + + + +retouch-clone + +

+

In many cases, the edges of the source shape won’t precisely match the surroundings of the target, leading to unnatural looking results. In this example, the sample of sky we chose as the source was slightly darker than the target, leaving a faint outline of the circular shape used in the cloning process:

+

+ + + + + + + + +retouch-clone-nocontrol + +

+

In such cases, the heal tool + + + + + + + + +retouch-heal-icon + + is more appropriate. With this tool, the color and luma of the sample is blended to fit better with the surroundings. In this example, using heal instead of clone produces a much more pleasing result:

+

+ + + + + + + + +retouch-heal-nocontrol + +

+

🔗source and target shapes

+

Once you have chosen heal or clone mode, you must choose the shape you wish to use (circle, ellipse, path or brush – see the drawn masks section for details). The source and target patches will both use the same shape.

+

When you hover over the image with your mouse, a plus symbol (+) will appear to indicate where the source shape will be placed by default. Your normal mouse cursor will indicate the position of the target shape:

+

+ + + + + + + + +retouch-source-cross + +

+

It is recommended that you choose the position of the source shape first, followed by the position of the target, as follows:

+
    +
  • +

    Shift+click to set the position of the source shape in “relative mode”. The position of the “plus” (+) symbol will move to the clicked location and will remain in a fixed position relative to your cursor until you click on the image to begin placing your target shape. If you place subsequent shapes without first changing the target location, the source shape will be placed at the same offset from the target shape as was used for the first stroke.

    +
  • +
  • +

    Ctrl+Shift+click to change the position of the source shape in “absolute” mode. As above, the position of the “plus” (+) symbol will move to the clicked location, but will remain in the same absolute position even if you move your mouse. You can then click on the image to begin placing the target shape. If you place subsequent shapes without first changing the target location, exactly the same source position will be used, fixed in the absolute coordinate system of the image.

    +
  • +
+

Once you have placed your source and target shapes on the image, they can be adjusted manually with your mouse.

+
+

Note: For circle and ellipse shapes only, you can place both the source and target shapes with a single click-and-drag motion: Click on the desired target location and then drag, releasing your mouse button when you reach the desired source location. This operation does not affect the placement of subsequent shapes.

+
+

🔗fill and blur

+

The clone and heal tools both require the use of another part of the image to “fill in” the region being hidden. Sometimes there is no suitable sample in the image to use for this purpose. In such cases, the retouch module offers two further options:

+
+
+ + + + + + + + +retouch-fill-icon + + fill tool
+
Fill the drawn region with a selected color.
+
+ + + + + + + + +retouch-blur-icon + + blur tool
+
Apply a blur to the drawn region, smoothing out any details.
+
+

These two options are most useful when used together with wavelet decomposition, where they can be used to smooth over features within a selected detail layer.

+

🔗wavelet decomposition

+

Wavelets allow an image to be decomposed into a number of layers each containing varying levels of detail, so that you can work on each detail layer independently and then recombine them at the end. This is particularly useful in portrait photography, where you can deal with skin blotches and blemishes on a coarse layer of detail, leaving the finer skin texture untouched. The wavelets section provides more information on the decomposition process.

+

This method can be used with the healing tool, for example, to paint over a spot that appears in one of the coarse detail layers, while leaving the hairs in the fine detail layers intact:

+

+ + + + + + + + +retouch-beard-preserve + +

+

It can also be used with the blur tool to even out coarse blotches in the skin, again without impacting the finer details (see the wavelets section for details on this technique).

+

🔗module controls

+

+ + + + + + + + +retouch-overview + +

+

🔗retouch tools

+

The retouch tools section consists of two items:

+
+
shapes
+
The number after the shapes label indicates how many shapes have been placed on the image, either directly or within a wavelet layer.
+
+

Click on one of the shape icons to draw a new shape on the image (see drawn masks for details).

+
+
+

Ctrl+click on a shape icon to draw multiple shapes continuously (right-click to cancel).

+
+
+

Click the show and edit shapes + + + + + + + + +retouch-shapes-icon + + button to show and edit any existing shapes for the currently-selected wavelet scale.

+
+
algorithms
+
Choose a retouching algorithm (clone, heal, fill or blur). Ctrl+click to change the algorithm used for the currently-selected shape. Shift+click to set the default algorithm (used for new images or when you reset module parameters).
+
+

🔗wavelet decompose

+

The wavelet decompose section centres around a bar graph that shows how the image has been decomposed into detail (scale) layers. The key features of the bar graph are:

+
    +
  • The black square on the left represents the entire image before decomposition.
  • +
  • The gray squares show the various wavelet detail layers, with fine details to the left, and coarse details to the right.
  • +
  • The white square on the far right represents the residual image (the remainder of the image after the detail layers have been extracted).
  • +
  • A light gray dot in a square indicates the currently-selected layer. Click on another square to select a different layer.
  • +
  • The light gray bar running along the top indicates which levels of detail are visible at the current zoom level. Zoom in to see finer details.
  • +
  • The triangle at the bottom shows how many layers the image has been decomposed into. Drag the triangle to the right to create more layers. Drag it to the left to decrease the number of layers. By default no wavelet decomposition is performed.
  • +
  • The triangle at the top shows the current value of the “merge from” parameter (see below).
  • +
  • The orange lines under the squares indicate which layers have retouch edits applied.
  • +
+

The remaining items in this section are:

+
+
scales
+
Shows how many detail layers the image has been decomposed into. Zero indicates that no wavelet decomposition has been performed.
+
current
+
Shows which layer is currently selected (also marked with the light gray dot on the bar graph).
+
merge from
+
This setting allows a single edit to be applied to multiple consecutive scales within a group starting from the coarsest scale (excluding the residual image) down to the scale selected. For example, if “merge from” is set to 3 and the maximum scale is 5 then all edits that are added to scale 5 will be applied to scales 3, 4 and 5. Edits added to scale 4 will be applied to scales 3 and 4, and edits added to scale 3 will be applied to scale 3 only. If you set merge from to 0, then merging is disabled, and all edits apply only to the scale that they are defined in. Setting merge from to the highest scale available (in this example, 5) also disables merging.
+
+
           merge_from
+               v
+   0   1   2   3   4   5    scale
+               <-------o    scale 5 edits
+               <---o        scale 4 edits
+               o            scale 3 edits
+           o                scale 2 edits
+       o                    scale 1 edits
+
+
+ + + + + + + + +retouch-display-icon + + display wavelet scale
+
Display the currently-selected wavelet layer on the center image. Selecting this option brings up an additional control – preview single scale.
+
preview single scale
+
An additional control that allows the black, white and gray points of the wavelet scale preview to be adjusted to make it easier to see. Click the + + + + + + + + +auto-levels-icon + + to set these values automatically. This does not affect the module’s operation – only the wavelet scale preview.
+
+ + + + + + + + +retouch-cut-icon + + cut
+
Cut all shapes from the currently-selected layer and place them into the clipboard.
+
+ + + + + + + + +retouch-paste-icon + + paste
+
Move the shapes on the clipboard to the currently-selected layer.
+
+ + + + + + + + +retouch-hide-icon + + temporarily switch off shapes
+
Toggle all shapes (whether on the current layer or not) on or off, temporarily removing the module’s effect.
+
+ + + + + + + + +retouch-mask-icon + + display masks
+
Show the target shapes associated with the currently-selected layer with a yellow overlay.
+
+

🔗shapes

+

This section allows you to modify settings related to the currently-selected shape:

+
+
shape selected
+
Indicates which shape is currently selected, and what type of shape it is.
+
fill mode
+
If the fill algorithm has been chosen for the currently-selected shape, choose whether to “erase” or fill the selected shape with a chosen “color”.
+
fill color
+
If a fill mode of “color” has been chosen, select the color to fill the shape with. You can click to select or enter a custom rgb value or use the picker to take a sample from the image.
+
brightness
+
If the fill algorithm has been chosen for the currently-selected shape, fine-tune the color’s brightness. This slider also works in “erase” mode.
+
blur type
+
If the blur algorithm has been chosen for the currently-selected shape, choose whether to apply a “gaussian” or “bilateral” blur.
+
blur radius
+
If the blur algorithm has been chosen for the currently-selected shape, choose the radius of the blur.
+
mask opacity
+
Alter the opacity of the mask associated with the currently-selected shape. An opacity of 1.0 indicates that the shape is completely opaque and the module’s effect is fully applied, whereas a value less than 1.0 indicates that the effect applied by the shape is blended with the underlying image to the degree indicated by the slider.
+
+

🔗panning and zooming the image

+

While creating or editing a shape, mouse actions are applied to the current shape. If you need to move or zoom the portion of the image shown in the center view, hold down the ‘a’ key while dragging the mouse or using the scroll wheel. While the key is held down, the mouse actions will apply to the entire image rather than the current shape. Holding down the key will also temporarily suppress generating new shapes in continuous-creation mode.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/retouch/rt-auto-levels-icon.png b/en/module-reference/processing-modules/retouch/rt-auto-levels-icon.png new file mode 100644 index 0000000000..82a68d9c72 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-auto-levels-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-beard-preserve.jpg b/en/module-reference/processing-modules/retouch/rt-beard-preserve.jpg new file mode 100644 index 0000000000..1e75d9a909 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-beard-preserve.jpg differ diff --git a/en/module-reference/processing-modules/retouch/rt-blur-icon.png b/en/module-reference/processing-modules/retouch/rt-blur-icon.png new file mode 100644 index 0000000000..a1fe402527 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-blur-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-clone-icon.png b/en/module-reference/processing-modules/retouch/rt-clone-icon.png new file mode 100644 index 0000000000..1a1cf55e8e Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-clone-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-clone-nocontrol.png b/en/module-reference/processing-modules/retouch/rt-clone-nocontrol.png new file mode 100644 index 0000000000..1095406d1d Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-clone-nocontrol.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-clone.png b/en/module-reference/processing-modules/retouch/rt-clone.png new file mode 100644 index 0000000000..30de9b3849 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-clone.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-cut-icon.png b/en/module-reference/processing-modules/retouch/rt-cut-icon.png new file mode 100644 index 0000000000..de628c384e Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-cut-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-display-icon.png b/en/module-reference/processing-modules/retouch/rt-display-icon.png new file mode 100644 index 0000000000..c2156684df Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-display-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-fill-icon.png b/en/module-reference/processing-modules/retouch/rt-fill-icon.png new file mode 100644 index 0000000000..f7b7a92f89 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-fill-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-heal-icon.png b/en/module-reference/processing-modules/retouch/rt-heal-icon.png new file mode 100644 index 0000000000..0c121f871c Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-heal-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-heal-nocontrol.png b/en/module-reference/processing-modules/retouch/rt-heal-nocontrol.png new file mode 100644 index 0000000000..b94ae644a3 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-heal-nocontrol.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-hide-icon.png b/en/module-reference/processing-modules/retouch/rt-hide-icon.png new file mode 100644 index 0000000000..6f6d313454 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-hide-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-mask-icon.png b/en/module-reference/processing-modules/retouch/rt-mask-icon.png new file mode 100644 index 0000000000..9d0dac523c Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-mask-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-original.png b/en/module-reference/processing-modules/retouch/rt-original.png new file mode 100644 index 0000000000..d0f230cec6 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-original.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-overview.png b/en/module-reference/processing-modules/retouch/rt-overview.png new file mode 100644 index 0000000000..b85bec16ec Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-overview.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-paste-icon.png b/en/module-reference/processing-modules/retouch/rt-paste-icon.png new file mode 100644 index 0000000000..c8de963899 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-paste-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-shapes-icon.png b/en/module-reference/processing-modules/retouch/rt-shapes-icon.png new file mode 100644 index 0000000000..8a0b54191f Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-shapes-icon.png differ diff --git a/en/module-reference/processing-modules/retouch/rt-source-cross.png b/en/module-reference/processing-modules/retouch/rt-source-cross.png new file mode 100644 index 0000000000..262ae52570 Binary files /dev/null and b/en/module-reference/processing-modules/retouch/rt-source-cross.png differ diff --git a/en/module-reference/processing-modules/rgb-curve/index.html b/en/module-reference/processing-modules/rgb-curve/index.html new file mode 100644 index 0000000000..4d4f10d43c --- /dev/null +++ b/en/module-reference/processing-modules/rgb-curve/index.html @@ -0,0 +1,3040 @@ + + + + + +darktable user manual - rgb curve + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / rgb curve + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ rgb curve +

+ + + +

A classic digital photography tool to alter an image’s tones using curves.

+

This module is very similar to the tone curve module but works in RGB color space.

+

Activate the picker on the left to show the picked values in the graph (Ctrl+click or right-click to use the picker in area mode). Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the widget.

+

A second picker to the right can be used to automtaically create new nodes based on the sampled area. Ctrl+click+drag to alter the created nodes to have a positive curve for the selected area; Shift+click+drag to create a negative curve.

+

🔗module controls

+

Please refer to the curves section for more details about how to modify curves including the interpolation method and preserve colors controls.

+
+
mode
+
RGB is a linear color space designed to capture and display images in additive synthesis. It is related to the capture and display media and does not isolate color and lightness information in the same way that Lab and XYZ color spaces do. This module works in ProPhoto RGB. Adding contrast in RGB space is known to desaturate highlights and boost saturation in the shadows, but this has been proven to be the most reliable way to edit contrast, and is the standard method in most software
+
+

Depending on the desired intent you can apply the RGB curve in two different modes

+
+
+
    +
  • RGB, linked channels: Apply the L-channel curve to all three channels in the RGB color space.
  • +
+
+
    +
  • RGB, independent channels: R, G and B curves can be adjusted independently.
  • +
+
+
compensate middle gray
+
Select this to change the histogram display in the module. This option does not alter the processing but may assist when editing the curve.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/rgb-levels/index.html b/en/module-reference/processing-modules/rgb-levels/index.html new file mode 100644 index 0000000000..36c4dd9a54 --- /dev/null +++ b/en/module-reference/processing-modules/rgb-levels/index.html @@ -0,0 +1,3033 @@ + + + + + +darktable user manual - rgb levels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / rgb levels + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ rgb levels +

+ + + +

Adjust black, white and mid-gray points in RGB color space. This module is silmilar to the levels module, which works in Lab color space.

+

The rgb levels tool shows a histogram of the image, and displays three bars with handles. Drag the handles to modify the black, middle-gray and white points in lightness (in “RGB, linked channels” mode) or independently for each of the R, G and B channels (in “RGB, independent channels” mode).

+

Moving the black and white bars to match the left and right borders of the histogram will make the output image span the full available tonal range. This will increase the image’s contrast.

+

Moving the middle bar will modify the mid-tones. Move it to the left to make the image look brighter and move it to the right to make it darker. This is often referred to as changing the image’s gamma.

+

Three pickers are available for sampling the black, white and gray points from the image.

+
+

Note: Under certain conditions, especially with highly saturated blue light sources, the levels module may produce black pixel artifacts. See the “gamut clipping” option of the input color profile module for information about how to mitigate this issue.

+
+

🔗module controls

+
+
mode
+
The mode of operation. “RGB, linked channels” (default) provides a single levels tool which updates all channels, taking into account the selected color preservation method (see “preserve colors” below). “RGB, independent channels” provides separate levels controls for each of the R, G and B channels.
+
auto
+
Auto-adjust the black and white point and put the gray point exactly in the mean between them. Use the picker to auto-adjust based on a selected region of the image.
+
preserve colors
+
Choose a color preservation method when using “RGB, linked channels” mode (default “luminance”).
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/rgb-primaries/index.html b/en/module-reference/processing-modules/rgb-primaries/index.html new file mode 100644 index 0000000000..37732a41ec --- /dev/null +++ b/en/module-reference/processing-modules/rgb-primaries/index.html @@ -0,0 +1,3038 @@ + + + + + +darktable user manual - rgb primaries + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / rgb primaries + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ rgb primaries +

+ + + +

Adjust the hue and purity of the RGB primary colors (i.e. which red, green and blue they represent), while leaving uncolored (gray) pixels unchanged. In addition to preserving gray pixels, the opponency relationships between the colors are also preserved under this adjustment: If you increase the purity of the blue primary, the opponent yellow’s intensity increases to balance things out; If you twist the blue hue toward cyan, the opponent yellow is twisted toward orange.

+

This module is essentially a channel mixer (as in the color calibration module) but with a different interface. Even though the sliders are named “red”, “green” and “blue”, all adjustments are global and affect the overall colorimetry of the image, just like a channel mixer does.

+

When applied before the filmic rgb or sigmoid tone mapping modules rgb primaries can be used to make small adjustments to colorimetry. When applied after the tone mapping modules it may be used to apply creative edits such as tinting.

+

🔗module controls

+
+
red hue
+
Shift red towards yellow (positive values) or magenta (negative values)
+
red purity
+
The purity of the red primary
+
green hue
+
Shift green towards cyan (positive values) or yellow (negative values)
+
green purity
+
The purity of the green primary
+
blue hue
+
Shift blue towards magenta (positive values) or cyan (negative values)
+
blue purity
+
The purity of the blue primary
+
tint hue
+
When applied after tone mapping, this control allows the gray (achromatic) parts of the image to be tinted. When applied before tone mapping, it acts like a white balance control.
+
tint purity
+
The purity of the tint that is applied to the image
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/rotate-perspective/icon-both.png b/en/module-reference/processing-modules/rotate-perspective/icon-both.png new file mode 100644 index 0000000000..3c2657fd53 Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/icon-both.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/icon-draw-structure-lines.png b/en/module-reference/processing-modules/rotate-perspective/icon-draw-structure-lines.png new file mode 100644 index 0000000000..5901fd0d0b Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/icon-draw-structure-lines.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/icon-draw-structure-rectangle.png b/en/module-reference/processing-modules/rotate-perspective/icon-draw-structure-rectangle.png new file mode 100644 index 0000000000..03ffe70bef Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/icon-draw-structure-rectangle.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/icon-get-structure.png b/en/module-reference/processing-modules/rotate-perspective/icon-get-structure.png new file mode 100644 index 0000000000..1997ab63fe Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/icon-get-structure.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/icon-horizontal.png b/en/module-reference/processing-modules/rotate-perspective/icon-horizontal.png new file mode 100644 index 0000000000..d8df7b957c Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/icon-horizontal.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/icon-vertical.png b/en/module-reference/processing-modules/rotate-perspective/icon-vertical.png new file mode 100644 index 0000000000..4779a1a20d Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/icon-vertical.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/index.html b/en/module-reference/processing-modules/rotate-perspective/index.html new file mode 100644 index 0000000000..83d69fa311 --- /dev/null +++ b/en/module-reference/processing-modules/rotate-perspective/index.html @@ -0,0 +1,3175 @@ + + + + + +darktable user manual - rotate and perspective + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / rotate and perspective + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ rotate and perspective +

+ + + +

Automatically correct for converging lines, a form of perspective distortion. The underlying mechanism is inspired by Markus Hebel’s ShiftN program. This module also allows for the rotation of the image to be adjusted.

+

Perspective distortions are a natural effect when projecting a three dimensional scene onto a two dimensional plane and cause objects close to the viewer to appear larger than objects further away. Converging lines are a special case of perspective distortions frequently seen in architectural photographs – parallel lines, when photographed at an angle, are transformed into converging lines that meet at some vantage point within or outside of the image frame.

+

This module is able to correct converging lines by warping the image in such a way that the lines in question become parallel to the image frame. Corrections can be applied in a vertical and horizontal direction, either separately or in combination. In order to perform automatic correction the module is able to analyze the image for suitable structural features consisting of line segments. You can also set the line structures manually by drawing a “perspective rectangle” or drawing multiple horizontal and vertical lines onto the image. Based on these (automatic or manually-drawn) line segments a fitting procedure is initiated, which determines the best values for the module’s parameters.

+

As the most common use case for this module is for rotation, the perspective correction controls are hidden by default. Click the “perspective” header to expand the controls.

+

While the module is active (and none of the structure buttons are selected) you can right-click and drag anywhere on the image to define a horizontal or vertical line. This will cause the rotation parameter to be automatically adjusted to make the drawn line horizontal/vertical with respect to the image frame.

+
+

Note: This functionality (right-click and drag to set horizontal/vertical) is also available when the module is inactive, as long as no other function (e.g. drawn mask creation) claims the right-hand mouse button.

+
+

🔗perspective correction workflow

+

🔗structure

+

The first step is to obtain details about the horizontal and/or vertical structures in the image. Three alternative methods are provided to do this:

+

🔗manually draw structure lines

+

Click on the + + + + + + + + +draw-structure-lines-icon + + icon to enable line drawing mode and then click-and-drag on the image to draw lines that you wish to become horizontal or vertical. The module will automatically detect whether the lines are horizontal or vertical and color them green or blue, respectively. Draw as many lines as you wish (the more lines, the better the fit mechanism will work) and then click on one of the “fit” icons to complete the process. You can re-enter this mode to edit your drawn lines at any time. Edit a line by clicking and dragging on the line or the end nodes, and right-click a line to delete it. Once you are happy with your changes, re-select a “fit” icon to complete the process.

+

🔗manually define a perspective rectangle

+

Click on the + + + + + + + + +draw-structure-rectangle-icon + +icon to enable perspective rectangle drawing mode. This will draw a rectangle on the screen and you can grab and move the corners of the rectangle so that the left and right sides fall on lines you wish to make vertical, and the top and bottom fall on lines you wish to make horizontal. Once you are happy with your rectangle, click one of the “fit” icons to complete the process. You can re-enter this mode to edit your drawn rectangle at any time. Once you are happy with your changes, re-select a “fit” icon to complete the process.

+

This method is similar to how “keystone” correction works in the crop and rotate module.

+

🔗automatically detect structure

+

Click the + + + + + + + + +get-structure-icon + + icon to analyze the image for structural elements – darktable will automatically detect and evaluate line elements. Shift+click to apply a contrast enhancement step before performing further analysis. Ctrl+click to apply an edge enhancement step before performing further analysis. Both variations can be used alone or in combination if the default analysis is not able to detect a sufficient number of lines.

+

Only lines that form a set of vertical or horizontal converging lines are used for subsequent processing steps. Line segments are displayed as overlays on the image canvas, with the type of line identified by color as follows:

+
+
green
+
Vertical converging lines
+
red
+
Vertical lines that do not converge
+
blue
+
Horizontal converging lines
+
yellow
+
Horizontal lines that do not converge
+
gray
+
Other lines that are not of interest to this module
+
+

Lines marked in red or yellow are regarded as outliers and are not taken into account during the automatic fitting step. This outlier elimination involves a statistical process using random sampling which means that each time you press the “get structure” button the color pattern of the lines will look slightly different.

+

You can manually change the status of line segments: Left-Click on a line to select it (turn the color to green or blue) and Right-click to deselect it (turn the color to red or yellow). If you keep the mouse button pressed, you can use a sweeping action to select/deselect multiple lines in a row. The size of the select/deselect brush can be changed with the mouse wheel. Hold down the Shift key and keep the left or right mouse button pressed while dragging to select or deselect all lines in the chosen rectangular area.

+

Once you are happy with the detected lines, select a “fit” icon to complete the process.

+

🔗fit

+

Once you are happy with the identified horizontal and vertical lines, using one of the methods above, click on one of the “fit” icons to automatically set the module’s parameters based on the defined structure. The image and the overlaid lines are then displayed with perspective corrections applied.

+

You may choose to automatically apply just the vertical corrections + + + + + + + + +vertical-icon + +, just the horizontal corrections + + + + + + + + +horizontal-icon + +, or both together + + + + + + + + +both-icon + +. Ctrl+click on any of the icons to apply a rotation without the lens shift. Shift+click on any of the icons to apply the lens shift without any rotation.

+

🔗rotate

+

Once you are happy with the applied perspective corrections, you may wish to perform a final rotation correction either by adjusting the rotation parameter or right-clicking and dragging the image to define a horizontal/vertical line.

+

🔗module controls

+
+
rotation
+
Control the rotation of the image around its center to correct for a skewed horizon. To rotate by more than the default soft limit of ten degrees, right click and enter the desired value up to 180 degrees (see module controls).
+
automatic cropping
+
When activated, this feature crops the image to remove any black areas at the edges caused by the distortion correction. You can either crop to the “largest area”, or to the largest rectangle that maintains the original aspect ratio (“original format”). In the latter case you can manually adjust the automatic cropping result by clicking in the clip region and moving it around. The size of the region is modified automatically to exclude any black areas.
+
lens shift (vertical)
+
Correct converging vertical lines (i.e. to make the green lines parallel). In some cases you can obtain a more natural looking image if you correct vertical distortions to an 80 ~ 90% level rather than to the maximum extent. To do this, reduce the correction slider after having performed the automatic correction.
+
lens shift (horizontal)
+
Correct converging horizontal lines (i.e. to make the blue lines parallel).
+
shear
+
Shear the image along one of its diagonals. This is required when correcting vertical and horizontal perspective distortions simultaneously.
+
lens model
+
This parameter controls the lens focal length, camera crop factor and aspect ratio that used by the correction algorithm. If set to “generic” a lens focal length of 28mm on a 35mm full-frame camera is assumed. If set to “specific”, the focal length and crop factor can be set manually using the sliders provided.
+
focal length
+
If the lens model is set to “specific”, set the lens focal length. The default value is taken from the image’s Exif data, and can be overridden by adjusting the slider manually.
+
crop factor
+
If the lens model is set to “specific”, set the camera crop factor. You will normally need to set this value manually.
+
aspect adjust
+
If the lens model is set to “specific”, this parameter allows for a free manual adjustment of the image’s aspect ratio. This is useful for “unsqueezing” images taken with an anamorphic lens (which changes the ratio of image height to width).
+
structure
+
Define horizontal and vertical lines in the image using a manual or automatic method (see workflow section for details).
+
fit
+
Set the distortion correction sliders automatically based on the identified structure (see workflow section for details).
+
show guides
+
Tick the box to show guide overlays whenever the module is activated. Click the icon on the right to control the properties of the guides. See guides & overlays for details.
+
+

🔗examples

+

Here is an image with a skewed horizon and converging lines caused by directing the camera upwards:

+

+ + + + + + + + +prespective-correction-example-before + +

+

Here is the image after having corrected for vertical and horizontal perspective distortions using automatic structure detection. Note the framing adjustment made by the automatic cropping feature and the still-visible overlay of structural lines:

+

+ + + + + + + + +prespective-correction-example-after + +

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/rotate-perspective/perspective-correction-example-after.png b/en/module-reference/processing-modules/rotate-perspective/perspective-correction-example-after.png new file mode 100644 index 0000000000..36dc031674 Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/perspective-correction-example-after.png differ diff --git a/en/module-reference/processing-modules/rotate-perspective/perspective-correction-example-before.png b/en/module-reference/processing-modules/rotate-perspective/perspective-correction-example-before.png new file mode 100644 index 0000000000..5d91b2b9f9 Binary files /dev/null and b/en/module-reference/processing-modules/rotate-perspective/perspective-correction-example-before.png differ diff --git a/en/module-reference/processing-modules/rotate-pixels/index.html b/en/module-reference/processing-modules/rotate-pixels/index.html new file mode 100644 index 0000000000..240991957c --- /dev/null +++ b/en/module-reference/processing-modules/rotate-pixels/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - rotate pixels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / rotate pixels + +
+ + + + +
+ +

+ rotate pixels +

+ + + +

The sensors of some cameras (such as the Fujifilm FinePix S2Pro, F700, and E550) have a diagonally oriented Bayer pattern instead of the usual orthogonal layout.

+

Without correction this would lead to a tilted image with black corners. This module applies the required rotation.

+

darktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled.

+

The module has no controls.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/scale-pixels/index.html b/en/module-reference/processing-modules/scale-pixels/index.html new file mode 100644 index 0000000000..d1a32e374e --- /dev/null +++ b/en/module-reference/processing-modules/scale-pixels/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - scale pixels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / scale pixels + +
+ + + + +
+ +

+ scale pixels +

+ + + +

Some cameras (such as the Nikon D1X) have rectangular instead of the usual square sensor cells. Without correction this would lead to distorted images. This module applies the required scaling.

+

darktable detects images that need correction using their Exif data and automatically activates this module where required. For other images the module always remains disabled.

+

The module has no controls.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/shadows-and-highlights/index.html b/en/module-reference/processing-modules/shadows-and-highlights/index.html new file mode 100644 index 0000000000..6179f14bc2 --- /dev/null +++ b/en/module-reference/processing-modules/shadows-and-highlights/index.html @@ -0,0 +1,3039 @@ + + + + + +darktable user manual - shadows and highlights + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / shadows and highlights + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ shadows and highlights +

+ + + +

Modify the tonal range of the shadows and highlights of an image by enhancing local contrast.

+
+

Note: This module performs blurs in Lab color space, which can result in a number of issues when the parameters are pushed hard, including halos, high local contrast in highlights, and hue shifts towards blue in the shadows. You are advised to use the tone equalizer module instead.

+
+

🔗module controls

+
+
shadows
+
Control the effect on shadows. Positive values will lighten shadows while negative values will darken them.
+
highlights
+
Control the effect on highlights. Positive values will lighten highlights while negative values will darken them.
+
white point adjustment
+
By default the algorithm of this module leaves the black and white points untouched. In some cases an image might contain tonal variations beyond the white point, i.e. above a luminance value of 100. A negative shift in the white point adjustment can bring these values back into the proper range so that further details in the highlights become visible.
+
soften with
+
The underlying blurring filter: gaussian or bilateral. Try the bilateral filter if the gaussian blur generates halos.
+
radius
+
The radius of the blurring filter used by the algorithm. Higher values give softer transitions between shadows and highlights but might introduce halos. Lower values will reduce the size of halos but may lead to an artificial look. The bilateral filter is much less prone to halo artifacts.
+
compress
+
Control how strongly the effect extends to the mid-tones. High values limit the effect to only the extreme shadows and highlights. Lower values also cause adjustments to the mid-tones. At 100% this module has no visible effect as only absolute black and absolute white are affected.
+
shadows color adjustment
+
Control the color saturation adjustment made to shadows. High values cause saturation enhancements on lightened shadows. Low values cause desaturation on lightened shadows. It is normally safe to leave this at its default of 100%. This gives a natural saturation boost on shadows – similar to what you would expect in nature if shadows were to receive more light.
+
highlights color adjustment
+
Control the color saturation adjustment made to highlights. High values cause saturation enhancements on darkened highlights. Low values cause desaturation on darkened highlights. Often highlights do not contain enough color information to give convincing colors when darkened. You might need to adjust this parameter in order to find the best fitting value depending on your specific image, but be aware that sometimes the results might not be fully satisfying.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/sharpen/index.html b/en/module-reference/processing-modules/sharpen/index.html new file mode 100644 index 0000000000..2fd0cd25e7 --- /dev/null +++ b/en/module-reference/processing-modules/sharpen/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - sharpen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / sharpen + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ sharpen +

+ + + +

Sharpen the details in the image using a standard UnSharp Mask (USM).

+

This module works by increasing the contrast around edges and thereby enhancing the impression of sharpness of an image. This module is applied to the L channel in Lab color space.

+
+

Note: The USM algorithm used in this module performs blurs in Lab color space, which can produce undesirable effects, and is no longer recommended. Instead use the presets offered by the contrast equalizer module for deblurring or the local contrast module for general sharpness.

+
+

🔗module controls

+
+
radius
+
The unsharp mask applies a gaussian blur to the image as part of its algorithm. This parameter controls the radius of that blur which, in turn, defines the spatial extent of the edge enhancement. Very high values will lead to ugly over-sharpening.
+
amount
+
The strength of the sharpening.
+
threshold
+
Contrast differences below this threshold are excluded from sharpening. Use this to avoid amplification of noise.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/sigmoid/index.html b/en/module-reference/processing-modules/sigmoid/index.html new file mode 100644 index 0000000000..282d4b7efd --- /dev/null +++ b/en/module-reference/processing-modules/sigmoid/index.html @@ -0,0 +1,3075 @@ + + + + + +darktable user manual - sigmoid + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / sigmoid + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ sigmoid +

+ + + +

Remap the tonal range of an image using a modified generalized log-logistic curve.

+

This module can be used to expand or contract the dynamic range of the scene to fit the dynamic range of the display.

+
+

Note: Modules placed before sigmoid in the pipeline operate in scene-referred space. Modules after sigmoid work in display-referred space.

+
+

🔗usage

+

Please take note of the following guidelines while using this module within your workflow:

+
+
only use one display transform
+
Never use sigmoid together with another display transform module (i.e. filmic rgb or base curve).
+
adjust for the mid-tones first
+
The sigmoid curve pivots around middle gray. Before using sigmoid, you should first use the exposure module to adjust the mid-tones to your liking.
+
less is more
+
You should try to accomplish the majority of your processing using modules in the scene-referred section of the pixelpipe and not rely on the display transform module (sigmoid, filmic rgb, base curve) to do all the work.
+
preserve hue to taste
+
This module provides a number of methods to preserve hues. You are advised to use the “per channel” mode and tune the hue preservation to your liking on a per-image basis. Sunsets and fire are two examples where users commonly reduce the hue preservation to achieve a “hotter” look.
+
keep skew at bay
+
For images like portraits, it is best to refrain from using skew values above zero. This way you will avoid harsh transitions in the skin tones. This is particularly important when hue preservation is not enabled, as the skew also affects the hue path of the skin tones.
+
+

🔗module controls

+
+
contrast
+
Adjust the aggressiveness of the compression while leaving middle-gray unchanged. Higher values require lower exposure to reach display white, and shadows become darker. Lower contrast is able to display a larger dynamic range.
+
skew
+
Lean the compression towards shadows or highlights. Skew can be used to transfer some contrast from shadows to highlights or vice versa without changing the amount of contrast at middle gray. Positive skew flattens shadows and compresses highlights. Negative skew creates darker shadows and duller highlights.
+
color processing
+
The mode used to map pixel values from scene to display space.
+
    +
  • per channel mode applies the sigmoid curve to each rgb channel separately, affecting luminance, chroma, and hue. Hue can be optionally preserved using the preserve hue option (below). This mode is in line with the behavior of the color layers in analog film, and handles smooth roll-off to bright areas very well.
  • +
+
+
    +
  • rgb ratio is similar to preserve color in filmic rgb. It maps the rgb triplet uniformly using the sigmoid curve, which preserves the spectral color of the pixel. Bright colorful pixels are desaturated along spectral lines as they would otherwise end up outside the display gamut.
  • +
+
+
preserve hue (per channel mode only)
+
Choose how much to preserve hue – 100% preserves the spectral hue of the image (identical to using the “rgb ratio” color processing mode); 0% uses the per-channel mode with heavy hue skewing (see below). An acceptable approximation of preserved perceptual hue is usually somewhere between the two extremes.
+
All colors that lie between the primary colors (red, green, and blue) converge towards the closest secondary colors (yellow, magenta, and cyan). The per channel hue skew effect creates yellow sunsets and fires, magenta-looking blue lights, and cyan skies. The skew is stronger for brighter and more saturated pixels.
+
target black
+
Lower bound that the sigmoid curve converges to as the scene value approaches zero – this should normally be left unchanged. You can use this to give a faded analog look, but should instead prefer to use the “global offset” slider in color balance rgb to achieve a similar effect.
+
target white
+
Upper bound that the sigmoid curve converges to as the scene value approaches infinity – this should normally be left unchanged. You can use this to clip white at a defined scene intensity.
+
+

🔗primaries

+

Expand this section to set custom primaries. You are advised to use the “smooth” preset as a starting point and then adjust using the following controls:

+
+

Note: These settings apply only to the per channel processing mode.

+
+
+
base primaries
+
Choose the set of primaries to use as the base for adjustments. This is a bit like locally overriding the working profile, and is necessary to allow presets to be created that don’t change even if the user amends the working profile used in the pixel pipeline.
+
red/green/blue attenuation
+
Attenuate (decrease) the purity of the red, green or blue primaries before the signal is processed through sigmoid’s per-channel curves. An important consequence is that now even the brightest and most pure inputs get smoothly degraded to achromatic at the high end. This avoids posterization and flat-looking patches, which are often seen with, for example, blue LED lights.
+
red/green/blue rotation
+
Rotate the primaries where the per-channel curves are applied. This affects the hue paths when approaching white in the high end. These controls should not normally need large adjustments from the starting values given in the “smooth” preset.
+
recover purity
+
Recover some of the original purity. A value of 100 causes all of the attenuations to be restored after the per-channel process is done. This lands the middle range values near their original purities. A value of 0 doesn’t restore the purity at all, so the more you apply attenuation, the less purity there is in the final picture. The rotations are always restored regardless of the value of this slider. When this slider is at 0, the output of the module is guaranteed to remain within the gamut footprint of the chosen base primaries.
+
+

Bear in mind that unlike the rgb primaries module, this is not a tool for creative color grading but rather a set of controls to provide a reasonable starting point for further edits. The effect of these adjustments is not the same as the rgb primaries module even though the interface looks similar.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/soften/index.html b/en/module-reference/processing-modules/soften/index.html new file mode 100644 index 0000000000..df63aa1b35 --- /dev/null +++ b/en/module-reference/processing-modules/soften/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - soften + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / soften + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ soften +

+ + + +

Create a softened image using the Orton effect.

+

Michael Orton achieved his results on slide film by using two exposures of the same scene, one well exposed and one overexposed. He then used a darkroom technique to blend these two images into a final image where the overexposed image was blurred.

+

This module is a near-copy of Orton’s analog process into the digital domain.

+

🔗module controls

+
+
size
+
The size of blur of the overexposed image. The bigger the size, the softer the result.
+
saturation
+
The saturation of the overexposed image.
+
brightness
+
The brightness (EV) of the overexposed image.
+
mix
+
How the two images are mixed. 50% represents an equal mix of the well exposed and overexposed images.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/split-toning/index.html b/en/module-reference/processing-modules/split-toning/index.html new file mode 100644 index 0000000000..98e89aa93e --- /dev/null +++ b/en/module-reference/processing-modules/split-toning/index.html @@ -0,0 +1,3027 @@ + + + + + +darktable user manual - split-toning + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / split-toning + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ split-toning +

+ + + +

Create a two color linear toning effect where the shadows and highlights are represented by two different colors.

+

The split-toning module does not convert images to black and white and has limited benefits on color images. In order to perform traditional split-toning, the input to this module should therefore be monochrome.

+

🔗module controls

+
+
shadows and highlights color
+
Set the desired hue and saturation for both shadows and highlights. Clicking on the colored squares will open a color selector dialog which offers you a choice of commonly used colors, or allows you to define a color in RGB color space.
+
balance
+
The ratio of toning between shadows and highlights. When set to 50%, half of the lightness range in image is used for shadows toning and the other half for highlights toning.
+
compress
+
The percentage of total (mid-tone) lightness range that is not affected by color toning. This compresses the effect on the shadows and highlights while preserving the mid-tones.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/spot-removal/index.html b/en/module-reference/processing-modules/spot-removal/index.html new file mode 100644 index 0000000000..2d02e057e9 --- /dev/null +++ b/en/module-reference/processing-modules/spot-removal/index.html @@ -0,0 +1,3033 @@ + + + + + +darktable user manual - (deprecated) spot removal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) spot removal + +
+ + + + +
+ +

+ (deprecated) spot removal +

+ + + +
+

Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the “cloning” tool in the retouch module instead.

+
+

Correct areas of an image (the target) using details from another area of the image (the source).

+

This module uses some of the shapes that are available for drawn masks (circles, ellipses and paths), and the user interface is similar.

+

To use this module, first select the desired shape by clicking the corresponding shape icon (Ctrl+click to enable continuous shape creation mode). Next, you may optionally choose the source for the correction by using Shift+Ctrl+click or Shift+click on the image canvas to choose absolute or relative mode, respectively (see below). Finally click on the canvas to choose the area to be healed (the target area). A cross is displayed where the source area will be positioned.

+

The source positioning has two modes

+
+
absolute mode
+
Before placing a shape on the image canvas, Shift+Ctrl+click on the desired position for the source. From this point on, all new shapes will have their source created at the same absolute position (in image co-ordinates).
+
relative mode
+
Before placing a shape on the image canvas, Shift+click on the desired position for the source. The current shape will have the source created at that position and subsequent shapes will have their source created at the same position, relative to the target shape.
+
+

After creation the source and target areas of each shape can be shifted independently until the result matches your expectations. An arrow points from the source area of each shape to its target.

+

Use the shape-specific controls to adjust each shape’s size, border width, and other attributes.

+

Right-click on a shape to delete it.

+

This module is equivalent to the “cloning” tool in the retouch module; see the description of the cloning tool for additional details and examples. If spot removal produces unsatisfactory results, you may want to try the “heal” tool in retouch instead.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/surface-blur/index.html b/en/module-reference/processing-modules/surface-blur/index.html new file mode 100644 index 0000000000..5908e1eb5b --- /dev/null +++ b/en/module-reference/processing-modules/surface-blur/index.html @@ -0,0 +1,3029 @@ + + + + + +darktable user manual - surface blur + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / surface blur + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ surface blur +

+ + + +

Smooth image surfaces while preserving sharp edges using a bilateral filter.

+

This module can be used to denoise images, however you should be aware that bilateral filters are susceptible to overshoots and darktable offers much better alternatives. For example, the astrophoto denoise module uses a non-local means denoising algorithm, and the denoise (profiled) module provides a choice between non-local means and wavelet denoising algorithms.

+

The surface blur module blurs noise within the surfaces of an image by averaging pixels with their neighbors, taking into account not only their geometric distance but also their distance on the range scale (i.e. differences in their RGB values). It can be particularly useful if one RGB channel is more noisy/needs more smoothing than the others. In such a case, use the color calibration module to examine the channels one by one, in order to set the blur intensities accordingly.

+

In chromaticity blending mode, this module can be used to reduce the appearance of color moire resulting from fine repeated patterns on the object being photographed. You will likely need to increase the values of the Red, Green, and Blue sliders from their defaults for optimal effectiveness.

+

The module can also be used as a creative filter to provide interesting effects, for example to lend an image a cartoon-like appearance. When used with chrominance blending, it can also be used to even out the color of a surface (for example, to remove skin redness).

+

This module is resource-intensive and slows down pixelpipe processing significantly. You should consider activating it late in your workflow.

+

🔗module controls

+
+
radius
+
The spatial extent of the gaussian blur.
+
red, green, blue
+
The blur intensity for each of the RGB channels.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/tone-curve/index.html b/en/module-reference/processing-modules/tone-curve/index.html new file mode 100644 index 0000000000..0fec63c3dd --- /dev/null +++ b/en/module-reference/processing-modules/tone-curve/index.html @@ -0,0 +1,3056 @@ + + + + + +darktable user manual - tone curve + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / tone curve + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ tone curve +

+ + + +

A classic digital photography tool to alter the tones of an image’s using curves.

+

This module is very similar to the rgb curve module but works in Lab color space.

+

Activate the picker to show the picked values on the displayed histogram. Numerical (Lab) values of the input and output (see below) at the selected spot or area are shown at the top left of the graph.

+

🔗module controls

+

Please refer to the curves section for more details about how to modify curves including the interpolation method, scale for graph and preserve colors controls.

+
+
color spaces
+
Depending on the desired intent, the tone curve can be applied in one of three color spaces:
+
+
    +
  • Lab (linked or separated channels): Lab is a perceptual color space that is designed to approximate the way humans perceive colors and lightness. It represents color information independently of lightness. In “Lab, separated channels” mode, you are given fully independent control over the luminance (L-channel) and the chrominance (a/b-channels). In “Lab, linked channels” mode, only the luminance (L-channel) control is available. The color saturation correction is automatically computed, for each pixel, from the contrast correction applied to the luminance channel. This works better in cases where a subtle contrast correction is applied, but gives increasingly inaccurate saturation correction as the contrast is more dramatically altered.
  • +
+
+
+
    +
  • XYZ (linked channels): XYZ is a linear technical color space designed to link the physiological light response of the human eye to RGB color spaces. As with Lab, it separates lightness from color information, but does so in a way that does not account for the role of the brain’s correction in human perception. The “XYZ, linked channels” mode offers an alternative to “Lab, linked channels”, and works by applying the L-channel curve to all three channels in the XYZ color space. Look at blend mode “coloradjustment” if you want to tune the strength of automatic chroma scaling. This mode is known to produce a slight hue shift towards yellow.
  • +
+
+
+
    +
  • RGB (linked channels): RGB is a linear color space designed to capture and display images in additive synthesis. It is related to capture and display media and does not isolate color and lightness information. The “RGB, linked channels” mode works in ProPhoto RGB and applies the L-channel curve to all three channels in the RGB color space. Adding contrast in RGB space is known to desaturate highlights and boost saturation in the shadows, but this has proven to be the most reliable way to edit contrast, and is the standard method used in most software. This mode makes the tone curve module behave in much the same way as the base-curve module, except that the latter works in camera RGB space.
  • +
+
+
+

Note that the module works in Lab color space in all cases. This means that the middle-gray coordinate is always 50% in the graph, no matter what color space is used. The same applies to the inset histogram displayed in the background of the curve. The controls are converted to the relevant color space before the corrections are applied – in RGB and XYZ, the middle-gray is therefore remapped from 50% to 18%.

+
+
L-channel curve
+
The tone curve in L-channel works on Lightness. To provide a better overview, a lightness histogram is displayed in the module. When working in one of the “linked channels” modes, the L-channel curve is the only one available.
+
+

The horizontal axis represents the lightness of the input image pixels. The vertical axis represents the lightness of the output image pixels. The default straight diagonal line does not change anything. A curve above the default diagonal increases the lightness, whereas a curve below decreases it. An S-like curve will enhance the contrast of the image. You can move the end-points of the default diagonal to change the black and white points and hence alter the overall contrast – this has the same effect as changing the black and white points in the levels module.

+
+
a/b-channel curves
+
The curves in the a and b channels work on color values and are available only in the “Lab, separated channels” mode. The horizontal axis represents the color channel value of the input image pixels. The vertical axis represents the color channel value of the output image pixels. Positive a-values correspond to more magenta colors; negative a-values correspond to more greenish colors. Positive b-values correspond to more yellowish colors; negative b-values correspond to more blueish colors.
+
+

The default diagonal straight line does not change anything. Shifting the center of the curve will give the image a color tint: shifting the a-channel upwards gives a magenta tint; shifting the b-channel upwards gives a yellow tint; shifting the a-channel downwards gives a green tint; shifting the b-channel downwards gives a blue tint.

+
+
+

Increasing/decreasing the steepness of a curve, without shifting its center, will increase/decrease the color saturation of the respective channel. With properly defined curves you can exert fine control on color saturation, depending on the input pixel’s colors.

+
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/tone-equalizer/index.html b/en/module-reference/processing-modules/tone-equalizer/index.html new file mode 100644 index 0000000000..488fa2e062 --- /dev/null +++ b/en/module-reference/processing-modules/tone-equalizer/index.html @@ -0,0 +1,3137 @@ + + + + + +darktable user manual - tone equalizer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / tone equalizer + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ tone equalizer +

+ + + +

Dodge and burn while preserving local contrast.

+

When used together with filmic rgb, this module replaces the need for other tone-mapping modules such as the base curve, shadows and highlights, tone curve and zone system (deprecated) modules. It works in linear RGB space and utilizes a user-defined mask to guide the dodging and burning adjustments, helping to preserve local contrast within the image.

+

The following diagram describes how the tone equalizer works:

+

+ + + + + + + + +tone-equalizer-mask + +

+
    +
  1. +

    Create a monochrome guided mask that divides the input image into regions of similar luminosity. The resulting mask should blur the fine details within the image so that pixels within each region are all treated similarly, preserving local contrast.

    +
  2. +
  3. +

    Adjust the sliders in the simple tab or the equalizer graph in the advanced tab to alter the brightness of the underlying image, based on the brightness of the mask. Exposure can also be adjusted by scrolling with the mouse while hovering the cursor over the preview image (see cursor indicator/control for details).

    +

    In the simple tab, each slider corresponds to a single brightness zone (EV) in the mask, which can be raised or lowered to adjust the exposure of the image where the mask’s brightness lies in that zone. Similarly, in the equalizer tab, the horizontal axis of the graph corresponds to the brightness level of the mask, and the vertical axis specifies the required exposure adjustment to pixels where the mask matches that brightness level.

    +
  4. +
  5. +

    The exposure of each pixel of the input image is adjusted using the mask and the equalizer graph. For each pixel, the module looks up the brightness of the mask at that point, finds the matching brightness on the horizontal axis of the equalizer graph, and increases or decreases the exposure accordingly (using the vertical axis of the graph).

    +
  6. +
+

It is important that the mask separates the image into regions of similar brightness, and that a suitable amount of blur is applied within those regions. This means that all of the pixels in each region will have their exposure adjusted similarly, without adversely affecting local contrast. Examine your image beforehand to identify which regions you wish to dodge and burn, and use the controls on the masking tab to ensure that those areas are reasonably separated in tone within the final mask. This will allow those regions to be adjusted independently.

+

🔗module controls

+

The controls of the tone equalizer module are divided between three tabs.

+
+
display exposure mask
+
Click on the icon to the right of this label to show/hide the module’s guided mask over the top of the image. This control is available in all three tabs.
+
+

🔗simple tab

+

This tab splits the brightness of the guided mask into nine zones (from –8 to 0 EV) and allows you to alter each zone independently. This is a simplified interface and is used to generate the same tone adjustment curve as shown in the advanced tab.

+
+
–8 EV … 0 EV
+
Each slider adjusts the exposure of all pixels where the guided mask has the given brightness. If the mask’s histogram is evenly spread over the entire tonal range, sliders towards the top generally affect the shadows, whereas sliders towards the bottom generally affect the highlights. You can check the spread of the histogram within the advanced tab.
+
+

🔗advanced tab

+

This tab allows you to control the same intensity levels as in the simple tab, though here they are represented as control points on a curve. Behind the curve is a histogram representing the intensity levels of the guided mask (not the underlying image). If the histogram is too bunched up, this means your mask doesn’t have a good spread of intensity levels, which makes it harder to independently control the brightness of the different parts of your image. It is therefore recommended that the histogram be adjusted so that it extends the entire range, covering as many control points as possible for maximum flexibility. You can adjust the mask using the controls in the masking tab.

+

Click+drag the control points on the curve to adjust the brightness of all pixels where the mask has the given intensity. If the mask’s histogram is evenly spread over the entire tonal range, control points to the left will generally affect the shadows, and control points to the right will generally affect the highlights. Moving a single control point will also affect control points on either side to ensure the curve remains smooth. This behaviour can be adjusted using the curve smoothing control.

+
+
curve smoothing
+
Control how the curve is interpolated between control points. Move the slider to the right to make the transitions between the control points more gradual, but beware that going past about 0.6 can introduce some instability (oscillations) in the curve due to mathematical constraints. Move the slider to the left for a more well-behaved curve, but beware that this can result in harsher tonal transitions that may damage local contrast.
+
+

🔗masking tab

+

This tab contains controls for adjusting the guided mask.

+

The purpose of the guided mask is to separate out areas with different tonal ranges so that they can be independently brightened or darkened by the tone equalizer. The masking filters are designed to allow sharp edges between these areas to be preserved, while blurring details within a given tonal range, so that the brightness can be adjusted without adversely impacting local contrast. Ideally the mask histogram shown in the advanced tab should be spread out across all of the control points.

+

To avoid having to switch back and forth between the advanced and masking tabs, a gray bar under the “mask post processing” label displays a representation of the middle 80% of the histogram. By using the controls in this tab to center and spread out this gray bar, you can expect to have a nicely shaped histogram when you return to the “advanced” tab. If you see orange at either end of the gray bar, this means that part of the histogram is outside of the 9 EV range of the mask, and needs to be further adjusted.

+

+ + + + + + + + +tone-equalizer-mask-histogram + +

+

When setting up the guided mask you will need to strike a balance between obtaining a smooth blur within tonal regions (to preserve local contrast) and preservation of the boundaries between those regions. Some experimentation will be required to find the best settings. Often the key controls to adjust are the exposure/contrast compensation sliders at the bottom of the module.

+

Displaying the guided mask while making these adjustments will help you to understand these controls and better judge the quality of the mask.

+
+
luminance estimator
+
Choose the method by which the luminance of a pixel will be estimated when mapping it to a mask intensity value (default RGB euclidean norm).
+
preserve details
+
Choose the smoothing algorithm used to blur the mask:
+
+
    +
  • no: Do not smooth the mask (the effect is the same as using normal tone curves). When the module is used to compress dynamic range, this option can cause compression of local contrast. This can be useful when increasing (local and global) contrast.
  • +
  • guided filter: Use the original guided filter algorithm to blur the mask while attempting to preserve edges. One of the limitations of this algorithm is that the guided filter is exposure-sensitive, meaning that shadows tend to be blurred more than highlights. Note that this limitation can sometimes be an asset: if one wants to lighten shadows a lot, the guided filter can provide very good local contrast preservation.
  • +
  • average guided filter: Use this option in cases where the effect of the guided filter is too strong. In this mode, a geometric mean is taken between the output of the original guided filter algorithm and the output given by the no option.
  • +
  • eigf (default): The exposure-independent guided filter solves the problem of the original guided filter, in that it makes the degree of blurring independent of the exposure. This means the degree of blurring applied to the highlights and the shadows regions should be about the same. This improved algorithm is now the default option.
  • +
  • averaged eigf: This option takes the geometric mean between the eigf mask and the mask generated by the no option, and is useful in cases where the degree of blurring in the mask needs to be mitigated.
  • +
+
+
filter diffusion
+
By default this is set to a value of 1, meaning that the filtering algorithm is run once on the input image to produce the blurred monochrome mask.
+
+

If you increase this to 2, the filtering algorithm will be run once on the input image to produce an intermediate mask, and then a second time on the intermediate mask. As a result, the final mask will be more blurred than when using a single iteration. Progressively higher values will diffuse the mask even further. However, because the mask filtering algorithm is run multiple times, each iteration will increase the processing time.

+
+
smoothing diameter
+
This controls how much of the surrounding image to take into account when calculating the mask’s blur at a particular point, defined as a percentage of the length of the image’s longer side (default 5%). With lower values, the transition between darker and lighter areas of the mask will be more pronounced. As the value is increased, transitions become smoother/softer. For the default exposure-independent guided filter (eigf), you should typically use blurring radii around 1-10%. With the original guided filter, blurring radii around 1-25% will typically yield better results.
+
edges refinement/feathering
+
Higher values force the mask to follow high contrast edges more closely. Lower values give smoother gradients, but may introduce halos. If required, feathering can be set to values as high as 10,000.
+
mask post-processing
+
This bar provides a representation of the current span of the mask’s histogram. It covers the middle 80% of the histogram, dropping the first and last decile to prevent outliers from skewing the indicator too much. Orange indicators at either end mean that the histogram exceeds the upper or lower bounds of its 9 EV range.
+
mask quantization
+
Apply a degree of posterization to the mask, so that it tends to centre round a few discrete levels. In some cases, this may be useful to help separate out areas of your image into distinct masking levels.
+
mask exposure compensation
+
Adjust the mask’s histogram to the left or right. If you have used the exposure module to adjust the image brightness, you may need to offset that adjustment by using this slider to re-centre the mask’s histogram. Click on the wand icon to the right of the slider to set the exposure compensation such that the average of the mask’s histogram will coincide with the central –4EV control point. The slider can then be fine-tuned as required.
+
mask contrast compensation
+
Dilate (spread out) or compress the mask’s histogram. The wand icon to the right of the slider will propose a reasonable starting point, which can then be fine-tuned to optimize the spread of the histogram under the tone equalizer control points.
+
+

🔗cursor indicator/control

+

When the tone equalizer module is enabled and expanded, you can move the mouse pointer over the preview image to show a cursor that displays information about the pixel under the pointer. When this cursor is shown, the mouse wheel can be used to brighten or darken the areas of your image that match the mask intensity level at that point. This provides a convenient way to quickly brighten or darken specific parts of the image.

+

+ + + + + + + + +tone-equalizer-simple + +

+
    +
  • the cross-hairs indicate the position of the pixel under the cursor
  • +
  • the text label shows the intensity of the guided mask at that point, in EV
  • +
  • the shade of the outer circle indicates the intensity of the mask at that point
  • +
  • if the tone equalizer has brightened or darkened pixels matching this mask intensity, the magnitude of the adjustment is indicated by an arc on the left-hand-side. The longer the arc, the greater the brightness adjustment,
  • +
  • if there has been an exposure adjustment, the shade of the inner circle indicates the amount of brightening or darkening, relative to the mask’s intensity at that point (as indicated by the outer gray circle). That is to say, if the pixel under the crosshairs has been brightened, the inner circle will be a lighter shade of gray than the outer circle; if the pixel has been darkened, the inner circle will be a darker shade of gray than the outer circle.
  • +
+

If you need to move or zoom the portion of the image shown in the center view while the module is expanded, hold down the ‘a’ key while dragging the mouse or using the scroll wheel. As long as the key is held down, mouse actions adjust the viewport rather than adjusting the tone curve.

+

🔗presets

+

The tone equalizer comes with several presets that can use used to compress shadows and highlights. Each comes in two variants, using either the guided filter (gf) or the exposure-independent guided filter (eigf). The variants using the guided filter tend to preserve local contrast in the shadows better those that use the exposure-independent guided filter, but at the price of reducing the local contrast in the highlights. Either of these variants may lead to better results, depending on the image. In both cases, the presets preserve middle-gray, so you shouldn’t need to adjust the global exposure after activating the tone equalizer.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-cursor.png b/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-cursor.png new file mode 100644 index 0000000000..6c77569154 Binary files /dev/null and b/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-cursor.png differ diff --git a/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-mask-histogram.png b/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-mask-histogram.png new file mode 100644 index 0000000000..8ac6de43d8 Binary files /dev/null and b/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-mask-histogram.png differ diff --git a/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-overview.png b/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-overview.png new file mode 100644 index 0000000000..3118f2dac4 Binary files /dev/null and b/en/module-reference/processing-modules/tone-equalizer/tone-equalizer-overview.png differ diff --git a/en/module-reference/processing-modules/tone-mapping/index.html b/en/module-reference/processing-modules/tone-mapping/index.html new file mode 100644 index 0000000000..1946dac35e --- /dev/null +++ b/en/module-reference/processing-modules/tone-mapping/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - (deprecated) tone mapping + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) tone mapping + +
+ + + + +
+ +

+ (deprecated) tone mapping +

+ + + +
+

Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer module instead.

+
+

Compress the tonal range of HDR images so that they fit into the limits of an LDR image, using Durand’s 2002 algorithm.

+

The underlying algorithm uses a bilateral filter to decompose an image into a coarse base layer and a detail layer. The contrast of the base layer is compressed, while the detail layer is preserved, then both layers are re-combined.

+

🔗module controls

+
+
contrast compression
+
The contrast compression level of the base layer. A higher compression will make the image fit a lower dynamic range.
+
spatial extent
+
The spatial extent of the bilateral filter. Lower values cause the contrast compression to have stronger effects on image details.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/unbreak-input-profile/index.html b/en/module-reference/processing-modules/unbreak-input-profile/index.html new file mode 100644 index 0000000000..b2920fab1c --- /dev/null +++ b/en/module-reference/processing-modules/unbreak-input-profile/index.html @@ -0,0 +1,3025 @@ + + + + + +darktable user manual - unbreak input profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / unbreak input profile + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ unbreak input profile +

+ + + +

Add a correction curve to image data. This is required if you have selected certain input profiles in the input color profile module.

+

If you decide to use an ICC profile from the camera manufacturer in the input color profile module, a correction curve frequently needs to be pre-applied to image data to prevent the final output from looking too dark. This extra processing is not required if you use darktable’s standard or enhanced color matrices.

+

The correction curve is defined with a linear part extending from the shadows to some upper limit and a gamma curve covering mid-tones and highlights. For further information please see darktable’s neighboring project UFRaw.

+
+
linear
+
The upper limit for the region counted as shadows and where no gamma correction is performed. Typically values between 0.0 and 0.1 are required by the profile.
+
gamma
+
The gamma value required to compensate the input profile. Often the required value is 0.45 (the reciprocal of the 2.2 gamma used by some manufacturer’s profiles).
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/velvia/index.html b/en/module-reference/processing-modules/velvia/index.html new file mode 100644 index 0000000000..267d546740 --- /dev/null +++ b/en/module-reference/processing-modules/velvia/index.html @@ -0,0 +1,3027 @@ + + + + + +darktable user manual - velvia + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / velvia + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ velvia +

+ + + +

Resaturate pixels in a weighted manner that gives more weight to blacks, whites and less saturated pixels.

+
+

Note: This module causes hue and brightness shifts that can be difficult to manage. Instead, use the color balance rgb module for color modifications.

+
+

🔗module controls

+
+
strength
+
The strength of the effect
+
mid-tones bias
+
Reduce the effect on mid-tones in order to avoid unnatural skin tones. Reducing the mid-tone bias decreases mid-tone protection and makes the overall velvia effect stronger.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/vibrance/index.html b/en/module-reference/processing-modules/vibrance/index.html new file mode 100644 index 0000000000..6f5e9ab951 --- /dev/null +++ b/en/module-reference/processing-modules/vibrance/index.html @@ -0,0 +1,3025 @@ + + + + + +darktable user manual - (deprecated) vibrance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) vibrance + +
+ + + + +
+ +

+ (deprecated) vibrance +

+ + + +
+

Please note that this module is deprecated from darktable 3.6 and should no longer be used for new edits. Please use the vibrance control in the color balance rgb module instead.

+
+

Saturate and reduce the lightness of the most saturated pixels to make the colors more vivid.

+

🔗module controls

+
+
vibrance
+
The amount of vibrance to apply to the image.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/vignetting/index.html b/en/module-reference/processing-modules/vignetting/index.html new file mode 100644 index 0000000000..67aa9e3e99 --- /dev/null +++ b/en/module-reference/processing-modules/vignetting/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - vignetting + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / vignetting + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ vignetting +

+ + + +

Apply a vignetting effect to the image.

+

Vignetting is a modification of the brightness and saturation at the borders of the image in a specified shape. Many of the parameters listed below can also be modified with a graphical control that overlays the image when the module has focus, showing the shape and extent of the effect.

+
+

Note: This module is known to provoke banding artifacts under certain conditions. You should consider activating the dither or posterize module to alleviate this.

+
+

Also note: This module can produce unnatural-looking results and should be used with care. Instead, use the exposure module with an elliptical mask with a large transition area and, if necessary, use the color balance rgb module with the same mask to reduce saturation at the edges.

+
+

🔗module controls

+
+
fall-off start
+
The radius of the central vignetting area.
+
fall-off radius
+
The progressiveness of the fall-off. Lower values cause a steeper transition.
+
brightness
+
The intensity of brightening (positive values) or darkening (negative values).
+
saturation
+
Control how strong colors become when desaturated/saturated in the darkened/brightened vignetting area.
+
horizontal/vertical center
+
Shift the center of the vignetting area horizontally/vertically.
+
shape
+
The shape of the vignetting effect. The default value of 1 creates a circular or elliptical area. Smaller values shift the shape to being more square; higher values turn it into a cross-like shape.
+
automatic ratio
+
Automatically adjust the width/height ratio of the vignetting area to match the aspect ratio of the underlying image. This typically causes the vignetting area to become elliptical.
+
width/height ratio
+
Manually adjust the width/height ratio of the vignetting area.
+
dithering
+
Activate random noise dithering to alleviate banding artifacts caused by vignette gradients. Select “8-bit output” to prevent banding on monitor display and for JPEGs. When set to “16-bit output”, only a small amount of dithering is applied, just strong enough to compensate for banding on the fine grained 16-bit level. It is now recommended that you instead use the dither or posterize module to alleviate banding artifacts.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/watermark/index.html b/en/module-reference/processing-modules/watermark/index.html new file mode 100644 index 0000000000..43fd9d2057 --- /dev/null +++ b/en/module-reference/processing-modules/watermark/index.html @@ -0,0 +1,3076 @@ + + + + + +darktable user manual - watermark + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / watermark + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ watermark +

+ + + +

Render a vector-based overlay onto your image. Watermarks are standard SVG documents and can be designed using Inkscape.

+

You can also use bitmap (PNG) images.

+

The SVG processor in darktable can also substitute strings within an SVG document, allowing image-dependent information to be included in the watermark.

+

User-designed watermarks should be placed into the directory $HOME/.config/darktable/watermarks. Once in place, use the reload button update the list of available watermarks.

+

The following is a list of variable strings that are supported for substitution within an SVG document.

+

In addition to this list you can also use the variable strings defined in the variables section.

+
$(WATERMARK_TEXT)             A short free text (max. 63 characters)
+$(WATERMARK_COLOR)            The color to use for $WATERMARK_TEXT
+$(WATERMARK_FONT_FAMILY)      The font family to use for $WATERMARK_TEXT
+$(WATERMARK_FONT_STYLE)       The font style (normal, oblique, italic)
+$(WATERMARK_FONT_WEIGHT)      The font weight (boldness)
+

🔗module controls

+
+
marker
+
Choose the watermark to apply. Use the reload button to update the list to include any newly-added watermarks. The extension of the file (png/svg) is shown in brackets.
+
text
+
A free text field in which you can enter up to 63 characters to be printed where referenced by the corresponding watermark. An example is supplied as simple-text.svg.
+
font
+
The font to use (default “DejaVu Sans Book”). Click on the field to open a dialog box showing the fonts available on your system. Fonts can be searched by name and a preview is shown next to the font name. You may specify your own sample text.
+
color
+
The color of the text. Click on the colored field to open a color selector dialog which offers you a choice of commonly used colors, or allows you to define a color in RGB color space.
+
opacity
+
The opacity of the watermark’s rendering.
+
rotation
+
The rotation angle of the watermark.
+
scale
+
The scale of the watermark (in per cent), with respect to the option selected in the “scale on” parameter.
+
scale on
+
The reference for the scale parameter – how the watermark is scaled relative to the image:
+
    +
  • “image” (default): Scale the watermark relative to the whole image,
  • +
+
+
    +
  • “larger border”: Scale the larger border of the watermark relative to the larger border of the image,
  • +
+
+
    +
  • “smaller border”: Scale the smaller border of the watermark relative to the smaller border of the image,
  • +
+
+
    +
  • “height”: Scale the height of the watermark relative to the height of the image (useful for text with a constant font height),
  • +
+
+
    +
  • “advanced options”: activate additional options (below) to allow you to choose which image dimension to scale to which watermark dimension. For example, you can choose to scale the watermark’s height relative to the image’s width.
  • +
+
+
scale marker to (“advanced options” only)
+
The image reference against which the watermark should be scaled – “image width”, “image height”, “larger image border” or “smaller image border”.
+
scale marker reference (“advanced options” only)
+
The dimension of the unrotated watermark (“marker width” or “marker height”) to use as a scaling reference.
+
alignment
+
Use these controls to align the watermark to any edge or the center of the image.
+
x offset
+
Pixel-independent offset relative to the choice of alignment on the x-axis.
+
y offset
+
Pixel-independent offset relative to the choice of alignment on the y-axis.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/white-balance/index.html b/en/module-reference/processing-modules/white-balance/index.html new file mode 100644 index 0000000000..a044c10889 --- /dev/null +++ b/en/module-reference/processing-modules/white-balance/index.html @@ -0,0 +1,3085 @@ + + + + + +darktable user manual - white balance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / white balance + +
+ + + + +
+ +

+ white balance +

+ + + +

Adjust the white balance of the image by altering the temperature and tint, defining a coefficient for each RGB channel, or choosing from list of predefined white balance settings.

+

The default settings for this module are derived from the camera white balance stored in the image’s Exif data.

+

White balance is not intended as a “creative” module – its primary goal is to technically correct the white balance of the image ensuring that neutral colored objects in the scene are rendered with neutral colors in the image. For creative color operations, it is usually better to use other modules such as color calibration or color balance rgb.

+
+

Note: The color calibration module now provides a more modern and flexible method of controlling white balance. The color calibration module can be enabled by default for new images by selecting “scene-referred” (filmic or sigmoid) in preferences > processing > auto-apply pixel workflow defaults. Some basic settings are still required (and applied automatically) in the white balance module, so that demosaic works correctly.

+
+

🔗module controls

+

🔗scene illuminant temp

+

This section provides scene-illuminant temperature and tint controls to adjust the white balace of the image. Click on the ‘scene illuminant temp’ section label to cycle between 3 different color modes for the temperature/tint sliders.

+
+
temperature
+
Set the color temperature in kelvin.
+
tint
+
Alter the color tint of the image, from magenta (tint < 1) to green (tint > 1).
+
+

🔗white balance presets

+
+
setting
+
Choose from a predetermined list of white balances. The available settings are derived from the presets available in the camera used to take the photograph. The following options are provided in addition to any camera-defined white balance presets.
+
+
    +
  • as shot (default): The white balance as reported by the camera
  • +
+
+
+
    +
  • from image area: Draw a rectangle over a neutral color in the image to calculate white balance from that area.
  • +
+
+
+
    +
  • user modified: The most recently modified setting. Manual adjustment of temperature, tint or r/g/b channel coefficients will automatically select this option. Choose this setting after selecting any other preset to return parameters to the most recent user-modified state
  • +
+
+
+
    +
  • camera reference: Set the temperature to the camera reference white point, which is assumed to be D65 (or ~6502K). The white balance channel multipliers are calculated such that pure white in the camera colorspace is converted into pure white in sRGB D65 (where pure white means that each color channel has an equal value).
  • +
+
+
+

For convenience the final four modes can also be set by clicking on one of the buttons in the button bar above the setting drop-down.

+
+
finetune
+
Finetune a camera-specific white balance preset. This is only shown if it is available for the camera in question. The direction of adjustment is dependent on the provided presets. If your camera doesn’t have white balance presets available, check this guide to see how you can submit your own.
+
+

🔗channel coefficients

+

The RGB channel coefficients are automatically calculated from the above parameters and, as such, are hidden by default. You can expand/collapse the channel coefficients section by clicking on either the ‘channel coefficients’ label or the adjacent triangular button.

+
+
red/green/blue
+
Set the value of each RGB channel coefficient from 0 to 8
+
+

🔗additional functionality

+

🔗colored sliders

+

By default the module’s sliders are monochrome. However, two flavors of colored sliders can be enabled in preferences > darkroom > white balance slider colors or by clicking on the ‘scene illuminant temp’ section label in the module.

+
+
no color (default)
+
The background of the sliders is not colored.
+
illuminant color
+
The slider colors represent the color of the light source (the color you are adjusting to in order to achieve neutral white).
+
effect emulation
+
The slider colors represent the effect the adjustment would have had on the scene. This is how most other raw processors show temperature/tint sliders colors.
+
+

🔗button bar

+

The button bar is simple addition that allows one-click access to the internal white balance settings. You can disable this by editing your darktablerc file. Find the line that says

+
plugins/darkroom/temperature/button_bar=TRUE
+

and change TRUE to FALSE.

+

🔗usage warning

+

The only parameters that are used internally by this module’s operation are the rgb channel coefficients. The temperature and tint sliders are provided as a more user-friendly way to adjust those parameters. The relationship between the channel coefficients and temperature/tint sliders depends on characteristics specific to the camera used to take the photograph. This means that applying white balance settings from an image made with one camera to an image made with another will, in general, not give consistent results.

+

The mathematical relationship between the two sets of values is not straightforward. It is possible to set the channel coefficients such that there is no valid equivalent temperature and tint setting (mainly where very high temperature values are calculated from the sliders). Editing white balance using temperature and tint on an image previously edited using channel coefficients may therefore give odd results, at least where high temperature values are involved.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/zone-system/index.html b/en/module-reference/processing-modules/zone-system/index.html new file mode 100644 index 0000000000..4db204442c --- /dev/null +++ b/en/module-reference/processing-modules/zone-system/index.html @@ -0,0 +1,3036 @@ + + + + + +darktable user manual - (deprecated) zone system + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Module Reference / processing modules / (deprecated) zone system + +
+ + + + +
+ +

+ (deprecated) zone system +

+ + + +
+

Please note that this module is deprecated from darktable 3.4 and should no longer be used for new edits. Please use the tone equalizer or multiple instances of the exposure module with parametric masks to narrow down on a zone.

+
+

Adjust the lightness of an image using Ansel Adams’ zone system.

+

The lightness of the image (the L channel in Lab color space) is divided into a number of zones ranging from pure black to pure white. These zones are displayed in a zonebar beneath a preview image. The number of zones can be changed by mouse-scrolling on that bar (default 10 zones).

+

+ + + + + + + + +zone-system + +

+

The zonebar is split horizontally with the lower part showing the zones of the module’s input and the upper part the zones of the module’s output. In its default state both parts are fully aligned. While the output zones are static you can left click and drag a control point in the input zones to modify the mapping between input and output.

+

Shifting a control point proportionally expands the zones on one side and compresses the zones on the other side of that point. All pre-existing control points stay in place, effectively preventing changes to the zones beyond the next control point. Use right click to remove a control point.

+

The preview image above the zonebar shows how the image’s zones are broken down. When hovering above a zone, that zone – either from input or output – is highlighted in yellow on the preview image.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/processing-modules/zone-system/zone-system.png b/en/module-reference/processing-modules/zone-system/zone-system.png new file mode 100644 index 0000000000..79afc0a80c Binary files /dev/null and b/en/module-reference/processing-modules/zone-system/zone-system.png differ diff --git a/en/module-reference/utility-modules/darkroom/clipping/clipping-icon.png b/en/module-reference/utility-modules/darkroom/clipping/clipping-icon.png new file mode 100644 index 0000000000..be3b735bb9 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/clipping/clipping-icon.png differ diff --git a/en/module-reference/utility-modules/darkroom/clipping/index.html b/en/module-reference/utility-modules/darkroom/clipping/index.html new file mode 100644 index 0000000000..43d14fa586 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/clipping/index.html @@ -0,0 +1,3105 @@ + + + + + +darktable user manual - clipping warning + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / clipping warning + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ clipping warning +

+ + + +

Highlight areas of the image that may exhibit luminance or gamut clipping.

+

When an image is sent to a display device, each pixel is normally represented as a set of 3 numbers, representing the intensity of the red, green and blue primary colors in the output color space. Because the output color space is usually closely related to hardware with physical limations, there is a maximum permitted value for the [R,G,B] channels, representing the maximum available intensity for that color space. Similarly, there is also a minimum value below which pixel values will be mapped to zero. When we try to convert from a larger color space to the final output color space, any values exceeding this maximum will be clamped to the maximum value, and any values below the minimum will be clamped to zero. This process is called “clipping” and it will lead to lost detail, or “incorrect” colors for any pixels with clipped channels.

+

Click the + + + + + + + + +clipping warning + + icon to enable the clipping warning.

+

There are two ways in which a pixel might become clipped when represented in the output color space.

+
    +
  • +

    luminance clipping: This can occur when a pixel is too bright to be represented in the output color space. The pixel luminance is calculated as a weighted average of the [R,G,B] channels. If this average exceeds the maximum allowed value, it is an indication of over-exposure. The overall luminance of a pixel can also be too dark to be represented by an [R,G,B] value in the output color space, in which case it will simply be shown as black. We normally deal with luminance clipping by carefully adjusting tone mappings and exposure levels.

    +
  • +
  • +

    gamut clipping: The output color space defines a set of primary colors that, mixed together in certain ratios, produce the final output color. However, there are only so many colors that can be produced by mixing together a combination of those three primary colors. Highly saturated colors in particular can be difficult to represent, especially for pixels that are very bright or very dark. If there is no set of positive [R,G,B] values that can represent a given color at a given level of brightness, we say that the color is “out of gamut”, and we need to settle for another color instead that can be represented by permitted [R,G,B] values within the color space. We can handle gamut clipping by being careful not to over-saturate colors in the highlights and shadows, and possibly by using some color grading/color mapping techniques.

    +
  • +
+

The “clipping warning” module is used to highlight those pixels that cannot be accurately represented in the output color space, either due to luminance or gamut clipping. Prior to darktable 3.4, the clipping highlighted any pixels that exceeded the maximum allowed value on any of the [R,G,B] channels, or that had been completely crushed to black. From darktable 3.4 onwards, the clipping warning indicator has some additional modes to help you to differentiate between luminance and gamut clipping, so that you can make better decisions about how to address any issues.

+

As the clipping warning runs at the end of the preview pixelpipe, it receives data in display color space then converts it to histogram color space. If you are using a display color space that is not “well behaved” (this is common for a device profile), then colors that are outside of the gamut of the display profile will clip or distort.

+

The clipping warning module, described here, warns you about clipping caused by image processing and the limitations of the output color space. It should not be confused with the following similar tools:

+
    +
  • +

    The raw overexposed warning indicates where pixels in the original raw file are clipped due to physical limitations in the dynamic range of the camera sensor. This module highlights information that was permanently lost at the point of image capture, and you need to deal with it as best you can using highlight recovery techniques.

    +
  • +
  • +

    The gamut check module also provides information about clipping arising from image processing. It is based on the external littleCMS library, and is more or less equivalent to the full gamut mode in the clipping warning module. The downsides of the gamut check module are that it doesn’t allow you to distinguish between clipping caused by luminance and gamut mapping, and it is much slower than the clipping warning indicator.

    +
  • +
+

🔗module controls

+

Right-click on the clipping icon to show the following options:

+
+
clipping preview mode
+
Choose the type of clipping that you want to highlight:
+
+
    +
  • any RGB channel: Provides an over-clipping indication if any one of the three [R,G,B] channels exceeds the maximum permitted value for the histogram color space, or an under-clipping indication if the three [R,G,B] channels are too dark and are all forced to black. This was the default mode prior to darktable version 3.4.
  • +
+
+
    +
  • luminance only: Indicates any pixels that are clipped because their luminance falls outside of the range set in the “upper threshold” and “lower threshold” sliders. If this happens, it generally means that tone mapping or exposure settings have been poorly set
  • +
+
+
    +
  • saturation only: Indicates where over-saturated colors have pushed one or more of the [R,G,B] channels towards a value outside the permitted range of the histogram color space, even though the overall luminance of the pixel may lie within acceptable limits. This means that the pixel’s color is impossible to represent in the histogram color space, and can arise from poorly set gamut mapping or saturation settings,
  • +
+
+
    +
  • full gamut: Shows a combination of the three previous options. This is the default mode from darktable 3.4 onwards, and it gives the most complete indication of potentially problematic pixels.
  • +
+
+
color scheme
+
By default, the indicator marks pixels with red where the upper threshold is exceeded (over-clipping) and with blue where the lower threshold is breached (under-clipping). This color scheme can be changed to black & white or purple & green for “over & under” indicators, which may be useful to improve visibility for some images.
+
lower threshold
+
Expressed in EV relative to the white point (which is nominally EV = 0). If the [R,G,B] channels all fall below this value, an under-clipping indicator is shown warning that the pixel may be end up being crushed to black. Use the following reference to set this threshold, depending on your intended output medium:
+
+
    +
  • 8-bit sRGB clips blacks at –12.69 EV
  • +
+
+
    +
  • 8-bit Adobe RGB clips blacks at –19.79 EV
  • +
+
+
    +
  • 16-bit sRGB clips blacks at –20.69 EV
  • +
+
+
    +
  • fine art matte prints typically produce black at –5.30 EV
  • +
+
+
    +
  • color glossy prints typically produce black at –8.00 EV
  • +
+
+
    +
  • black & white glossy prints typically produce black at –9.00 EV
  • +
+
+
upper threshold
+
How close a pixel should be to the upper limit before being flagged by the clipping warning, expressed as a percentage (default 98%). In the case of gamut checks, this controls how close the saturation of the pixel is allowed to get to the limits of the color space’s gamut before a clipping indication is flagged.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/color-assessment/bulb-icon.png b/en/module-reference/utility-modules/darkroom/color-assessment/bulb-icon.png new file mode 100644 index 0000000000..75b0bd1d2d Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/color-assessment/bulb-icon.png differ diff --git a/en/module-reference/utility-modules/darkroom/color-assessment/color-assessment-overview.png b/en/module-reference/utility-modules/darkroom/color-assessment/color-assessment-overview.png new file mode 100644 index 0000000000..7e5842311e Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/color-assessment/color-assessment-overview.png differ diff --git a/en/module-reference/utility-modules/darkroom/color-assessment/index.html b/en/module-reference/utility-modules/darkroom/color-assessment/index.html new file mode 100644 index 0000000000..550750c66d --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/color-assessment/index.html @@ -0,0 +1,3052 @@ + + + + + +darktable user manual - color assessment + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / color assessment + +
+ + + + +
+ +

+ color assessment +

+ + + +

Assess colors and brightness in your image using ISO 12646:2008 recommended viewing conditions.

+

When developing an image, the way we perceive brightness, contrast and saturation is influenced by the surrounding ambient conditions. If an image is displayed against a dark background, this can have a number of adverse effects on our perception of that image:

+
    +
  • Exaggeration of the perceived exposure makes the image seems brighter than it really is. This is nicely illustrated by the Adelson checkerboard shadow effect.
  • +
  • A decrease in the perceived saturation in the image makes the colors seem less rich than they really are (the Hunt effect).
  • +
  • A decrease in the perceived contrast in the image makes the tones seem flatter than they really are (Bartleson-Breneman effect 3)
  • +
+

The end result is that the final image can end up being too dark and overly-processed in terms of contrast and color saturation. To avoid this, the “ISO 12646:2008” standard makes some recommendations about the conditions under which the colors of an image should be assessed. The color assessment module in the darkroom places a frame around the image to help the user better assess the colors in the image, along the lines of those recommendations.

+

+ + + + + + + + +color-assessment-overview + +

+

When the color assessment button + + + + + + + + +bulb-icon + + is selected in the bottom panel, the image is zoomed out so that a thick mid-gray border appears around the image to act as a reference against which to compare the image’s tones. A thinner white border is placed immediately around the image to give the eyes a basis for comparison when looking at parts of the image that are meant to be a bright white.

+

Although the color assessment mode provides a mid-gray surrounding to the image, it is recommended that you also set your user interface (in preferences > general) to one of the “grey” themes. These themes are designed to provide a user interface that is close to middle gray (it is actually slightly darker to allow better contrast with the text in the user interface). When one of these themes is used together with the color assessment mode, this will help to avoid the above perception issues.

+

Color assessment mode can also be toggled by pressing Ctrl+B.

+

You can modify the distance from the edge of the center panel to the edge of the image by adjusting the darkroom/ui/iso12464_border entry in the $HOME/.config/darktable/darktablerc file. In the same file you can modify the size of the white border (in percent) by adjusting the darkroom/ui/iso12464_ratio entry.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/duplicate-manager/index.html b/en/module-reference/utility-modules/darkroom/duplicate-manager/index.html new file mode 100644 index 0000000000..abde4bab9a --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/duplicate-manager/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - duplicate manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / duplicate manager + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ duplicate manager +

+ + + +

View and create multiple versions of the current image. Each version can be edited independently without affecting other versions – all versions use the same underlying image file, but the editing history of each version is stored in its own independent XMP sidecar file.

+

The duplicate manager lists each version of the current darkroom image along with its preview thumbnail. Hold down the left mouse button on a thumbnail to temporarily show that version in the center view. Double-click to switch to that version and edit it.

+

The buttons at the bottom of the module allow you to create new duplicates of the current image. You can either create a ‘virgin’ version (with an empty history stack) using the “original” button or an exact duplicate of the current edit using the “duplicate” button.

+

A version number is displayed to the right of each thumbnail. Click in the area below the version number to enter a description against that version of the image. This description is stored in the version name metadata tag, which can also be edited within the metadata editor module in the lighttable view.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/gamut/gamut-icon.png b/en/module-reference/utility-modules/darkroom/gamut/gamut-icon.png new file mode 100644 index 0000000000..a61b1a00e3 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/gamut/gamut-icon.png differ diff --git a/en/module-reference/utility-modules/darkroom/gamut/index.html b/en/module-reference/utility-modules/darkroom/gamut/index.html new file mode 100644 index 0000000000..f84d0a3fe3 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/gamut/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - gamut check + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / gamut check + +
+ + + + +
+ +

+ gamut check +

+ + + +

Highlight areas of the image that may exhibit gamut clipping.

+

Click the + + + + + + + + +gamut-icon + + icon to activate the gamut check display mode for your image. This function highlights, in cyan, all pixels that are out of gamut with respect to the selected softproof profile. You can also activate gamut check with the keyboard shortcut Ctrl+G. A message “gamut check” on the bottom left of your image tells you that you are in gamut check display mode. Gamut check and soft proof are mutually exclusive modes.

+

Right-click on the icon to open a dialog with configuration parameters – these are the same as for the soft proof option.

+

You might also like to consider using the clipping warning, which also provides under- and over-exposure warnings as well as a gamut check similar to that offered by this module.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/global-color-picker/index.html b/en/module-reference/utility-modules/darkroom/global-color-picker/index.html new file mode 100644 index 0000000000..5ac7be09b6 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/global-color-picker/index.html @@ -0,0 +1,3047 @@ + + + + + +darktable user manual - global color picker + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / global color picker + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ global color picker +

+ + + +

Take color samples from the current darkroom image, display their values in multiple ways and compare colors from different locations.

+

The color picker is activated by pressing the picker icon. The module’s parameters will remain in effect until you leave the darkroom mode.

+

Besides the global color picker described here, many darktable modules (e.g. tone curve) also contain local pickers which are used to set individual module parameters. You should be aware that these two forms of picker do not always work in the same color space. The global color picker works in the histogram color space and takes its samples after the complete pixelpipe has been processed. Local pickers run in the color space of the module in which they are activated and reflect the input or output data of that module within the pixelpipe.

+

You can right-click on the sampled color values to copy them to the clipboard.

+

As the global color picker runs at the end of the preview pixelpipe, it receives data in display color space then converts it to histogram color space. If you are using a display color space which is not “well behaved” (this is common for a device profile), then colors that are outside of the gamut of the display profile will clip or distort.

+

Hover over any of the color values to show a tooltip containing more detailed information about the picked color or live color sample. This information includes RGB and Lab values as well as an approximate color name. An attempt is also made to detect skin tones and provide an appropriate description. Skin tone detection needs proper Lightness scaling (44 to 48% for African and 58 to 64% for all others) and neutral white balance.

+

🔗module controls

+
+
point/area mode
+
The global color picker can be activated in point or area mode with the picker icon. In point mode only a small spot under your cursor is taken as a sample. In area mode darktable samples the area within a drawn rectangle.
+
mean/min/max
+
If samples are taken in area mode, darktable will calculate mean, minimum and maximum color channel values. This combobox allows you to select which of those are displayed. For obvious statistical reasons mean, min and max are identical for the single sample of point mode.
+
color swatch / color values
+
A color swatch representing the sampled point or area is displayed alongside numerical values. Clicking on the swatch will toggle on/off a much larger swatch for easier viewing.
+
+

The global color picker works in display RGB color space, though you may choose (by selecting from the drop-down) to translate these numerical values into another color space. Beware that values in other color spaces are approximated here – depending on the display color profile there may be some deviations from the actual values.

+
+
live samples
+
The sampled colors (in either area or point mode) can be stored as live samples by pressing the “add” button. A color swatch and numerical values will be shown for each stored sample. You can change the numerical value (mean, min, max) and color space to display.
+
+

Newly created live samples are not locked. If you change your image processing those changes will be reflected in the live samples. This can be used to see how an altered parameter affects different parts of the image. Clicking on a live sample’s color swatch locks it and a lock symbol is displayed. Further image changes will then no longer affect the sample. You can use this to compare two live samples by locking just one of them, thus providing a before and after comparison.

+
+
+

If you hover the mouse over the “delete” button of one of the live sample entries, the selected region for that sample will be highlighted in the image preview.

+
+
display samples on image/vectorscope
+
When this checkbox is ticked, live sample locations are visually indicated on the image and the vectorscope view of the scopes module.
+
restrict scope to selection
+
When this checkbox is ticked, only the values of the selected area or point are taken into account by the regular and waveform views of the scopes module. This allows you to see what tonal values are present in the selected area. When using a picker in a processing module, this option restricts the scope to the picked area from the processing module instead of the global color picker.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/guides-overlays/guides-overlays-icon.png b/en/module-reference/utility-modules/darkroom/guides-overlays/guides-overlays-icon.png new file mode 100644 index 0000000000..4911e79a4a Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/guides-overlays/guides-overlays-icon.png differ diff --git a/en/module-reference/utility-modules/darkroom/guides-overlays/index.html b/en/module-reference/utility-modules/darkroom/guides-overlays/index.html new file mode 100644 index 0000000000..cca332b5fe --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/guides-overlays/index.html @@ -0,0 +1,3062 @@ + + + + + +darktable user manual - guides & overlays + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / guides & overlays + +
+ + + + +
+ +

+ guides & overlays +

+ + + +

A number of commonly-used compositional guides can be overlaid on your image while you are editing. These can be enabled either globally (all the time) or locally (when certain modules are active).

+

Other darkroom functionality also draws colored overlay lines on the image (for example, drawn masks). An option is also provided to change the color of those overlays (see below).

+

🔗global guides

+

Left-click the + + + + + + + + +guides-overlays-icon + + icon in the bottom bar to globally display guide overlays. The overlays will remain switched on until you click the button a second time to switch them off.

+

Right-click the icon to show the settings dialog (see below).

+

🔗local guides

+

A more common use is to switch the guides on only when a specific module is activated. The following control is added by default to all modules that crop/distort the image (currently crop, crop and rotate, orientation, framing, liquify, lens correction and rotate and perspective):

+

+ + + + + + + + +local-controls + +

+

Tick the box to show guide overlays whenever the module is active. Click the icon on the right to show the settings dialog (see below).

+

🔗global guide overlay settings

+

Please note that, while you can choose to switch guide overlays on and off either globally or locally, the following settings are stored globally and cannot be set independently for each module.

+
+
type
+
The type of compositional guide lines to display.
+
flip
+
Some guides are asymmetrical. This option allows you to flip such guides horizontally/vertically.
+
horizontal lines, vertical lines, subdivisions
+
When the grid overlay type is selected, set the parameters of the grid.
+
overlay color
+
The color of the overlay lines. Note that this impacts any lines that are drawn directly over the image, for example, drawn masks.
+
contrast
+
The contrast between the lightest and darkest parts of any overlays – usually, the contrast between the “on” and “off” parts of dashed lines.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/guides-overlays/local-controls.png b/en/module-reference/utility-modules/darkroom/guides-overlays/local-controls.png new file mode 100644 index 0000000000..85b7b601a6 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/guides-overlays/local-controls.png differ diff --git a/en/module-reference/utility-modules/darkroom/high-quality-processing/high-quality-processing-icon.png b/en/module-reference/utility-modules/darkroom/high-quality-processing/high-quality-processing-icon.png new file mode 100644 index 0000000000..59b9aec009 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/high-quality-processing/high-quality-processing-icon.png differ diff --git a/en/module-reference/utility-modules/darkroom/high-quality-processing/index.html b/en/module-reference/utility-modules/darkroom/high-quality-processing/index.html new file mode 100644 index 0000000000..46a71e330f --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/high-quality-processing/index.html @@ -0,0 +1,3031 @@ + + + + + +darktable user manual - high quality processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / high quality processing + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ high quality processing +

+ + + +

Process the image in the darkroom view using “high quality mode”, so that the displayed image reflects the appearance of a full-sized export.

+

Activate this mode by clicking the + + + + + + + + +high quality processing icon + + icon at the bottom of the darkroom view.

+

Note that while this mode provides the most accurate representation of the processed image, it also results in signficant performance degredation. Please see the types of pixelpipe section for a full discussion.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/history-stack/index.html b/en/module-reference/utility-modules/darkroom/history-stack/index.html new file mode 100644 index 0000000000..19a7e6029d --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/history-stack/index.html @@ -0,0 +1,3029 @@ + + + + + +darktable user manual - history stack + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / history stack + +
+ + + + +
+ +

+ history stack +

+ + + +

View and modify the history stack of the current darkroom image.

+

This module lists every change of state (activate/de-activate/move/change parameters) for all processing modules that have been modified for the current image. Select a point in the stack to return to that point in the development history of the image. Shift+click an item in the history stack to expand that module in the right-hand module panel without changing the current edit.

+
+

Caution: If you select a module in the history stack and then make further modifications to the image, all edits above the currently selected step will be discarded. It is easy to lose development work on an image in this way! You can usually use Ctrl+Z to undo such changes.

+
+

It is safe to quit the program, leave the darkroom mode, or switch to another image after having selected some earlier state in the history stack module. When returning to that image you will find the history stack panel in the state where you left it.

+

Hover the mouse over an item in the history stack to show a tooltip with details of all changes that were made in that module compared to its previous or default state. This can help you to track down adjustments that were made unintentionally.

+

Click “compress history stack” to generate the shortest history stack that reproduces the current image. This causes all edits above the currently-selected step to be discarded. If any module appears multiple times in the remainder of the stack, these will be compressed into a single step in the history.

+

Click “compress history stack” while holding the Ctrl key to truncate the history stack without compressing it i.e. discard all modules above the currently selected one but leaving the remainder of the history stack unchanged.

+

Click the “reset parameters” button in the module header to discard the entire history stack and reactivate any default modules. This can also be achieved by selecting the “original image” history item and clicking “compress history stack”.

+

The button to the right of the “compress history stack” button allows you to create a new style from the history stack of the current image, which can then be applied to other images. Use the first line of the popup dialog window to name your style and the second to add a searchable description. You will be prompted to choose which of the modules from the current history stack to include in the style.

+

Once created, styles can be managed and applied to other images with the lighttable’s styles module. You can also assign shortcut keys to your styles (see preferences > shortcuts) and apply the associated style to all selected images by pressing the shortcut key whenever you are in the lighttable or darkroom view.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/image-info-line/index.html b/en/module-reference/utility-modules/darkroom/image-info-line/index.html new file mode 100644 index 0000000000..e46c9075ac --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/image-info-line/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - image information line + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / image information line + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ image information line +

+ + + +

Display information about the current image in a darkroom panel.

+

The contents of this line can be set in preferences > darkroom. See the variables section for information about the variables that can be used here. You can also insert a newline with $(NL).

+

The image information line can be displayed in the top, bottom, left or right panel depending on an additional configuration item in preferences > darkroom.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/index.html b/en/module-reference/utility-modules/darkroom/index.html new file mode 100644 index 0000000000..8001b5dd1a --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/index.html @@ -0,0 +1,3115 @@ + + + + + +darktable user manual - darkroom + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/index.xml b/en/module-reference/utility-modules/darkroom/index.xml new file mode 100644 index 0000000000..cd50a36b38 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/index.xml @@ -0,0 +1,116 @@ + + + + darkroom on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/ + Recent content in darkroom on darktable user manual + Hugo + en + + + clipping warning + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/clipping/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/clipping/ + Highlight areas of the image that may exhibit luminance or gamut clipping. When an image is sent to a display device, each pixel is normally represented as a set of 3 numbers, representing the intensity of the red, green and blue primary colors in the output color space. Because the output color space is usually closely related to hardware with physical limations, there is a maximum permitted value for the [R,G,B] channels, representing the maximum available intensity for that color space. + + + color assessment + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/color-assessment/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/color-assessment/ + Assess colors and brightness in your image using ISO 12646:2008 recommended viewing conditions. When developing an image, the way we perceive brightness, contrast and saturation is influenced by the surrounding ambient conditions. If an image is displayed against a dark background, this can have a number of adverse effects on our perception of that image: Exaggeration of the perceived exposure makes the image seems brighter than it really is. This is nicely illustrated by the Adelson checkerboard shadow effect. + + + duplicate manager + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/duplicate-manager/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/duplicate-manager/ + View and create multiple versions of the current image. Each version can be edited independently without affecting other versions &ndash; all versions use the same underlying image file, but the editing history of each version is stored in its own independent XMP sidecar file. The duplicate manager lists each version of the current darkroom image along with its preview thumbnail. Hold down the left mouse button on a thumbnail to temporarily show that version in the center view. + + + gamut check + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/gamut/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/gamut/ + Highlight areas of the image that may exhibit gamut clipping. Click the icon to activate the gamut check display mode for your image. This function highlights, in cyan, all pixels that are out of gamut with respect to the selected softproof profile. You can also activate gamut check with the keyboard shortcut Ctrl+G. A message “gamut check” on the bottom left of your image tells you that you are in gamut check display mode. + + + global color picker + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/global-color-picker/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/global-color-picker/ + Take color samples from the current darkroom image, display their values in multiple ways and compare colors from different locations. The color picker is activated by pressing the picker icon. The module&rsquo;s parameters will remain in effect until you leave the darkroom mode. Besides the global color picker described here, many darktable modules (e.g. tone curve) also contain local pickers which are used to set individual module parameters. You should be aware that these two forms of picker do not always work in the same color space. + + + guides & overlays + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/guides-overlays/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/guides-overlays/ + A number of commonly-used compositional guides can be overlaid on your image while you are editing. These can be enabled either globally (all the time) or locally (when certain modules are active). Other darkroom functionality also draws colored overlay lines on the image (for example, drawn masks). An option is also provided to change the color of those overlays (see below). 🔗global guides Left-click the icon in the bottom bar to globally display guide overlays. + + + high quality processing + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/high-quality-processing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/high-quality-processing/ + Process the image in the darkroom view using &ldquo;high quality mode&rdquo;, so that the displayed image reflects the appearance of a full-sized export. Activate this mode by clicking the icon at the bottom of the darkroom view. Note that while this mode provides the most accurate representation of the processed image, it also results in signficant performance degredation. Please see the types of pixelpipe section for a full discussion. + + + history stack + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/history-stack/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/history-stack/ + View and modify the history stack of the current darkroom image. This module lists every change of state (activate/de-activate/move/change parameters) for all processing modules that have been modified for the current image. Select a point in the stack to return to that point in the development history of the image. Shift+click an item in the history stack to expand that module in the right-hand module panel without changing the current edit. + + + image information line + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/image-info-line/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/image-info-line/ + Display information about the current image in a darkroom panel. The contents of this line can be set in preferences &gt; darkroom. See the variables section for information about the variables that can be used here. You can also insert a newline with $(NL). The image information line can be displayed in the top, bottom, left or right panel depending on an additional configuration item in preferences &gt; darkroom. + + + mask manager + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/mask-manager/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/mask-manager/ + Manage all drawn masks and shapes for the current image. This module can be used to create, rename, edit and delete shapes. You can alter the shapes in a drawn mask, group shapes together, and combine them using set operators. The top line of the mask manager panel contains buttons that can be used to create new shapes. These are the same as in the drawn mask interface of the processing modules. + + + module order + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/module-order/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/module-order/ + Change the order of the processing modules in the darkroom using presets. When processing an image, the active modules are applied in a specific order, which is shown in the right-hand panel of the darkroom view. This module provides information about the current ordering of the processing modules in the pixelpipe. The name of the currently-selected preset is shown in the module header (or &ldquo;custom&rdquo; if the user has manually modified the order). + + + navigation + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/navigation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/navigation/ + Zoom and pan the current image. The navigation panel (displayed on the top left hand side of the darkroom) shows a full preview of the current image with a rectangle showing the area that is currently visible in the central panel. You can interact with this module using your mouse in the same way as you can interact with the main image (scroll to zoom in/out, middle-click to cycle through zoom levels, click+drag to pan). + + + raw overexposed warning + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/raw-overexposed/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/raw-overexposed/ + Highlight areas of the image where color channels of the raw input file are clipped. Clipped color channels imply an overexposed image with loss of information in the affected areas. Some of this information may be recoverable using the highlight reconstruction, color reconstruction or filmic rgb modules. Click on the icon to show/hide the warning overlay. Right-click on the icon to open a dialog containing the following configuration parameters. mode Choose how to mark clipped areas: mark with CFA color: Display a pattern of the respective primary colors (red, green, and blue) to indicate which color channels are clipped. + + + snapshots + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/snapshots/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/snapshots/ + Store development snapshots and compare with the current edit. Snapshots can be taken at any point in the development process and later overlaid onto the current center view. This allows you to undertake a side by side comparison (by default left=snapshot, right=active edit) while you are tuning parameters of a module. It can also be combined with the history stack module to compare a snapshot against different stages of development. + + + soft proof + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/soft-proof/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/soft-proof/ + View your image rendered using a selected color profile. Click the icon to activate the soft proof display mode on your image. This allows you to preview your image rendered using a printer profile to see how colors will end up on the final print. You can also activate soft proof with the keyboard shortcut Ctrl+S. A message “soft proof&quot; on the bottom left of your image tells you that you are in soft proof display mode. + + + diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/index.html b/en/module-reference/utility-modules/darkroom/mask-manager/index.html new file mode 100644 index 0000000000..41729eccb1 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/mask-manager/index.html @@ -0,0 +1,3162 @@ + + + + + +darktable user manual - mask manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / mask manager + +
+ + + + +
+ +

+ mask manager +

+ + + +

Manage all drawn masks and shapes for the current image.

+

+ + + + + + + + +mask manager + +

+

This module can be used to create, rename, edit and delete shapes. You can alter the shapes in a drawn mask, group shapes together, and combine them using set operators.

+

The top line of the mask manager panel contains buttons that can be used to create new shapes. These are the same as in the drawn mask interface of the processing modules.

+

The panel below these buttons displays a list of all masks and individual shapes defined for the current image.

+

Groups of shapes forming a drawn mask are displayed with a headline in the form “grp <module_name>” to indicate the module in which they are used, with the constituent shapes listed below. The list of mask groups is followed by a list of all individual shapes that have been generated in the context of the current image (which also repeats the shapes that are part of a group). If a shape is in use by any drawn masks this is indicated by a symbol to the right of the shape name.

+

🔗shapes

+

By default each shape receives an automatically generated name, consisting of the shape type (“brush”, “circle”, “ellipse”, “path”, “gradient”) and an automatically-incremented integer. You can rename a shape by double-clicking on its current name. It is a good habit to give shapes and groups meaningful names, especially if you intend to reuse the same selection in different masks.

+

If any shape has a reduced opacity this will be shown to the right of the shape name. An icon representing the chosen set operator (mode) is shown to the left (except for the first shape in a group, which has no prior shape to be combined with).

+

Click on a shape name to show the selected shape on the image canvas with all of its controls, allowing you to edit the properties of just that shape. This is especially useful where there are many overlapping shapes within a mask, making it difficult to select the right one with the mouse. Similarly if you select a shape on-screen from within the mask controls of a processing module, that shape will also be selected in the mask manager.

+

Right-click on a shape name to show a menu containing additional options (explained below).

+
+

Note: darktable retains all shapes that have ever been defined for the current image unless you explicitly remove them. If you choose to include develop history when exporting an image, all defined shapes will be exported with the image. Beware that if the list of shapes is very long the space required to store those shapes might exceed the size limit of certain file formats. This can cause XMP tag creation to fail during export.

+
+

🔗masks & groups

+

Drawn masks are constructed by adding a group of shapes to the image in the order that they are listed (from bottom to top – the same order as processing modules are displayed). Each shape adjusts the existing mask using one of five logical set operators (see below). Because order is important it is also possible to move shapes up and down the list via the right-click menu.

+

Click on the name of a group in the mask manager to expand that group, showing a list of its constituent shapes – the corresponding shapes will be shown on the center image. Similarly if you choose to show a drawn mask from within a processing module, the corresponding group will be expanded within the mask manager.

+

Right-click on a group name to display a menu with options to add new or existing shapes to the group, or to clean up unused shapes. You can also choose to delete the group.

+

Right-click on any of the constituent shapes to control how that shape contributes to the overall group mask as follows:

+
+
remove from group
+
Remove the shape from the current mask.
+
use inverted shape
+
Invert the polarity of the selected shape.
+
mode
+
Choose how this shape will be combined with the preceding mask by selecting one of the five set operators defined below. The currently-selected mode is highlighted with a check mark.
+
move up/down
+
Move the shape up or down the list.
+
+

You can also create your own groups using existing shapes by selecting the shapes you wish to group, right-clicking them and choosing “group the forms”.

+

🔗properties

+

Expand the properties section to change the properties (opacity, size, rotation, feather, hardness) of the currently selected shape(s).

+

If a group is selected, the soft limits of the sliders are automatically adjusted in an attempt to prevent irreversible distortions (where some of the shapes are clamped at their extreme values but others can still be adjusted, so that reversing the move does not return all shapes to their previous configuration). However, like any soft limits, these can be overridden (forced) if you are happy to accept the consequences.

+

If a pen (e.g. Wacom) is detected, some additional options are also displayed to control how it is used by darktable:

+
+
pressure
+
Controls how the pressure reading of a graphics tablet impacts newly generated drawn mask brush strokes. You can control the brush width, hardness and opacity. “Absolute” control means that the pressure reading directly defines the attribute with a value between 0% and 100%. “Relative” means that the pressure reading adjusts the attribute between zero and the pre-defined default value (default off).
+
smoothing
+
Sets the level for smoothing of drawn mask brush strokes. Stronger smoothing leads to fewer nodes and easier editing at the expense of lower accuracy.
+
+

🔗set operators (modes)

+

Set operators are used to define how grouped shapes are combined. In the following examples (with the exception of “sum”) we will use a mask that combines a gradient followed by a path, to demonstrate the effect of each set operator when applied to the path shape:

+

+ + + + + + + + +gradient + + + + + + + + + + +path + +

+

As a convention in the following explanations we say that a pixel is “selected” in a mask or shape if it has an opacity greater than zero.

+
+
sum (default for brush shapes)
+
The shape adds to the existing mask by increasing its opacity by the opacity of the drawn shape. This allows multiple shapes (e.g. brush strokes) with low opacity to be layered on top of one another to increase the strength of the overall mask (e.g. for dodge and burn operations). The resulting opacity of a given pixel is the sum of the opacity of the individual shapes that intersect with that pixel, up to a maximum of 100%.
+
union (default for non-brush shapes)
+
The shape adds to the existing mask in such a way that the resulting mask contains the pixels that are either selected in the existing mask or in the added shape. In overlapping areas the maximum value is taken:
+
+

+ + + + + + + + +union + +

+
+
intersection
+
The shape adds to the existing mask in such a way that the resulting mask contains only pixels that are selected in both the existing mask and the added shape. In overlapping areas the minimum value is used. In the given example we use this operator to “imprint” the path with a gradient:
+
+

+ + + + + + + + +intersection + +

+
+
difference
+
In the non-overlapping area the existing mask is unchanged. In the resulting mask, pixels are selected only if they are selected in the existing mask but not in the added shape. This set operator can be chosen if you want to “cut out” a region from within an existing selection:
+
+

+ + + + + + + + +difference + +

+
+
exclusion
+
The resulting mask selects all pixels that are selected in the existing mask and not in the added shape or vice versa. This is equivalent to an “exclusive or”:
+
+

+ + + + + + + + +exclusion + +

+
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager.png new file mode 100644 index 0000000000..fc87521ac8 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex1.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex1.png new file mode 100644 index 0000000000..fe75e35113 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex1.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex2.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex2.png new file mode 100644 index 0000000000..876dc1dbd1 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex2.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex3.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex3.png new file mode 100644 index 0000000000..c0f682d829 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex3.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex4.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex4.png new file mode 100644 index 0000000000..cb8a4c72a5 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex4.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex5.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex5.png new file mode 100644 index 0000000000..20c3218790 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex5.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex6.png b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex6.png new file mode 100644 index 0000000000..65008417e2 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/mask-manager_ex6.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/masks_difference.png b/en/module-reference/utility-modules/darkroom/mask-manager/masks_difference.png new file mode 100644 index 0000000000..603042e672 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/masks_difference.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/masks_exclusion.png b/en/module-reference/utility-modules/darkroom/mask-manager/masks_exclusion.png new file mode 100644 index 0000000000..386b78606f Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/masks_exclusion.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/masks_intersection.png b/en/module-reference/utility-modules/darkroom/mask-manager/masks_intersection.png new file mode 100644 index 0000000000..2a6fb693e7 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/masks_intersection.png differ diff --git a/en/module-reference/utility-modules/darkroom/mask-manager/masks_union.png b/en/module-reference/utility-modules/darkroom/mask-manager/masks_union.png new file mode 100644 index 0000000000..888b25f70d Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/mask-manager/masks_union.png differ diff --git a/en/module-reference/utility-modules/darkroom/module-order/index.html b/en/module-reference/utility-modules/darkroom/module-order/index.html new file mode 100644 index 0000000000..9e0496da04 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/module-order/index.html @@ -0,0 +1,3031 @@ + + + + + +darktable user manual - module order + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / module order + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ module order +

+ + + +

Change the order of the processing modules in the darkroom using presets.

+

When processing an image, the active modules are applied in a specific order, which is shown in the right-hand panel of the darkroom view. This module provides information about the current ordering of the processing modules in the pixelpipe. The name of the currently-selected preset is shown in the module header (or “custom” if the user has manually modified the order). The following presets are available for selection.

+
+
v3.0 RAW
+
This is the default module order for scene-referred RAW development workflow.
+
v3.0 JPEG
+
This is the default module order for JPEG development.
+
legacy
+
This module order is used for the legacy display-referred workflow. You will also see this order displayed for any images you previously edited in darktable prior to version 3.0.
+
+
+

Note: changing the order of modules in the pixelpipe is not a cosmetic change to the presentation of the GUI – it has real consequences to how the image will be processed. Please do not change the order of the modules unless you have a specific technical reason and understand why this is required from an image processing perspective.

+
+

For more information about changing module order please refer to the pixelpipe & module order.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/navigation/index.html b/en/module-reference/utility-modules/darkroom/navigation/index.html new file mode 100644 index 0000000000..2989ba605b --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/navigation/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - navigation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / navigation + +
+ + + + +
+ +

+ navigation +

+ + + +

Zoom and pan the current image.

+

The navigation panel (displayed on the top left hand side of the darkroom) shows a full preview of the current image with a rectangle showing the area that is currently visible in the central panel. You can interact with this module using your mouse in the same way as you can interact with the main image (scroll to zoom in/out, middle-click to cycle through zoom levels, click+drag to pan). Alternatively, the current zoom scale is displayed in a combobox to the bottom-right of the preview – click to choose from a number of common zoom levels or type a number to set the zoom level manually.

+

The navigation panel can be toggled on/off with a keyboard shortcut (Ctrl+Shift+N by default).

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/raw-overexposed/index.html b/en/module-reference/utility-modules/darkroom/raw-overexposed/index.html new file mode 100644 index 0000000000..0de066423f --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/raw-overexposed/index.html @@ -0,0 +1,3054 @@ + + + + + +darktable user manual - raw overexposed warning + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / raw overexposed warning + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ raw overexposed warning +

+ + + +

Highlight areas of the image where color channels of the raw input file are clipped.

+

Clipped color channels imply an overexposed image with loss of information in the affected areas. Some of this information may be recoverable using the highlight reconstruction, color reconstruction or filmic rgb modules.

+

Click on the + + + + + + + + +raw overexposed + + icon to show/hide the warning overlay. Right-click on the icon to open a dialog containing the following configuration parameters.

+
+
mode
+
Choose how to mark clipped areas:
+
+
    +
  • mark with CFA color: Display a pattern of the respective primary colors (red, green, and blue) to indicate which color channels are clipped.
  • +
+
+
+
    +
  • mark with solid color: Mark clipped areas with a user defined solid color (see below) independent of the affected color channels.
  • +
+
+
+
    +
  • false color: Set clipped color channels to zero in the affected areas.
  • +
+
+
color scheme
+
Choose the solid color for the mark with solid color mode.
+
clipping threshold
+
Set the threshold defining what values are considered to be overexposed. You can safely leave this slider at its default value of 1.0 (white level) in most cases.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/raw-overexposed/raw-overexposed-icon.png b/en/module-reference/utility-modules/darkroom/raw-overexposed/raw-overexposed-icon.png new file mode 100644 index 0000000000..d5fea45d42 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/raw-overexposed/raw-overexposed-icon.png differ diff --git a/en/module-reference/utility-modules/darkroom/snapshots/index.html b/en/module-reference/utility-modules/darkroom/snapshots/index.html new file mode 100644 index 0000000000..d2657ab34c --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/snapshots/index.html @@ -0,0 +1,3027 @@ + + + + + +darktable user manual - snapshots + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / snapshots + +
+ + + + +
+ +

+ snapshots +

+ + + +

Store development snapshots and compare with the current edit.

+

Snapshots can be taken at any point in the development process and later overlaid onto the current center view. This allows you to undertake a side by side comparison (by default left=snapshot, right=active edit) while you are tuning parameters of a module. It can also be combined with the history stack module to compare a snapshot against different stages of development.

+

To take a snapshot, click on the take snapshot button. Above the button you will see a list of the snapshots that have been taken for this editing session. The name of each snapshot reflects the name of the module selected in the history stack and its position at the time the snapshot was taken. You can choose your own label for a snapshot by Ctrl+clicking on the snapshot name – this will be displayed after the module name, separated with a bullet.

+

Click on the name of a snapshot to show it – this enables a split view between the saved snapshot image and the current state of the processed image. You can control the position of the split-line by clicking and dragging the line with your mouse. If you hover over the split-line with your mouse, a small rotation icon will appear on the center of the line. Click this icon to change between vertical and horizontal split view – the positions of the snapshot and current image will be rotated anti-clockwise allowing you to choose whether they appear to the top, bottom, left or right of the screen.

+

At all times, an arrow containing the letter “S” is displayed to indicate which side of the image is the snapshot and which is the current edit.

+

You can pan or zoom the image while using the snapshot view using your keyboard or mouse. To pan with the mouse you will need to hold the “a” key while clicking and dragging (this key can be configured in preferences > shortcuts > views > darkroom > force pan & zoom with mouse).

+

Click on the name of the snapshot again to disable the overlay and return to your editing session. Click the module’s reset button to remove all existing snapshots.

+
+

Note: Snapshots are retained for the duration of your darktable session. This means that you can also use snapshots to compare with another image. Just navigate to that image and enable the snapshot view as normal. When you do this, an arrow appears in the snapshot name to indicate it was not taken from the current image – hover over the name with your mouse to see the originating image name in a tooltip.

+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/soft-proof/index.html b/en/module-reference/utility-modules/darkroom/soft-proof/index.html new file mode 100644 index 0000000000..4f58e3efd8 --- /dev/null +++ b/en/module-reference/utility-modules/darkroom/soft-proof/index.html @@ -0,0 +1,3043 @@ + + + + + +darktable user manual - soft proof + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / darkroom / soft proof + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ soft proof +

+ + + +

View your image rendered using a selected color profile.

+

Click the + + + + + + + + +soft proof + + icon to activate the soft proof display mode on your image. This allows you to preview your image rendered using a printer profile to see how colors will end up on the final print. You can also activate soft proof with the keyboard shortcut Ctrl+S. A message “soft proof" on the bottom left of your image tells you that you are in soft proof display mode.

+

Right-click on the icon to open a dialog with the following configuration parameters. For each of these parameters, the list of available profiles is read from $DARKTABLE/share/darktable/color/out and $HOME/.config/darktable/color/out (where $DARKTABLE represents darktable’s installation directory and $HOME your home directory). Note that these color/out directories are not created by the darktable install; if you need to use one, you must create it yourself.

+
+
display profile
+
Set the color profile for the display. The option “system display profile” is the preferred setting when working with a calibrated display. The profile is taken either from your system’s color manager or from your X display server. The method darktable uses to detect your system display profile can be changed in preferences > miscellaneous. For more information see the display profile section.
+
preview display profile
+
Set the color profile for the preview image if you are using a second window.
+
intent
+
Set the rendering intent for your display – only available if rendering with LittleCMS2 is activated. See rendering intent for a list of available options. This option appears twice – once for the “display profile” and once for the “preview display profile”.
+
softproof profile
+
Set the color profile for soft proofing. Typically these profiles are supplied by your printer or generated during printer profiling.
+
histogram profile
+
Set the color profile of the histogram. None of the available options are ideal, however, “system display profile” is probably the least bad setting, since all other profiles are derived from the display color space and at least the values will conform to what you see on screen.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/darkroom/soft-proof/soft-proof-icon.png b/en/module-reference/utility-modules/darkroom/soft-proof/soft-proof-icon.png new file mode 100644 index 0000000000..eaeb532e48 Binary files /dev/null and b/en/module-reference/utility-modules/darkroom/soft-proof/soft-proof-icon.png differ diff --git a/en/module-reference/utility-modules/index.html b/en/module-reference/utility-modules/index.html new file mode 100644 index 0000000000..0a98a1f479 --- /dev/null +++ b/en/module-reference/utility-modules/index.html @@ -0,0 +1,3051 @@ + + + + + +darktable user manual - utility modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Module Reference / utility modules + +
+ +
+ +
+ + + +
+
+ + +
+ +

utility modules

+ +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/index.xml b/en/module-reference/utility-modules/index.xml new file mode 100644 index 0000000000..7d0d201d16 --- /dev/null +++ b/en/module-reference/utility-modules/index.xml @@ -0,0 +1,11 @@ + + + + utility modules on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/ + Recent content in utility modules on darktable user manual + Hugo + en + + + diff --git a/en/module-reference/utility-modules/lighttable/history-stack/index.html b/en/module-reference/utility-modules/lighttable/history-stack/index.html new file mode 100644 index 0000000000..348e521c82 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/history-stack/index.html @@ -0,0 +1,3119 @@ + + + + + +darktable user manual - history stack + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / history stack + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ history stack +

+ + + +

Manipulate the history stack of one or more selected images.

+

🔗module controls

+
+
selective copy…
+
Copy parts of the history stack from the selected image. A dialog will appear, from which you will be able to select which history stack items you want to copy. For any module, you may also choose to “reset” that module’s parameters – this will cause the module to be copied but with all controls set to their initial (default) state (as if you had clicked the module reset button).
+
+

If more than one image is selected, the history stack is taken from the image that was selected first. Double-click on a history item to copy that item only and immediately close the dialog.

+
+
copy
+
Copy the complete history stack from the selected image. If more than one image is selected, the history stack is taken from the image that was selected first.
+
+

Information relating to internal display encoding and mask management is considered unsafe to automatically copy to other images and will therefore not be copied when using this button.

+
+
+

The following modules are excluded from the copy operation:

+
+
+ +
+
+
+
+
+
+
+
+
+
+
+
    +
  • deprecated modules
  • +
+
+
+

You can override all of these exclusions by using “selective paste…” and choosing which modules to paste to the target image(s).

+
+
compress history
+
Compress the history stack of the selected image. If any module appears multiple times in the history stack, these occurrences will be compressed into a single step in the history. Beware: this action can not be undone!
+
discard history
+
Physically delete the history stack of the selected images. Beware: this action can not be undone!
+
selective paste…
+
Paste parts of a copied history stack onto all selected images. As with the selective copy button, a dialog appears from which you may choose the items to paste (or “reset”) from the source history stack.
+
paste
+
Paste all items of a copied history stack onto all selected images.
+
mode
+
This setting defines how the paste actions behave when applied to an image that already has a history stack. In simple terms the “overwrite” mode deletes the previous history stack before pasting, whereas “append” concatenates the two history stacks together.
+
+

A copied history stack can have multiple entries of the same module (with the same name or different names) and pasting behaves differently for these entries in append and overwrite modes.

+
+
+

In append mode, for each module in the copied history stack, if there is a module in the destination image with the same name it will be replaced. If there is no such module, a new instance will be created. In both cases the pasted instance is placed on top of the history stack. If a particular module appears multiple times in either history stack only the last occurrence of that module will be processed.

+
+
+

In overwrite mode the behavior is the same except that the history of the destination image is deleted before the paste operation commences. The “copy all”/“paste all” actions in this mode will precisely duplicate the copied history stack to the destination images (including any duplicate occurrences).

+
+
+

Note: If you use the “copy” button (copy all safe modules) followed by the “paste” button (paste all copied modules), the paste will always be done in overwrite mode, regardless of the setting of this parameter. Similarly when performing the same operation using keyboard shortcuts.

+
+
+
+
+
Notes
+
    +
  • Automatic module presets are only added to an image when it is first opened in the darkroom or its history stack is discarded. If you use overwrite mode to paste history stack entries to images that haven’t previously been opened in the darkroom then the next time that image is opened in the darkroom, automatic presets will be applied to the image. It may therefore seem as if the “overwrite” mode did not accurately duplicate the existing history stack, but in this case, those automatic modules were added subsequently.
  • +
+
+
+
    +
  • The append mode allows you to later reconstruct your pre-existing history stack (because previous history items are retained in the stack of the destination image). However, in “overwrite” mode all previous edits are irrevocably lost.
  • +
+
+
+
    +
  • The mode setting is retained when you quit darktable – if you change it for a one-off copy and paste, make sure to change it back again.
  • +
+
+
+
+
+
load sidecar file
+
Open a dialog box which allows you to import the history stack from a selected XMP file. The imported history stack is used to completely replace the current history stack(s) of the selected image(s). Caution: this operation can not be undone!
+
+

Images that were exported by darktable typically contain the full history stack if the file format supports embedded metadata (see the export module for details of this feature and its limitations). You can load an exported image as a sidecar file in the same way as you can with an XMP file. This feature allows you to recover all parameter settings if you have accidentally lost or overwritten the XMP file. All you need is the source image, typically a raw, and the exported file.

+
+
write sidecar files
+
Write XMP sidecar files for all selected images. The filename is generated by appending “.xmp” to the name of the underlying input file.
+
+

By default darktable generates and updates sidecar files automatically whenever you work on an image and change the history stack. You can disable automatic sidecar file generation in preferences > storage. This can be useful when you are running multiple versions of darktable (so that edits in each version do not conflict with one another) however, in general, disabling this feature is not recommended.

+
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/import/eye-icon.png b/en/module-reference/utility-modules/lighttable/import/eye-icon.png new file mode 100644 index 0000000000..02406abeb2 Binary files /dev/null and b/en/module-reference/utility-modules/lighttable/import/eye-icon.png differ diff --git a/en/module-reference/utility-modules/lighttable/import/import-dialog.png b/en/module-reference/utility-modules/lighttable/import/import-dialog.png new file mode 100644 index 0000000000..2447916f4a Binary files /dev/null and b/en/module-reference/utility-modules/lighttable/import/import-dialog.png differ diff --git a/en/module-reference/utility-modules/lighttable/import/index.html b/en/module-reference/utility-modules/lighttable/import/index.html new file mode 100644 index 0000000000..9b3766e642 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/import/index.html @@ -0,0 +1,3136 @@ + + + + + +darktable user manual - import + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / import + +
+ + + + +
+ +

+ import +

+ + + +

Add images to the darktable library, optionally copying them from another location on the filesystem or from a connected camera.

+

See supported file formats for more information.

+

🔗module controls

+

The following buttons are shown in the module’s UI by default:

+
+
add to library
+
Add existing images to the darktable library without copying or moving files. If you only add a single image to the library it will be automatically loaded in the darkroom.
+
copy & import
+
Create copies of images from the filesystem and then add those copies to the darktable library.
+
+

When a camera is detected, a new section will appear in the module for that device. If you hover your mouse over the camera label, a tooltip will display information about the camera (model, firmware version etc.)

+

Depending on the capabilities of the camera, the following additional buttons may be displayed:

+
+
mount camera
+
Mount the camera for exclusive use by darktable. This button only appears if the camera is not currently mounted and is not locked by another process.
+
copy & import from camera
+
Create copies of images from the connected camera and then add those images to the darktable library. This button only appears if the camera is currently mounted.
+
tethered shoot
+
Open the tethering view so that you can take images with your connected camera using darktable. This button only appears if the camera is currently mounted.
+
unmount camera
+
Unmount the camera and release it for use by other applications. This button only appears if the camera is currently mounted.
+
+

🔗module parameters

+

Click on the “parameters” label or the expander button beside it to display the following additional options.

+

All parameters are retained from one session to the next and can be saved as module presets.

+
+
ignore exif rating
+
Check this option to ignore any rating stored within the image’s Exif data and instead use a hard-coded value (below).
+
initial rating
+
Initial star rating (from 0 to 5) to use for all newly-imported images (default 1).
+
apply metadata
+
Check this option to automatically set metadata fields and/or tags at import time (see below).
+
metadata
+
If the “apply metadata” box is checked, a list of the visible metadata fields is presented for completion (see metadata editor for details). Any populated strings are automatically added to the imported images. You can also choose from any presets saved within the metadata editor module.
+
+

Double-click on a label to reset the corresponding field. Double-click on the “metadata presets” label to reset all fields.

+
+
+

If preferences > storage > create XMP files is set to “never”, an additional column “from XMP” is presented so that you can choose to prevent the import of metadata from XMP files.

+
+
tags
+
If you want to add further tags by default when importing images, you can provide them here as a comma separated list. As with metadata you can also choose from any presets saved within the tagging module.
+
+

🔗import dialog

+

Each of the three import buttons (add to library, copy & import, copy & import from camera) uses a similar dialog for the import process, described in this section.

+

The following example screenshot is taken from the “add to library” button:

+

+ + + + + + + + +import-dialog + +

+

🔗common functionality

+

🔗places and folders

+

The import dialog is intended to allow you to set up common import locations, to make subsequent imports as simple as possible. When you first open the dialog, darktable attempts to add some common locations (home, pictures, mounted devices) to the places pane. You can add new places to the list by clicking on the + button and you can remove places from the list by right-clicking on them. If you wish to restore a default location that you have deleted, you can do this with the reset button.

+

When you choose a place, the folder tree is automatically populated (into the folders pane) from the root directory of the selected place. You can then navigate the folder tree and select a folder for import. The last selected place/folder is automatically reloaded the next time you open the dialog.

+

In the example screenshot above, you can see that a “place” has been created for the root of the Photos folder and a sub-folder within that structure has been selected. This is the recommended workflow for the import process – you should not have to create new places very often.

+

🔗files

+

Once you have selected a folder, the files pane will automatically be populated with a list of the files found in that folder. By default, all files in the chosen folder are selected.

+

You can view thumbnails for any of the images by clicking on the + + + + + + + + +eye icon + + icon. In addition, buttons are available at the bottom of the screen to select “all” files or “none”.

+

Once you are happy with your selection, press Enter or click on the button at the bottom-right of the screen to import (this button will be named differently depending on the type of import being performed).

+

Press Escape or click the “cancel” button to exit without importing.

+

🔗common options

+

The following additional options are common to all import dialogs:

+
+
recursive directory
+
Check this option to import images in the selected folder and all subfolders. It is recommended that you not use this option to import a large number of images at the same time. The import process causes darktable to generate thumbnails for all of the imported images, but in the end it will only be able to keep the most recent in its cache. It is therefore better to import images in smaller chunks to avoid the performance penalty this imposes.
+
ignore JPEG images
+
Check this option if there are JPEG images in the same folder that you do not wish to import. This option is usually used where the camera stores RAW+JPEG and you only want to work on the RAW files, leaving the JPEG images untouched.
+
+

🔗add to library

+

The “add to library” button allows you to add one or more existing images to the darktable library from the local filesystem. This process does not copy or move images but merely adds their details to the library database and creates XMP sidecar files for them.

+
+
select only new pictures
+
Tick this box to restrict the initial selection (when the dialog is loaded) to only those images that have not already been loaded into the darktable library. If you attempt to reload existing images into the darktable library, data for those images will be reloaded from the XMP sidecar files. A button is also available at the bottom of the dialog to select only “new” images for the currently-selected folder.
+
+
+

Note: “Add to library” does not create duplicates of your image files in a separate folder structure but processes them in-situ. The “add to library” process simply adds details of those images to darktable’s library database (and creates an XMP sidecar file if applicable) allowing the images to be viewed and developed.

+

This means that if you delete images from disk after having added them, darktable cannot access them any more. Moreover, darktable does not watch for changes in the filesystem. Any new images will not be shown until they are explicitly imported.

+
+

🔗copy & import

+

This option copies images from another location on your filesystem (including mounted storage devices) and then adds the copied images to the darktable library. Using this option, if an existing XMP sidecar file is available for the image, it will not be read or copied and a new XMP will be created.

+

The following additional options are available to control the file and directory naming of the copied files. By default, only the “import job” option is shown – click on the “naming rules” label or the expander icon beside it to show additional options:

+
+
import job
+
The name of the import job (populated into the $(JOBCODE) variable).
+
override todays’s date
+
Enter a valid date/time (in YYYY-MM-DD[Thh:mm:ss] format) if you want to override the current date/time used when expanding the variables $(YEAR), $(MONTH), $(DAY), $(HOUR), $(MINUTE) and $(SECONDS). Leave the field empty otherwise.
+
base directory naming pattern
+
The base directory part of the naming pattern (default $(PICTURES_FOLDER)/Darktable). Click on the icon beside the input field to choose a directory manually.
+
sub directory naming pattern
+
The sub directory part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(JOBCODE)).
+
keep original filename
+
Check this box to keep the original filename instead of using the pattern below when importing.
+
file naming pattern
+
The file name part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(SEQUENCE).$(FILE_EXTENSION)).
+
keep this window open
+
Keep the window open after the import is complete, allowing multiple imports but with different naming options.
+
+

Most of these options can also be set in preferences > import. See this section for more information about the available variables.

+

🔗copy & import from camera

+

This option copies files from a connected camera to the local filesystem and then adds the copied images to the darktable library. It provides the same naming options as the “copy & import” dialog but does not allow places or folders to be selected.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/index.html b/en/module-reference/utility-modules/lighttable/index.html new file mode 100644 index 0000000000..5eec0e8718 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/index.html @@ -0,0 +1,3059 @@ + + + + + +darktable user manual - lighttable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/index.xml b/en/module-reference/utility-modules/lighttable/index.xml new file mode 100644 index 0000000000..7bf05da24d --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/index.xml @@ -0,0 +1,60 @@ + + + + lighttable on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/ + Recent content in lighttable on darktable user manual + Hugo + en + + + actions on selection + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/selected-image/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/selected-image/ + Perform actions on images that have been selected in the lighttable view. 🔗module controls The module controls are spread over two tabs for manipulating the image files and the related metadata. 🔗images tab remove Remove the selected images from the darktable library without deleting them. Removed images can no longer be viewed or edited within darktable but the image files remain on the filesystem along with any XMP sidecar files. As darktable keeps the XMP files up-to-date with your latest development history, you can fully restore your work later by re-importing the images. + + + history stack + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/history-stack/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/history-stack/ + Manipulate the history stack of one or more selected images. 🔗module controls selective copy&hellip; Copy parts of the history stack from the selected image. A dialog will appear, from which you will be able to select which history stack items you want to copy. For any module, you may also choose to &ldquo;reset&rdquo; that module&rsquo;s parameters &ndash; this will cause the module to be copied but with all controls set to their initial (default) state (as if you had clicked the module reset button). + + + import + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/import/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/import/ + Add images to the darktable library, optionally copying them from another location on the filesystem or from a connected camera. See supported file formats for more information. 🔗module controls The following buttons are shown in the module&rsquo;s UI by default: add to library Add existing images to the darktable library without copying or moving files. If you only add a single image to the library it will be automatically loaded in the darkroom. + + + lua scripts installer + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/lua-scripts-installer/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/lua-scripts-installer/ + As described in lua scripts, darktable provides powerful scripting capabilities to extend its functionality and integrate with other software. Many such scripts are already available. The Lua script installer module helps to install them without the need for manual configuration. The first time it is run, instructions are displayed in the module. For the module to be able to install the scripts, you will need to have git installed and available on your path. + + + selection + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/select/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/select/ + Select images in the lighttable according to simple criteria. 🔗module controls select all Select all images in the current collection. select none De-select all images. invert selection Select all images in the current collection that are not currently selected. select film roll Select all images in the current collection that are in the same film roll as the currently-selected images. select untouched Select all images in the current collection that have not yet been developed. + + + styles + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/styles/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/styles/ + Create named styles from selected images&rsquo; history stacks and apply styles to selected images. Styles can either be created within this panel or in the history stack module in the darkroom. A list of all available styles is displayed in the module. A search field above the list allows you to locate a style by name or description. This module also allows styles to be edited and deleted. Double-click on a style name to apply that style to all selected images. + + + timeline + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/timeline/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/timeline/ + View your images by the date/time they were taken. In the lighttable filemanager view, you can show/hide the timeline module in the bottom panel with the shortcut Ctrl+F. Within the timeline, you can show the next and previous dates by scrolling your mouse; Ctrl+scroll to zoom in/out. You can also use the timeline to select images by date range by clicking and dragging your mouse. + + + diff --git a/en/module-reference/utility-modules/lighttable/lua-scripts-installer/index.html b/en/module-reference/utility-modules/lighttable/lua-scripts-installer/index.html new file mode 100644 index 0000000000..8a03231c65 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/lua-scripts-installer/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - lua scripts installer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / lua scripts installer + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ lua scripts installer +

+ + + +

As described in lua scripts, darktable provides powerful scripting capabilities to extend its functionality and integrate with other software. Many such scripts are already available. The Lua script installer module helps to install them without the need for manual configuration. The first time it is run, instructions are displayed in the module.

+

For the module to be able to install the scripts, you will need to have git installed and available on your path. You can get it from git-scm.com.

+

The officially supported scripts are documented here.

+

The module can be disabled with an option in preferences > lua options.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/select/index.html b/en/module-reference/utility-modules/lighttable/select/index.html new file mode 100644 index 0000000000..bc954afe26 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/select/index.html @@ -0,0 +1,3031 @@ + + + + + +darktable user manual - selection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / selection + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ selection +

+ + + +

Select images in the lighttable according to simple criteria.

+

🔗module controls

+
+
select all
+
Select all images in the current collection.
+
select none
+
De-select all images.
+
invert selection
+
Select all images in the current collection that are not currently selected.
+
select film roll
+
Select all images in the current collection that are in the same film roll as the currently-selected images.
+
select untouched
+
Select all images in the current collection that have not yet been developed.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/selected-image/index.html b/en/module-reference/utility-modules/lighttable/selected-image/index.html new file mode 100644 index 0000000000..14639880ca --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/selected-image/index.html @@ -0,0 +1,3064 @@ + + + + + +darktable user manual - actions on selection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / actions on selection + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ actions on selection +

+ + + +

Perform actions on images that have been selected in the lighttable view.

+

🔗module controls

+

The module controls are spread over two tabs for manipulating the image files and the related metadata.

+

🔗images tab

+
+
remove
+
Remove the selected images from the darktable library without deleting them. Removed images can no longer be viewed or edited within darktable but the image files remain on the filesystem along with any XMP sidecar files. As darktable keeps the XMP files up-to-date with your latest development history, you can fully restore your work later by re-importing the images.
+
delete / delete (trash)
+
Remove the selected images from the darktable library and remove any associated XMP sidecar files from the filesystem. If no duplicates of a removed image remain in the darktable library, the image file itself is also deleted. You can control whether this action irrevocably deletes the files or attempts to put them into your system’s trash bin with a configuration item in preferences > security. A second configuration item in the same tab allows you to control whether or not to be prompted before deleting images.
+
move
+
Physically move selected images (the image files plus all associated XMP sidecars) to another folder on the filesystem. If an image with the given filename already exists in the target folder the source image will not be moved.
+
copy
+
Physically copy selected images (the image file plus all associated XMP sidecars) to another folder on the filesystem. If an image with the given filename already exists in the target folder it will not be overwritten – instead a new duplicate will be generated with the same history stack as the source image.
+
create hdr
+
Create a high dynamic range image from the selected images, and add the result to the library as a new image in DNG format. Images need to be properly aligned, which implies that they have been taken on a sturdy tripod. You can also generate HDRs with programs like Luminance HDR, and later import them into darktable for further processing. Note that darktable can only create HDR images from raw files.
+
duplicate
+
Create duplicates of the selected images within darktable. Duplicate images share the same image file, but each duplicate has its own XMP sidecar file and a separate entry in darktable’s library database. This allows you to test different edits on the same image.
+
rotation
+
Perform a clockwise or counter-clockwise rotation on the selected images. A third button can be used to reset the image rotation to the value stored in the image’s Exif data. This feature is directly linked to the orientation processing module – adjustments made here are automatically converted into a history stack item for that module.
+
copy locally
+
Create local copies of the selected images on the local drive. These copies will then be used when the original images are not accessible (see local copies).
+
resync local copy
+
Synchronize the XMP sidecar of the local copy of each selected image with the copy in external storage, and remove the local copies. Note that if a local copy has been modified and the external storage is not accessible the local copy will not be deleted (see local copies).
+
group
+
Create a new group from the selected images (see image grouping).
+
ungroup
+
Remove the selected images from their group (see image grouping).
+
+

🔗metadata tab

+
+
metadata type checkboxes
+
Choose the types of metadata (ratings, tags, metadata, colors, geo tags) that you want to operate on.
+
copy
+
Copy the chosen types of metadata from the selected image onto the clipboard. If you have more than one image selected, or no images selected, then this button is unavailable.
+
paste
+
Paste any metadata in the clipboard onto the selected images.
+
clear
+
Clear the chosen types of metadata from the selected images.
+
mode
+
When pasting metadata onto images, this option controls whether the metadata on the clipboard should be merged with the existing metadata (merge), or should replace it entirely (overwrite).
+
refresh exif
+
Refresh the Exif data from the source file. Warning: this may overwrite some tags and metadata that you have altered in darktable (such as star ratings).
+
monochrome
+
Flag the image as monochrome, meaning that it will receive any monochrome-specific workflow treatment that is offered by the processing modules. Refer to the developing monochrome images section for more details.
+
color
+
Remove the monochrome flag from the image so that it will receive the default workflow treatment that is normally used when developing color photos.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/styles/index.html b/en/module-reference/utility-modules/lighttable/styles/index.html new file mode 100644 index 0000000000..47de80c485 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/styles/index.html @@ -0,0 +1,3047 @@ + + + + + +darktable user manual - styles + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / styles + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ styles +

+ + + +

Create named styles from selected images’ history stacks and apply styles to selected images.

+

Styles can either be created within this panel or in the history stack module in the darkroom.

+

A list of all available styles is displayed in the module. A search field above the list allows you to locate a style by name or description. This module also allows styles to be edited and deleted.

+

Double-click on a style name to apply that style to all selected images. A style may also be applied to all selected images by pressing a shortcut key assigned to it (see preferences > shortcuts) while in the lighttable or darkroom view.

+

Hover over the style name with your mouse to view a preview of the first selected image with that style applied.

+

Remove all styles by clicking on the module’s reset button.

+

Please note that styles also include the active state of each module. You can use this to create your own default settings, which you can then activate on-demand. Simply set your desired defaults for each module, disable the module, and save the style.

+

🔗module controls

+
+
create duplicate
+
When applying a style to images, tick this box to create a duplicate of each image before applying the chosen style to that duplicate. Disable this option to apply the chosen style directly to the selected images. Beware that in this case any existing history stack is overwritten (depending on the mode – see below) and cannot be recovered.
+
mode
+
As with the history stack module, this combobox allows you to either “append” the style to the current history stack or to “overwrite” the history stack of the target image.
+
create
+
Create new style(s) using the history stack of the selected image(s). For each selected image a style creation window is shown. You must supply a unique name for each new style and you can also add an optional description.
+
+

You will be provided with the option to select which history stack items you want to include in the created style. For any module, you may also choose to “reset” that module’s parameters – this will cause the module to be included in the style but with all controls set to their initial (default) state (as if you had clicked the module reset button).

+
+
+

The panel supports a hierarchical view, meaning that you can create categories using the pipe symbol “|” as a separator. For example “print|tone curve +0.5 EV” will create a “print” category with a style of “tone curve +0.5 EV” below it.

+
+
edit
+
Select “edit” to bring up a dialog which allows you to include or exclude specific items from the stack of an existing style. Check the “duplicate” option if you want to create a new style, instead of overwriting the existing one, in which case you will need to provide a unique name for the new style.
+
remove
+
Delete the selected style, without any further prompt.
+
import
+
Import a previously saved style. Styles are stored as XML files with the extension .dtstyle. If a style with the same name already exists, you will be asked if you wish to overwrite.
+
export
+
Save the selected style to disk as a .dtstyle file. This allows styles to be published and shared with other users.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/timeline/index.html b/en/module-reference/utility-modules/lighttable/timeline/index.html new file mode 100644 index 0000000000..e05ed63231 --- /dev/null +++ b/en/module-reference/utility-modules/lighttable/timeline/index.html @@ -0,0 +1,3033 @@ + + + + + +darktable user manual - timeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / lighttable / timeline + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ timeline +

+ + + +

View your images by the date/time they were taken.

+

+ + + + + + + + +timeline + +

+

In the lighttable filemanager view, you can show/hide the timeline module in the bottom panel with the shortcut Ctrl+F.

+

Within the timeline, you can show the next and previous dates by scrolling your mouse; Ctrl+scroll to zoom in/out.

+

You can also use the timeline to select images by date range by clicking and dragging your mouse.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/lighttable/timeline/timeline.png b/en/module-reference/utility-modules/lighttable/timeline/timeline.png new file mode 100644 index 0000000000..f2f3dfaf02 Binary files /dev/null and b/en/module-reference/utility-modules/lighttable/timeline/timeline.png differ diff --git a/en/module-reference/utility-modules/map/find-location/index.html b/en/module-reference/utility-modules/map/find-location/index.html new file mode 100644 index 0000000000..c902414b6c --- /dev/null +++ b/en/module-reference/utility-modules/map/find-location/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - find location + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / map / find location + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ find location +

+ + + +

Search for a location on the map. You must be connected to the internet to use this feature.

+

To use this module, type in a place name or address, press Enter and a list of results will be shown. Click on an item in the list and the map will zoom to that location. An outline covering that location or a pin pointing at the location will be displayed.

+

An outline (polygon) can be used to create a user location. Check the max polygon points parameter in the map settings module to ensure that sufficient points are available for a polygon to be displayed.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/map/index.html b/en/module-reference/utility-modules/map/index.html new file mode 100644 index 0000000000..28257ed79a --- /dev/null +++ b/en/module-reference/utility-modules/map/index.html @@ -0,0 +1,3031 @@ + + + + + +darktable user manual - map + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+
+ + + +
+
+ + + +
+
+ + +
+ +

map

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/map/index.xml b/en/module-reference/utility-modules/map/index.xml new file mode 100644 index 0000000000..35c42d282d --- /dev/null +++ b/en/module-reference/utility-modules/map/index.xml @@ -0,0 +1,32 @@ + + + + map on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/ + Recent content in map on darktable user manual + Hugo + en + + + find location + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/find-location/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/find-location/ + Search for a location on the map. You must be connected to the internet to use this feature. To use this module, type in a place name or address, press Enter and a list of results will be shown. Click on an item in the list and the map will zoom to that location. An outline covering that location or a pin pointing at the location will be displayed. An outline (polygon) can be used to create a user location. + + + locations + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/locations/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/locations/ + Create areas or locations and organize them as hierarchical tags. A location is shown as a shape on the map when selected. Initially each location is represented as a square or circle and can be changed to a rectangle or ellipse by adjusting the shape&rsquo;s width and/or height. A location can also be created from an OpenStreetMap region (city/country) polygon. To achieve this, first make sure the max polygon points parameter is large enough (some country polygons use more than 150,000 points). + + + map settings + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/map-settings/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/map-settings/ + Select preferred map data from various providers. Some will provide additional layers (satellite view etc.) which you can toggle. 🔗module controls map source Choose the provider to source map information from. max polygon points The find location module doesn&rsquo;t display polygons with more points than this for performance reasons. Usually a country polygon has between 50,000 and 150,000 points. show OSD Choose whether to display the OSD controls at the top-left of the center view. + + + diff --git a/en/module-reference/utility-modules/map/locations/index.html b/en/module-reference/utility-modules/map/locations/index.html new file mode 100644 index 0000000000..0492c6f0e3 --- /dev/null +++ b/en/module-reference/utility-modules/map/locations/index.html @@ -0,0 +1,3073 @@ + + + + + +darktable user manual - locations + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / map / locations + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ locations +

+ + + +

Create areas or locations and organize them as hierarchical tags.

+

A location is shown as a shape on the map when selected. Initially each location is represented as a square or circle and can be changed to a rectangle or ellipse by adjusting the shape’s width and/or height.

+

A location can also be created from an OpenStreetMap region (city/country) polygon. To achieve this, first make sure the max polygon points parameter is large enough (some country polygons use more than 150,000 points). Then select the desired location in the find location module. When the corresponding region shape is displayed, a polygon symbol becomes available in the “shape” control (see below). Select it to create the new location.

+

Each location is stored as tag entry under the geotagging collection in the collections module. The pipe “|” character can be used to insert a new level (a group of locations).

+

🔗module controls

+
+
shape
+
Select the circle or rectangle symbol to choose the default shape for new locations. A polygon symbol is available when a shape is displayed by the find location module.
+
new location / new sub-location
+
When no location is selected you can use the new location button to create a location at root level. When a location is selected use the new sub-location button to create a sub-location within the selected location.
+
show all
+
Show or hide all locations that lie within the visible area of the current map.
+
+

🔗actions on the locations list

+
+
click
+
Select or de-select a location. If the location is not currently visible on the map, the map is automatically centered on that location.
+
Ctrl+click
+
Edit the name of the location. Press Enter to save changes or Esc to close the editing window without saving.
+
right-click
+
Open a sub-menu which allows you to:
+
    +
  • Edit the name of the location.
  • +
+
+
    +
  • Delete the location.
  • +
+
+
    +
  • Update the filmstrip – the filmstrip will be populated with all images in the selected location.
  • +
+
+
    +
  • Switch to the lighttable view and show a collection that contains all images in the selected location.
  • +
+
+
+

🔗actions on locations in the map

+

Note: The following actions have no effect on polygon locations.

+
+
click and drag
+
Move the location shape to a new position on the map.
+
Ctrl+click or Ctrl+Shift+click
+
Move an image or a group of images and place them inside a location shape.
+
mouse scroll
+
When inside a location shape (but not over an image), increase or decrease the size of that shape.
+
When hovering over an image, cycle through the thumbnails of images located at that position on the map.
+
When outside a location shape (and not over an image) zoom the map in or out.
+
Shift+scroll
+
Increase or decrease the width of the location shape.
+
Ctrl+scroll
+
Increase or decrease the height of the location shape.
+
click on a location shape
+
Select a different location when the show all checkbox is selected.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/map/map-settings/index.html b/en/module-reference/utility-modules/map/map-settings/index.html new file mode 100644 index 0000000000..7ba37ff4d4 --- /dev/null +++ b/en/module-reference/utility-modules/map/map-settings/index.html @@ -0,0 +1,3050 @@ + + + + + +darktable user manual - map settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / map / map settings + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ map settings +

+ + + +

Select preferred map data from various providers. Some will provide additional layers (satellite view etc.) which you can toggle.

+

🔗module controls

+
+
map source
+
Choose the provider to source map information from.
+
max polygon points
+
The find location module doesn’t display polygons with more points than this for performance reasons. Usually a country polygon has between 50,000 and 150,000 points.
+
show OSD
+
Choose whether to display the OSD controls at the top-left of the center view.
+
filtered images
+
Check this box to display only the images from the current collection (those shown in the filmstrip) in the center view. Un-check the box to display all images in the current library, where those images have associated GPS data. You can also toggle this option by pressing Ctrl+S.
+
max images
+
The maximum number of thumbnails to display on the map.
+
group size factor
+
Increase or decrease the size of area that causes images to be grouped.
+
min images per group
+
The minimum number of images that need to be placed in the same position in order to automatically create an image group for them.
+
thumbnail display
+
Define what information to show on the map display
+
    +
  • thumbnails: Display image thumbnails along with a counter.
  • +
+
+
    +
  • count: Just display the number of images (to free space on the map). Hover over the number of images to show the corresponding thumbnail(s). A count-only marker behaves the same way as a normal image thumbnail, in terms of color coding, scrolling, drag and drop etc.
  • +
+
+
    +
  • none: Show nothing.
  • +
+
+
You can also cycle through these options by pressing Shift+S.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/print/index.html b/en/module-reference/utility-modules/print/index.html new file mode 100644 index 0000000000..5c297ddbd4 --- /dev/null +++ b/en/module-reference/utility-modules/print/index.html @@ -0,0 +1,3017 @@ + + + + + +darktable user manual - print + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + + +darktable / Module Reference / utility modules / print + +
+ +
+
+ + + +
+ +
+ + +
+ +

print

+ +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/print/index.xml b/en/module-reference/utility-modules/print/index.xml new file mode 100644 index 0000000000..094e00e780 --- /dev/null +++ b/en/module-reference/utility-modules/print/index.xml @@ -0,0 +1,18 @@ + + + + print on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/ + Recent content in print on darktable user manual + Hugo + en + + + print settings + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/print-settings/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/print-settings/ + Manage settings for the print view and initiate printing. 🔗module controls 🔗printer printer Select one of the installed printers. media The type of media loaded on the printer (Plain Paper, Luster Photo Paper, etc.). profile The printer&rsquo;s ICC profile for the loaded paper. This is the profile specific to the printer and paper. This profile is the last color space transformation applied to the picture whose goal is to create a high quality print. + + + diff --git a/en/module-reference/utility-modules/print/print-settings/index.html b/en/module-reference/utility-modules/print/print-settings/index.html new file mode 100644 index 0000000000..5263d07ee6 --- /dev/null +++ b/en/module-reference/utility-modules/print/print-settings/index.html @@ -0,0 +1,3080 @@ + + + + + +darktable user manual - print settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / print / print settings + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ print settings +

+ + + +

Manage settings for the print view and initiate printing.

+

🔗module controls

+

🔗printer

+
+
printer
+
Select one of the installed printers.
+
media
+
The type of media loaded on the printer (Plain Paper, Luster Photo Paper, etc.).
+
profile
+
The printer’s ICC profile for the loaded paper. This is the profile specific to the printer and paper. This profile is the last color space transformation applied to the picture whose goal is to create a high quality print.
+
intent
+
The print rendering intent (“perceptual”, “relative colorimetric”, “saturation” or “absolute colorimetric”). See rendering intent for more details.
+
black point compensation
+
Whether to adjust the black point of the output profile, which is often lighter than the input profile. This should be “on” when the intent is set to “relative colorimetric”.
+
+

🔗page

+
+
paper size
+
The size of the paper on which to print.
+
orientation
+
Portrait or landscape (note that darktable chooses the best fit by default).
+
units
+
The unit to use for setting the margins: “mm”, “cm”, or “inch”.
+
margins
+
Set each margin separately, or all together by clicking on the middle “lock” button.
+
display grid
+
Select the grid size using the entry field (expressed in the currently selected unit). Tick the option to display the grid on the canvas.
+
snap to grid
+
Help setting the image areas by snapping them to the grid for proper alignment.
+
borderless mode required
+
Indicates whether the printer borderless mode is to be activated. This item is activated when the user’s margins are smaller than the printer hardware margins. Note that it is only an indicator as it does not activate the borderless mode automatically.
+
+

🔗image layout

+
+
image width/height
+
This information field displays the actual image width and height (given with the selected units) on the paper.
+
scale factor
+
This information field displays the scaling of the image to fit on the paper. If this value is less than 1 the image is down-scaled, otherwise it is up-scaled. This is an important factor to watch – a value that is too large (up-scale) may result in a low quality print. The corresponding dpi (dots per inch) is also displayed.
+
alignment
+
Select the alignment of the image on its area.
+
new image area button
+
Create a new image area. Drag and drop on the canvas to place it. If the option snap to grid is activated the area can be easily aligned to the grid lines. An image can be placed into this area by dragging it from the filmstrip and dropping it on the new area.
+
delete image area button
+
Remove the currently selected image area from the composition.
+
clear layout button
+
Remove all the image areas leaving the canvas empty.
+
+

The following four fields represent the position of currently selected area on the page – the top/left corner on the first line and the width/height of the area on the second line.

+

When hovering an image area its position and size are displayed. It is also possible to grab the side and corner of the area to change the size or to drag the whole area to change its position.

+

The page layout can be recorded using a preset.

+ +
+
profile
+
The export profile to use. This profile is the entry point used for the next transformation using the printer’s ICC profile. Usually it is better to prefer a large gamut (e.g. Adobe RGB) rather than a smaller one (e.g. sRGB).
+
intent
+
The rendering intent to use when exporting the image. For more information see rendering intent.
+
style
+
Choose a style to apply when exporting the image – defaults to “none”. See the export module for a more detailed discussion of applying a style during export.
+
mode
+
Whether the chosen style should be appended to the existing history stack or replace it completely. See the export module for more details.
+
+ +

When clicked, the images are first exported using the selected options, then composed on the page and finally sent to the printer.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/collection-filters/aperture-range-filter.png b/en/module-reference/utility-modules/shared/collection-filters/aperture-range-filter.png new file mode 100644 index 0000000000..5ac2788909 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/aperture-range-filter.png differ diff --git a/en/module-reference/utility-modules/shared/collection-filters/capture-date-filter.png b/en/module-reference/utility-modules/shared/collection-filters/capture-date-filter.png new file mode 100644 index 0000000000..153932f0dd Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/capture-date-filter.png differ diff --git a/en/module-reference/utility-modules/shared/collection-filters/color-filter-and.png b/en/module-reference/utility-modules/shared/collection-filters/color-filter-and.png new file mode 100644 index 0000000000..1ca1606056 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/color-filter-and.png differ diff --git a/en/module-reference/utility-modules/shared/collection-filters/color-filter-or.png b/en/module-reference/utility-modules/shared/collection-filters/color-filter-or.png new file mode 100644 index 0000000000..a57030db4e Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/color-filter-or.png differ diff --git a/en/module-reference/utility-modules/shared/collection-filters/color-filter.png b/en/module-reference/utility-modules/shared/collection-filters/color-filter.png new file mode 100644 index 0000000000..036df58f71 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/color-filter.png differ diff --git a/en/module-reference/utility-modules/shared/collection-filters/index.html b/en/module-reference/utility-modules/shared/collection-filters/index.html new file mode 100644 index 0000000000..3ee97ad53a --- /dev/null +++ b/en/module-reference/utility-modules/shared/collection-filters/index.html @@ -0,0 +1,3170 @@ + + + + + +darktable user manual - collection filters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / collection filters + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ collection filters +

+ + + +

Filter the collection of images displayed in the lighttable view and filmstrip panel using image attributes, optionally pinning filters to the top panel for quick access.

+

Once you have defined a collection of images with the collections module, the collection filters module allows you to define additional filters and sort criteria. For example, you might wish to show all images in a given folder using the collections module and then define additional quick filters to narrow-down by star rating and/or color label.

+

🔗filtering attributes

+

For information about the image attributes you can select, please see the documentation for the collections module.

+

Note that only a subset of filters is currently implemented – more will be added in future versions of darktable.

+

🔗default settings

+

By default, three filters (range rating, color label and text search are defined within this module. By default these filters select all images (i.e. show images with any star rating or color label) and are all pinned to the top panel for quick access. This default setting is also available as the “initial setting” preset.

+

🔗module controls

+

🔗adding new filters

+

To add a new filter to the module, click on the “new rule” button and select an image attribute to use.

+

🔗combining multiple filters

+

When you use multiple filters, the first item on the filter header allows you to define how the filter is combined with the previous one.

+
+
and
+
Narrow down search. An image is only retained if it also fulfills the new criteria.
+
or
+
Add more images. Images from the collection that fulfill the new criteria are added.
+
and not
+
Exclude images. Images that fulfill the new criteria are removed.
+
+
+

Note: The and/or/not operators have a defined order of precedence such that “not” is executed first, then “and” and finally “or”. This means, for example, that if you define complex filters like “A and B or C and not D” these will be implemented as “(A and B) or (C and (not D))”.

+
+

🔗removing or deactivating filters

+

You can remove or temporarily deactivate a specific filter using the buttons on the right of the filter header (see screenshots in the following sections). If a filter is pinned to the top panel, you will need to unpin it before removing or deactivating.

+

🔗pinning into the top toolbar

+

The pin button on the right of the filter header allows you to pin a filter to the top panel. To avoid unwanted actions, pinned filters can’t be removed or deactivated.

+

🔗resetting filters

+

Clicking on the module reset button will remove all un-pinned filters and reset all others to their default values. If you want to also remove the pinned filters, you can Ctrl+click on the reset button.

+

🔗returning to a previous set of filters

+

You can return to a previously-defined set of filters by clicking on the history button at the bottom of the module and selecting from the resulting list.

+

🔗filter widgets

+

A number of filter widgets have been created for use within this module. Since some of these widgets use non-standard interfaces, their usage is explained in the following sections:

+

🔗color labels

+

The following image shows the color labels widget, set to filter images having yellow or green color labels:

+

+ + + + + + + + +color filter + +

+

You can interact with this filter widget as follows:

+
    +
  • Click on a color label to include images with that label
  • +
  • Ctrl+click on a color label to include images without that label
  • +
  • Click or Ctrl+click on the gray icon to act on all color labels simultaneously
  • +
  • Use the last button to define how to handle the selection of multiple color labels. Select + + + + + + + + +and + + (and) to filter images having all of the selected color labels; Select + + + + + + + + +or + + (or) to filter images with at least one of the selected color labels.
  • +
+

🔗rating

+

This is the classic rating selection widget that used to be shown in darktable’s top panel by default.

+

+ + + + + + + + +rating filter + +

+

This widget is composed of a pair of comboboxes. The combobox on the right (always visible) is used to choose a number of stars, plus some additional options (“all”, “unstarred only”, “rejected only”, “all except rejected”). The combobox to the left (only shown when a star rating is chosen in the right-hand combobox) is used to choose an operator (<, <=, =, >, >=, ≠).

+

🔗range rating

+

This new widget also allows you to select images by star rating, this time using a new “range” widget. The following image shows the widget with ratings of 2-4 stars selected.

+

+ + + + + + + + +range rating filter + +

+

You can choose a new range of ratings to filter by clicking and dragging over the widget’s interface. You can also access pre-defined ranges by right-clicking and selecting from the popup menu. The number of applicable images is also shown against each entry in this menu.

+

🔗range filters for numeric attributes

+

Numeric attributes (aperture, exposure, focal length, iso, aspect ratio) are filtered using a widget that shows a histogram of the number of images available depending on the value of the given attribute (similar to the timeline in the lighttable view).

+

For example, the following image shows the widget when used for selecting by aperture:

+

+ + + + + + + + +aperture range filter + +

+

As with the range rating filter, you can select a range of values to filter by clicking and dragging on the widget. You can also access predefined ranges by right-clicking and selecting from the popup menu. The number of applicable images is also shown against each entry in this menu.

+

You can also use the “min” and “max” text entry fields in the main module interface to manually define the bounds of the selection.

+

🔗date attributes

+

As with numeric and rating range filters, date/time filters are represented using a “range” widget. You can select a range of values by clicking and dragging on the widget, and use the right-click menu for more options.

+

+ + + + + + + + +date range filter + +

+

You can also use the “min” and “max” text entry fields in the main module interface to manually define the bounds of the selection (right-click for more options).

+

The date/time format used by this module is YYYY:MM:DD HH:MM:SS (only the year values are mandatory).

+

The keyword now is allowed in the max field (to define the current date/time).

+

You can also use “relative” date/time values by preceding text entries with + or -. This allows you to set the maximum or minimum bound of the range relative to the other bound. As an example if you set the min value to -0000:01 and the max value to 2022:04:15, this will select images taken during the month before April 15th 2022.

+

🔗filename

+

The filename filter allows you to search images by their filename and/or extension. You can either enter the name or extension (with the leading .) manually or use the right-click menu to select.

+

Within the extension field, you can also use the keywords RAW (to select all handled RAW file extensions), NOT RAW (to select all non-RAW file extensions), LDR (to select low-dynamic-range extensions) or HDR (to select high-dynamic-range extensions).

+

🔗camera, lens

+

The camera and lens filters are presented text entry fields into which you can enter text to filter by. Alternatively, you can right-click on the text box to see a list of cameras or lenses to select from.

+ +

You can search images using any of their text properties (path, filename, filmroll, tags, metadata, camera, maker) using the text search filter. The search is performed “on-the-fly” and the widget is dimmed during the search process.

+

By default darktable performs a “fuzzy” search (wildcards are automatically added to the start and the end of the text). If you want to search for an exact match, you can enclose it with double-quotes ("match this exactly").

+

🔗sorting

+

The bottom part of the module allows you to define the sort order of the images when displayed in the lighttable and filmstrip views. As with the filter criteria, you can add multiple rules to this section. However, only the first-selected sort criteria is pinned to the top panel (this cannot be unpinned).

+

As with filter criteria, the history button allows you to access any previously-used sort criteria.

+

The button to the right of the attribute selection allows you to choose whether to sort that criteria in ascending or descending order.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/collection-filters/range-rating-filter.png b/en/module-reference/utility-modules/shared/collection-filters/range-rating-filter.png new file mode 100644 index 0000000000..a6e2a4d6db Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/range-rating-filter.png differ diff --git a/en/module-reference/utility-modules/shared/collection-filters/rating-filter.png b/en/module-reference/utility-modules/shared/collection-filters/rating-filter.png new file mode 100644 index 0000000000..452a1d2369 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collection-filters/rating-filter.png differ diff --git a/en/module-reference/utility-modules/shared/collections/collect-and.png b/en/module-reference/utility-modules/shared/collections/collect-and.png new file mode 100644 index 0000000000..2fc27ce42d Binary files /dev/null and b/en/module-reference/utility-modules/shared/collections/collect-and.png differ diff --git a/en/module-reference/utility-modules/shared/collections/collect-except.png b/en/module-reference/utility-modules/shared/collections/collect-except.png new file mode 100644 index 0000000000..0903d04111 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collections/collect-except.png differ diff --git a/en/module-reference/utility-modules/shared/collections/collect-expander.png b/en/module-reference/utility-modules/shared/collections/collect-expander.png new file mode 100644 index 0000000000..2fedc77316 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collections/collect-expander.png differ diff --git a/en/module-reference/utility-modules/shared/collections/collect-or.png b/en/module-reference/utility-modules/shared/collections/collect-or.png new file mode 100644 index 0000000000..1042764598 Binary files /dev/null and b/en/module-reference/utility-modules/shared/collections/collect-or.png differ diff --git a/en/module-reference/utility-modules/shared/collections/index.html b/en/module-reference/utility-modules/shared/collections/index.html new file mode 100644 index 0000000000..235181bc4e --- /dev/null +++ b/en/module-reference/utility-modules/shared/collections/index.html @@ -0,0 +1,3206 @@ + + + + + +darktable user manual - collections + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / collections + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ collections +

+ + + +

Filter the images shown in the lighttable view and filmstrip panel using image attributes. This set of filtered images is known as a collection.

+

Importing images into darktable stores information about them (filename, path, Exif data, data from XMP sidecar files etc.) in darktable’s library database. A collection may be defined by applying filtering rules to these attributes, thus creating a subset of images to display in the lighttable view and the filmstrip module.

+

The default collection is based on the film roll attribute and displays all images of the last imported or selected film roll.

+

🔗filtering attributes

+

The images in a collection can be filtered using the following image attributes:

+

🔗files

+
+
film roll
+
The name of the film roll to which the image belongs (which is the same as the name of the folder in which the image resides). Ctrl+Shift+click on a film roll to switch to the corresponding folder. Right-click to remove the contents of the film roll from the darktable library or tell darktable that its location has changed in the file system.
+
folder
+
The folder (file path) where the image file is located. Click on a folder to include the contents of that folder and all sub-folders in the collection; Shift+click to include only the images in the selected folder; Ctrl+click to show only the images from any sub-folders; Ctrl+Shift+click to switch to the corresponding film roll. Right-click on a folder name to remove its contents from the darktable library or tell darktable that its location has changed in the file system.
+
filename
+
The image’s filename.
+
+

🔗metadata

+
+
tag
+
Any tag that is attached to the image. Untagged images are grouped under the “not tagged” entry. When activated, a hierarchical list of known tags is displayed
+
title
+
The image’s metadata “title” field.
+
description
+
The image’s metadata “description” field.
+
creator
+
The image’s metadata “creator” field.
+
publisher
+
The image’s metadata “publisher” field.
+
rights
+
The image’s metadata “rights” field.
+
notes
+
The image’s metadata “notes” field.
+
version name
+
The image’s metadata “version name” field.
+
rating
+
The image’s star rating
+
color label
+
Any color label attached to the image (“red”, “yellow”, “green”, “blue”, “purple”).
+
geotagging
+
The geo location of the image (see locations).
+
+

🔗times

+
+
capture date
+
The date the photo was taken, in the format YYYY:MM:DD.
+
capture time
+
The date & time the photo was taken, in the format YYYY:MM:DD hh:mm:ss.
+
import time
+
The date/time the file was imported, in the format YYYY:MM:DD hh:mm:ss.
+
modification time
+
The date/time the file was last changed, in the format YYYY:MM:DD hh:mm:ss.
+
export time
+
The date/time the file was last expoted, in the format YYYY:MM:DD hh:mm:ss.
+
print time
+
The date/time the file was last printed, in the format YYYY:MM:DD hh:mm:ss.
+
+

🔗capture details

+
+
camera
+
The Exif data entry describing the camera make and model.
+
lens
+
The description of the lens, as derived from Exif data.
+
aperture
+
The aperture, as derived from Exif data.
+
exposure
+
The shutter speed, as derived from Exif data.
+
focal length
+
The focal length, as derived from Exif data.
+
ISO
+
The ISO, as derived from Exif data.
+
aspect ratio
+
The aspect ratio of the image, including any cropping within darktable.
+
+

🔗darktable

+
+
grouping
+
Choose between “group followers” and “group leaders”.
+
local copy
+
Show files that are, or are not copied locally.
+
history
+
Choose images whose history stacks have been altered or not.
+
module
+
Filter based on the processing modules that have been applied to the image.
+
module order
+
Choose images with “v3.0”, “legacy” or “custom” module orders.
+
+

🔗module controls

+

🔗defining filter criteria

+

The top line of the module can be used to define filter criteria for your collection as follows:

+
+
image attribute
+
The combobox on the left allows you to choose which attribute to use to filter your collection.
+
search pattern
+
In the text field to the right of the attribute combobox, you can write a matching pattern. This pattern is compared against all database entries with the selected attribute. The filtering mechanism detects a match if any image’s attribute contains the pattern in its full text. You may use % as wildcard character. The collection will be limited to only the matching images. Leave the text field empty to match all images having that attribute. Where applicable, a tooltip will appear if you hover over the attribute or search pattern to provide additional information.
+
+

Attributes with numerical or date/time attributes can be used in combination with comparative and range operators. Use <, <=, >, >=, <>, or = to select images with attributes less than, less than or equal, greater than, greater than or equal, not equal, or equal to the given value, respectively. An expression in the form [from;to] can be used to select using a range of values.

+
+
select by value
+
As well as defining filter criteria using a search pattern, you can also manually choose from a list of values (for the chosen attribute) taken from the currently-matching set of images. Making such a selection will automatically populate the “search pattern” field.
+
+

The box below the search pattern will list values for the selected attribute that are present in the currently-selected images. This list is continuously updated as you type. You may also choose a sorting criteria by scrolling through the list and double-clicking.

+
+
+

If you enable single-click mode (see preferences > lighttable) you can select with a single-click rather than double-click. This mode also allows you to select a range of values with the mouse. This only works for numerical and date-time attributes.

+
+
+

🔗combining multiple filters

+

You can combine multiple filters together to create more complex collections of images using a series of rules. A rule is a combination of a filter criteria along with a logical operation that defines how that criteria is combined with any previous rules.

+

Click on the + + + + + + + + +collect-expander-icon + + button (to the right of the search field) to open a menu with the following options:

+
+
clear this rule
+
Remove the current rule, or reset it if this is the only rule defined.
+
narrow down search
+
Add a new rule, which is combined with the previous rule(s) in a logical AND operation. An image is only retained as part of the collection if it also fulfills the new criteria.
+
add more images
+
Add a new rule, which is combined with the previous rule(s) in a logical OR operation. Images that fulfill the new criteria are added to the collection.
+
exclude images
+
Add a new rule, which is combined with the previous rule(s) in a logical EXCEPT operation. Images that fulfill the new criteria are removed from the collection.
+
+

The logical operators defining how rules are combined are indicated with icons to the right of each added rule: AND by the + + + + + + + + +collect-and-icon + + symbol, OR by the + + + + + + + + +collect-or-icon + + symbol, and EXCEPT by the + + + + + + + + +collect-except-icon + + symbol. Click on any of these icons to change the logical operation for that rule.

+

🔗updating the folder path of moved images

+

While it is best to not touch imported files behind darktable’s back, this module can help you to recover from situations when you have moved or renamed image folders after importing them. The collections module has a feature that allows you to update darktable’s library database with the new folder location. The process is as follows:

+
    +
  1. Set the image attribute combobox to “folder” or “film roll”.
  2. +
  3. The original film roll or folder name will be displayed with strikethrough formatting to emphasize that it can not be located.
  4. +
  5. Right-click on the folder or film roll name, select “search filmroll…”, and then select the new location of the folder.
  6. +
+

🔗returning to a previous collection

+

You can return to a previously-defined collection by clicking on the history button at the bottom of the module or using the recently used collections module – see the preferences section for more details.

+

🔗preferences

+

The “preferences…” option in the presets menu allows you to adjust the behavior of the collections module as follows:

+
+
do not set the ‘uncategorized’ entry for tags
+
Do not set the ‘uncategorized’ category for tags that do not have children (default off).
+
tag case sensitivity
+
Set whether tags should be case sensitive or not – without the sqlite ICU extension this will only apply to the 26 latin letters (default insensitive).
+
number of collections to be stored
+
Set the number of recent collections to show in the history popup (if present).
+
hide the history button and show a specific module instead
+
Choose how to view your collections history – you can either use the history button in this module or use the recently used collections module.
+
number of folder levels to show in lists
+
The number of folder levels to show in film roll names, starting from the right (default 1).
+
sort film rolls by
+
Sort film rolls by either the “folder name” (path) or the “import time” (the date the film rolls were first imported) (default “import time”).
+
sort collections descending
+
Sort the following collections in descending order: “film roll” (when sorted by folder), “folder”, date/time (e.g. date/time taken) (default on)
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/export/index.html b/en/module-reference/utility-modules/shared/export/index.html new file mode 100644 index 0000000000..e8334cbd04 --- /dev/null +++ b/en/module-reference/utility-modules/shared/export/index.html @@ -0,0 +1,3183 @@ + + + + + +darktable user manual - export + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / export + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ export +

+ + + +

Export selected images.

+

When used in the darkroom view, the currently-edited image will be exported if no other images are selected in the filmstrip.

+

Files can be exported to a file on disk, email, various online storage locations, a web album, or a book template.

+

🔗module controls

+

🔗storage options

+
+
target storage
+
The type of location to store your selected images. A number of different back-ends are implemented, including file on disk, LaTeX book template and various web albums. Depending on the selected target, you will be asked to provide additional information, such as filenames or account name and password.
+
filename template
+
Define the folder and file to which the image will be exported. This can be automatically generated using several pre-defined variables. See the variables section for details.
+
output directory selector
+
The button beside the filename template entry opens a dialog to select the parent directory for export.
+
on conflict
+
Choose what to do if the generated filename conflicts with an existing file on export:
+
+
    +
  • create unique filename: Automatically choose a unique new file name by appending an integer to name of the conflicting file.
  • +
+
+
+
    +
  • overwrite: Automatically overwrite existing files. This option will present you with a confirmation dialog in order to protect you from accidental data loss – you can disable this in preferences > security > ask before exporting in overwrite mode. Note: This dialog is not presented per-file but as a one-off confirmation before the export job starts.
  • +
+
+
+
    +
  • overwrite if changed: Automatically overwrite existing files if the last export timestamp stored in darktable’s database does not match the last changed date/time on the existing file.
  • +
+
+
+
    +
  • skip: Do not export images where the destination filename already exists.
  • +
+
+
+

🔗format options

+
+
file format
+
Choose the file format for the exported image. Additional options will appear (below) depending on the selected format.
+
quality
+
The quality of the exported file. Higher values lead to larger file sizes. The default quality (95) is a good setting for very high quality exports (e.g. for archiving or printing purposes). If you need a good compromise between size and quality (e.g. for online image display or uploads) you should consider a value of “90” instead.
+
bit depth
+
The number of bits used for each color channel. More bits means less posterization/color banding.
+
compression
+
The type of compression to use.
+
compression level
+
For export formats where compression can be specified, the compression level specifies how much compression to apply. The higher the level, the more the data will be compressed, at the cost of more CPU cycles.
+
b&w image
+
For TIFF export format, it is possible to save a monochrome image. This setting controls whether the resulting file encodes the shades of gray as separate RGB channels, or as a single grayscale channel. The latter option will result in smaller files.
+
+

🔗global options

+
+
set size
+
Choose how to measure the maximum size of your exported image
+
+
    +
  • in pixels (for file): Enter the maximum width and height in pixels.
  • +
+
+
+
    +
  • in cm (for print): Enter the maximum width and height in cm and define the image’s dpi. The equivalent size in pixels will be automatically calculated.
  • +
+
+
+
    +
  • in inch (for print): Enter the maximum width and height in inches and define the image’s dpi. The equivalent size in pixels will be automatically calculated.
  • +
+
+
+
    +
  • by scale (for file): Enter a multiplier to specify by how much the exported image should be scaled compared to the input image. For example, entering a value of 0.5 will result in an output image with half the width and height (in pixels) of the original image.
  • +
+
+
dpi
+
If units of cm or inches are chosen, set the dpi of the output image. The dpi will also be stored in the Exif data of the exported image. It will be automatically set to 300 if “in pixels” or “by scale” is chosen.
+
max size
+
Set the maximum width and height of the exported image(s) in pixels, cm or inches (depending on the selected unit) – zero means that no constraint will be set on that dimension. Exported images will be constrained so as not to exceed either of these values, while retaining the correct aspect ratio. Set both to zero to export with the original dimensions (after cropping). If the entered values exceed the original dimensions darktable will either export with the original dimensions or upscale the image, depending on the “allow upscaling” parameter.
+
allow upscaling
+
Set to “yes” to perform an upscaling step if the user-defined maximum width and height exceed the original dimensions of the image. If set to “no” the exported image’s dimensions will not exceed the dimensions of the original image (after cropping).
+
high quality resampling
+
Set this to ‘yes’ to perform high quality resampling on the image. The image will be processed in full resolution and only downscaled at the very end. This can sometimes result in better quality, but will always be slower.
+
store masks
+
Store masks as additional layers (for TIFF format) or channels (for EXR and XCF formats) in the exported image.
+
profile
+
The output color profile. Select “image settings” if you want the settings in the output color profile module of the individual images to be respected.
+
intent
+
This option lets you define the intent – the way in which darktable will handle out-of-gamut colors. See rendering intent for a more detailed description of the available options.
+
style
+
Choose a style which darktable will combine with the existing history stack to generate the output image. These history items are only added temporarily – the original history stack is not overwritten. You can use this feature to add processing steps and parameters that you want to be applied specifically to images before export. For example you may define a style that adds a stronger level of sharpening when you produce scaled-down JPEG files for the internet or add a certain level of exposure compensation to all of your output images.
+
mode
+
When applying a style during export this option defines whether the history stack items of that style replace the original history stack of the image or are appended to it. Technically speaking, in append mode history stack items of the style will constitute separate instances of the respective modules on top of any existing ones (see also multiple instances). As a consequence the original history stack will remain in effect with the new items being applied in addition. This way you can apply an overall adjustment (e.g. exposure) to a number of exported images while respecting the settings of each individual image.
+
export
+
Press this button to start a background job to export all selected images. A bar at the bottom of the left hand panel displays the progress of the export job. Furthermore a notification message pops up reporting the completion of each individual export. You may click on the pop-up to make it disappear. You may abort the export job by clicking on the “x” icon located close to the progress bar.
+
+
+

Note: Images that are selected but currently hidden (because they are members of a collapsed group) will not be exported.

+
+

🔗metadata preferences

+

The “preferences…” option in the presets menu brings up a dialog where you can configure what metadata to include in exported files:

+

+ + + + + + + + +metadata config + +

+

The parameters entered into this dialog are saved along with other export parameters to user presets and the last entered values are retained when darktable is closed.

+

🔗general settings

+

The left-hand-side of this dialog allows you to choose which groups of metadata are to be exported with the image. The following options are available:

+
+
exif data
+
Export the source image’s Exif data.
+
metadata
+
Export metadata defined in the metadata editor module. Only metadata fields that are tagged as visible and are not tagged as private will be exported.
+
geo tags
+
Export geo tags.
+
tags
+
Export tags created in the tagging module (to Xmp.dc.Subject). Three additional options can also be selected:
+
    +
  • private tags: Export private tags
  • +
+
+
    +
  • synonyms: Export tag synonyms
  • +
+
+
    +
  • omit hierarchy: Only export the last part of hierarchical tags
  • +
+
+
hierarchical tags
+
Export hierarchical tags (to Xmp.lr.Hierarchical Subject)
+
develop history
+
Export the entire development history (history stack and shapes) where supported (e.g. JPEG, JPEG2000, TIFF). The development history will be stored as XMP tags within the output file. This information can later be used to reconstruct the parameters and settings that were used to produce the exported image.
+
+
+

Caution: For various reasons embedding XMP tags into output files may fail without notice, e.g. if certain size limits are exceeded. Users are therefore advised to not rely on this feature for their backup strategy. To back up your data always make sure to save your input (raw) file as well as all of darktable’s XMP sidecar files.

+
+

🔗per metadata settings

+

The right-hand-side of this dialog allows you to define formulas to populate image metadata. The formulas defined here have priority over the settings in the left-hand-side of the dialog. The first column identifies the entry to be edited. The second column allows you to define how to calculate the value for that metadata entry using a formula.

+

See the variables section for details of the variables you can use in your metadata formula. Press Enter to validate the formula. Leave the formula empty to prevent a given metadata entry from being exported (Exif.GPSInfo.GPSVersionID in the above example).

+

Use the “–” icon to remove a metadata entry from the list and the “+” icon to add a new one from a predefined list of available metadata tags.

+

Click on the “add” button to add a metadata entry to the list.

+

The formulas allow you virtually define all the metadata you need to qualify your images in tagging and export the values in the XMP or IPTC tags of your choice. The exported tags can be different from one export to the next depending on the destination of the images. Tags and Categories are displayed separately in image information.

+

Remember that a tag set up as a category is never exported.

+

🔗tips

+
    +
  • To prevent a specific metadata field from being exported, add it to the list and leave the formula empty.
  • +
  • To force a specific exif metadata field to be exported when exif export is disabled, add it to the list and enter = into the formula.
  • +
+

🔗examples

+
+
example 1
+
A first level tag called places is set as a category, and is followed by four levels of information (or keywords): country, region, city and location (e.g. places|France|Nord|Lille|rue Nationale). Each level can be retrieved (when it is defined) by one of the variables $(CATEGORY0(places)), $(CATEGORY1(places)), $(CATEGORY2(places)) and $(CATEGORY3(places)). In this example, the returned values are “France”, “Nord”, “Lille” and “rue Nationale”, respectively. These keywords can also be retrieved as simple tags using the variable $(TAGS). The last keyword level defined (the leaf) is displayed in image information, here “rue Nationale”.
+
example 2
+
A first level tag called creator is followed by the name of the photographer, both set as categories: creator|firstname lastname. The formula copyrights ($(YEAR) $(CATEGORY0(creator))) builds the text associated with image rights. Here, image information displays “creator: firstname lastname” as categories. Neither creator nor “firstname lastname” appear in the tags list and they are not exported as simple tags.
+
+
+

Note: tagging is not appropriate to define free text metadata, like a title or a description, which may be specific to each image. Use the metadata editor for this type of information.

+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/export/metadata-config.png b/en/module-reference/utility-modules/shared/export/metadata-config.png new file mode 100644 index 0000000000..1c9600d978 Binary files /dev/null and b/en/module-reference/utility-modules/shared/export/metadata-config.png differ diff --git a/en/module-reference/utility-modules/shared/filmstrip/filmstrip.png b/en/module-reference/utility-modules/shared/filmstrip/filmstrip.png new file mode 100644 index 0000000000..57c99bde1a Binary files /dev/null and b/en/module-reference/utility-modules/shared/filmstrip/filmstrip.png differ diff --git a/en/module-reference/utility-modules/shared/filmstrip/index.html b/en/module-reference/utility-modules/shared/filmstrip/index.html new file mode 100644 index 0000000000..ae54f024d7 --- /dev/null +++ b/en/module-reference/utility-modules/shared/filmstrip/index.html @@ -0,0 +1,3074 @@ + + + + + +darktable user manual - filmstrip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / filmstrip + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ filmstrip +

+ + + +

The filmstrip can be used to quickly switch between images. The images shown are the same as those displayed in the lighttable view and are defined by the currently-selected collection.

+

+ + + + + + + + +filmstrip + +

+

The filmstrip can be switched on and off using the shortcut Ctrl+F. The height of the filmstrip panel can be changed by clicking and dragging its top border.

+

Quickly navigate through the images in the filmstrip by scrolling with the mouse. Increase scroll speed with Shift+scroll. Change the height of the filmstrip with Ctrl+scroll or by clicking+dragging the top of the panel. In the darkroom you can change the photo currently being processed by clicking on another image in the filmstrip.

+

In the darkroom, the image currently being processed is selected and highlighted. Hover over an image on the filmstrip with your mouse to select it (in order to act on it with a keyboard shortcut) without changing the image being processed.

+

If you wish to select multiple images in the filmstrip, use Alt+click to select the first image, followed by either Ctrl+click to select or de-select further images, or Shift+click to select a range of images.

+

The following shortcuts can be used to select images in the filmstrip:

+
    +
  • +

    Ctrl+A selects all images in the filmstrip

    +
  • +
  • +

    Ctrl+Shift+A deselects all images

    +
  • +
  • +

    Ctrl+I inverts the current selection

    +
  • +
+

The following shortcuts can be used to perform operations on the selected images

+
    +
  • +

    F1, F2, F3, F4, F5 adds or removes a color label (red, yellow, green, blue, purple, respectively). A color label will be added if any selected image does not currently have the label; otherwise the label will be removed

    +
  • +
  • +

    0, 1, 2, 3, 4, 5 sets the star rating

    +
  • +
  • +

    R rejects the image(s)

    +
  • +
  • +

    Ctrl+D duplicates the image(s)

    +
  • +
  • +

    Ctrl+C copies the full history stack

    +
  • +
  • +

    Ctrl+V pastes all of the copied history stack

    +
  • +
  • +

    Ctrl+Shift+C selectively copies the history stack

    +
  • +
  • +

    Ctrl+Shift+V selectively pastes from the copied history stack

    +
  • +
+

See the lighttable’s history stack module documentation for more information about the copy and paste functionality.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/focus-peaking/focus-peaking-icon.png b/en/module-reference/utility-modules/shared/focus-peaking/focus-peaking-icon.png new file mode 100644 index 0000000000..efff3177f6 Binary files /dev/null and b/en/module-reference/utility-modules/shared/focus-peaking/focus-peaking-icon.png differ diff --git a/en/module-reference/utility-modules/shared/focus-peaking/focus-peaking-overview.png b/en/module-reference/utility-modules/shared/focus-peaking/focus-peaking-overview.png new file mode 100644 index 0000000000..4a33f2ebea Binary files /dev/null and b/en/module-reference/utility-modules/shared/focus-peaking/focus-peaking-overview.png differ diff --git a/en/module-reference/utility-modules/shared/focus-peaking/index.html b/en/module-reference/utility-modules/shared/focus-peaking/index.html new file mode 100644 index 0000000000..b3ce41e8a4 --- /dev/null +++ b/en/module-reference/utility-modules/shared/focus-peaking/index.html @@ -0,0 +1,3052 @@ + + + + + +darktable user manual - focus peaking + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / focus peaking + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ focus peaking +

+ + + +

Identify which parts of the image contain high contrast details such as edges and textures, which are usually a useful guide to sharpness and therefore focus.

+

Activate the module by clicking on the + + + + + + + + +focus-peaking-icon + + icon. The sharpest parts of the image will be highlighted with a yellow, green and blue overlay:

+

Focus peaking works by filtering out most of the image noise, measuring the intensity gradients in the image and calculating average and standard deviation statistics. When the gradient of an edge differs significantly from the mean, the associated pixels are marked with a “heat map” indicating how sharp the edge is.

+
    +
  • yellow represents a large (6σ) jump in gradient, indicating a very sharp edge.
  • +
  • green represents a medium (4σ) jump in gradient, indicating a reasonably sharp edge.
  • +
  • blue represents a small (2σ) jump in gradient, indicating a slightly sharp edge.
  • +
+
+

Note: While the algorithm in this module generally does a good job of locating the sharpest parts of an image, it does not necessarily detect whether an image is sharp. Additionally, as it uses local contrast to detect sharpness, it will also highlight the edges of dark objects against bright backgrounds (and vice versa) even if those edges are blurred. Because it runs at the end of the pixelpipe, it may also detect the results of any sharpening you have performed within darktable.

+
+

The following example image was taken with a wide aperture to give a shallow depth of field, and you can see how the camera has focused on the chinese character written on the second red lantern along from the front. There are also stems of the pink flowers that fall within the area of acceptable sharpness around the focal plane, and these have also been marked up with yellow and green.

+

+ + + + + + + + +focus-peaking-overview + +

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/geotagging/index.html b/en/module-reference/utility-modules/shared/geotagging/index.html new file mode 100644 index 0000000000..a17775bdb0 --- /dev/null +++ b/en/module-reference/utility-modules/shared/geotagging/index.html @@ -0,0 +1,3080 @@ + + + + + +darktable user manual - geotagging + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / geotagging + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ geotagging +

+ + + +

Import and apply GPX track data to a selection of images.

+

This module is common to the lighttable and map views. The map view provides an enhanced mode that allows you to preview the position of the images along the GPS tracks while adjusting the images’ date/time offset and time zone.

+

🔗workflow overview

+

A GPS receiver calculates its current position based on information it receives from satellites, and records it in a GPX file together with the current date and time. The Exif data of the images also contains a time stamp defined by the camera settings. The geotagging module takes the time stamp of the image, looks up the position in the GPX file at that time, and stores the appropriate coordinates (latitude/longitude/elevation) in its database and the image’s XMP sidecar file.

+

Two problems may occur during this process:

+
    +
  • In contrast to GPS devices, most cameras don’t record the time accurately.
  • +
  • The time stored in the Exif data does not include the time zone. Most people set their camera to local time, whereas GPS devices store the time in the UTC (Universal Time, Coordinated, i.e. Greenwich (London)) time zone. If the time zones of the camera and GPX file differ, than the related location will be wrong.
  • +
+

If your image already shows the correct date/time and carries the UTC time stamp, you can directly apply the GPX track file without further adjustments.

+

Otherwise follow the following process to correlate the time of the images and GPS track files

+
    +
  1. +

    Fix the camera time setting for a single image by manually entering the correct date/time for that image into the date/time field. A good way to do this accurately is to take a photograph of a reliable time source. This can be any precise clock or, even better, the time displayed on your GPS device (bearing in mind that GPS devices normally show the local time, even though they store universal time). The difference (offset) between the time entered and the time stored in the image’s Exif data will be shown in the date/time offset field.

    +
  2. +
  3. +

    Press the lock button to lock the calculated offset in the module.

    +
  4. +
  5. +

    Select all of the images you wish to adjust and click apply offset to apply the calculated offset to those images.

    +
  6. +
  7. +

    If the camera time zone is not UTC, set the time zone in the camera time zone field.

    +
  8. +
+

With the time setting corrected, you can now apply GPX tracking data using the apply GPX track file button.

+

🔗module controls (common)

+
+
date/time
+
This field is initialized with the date/time read from the first selected image (format yyyy:mm:dd hh:mm:ss) and can be modified to correct the date/time for that image. The individual date/time fields can be altered by scrolling over them with your mouse. If any field reaches its limit, the neighboring fields are automatically updated. For example, if you go over 60 on the minute field, the hour field will automatically be incremented. It is also possible to use milliseconds in this module if you enable preferences > lighttable > show image time with milliseconds.
+
original date/time
+
The original date/time of the image is shown here for reference.
+
date/time offset
+
The calculated difference between the original date/time and that keyed in the date/time field. If the calculated difference is greater than 99 days 23 hours 59 minutes and 59 seconds, the offset is invalidated.
+
lock button
+
If the lock button is activated, the offset value is frozen. If you subsequently change the selected image(s), the new image date/time is updated using the locked offset. This allows you to apply the same offset to multiple groups of images.
+
apply offset button
+
Apply the offset to selected images.
+
apply date/time button
+
It is sometimes useful to be able to set the absolute date/time for an image, for example where this information is missing. This button allows you to apply the date/time entered in the date/time field to the selected images, without considering the previous value. You can use Ctrl+Z to undo any unwanted changes.
+
camera time zone
+
Select the camera’s time zone. Start typing to show a list of permitted values.
+
apply GPX track file (lighttable view only)
+
Apply a GPX track file. Click the corresponding button and navigate to the GPX file. You can use Ctrl+Z to undo any unwanted changes. Within the file chooser window, the preview button lists the tracks of the selected GPX file along with the following information: track name, start and end date/time (local time), number of track points and number of selected images that will be geotagged.
+
+

🔗module controls (map view)

+
+
GPX file
+
The path of the GPX file selected.
+
track list
+
This table shows the start date/time of each track, along with the number of track points and the number of matching images. When a check button is activated, the related track is displayed on the map. A check button in the table header allows you to select or de-select all of the tracks at once. Hover over a row with your mouse to display the start and end times both in local time (LT) and UTC.
+
preview images
+
If checked, the matching images are displayed on the map along the visible tracks.
+
select images
+
If you don’t wish to apply an offset to all of the selected images, but only to the matching images, use this button to select images. If you don’t want to lose the current offset you may want to lock it before changing the selection.
+
counts
+
A count of the number of matching images and the number selected is displayed to the right of the select images button.
+
apply geo-location
+
This button is displayed when the offset is null. The apply geo-location button applies the GPX data to matching images on selected tracks.
+
apply offset and geo-location
+
This button is displayed once an offset has been entered. As a reminder, the apply offset button applies the offset to all selected images. Unlike apply offset, the apply offset and geo-location button applies the offset and the GPX data to matching images on selected tracks.
+
+

You can use Ctrl+Z to undo any unwanted changes (twice in case of apply offset and geo-location).

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/image-information/index.html b/en/module-reference/utility-modules/shared/image-information/index.html new file mode 100644 index 0000000000..627f32a625 --- /dev/null +++ b/en/module-reference/utility-modules/shared/image-information/index.html @@ -0,0 +1,3025 @@ + + + + + +darktable user manual - image information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / image information + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ image information +

+ + + +

Display information embedded within an image’s Exif data as well as a number of additional data fields defined by darktable.

+

When hovering with the mouse over image thumbnails, the displayed data is automatically updated to show information about the image currently under the mouse cursor.

+

When several images are selected and the focus is not on a single image, the module only displays information that is the same for all images. If any fields differ between the images, the text “<various values>” is displayed instead.

+

While you are in the lighttable view, you can double-click on the filmroll field for a given image to show all images in that image’s film roll.

+

🔗preferences

+

The “preferences…” option in the presets menu brings up a dialog with a list of all fields that are available for display.

+

The visible checkbox allows you to choose which fields to display. You can also drag and drop one row at a time to change the display order.

+

These preferences can be saved as module presets. Press the module’s reset button to make all available information visible and displayed in its default order.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/index.html b/en/module-reference/utility-modules/shared/index.html new file mode 100644 index 0000000000..cce98c7b77 --- /dev/null +++ b/en/module-reference/utility-modules/shared/index.html @@ -0,0 +1,3087 @@ + + + + + +darktable user manual - shared + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/index.xml b/en/module-reference/utility-modules/shared/index.xml new file mode 100644 index 0000000000..67881a4956 --- /dev/null +++ b/en/module-reference/utility-modules/shared/index.xml @@ -0,0 +1,88 @@ + + + + shared on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/ + Recent content in shared on darktable user manual + Hugo + en + + + collection filters + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collection-filters/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collection-filters/ + Filter the collection of images displayed in the lighttable view and filmstrip panel using image attributes, optionally pinning filters to the top panel for quick access. Once you have defined a collection of images with the collections module, the collection filters module allows you to define additional filters and sort criteria. For example, you might wish to show all images in a given folder using the collections module and then define additional quick filters to narrow-down by star rating and/or color label. + + + collections + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collections/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collections/ + Filter the images shown in the lighttable view and filmstrip panel using image attributes. This set of filtered images is known as a collection. Importing images into darktable stores information about them (filename, path, Exif data, data from XMP sidecar files etc.) in darktable&rsquo;s library database. A collection may be defined by applying filtering rules to these attributes, thus creating a subset of images to display in the lighttable view and the filmstrip module. + + + export + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/export/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/export/ + Export selected images. When used in the darkroom view, the currently-edited image will be exported if no other images are selected in the filmstrip. Files can be exported to a file on disk, email, various online storage locations, a web album, or a book template. 🔗module controls 🔗storage options target storage The type of location to store your selected images. A number of different back-ends are implemented, including file on disk, LaTeX book template and various web albums. + + + filmstrip + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/filmstrip/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/filmstrip/ + The filmstrip can be used to quickly switch between images. The images shown are the same as those displayed in the lighttable view and are defined by the currently-selected collection. The filmstrip can be switched on and off using the shortcut Ctrl+F. The height of the filmstrip panel can be changed by clicking and dragging its top border. Quickly navigate through the images in the filmstrip by scrolling with the mouse. + + + focus peaking + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/focus-peaking/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/focus-peaking/ + Identify which parts of the image contain high contrast details such as edges and textures, which are usually a useful guide to sharpness and therefore focus. Activate the module by clicking on the icon. The sharpest parts of the image will be highlighted with a yellow, green and blue overlay: Focus peaking works by filtering out most of the image noise, measuring the intensity gradients in the image and calculating average and standard deviation statistics. + + + geotagging + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/geotagging/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/geotagging/ + Import and apply GPX track data to a selection of images. This module is common to the lighttable and map views. The map view provides an enhanced mode that allows you to preview the position of the images along the GPS tracks while adjusting the images&rsquo; date/time offset and time zone. 🔗workflow overview A GPS receiver calculates its current position based on information it receives from satellites, and records it in a GPX file together with the current date and time. + + + image information + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/image-information/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/image-information/ + Display information embedded within an image&rsquo;s Exif data as well as a number of additional data fields defined by darktable. When hovering with the mouse over image thumbnails, the displayed data is automatically updated to show information about the image currently under the mouse cursor. When several images are selected and the focus is not on a single image, the module only displays information that is the same for all images. + + + metadata editor + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/metadata-editor/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/metadata-editor/ + Edit the metadata of selected images. Metadata is freeformat text (title, description, creator, publisher, rights etc.) that describes your images. When several images are selected having different values for a given metadata field, the module displays for that field &ndash; if you choose to apply changes, these fields will not be changed. If you right-click on the field the different values are listed at the end of the contextual menu. Select one of the values in the menu to apply that value to all of the selected images &ndash; the change will be saved once you press the &ldquo;apply&rdquo; button or the Enter/Tab key. + + + recently used collections + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/recent-collections/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/recent-collections/ + Display a list of recently used collections generated by the collections module. This module may be hidden, depending on the preferences set in the collections module. Click on an entry to reopen the selected collection. This also updates the collections module with the appropriate filter criteria and rules. 🔗preferences The &ldquo;preferences&hellip;&rdquo; option in the presets menu allows you to adjust the behavior of the recent collections module as follows: number of recent collections to be stored The number of recent collections to store and display in the recent collections module (default 10) prefer a history button in the collections module Set whether you prefer to use this module or the history button in the collections module. + + + scopes + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/scopes/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/scopes/ + This module provides various graphical depictions of the developed image&rsquo;s light levels or chromaticity. Hover the mouse over the module to reveal buttons that can be used to adjust the display. The buttons on the left-hand-side are used to choose the display mode, from left-to-right: vectorscope, waveform, rgb parade and histogram. The buttons on the right-hand-side control how the plot for the current scope is drawn. The height of the scopes module can be changed by clicking-and-dragging on the bottom edge or by holding down Shift+Alt while scrolling the mouse. + + + tagging + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/tagging/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/tagging/ + Manage tags attached to images. Tags provide a means of adding information to images using a keyword dictionary. You can also manage tags as a hierarchical tree, which can be useful when their number becomes large. Tags are physically stored in XMP sidecar files as well as in darktable&rsquo;s library database and can be included in exported images. 🔗definitions The following definitions assume that you have set up a single tag named &ldquo;places|France|Nord|Lille&rdquo;. + + + diff --git a/en/module-reference/utility-modules/shared/metadata-editor/index.html b/en/module-reference/utility-modules/shared/metadata-editor/index.html new file mode 100644 index 0000000000..9276ae7c2e --- /dev/null +++ b/en/module-reference/utility-modules/shared/metadata-editor/index.html @@ -0,0 +1,3050 @@ + + + + + +darktable user manual - metadata editor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / metadata editor + +
+ + + + +
+ +

+ metadata editor +

+ + + +

Edit the metadata of selected images.

+

Metadata is freeformat text (title, description, creator, publisher, rights etc.) that describes your images.

+

When several images are selected having different values for a given metadata field, the module displays for that field – if you choose to apply changes, these fields will not be changed. If you right-click on the field the different values are listed at the end of the contextual menu. Select one of the values in the menu to apply that value to all of the selected images – the change will be saved once you press the “apply” button or the Enter/Tab key.

+

🔗module controls

+
+
reset
+
Delete visible (see below) metadata from the selected images.
+
metadata entry fields
+
A separate field is displayed for each metadata item. Hold Ctrl while scrolling with your mouse to increase the height of a field. Press Ctrl+Enter to insert a new line. Double-click on a field’s label to delete the contents of that field.
+
apply
+
Apply new settings from the metadata entry fields to the selected images.
+
+

🔗keyboard

+

You may use the keyboard to navigate and apply changes while any of the metadata entry boxes have focus:

+
    +
  • +

    The Tab key saves the current field and moves the cursor to the next field. When the last field is reached, the Tab key returns focus to the first field.

    +
  • +
  • +

    Shift+Tab works the same as Tab, but in the opposite direction.

    +
  • +
  • +

    The Enter key saves the current field without moving the cursor.

    +
  • +
+

🔗preferences

+

The “preferences…” option in the presets menu brings up a dialog where you can configure how metadata is handled within darktable. For each metadata item, two check boxes allow you to restrict how metadata is handled:

+
+
visible
+
Show or hide this metadata field. Hidden fields are not included in exported images.
+
private
+
Keep this metadata field private. Private fields are not included in exported images.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/recent-collections/index.html b/en/module-reference/utility-modules/shared/recent-collections/index.html new file mode 100644 index 0000000000..df6e5df611 --- /dev/null +++ b/en/module-reference/utility-modules/shared/recent-collections/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - recently used collections + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / recently used collections + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ recently used collections +

+ + + +

Display a list of recently used collections generated by the collections module.

+

This module may be hidden, depending on the preferences set in the collections module.

+

Click on an entry to reopen the selected collection. This also updates the collections module with the appropriate filter criteria and rules.

+

🔗preferences

+

The “preferences…” option in the presets menu allows you to adjust the behavior of the recent collections module as follows:

+
+
number of recent collections to be stored
+
The number of recent collections to store and display in the recent collections module (default 10)
+
prefer a history button in the collections module
+
Set whether you prefer to use this module or the history button in the collections module.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/scopes/histogram.png b/en/module-reference/utility-modules/shared/scopes/histogram.png new file mode 100644 index 0000000000..df7bdd9937 Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/histogram.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/index.html b/en/module-reference/utility-modules/shared/scopes/index.html new file mode 100644 index 0000000000..50eff35442 --- /dev/null +++ b/en/module-reference/utility-modules/shared/scopes/index.html @@ -0,0 +1,3188 @@ + + + + + +darktable user manual - scopes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / scopes + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ scopes +

+ + + +

This module provides various graphical depictions of the developed image’s light levels or chromaticity.

+

+ + + + + + + + +scopes module + +

+

Hover the mouse over the module to reveal buttons that can be used to adjust the display. The buttons on the left-hand-side are used to choose the display mode, from left-to-right: vectorscope, waveform, rgb parade and histogram. The buttons on the right-hand-side control how the plot for the current scope is drawn.

+

The height of the scopes module can be changed by clicking-and-dragging on the bottom edge or by holding down Shift+Alt while scrolling the mouse. The visibility of the module can be toggled with a keyboard shortcut (default Ctrl+Shift+H).

+

The scopes module is at the top of the right-hand panel by default but can be moved to the left-hand panel with preferences > miscellaneous > position of the scopes module.

+

For performance reasons, scopes are calculated from the image preview (the image displayed in the navigation module) rather than the higher quality image displayed in the center view. The preview is calculated at a lower resolution and may use shortcuts to bypass more time-consuming image processing steps. Hence the display may not accurately represent fine detail in the image, and may deviate in other ways from the final developed image.

+

🔗histogram

+

+ + + + + + + + +histogram + +

+

The histogram shows the distribution of pixels by lightness for each color channel.

+

The horizontal axis runs from 0% to 100% lightness for each channel. The vertical axis gives the count of pixels having the given lightness.

+

In its default state, data for all three RGB color channels is displayed. The red, green and blue colored buttons on the right-hand-side can be used to toggle the display of each color channel.

+

The first button on the right-hand-side toggles between logarithmic and linear rendering of the vertical axis (pixel count) data.

+

🔗waveform

+

+ + + + + + + + +waveform scope (horizontal) + +

+

The waveform scope shows similar data to the histogram, but allows you to view that data in a spatial context.

+

In the “standard” horizontal waveform, the horizontal axis of the waveform represents the horizontal axis of the image – the right-hand side of the waveform represents the right-hand side of the image and the left-hand side of the waveform represents the left-hand side of the image.

+

The vertical axis represents the distribution of pixels by lightness for each channel – the dotted line at the top represents 100% lightness (values above this may be clipped), the dotted line in the middle represents 50% lightness, and the bottom of the waveform represents 0% lightness.

+

The brightness of each point on the waveform represents the number of pixels at the given position (the horizontal axis) having the given lightness (the vertical axis). The brighter the point, the more pixels at that position have that lightness.

+

As with the histogram, you can selectively display each of the red, green, and blue channels, by clicking on the appropriate buttons.

+

The first button on the right-hand-side toggles the display between horizontal (above) and vertical (below) mode:

+

+ + + + + + + + +waveform scope (vertical) + +

+

In the vertical waveform, the vertical axis of the plot represents the vertical axis of the image, and the horizontal axis represents the distribution of pixels by lightness. The vertical waveform can be useful for portrait-format images, or simply to understand an image in a different way.

+

See Of Histograms and Waveforms for more on darktable’s waveform scope.

+

🔗rgb parade

+

+ + + + + + + + +rgb parade (horizontal) + +

+

The RGB parade scope shows the same data as the waveform, but with the red, green, and blue channels presented side-by-side.

+

As with the waveform, clicking the button on the right-hand-side of the module toggles between horizontal (above) and vertical (below) mode:

+

+ + + + + + + + +rgb parade (vertical) + +

+

The RGB parade can be useful for matching the intensities of the red, green, and blue channels. It can also help to understand the differences between, and individual qualities of, each channel.

+

🔗vectorscope

+

+ + + + + + + + +vectorscope + +

+

The vectorscope shows chromaticity without regard to either lightness or spatial data.

+

The distance from the center of the graph represents chroma and the angle represents hue. Areas of the graph are colored depending on the chromaticity of the color to which they correspond in the image. The graph represents color “volume” by rendering the more frequently used colors in lighter tones.

+

The graph includes a “hue ring” representing the maximum chroma of each hue (in bounded RGB) of the current histogram profile. The RGB primary/secondary colors are marked by circles around the edge of the hue ring.

+

🔗color harmony and additional vectorscope controls

+

The vectorscope provides some additional controls beyond those provided by the other modes, which deserve separate discussion. Hovering over the scopes module while in vectorscope mode shows the following additional buttons:

+

+ + + + + + + + +vectorscope-options + +

+

Click the right-most button to toggle the chroma scale between linear and logarithmic mode.

+

Click the second-to-right-most button to toggle the color space of the vectorscope between CIELUV, JzAzBz or RYB – as previously mentioned, these color spaces exclude any luminosity component in this module. The CIELUV graph will be faster to calculate, and is a well-known standard, though JzAzBz may be more perceptually accurate.

+

Finally, along the left-hand edge of the module are a series of buttons that allow the selected color harmony indicator to be overlaid on the vectorscope graphic. For example, the following shows the “triad” color harmony:

+

+ + + + + + + + +vectorscope-ch-triad + +

+

Rotate the display of the overlaid harmony guides by hovering over the scopes module and scrolling with the mouse scroll wheel. Hold Ctrl while scrolling to rotate more slowly. Hold Shift while scrolling to change the area covered by the guide overlays.

+

The type and position of the chosen harmony guides is saved alongside each image’s editing data (in the XMP file and database) so can be restored whenever you return to the image for further editing.

+

A full description of how to use this functionality is out of scope of this reference section, however, the following overview gives a basic guide as to how to use this mode to improve the color harmonies within the image.

+
    +
  1. +

    With the global color picker, take live samples of the key colored areas of the image. The choice of these is purely artistic, depending on the feeling you wish to convey. Choose (in the global color picker) to display the chosen samples on the RYB vectorscope.

    +
  2. +
  3. +

    Choose the color harmony type that you wish to implement (or the closest to the actual distribution of picked live samples). Rotate (with Ctrl+scroll) until the picked samples fall roughly inside (or near) the harmony guides.

    +
  4. +
  5. +

    If some of the picked samples fall outside of the guide lines, perform manipulations of the image’s colors until they fall within the guides. You can use any processing module to achieve this but multiple masked instances of color balance rgb usually provide the best results.

    +
  6. +
+

Bear in mind that these controls are provided as a basic guide to achieving color harmony – do not try to force colors into the guides at the expense of the overall look of the image. For some useful examples of how to use this functionality, please see the pull request that implemented the original change.

+

🔗caveats

+
    +
  • The hue ring is not a gamut check, as a color can be within the hue ring, yet out of gamut due to its darkness/lightness.
  • +
  • When adjusting an image based upon a color checker, faster and more accurate results will come from using calibrate with a color checker in the color calibration module.
  • +
  • The vectorscope does not have a “skin tone line”, which is a flawed generalization rather than a universal standard.
  • +
  • The vectorscope represents a colorimetric encoding of an image, which inevitably diverges from a viewer’s perception of the image.
  • +
+

🔗exposure adjustment

+

The histogram, waveform, and RGB parade scopes can be used to directly alter the exposure and black level of the exposure module.

+

For the histogram, click towards the right-hand side of the histogram and then drag right to increase or drag left to decrease the exposure. In a similar manner you can control the black level by clicking and dragging in the left-hand side.

+

For horizontal waveform and RGB parade, drag the upper portion of the scope up/down to increase/decrease exposure. Drag the lower portion up/down to increase/decrease the black level.

+

For vertical waveform and RGB parade scopes, the corresponding regions are to the right (exposure) and left (black level).

+

You can also scroll in the appropriate area – rather than dragging – to adjust exposure and black point. Double-click in the scope to reset the exposure module’s parameters to their defaults.

+

🔗histogram profile

+

Image data is converted to the histogram profile before the scope data is calculated. You can choose this profile by right-clicking on the soft-proof or gamut check icons in the bottom module and then selecting the profile of interest. When soft-proof or gamut check is enabled, the scope is shown in the soft proof profile.

+

As the scopes module runs at the end of the preview pixelpipe, it receives data in display color space. If you are using a display color space that is not “well behaved” (this is common for a device profile), then colors that are outside of the gamut of the display profile may be clipped or distorted.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/scopes/parade-vertical.png b/en/module-reference/utility-modules/shared/scopes/parade-vertical.png new file mode 100644 index 0000000000..7d582f8d34 Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/parade-vertical.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/parade.png b/en/module-reference/utility-modules/shared/scopes/parade.png new file mode 100644 index 0000000000..fd69b50152 Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/parade.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/scopes.png b/en/module-reference/utility-modules/shared/scopes/scopes.png new file mode 100644 index 0000000000..e7842de293 Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/scopes.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/vectorscope-ch-triad.png b/en/module-reference/utility-modules/shared/scopes/vectorscope-ch-triad.png new file mode 100644 index 0000000000..f37feacf25 Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/vectorscope-ch-triad.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/vectorscope-options.png b/en/module-reference/utility-modules/shared/scopes/vectorscope-options.png new file mode 100644 index 0000000000..2e0922303e Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/vectorscope-options.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/vectorscope.png b/en/module-reference/utility-modules/shared/scopes/vectorscope.png new file mode 100644 index 0000000000..6e5227023f Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/vectorscope.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/waveform-vertical.png b/en/module-reference/utility-modules/shared/scopes/waveform-vertical.png new file mode 100644 index 0000000000..656948d153 Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/waveform-vertical.png differ diff --git a/en/module-reference/utility-modules/shared/scopes/waveform.png b/en/module-reference/utility-modules/shared/scopes/waveform.png new file mode 100644 index 0000000000..14e403119f Binary files /dev/null and b/en/module-reference/utility-modules/shared/scopes/waveform.png differ diff --git a/en/module-reference/utility-modules/shared/tagging/check-icon.png b/en/module-reference/utility-modules/shared/tagging/check-icon.png new file mode 100644 index 0000000000..28cfcf958d Binary files /dev/null and b/en/module-reference/utility-modules/shared/tagging/check-icon.png differ diff --git a/en/module-reference/utility-modules/shared/tagging/index.html b/en/module-reference/utility-modules/shared/tagging/index.html new file mode 100644 index 0000000000..36f960d0a8 --- /dev/null +++ b/en/module-reference/utility-modules/shared/tagging/index.html @@ -0,0 +1,3305 @@ + + + + + +darktable user manual - tagging + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / shared / tagging + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ tagging +

+ + + +

Manage tags attached to images.

+

Tags provide a means of adding information to images using a keyword dictionary. You can also manage tags as a hierarchical tree, which can be useful when their number becomes large.

+

Tags are physically stored in XMP sidecar files as well as in darktable’s library database and can be included in exported images.

+

🔗definitions

+

The following definitions assume that you have set up a single tag named “places|France|Nord|Lille”.

+
+
tag
+
A tag is a descriptive string that may be attached to an image. A tag can be a single term or a sequence of connected terms forming a path, separated by the pipe symbol. For example, “places|France|Nord|Lille” defines a single tag, where each term in the path forms a smaller subset of those before it. You can attach as many tags to an image as you like.
+
+

You can assign properties (name, private, category, synonyms and image order) to a tag.

+
+
node
+
Any path that forms part of a tag is a node. In the above example, “places”, “places|France”, “places|France|Nord” and “places|France|Nord|Lille” are all nodes. In the hierarchical tree view, the nodes form the branches and leaves of the tree.
+
free node
+
Any node that is not explicitly defined as a tag is called a free node. In the above example, “places”, “places|France” and “places|France|Nord” are all free nodes. You cannot set any properties, except “name”, for a free node and you cannot add a free node to an image. See the “multiple tags” section below for more information.
+
category
+
Any tag can be flagged by the user as being a “category”.
+
+

🔗multiple tags

+

The above definitions considered a simple example – a single tag and its properties. Consider instead the scenario where the following four pipe-delimited tags are each separately defined in darktable.

+
places|France|Nord|Lille
+places|France|Nord
+places|France
+places|England|London
+

In this case the nodes are

+
places
+places|France
+places|France|Nord
+places|France|Nord|Lille
+places|England
+places|England|London
+

The only free nodes are “places” and “places|England”. Both of these free nodes are also (by implication) categories.

+

You can attach any of these tags to any image. Any tags attached to an image, except category tags, can be included when that image is exported.

+

If you attach the “places|France|Nord|Lille” tag to an image, the “places|France|Nord” and “places|France” tags are also implicitly attached to that image (you don’t need to attach them manually). Note that this is only true here because those additional tags have been separately defined – the “places” node is not included because it is a “free node” (not a tag).

+

🔗module sections

+

+ + + + + + + + +tagging-overview + +

+

The tagging module consists of two sections

+
    +
  1. +

    The upper attached tags section (with the attach/detach buttons under it)

    +
  2. +
  3. +

    The lower tag dictionary section (with the new/import…/export… buttons under it)

    +
  4. +
+

🔗attached tags section

+

The attached tags section displays tag(s) attached to image(s), where those images are

+
    +
  • +

    under your mouse cursor (if hovering over an image in the lighttable view); or

    +
  • +
  • +

    currently selected (if not hovering over an image)

    +
  • +
+

Automatically generated darktable tags (with names starting “darktable|”) cannot be selected.

+

At the bottom of the attached tags section are the following buttons, from left to right:

+
+
attach
+
If a tag is selected in the tag dictionary section, attach this tag to the selected images.
+
detach
+
If a tag is selected in the attached tags list, detach that tag from the selected images. A tag can also be detached if you right click on the tag name and select detach from the pop-up menu.
+
+ + + + + + + + +check-icon + + hidden tags
+
Choose whether to view any hidden tags that darktable has automatically attached to the selected images.
+
+ + + + + + + + +sort-icon + + sort
+
Choose whether to sort the attached tags list alphabetically or by the count shown in brackets next to the tag (this count indicates how many of the selected images have that tag attached to them).
+
+ + + + + + + + +minus-icon + + parents
+
Choose whether or not to show the parent categories of the tag.
+
+

You can adjust the height of the attached tags window by holding Ctrl and scrolling with your mouse wheel.

+

🔗tag dictionary section

+

The tag dictionary section displays all of the tags that are available in darktable’s database. At the top of the tag dictionary section is a text box where tag names can be entered. Below this is a list of available tags, which may also include indicator symbols to the left of the tag names. The meanings of these symbols are as follows:

+
    +
  • +

    a check mark [✓] indicates that the tag is attached to all of the selected images

    +
  • +
  • +

    a minus sign [–] indicates that the tag is attached to at least one of the selected images. If the symbol is next to a node name in the hierarchical tree view, it means that one of the child tags under that node is attached to at least one of the selected images.

    +
  • +
  • +

    if no indicator symbol is present, this means that the tag is not attached to any of the selected images, or that the node has no child tags attached to any of the selected images.

    +
  • +
+

In the hierarchical tree view, a name in italics represents either a free node or a category.

+

Below the tag dictionary list are the following buttons, from left to right:

+
+
new
+
Create a new tag, using the name that has been entered into the text entry box at the top of the tag dictionary section.
+
import…
+
Import tags from a Lightroom keyword file.
+
export…
+
Export all tags to a Lightroom keyword file.
+
+ + + + + + + + +plus-icon + + suggestions
+
Show a list of suggested keywords based on the keywords already associated with the selected images (see the preferences section). CAUTION: This view queries the database so might be slow.
+
+ + + + + + + + +list-tree-icon + + list/tree
+
Toggle the display of tags between the straight list view and hierarchical tree view.
+
+

You can adjust the height of the tag dictionary window by holding Ctrl while scrolling with your mouse wheel.

+

🔗usage

+

The following sections describe the operations that can be performed with tags.

+

🔗text entry

+

The text entry box (shown under the attach/detach buttons) has multiple purposes.

+
    +
  • +

    If the tag dictionary list is in list view mode (rather than tree view mode), then typing the first few characters of a tag will bring up a list of suggestions. You can then scroll down with the arrow keys and press Enter to select one of the suggestions. Pressing Enter a second time will attach it to the selected images. You can also edit the name of the tag before pressing Enter – in this case the tag will be created if it doesn’t already exist in the database.

    +
  • +
  • +

    Typing some partial text into the text entry box allows you filters the set of tags shown in the tag dictionary window to those whose name or synonym matches the entered text. Press Enter to attach a tag with the entered name to the selected images. If that tag name does not yet exist in the database, it will be created before being attached.

    +
  • +
  • +

    The pop-up menu entry “copy to entry” can be used to copy a selected tag to the text entry box. You can then edit this name and press Enter to create a new tag with that name, making it easy to create multiple tags with similar names.

    +
  • +
+

🔗create tag

+

There are several ways to create a new tag:

+
    +
  • +

    Import a text file. You can import one or more text files in the Lightroom tagging file format. You can also export your tags, edit the exported file, then re-import it. The import function updates existing tags and creates new tags as required. If you change the name of a tag in an imported file, it will be treated as a new tag.

    +
  • +
  • +

    Import already-tagged images. This method does not offer any flexibility to change tag names or categories during the import process.

    +
  • +
  • +

    Use the “create tag” sub-menu. A tag can be created manually, under an existing one (hierarchical) or at the root level.

    +
  • +
  • +

    Use the “set as a tag“ sub-menu. You can set a free node (e.g. ”places|England”) as a tag so that it gets implicitly attached to all images tagged with its sub-tags (e.g. ”places|England|London”).

    +
  • +
  • +

    Type into the text box and press the “new” button or the Enter key. Hierarchical tags are created using the pipe symbol “|” to separate nodes. Note that the entered tag is also attached to any selected images.

    +
  • +
+

A number of tags are automatically generated by darktable when certain actions are undertaken. For example, the tags “darktable|exported” and “darktable|styles|your_style” can be used to identify images that have been exported and had styles applied, respectively.

+

🔗edit/rename tag

+

The tag dictionary can be maintained via the “edit…” and “change path…” items in the right-click pop-up menu.

+

The “edit…” operation allows you to change the name of a tag, though you cannot change which node it belongs to (you cannot use the pipe “|” symbol in the tag name field). The command is aborted if you try to enter a tag name that already exists. You can set the private and category flags and define synonyms for the tag (see below). These attributes are recorded in the XMP-dc Subject and XMP-lr Hierarchical Subject metadata entries, respectively. You can control which tags are included in exports by changing settings in the export module.

+
    +
  • +

    A tag set as “private” is, by default, not exported.

    +
  • +
  • +

    A tag set as “category” is not exported in XMP-dc Subject. However it is exported in XMP-lr Hierarchical Subject as this XMP metadata holds the organization of your tags.

    +
  • +
  • +

    “synonyms” enrich the tag information and are mainly used to assist search engines. For example “juvenile”, “kid” or “youth” can be set as synonyms of “child”. Synonyms can also be used to translate tag names to other languages.

    +
  • +
+

The “change path…” operation is only available in the tree view mode, and it shows the number of tagged images which would be impacted by a change to the name of this node. The change path window lets the user change the full path of the node, including the nodes to which it belongs (nodes can be specified using the pipe “|” symbol). This operation is powerful, but please take care as it can have a significant impact on the metadata of your images. The operation is aborted if the requested change causes a conflict with an existing tag.

+

A quick way to organize the tag structure is to drag and drop the nodes. In the tree view mode, you can drag any node and drop it on top of any other node. The first node and its descendants, if any, become descendants of the second node. Dragging over a node automatically opens that node (to avoid opening a node, drag over the node selection indicator instead). To place a node at the root level, drag it onto the top of the tagging window. If the requested change causes a conflict with an existing tag, the operation is aborted.

+

🔗attach tag

+

There are a number of ways to attach an existing tag to a group of selected images:

+
    +
  • click on a tag in the tag dictionary window to select it, then click on the attach button.
  • +
  • right-click on a tag in the tag dictionary window, to show a pop-up menu, then select the “attach tag” menu item.
  • +
  • double-click on a tag in the tag dictionary window.
  • +
  • right-click on a tag shown in the attached tags view to show a pop-up menu. If some of the selected images do not currently have that tag, the “attach tag to all” menu item can be used to attach that tag to all the selected images.
  • +
  • Type into the text box and press the “new” button or the Enter key. This will create the tag if it doesn’t already exist, and attach it to the selected images.
  • +
  • Press Ctrl+T to open a small text box at the bottom of the central view of the lighttable. Type in the name of a tag and press Enter. The tag will be created if it doesn’t exist, and attached to all the selected images.
  • +
  • Drag an image or group of images and drop it onto the desired tag.
  • +
+

When hovering over the images in the ligthtable you can check which tags are attached to the image, either by looking at the attached tags window in the tagging module, or in the tags attribute in the image information module.

+

🔗detach tag

+

There are several ways to remove a tag from a group of selected images:

+
    +
  • click on a tag in the attached tag window of the tagging module to select the tag, then click on the detach button.
  • +
  • double-click on a tag in the attached tag window.
  • +
  • right-click on a tag in the attached tag window, to show a pop-up menu, and select “detach”.
  • +
+

🔗delete tag

+

It is possible to completely remove a tag from all images (whether selected or not) and delete the tag from the database. Because this could impact a large number of images, a warning will be displayed indicating how many images currently have this tag attached. Take this warning seriously as there is no way to undo this action (except by restoring your database and/or XMP sidecar files from a backup). A tag in tag dictionary window can be deleted in the following ways:

+
    +
  • right-click on a tag in the tag dictionary window, to show a pop-up menu, and choose “delete tag”.
  • +
  • right-click on a branch node in the tag dictionary window, to show a pop-up menu, and choose “delete node” to delete the selected node together with any child nodes.
  • +
+

🔗import / export

+

The “import” button allows you to choose a text file (which must comply with the Lightroom tag text file format) and import its content. If a tag in the imported file already exists, its properties will be updated, otherwise a new tag will be created.

+

The “export” button exports your entire tag dictionary into a text file of your choice (Lightroom tag text file format).

+

🔗keyboard

+

The following keys can be used within the tagging module:

+
    +
  • +

    The Tab key can be used to navigate between the attached tags view, the text entry box, and the tag dictionary view. Pressing Tab from within the text entry field selects the first matching tag in the tag dictionary view (if any).

    +
  • +
  • +

    The Down arrow key is equivalent to the Tab key, when pressed while inside the text entry field.

    +
  • +
  • +

    Shift+Tab does the same as the Tab key but navigates in the opposite direction. Pressing Shift+Tab from within the text entry field selects the first user tag in the attached tags view (if any).

    +
  • +
  • +

    The Enter key can be used within the tag dictionary view to attach the selected tag, keeping focus on the attached tag (similar to when a tag is attached using the mouse).

    +
  • +
  • +

    Pressing Shift+Enter from within the tag dictionary view returns focus to the text entry field.

    +
  • +
  • +

    The Delete / BackSpace keys can be used within the attached tags view to detach the selected tag.

    +
  • +
+ +

To see the images bearing a particular tag in the tag dictionary window, right-click on the tag name and choose “go to tag collection” in the resulting pop-up menu. This opens a collection in the collections module showing all images containing this tag. You can also select other tags in the collections module by double-clicking on the collection for the other tag.

+

To return to the collection that was selected before opening a tag collection select the “go back to work” item from the pop-up menu. This will allow you to return to the original collection, as long as you haven’t selected any other collections in the meantime.

+

🔗preferences

+

The “preferences…” option in the presets menu brings up a dialog where you can tweak the behavior of the tag suggestions list. The tag suggestions list comprises two parts, with the best-matched tags on one side and the most-recently-attached tags on the other. The following options are available:

+
+
suggested tags level of confidence
+
Level of confidence used to include the tag in the suggestions list (default 50):
+
    +
  • 0: display all associated tags,
  • +
+
+
    +
  • 99: match tags with a 99% confidence level,
  • +
+
+
    +
  • 100: this is essentially an unreachable level of confidence and so returns no matching tags. Use 100% to disable the best-matched tag suggestion list (faster).
  • +
+
+
number of recently attached tags
+
Number of recently attached tags to include in the suggestions list (default 20). A value of “-1” can be used to disable the the most-recently-attached suggestions list.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/shared/tagging/list-tree-icon.png b/en/module-reference/utility-modules/shared/tagging/list-tree-icon.png new file mode 100644 index 0000000000..165e47b171 Binary files /dev/null and b/en/module-reference/utility-modules/shared/tagging/list-tree-icon.png differ diff --git a/en/module-reference/utility-modules/shared/tagging/minus-icon.png b/en/module-reference/utility-modules/shared/tagging/minus-icon.png new file mode 100644 index 0000000000..376945c843 Binary files /dev/null and b/en/module-reference/utility-modules/shared/tagging/minus-icon.png differ diff --git a/en/module-reference/utility-modules/shared/tagging/plus-icon.png b/en/module-reference/utility-modules/shared/tagging/plus-icon.png new file mode 100644 index 0000000000..d3463fcd16 Binary files /dev/null and b/en/module-reference/utility-modules/shared/tagging/plus-icon.png differ diff --git a/en/module-reference/utility-modules/shared/tagging/sort-icon.png b/en/module-reference/utility-modules/shared/tagging/sort-icon.png new file mode 100644 index 0000000000..fb2216796f Binary files /dev/null and b/en/module-reference/utility-modules/shared/tagging/sort-icon.png differ diff --git a/en/module-reference/utility-modules/shared/tagging/tagging-overview.png b/en/module-reference/utility-modules/shared/tagging/tagging-overview.png new file mode 100644 index 0000000000..a398453cbe Binary files /dev/null and b/en/module-reference/utility-modules/shared/tagging/tagging-overview.png differ diff --git a/en/module-reference/utility-modules/tethering/camera-settings/index.html b/en/module-reference/utility-modules/tethering/camera-settings/index.html new file mode 100644 index 0000000000..ac4c01504b --- /dev/null +++ b/en/module-reference/utility-modules/tethering/camera-settings/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - camera settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / tethering / camera settings + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ camera settings +

+ + + +

Set up an image capture job.

+

This can include sequence, bracket and delayed captures. You are also able to control other camera settings such as focus mode, aperture, shutter speed, ISO and white balance.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/tethering/index.html b/en/module-reference/utility-modules/tethering/index.html new file mode 100644 index 0000000000..14f5fe3016 --- /dev/null +++ b/en/module-reference/utility-modules/tethering/index.html @@ -0,0 +1,3031 @@ + + + + + +darktable user manual - tethering + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + + +darktable / Module Reference / utility modules / tethering + +
+ +
+
+ + + +
+ +
+ + +
+ +

tethering

+ +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/tethering/index.xml b/en/module-reference/utility-modules/tethering/index.xml new file mode 100644 index 0000000000..4ab2c344e3 --- /dev/null +++ b/en/module-reference/utility-modules/tethering/index.xml @@ -0,0 +1,32 @@ + + + + tethering on darktable user manual + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/ + Recent content in tethering on darktable user manual + Hugo + en + + + camera settings + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/camera-settings/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/camera-settings/ + Set up an image capture job. This can include sequence, bracket and delayed captures. You are also able to control other camera settings such as focus mode, aperture, shutter speed, ISO and white balance. + + + live view + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/live-view/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/live-view/ + Control your camera&rsquo;s live view mode. Functionality such as focus control, rotation, guides and overlays are supported. + + + session + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/session/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/session/ + Set a session jobcode to allow the creation of a new film roll. A session is a sequence of exposures taken in tethering mode and placed into a single film roll. A new session means the creation of a new film roll. The session module allows you to set a jobcode, which can be used to create your new film roll. See preferences &gt; import &gt; session options for details about how to create new film rolls using the $(JOBCODE) variable in the session module. + + + diff --git a/en/module-reference/utility-modules/tethering/live-view/index.html b/en/module-reference/utility-modules/tethering/live-view/index.html new file mode 100644 index 0000000000..54d7f8e32f --- /dev/null +++ b/en/module-reference/utility-modules/tethering/live-view/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - live view + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / tethering / live view + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ live view +

+ + + +

Control your camera’s live view mode.

+

Functionality such as focus control, rotation, guides and overlays are supported.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/module-reference/utility-modules/tethering/session/index.html b/en/module-reference/utility-modules/tethering/session/index.html new file mode 100644 index 0000000000..697f5311d8 --- /dev/null +++ b/en/module-reference/utility-modules/tethering/session/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - session + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + + +darktable / Module Reference / utility modules / tethering / session + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ session +

+ + + +

Set a session jobcode to allow the creation of a new film roll.

+

A session is a sequence of exposures taken in tethering mode and placed into a single film roll. A new session means the creation of a new film roll.

+

The session module allows you to set a jobcode, which can be used to create your new film roll. See preferences > import > session options for details about how to create new film rolls using the $(JOBCODE) variable in the session module.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/index.html b/en/overview/index.html new file mode 100644 index 0000000000..50600023e8 --- /dev/null +++ b/en/overview/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - Overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/index.xml b/en/overview/index.xml new file mode 100644 index 0000000000..bcf2e32dde --- /dev/null +++ b/en/overview/index.xml @@ -0,0 +1,18 @@ + + + + Overview on darktable user manual + https://darktable-org.github.io/dtdocs/en/overview/ + Recent content in Overview on darktable user manual + Hugo + en + + + supported file formats + https://darktable-org.github.io/dtdocs/en/overview/supported-file-formats/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/supported-file-formats/ + darktable supports a huge number of file formats from various camera manufacturers. In addition darktable can read a wide range of low- and high-dynamic-range images &ndash; mainly for data exchange between darktable and other software. In order for darktable to consider a file for import, it must have one of the following extensions (case independent): 3FR, ARI, ARW, BAY, BMQ, CAP, CINE, CR2, CR3, CRW, CS1, DC2, DCR, DNG, GPR, ERF, FFF, EXR, IA, IIQ, JPEG, JPG, JXL, K25, KC2, KDC, MDC, MEF, MOS, MRW, NEF, NRW, ORF, PEF, PFM, PNG, PXN, QTK, RAF, RAW, RDC, RW1, RW2, SR2, SRF, SRW, STI, TIF, TIFF, X3F + + + diff --git a/en/overview/sidecar-files/index.html b/en/overview/sidecar-files/index.html new file mode 100644 index 0000000000..6cf5059c39 --- /dev/null +++ b/en/overview/sidecar-files/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - sidecar files & non-destructive editing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Overview / sidecar files & non-destructive editing + +
+ + + + +
+ +

sidecar files & non-destructive editing

+ +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/sidecar-files/index.xml b/en/overview/sidecar-files/index.xml new file mode 100644 index 0000000000..c74d1909c2 --- /dev/null +++ b/en/overview/sidecar-files/index.xml @@ -0,0 +1,32 @@ + + + + sidecar files & non-destructive editing on darktable user manual + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/ + Recent content in sidecar files & non-destructive editing on darktable user manual + Hugo + en + + + sidecar files + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar/ + darktable is a non-destructive image editor and opens all images in read-only mode. Any data created within darktable (metadata, tags, and image processing steps) is stored in separate .XMP sidecar files. These files are stored alongside the original Raw files and allow darktable to store information about the images as well as the full editing history without touching the original raw files. When you import an image into darktable for the first time, an XMP file is automatically generated. + + + importing sidecar files generated by other applications + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar-import/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar-import/ + When importing an image, darktable automatically checks if it is accompanied by a sidecar file. As well as looking for files named &lt;basename&gt;.&lt;extension&gt;.xmp and &lt;basename&gt;_&lt;number&gt;.&lt;extension&gt;.xmp (darktable&rsquo;s XMP file naming formats) darktable also checks for the presence of a file in the form &lt;basename&gt;.xmp (the naming format for Lightroom&rsquo;s XMP sidecar files). Files with the latter naming format will be read by darktable but will not be written to. Once the image has been imported, darktable will generate an additional XMP file using its own naming convention. + + + local copies + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/local-copies/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/local-copies/ + Many users have huge image collections stored on extra hard drives in their desktop computer, or on an external storage medium (RAID NAS, external hard drives etc.). It is a common requirement to develop a number of images while travelling using a laptop and then later synchronize them back to the original storage medium. However, copying images manually from the main storage to the laptop and back is cumbersome and prone to errors. + + + diff --git a/en/overview/sidecar-files/local-copies/index.html b/en/overview/sidecar-files/local-copies/index.html new file mode 100644 index 0000000000..5ce5052332 --- /dev/null +++ b/en/overview/sidecar-files/local-copies/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - local copies + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + + + + +
+ +

+ local copies +

+ + + +

Many users have huge image collections stored on extra hard drives in their desktop computer, or on an external storage medium (RAID NAS, external hard drives etc.).

+

It is a common requirement to develop a number of images while travelling using a laptop and then later synchronize them back to the original storage medium. However, copying images manually from the main storage to the laptop and back is cumbersome and prone to errors. The “local copies” feature of darktable has been designed to directly support these use cases.

+

You can create local copies of selected images from within the lighttable. Local copies are always used when present, giving continued access to images even if the external storage is no longer connected. At a later point, when your primary storage medium has been reconnected, you can synchronize the XMP sidecar files back to this storage, deleting any local copies. These operations can be found in the actions on selection module in the lighttable.

+

For safety reasons, if local copies exist and the external storage is available, the local XMP sidecars are automatically synchronized at start up.

+

Local copies are stored within the $HOME/.cache/darktable directory and named img-<SIGNATURE>.<EXT> (where SIGNATURE is a hash signature (MD5) of the full pathname, and EXT is the original filename extension).

+

Local copies can be identified in the lighttable view by a white marker on the top right of the thumbnail. In addition, all local copies carry the darktable|local-copy tag to allow them to be easily selected.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/sidecar-files/sidecar-import/index.html b/en/overview/sidecar-files/sidecar-import/index.html new file mode 100644 index 0000000000..758a048eb2 --- /dev/null +++ b/en/overview/sidecar-files/sidecar-import/index.html @@ -0,0 +1,3039 @@ + + + + + +darktable user manual - importing sidecar files generated by other applications + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / sidecar files & non-destructive editing / importing sidecar files generated by other applications + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ importing sidecar files generated by other applications +

+ + + +

When importing an image, darktable automatically checks if it is accompanied by a sidecar file. As well as looking for files named <basename>.<extension>.xmp and <basename>_<number>.<extension>.xmp (darktable’s XMP file naming formats) darktable also checks for the presence of a file in the form <basename>.xmp (the naming format for Lightroom’s XMP sidecar files). Files with the latter naming format will be read by darktable but will not be written to. Once the image has been imported, darktable will generate an additional XMP file using its own naming convention.

+

At present, darktable is able to load the following metadata from Lightroom-generated sidecar files during the import process:

+
    +
  • tags (including hierarchical tags)
  • +
  • color labels
  • +
  • ratings
  • +
  • GPS information
  • +
+

In addition, darktable has been designed to help migrate some image operations from other specific applications. The aim here is not to make darktable a drop-in replacement for any other software, but rather to help you to recover part of the work you have already invested into your image. It is important to understand that the import process will never give identical results to other software. The underlying processing engines are very different from application to application, and depend a lot on the individual image. In some cases, the results may be similar but often, further adjustment will be required in darktable.

+

This migration happens automatically when entering the darkroom view, provided that a corresponding XMP sidecar is found.

+

At present, darktable is able to handle the following development steps from Lightroom-generated XMP files (with the corresponding darktable module in parentheses):

+ + + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/sidecar-files/sidecar/index.html b/en/overview/sidecar-files/sidecar/index.html new file mode 100644 index 0000000000..5d3c5b8158 --- /dev/null +++ b/en/overview/sidecar-files/sidecar/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - sidecar files + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + + + + +
+ +

+ sidecar files +

+ + + +

darktable is a non-destructive image editor and opens all images in read-only mode. Any data created within darktable (metadata, tags, and image processing steps) is stored in separate .XMP sidecar files. These files are stored alongside the original Raw files and allow darktable to store information about the images as well as the full editing history without touching the original raw files. When you import an image into darktable for the first time, an XMP file is automatically generated. The generation of XMP files can be disabled in preferences > storage > XMP sidecar files but this is not recommended in normal use.

+

For a given source image, multiple editing versions, called duplicates, can co-exist, sharing the same input image data but each having their own metadata, tags and processing steps. Each duplicate of a given image (named <basename>.<extension) is represented by a separate XMP sidecar file (with a filename constructed in the form <basename>_<number>.<extension>.xmp, where <number> represents the version number of that edit). Information for the initial edit – the “duplicate” with version number zero – is stored in the sidecar file named <basename>.<extension>.xmp. The version number of each duplicate is displayed in the image information module in each of darktable’s views.

+

Your work is automatically synchronised to the sidecar files without the need to press a “save” button. When backing up your data, make sure that you also retain copies of the XMP files, as these are required to fully reconstruct your work in case of a disaster.

+

In addition to the sidecar files, darktable keeps all image-related data in its library database for fast access. An image can only be viewed and edited from within darktable if its data has first been loaded into the library database. This happens automatically when you first import an image. If an image is subsequently re-imported, the database will be updated from the contents of its XMP file.

+

Once an image has been imported into darktable, the database entries take precedence over the XMP file. Subsequent changes to the XMP file by any other software are not visible to darktable – such changes will be overwritten the next time darktable synchronizes the file. On request, darktable can be configured to search for updated XMP files at startup, offering a choice to update the database or overwrite the XMP file where changes are identified. This configuration can be changed in preferences > storage > XMP sidecar files.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/supported-file-formats/index.html b/en/overview/supported-file-formats/index.html new file mode 100644 index 0000000000..b4f55aef44 --- /dev/null +++ b/en/overview/supported-file-formats/index.html @@ -0,0 +1,3025 @@ + + + + + +darktable user manual - supported file formats + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Overview / supported file formats + +
+ + + + +
+ +

+ supported file formats +

+ + + +

darktable supports a huge number of file formats from various camera manufacturers. In addition darktable can read a wide range of low- and high-dynamic-range images – mainly for data exchange between darktable and other software.

+

In order for darktable to consider a file for import, it must have one of the following extensions (case independent): 3FR, ARI, ARW, BAY, BMQ, CAP, CINE, CR2, CR3, CRW, CS1, DC2, DCR, DNG, GPR, ERF, FFF, EXR, IA, IIQ, JPEG, JPG, JXL, K25, KC2, KDC, MDC, MEF, MOS, MRW, NEF, NRW, ORF, PEF, PFM, PNG, PXN, QTK, RAF, RAW, RDC, RW1, RW2, SR2, SRF, SRW, STI, TIF, TIFF, X3F

+

If darktable was compiled with JPEG2000 support, the following extensions are also recognized: J2C, J2K, JP2, JPC.

+

If darktable was compiled with GraphicsMagick support, the following extensions are also recognized: BMP, DCM, GIF, JNG, JPC, JP2, MIFF, MNG, PBM, PGM, PNM, PPM, WEBP.

+

🔗camera raw files

+

darktable reads raw files using the open source library RawSpeed, originally developed by Klaus Post and now maintained as part of the darktable project. The number of supported cameras and file formats is constantly increasing. Most modern camera models are supported, and new ones tend to get added very quickly. It is beyond the scope of this manual to give an exhaustive list.

+

With the exception of Fujifilm X-Trans cameras, darktable does not decode images from cameras with non-Bayer sensors (e.g. Sigma cameras with the Foveon X3 sensor).

+

🔗other image files

+

darktable natively reads “ordinary” images in JPEG, 8-bit/16-bit PNG and 8-bit/16-bit TIFF format, as well as 16-bit/32-bit floating point TIFF formats.

+

darktable also reads high dynamic range images in OpenEXR, RGBE and PFM formats.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/user-interface/filmstrip/index.html b/en/overview/user-interface/filmstrip/index.html new file mode 100644 index 0000000000..5c212999c5 --- /dev/null +++ b/en/overview/user-interface/filmstrip/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - filmstrip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / user interface / filmstrip + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ filmstrip +

+ + + +

The filmstrip, when enabled, is shown at the bottom of the screen (except in the lighttable view, where it is replaced with the timeline module) and displays the images from the current collection (set in the lighttable view). You can navigate the filmstrip by scrolling with the mouse wheel.

+

The filmstrip allows you to interact with images while you are not in the lighttable view. For example, while developing an image in darkroom mode, you can switch to another image by clicking its thumbnail in the filmstrip. You can also rate and color-classify the images as you do in lighttable, as well as copy & paste the history stack using keyboard shortcuts.

+

See the filmstrip module documentation for more information.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/user-interface/index.html b/en/overview/user-interface/index.html new file mode 100644 index 0000000000..33c572da03 --- /dev/null +++ b/en/overview/user-interface/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - user interface + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Overview / user interface + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

user interface

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/user-interface/index.xml b/en/overview/user-interface/index.xml new file mode 100644 index 0000000000..cc94fd249c --- /dev/null +++ b/en/overview/user-interface/index.xml @@ -0,0 +1,46 @@ + + + + user interface on darktable user manual + https://darktable-org.github.io/dtdocs/en/overview/user-interface/ + Recent content in user interface on darktable user manual + Hugo + en + + + views + https://darktable-org.github.io/dtdocs/en/overview/user-interface/views/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/views/ + The functionality in darktable is separated into six different views: lighttable Manage images and collections. darkroom Develop a single image. map Show geo-tagged images on a map and manually geo-tag new images. print Send images to a printer. slideshow Display images as a slideshow, processing them on-the-fly. tethering Remotely capture and save images taken with a connected camera. You can switch between views by clicking the view name at the top of the right-hand panel (the currently active view is highlighted) or by using one of the following keyboard shortcuts: + + + screen layout + https://darktable-org.github.io/dtdocs/en/overview/user-interface/screen-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/screen-layout/ + The layout of all darktable views is similar and consists of a center area with panels at the edges: center area : Contains information and functionality specific to the current view. left panel : Contains modules primarily used to provide information. right panel : Contains modules primarily used for image processing. top banner : Contains information about the current darktable version and allows you to switch between views. Also used by some modules to show additional hints and messages. + + + filmstrip + https://darktable-org.github.io/dtdocs/en/overview/user-interface/filmstrip/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/filmstrip/ + The filmstrip, when enabled, is shown at the bottom of the screen (except in the lighttable view, where it is replaced with the timeline module) and displays the images from the current collection (set in the lighttable view). You can navigate the filmstrip by scrolling with the mouse wheel. The filmstrip allows you to interact with images while you are not in the lighttable view. For example, while developing an image in darkroom mode, you can switch to another image by clicking its thumbnail in the filmstrip. + + + top panel + https://darktable-org.github.io/dtdocs/en/overview/user-interface/top-panel/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/top-panel/ + The top panel appears in all darktable views and provides access to common functions. 🔗On the left-hand-side filter / sort Choose how to filter and sort the images. Criteria can be altered in the collection filters module or by clicking on the icon. sort order Switch the sort order (ascending / descending). 🔗On the right-hand-side grouping Expand or collapse grouped images. thumbnail overlays Define what information is overlaid on to thumbnails in the lighttable/filmstrip. + + + keyboard shortcuts + https://darktable-org.github.io/dtdocs/en/overview/user-interface/keyboard-shortcuts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/user-interface/keyboard-shortcuts/ + Much of the functionality in darktable can be controlled via keyboard shortcuts, which can be customised in preferences &gt; shortcuts. Press the H key (for help) in any darktable view to show a list of all shortcuts that are applicable to the current view. + + + diff --git a/en/overview/user-interface/keyboard-shortcuts/index.html b/en/overview/user-interface/keyboard-shortcuts/index.html new file mode 100644 index 0000000000..938889f0ea --- /dev/null +++ b/en/overview/user-interface/keyboard-shortcuts/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - keyboard shortcuts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / user interface / keyboard shortcuts + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ keyboard shortcuts +

+ + + +

Much of the functionality in darktable can be controlled via keyboard shortcuts, which can be customised in preferences > shortcuts.

+

Press the H key (for help) in any darktable view to show a list of all shortcuts that are applicable to the current view.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/user-interface/screen-layout/index.html b/en/overview/user-interface/screen-layout/index.html new file mode 100644 index 0000000000..422d992cb0 --- /dev/null +++ b/en/overview/user-interface/screen-layout/index.html @@ -0,0 +1,3076 @@ + + + + + +darktable user manual - screen layout + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / user interface / screen layout + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ screen layout +

+ + + +

The layout of all darktable views is similar and consists of a center area with panels at the edges:

+

+ + + + + + + + +screen-layout + +

+
    +
  1. +

    center area +: Contains information and functionality specific to the current view.

    +
  2. +
  3. +

    left panel +: Contains modules primarily used to provide information.

    +
  4. +
  5. +

    right panel +: Contains modules primarily used for image processing.

    +
  6. +
  7. +

    top banner +: Contains information about the current darktable version and allows you to switch between views. Also used by some modules to show additional hints and messages.

    +
  8. +
  9. +

    top panel +: Provides access to global settings and shortcuts

    +
  10. +
  11. +

    bottom panel +: Provides access to view-specific settings and shortcuts.

    +
  12. +
  13. +

    filmstrip/timeline panel +: An optional panel that can be enabled at the bottom of the screen to display a timeline (in the lighttable view) or a filmstrip (in other views) of images in the current collection.

    +
  14. +
+

🔗panel size and visibility

+

The left, right and filmstrip/timeline panels can be resized by dragging their inner borders.

+

Each of the panels can be expanded or collapsed by pressing the triangle located at the outside edge of the panels. Panel visibility can also be adjusted using keyboard shortcuts, as follows:

+
    +
  • TAB temporarily expands the centre view to fill the whole window. Press again to return to the previous view.
  • +
  • F11 toggles fullscreen mode
  • +
  • Shift+Ctrl+t toggles the top panel (between the image and the top banner)
  • +
  • Shift+Ctrl+b toggles the bottom panel (between the image and the filmstrip/timeline, if shown)
  • +
  • Shift+Ctrl+l toggles the left panel
  • +
  • Shift+Ctrl+r toggles the right panel
  • +
  • Ctrl+f toggles the filmstrip/timeline
  • +
  • Ctrl+h toggles the top banner
  • +
  • b toggles all borders and panel-collapse controls
  • +
+
+

Note: The size and visibility of the panels are stored independently for each view.

+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/user-interface/screen-layout/screen-layout-src.png b/en/overview/user-interface/screen-layout/screen-layout-src.png new file mode 100644 index 0000000000..a929299640 Binary files /dev/null and b/en/overview/user-interface/screen-layout/screen-layout-src.png differ diff --git a/en/overview/user-interface/screen-layout/screen-layout.png b/en/overview/user-interface/screen-layout/screen-layout.png new file mode 100644 index 0000000000..03b7f3236e Binary files /dev/null and b/en/overview/user-interface/screen-layout/screen-layout.png differ diff --git a/en/overview/user-interface/top-panel/index.html b/en/overview/user-interface/top-panel/index.html new file mode 100644 index 0000000000..ac9fc7939e --- /dev/null +++ b/en/overview/user-interface/top-panel/index.html @@ -0,0 +1,3127 @@ + + + + + +darktable user manual - top panel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / user interface / top panel + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ top panel +

+ + + +

The top panel appears in all darktable views and provides access to common functions.

+

+ + + + + + + + +top-panel + +

+

🔗On the left-hand-side

+
+
filter / sort
+
Choose how to filter and sort the images. Criteria can be altered in the collection filters module or by clicking on the + + + + + + + + +top-panel_filter-preferences icon + + icon.
+
+ + + + + + + + +top-panel_sort-order icon + + sort order
+
Switch the sort order (ascending / descending).
+
+

🔗On the right-hand-side

+
+
+ + + + + + + + +top panel_grouping icon + + grouping
+
Expand or collapse grouped images.
+
+ + + + + + + + +top panel_overlays icon + + thumbnail overlays
+
Define what information is overlaid on to thumbnails in the lighttable/filmstrip.
+
You can define different settings depending on the thumbnail size. See preferences > lighttable for details of how size delimiters are set.
+
+ + + + + + + + +top panel_help icon + + context-sensitive help
+
Click this icon and then click on a control element to be directed to the appropriate online help page.
+
+ + + + + + + + +top panel shortcut mapping icon + + shortcut mapping
+
Click this icon to enter the visual shortcut mapping mode to create keyboard/mouse shortcuts.
+
+ + + + + + + + +top panel_preferences icon + + preferences
+
View and amend darktable’s preferences & settings.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/user-interface/top-panel/top-panel.png b/en/overview/user-interface/top-panel/top-panel.png new file mode 100644 index 0000000000..af6461baf8 Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_filter-preferences.png b/en/overview/user-interface/top-panel/top-panel_filter-preferences.png new file mode 100644 index 0000000000..8e879aba49 Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_filter-preferences.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_grouping.png b/en/overview/user-interface/top-panel/top-panel_grouping.png new file mode 100644 index 0000000000..1a25cdaf2e Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_grouping.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_help.png b/en/overview/user-interface/top-panel/top-panel_help.png new file mode 100644 index 0000000000..de9bf2883b Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_help.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_overlays.png b/en/overview/user-interface/top-panel/top-panel_overlays.png new file mode 100644 index 0000000000..fa86f0049e Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_overlays.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_preferences.png b/en/overview/user-interface/top-panel/top-panel_preferences.png new file mode 100644 index 0000000000..46b08e7bdc Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_preferences.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_shortcut.png b/en/overview/user-interface/top-panel/top-panel_shortcut.png new file mode 100644 index 0000000000..b352286a8e Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_shortcut.png differ diff --git a/en/overview/user-interface/top-panel/top-panel_sort-order.png b/en/overview/user-interface/top-panel/top-panel_sort-order.png new file mode 100644 index 0000000000..a5f2d157e2 Binary files /dev/null and b/en/overview/user-interface/top-panel/top-panel_sort-order.png differ diff --git a/en/overview/user-interface/views/index.html b/en/overview/user-interface/views/index.html new file mode 100644 index 0000000000..7e7f792aa7 --- /dev/null +++ b/en/overview/user-interface/views/index.html @@ -0,0 +1,3040 @@ + + + + + +darktable user manual - views + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / user interface / views + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ views +

+ + + +

The functionality in darktable is separated into six different views:

+
+
lighttable
+
Manage images and collections.
+
darkroom
+
Develop a single image.
+
map
+
Show geo-tagged images on a map and manually geo-tag new images.
+
print
+
Send images to a printer.
+
slideshow
+
Display images as a slideshow, processing them on-the-fly.
+
tethering
+
Remotely capture and save images taken with a connected camera.
+
+

You can switch between views by clicking the view name at the top of the right-hand panel (the currently active view is highlighted) or by using one of the following keyboard shortcuts:

+
    +
  • L switches to lighttable
  • +
  • D switches to darkroom
  • +
  • M switches to map
  • +
  • P switches to print
  • +
  • S switches to slideshow
  • +
  • T switches to tethering
  • +
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/workflow/export/index.html b/en/overview/workflow/export/index.html new file mode 100644 index 0000000000..a196fc8e66 --- /dev/null +++ b/en/overview/workflow/export/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - export + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ export +

+ + + +

darktable is a non-destructive editor, which means that all changes are recorded in the library database (with a backup stored in an XMP sidecar file), and the original Raw file is left untouched. You therefore need to export images in order to bake your edits into an output file that can be distributed outside of darktable.

+
    +
  1. +

    Choose an export scenario.

    +

    The export module offers many options, but by far the most common use is to “save a developed raw image as a JPEG”. You can either export the currently-edited image directly from the darkroom view or select one or more images from the lighttable view and export them all at once.

    +
  2. +
  3. +

    Select which images to export (if you are in the lighttable view), open the export module, set target storage to “file on disk” and select a location to save your images – by default, they will be exported to a “darktable_exported” directory within the directory that contains your Raw file(s). Choose a “file format” of JPEG and keep the default settings.

    +
  4. +
  5. +

    Click the “export” button to save your processed images in the selected location.

    +
  6. +
+

Note: While JPEG is useful for most purposes, if you wish to perform further edits in a raster editor like GIMP or Krita, it is normally better to export in TIFF format.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/workflow/import-review/index.html b/en/overview/workflow/import-review/index.html new file mode 100644 index 0000000000..b098c6aaec --- /dev/null +++ b/en/overview/workflow/import-review/index.html @@ -0,0 +1,3035 @@ + + + + + +darktable user manual - import & review + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Overview / an introduction to darktable's workflow / import & review + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ import & review +

+ + + +

Before you can do anything in darktable you must first add some images files to the library using the import module in the lighttable view. This will create entries for your images in darktable’s library database so that it can keep track of the changes you make. There are three ways to import images, each accessible through buttons in the import module:

+
+
add to library
+
This option adds images to the library without copying or moving – your original files will stay in their current location and will not be altered. On import, darktable will read the metadata from the image files and any accompanying XMP sidecar file. If an image has already been added to the database, any updates you have made to the sidecar file will be loaded.
+
copy & import
+
Copies the images to the storage location (following the file naming pattern defined in preferences > import), then adds the copied images to the library – the original images are not changed or moved. Only the images are copied and if an existing XMP sidecar file is available for the image, it will not be read, copied or used.
+
copy & import from camera
+
Connect the camera to your system with a USB cable (if your camera is auto-mounted by your system, you will need to un-mount it before it can be accessed by darktable). If you don’t see your camera listed in the import module, press the “scan for devices” button. Once your camera is detected the import module should offer the ability to copy & import images from the camera. Clicking the “copy & import” button physically copies the selected images from the camera into a specified directory (following the file naming pattern defined in preferences > import) and then adds the copied images to the library.
+
+

Once images have been imported, their thumbnails are displayed in the lighttable view, within which you can organize and catalog your imported images – please refer to the digital asset management section for more information.

+

The primary use for the lighttable view is to review your images and decide which you would like to edit further and which to discard. The following is a possible culling process to choose which images to edit/delete:

+
    +
  1. Set the lighttable view to only show images with a rating of exactly 1 star using the view setting on the top panel. Since darktable assigns a 1 star rating to newly-imported images by default, this will show all of the images you have just imported. You can use the collections module to further refine your selection if needed.
  2. +
  3. Perform a quick first-level screening of your images: If any images are badly out-of-focus or otherwise unwanted, reject them or give them a 0-star rating (by pressing the “R” or “0” keys, respectively, while hovering over the image with your mouse). If you would like an image to pass to the next review phase, press 2 to give it a 2 star rating. Any images that no longer have a 1 star rating will automatically disappear from view. Continue in this manner until no more images remain visible in the lighttable view.
  4. +
  5. Alter the lighttable view to only show images with 2 stars. Go through these images more carefully, and decide whether to promote them to a 3 star rating, or put them back down to a lower rating. Again, proceed until no more images remain in the lighttable view.
  6. +
  7. Alter the lighttable view to only show images with 3 stars. Perform quick edits and experiments on those images in the darkroom view to decide if they are worthy of further effort. If you are happy with the results of those edits, promote that image to a 4 star rating for final editing.
  8. +
  9. Go through your 4 star images, perform any final edits on them and then export to see the final result. Increase the rating a final time to 5 stars to indicate that processing is complete.
  10. +
+

If space is at a premium you might consider permanently deleting your rejected or 0-star images. Select these images in the lighttable view and use the ’trash/delete’ option in the actions on selection module. You should only do this for images you are certain you will never need again.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/workflow/index.html b/en/overview/workflow/index.html new file mode 100644 index 0000000000..887e51b449 --- /dev/null +++ b/en/overview/workflow/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - an introduction to darktable's workflow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Overview / an introduction to darktable's workflow + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

an introduction to darktable's workflow

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/workflow/index.xml b/en/overview/workflow/index.xml new file mode 100644 index 0000000000..b0ce6598b5 --- /dev/null +++ b/en/overview/workflow/index.xml @@ -0,0 +1,39 @@ + + + + an introduction to darktable's workflow on darktable user manual + https://darktable-org.github.io/dtdocs/en/overview/workflow/ + Recent content in an introduction to darktable's workflow on darktable user manual + Hugo + en + + + introduction + https://darktable-org.github.io/dtdocs/en/overview/workflow/introduction/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/introduction/ + This section is intended to provide you with a flavor of what darktable can do and offer a suggested end-to-end processing workflow. New users should start by working through this introduction and following the links provided for further details. Please note that this is not an exhaustive guide and many useful topics are not covered. You are advised to read through the reference sections of this manual once you are familiar with the basics. + + + import & review + https://darktable-org.github.io/dtdocs/en/overview/workflow/import-review/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/import-review/ + Before you can do anything in darktable you must first add some images files to the library using the import module in the lighttable view. This will create entries for your images in darktable&rsquo;s library database so that it can keep track of the changes you make. There are three ways to import images, each accessible through buttons in the import module: add to library This option adds images to the library without copying or moving &ndash; your original files will stay in their current location and will not be altered. + + + process + https://darktable-org.github.io/dtdocs/en/overview/workflow/process/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/process/ + This section is intended to get you comfortable processing images in the darkroom view using a scene-referred workflow. You are advised to follow the guidelines provided below, up to the end of the image processing in 3 modules section and then choose other areas to learn as-and-when you need to use those techniques in your images. 🔗getting started 🔗take a well-exposed photograph Good image processing techniques start in the camera &ndash; a well-exposed image (without blown highlights or heavily crushed blacks) will always make post-processing much more straightforward. + + + export + https://darktable-org.github.io/dtdocs/en/overview/workflow/export/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/overview/workflow/export/ + darktable is a non-destructive editor, which means that all changes are recorded in the library database (with a backup stored in an XMP sidecar file), and the original Raw file is left untouched. You therefore need to export images in order to bake your edits into an output file that can be distributed outside of darktable. Choose an export scenario. The export module offers many options, but by far the most common use is to “save a developed raw image as a JPEG”. + + + diff --git a/en/overview/workflow/introduction/index.html b/en/overview/workflow/introduction/index.html new file mode 100644 index 0000000000..8e318618d7 --- /dev/null +++ b/en/overview/workflow/introduction/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - introduction + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + + + + +
+ +

+ introduction +

+ + + +

This section is intended to provide you with a flavor of what darktable can do and offer a suggested end-to-end processing workflow. New users should start by working through this introduction and following the links provided for further details.

+

Please note that this is not an exhaustive guide and many useful topics are not covered. You are advised to read through the reference sections of this manual once you are familiar with the basics.

+

Further information on most of the subjects in this guide are also covered in the other resources section.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/overview/workflow/process/index.html b/en/overview/workflow/process/index.html new file mode 100644 index 0000000000..817cc30091 --- /dev/null +++ b/en/overview/workflow/process/index.html @@ -0,0 +1,3145 @@ + + + + + +darktable user manual - process + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+ +
+ + + +
+
+ + +
+ +

+ process +

+ + + +

This section is intended to get you comfortable processing images in the darkroom view using a scene-referred workflow. You are advised to follow the guidelines provided below, up to the end of the image processing in 3 modules section and then choose other areas to learn as-and-when you need to use those techniques in your images.

+

🔗getting started

+

🔗take a well-exposed photograph

+

Good image processing techniques start in the camera – a well-exposed image (without blown highlights or heavily crushed blacks) will always make post-processing much more straightforward. Under- or over-exposure can be “fixed” by darktable to some extent but no software can recover information that is not present in the Raw image (clipped highlights). Where possible, you are advised to use exposure to-the-right (ETTR) techniques to maximize the amount of data available for processing while avoiding clipping. As a general rule of thumb, in cases where the scene-dynamic-range exceeds that of your camera, it is safe to underexpose all images by 0.5 to 1 EV (by reducing the ISO sensitivity if possible) even if the in-camera preview looks darker than expected (the preview is not the raw data). If the scene dynamic range is lower than that of your camera, you may wish to dial in some over-exposure (decrease shutter speed or increase aperture) to capture more light and reduce noise.

+

🔗scene-referred workflow: a new approach

+

If you have used other Raw software in the past (or darktable prior to version 3.0) you may notice some significant differences from what you are used to – darktable now uses a scene-referred approach for most of its processing modules. This approach is used extensively in cinematography and is known to be much more robust than the traditional display-referred approach.

+

In display-referred processing the data from your Raw file is initially compressed into a range that represents pure black as 0 and pure white as 1, fixing mid-gray at 0.5. A tone curve is automatically (and irreversibly) applied to this data to make the image look “good” on your display and subsequent edits are carried out on top of this already highly-modified image data. The cost of display-referred is an early loss of the relationship between pixel luminosity and saturation (usually also involving hue shifts), which is responsible for the infamous “HDR look” when the dynamic range increases.

+

In the real world, “pure black” does not really exist (there is always some light) and there is no limit to how bright things can be (so no “pure white” either). Scene-referred processing attempts to retain the physical properties of the scene for as long as possible by placing the Raw data on an unbounded linear scale and only compressing the data to the dynamic range of your display after image processing is complete.

+

In a scene-referred workflow many common tools (tone curves and levels, for example) are no longer useful ways to manipulate the image, since they rely on now-invalid definitions of black, white and gray. Experienced users may need to learn new techniques and discard old ones, but will be rewarded with much more robust and predictable outputs.

+

The scene-referred workflow in darktable enables the filmic rgb and exposure modules by default when you open new images in the darkroom view.

+

🔗white balance and color calibration

+

Most processing software uses a traditional temperature/tint model for adjusting the white balance of an image. In darktable, the color calibration module provides a much more robust and flexible approach, allowing you to explicitly define the color of the light source. This is particularly useful for scenes illuminated by artificial lighting.

+

Please note that the white balance module is still enabled in this approach, but its settings normally should not be altered.

+
+

Set preferences > processing > auto-apply pixel workflow defaults to “scene-referred (filmic)” now.

+
+

Enter preferences by clicking on the gear icon in the top panel.

+

🔗edit in a controlled environment

+

Image processing should be performed in a controlled environment, lit by a white light source against a background approximating mid-gray, and on a monitor that has been properly calibrated.

+

While this may not be practical in many home editing environments you can control the background colors on your monitor’s display. You should set the darktable color scheme to use one of the “grey” themes and use the color assessment mode when altering tones and colors in your image. Dark themes might look good but, unless you are processing images to be viewed on a cinema screen in a darkened room, they should not be used for photo processing.

+
+

Set preferences > general > theme to “darktable-elegant-grey” or “darktable-icons-grey” now.

+
+

🔗enter the darkroom

+

Choose an image to edit from the lighttable view and double-click to load that image into the darkroom view. For now try to choose an image that is well exposed – we will discuss some techniques to recover badly-exposed images later.

+

In the darkroom view, you will see a list of processing modules to the right of your image. Each module performs its own processing on the image, in the order shown in the module list, starting at the bottom of the list and moving up to the top. You can think of this like a stack of building blocks where each block builds on the processing performed by the modules below it.

+

On the left hand side is the history stack (you may need to expand the module), which shows the order in which adjustments were made to the controls of the various modules. This allows you to undo changes by reverting to an earlier step in the history stack. You will see that a number of modules are applied automatically – these are needed in order to generate a legible image from the Raw data.

+

It is important to understand the distinction between the order of the modules on the right-hand-side of the screen (which represents the order in which modules are executed) and the order of the modules in the history stack (which represents the order in which modules were modified).

+

To the top right is the scopes module, which shows the spread of tones/colors in your image.

+
+

If you have previously viewed or edited the image in the darkroom view, start by discarding history (click the reset button in the history stack). This will reapply defaults using your new settings and provide a clean starting point for editing.

+
+

🔗why doesn’t the raw image look like the JPEG?

+

…because you haven’t processed it yet

+

One of the first things people notice when switching from lighttable to darkroom view is that the image looks different – often flatter and less saturated than that shown in the lighttable view. This is because the darkroom view displays the (mostly unprocessed) Raw image, but the lighttable view initially displays the (in-camera) JPEG preview. Now that you have opened the image in the darkroom view, the lighttable view will update to show the edited version.

+

Most Raw software goes to great lengths to reproduce the look of standard camera JPEGs out of the box. While this can be useful (if you only want to make very minor adjustments to the camera’s rendition of an image) we assume that you are using a Raw editor to make the image your own, and that the camera does not know how to do this. Certainly, if you are using the ETTR techniques mentioned above, the camera JPEG will rarely be close to how you want the final image to look.

+

The default settings in darktable are therefore intended to provide you with a neutral starting point for further editing and nothing more. We do not intend to change this.

+

🔗module groups

+

Below the scopes module, at the top right of the screen, is a set of tabs into which darktable’s modules are grouped. If you cannot find a module in one of the tabs you can use the search feature to locate it.

+
+

For the purposes of this guide, click on the hamburger icon (to the right of the tabs) and select the “workflow: scene-referred” preset now.

+
+

🔗image processing in 3 modules

+

The following basic adjustments are fundamental to scene-referred editing and will be required, to some extent, on the majority of images. You can usually produce a good-looking image with these steps alone.

+

As you will be adjusting the tones and colors of the image, start by enabling color assessment mode (press Ctrl+B) and perform the following edits on the zoomed-out image while in this mode.

+
    +
  1. +

    Set overall image brightness: First, set the overall (average) brightness of the image (the mid-gray point) by adjusting the exposure slider in the exposure module. This is a purely artistic setting and should be defined based on your intent – for example, for a high-key image you will set the average brightness to be lighter than for a low-key image. The color assessment mode provides you with two reference points to assist with this by surrounding the image with a white frame against a middle-gray background.

    +

    At this point, don’t worry if the brightest parts of your image lose detail – this can be recovered in the next step.

    +
    +

    Note: The lens correction module can also affect the image brightness so you may want to consider enabling it before adjusting exposure.

    +
    +
  2. +
  3. +

    Set white and black points: The next two steps use the filmic rgb module to define how the tones in your image will be mapped to the dynamic range of your display. Start by setting the white and black relative exposure sliders in the scene tab. These are purely technical settings, defining white and black relative to the mid-gray point you set in the previous step. If your image contains tones you want to treat as pure white or pure black you can use the pickers beside the sliders to set these values (using the maximum and minimum brightness of the image). Otherwise set the values manually using the color assessment frames as a reference.

    +
  4. +
  5. +

    Adjust the contrast: Now move to the look tab in filmic rgb (for now we will skip the reconstruct tab). Enable the look only view at the top of the module to see a representation of the filmic tone curve, which consists of a straight section in the middle (used to set the contrast of the mid-tones) and curved sections at the top and bottom (where the shadows and highlights are compressed to fit the dynamic range of the display).

    +

    The contrast slider changes the slope of the straight section (the mid-tone image contrast), the latitude slider changes its length and the shadows/highlights balance slider changes its position. There is a lot of give-and-take involved here – if you want to increase the contrast of the mid-tones, you must sacrifice contrast in the shadows/highlights and vice versa. The default settings of this module are tuned to work for the majority of images but you should experiment with these sliders to understand how they affect the image.

    +
    +

    Note: The highlight compression in the filmic rgb module can cause detail to be lost in the highlights. You can mitigate this to some extent by reducing the white relative exposure, adjusting the shadows/highlights balance or changing the contrast in highlights setting in the options tab. The tone equalizer module can also be used to reduce the relative brightness of the sky.

    +
    +
  6. +
  7. +

    Color preservation: The tone mapping in the filmic rgb module attempts to redistribute the tones in your image without affecting color reproduction. While the default color preservation algorithm works for most images, you are encouraged to experiment by changing the preserve chrominance setting in the options tab if you do not like how the colors appear.

    +
  8. +
  9. +

    Saturation: Your image will probably not look very colorful at this point. You can adjust the global saturation of the image using the color balance rgb module. The “basic colorfulness” preset should provide you with generally-reasonable defaults, but you are encouraged to experiment further with these settings as required.

    +
    +

    Note: This guide assumes that the white balance of the image has been correctly captured by your camera. If this is not the case, you may need to make some corrections in the color calibration module first.

    +
    +
  10. +
+

You can now switch off color assessment mode by pressing Ctrl+B again.

+

🔗other processing techniques

+

With practice the above workflow can quickly provide you with a reasonable-looking image, though most will need some additional work before they are ready for export. The following sections are intended to provide a brief outline of some more image processing techniques in darktable, with links to the relevant reference sections for more information.

+

As a general rule, you should begin with the basic steps outlined in the previous section, then perform corrections and finish with creative adjustments.

+

🔗corrections

+

🔗color calibration

+

Traditional white balance correction attempts to ensure that whites and grays are really neutral (R = G = B) and doesn’t really try to manage the impact on other colors. The CAT tab of the color calibration module extends this treatment to handle the remainder of the color range and works in a color space designed specifically for chromatic (color) adaptation. As with traditional white balance controls you can select a patch of neutral gray in your image to calculate the white balance, or use a selection of other automatic and manual methods. The default settings use the white balance from the image’s Exif data and are usually sufficient.

+

If you need to make adjustments in the color calibration module, you may want to also revisit any saturation corrections you made earlier in the color balance rgb module.

+

🔗correct lens distortions

+

All lenses introduce some artifacts (distortion, chromatic aberrations, vignetting) to the image. The lens correction module can correct many of these issues for a wide variety of lenses. The chromatic aberrations and raw chromatic aberrations modules can also be used to handle chromatic aberrations for lenses that are not (or only partially) supported by lens correction. In most cases simply enabling the lens correction module will auto-detect your lens and auto-apply all available corrections.

+

If you decide to use the lens correction module, it should be enabled at the start of your edit, before you adjust exposure, since vignetting correction can alter the overall brightness of your image.

+

🔗reduce noise / retain detail

+

At a pixel level there is a trade-off to be made between the retention of fine details and the reduction/removal of sensor noise. In most situations, a small amount of noise is perfectly acceptable and will not be noticeable except when you zoom in to 100%. At this scale you are not viewing the image at a realistic size – even when represented on a large monitor or print, noise that is obvious at high zoom factors will be virtually invisible on the final image. However, some modules further along the image pipeline (especially those that increase local contrast) may end up exaggerating any noise that is present so, again, there are trade-offs to be made.

+

The first module you can use to manage this is demosaic, which controls how the single-color (R, G or B) pixels in your Raw file are converted to image pixels combining all three colors. Each demosaic algorithm has its own trade-offs between retaining fine detail and reducing noise. The default demosaic algorithm (RCD) usually provides a reasonable compromise.

+

Demosaic algorithms can only do so much to manage noise in your image. The denoise (profiled) module is individually tuned for a number of common camera sensors and can be used to reduce or remove pixel noise. As with demosaic you should alter the settings until you are happy with the balance of denoising vs fine-detail reproduction. The default settings are usually sufficient.

+

🔗sharpness and local contrast

+

A number of modules can be used to adjust the local contrast and sharpness of your image. Most of these modules aim to enhance the apparent contrast of edges and do not add “real” sharpness (they are not the same as lens deconvolution). You should take care when using these modules as most of them can introduce artifacts (such as halos) when settings are pushed too far:

+
    +
  • the contrast equalizer module allows you to adjust contrast, limiting the effect to certain feature sizes. For example you can use it to increase the contrast of fine details without impacting larger-scale objects, or vice versa
  • +
  • the diffuse or sharpen module offers a number of presets for sharpening, lens deblurring and the addition of local contrast
  • +
  • the local contrast module provides a simpler interface for quickly adding local contrast to your images – just enabling the module or selecting one of the presets is often all that is required
  • +
  • the sharpen module is intended to re-introduce sharpness that was removed by your camera’s anti-alias filter (if present) and can be enabled by default in preferences > processing. The methods listed above are usually preferred to this legacy module.
  • +
+

As with the modules mentioned in the previous section, you should take care when adding contrast to small-scale objects – an image viewed at 100% is not a realistic representation of your final edit and local contrast adjustments are usually better judged when zoomed out.

+

🔗reconstruct blown highlights

+

While a well-exposed image will make post-processing much easier, darktable does provide a few tools to handle blown highlights.

+

The highlight reconstruction module attempts to reconstruct blown highlights (colors and structure) using adjacent pixels. A number of different approaches are provided, some of which may be better on certain images, however, the default algorithm produces good results in most cases.

+

Even well-reconstructed highlights can show color and edge artefacts, some of which may be exacerbated by subsequent modules in the pipe. In this case the reconstruct tab on the filmic rgb module provides additional methods to further smooth/correct highlights at the end of the processing pipeline.

+

🔗adjust angle and perspective

+

The rotate and perspective module can be used to adjust the angle of the image or to simulate the functionality of a tilt/shift lens by altering the perspective, making converging horizontal and/or vertical lines parallel (keystone correction). This latter technique is most commonly used for architectural photography. If you just want to correct the angle of the horizon you can do this by right-clicking and dragging along the horizon line.

+

🔗remove spots and unwanted objects

+

Use the retouch module to remove unwanted objects by replacing pixels with detail from elsewhere in the image. This module also offers powerful techniques for removing large-scale objects (such as spots or blemishes) while leaving fine-scale details (like hairs and follicles) intact. The most common use for this module is to remove dust spots from images or blemishes from skin.

+

🔗remove atmospheric haze

+

There are two methods for removing atmospheric haze in darktable. The haze removal module provides a much simpler interface, but the “dehaze” preset in the diffuse or sharpen module can provide more flexibility when needed.

+

🔗creative adjustments

+

🔗crop and frame

+

Use the crop module to crop your image and the framing module to surround your image with a colored frame. Both modules can be set to use a predefined or custom aspect ratio – for example, you could place a square-cropped image into a 3:2 frame.

+

🔗dodge and burn

+

Dodging and burning is a traditional darkroom technique to add and remove brightness from an image. There are two recommended ways to achieve this

+
    +
  • If you want to selectively dodge or burn only certain objects you can apply a new instance of the exposure module using a drawn mask to isolate the effect to the required area of the image (see also the mask refinement section for more information). Move the exposure slider to alter the brightness of the masked area.
  • +
  • If you wish to dodge or burn areas with a similar brightness (for example, to brighten the shadows or darken the highlights) you should use the tone equalizer module.
  • +
+

🔗convert to monochrome

+

darktable provides a number of ways to remove the color from your image. The most flexible method is to use the gray tab of the color calibration module. A number of film emulation presets are available in this module to provide you with a starting point.

+

See the developing monochrome images section for details of other techniques.

+

🔗color grading

+

The color balance rgb module is your one-stop-shop for controlling the colors in your image. Adjustments can be isolated to the shadows, highlights and mid-tones, or applied at a global level.

+

🔗other important topics

+

🔗reuse common module settings

+

If you find yourself using the same module parameters repeatedly, you can create presets containing your favorite settings. If you use the same settings on every image, you can also make presets apply automatically to new images. For example, you may find yourself adding the same exposure settings to every image taken by a certain camera – in this case you can create a preset that automatically applies those corrections only to images from that camera.

+

You may also have groups of module settings that you commonly apply only to certain types of image. You can use styles to apply multiple module settings at once to a selection of images.

+

🔗perform adjustments locally

+

Most darktable modules can either be applied to the whole image, or restricted to parts of the image using drawn and parametric masks.

+

🔗control darktable with other input methods

+

You don’t need to use the darktable UI to make adjustments to your images. Most of the functionality in darktable can also be controlled using shortcuts defined with your keyboard/mouse and even with other input devices such as game controllers and MIDI devices. See the shortcuts section for details.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/darkroom/index.html b/en/preferences-settings/darkroom/index.html new file mode 100644 index 0000000000..408ac5f2c4 --- /dev/null +++ b/en/preferences-settings/darkroom/index.html @@ -0,0 +1,3093 @@ + + + + + +darktable user manual - darkroom + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / darkroom + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ darkroom +

+ + + +

Control functionality in the darkroom view and associated modules.

+

🔗general

+
+
scroll down to increase mask parameters
+
By default, scrolling your mouse up increases the value of the relevant shape parameters in drawn masks. Set this preference to reverse the behavior (default off).
+
middle mouse button zooms to 200%
+
When enabled, clicking the middle mouse button on the image canvas causes the zoom level to toggle between fit, 100% and 200%. When disabled, the middle mouse button toggles between fit and 100%. In the latter case, you can use Ctrl+middle-click to access the 200% zoom level (default on).
+
pattern for the image information line
+
Set the information to be displayed in the image information line. You can use any variables in the variables section as well as $(NL) for a new line. You can also include formatting (bold, italic, colors etc).
+
position of the image information line
+
Choose the darkroom panel in which the image information line is displayed. Choose between “top left” “top right” “top center” “bottom” and “hidden” (default “bottom”).
+
border around image in darkroom mode
+
Display the center image in darkroom mode with an outside border of the given number of pixels (default 20).
+
show scrollbars for center view
+
Choose whether to show scrollbars in the center view of the darkroom (default off).
+
reduce resolution of preview image
+
Reduce the resolution of the navigation preview image (choose from “original”, “1/2”, “1/3” or “1/4” size). This may improve the speed of the rendering but take care as it can also hinder accurate color picking and masking (default “original”).
+
show loading screen between images
+
Show gray loading screen when navigating between images in the darkroom. Switch this option off to just show a simple toast message and leave the previous image in place until the next image is loaded. Note that switching this option off can be very useful to quickly compare duplicate images, however, there might be issues with long loading times (leading you to think the next image has already loaded) and you may observe visual artifacts while the next image is loading (default on).
+
+

🔗modules

+
+
display of individual color channels
+
Control how individual color channels are displayed when activated in the parametric masks feature. You can choose between “false color” and “gray scale” (default “false color”).
+
hide built-in presets for processing modules
+
If enabled, only user-defined presets will be shown in the presets menu for processing modules – built-in presets will be hidden (default off).
+
show the guides widget in modules UI
+
Enable this to show the local guides & overlays interface directly within the UI of the modules that support it (default on).
+
expand a single processing module at a time
+
Control how processing modules are expanded in the darkroom. If this option is enabled, expanding a module by clicking collapses any currently expanded module. If you want to expand a module without collapsing the others you can do so with Shift+click. Disabling this option inverts the meaning of click and Shift+click (default on).
+
only collapse modules in current group
+
When choosing to expand a single processing module at a time (using the logic defined in the previous setting), only collapse other modules that appear in the current visible group. Disable this option to ensure that modules in non-visible groups are also collapsed (default on).
+
expand the module when it is activated, and collapse it when disabled
+
Select this option for the darkroom to automatically expand or collapse processing modules when they are enabled or disabled. (default off)
+
scroll processing modules to the top when expanded
+
With this option enabled processing modules are scrolled to the top of the right-hand panel when expanded. (default on)
+
show right-side buttons in processing module headers
+
Choose whether to show the four buttons (mask indicator, multi-instance menu, reset, presets menu) on the right-hand-side of the module header for processing modules. These buttons will always appear when the mouse is over the module. At other times they will be shown or hidden according to this preference selection:
+
    +
  • always: always show all buttons
  • +
+
+
    +
  • active: only show the buttons when the mouse is over the module
  • +
+
+
    +
  • dim: buttons are dimmed when mouse is not over the module
  • +
+
+
    +
  • auto: hide the buttons when the panel is narrow
  • +
+
+
    +
  • fade: fade out all buttons when the panel narrows
  • +
+
+
    +
  • fit: hide all the buttons if the module name doesn’t fit
  • +
+
+
    +
  • smooth: fade out all buttons in one header simultaneously
  • +
+
+
    +
  • glide: gradually hide individual buttons as needed
  • +
+
+
(default always)
+
show mask indicator in module headers
+
If enabled, an icon will be shown in the header of any processing modules that have a mask applied (default on).
+
prompt for name on addition of new instance
+
If enabled, when creating a new instance of a processing module, a prompt will be immediately displayed allowing you to set a name for the new instance (default off).
+
automatically update module name
+
Automatically update the name (label) on processing modules if the current parameters of the module match those of a saved preset. The module name will only be updated if it hasn’t already been manually amended for the current image. It will be set either to the module name from which the preset was made (if the module name was manually adjusted before the preset was created) or to the name of the preset itself (default on).
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/general/index.html b/en/preferences-settings/general/index.html new file mode 100644 index 0000000000..5df478f0ff --- /dev/null +++ b/en/preferences-settings/general/index.html @@ -0,0 +1,3060 @@ + + + + + +darktable user manual - general + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / general + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ general +

+ + + +

Control the overall look and feel of darktable.

+
+
interface language
+
Set the language of the user interface. This includes the option to enable sentence case (en@truecase) for English. The system default is marked with an * (needs a restart)
+
theme
+
Set the theme for the user interface. Aside from any aesthetic considerations, the recommended interface color for color evaluation is middle gray. Visual perception is affected by ambient brightness, and a low user interface brightness causes all kinds of illusions. Using a dark interface to retouch photos can therefore lead to excessive retouching (abuse of contrast and saturation) and to a photo that is too dark when printed. It is therefore highly recommended that you use one of the “grey” themes for retouching work as these are designed so that the user interface approximates middle gray (default “darktable-elegant-grey”).
+
use system font size
+
Select this option to use the font size defined by your system. If unchecked, you may enter a custom font size in the box below (default on).
+
font size in points
+
If the “use system font size” option is switched off, enter a font size (in points) for darktable to use. The font size will be changed immediately.
+
GUI controls and text DPI
+
Adjust the global GUI resolution to rescale controls, buttons, labels, etc. Increase for a magnified GUI, decrease to fit more content in the window. Set to -1 to use the system-defined global resolution. The default is 96 DPI on most systems. (needs a restart)
+
+

🔗CSS theme modifications

+

In addition to selecting a pre-built theme you can also apply additional CSS customizations of your own to tweak the look-and-feel of darktable.

+

Two different methods are provided for this:

+
+
create a custom theme
+
If you wish to make a large number of changes to darktable’s UI you may wish to create your own theme (in a .css file) and place it in $HOME/.config/darktable/themes (or C:\%LOCALAPPDATA%\darktable\themes on Windows). Your new theme will automatically appear in the theme selection list the next time you restart darktable.
+
+

Please note that the structure of darktable’s internal CSS changes frequently and you may need to make significant changes to your own themes when new versions of darktable are released. For this reason (among others) we do not recommend creating complex custom themes unless you are willing to devote a lot of time to ongoing maintenance. If your theme loads any of darktable’s pre-built themes using the @import url directive, note that your CSS theme file may not be portable between installations (@import url uses relative paths and the location of the pre-built themes is system-dependent).

+
+
create theme tweaks
+
A text box is provided at the bottom of the general tab within which you can enter your own CSS tweaks. When using this option, darktable will first load your selected theme (the “base” theme, chosen in the theme drop-down) and then apply your custom CSS on top. This means that you can easily make minor alterations to the look-and-feel, while still keeping mostly up-to-date with core theme changes when a new version of darktable is released. It also means that you can usually change your base theme without affecting your custom CSS tweaks.
+
+

When you have finished entering your CSS, click the “save CSS and apply” button. This will save your CSS to $HOME/.config/darktable/user.css (or C:\%LOCALAPPDATA%\darktable\user.css on Windows) and immediately apply it to the current darktable session.

+
+
+

If you notice any issues after applying your CSS, you can uncheck the “modify selected theme with CSS tweaks below” box to revert. This will immediately restore the base theme but will leave your tweaks in the editor so that you can re-edit them and try again. Simply press “save CSS and apply” again when you are ready to retry. This will automatically re-check the “modify selected theme with CSS tweaks below” checkbox and apply the new CSS.

+
+
+
+

Note: If you have any issues while using custom CSS tweaks please retry with the “modify selected theme with CSS tweaks below” option unchecked to be certain that they were not caused by any of your alterations.

+
+

🔗understanding darktable’s themes

+

All of darktable’s pre-built themes are provided as CSS files in $DARKTABLE/share/darktable/themes/ (where $DARKTABLE is darktable’s installation directory). The darktable.css theme contains the bulk of the code used to control the look-and-feel of darktable. A number of other themes are also provided but most of them use darktable.css as a base (by importing darktable.css using the @import url directive).

+

If you choose to create your own custom theme file you are advised to follow a similar approach – import one of darktable’s existing theme files using @import url (this directive expects relative paths) and then apply your own customizations on top. You do not need to do this when using the CSS text box in the preferences dialog – attempting to use @import url in the CSS tweaks text box will not work correctly.

+

Themes use the same basic CSS principles as in html browsers (with some minor exceptions – see the Gtk documentation for details):

+
    +
  • The majority of the style properties are assigned to broad groups of UI elements, for example, Gtk buttons and text entry fields
  • +
  • Next, related groups of darktable-specific UI elements are given class names allowing them to be styled as a group
  • +
  • Finally, some unique UI elements are assigned a CSS id so that they can be styled independently
  • +
+

You are encouraged to explore the existing themes (darktable.css in particular is very well commented) and to make use of the Gtk Inspector tool to figure out how to select the specific UI element (or class of elements) you wish to modify. Some experimentation will be required.

+

Please note that darktable themes are grayscale by default in order that users not be distracted by strong colors while editing images. You are advised to retain this practice in your own themes and to keep the average shade as close to middle-gray as possible. In addition you are advised to review your custom CSS each time darktable is updated, to ensure that changes to the application have not adversely affected your tweaks.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/import/index.html b/en/preferences-settings/import/index.html new file mode 100644 index 0000000000..c2507ffbd3 --- /dev/null +++ b/en/preferences-settings/import/index.html @@ -0,0 +1,3054 @@ + + + + + +darktable user manual - import + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / import + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ import +

+ + + +

Control default file naming conventions used when importing images.

+

🔗session options

+

The following options define the default naming pattern for use in the “copy & import” or “copy & import from camera” options in the import module, or when taking photos in the tethering view.

+

The naming pattern consists of three parts: a base part defining the parent folder, a session part defining a sub directory (which is specific to the individual import session), and a file name part defining the filename structure for each imported image.

+

Several pre-defined variables can be used in the pattern as placeholders:

+
$(HOME)              the home folder as defined by the system
+$(PICTURES_FOLDER)   the pictures folder as defined by the system (usually “$HOME/Pictures”)
+$(DESKTOP)           the desktop folder as defined by the system (usually “$HOME/Desktop”)
+$(USERNAME)          your user account name on the system
+$(FILE_NAME)         basename of the imported image
+$(FILE_EXTENSION)    extension of the imported image
+$(JOBCODE)           unique identifier of the import job
+$(SEQUENCE)          a sequence number within the import job
+$(MAX_WIDTH)         maximum image width to limit within export session
+$(MAX_HEIGHT)        maximum image height to limit within export session
+$(ID)                unique identification number of the image in darktable's database
+$(YEAR)              year at the date of import
+$(MONTH)             month at the date of import
+$(DAY)               day at the date of import
+$(HOUR)              hour at the time of import
+$(MINUTE)            minute at the time of import
+$(SECOND)            second at the time of import
+$(EXIF_YEAR)         year the photo was taken (from Exif data)
+$(EXIF_MONTH)        month the photo was taken (from Exif data)
+$(EXIF_DAY)          day the photo was taken (from Exif data)
+$(EXIF_HOUR)         hour the photo was taken (from Exif data)
+$(EXIF_MINUTE)       minute the photo was taken (from Exif data)
+$(EXIF_SECOND)       seconds the photo was taken (from Exif data)
+$(EXIF_ISO)          ISO value of the photo (from Exif data)
+
+
base directory naming pattern
+
The base directory part of the naming pattern (default $(PICTURES_FOLDER)/Darktable).
+
sub directory naming pattern
+
The sub directory part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(JOBCODE)).
+
keep original filename
+
Check this box to keep the original filename instead of using the pattern below when importing from a camera or card (default off).
+
file naming pattern
+
The file name part of the naming pattern (default $(YEAR)$(MONTH)$(DAY)_$(SEQUENCE).$(FILE_EXTENSION).
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/index.html b/en/preferences-settings/index.html new file mode 100644 index 0000000000..3d50430efc --- /dev/null +++ b/en/preferences-settings/index.html @@ -0,0 +1,3092 @@ + + + + + +darktable user manual - Preferences & Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/index.xml b/en/preferences-settings/index.xml new file mode 100644 index 0000000000..c0d10ed7b0 --- /dev/null +++ b/en/preferences-settings/index.xml @@ -0,0 +1,95 @@ + + + + Preferences & Settings on darktable user manual + https://darktable-org.github.io/dtdocs/en/preferences-settings/ + Recent content in Preferences & Settings on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/preferences-settings/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/overview/ + darktable comes with a number of user-configurable preferences. These can be adjusted in the preferences dialog, which can be reached by clicking the gear icon on the right of the top panel. Preferences are separated into tabs, each of which is described in more detail in the following sections. When opened from within the lighttable or darkroom views, the appropriate tab will be loaded by default to allow you to modify that view&rsquo;s settings. + + + general + https://darktable-org.github.io/dtdocs/en/preferences-settings/general/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/general/ + Control the overall look and feel of darktable. interface language Set the language of the user interface. This includes the option to enable sentence case (en@truecase) for English. The system default is marked with an * (needs a restart) theme Set the theme for the user interface. Aside from any aesthetic considerations, the recommended interface color for color evaluation is middle gray. Visual perception is affected by ambient brightness, and a low user interface brightness causes all kinds of illusions. + + + import + https://darktable-org.github.io/dtdocs/en/preferences-settings/import/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/import/ + Control default file naming conventions used when importing images. 🔗session options The following options define the default naming pattern for use in the &ldquo;copy &amp; import&rdquo; or &ldquo;copy &amp; import from camera&rdquo; options in the import module, or when taking photos in the tethering view. The naming pattern consists of three parts: a base part defining the parent folder, a session part defining a sub directory (which is specific to the individual import session), and a file name part defining the filename structure for each imported image. + + + lighttable + https://darktable-org.github.io/dtdocs/en/preferences-settings/lighttable/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/lighttable/ + Control functionality in the lighttable view and modules. 🔗general hide built-in presets for utility modules If enabled, only user-defined presets will be shown in presets menu for utility modules &ndash; built-in presets will be hidden (default off). use single-click in the collections module Enable &ldquo;single click&rdquo; mode in the collections module, which allows ranges to be selected (default off). expand a single utility module at a time Controls how utility modules are expanded. + + + darkroom + https://darktable-org.github.io/dtdocs/en/preferences-settings/darkroom/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/darkroom/ + Control functionality in the darkroom view and associated modules. 🔗general scroll down to increase mask parameters By default, scrolling your mouse up increases the value of the relevant shape parameters in drawn masks. Set this preference to reverse the behavior (default off). middle mouse button zooms to 200% When enabled, clicking the middle mouse button on the image canvas causes the zoom level to toggle between fit, 100% and 200%. When disabled, the middle mouse button toggles between fit and 100%. + + + processing + https://darktable-org.github.io/dtdocs/en/preferences-settings/processing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/processing/ + Control how images are processed. 🔗image processing always use LittleCMS 2 to apply output color profile If this option is activated, darktable will use the LittleCMS 2 system library to apply the output color profile instead of its own internal routines. This is significantly slower than the default but might give more accurate results in some cases. If the given ICC is LUT-based or contains both a LUT and a matrix, darktable will use LittleCMS 2 to render the colors regardless of this parameter&rsquo;s value (default off). + + + security + https://darktable-org.github.io/dtdocs/en/preferences-settings/security/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/security/ + Control whether warning messages are shown before undertaking certain activities. 🔗general ask before removing images from the library Always ask before removing image information from darktable&rsquo;s library database, where the xmp file is retained (default on). ask before deleting images from disk Always ask before deleting an image file (default on). ask before discarding history stack Always ask before discarding the history stack of an image (default on). try to use trash when deleting images Instead of physically deleting images from disk, attempt to put them into the system&rsquo;s trash bin (default on). + + + storage + https://darktable-org.github.io/dtdocs/en/preferences-settings/storage/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/storage/ + The following options are related to darktable&rsquo;s library database and XMP sidecar files. 🔗database create database snapshot Specifies how often darktable should create database snapshots. Options are &ldquo;never&rdquo;, &ldquo;once a month&rdquo;, &ldquo;once a week&rdquo;, &ldquo;once a day&rdquo; and &ldquo;on close&rdquo; (default &ldquo;once a week&rdquo;) how many snapshots to keep Number of snapshots to keep after creating a new snapshot, not counting database backups taken when moving between darktable versions. Enter &ldquo;-1&rdquo; to store an unlimited number of snapshots. + + + miscellaneous + https://darktable-org.github.io/dtdocs/en/preferences-settings/miscellaneous/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/miscellaneous/ + 🔗interface load default shortcuts at startup When launching the application, darktable loads default shortcuts first, and then loads user-defined shortcuts on top. This allows default shortcuts to be overridden with a new action but prevents them from being deleted (since the deleted shortcut will be automatically reloaded on the next restart). Deactivate this preference to stop loading default shortcuts on startup &ndash; only load the user-defined ones (including any defaults that you have not subsequently deleted or overridden). + + + shortcuts + https://darktable-org.github.io/dtdocs/en/preferences-settings/shortcuts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/shortcuts/ + You can perform almost any action in darktable with a keyboard/mouse shortcut. You can also use various other input devices, including MIDI devices and game controllers &ndash; see the midi device support section for details. These are referred to as external devices or just devices in this guide. 🔗defining shortcuts A shortcut is a combination of key or button presses and/or mouse or device movements that performs an action in darktable. + + + presets + https://darktable-org.github.io/dtdocs/en/preferences-settings/presets/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/presets/ + This menu provides an overview of the presets that are defined for darktable&rsquo;s modules, and allows you to modify some of their properties. Pre-defined presets (those that are included by default within darktable) are shown with a lock symbol. Their properties cannot be changed. User-defined presets can be imported from exported .dtpreset files using the &ldquo;import&rdquo; button at the bottom of the screen. You can export all user-defined presets to a single directory using the &ldquo;export&rdquo; button. + + + lua options + https://darktable-org.github.io/dtdocs/en/preferences-settings/lua-options/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/preferences-settings/lua-options/ + lua scripts installer don&rsquo;t show again Check this box to hide the lua scripts installer in the lighttable if no lua scripts are installed. + + + diff --git a/en/preferences-settings/lighttable/index.html b/en/preferences-settings/lighttable/index.html new file mode 100644 index 0000000000..145b58f2df --- /dev/null +++ b/en/preferences-settings/lighttable/index.html @@ -0,0 +1,3057 @@ + + + + + +darktable user manual - lighttable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / lighttable + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ lighttable +

+ + + +

Control functionality in the lighttable view and modules.

+

🔗general

+
+
hide built-in presets for utility modules
+
If enabled, only user-defined presets will be shown in presets menu for utility modules – built-in presets will be hidden (default off).
+
use single-click in the collections module
+
Enable “single click” mode in the collections module, which allows ranges to be selected (default off).
+
expand a single utility module at a time
+
Controls how utility modules are expanded. If this option is enabled, expanding a module by clicking collapses any other currently expanded panel. If you want to expand a panel without collapsing the others you can do so with Shift+click. Disabling this option inverts the meaning of click and Shift+click (default off).
+
scroll utility modules to the top when expanded
+
With this option enabled the side panels will scroll a utility module to the top of the panel when it is expanded. (default off)
+
rating an image one star twice will not zero out the rating
+
Normally clicking a one star rating twice will set a zero star rating to that image. Check this option to disable this functionality (default off).
+
show scrollbars for center view
+
Choose whether to show scrollbars in the center view of the lighttable (default on).
+
show image time with milliseconds
+
Choose whether to include milliseconds when displaying time values (default off). If set, milliseconds are shown in the image information module and can also be used in the geotagging module.
+
+

🔗thumbnails

+
+
use raw file instead of embedded JPEG from size
+
When generating thumbnails for images that have not yet been processed in the darkroom, if the thumbnail size is greater than this value, generate it by processing the raw image data. If the thumbnail is below this size, use the JPEG preview image embedded in the raw file. Once an image has been processed in the darkroom, thumbnails will always be generated from raw data (you can revert back to the JPEG preview by discarding history). To render thumbnails with the best quality choose “always”.
+
high quality processing from size
+
If the thumbnail size is greater than this value and is being generated from raw data, it will be processed using the full quality rendering path, which is better but slower (default 720p). To render thumbnails with the best quality, choose “always”.
+
enable disk backend for thumbnail cache
+
If activated, darktable stores all thumbnails on disk as a secondary cache, and thereby keeps thumbnails accessible if they are dropped from the primary cache. This needs more disk space but speeds up the lighttable view as it avoids the reprocessing of thumbnails (default on).
+
enable disk backend for full preview cache
+
If enabled, darktable writes full preview images to disk (.cache/darktable/) when evicted from the memory cache. Note that this can take a lot of storage (several gigabytes for 20k images) and darktable will never delete cached images. It’s safe to delete these manually if you want. Enabling this option will greatly improve lighttable performance when zooming an image in full preview mode (default off).
+
generate thumbnails in background
+
Choose whether to automatically generate thumbnails in the background when the user is in the lighttable view and is inactive (no keyboard/mouse activity). Thumbnails will be generated up to the selected size (default never).
+
+

Note: You can set the period of inactivity required before thumbnail generation will start by altering the backthumbs_inactivity setting in $HOME/.config/darktable/darktablerc (default 5 seconds).

+
+
reset cached thumbnails
+
Force thumbnails to be regenerated by resetting the database. This may be needed if some thumbnails have been manually removed or have become corrupted (default off).
+
delimiters for size categories
+
Size categories are used to allow different thumbnail overlays to be shown depending on the thumbnail size. A pipe delimited set of values defines at what image sizes the category changes. The default value of “120|400” means that there will be 3 categories of thumbnail: 0-120px, 120-400px and >400px.
+
pattern for the thumbnail extended overlay text
+
If you have chosen to show extended overlay text over thumbnail images, this setting allows you to define what information is displayed. This pattern can use any of the variables defined in the variables section. You can also include formatting (bold, italic, colors etc).
+
pattern for the thumbnail tooltip (empty to disable)
+
Defines what information is displayed in the tooltip when the mouse hovers over image thumbnails. This pattern can also use the same variables and formatting as the extended overlay text.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/lua-options/index.html b/en/preferences-settings/lua-options/index.html new file mode 100644 index 0000000000..4af779402c --- /dev/null +++ b/en/preferences-settings/lua-options/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - lua options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / lua options + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ lua options +

+ + + +
+
lua scripts installer don’t show again
+
Check this box to hide the lua scripts installer in the lighttable if no lua scripts are installed.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/miscellaneous/index.html b/en/preferences-settings/miscellaneous/index.html new file mode 100644 index 0000000000..258b664ecd --- /dev/null +++ b/en/preferences-settings/miscellaneous/index.html @@ -0,0 +1,3066 @@ + + + + + +darktable user manual - miscellaneous + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / miscellaneous + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ miscellaneous +

+ + + +

🔗interface

+
+
load default shortcuts at startup
+
When launching the application, darktable loads default shortcuts first, and then loads user-defined shortcuts on top. This allows default shortcuts to be overridden with a new action but prevents them from being deleted (since the deleted shortcut will be automatically reloaded on the next restart). Deactivate this preference to stop loading default shortcuts on startup – only load the user-defined ones (including any defaults that you have not subsequently deleted or overridden). This makes deletion easier but also means that you will not benefit from new shortcuts added in future versions without first re-enabling this preference (default on).
+
scale slider step with min/max
+
When activated, the default step-size, when altering sliders, will depend on the current min/max values for that slider (default on).
+
sort built-in presets first
+
Choose how the presets menu is sorted. If this option is enabled, built-in presets are shown first. If the option is disabled, user presets are shown first (default on).
+
mouse wheel scrolls modules side panel by default
+
When enabled, the mouse wheel scrolls side panels by default and Ctrl+Alt+wheel scrolls data entry fields. When disabled, this behavior is reversed (default off).
+
always show panels’ scrollbars
+
Defines whether the panel scrollbars should be always visible or activated only depending on the panel content (default on). (needs a restart)
+
duration of the ui transitions in ms
+
Defines how long modules and other ui elements will take to transition between states (expand/collapse). Set to 0 to disable animation (default 250ms).
+
position of the scopes module
+
Choose whether to show the scopes module in the left or right panel (default right). (needs a restart)
+
method to use for getting the display profile
+
This option allows the user to force darktable to use a specific method to obtain the current display profile for color management. In the default setting “all”, darktable will choose to query the X display server’s xatom or the colord system service. You can set this option to “xatom” or “colord” to enforce a specific method if the two methods give different results. You can run the darktable-cmstest binary to examine your color management subsystem.
+
order or exclude midi devices
+
Semicolon-separated list of device-name fragments. If matched, load the midi device at the id given by the location in the list. If preceded by “-”, prevent the matched device from loading. You can also add encoding and number of knobs. For example “BeatStep:63:16”. Please see midi device support for more information.
+
+

🔗tags

+
+
omit hierarchy in simple tag lists
+
When exporting images any hierarchical tags are also added as a simple list of non-hierarchical tags to make them visible to some other programs. When this option is checked darktable will only include the last part of the hierarchy and ignore the rest. So foo|bar|baz will only add baz.
+
+

🔗shortcuts with multiple instances

+

It is possible to create multiple instances of many processing modules. In this scenario it is not always obvious which instance should be controlled by keyboard shortcut operations. The following options control rules that are applied (in order) to decide which module instance keyboard shortcuts should be applied to.

+

These rules are also used when clicking and dragging on the scopes module to change exposure.

+
+
prefer focused instance
+
If an instance has focus, apply the shortcut to that instance and ignore any other rules. Note that this option does not impact blending shortcuts, which are always applied to the focused instance (default on).
+
prefer expanded instances
+
If instances of the module are expanded, ignore collapsed instances (default off).
+
prefer enabled instances
+
After applying the above rule, if remaining instances of the module are active, ignore inactive instances (default off).
+
prefer unmasked instances
+
After applying the above rules, if remaining instances of the module are unmasked, ignore masked instances (default off).
+
selection order
+
After applying the above rules, apply the shortcut to the first or last instance remaining (default “last instance”).
+
+

🔗map / geolocalization view

+
+
pretty print the image location
+
Show a more readable representation of the geo-location in the image information module (default on).
+
+

🔗slideshow view

+
+
waiting time before each picture in slideshow
+
The number of seconds before displaying the next image (default 5) in the slideshow view.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/overview/index.html b/en/preferences-settings/overview/index.html new file mode 100644 index 0000000000..d2283dc551 --- /dev/null +++ b/en/preferences-settings/overview/index.html @@ -0,0 +1,3020 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / overview + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ overview +

+ + + +

darktable comes with a number of user-configurable preferences. These can be adjusted in the preferences dialog, which can be reached by clicking the gear icon on the right of the top panel. Preferences are separated into tabs, each of which is described in more detail in the following sections.

+

When opened from within the lighttable or darkroom views, the appropriate tab will be loaded by default to allow you to modify that view’s settings.

+

Any altered settings (i.e. those that differ from their default state) are highlighted with a bullet beside them. If you change a setting that needs a restart to take effect, a message will appear as a reminder after you exit the preferences dialog.

+

Double click on a setting’s label to reset to its default value.

+

The preferences dialog can be closed by clicking on the close button in your window manager or pressing the Escape key.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/presets/index.html b/en/preferences-settings/presets/index.html new file mode 100644 index 0000000000..9d7d37c0d5 --- /dev/null +++ b/en/preferences-settings/presets/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - presets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / presets + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ presets +

+ + + +

This menu provides an overview of the presets that are defined for darktable’s modules, and allows you to modify some of their properties.

+

Pre-defined presets (those that are included by default within darktable) are shown with a lock symbol. Their properties cannot be changed.

+

User-defined presets can be imported from exported .dtpreset files using the “import” button at the bottom of the screen. You can export all user-defined presets to a single directory using the “export” button.

+

Delete a user-defined preset by selecting it and pressing the Delete key.

+

Edit a user-defined preset’s properties by selecting it and pressing Enter or double-clicking. This will open a dialog that allows the preset to be edited, exported to an external .dtpreset file or deleted.

+

See the creating and editing presets section for more information about the other properties that can be edited in this dialog.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/processing/index.html b/en/preferences-settings/processing/index.html new file mode 100644 index 0000000000..31870ce83d --- /dev/null +++ b/en/preferences-settings/processing/index.html @@ -0,0 +1,3131 @@ + + + + + +darktable user manual - processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / processing + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ processing +

+ + + +

Control how images are processed.

+

🔗image processing

+
+
always use LittleCMS 2 to apply output color profile
+
If this option is activated, darktable will use the LittleCMS 2 system library to apply the output color profile instead of its own internal routines. This is significantly slower than the default but might give more accurate results in some cases.
+
+

If the given ICC is LUT-based or contains both a LUT and a matrix, darktable will use LittleCMS 2 to render the colors regardless of this parameter’s value (default off).

+
+
pixel interpolator (warp)
+
The pixel interpolator used for rotation, lens correction, liquify, crop and final scaling.
+
+

Whenever we scale or distort an image we have to choose a pixel interpolation algorithm (see wikipedia for details). For warping modules, darktable offers bilinear, bicubic or lanczos2. In general, bicubic is a safe option for most cases and is the default value.

+
+
pixel interpolator (scaling)
+
The pixel interpolator used for scaling. The same options are provided as for the warp modules, but with the addition of lanczos3.
+
+

lanczos3 can cause pixel overshoots leading to artefacts but sometimes gives a more crisp visual appearance. This option is therefore only provided for transforming (scaling) algorithms and is the default value.

+
+
LUT 3D root folder
+
Define the root folder (and sub-folders) containing LUT files used by the LUT 3D module
+
auto-apply pixel workflow defaults
+
Choose which modules and module order are applied to new RAW image edits by default:
+
+
    +
  • +

    scene-referred (filmic) (default) assumes that most processing will be performed in a linear RGB color space. Selecting this option automatically enables the filmic rgb, exposure and color calibration modules for new edits and sets the module order to v3.0 RAW.

    +

    The exposure module includes an automatic exposure adjustment of +0.7 EV (to provide a midtone brightening comparable to the +0.5 to +1.2 EV typically added by in-camera tone curves), and automatically enables the “compensate camera exposure” option for the filmic workflow. Both of these settings are intended to provide a reasonable starting-point for RAWs produced by a broad range of SLR and mirrorless cameras, but they can be overridden with an automatically-applied preset if the defaults produce consistently dark images for your camera.

    +

    In the scene-referred workflows, the color calibration module acts in conjunction with the white balance module as the modern way to handle white balance and chromatic adaptation with improved color science. Note that when using the color calibration module, the white balance module needs to be active and set to “Camera Reference” mode (this will be done automatically and warnings will appear if the two modules have inconsistent settings). When using both modules as prescribed, it is still possible to auto-detect white-balance from a specific area of the image by selecting the CCT picker tool in the CAT tab of color calibration.

    +
  • +
  • +

    scene-referred (sigmoid) follows the same assumptions and overall flow as scene-referred (filmic), with the exception that it auto-enables the sigmoid module for tone mapping in place of filmic rgb.

    +
  • +
  • +

    display-referred (legacy) is the legacy mode (used by default in darktable 2.6 and earlier) and assumes that most processing will be performed in the Lab color space. Selecting this option automatically enables the base curve module for tone mapping and sets the module order to legacy. This workflow uses only the white balance module for chromatic adaptation.

    +
  • +
  • +

    none sets the module order to v3.0 RAW and uses the white balance module for chromatic adaptation. No other exposure or tone mapping modules are enabled by default.

    +
  • +
+
+
auto-apply per camera basecurve presets
+
Use a per-camera base curve by default (if available) instead of the generic manufacturer one. This should only be used in conjunction with the display-referred workflow defined above (default off).
+
detect monochrome previews
+
Enable this option to analyse images during import and tag them with the darkroom|mode|monochrome tag if they are found to be monochrome. The analysis is based on the preview image embedded within the imported file. This makes for a more convenient workflow when working with monochrome images, but it slows down the import, so this setting is disabled by default.
+
show warning messages
+
Enable this option to display warning messages in processing modules where non-standard and possibly harmful settings have been used in the pipeline. Such messages can sometimes be false-positives (because of intentional non-standard settings) and can be disregarded if you know what you are doing. Disable to hide these warnings. (default on).
+
+

🔗CPU / memory

+
+
darktable resources
+
Choose how much of your system and graphics card (GPU) memory will be used by darktable. Four options are provided by default:
+
+
    +
  • small takes roughly 20% of your system memory and 40% of your GPU memory. This might be acceptable on very large systems, especially if you’re not exporting images. Mostly, though, this can only be recommended if you are using a lot of other demanding applications at the same time as darktable.
  • +
+
+
+
    +
  • default takes roughly 60% of your system memory and 70% of your GPU memory. This mode is recommended if you’re not exporting a lot of images, have at least 16Gb of system memory and 4Gb of GPU memory, and also are running a lot of other application at the same time as darktable.
  • +
+
+
+
    +
  • large takes roughly 75% of your system memory and 90% of your GPU memory. This is the best option if you are only using darktable on your system and/or are exporting a lot of images.
  • +
+
+
+
    +
  • unrestricted is not generally recommended. In this mode darktable may attempt to use more memory than your system has available. This might be possible if your system uses swapping when all of its system memory is taken, but it could lead to system instability. Use this mode with care, only when exporting very large images that darktable cannot otherwise handle.
  • +
+
+
+

See the memory & performance tuning section for more information.

+
+
prefer performance over quality
+
Enable this option to render thumbnails and previews at a lower quality. This increases the rendering speed by a factor of 4, and is useful when working on slower computers (default off). This also improves the performance of slideshow image rendering.
+
+

🔗OpenCL

+
+
activate OpenCL support
+
Your GPU can be used by darktable to significantly speed up processing. The OpenCL interface requires suitable hardware and matching OpenCL drivers on your system. If one of those is not found this option is grayed out. OpenCL support can be switched on and off at any time and takes immediate effect (default on).
+
OpenCL scheduling profile
+
Defines how preview and full pixelpipe tasks are scheduled on OpenCL enabled systems:
+
    +
  • default: the GPU processes the center view pixelpipe; the CPU processes the preview pipe.
  • +
+
+
    +
  • very fast GPU: both pixelpipes are processed sequentially on the GPU.
  • +
+
+
    +
  • multiple GPUs: both pixelpipes are processed in parallel on different GPUs – see the multiple devices section for more information.
  • +
+
+
use all device memory
+
Enable this option to allow darktable to use all OpenCL memory on all devices except for a safety margin (headroom). The default headroom is 600MB and can also be specified on a per-device basis.
+
OpenCL drivers
+
In most cases darktable is able to find the correct OpenCL driver but this depends on how your operating system handles installation. Generally speaking, darktable must:
+
+
    +
  • not use unreliable drivers
  • +
+
+
+
    +
  • only have one active driver per hardware device. Problems are typically found where the vendor-provided driver is installed as well as another driver (like rusticl) or (on Windows) where the OpenCLon12 driver has been installed via the OpenCL Compatibility Pack.
  • +
+
+
+

Toggle-switches are offered for most available drivers, though on more exotic hardware like ARM boards you will have to enable the “other platforms” fallback option. Select the drivers you want to use from the list. If you suspect that a driver is malfunctioning you can explicitly disable it here.

+
+
+

See the memory & performance tuning section for more information.

+
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/security/index.html b/en/preferences-settings/security/index.html new file mode 100644 index 0000000000..c415714ca3 --- /dev/null +++ b/en/preferences-settings/security/index.html @@ -0,0 +1,3048 @@ + + + + + +darktable user manual - security + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / security + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ security +

+ + + +

Control whether warning messages are shown before undertaking certain activities.

+

🔗general

+
+
ask before removing images from the library
+
Always ask before removing image information from darktable’s library database, where the xmp file is retained (default on).
+
ask before deleting images from disk
+
Always ask before deleting an image file (default on).
+
ask before discarding history stack
+
Always ask before discarding the history stack of an image (default on).
+
try to use trash when deleting images
+
Instead of physically deleting images from disk, attempt to put them into the system’s trash bin (default on).
+
ask before moving images from film roll folder
+
Always ask before moving an image file (default on).
+
ask before copying images to new film roll folder
+
Always ask before copying an image file to a new location (default on).
+
ask before removing empty folders
+
Always ask before removing any empty folder. This can happen after moving or deleting images (default off).
+
ask before deleting a tag
+
Always ask before deleting a tag from an image (default on).
+
ask before deleting a style
+
Always ask before deleting a style (default on).
+
ask before deleting a preset
+
Always ask before deleting a preset (default on).
+
ask before exporting in overwrite mode
+
Always ask before exporting images in overwrite mode.
+
+

🔗other

+
+
password storage backend to use
+
The backend to use for password storage. Options: “auto” (default), “none”, “libsecret”, “kwallet”, “apple_keychain” (on macOS), “windows_credentials” (on Windows).
+
executable for playing audio files
+
Define an external program which is used in the lighttable view to play audio files that some cameras record to keep notes for images (default “aplay”).
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/shortcuts/index.html b/en/preferences-settings/shortcuts/index.html new file mode 100644 index 0000000000..f78a0af6b4 --- /dev/null +++ b/en/preferences-settings/shortcuts/index.html @@ -0,0 +1,3199 @@ + + + + + +darktable user manual - shortcuts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / shortcuts + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ shortcuts +

+ + + +

You can perform almost any action in darktable with a keyboard/mouse shortcut. You can also use various other input devices, including MIDI devices and game controllers – see the midi device support section for details. These are referred to as external devices or just devices in this guide.

+

🔗defining shortcuts

+

A shortcut is a combination of key or button presses and/or mouse or device movements that performs an action in darktable.

+

The recommended way to assign shortcuts to visual elements is the visual shortcut mapping mode.

+

A single action may have multiple shortcuts but a single shortcut can only be linked to one action in a given darktable view – you can’t chain actions together except by applying a preset or style. You can, however, set up a single shortcut that does one thing in the lighttable view, say, and another in the darkroom view.

+

🔗initiating a shortcut

+

A shortcut must be initiated by either

+
    +
  • pressing a key on the keyboard; or
  • +
  • pressing a button or moving a knob/joystick on an external device
  • +
+

You cannot initiate a shortcut by moving your mouse, or by pressing the left, right or middle mouse buttons, as these actions are used to interact with darktable’s UI.

+

🔗simple shortcuts

+

A shortcut that only includes button and/or key presses (and not mouse/device movements) is referred to as a simple shortcut.

+

A simple shortcut must be initiated as above, but can include:

+
    +
  • One or more modifier keys (Shift, Ctrl, Alt), held down while executing the remainder of the shortcut
  • +
  • Up to three key presses, the last one of which may be a long-press (defined as a key-press longer than your system’s double-click duration)
  • +
  • Similarly, up to three device-button presses or mouse-button clicks, the last of which may be long
  • +
+

Various combinations of keyboard, mouse, and device buttons can be used to create simple shortcuts.

+

🔗creating additional modifiers

+

The only valid modifiers are the Shift, Ctrl and Alt keys on the keyboard. You can define additional keys (or device buttons) as modifiers by assigning keys/buttons to the “global/modifier” action. However, these will merely function as extra Ctrl, Alt or Shift keys – you cannot create “new” modifiers.

+

🔗extending simple shortcuts with movement

+

For certain actions you can choose to extend a simple shortcut using mouse/device movement. For example you might hold Ctrl+X while scrolling with your mouse to change the value of a slider. The following can be used to extend a simple shortcut:

+
    +
  • Movement of the mouse scroll wheel
  • +
  • Horizontal, vertical or diagonal movement of the mouse cursor
  • +
  • Movement of a knob/joystick on an external device
  • +
+

To extend a simple shortcut, you must hold the final key/button of the simple shortcut while performing the extending mouse/device movement.

+

For external devices you do not need to start with a simple shortcut – you can directly assign a control knob or joystick to an action – though this will significantly reduce the flexibility of such devices.

+

Long button and key presses cannot be extended, as the length of the click/press is timed using the release of the final button/key – such shortcuts must be terminated with the raising of the final button/key.

+
+

Note: You may need to switch off the “disable touchpad while typing” setting if you want to use extended shortcuts with a laptop touchpad.

+
+

🔗actions

+

Shortcuts are used to initiate actions within darktable.

+

An action is usually (but not always) an operation that you might undertake using darktable’s point-and-click user interface. For example:

+
    +
  • Increase, decrease or reset sliders
  • +
  • Scroll through dropdown lists
  • +
  • Enable, expand or focus modules
  • +
  • Click buttons
  • +
  • Switch between views
  • +
+

Such point-and-click type actions are normally defined as the application of an effect to an element of a widget, where these terms are defined as follows:

+
+
widget
+
Each visible part of the user interface is known as a widget. For example the darktable application window is a widget, containing side panel widgets, each of which contains module widgets, each of which contains button, slider and dropdown list widgets etc… When assigning a shortcut to an action, you must first decide which widget it is to be applied to.
+
element
+
An element is the part of a UI widget that is affected by your shortcut. For example, for a slider that has a picker, you can make a shortcut activate the picker button element or change the value element of the slider. For a row of tabs (the row is a single widget) you can select which tab element to activate or use your mouse scroll wheel to scroll through the tabs.
+
effect
+
A shortcut can sometimes have multiple possible effects on a given element. For example, a button can be activated as if it was pressed with a plain mouse-click or as if it was pressed with Ctrl+click. A slider’s value can be edited, increased/decreased or reset.
+
+

🔗assigning shortcuts to actions

+

There are two primary methods of assigning a shortcut to an action.

+

🔗visual shortcut mapping

+

Click on the + + + + + + + + +visual mapping button + + icon in the top panel of any darktable view to enter visual shortcut mapping mode. If you hold Ctrl while clicking the button, no confirmation will appear when overwriting an existing shortcut mapping.

+

The mouse cursor will change as you hover over UI widgets, to indicate whether or not a mapping can be created:

+
    +
  • A normal mouse cursor (pointer) appears when you hover over a module header, to indicate that you can click to expand the module,
  • +
  • An image of a keyboard with a “+” sign indicates that, in addition to assigning a shortcut, you can also add the widget to the quick access panel in the darkroom (by Ctrl+clicking on it),
  • +
  • An image of a keyboard with a “–” sign indicates that the widget is already in the quick access panel (Ctrl+click to remove it),
  • +
  • An image of a keyboard without a “+” or “–” indicates that a shortcut can be defined for the widget under the cursor but it cannot be added to or removed from the quick access panel,
  • +
  • A circle with a line through it (🚫) indicates that there is no mappable widget under the cursor.
  • +
+

Press a key combination while hovering over a mappable widget to assign a shortcut to that widget – a default action will be assigned to that shortcut based on the type of widget and whether you have keyed a simple or extended shortcut. See below for details of some of the default assigned actions.

+

Left-click on a mappable widget to open the shortcut mapping screen for that widget (see below). Left-click anywhere else on the screen to open the shortcut mapping screen, expanded (where possible) based on the part of the screen you have clicked on. This screen can be used to alter the action assigned to a shortcut and to configure shortcuts for non-visual actions. Entering the shortcut mapping screen exits visual shortcut mapping mode.

+

You can assign as many shortcuts as you like in a single mapping session and then exit mapping mode when you are finished by clicking the + + + + + + + + +visual mapping button + + icon again or right-clicking anywhere on the screen.

+

You can delete a user-defined shortcut mapping by defining it a second time against the same widget. If you attempt to reallocate an existing shortcut to a new action, you will be notified of the conflict and asked whether you wish to replace the existing shortcut.

+

Finally, if you scroll with your mouse wheel while in visual mapping mode (without pressing any other buttons/keys) when hovering over a slider, this will change the default speed for that slider – scroll up to increase and down to decrease. When you leave mapping mode, normal mouse scrolls over that slider will change its value with the adjusted speed.

+

🔗shortcut mapping screen

+

The most flexible way to create shortcuts is by using the shortcut mapping screen, which can be accessed from the global preferences dialog or by left-clicking in visual mapping mode. This screen allows access to all available actions, including some that are not directly linked to a UI widget.

+

The top panel of the shortcut mapping screen shows a list of available UI widgets/actions and the bottom panel shows the shortcuts currently assigned to them. You can search the top and bottom panels using the text entry boxes at the bottom of the screen (use the up/down arrow keys to navigate between matches).

+

Double-click an item in the top panel to create a new shortcut for that item, and then enter your desired shortcut (right-click to cancel). Once you have done this, a new entry will appear in the bottom panel showing the shortcut you have created. You can then manually alter the element, effect, speed or instance of the assigned action against that shortcut in the bottom panel. To delete a user-defined shortcut, select it in the bottom panel and press the Delete key.

+

Selecting an existing shortcut in the bottom panel will highlight (in bold) the matching action and its parents in the top panel. You can use this to navigate the top panel and find related actions.

+

The following additional options are provided in the shortcut mapping screen:

+
+
export…
+
Export the current shortcut mappings for one or all of your devices (keyboard/mouse, midi, game controller) to an external file. The dialog will show you how many shortcuts exist for each device.
+
import…
+
Import shortcut mappings from an external file for one or all of your devices. When loading a device, you can chose to assign it a different number. This can for example be used to exchange midi layouts. Before loading, you can chose to wipe the specific device first. When loading all from an empty file, this will effectively delete all your shortcuts.
+
restore…
+
Restore your shortcut mappings to (a) The mappings shipped with darktable by default, (b) The start of your current session, or (c) The point at which the shortcut mapping screen was last opened. When restoring, you can choose to leave any additional shortcuts that were added after the relevant checkpoint as they are, so that only changed shortcuts are restored to their previous meaning. Or you can choose to first clear all shortcuts and just load the restore point.
+
+

🔗deleting default shortcuts

+

When you delete a shortcut that has been created by darktable by default, that shortcut is moved to a separate “disabled defaults” category, in order to prevent it from being reloaded the next time darktable is launched. To reinstate a deleted shortcut, simply delete the shortcut from that category. You will be prompted if reinstating this shortcut overwrites another one that has been created in the meantime.

+

Alternatively, you may disable preferences > miscellaneous > interface > load default shortcuts at startup to prevent default shortcuts from being loaded on startup. While this option is disabled, darktable will only load user-defined shortcuts and any defaults that you have not subsequently deleted or overridden.

+

🔗common actions

+

The following is a list of some of the actions to which you can assign shortcuts, organized by widget type. This is not an exhaustive list and you are encouraged to browse the shortcut mapping screen for a complete list of available actions. If you assign a shortcut to a widget, it will be given a default action, depending on the type of widget and on whether you have assigned a simple or extended shortcut.

+

Note that it is possible to assign a number of actions that have no effect. For example, all sliders include a button element, regardless of whether such a button is actually present alongside a given slider.

+

🔗global

+

Actions in the “global” section of the shortcut mapping screen can be executed from any darktable view. Most of these actions do not have specific elements as they are used to perform one-off operations.

+

🔗views

+

Actions in the “views” section can only be executed from the specified darktable view. As with global actions, most do not have specific elements as they are used to perform one-off operations.

+

🔗buttons

+

A button is a clickable icon in the darktable interface. The default action, when assigning a simple shortcut to a button, is to activate that button as if clicked with the left mouse button. You can modify this action to activate the button as if clicked while holding a modifier key.

+

🔗toggles

+

A toggle is a button that has a persistent on/off state. It therefore has additional effects to allow you to toggle it or explicitly set its state. As with a normal button the default action, when assigning a simple shortcut to a toggle, is to activate the toggle as if clicked with the left mouse button (which toggles the button on/off).

+

🔗utility modules

+

All utility modules have the following elements:

+
+
show
+
Acts as a toggle that expands and collapses the module.
+
reset
+
Acts as a button that resets all module parameters when activated. The ctrl-activate action can be used to re-apply any automatic presets for that module.
+
presets
+
Allows you to select actions from the presets menu (e.g. edit, update, previous, next). The default action, when assigning a simple shortcut to a preset element, is to display a list of the available presets for selection. Extended shortcuts are not currently available for preset elements.
+
+

The default action, when assigning a simple shortcut to a utility module, is to toggle the show element (expand/collapse the module).

+

In addition, shortcuts are available for all of the controls on each module as well as any stored presets (see below).

+

🔗processing modules

+

Processing modules have the same elements and defaults as utility modules with the following additional elements:

+
+
enable
+
Acts as a toggle that switches the module on and off.
+
focus
+
Acts as a toggle that focuses or defocuses the module. This is useful for modules such as crop or tone equalizer, whose on-screen controls are only activated when those modules have focus. For crop, changes are saved only when the module loses focus.
+
instance
+
Allows you to select actions from the multiple-instance menu (e.g. move up/down, create new instance). The default action, when assigning a simple shortcut to the instance element, is to display a list of the available options for selection; An extended shortcut will move the preferred module instance (see below) up and down the pixelpipe.
+
+

If an action affects a processing module that can have multiple instances, you can choose which instance to adjust with a given shortcut. By default, all actions will affect the “preferred” instance, as defined using the settings in preferences > miscellaneous > shortcuts with multiple instances.

+

Additional options are available in the shortcuts mapping screen to adjust the blend parameters (the <blending> section) and module controls (the <focused> section) for the currently-focused module. The latter section allows you to assign shortcuts to the first, second, third (etc.) button, drop-down, slider and tab on the module. The shortcuts will affect different module controls depending on which module currently has focus (as the available list of controls changes).

+

You can also assign scroll shortcuts to the ‘preset’ menu, which allows you to use your mouse scroll wheel to scroll through the module’s presets.

+ +

A dropdown is a multi-selection box and has the following elements available:

+
+
selection
+
Allows values to be selected from the dropdown list in various ways. The default action, when assigning a simple shortcut to a dropdown, is to display a popup edit box with a list of the available values for selection; An extended shortcut (including a mouse movement) will scroll through the available values.
+
button
+
A standard button element that allows the button to the right of the dropdown (if present) to be activated. For example, the aspect dropdown in the crop module has a button that allows the crop controls to be changed from portrait to landscape and vice versa.
+
+

🔗sliders

+

A slider allows you to continuously alter an integer or decimal value, and has the following elements available:

+
+
value
+
Allows the current value of the slider to be altered. The default action, when assigning a simple shortcut to a slider, is to display a popup edit box so you can enter a value; An extended shortcut (including a mouse movement) will change the value up and down. Value elements are also used for modifying some on-screen graphs. When modifying the value element with a shortcut you may not exceed the bounds set in the visual slider.
+
force
+
This is the same as the value element described above, but it allows you to exceed the bounds set in the visual slider.
+
zoom
+
Allows you to change the upper and lower bounds of the visual slider without altering the current value.
+
button
+
A standard button element that allows the button to the right of the slider (if present) to be activated. For example, a slider may include a picker to visually set its value based on selected elements of the image.
+
+

You can alter the value of a slider more quickly or slowly than normal by defining the speed of the action in the shortcut mapping screen. By default a value (or force) effect is given a speed of 1.0, which means that it is changed at the default rate defined by the given slider. You can alter the slider more quickly by increasing the speed (a speed of 10 makes the action 10x faster) or more slowly by decreasing it (a speed of 0.1 makes the action 10x slower).

+

🔗fallbacks

+

Where a widget can have multiple different actions applied to it, it can be tedious to set up individual shortcuts for each one of those actions. To make this process simpler, if you create a simple shortcut a number of effects can be made available by default as extensions to that shortcut. These are known as fallbacks.

+

While fallbacks are a powerful way to quickly set up multiple actions using predefined and consistent shortcuts, they will assign a lot of actions automatically (which might not be what you want), and can be hard to understand. Fallbacks are therefore disabled by default and you will need to click on the “enable fallbacks” check box in the shortcuts setup window to enable them.

+

To take a brief example, you could create a simple shortcut (e.g. Ctrl+R) against a processing module. This will automatically set up the following fallback effects using the defined shortcut, extended with mouse-clicks. In each case (except the first) you should hold the initial shortcut while clicking with your mouse. The final mouse-click will apply the action defined below:

+
    +
  • Ctrl+R (no mouse-click) to show/hide the module (the default fallback)
  • +
  • Ctrl+R+left-click to enable/disable the module
  • +
  • Ctrl+R+left-double-click to reset the module
  • +
  • Ctrl+R+right-click to show the module’s preset menu
  • +
  • Ctrl+R+right-double-click to show the module’s multiple instance menu
  • +
+

Similar fallbacks are defined for many common UI elements and all can be manually overridden.

+

Some fallback actions are defined using modifier keys (usually Ctrl+ and Shift+). In this case you must define an initial shortcut without such a modifier in order to be able to use these fallbacks. For example, if you assign Ctrl+R to an action, you cannot use a Ctrl+ fallback. Some default fallbacks of this type are provided for the value element and for horizontal/vertical movements in the (zoomed) central area – in this case, Shift+ increases the speed to 10.0 and Ctrl+ decreases the speed to 0.1.

+

To see a list of all of the default fallbacks, click the “enable fallbacks” checkbox in the shortcut mapping screen and select the “fallbacks” category in the top panel. To see the fallbacks for a given widget (e.g. a slider) just select that widget in the top panel. In both cases an additional item (also named “fallbacks”) will then appear in the bottom panel containing full details of the available fallbacks.

+

Fallbacks are only applied if no other shortcut using that combination has been explicitly created. In the above example, if you were to explicitly assign Ctrl+R+left-click to another action, the “enable/disable module” fallback would be ignored.

+

As with any other shortcut, fallback settings are fully customizable.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/preferences-settings/shortcuts/visual-mapping-button.png b/en/preferences-settings/shortcuts/visual-mapping-button.png new file mode 100644 index 0000000000..b352286a8e Binary files /dev/null and b/en/preferences-settings/shortcuts/visual-mapping-button.png differ diff --git a/en/preferences-settings/storage/index.html b/en/preferences-settings/storage/index.html new file mode 100644 index 0000000000..f748acaae2 --- /dev/null +++ b/en/preferences-settings/storage/index.html @@ -0,0 +1,3050 @@ + + + + + +darktable user manual - storage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Preferences & Settings / storage + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ storage +

+ + + +

The following options are related to darktable’s library database and XMP sidecar files.

+

🔗database

+
+
create database snapshot
+
Specifies how often darktable should create database snapshots. Options are “never”, “once a month”, “once a week”, “once a day” and “on close” (default “once a week”)
+
how many snapshots to keep
+
Number of snapshots to keep after creating a new snapshot, not counting database backups taken when moving between darktable versions. Enter “-1” to store an unlimited number of snapshots. (default 10)
+
+

🔗XMP sidecar files

+
+
create XMP files
+
XMP sidecar files provide a redundant method of saving the changes that you have made to an image, in addition to the changes saved to darktable’s database. This option allows you to choose when files will first be written. Once written, they will subsequently be updated each time you edit or add a tag to the image. Choose from:
+
+
    +
  • never: Don’t write sidecar files. This can be useful if you are running multiple version of darktable for development/testing purposes but is not normally recommended,
  • +
+
+
    +
  • on import: A sidecar file will be written as soon as you add an image to darktable’s library,
  • +
+
+
    +
  • after edit: A sidecar will not be written until the first time you edit or add a tag to an image.
  • +
+
+
+

It’s strongly recommended that you choose either “on import” or “after edit”. Sidecar files provide a useful fail-safe to prevent data loss if your database becomes corrupted. Backing up your raw file plus the accompanying sidecar file will allow you to fully restore your work at a later date by re-importing your edit history back into darktable (default “on import”).

+
+
store XMP tags in compressed format
+
Entries in XMP tags can get rather large and may exceed the available space to store the history stack in some output files on export. This option allows binary XMP tags to be compressed in order to save space. Available options are “never”, “always”, and “only large entries” (default).
+
auto-save interval
+
This preference sets the interval (in seconds) after which the processing history for an image will be automatically saved (while in the darkroom view). Set to zero to disable auto-saving. Note that this option might be ignored for slow drives (default 10s).
+
look for updated XMP files on startup
+
Scan all XMP files on startup and check if any have been updated in the meantime by some other software. If updated XMP files are found, a menu is opened for the user to choose which of the XMP files to reload (replacing darktable’s database entries by the XMP file contents) and which of the XMP to overwrite from darktable’s database. Activating this option also causes darktable to check for text sidecar files that have been added after import time (default off).
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/print/index.html b/en/print/index.html new file mode 100644 index 0000000000..b2baf79323 --- /dev/null +++ b/en/print/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - Print + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Print + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

Print

+ +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/print/index.xml b/en/print/index.xml new file mode 100644 index 0000000000..756d458f05 --- /dev/null +++ b/en/print/index.xml @@ -0,0 +1,25 @@ + + + + Print on darktable user manual + https://darktable-org.github.io/dtdocs/en/print/ + Recent content in Print on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/print/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/print/overview/ + This view allows you to print your images. Because printing is not easy, there are many technical aspects to be taken into account. After selecting an image in the lighttable view you can enter the print settings module to adjust printer settings and initiate printing. This module supports the printer&rsquo;s ICC profile, which is somewhat mandatory if you want to obtain a high quality print close to the image displayed on the screen. + + + print view layout + https://darktable-org.github.io/dtdocs/en/print/print-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/print/print-view-layout/ + The central area displays the image layout on the paper (the white area). Some gray borders may be displayed around the image to represent the printable area (the page minus the borders) not filled by the image. The filmstrip below the image allows you to select more images. 🔗overlays When the mouse is over the bounding box of an image, its width and height are shown along its top and left, respectively. + + + diff --git a/en/print/overview/index.html b/en/print/overview/index.html new file mode 100644 index 0000000000..3090396922 --- /dev/null +++ b/en/print/overview/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Print / overview + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ overview +

+ + + +

This view allows you to print your images. Because printing is not easy, there are many technical aspects to be taken into account.

+

After selecting an image in the lighttable view you can enter the print settings module to adjust printer settings and initiate printing.

+

This module supports the printer’s ICC profile, which is somewhat mandatory if you want to obtain a high quality print close to the image displayed on the screen.

+

It is important to note that ICC profiles provided by the paper and/or printer manufacturers cannot be used on GNU/Linux as they are printer-driver dependent. The darktable print module uses CUPS and there are no ready-to-use ICC profiles available for this driver.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/print/print-view-layout/index.html b/en/print/print-view-layout/index.html new file mode 100644 index 0000000000..d05cf6d175 --- /dev/null +++ b/en/print/print-view-layout/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - print view layout + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Print / print view layout + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ print view layout +

+ + + +

The central area displays the image layout on the paper (the white area). Some gray borders may be displayed around the image to represent the printable area (the page minus the borders) not filled by the image.

+

The filmstrip below the image allows you to select more images.

+

🔗overlays

+

When the mouse is over the bounding box of an image, its width and height are shown along its top and left, respectively. Margins between the bounding box and the page edge are notated next to the dotted lines extending out from each side of the bounding box. All measurements are shown in the units as chosen in the print settings module.

+

Images are inset along one dimension of their bounding box when they do not match the aspect ratio of the box. The overlaid margin measurements should therefore only be used to understand the layout bounds, not the actual printed size of the image.

+

🔗left panel

+
+
collections
+
Filter the list of images displayed in the lighttable.
+
image information
+
Display image information
+
+

🔗right panel

+
+
print settings
+
Adjust print settings and initiate printing.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/sitemap.xml b/en/sitemap.xml new file mode 100644 index 0000000000..827031e3af --- /dev/null +++ b/en/sitemap.xml @@ -0,0 +1,732 @@ + + + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/astrophoto-denoise/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/base-curve/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/bloom/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/blurs/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/censorize/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/chromatic-aberrations/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-balance-rgb/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-calibration/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-contrast/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-correction/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-equalizer/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-look-up-table/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-mapping/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-reconstruction/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/color-zones/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/colorize/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/composite/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-equalizer/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/demosaic/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/denoise-profiled/ + + https://darktable-org.github.io/dtdocs/en/guides-tutorials/monochrome/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/diffuse/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/dither-or-posterize/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/enlarge-canvas/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/exposure/ + + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/filemanager/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/filmic-rgb/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/framing/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/graduated-density/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/grain/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/haze-removal/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highlight-reconstruction/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/highpass/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/hot-pixels/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/input-color-profile/ + + https://darktable-org.github.io/dtdocs/en/overview/workflow/introduction/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lens-correction/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/liquify/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/local-contrast/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowlight-vision/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lowpass/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/lut-3d/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-header/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/monochrome/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/negadoctor/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/output-color-profile/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/overview/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/overview/ + + https://darktable-org.github.io/dtdocs/en/darkroom/organization/overview/ + + https://darktable-org.github.io/dtdocs/en/darkroom/overview/ + + https://darktable-org.github.io/dtdocs/en/lighttable/overview/ + + https://darktable-org.github.io/dtdocs/en/lua/overview/ + + https://darktable-org.github.io/dtdocs/en/map/overview/ + + https://darktable-org.github.io/dtdocs/en/module-reference/overview/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/overview/ + + https://darktable-org.github.io/dtdocs/en/print/overview/ + + https://darktable-org.github.io/dtdocs/en/slideshow/overview/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/overview/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/overview/ + + https://darktable-org.github.io/dtdocs/en/tethering/overview/ + + https://darktable-org.github.io/dtdocs/en/overview/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-black-white-point/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-chromatic-aberrations/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/raw-denoise/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/retouch/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-curve/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-levels/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rgb-primaries/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-perspective/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/rotate-pixels/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/scale-pixels/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/shadows-and-highlights/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sharpen/ + + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/sigmoid/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/soften/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/split-toning/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/surface-blur/ + + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-anatomy-of-a-module/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/background/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-curve/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-equalizer/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/unbreak-input-profile/ + + https://darktable-org.github.io/dtdocs/en/overview/user-interface/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/velvia/ + + https://darktable-org.github.io/dtdocs/en/overview/user-interface/views/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vignetting/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/watermark/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/white-balance/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/basic-adjustments/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/channel-mixer/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/contrast-brightness-saturation/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/crop-rotate/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/defringe/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/fill-light/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/global-tonemap/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/invert/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/levels/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/spot-removal/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/tone-mapping/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/vibrance/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/zone-system/ + + https://darktable-org.github.io/dtdocs/en/lua/basic-principles/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/blend-modes/ + + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/collections/ + + https://darktable-org.github.io/dtdocs/en/darkroom/darkroom-view-layout/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cli/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/display-profile/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/general/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/how-opencl-works/ + + https://darktable-org.github.io/dtdocs/en/overview/workflow/import-review/ + + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/sidecar-import/ + + https://darktable-org.github.io/dtdocs/en/lighttable/ + + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-view-layout/ + + https://darktable-org.github.io/dtdocs/en/map/map-view-layout/ + + https://darktable-org.github.io/dtdocs/en/darkroom/organization/module-groups/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/multiple-instances/ + + https://darktable-org.github.io/dtdocs/en/print/print-view-layout/ + + https://darktable-org.github.io/dtdocs/en/overview/user-interface/screen-layout/ + + https://darktable-org.github.io/dtdocs/en/overview/supported-file-formats/ + + https://darktable-org.github.io/dtdocs/en/tethering/tethering-view-layout/ + + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/the-pixelpipe-and-module-order/ + + https://darktable-org.github.io/dtdocs/en/slideshow/usage/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/usage/ + + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/zoomable-lighttable/ + + https://darktable-org.github.io/dtdocs/en/lua/a-simple-example/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/activate-opencl/ + + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/culling/ + + https://darktable-org.github.io/dtdocs/en/darkroom/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-generate-cache/ + + https://darktable-org.github.io/dtdocs/en/tethering/examples/ + + https://darktable-org.github.io/dtdocs/en/overview/user-interface/filmstrip/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/import/ + + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/local-copies/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/parametric/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/presets/ + + https://darktable-org.github.io/dtdocs/en/overview/workflow/process/ + + https://darktable-org.github.io/dtdocs/en/darkroom/organization/quick-access-panel/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-method/ + + https://darktable-org.github.io/dtdocs/en/overview/sidecar-files/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/source-image/ + + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/history-stack/ + + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/ + + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/thumbnails/ + + https://darktable-org.github.io/dtdocs/en/lighttable/undo-redo/ + + https://darktable-org.github.io/dtdocs/en/special-topics/mem-performance/ + + https://darktable-org.github.io/dtdocs/en/overview/workflow/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/drawn-and-parametric/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-chart/ + + https://darktable-org.github.io/dtdocs/en/overview/workflow/export/ + + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/full-preview/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/lighttable/ + + https://darktable-org.github.io/dtdocs/en/lighttable/lighttable-modes/ + + https://darktable-org.github.io/dtdocs/en/darkroom/organization/manage-module-layouts/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/module-controls/ + + https://darktable-org.github.io/dtdocs/en/lua/printing-labeled-images/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/reference-values/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-intent/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/setting-up/ + + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/star-color/ + + https://darktable-org.github.io/dtdocs/en/tethering/ + + https://darktable-org.github.io/dtdocs/en/overview/user-interface/top-panel/ + + https://darktable-org.github.io/dtdocs/en/tethering/troubleshooting/ + + https://darktable-org.github.io/dtdocs/en/darkroom/pixelpipe/undo-redo/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/ + + https://darktable-org.github.io/dtdocs/en/lua/simple-shortcut/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/curves/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/darkroom/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cltest/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-spaces/ + + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/ + + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/grouping/ + + https://darktable-org.github.io/dtdocs/en/overview/user-interface/keyboard-shortcuts/ + + https://darktable-org.github.io/dtdocs/en/map/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/refinement-controls/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/problems-solutions/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/process/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/wavelets/ + + https://darktable-org.github.io/dtdocs/en/darkroom/processing-modules/deprecated/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cmstest/ + + https://darktable-org.github.io/dtdocs/en/lua/exporting-images/ + + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/making-input-images/ + + https://darktable-org.github.io/dtdocs/en/lighttable/digital-asset-management/metadata-tagging/ + + https://darktable-org.github.io/dtdocs/en/darkroom/organization/ + + https://darktable-org.github.io/dtdocs/en/darkroom/masking-and-blending/masks/raster/ + + https://darktable-org.github.io/dtdocs/en/slideshow/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/unbounded-colors/ + + https://darktable-org.github.io/dtdocs/en/special-topics/variables/ + + https://darktable-org.github.io/dtdocs/en/lua/building-ui-elements/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-artifacts/ + + https://darktable-org.github.io/dtdocs/en/print/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/processing/ + + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/purge_non_existing_images_sh/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-dimensions/ + + https://darktable-org.github.io/dtdocs/en/special-topics/color-pipeline/ + + https://darktable-org.github.io/dtdocs/en/module-reference/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/scheduling-profile/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/security/ + + https://darktable-org.github.io/dtdocs/en/lua/sharing-scripts/ + + https://darktable-org.github.io/dtdocs/en/special-topics/midi-device-support/ + + https://darktable-org.github.io/dtdocs/en/lua/calling-from-dbus/ + + https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/multiple-devices/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/ + + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/still-doesnt-work/ + + https://darktable-org.github.io/dtdocs/en/lua/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/storage/ + + https://darktable-org.github.io/dtdocs/en/special-topics/translating/ + + https://darktable-org.github.io/dtdocs/en/lua/darktable-from-lua/ + + https://darktable-org.github.io/dtdocs/en/guides-tutorials/batch-editing/ + + https://darktable-org.github.io/dtdocs/en/guides-tutorials/ + + https://darktable-org.github.io/dtdocs/en/lua/api/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/miscellaneous/ + + https://darktable-org.github.io/dtdocs/en/guides-tutorials/other-resources/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/shortcuts/ + + https://darktable-org.github.io/dtdocs/en/special-topics/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/presets/ + + https://darktable-org.github.io/dtdocs/en/preferences-settings/lua-options/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/selected-image/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/camera-settings/ + + https://darktable-org.github.io/dtdocs/en/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/clipping/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collection-filters/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/collections/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/color-assessment/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/ + + https://darktable-org.github.io/dtdocs/en/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/duplicate-manager/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/export/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/filmstrip/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/find-location/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/focus-peaking/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/gamut/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/geotagging/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/global-color-picker/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/guides-overlays/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/high-quality-processing/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/history-stack/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/history-stack/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/image-information/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/image-info-line/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/import/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/live-view/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/locations/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/lua-scripts-installer/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/map/map-settings/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/mask-manager/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/metadata-editor/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/module-order/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/navigation/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/print/print-settings/ + + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/raw-overexposed/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/recent-collections/ + + https://darktable-org.github.io/dtdocs/en/tags/rotate-orientation-basic-module-group/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/scopes/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/select/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/session/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/snapshots/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/darkroom/soft-proof/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/styles/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/shared/tagging/ + + https://darktable-org.github.io/dtdocs/en/tags/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/tethering/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/lighttable/timeline/ + + https://darktable-org.github.io/dtdocs/en/module-reference/utility-modules/ + + diff --git a/en/slideshow/index.html b/en/slideshow/index.html new file mode 100644 index 0000000000..596a9b88eb --- /dev/null +++ b/en/slideshow/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - Slideshow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Slideshow + +
+ +
+ +
+ + + +
+
+ + +
+ +

Slideshow

+ +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/slideshow/index.xml b/en/slideshow/index.xml new file mode 100644 index 0000000000..67aa99ac1b --- /dev/null +++ b/en/slideshow/index.xml @@ -0,0 +1,25 @@ + + + + Slideshow on darktable user manual + https://darktable-org.github.io/dtdocs/en/slideshow/ + Recent content in Slideshow on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/slideshow/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/slideshow/overview/ + The slideshow view allows you to watch a slideshow of your current collection with the associated filtering rules and sort order applied. To learn more about how to define the collection and filtering rules, see the section on collections. Select the sort criteria and sort order of the images in the top panel. The next section provides more details on the usage of the slideshow view. + + + usage + https://darktable-org.github.io/dtdocs/en/slideshow/usage/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/slideshow/usage/ + The slideshow view is still in an early stage of development with only a basic set of features. If you don&rsquo;t need the auto-advance mode, you could even use the sticky preview feature instead. spacebar start and stop auto-advance mode which automatically switches to the next images every five seconds by default. ESC leave slideshow mode and return to lighttable view. + or increase delay between each image. up arrow - or decrease delay between each image. + + + diff --git a/en/slideshow/overview/index.html b/en/slideshow/overview/index.html new file mode 100644 index 0000000000..5fbc609252 --- /dev/null +++ b/en/slideshow/overview/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Slideshow / overview + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ overview +

+ + + +

The slideshow view allows you to watch a slideshow of your current collection with the associated filtering rules and sort order applied.

+

To learn more about how to define the collection and filtering rules, see the section on collections. Select the sort criteria and sort order of the images in the top panel.

+

The next section provides more details on the usage of the slideshow view.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/slideshow/usage/index.html b/en/slideshow/usage/index.html new file mode 100644 index 0000000000..bd1ebdd0e4 --- /dev/null +++ b/en/slideshow/usage/index.html @@ -0,0 +1,3040 @@ + + + + + +darktable user manual - usage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Slideshow / usage + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ usage +

+ + + +

The slideshow view is still in an early stage of development with only a basic set of features.

+

If you don’t need the auto-advance mode, you could even use the sticky preview feature instead.

+

+spacebar             start and stop auto-advance mode which automatically switches
+                     to the next images every five seconds by default.
+
+ESC                  leave slideshow mode and return to lighttable view.
+
+
++ or                 increase delay between each image.
+up arrow 
+
+- or                 decrease delay between each image.
+down arrow
+
+left-click or        
+right arrow or       switch to the next image of the collection.
+right shift-key
+
+right-click or       
+left arrow or        switch to the previous image of the collection.
+left shift-key
+

+

Hint: To take full advantage of your screen size, put darktable into fullscreen mode by pressing F11 and hide the border-controls by pressing the B key.

+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/color-artifacts/index.html b/en/special-topics/color-management/color-artifacts/index.html new file mode 100644 index 0000000000..2845fbd815 --- /dev/null +++ b/en/special-topics/color-management/color-artifacts/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - possible color artifacts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / possible color artifacts + +
+ + + + +
+ +

+ possible color artifacts +

+ + + +

There are some infrequent situations that still can lead to problematic results unless the user takes some action. Some modules in Lab color space, like levels and monochrome, rely on the fact that the L channels carries all lightness information, with the a and b channels purely representing chroma and hue. Unbounded colors with negative L values are especially problematic to these modules and can lead to black pixel artifacts.

+

It has been found that highly saturated blue light sources in the image frame are likely candidates for pixels with negative L values. If you are engaged in stage photography you should pay close attention to such lights appearing in images.

+

In order to mitigate this issue the input color profile module has a gamut clipping option. This option is switched off by default but can be activated if artifacts are observed. Depending on the settings, colors will be confined to one of the available RGB gamuts. In effect black pixel artifacts are prevented at the costs of losing some color dynamics.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/color-dimensions/index.html b/en/special-topics/color-management/color-dimensions/index.html new file mode 100644 index 0000000000..dbf04eca03 --- /dev/null +++ b/en/special-topics/color-management/color-dimensions/index.html @@ -0,0 +1,3188 @@ + + + + + +darktable user manual - darktable's color dimensions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / darktable's color dimensions + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ darktable’s color dimensions +

+ + + +

This section defines the perceptual properties of color, both conceptually and quantitatively, in order to characterize and quantify the creative and corrective adjustments made to color in darktable.

+

🔗definitions

+

Color properties like “saturation”, “brightness” or “lightness” have passed into common usage but are largely misused and often used to mean different things. In color science, each of these terms has a precise meaning.

+

There are two frameworks within which color properties may be analyzed and described:

+
    +
  • A scene-linear, physiological, framework, that mostly focuses on the response of the retina cone cells, using color spaces such as CIE XYZ 1931 or CIE LMS 2006,
  • +
  • A perceptual, psychological, framework that stacks the brain’s corrections on top of the retina signal, using color spaces such as CIE Lab 1976, CIE Luv 1976, CIE CAM 2016 and JzAzBz (2017).
  • +
+

These two frameworks provide us with metrics and dimensions to analyze color and allow us to change some of its properties while preserving others.

+

The following dimensions of color are used by darktable:

+
+
hue
+
An attribute of visual perception in which an area appears to be similar to one of the colors red, yellow, green, or blue, or to a combination of adjacent pairs of these colors considered in a closed ring. 1 Hue is a shared property between the perceptual and scene-linear frameworks.
+
luminance
+
The density of luminous intensity with respect to a projected area in a specified direction at a specified point on a real or imaginary surface. 2 Luminance is a property of scene-referred frameworks, and is expressed by the Y channel of the CIE XYZ 1931 space.
+
brightness
+
An attribute of visual perception according to which an area appears to emit, transmit or reflect more or less light. 3
+
lightness
+
The brightness of an area judged relative to the brightness of a similarly illuminated area that appears to be white or highly transmitting. 4 Lightness is the perceptual, non-linear homologue of luminance (roughly equal to the cubic root of luminance Y). Lightness is expressed by the L channel in CIE Lab and Luv 1976 and the J channel in JzAzBz.
+
chroma
+
The colorfulness of an area judged as a proportion of the brightness of a similarly illuminated area that appears gray, white or highly transmitting. 5 Warning: chroma is not short for chrominance, which is the color part of a video signal (the Cb and Cr channels in YCbCr, for example).
+
brilliance
+
The brightness of an area judged relative to the brightness of its surroundings. 6
+
saturation
+
The colorfulness of an area judged in proportion to its brightness. 7
+
purity
+
The distance of the pixel chromaticity from the white point in the xy chromaticity plane. Zero purity means the light is achromatic. High purity, at the other extreme, means the light is laser-like, composed of a single wavelength.
+
+

Colors can be described in many different color spaces, but no matter the color space, each color needs at least 3 components: some metric of luminance or brightness, and 2 metrics of chromaticity (hue and chroma, or opponent color coordinates).

+

🔗illustrations

+

While the previous definitions are useful to give a meaning to the words, they don’t tell us what we should be looking at. The following charts show luminance, lightness, chroma, brilliance/brightness and saturation varying from a “0” base color and how the resulting colors degrade:

+

+ + + + + + + + +swatches + +

+

(Lightness + Chroma) or (Brilliance/Brightness + Saturation) are two different ways to encode the same reality. They are orthogonal spaces that can be converted from one to another by a simple rotation of the base. This means that chroma evolves at constant lightness, saturation evolves at constant brilliance/brightness, and vice versa:

+

+ + + + + + + + +lightness and chroma to brilliance and saturation + +

+

Lines of equal chroma are vertical (following the patches grid), meaning that chroma has the same direction for all colors in the gamut (see below). However, lines of equal saturation are oblique (drawn dashed on the graph) and all go from black through each color patch, meaning that their directions are particular to each color.

+

Increasing the chroma will therefore move all colors uniformly away from the central gray axis horizontally, while increasing the saturation will close or open the angle of the oblique dashed lines like a flower.

+

Similarly, increasing the lightness will move all colors uniformly up from the horizontal axis, while increasing brilliance/brightness will move them along the lines of equal saturation.

+

On both of the above charts, lightness, chroma, saturation and brilliance are drawn in the JzAzBz color space, which is a perceptual color space suited for an HDR signal, and is used in parametric masks and the color balance RGB module. Luminance is drawn in the CIE XYZ 1931 color space, and represents the effect of an exposure compensation. It shows the same behaviour as brilliance, except that the step size is not perceptually scaled.

+
+

Note: In this section, brilliance and brightness are both used to describe the same dimension. In all rigor, brightness is an absolute metric, whereas brilliance is the brightness of some surface relative to the brightness of its surroundings (that is, how much a surface “pops” out of its surroundings and looks fluorescent). But in image editing, increasing the brightness of some surface will indeed increase its brilliance too, so the term brilliance is preferred in darktable’s user interface for clarity and in reference to its visual effect.

+
+

🔗color dimensions and gamut

+

The gamut is the volume of colors that a certain color space can encompass and encode. It is important to note that, once converted to perceptual spaces, the gamut of any RGB space is not uniform along hues.

+

The following examples show the gamut volume of the sRGB space on hue slices containing the primary red, green and blue lights of the sRGB space, over a lightness-chroma plane with a uniform scale:

+

+ + + + + + + + +sRGB-red + + + + + + + + + + + +sRGB-green + + + + + + + + + + + +sRGB-blue + +

+

This shows that increasing the chroma (displacement over the horizontal axis) of some quantity can be safe for some hues at some lightness, but can push other hue-lightness coordinates way out of gamut. For example, we have much more margin in green or magenta than in cyan.

+

Many gamut issues at export are actually user-induced and the result of harsh chroma enlarging. For that reason, using brightness-saturation color models may be safer.

+

🔗color dimensions and complementary colors

+

Cyan, magenta, yellow (CMY) are complementary colors of red, green, blue (RGB). However, the complementary CMY spaces computed from RGB spaces are not perceptually complementary. To show this, we create a CMY space from sRGB, where cyan has sRGB coordinates (0, 1, 1), magenta (1, 0, 1) and yellow (1, 1, 0), and display it in a lightness-chroma space:

+

+ + + + + + + + +sRGB-cyan + + + + + + + + + + + +sRGB-magenta + + + + + + + + + + + +sRGB-yellow + +

+

By comparing with the hue slices of the primary colors in the previous section, it is easy to see not only that the gamuts don’t have the same shapes, but that the colors do not match.

+

This is one more reason to avoid using HSL/HSV spaces (derived from RGB spaces) to perform color editing: since these RGB spaces are not perceptually uniform in the first place, the resulting HSV/HSL spaces are not uniform either. While RGB spaces have some merit based on their connection to physical light, any process involving hue should go directly to perceptual spaces.

+

🔗color dimensions and settings

+

Many applications, including darktable, call any settings that affect chroma “saturation” (for example, in color balance, “contrast/brightness/saturation”). This is a symptom of software trying to be accessible to non-professionals by using a common language. This is misleading, since saturation does exist and is quite different from chroma. In addition, many video specifications improperly call chroma “saturation”. Whenever darktable reuses such specifications, it uses the incorrect term from the specification rather than the proper color dimension term.

+
+
+
    +
  1. +

    CIE definition of hue: https://cie.co.at/eilvterm/17-22-067 ↩︎

    +
  2. +
  3. +

    CIE definition of luminance: https://cie.co.at/eilvterm/17-21-050 ↩︎

    +
  4. +
  5. +

    CIE definition of lightness: https://cie.co.at/eilvterm/17-22-059 ↩︎

    +
  6. +
  7. +

    CIE definition of brightness: https://cie.co.at/eilvterm/17-22-063 ↩︎

    +
  8. +
  9. +

    CIE definition of chroma: https://cie.co.at/eilvterm/17-22-074 ↩︎

    +
  10. +
  11. +

    Article about brilliance (paywall): https://doi.org/10.1002/col.20128 ↩︎

    +
  12. +
  13. +

    CIE definition of saturation: https://cie.co.at/eilvterm/17-22-073 ↩︎

    +
  14. +
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/color-dimensions/lightness-chroma-to-brilliance-saturation.png b/en/special-topics/color-management/color-dimensions/lightness-chroma-to-brilliance-saturation.png new file mode 100644 index 0000000000..62a2422a9e Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/lightness-chroma-to-brilliance-saturation.png differ diff --git a/en/special-topics/color-management/color-dimensions/sRGB-blue.png b/en/special-topics/color-management/color-dimensions/sRGB-blue.png new file mode 100644 index 0000000000..3d5f3d46e2 Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/sRGB-blue.png differ diff --git a/en/special-topics/color-management/color-dimensions/sRGB-cyan.png b/en/special-topics/color-management/color-dimensions/sRGB-cyan.png new file mode 100644 index 0000000000..957cd04f6b Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/sRGB-cyan.png differ diff --git a/en/special-topics/color-management/color-dimensions/sRGB-green.png b/en/special-topics/color-management/color-dimensions/sRGB-green.png new file mode 100644 index 0000000000..e07e96e7cb Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/sRGB-green.png differ diff --git a/en/special-topics/color-management/color-dimensions/sRGB-magenta.png b/en/special-topics/color-management/color-dimensions/sRGB-magenta.png new file mode 100644 index 0000000000..4d6b9e9ea0 Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/sRGB-magenta.png differ diff --git a/en/special-topics/color-management/color-dimensions/sRGB-red.png b/en/special-topics/color-management/color-dimensions/sRGB-red.png new file mode 100644 index 0000000000..6290eeb983 Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/sRGB-red.png differ diff --git a/en/special-topics/color-management/color-dimensions/sRGB-yellow.png b/en/special-topics/color-management/color-dimensions/sRGB-yellow.png new file mode 100644 index 0000000000..c3f5f72eec Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/sRGB-yellow.png differ diff --git a/en/special-topics/color-management/color-dimensions/swatches.png b/en/special-topics/color-management/color-dimensions/swatches.png new file mode 100644 index 0000000000..d7a2e6158c Binary files /dev/null and b/en/special-topics/color-management/color-dimensions/swatches.png differ diff --git a/en/special-topics/color-management/color-spaces/index.html b/en/special-topics/color-management/color-spaces/index.html new file mode 100644 index 0000000000..eb24665140 --- /dev/null +++ b/en/special-topics/color-management/color-spaces/index.html @@ -0,0 +1,3061 @@ + + + + + +darktable user manual - darktable's color spaces + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / darktable's color spaces + +
+ +
+ + +
+ + +
+ +

+ darktable’s color spaces +

+ + + +

Input images are either RGB files (like JPEGs or TIFFs) or camera RAWs. Both store visual information as a combination of primary colors (e.g. red, green and blue) which together describe a light emission to be recreated by a display.

+

The following image illustrates this concept.

+

+ + + + + + + + +Spectral decomposition of a light emission into 3 RGB intensities + +

+

The left-hand-side of the image depicts a colored light that we need to represent digitally. We can use three ideal color filters to decompose this light into three colored primary lights at different intensities. In order to recreate the original colored light from our ideal decomposition (as illustrated in the center of the image) we simply need to recombine those three primary lights by addition.

+

It should be possible to reproduce the original colored light by taking a set of white lights at the correct intensities and projecting those lights through appropriately colored filters. This experiment can be performed at home using gels and dimmable white bulbs. This is roughly what old color CRT displays did and is how video projectors still work.

+

In photography, the initial decomposition step is performed by the color filter array that sits on top of your camera’s sensor. This decomposition is not ideal, so it isn’t possible to precisely recreate the original emission with simple addition – some intermediate scaling is required to adjust the three intensities.

+

On screens, the LED bulbs are dimmed proportionally to each intensity, and the emissions of the three lights are physically added to reconstruct the original emission. Digital images store the intensities of these primary lights as a set of three numbers for each pixel, depicted on the right-hand side of the above image as shades of gray.

+

While a set of display intensities can be easily combined to recreate an original light on a screen (for example, if we created a synthetic image in-computer) the set of captured intensities from a sensor needs some scaling in order for the on-screen light addition to reasonably reproduce the original light emission. This means that every set of intensities, expressed as an RGB set, must be linked to a set of filters (or primary LED colors) that define a color space – any RGB set only makes sense with reference to a color space.

+

Not only do we need to temper the captured intensities to make them summable again, but if we are to recompose the original light on a display that does not have the same colored filters or primaries as the space in which our RGB set belongs, these intensities need to be rescaled to take into account the differing filters on the display. The mechanism for this scaling is described in color profiles, usually stored within .icc files.

+
+

Note: Color is not a physical property of light – it exists only in the human brain, as a product of the decomposition of a light emission by the cone cells in the retina, again very similar in principle to the above filtering example. An “RGB” value should be understood as “light emissions encoded on 3 channels connected to 3 primaries”, but the primaries themselves may look different from what humans would call “red”, “green” or “blue”.

+
+

The filters described here are overlapping band-pass filters. Since they overlap, summing them back together would not preserve the energy of the original spectrum so (long story short) we need to dial them down with regard to the retina cone response

+

Most of darktable’s actual image processing takes place in a large RGB “working profile” space, with some (mostly older) modules internally working in the CIELab 1976 color space (often just called “Lab”). The final output of the image processing pipeline is once again in an RGB space shaped for either the monitor display or the output file.

+

This process implies that the pixelpipe has two fixed color conversion steps: input color profile and output color profile. In addition there is the demosaic step for raw images, where the colors of each pixel are reconstructed by interpolation.

+

Each module has a position in the pixelpipe that tells you which color space the module lives in:

+
    +
  • +

    up to demosaic +: The raw image information does not yet constitute an “image” but merely “data” about the light captured by the camera. Each pixel carries a single intensity for one primary color, and camera primaries are very different from primaries used in models of human vision. Bear in mind that some of the modules in this part of the pipe can also act on non-raw input images in RGB format (with full information on all three color channels).

    +
  • +
  • +

    between demosaic and input color profile +: Image is in RGB format within the color space of the specific camera or input file.

    +
  • +
  • +

    between input color profile and output color profile +: Image is in the color space defined by the selected working profile (linear Rec. 2020 RGB by default). As darktable processes images in 4x32-bit floating point buffers, we can handle large working color spaces without risking banding or tonal breaks.

    +
  • +
  • +

    after output color profile +: Image is in RGB format as defined by the selected display or output ICC profile.

    +
  • +
+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/color-spaces/spectral-decomposition.png b/en/special-topics/color-management/color-spaces/spectral-decomposition.png new file mode 100644 index 0000000000..1791dafd1c Binary files /dev/null and b/en/special-topics/color-management/color-spaces/spectral-decomposition.png differ diff --git a/en/special-topics/color-management/display-profile/index.html b/en/special-topics/color-management/display-profile/index.html new file mode 100644 index 0000000000..30bb90929e --- /dev/null +++ b/en/special-topics/color-management/display-profile/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - display profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / display profile + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ display profile +

+ + + +

For darktable to faithfully render colors on screen it needs to find the correct display profile for your monitor. In general this requires your monitor to be properly calibrated and profiled, and it needs the profile to be correctly installed on your system. darktable queries your X display server’s xatom as well as the system service colord (if available) for the right profile. If required you can enforce a specific method in preferences > miscellaneous.

+

To investigate your display profile configuration you can run the darktable-cmstest binary (Linux only) which prints out useful information (e.g. profile name per-monitor) and tells you if the system is correctly configured.

+

In rare cases you may need to manually select the display profile. This is possible from within the soft proof and gamut check option dialogs in the darkroom view and the display profile dialog in the lighttable view.

+

Bear in mind that high-tier consumer-grade screens usually don’t need a user-made display profile unless you need to perform soft-proofing with professional expectations, since they are properly calibrated to sRGB in the factory.

+

A poorly-made display profile will be more harmful than sticking to the default sRGB profile, since the default might be slightly inaccurate but will at least be reliable. Advanced and professional users are advised to proceed with the production of custom display profiles only if they have the training to assess the quality of the resulting profile and understanding of the profiling options.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/index.html b/en/special-topics/color-management/index.html new file mode 100644 index 0000000000..8c9f1990b8 --- /dev/null +++ b/en/special-topics/color-management/index.html @@ -0,0 +1,3065 @@ + + + + + +darktable user manual - color management + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/index.xml b/en/special-topics/color-management/index.xml new file mode 100644 index 0000000000..a3af153488 --- /dev/null +++ b/en/special-topics/color-management/index.xml @@ -0,0 +1,67 @@ + + + + color management on darktable user manual + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/ + Recent content in color management on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/overview/ + darktable employs a fully color managed workflow: Input color specifications are taken from embedded or user-supplied ICC profiles or (in the case of raw files) from a library of camera-specific color matrices. darktable automatically reads the display profile of your monitor (if properly configured) for accurate on-screen color rendition. Multiple-screen setups are fully supported as long as a system service like colord is in place and properly configured to inform darktable of the correct monitor profile. + + + display profile + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/display-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/display-profile/ + For darktable to faithfully render colors on screen it needs to find the correct display profile for your monitor. In general this requires your monitor to be properly calibrated and profiled, and it needs the profile to be correctly installed on your system. darktable queries your X display server&rsquo;s xatom as well as the system service colord (if available) for the right profile. If required you can enforce a specific method in preferences &gt; miscellaneous. + + + rendering method + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-method/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-method/ + darktable can render colors either with its own internal algorithms or by using the external library LittleCMS2. darktable&rsquo;s internal method is, by an order of magnitude, faster than the external one. The external option gives you a choice of the rendering intent and might offer a slightly higher accuracy in some cases. You can change the default method in preferences &gt; processing &gt; always use LittleCMS 2 to apply output color profile + + + rendering intent + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-intent/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/rendering-intent/ + If rendering with LittleCMS2 is activated (see rendering method) you can define how to handle out-of-gamut colors when converting between color spaces. A selection box in the export, output color profile, and soft proof modules gives you a choice of the following rendering intents: perceptual Best suited to photographs as it maintains the relative position of colors. This is usually the best choice. relative colorimetric Out-of-gamut colors are converted to colors having the same lightness, but different saturation. + + + darktable's color spaces + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-spaces/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-spaces/ + Input images are either RGB files (like JPEGs or TIFFs) or camera RAWs. Both store visual information as a combination of primary colors (e.g. red, green and blue) which together describe a light emission to be recreated by a display. The following image illustrates this concept. The left-hand-side of the image depicts a colored light that we need to represent digitally. We can use three ideal color filters to decompose this light into three colored primary lights at different intensities. + + + unbounded colors + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/unbounded-colors/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/unbounded-colors/ + Screens and most image file formats can only encode RGB intensities confined within a certain range. For example, images encoded on 8 bits can only contain values from 0 to 255, images on 10 bits from 0 to 1023, and so on… Graphic standards postulate that the maximum of that range, no matter its actual value, will always represent the maximum brightness that the display medium is able to render, usually between 100 and 160 Cd/m² (or nits) depending on the actual standard. + + + possible color artifacts + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-artifacts/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-artifacts/ + There are some infrequent situations that still can lead to problematic results unless the user takes some action. Some modules in Lab color space, like levels and monochrome, rely on the fact that the L channels carries all lightness information, with the a and b channels purely representing chroma and hue. Unbounded colors with negative L values are especially problematic to these modules and can lead to black pixel artifacts. + + + darktable's color dimensions + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-dimensions/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-management/color-dimensions/ + This section defines the perceptual properties of color, both conceptually and quantitatively, in order to characterize and quantify the creative and corrective adjustments made to color in darktable. 🔗definitions Color properties like &ldquo;saturation&rdquo;, &ldquo;brightness&rdquo; or &ldquo;lightness&rdquo; have passed into common usage but are largely misused and often used to mean different things. In color science, each of these terms has a precise meaning. There are two frameworks within which color properties may be analyzed and described: + + + diff --git a/en/special-topics/color-management/overview/index.html b/en/special-topics/color-management/overview/index.html new file mode 100644 index 0000000000..299f139862 --- /dev/null +++ b/en/special-topics/color-management/overview/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / overview + +
+ +
+ + +
+ + +
+ +

+ overview +

+ + + +

darktable employs a fully color managed workflow:

+
    +
  • +

    Input color specifications are taken from embedded or user-supplied ICC profiles or (in the case of raw files) from a library of camera-specific color matrices.

    +
  • +
  • +

    darktable automatically reads the display profile of your monitor (if properly configured) for accurate on-screen color rendition. Multiple-screen setups are fully supported as long as a system service like colord is in place and properly configured to inform darktable of the correct monitor profile.

    +
  • +
  • +

    Output files can be encoded in one of darktable’s built-in profiles, including sRGB and Adobe RGB, or into a color space supplied by the user as an ICC profile.

    +
  • +
+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/rendering-intent/index.html b/en/special-topics/color-management/rendering-intent/index.html new file mode 100644 index 0000000000..6a3659477d --- /dev/null +++ b/en/special-topics/color-management/rendering-intent/index.html @@ -0,0 +1,3027 @@ + + + + + +darktable user manual - rendering intent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / rendering intent + +
+ + + + +
+ +

+ rendering intent +

+ + + +

If rendering with LittleCMS2 is activated (see rendering method) you can define how to handle out-of-gamut colors when converting between color spaces. A selection box in the export, output color profile, and soft proof modules gives you a choice of the following rendering intents:

+
+
perceptual
+
Best suited to photographs as it maintains the relative position of colors. This is usually the best choice.
+
relative colorimetric
+
Out-of-gamut colors are converted to colors having the same lightness, but different saturation. Other colors remain unmodified.
+
saturation
+
Saturation is retained but lightness is slightly changed.
+
absolute colorimetric
+
Keep the white point.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/rendering-method/index.html b/en/special-topics/color-management/rendering-method/index.html new file mode 100644 index 0000000000..21d8aec273 --- /dev/null +++ b/en/special-topics/color-management/rendering-method/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - rendering method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / rendering method + +
+ +
+ + +
+ + +
+ +

+ rendering method +

+ + + +

darktable can render colors either with its own internal algorithms or by using the external library LittleCMS2. darktable’s internal method is, by an order of magnitude, faster than the external one. The external option gives you a choice of the rendering intent and might offer a slightly higher accuracy in some cases.

+

You can change the default method in preferences > processing > always use LittleCMS 2 to apply output color profile

+
+

Note: If the given ICC is LUT-based or contains both, a LUT and a matrix, darktable will use LittleCMS2 to render the colors regardless of the configuration parameter’s value.

+
+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-management/unbounded-colors/index.html b/en/special-topics/color-management/unbounded-colors/index.html new file mode 100644 index 0000000000..4629b16fd0 --- /dev/null +++ b/en/special-topics/color-management/unbounded-colors/index.html @@ -0,0 +1,3023 @@ + + + + + +darktable user manual - unbounded colors + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / color management / unbounded colors + +
+ + + + +
+ +

+ unbounded colors +

+ + + +

Screens and most image file formats can only encode RGB intensities confined within a certain range. For example, images encoded on 8 bits can only contain values from 0 to 255, images on 10 bits from 0 to 1023, and so on… Graphic standards postulate that the maximum of that range, no matter its actual value, will always represent the maximum brightness that the display medium is able to render, usually between 100 and 160 Cd/m² (or nits) depending on the actual standard. We generally call this maximum “100 % display-referred”. The minimum of the range, encoded 0 no matter the bit-depth used, becomes then “0 % display-referred”. 100 % encodes pure white, 0 % encodes pure black.

+

This is a limitation for image processing applications, because it means that any pixel lying outside of this range will be clipped to the nearest bound, resulting in non-recoverable loss of data (colors and/or textures).

+

For the longest time, image processing software too was bounded to this limitation for technical reasons, and some still is, but now by design choice. As a result, they would clip RGB intensities at 100 % display-referred between image operations.

+

darktable uses floating-point arithmetic inside its color pipeline, which means it can handle any RGB value internally, even those outside the display-referred range, as long as it is positive. Only at the very end of the pipeline, before the image is saved to a file or sent to display, are the RGB values clipped if needed.

+

Pixels that can take values outside of the display range are said to have “unbounded colors”. One could choose to clamp (i.e. confine) those values to the allowed range at every processing step or choose to carry on with them, and clamp them only at the last step in the pipeline. However, it has been found that processing is less prone to artifacts if the unbounded colors are not clamped but treated just like any other color data.

+

At the end of the pipeline, modules like filmic rgb can help you to remap RGB values to the display-referred range while maximizing the data preservation and avoiding hard clipping, which is usually not visually pleasing.

+

However, at all times in the pipeline, you must ensure that you do not create negative RGB values. RGB intensities encode light emissions and negative light does not exist. Those modules that rely on a physical understanding of light to process pixels will fail if they encounter a non-physical light emission. For safety, negative RGB values are still clipped whenever they might make the algorithms fail, but the visual result might look degraded. Negative values can be produced when abusing the black level in exposure or the offset in color balance and care should be taken when using these modules.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/color-pipeline/index.html b/en/special-topics/color-pipeline/index.html new file mode 100644 index 0000000000..ea96228064 --- /dev/null +++ b/en/special-topics/color-pipeline/index.html @@ -0,0 +1,3040 @@ + + + + + +darktable user manual - darktable's color pipeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Special Topics / darktable's color pipeline + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ darktable’s color pipeline +

+ + + +

Most image processing applications come from the 1990s and/or inherit a 1990s workflow. These applications processed images encoded with 8 bit unsigned integers because it was more memory- and computationally-efficient. However, due to the use of an integer format (which implies rounding errors) they had to apply a “gamma” (essentially a transfer function applying a power 1/2.2 or 1/2.4 to encode the RGB values) and increase the bit-depth in the low-lights in order to reduce rounding errors there (humans are very sensitive to low-light details). The 8 bit integer formats are also technically limited to the 0-255 range. Anything outside of this range overflows and is clipped to the nearest bound.

+

These workflows, using bounded RGB representations and possibly non-linear transforms to encode RGB signals, are called “display-referred”. They rely on the assumption that the image has been prepared for display at an early stage in the processing pipeline, and embed hard-coded assumptions about the RGB values of black, middle-gray and white. Most of the image-processing algorithms used in these workflows have been tuned around these assumptions. For example, the overlay blending mode expects a middle-gray encoded at 50% (or 128 in integer encoding).

+

Unfortunately the non-linear scaling, which is mandatory to make the integer encoding work, breaks the natural relationships between pixel values. Hue and saturation change in unpredictable ways, and value relationships between neighbouring pixels are dilated or compressed such that gradients are also altered unpredictably.

+

Display-referred pipelines therefore break optical filters (lens blurring or deblurring), alpha compositing (which relies on optical and geometrical definitions of occlusion), colors and gradients (local relationships between chrominance and luminance of pixels). They also don’t scale well to HDR images, which led to the development of many questionable local and global tonemapping methods and the infamous 2010s “HDR look”.

+

Modern computers are not tied to the same computational limitations as those from the 1990s, and can work on pixels whose values are completely unbounded (from 0 up to +infinity) and encoded as real numbers (using floating point formats). These possibilities enable what we call a “scene-referred” workflow, in which pixels can retain their original radiometric relationships along almost the entire processing pipe. In scene-referred workflow, pixels are prepared for display only at the last stage of the pipeline, in the display transform. This means that the RGB values of the pixels are kept proportional to the intensity of the light emission recorded by the camera on the scene, enabling accurate alpha compositing and optical filter emulations, while also scaling to any dynamic range through the same algorithm (SDR as well as HDR).

+

However, scene-referred pipelines lose the convenient fixed values of white, middle-gray and black which characterised display-referred pipelines, and setting these values, according to the scene and to the conditions of shooting, now becomes the responsibility of the user. This requires a more complex user interface.

+

Also, because scene-referred values are supposed to be physically-meaningful, pixels cannot have zero intensity. This would mean they have no light at all, and the existence of zero light breaks many physically-accurate algorithms. In fact, white and black mean nothing with regard to the original scene, which is only a collection of luminances at varying intensities. The scene-referred workflow simply aims at remapping some arbitrary scene luminances to what will appear white or black on the output medium.

+

Versions of darktable prior to 2.6 had a non-linear display-referred pipeline, assuming that a non-linear transform took place early in the pipe and middle-gray was thereafter encoded as 50%. However, not all modules and filters clipped pixel values above 100%, leaving open the possibility of recovering those values later in the pipe.

+

The filmic module’s view transform, introduced in darktable 2.6, was the first step toward a scene-referred pipeline, and deferred the mandatory, non-linear, display preparation to the end of the pipe, along with the ability to set custom black, gray and white values. The color balance module then introduced a way to deal with a variable definition of middle-gray.

+

Starting in darktable 3.2, users could choose between two workflows that defined consistent default settings, modules and pipeline order for both display-referred and scene-referred processing.

+

In darktable 3.4, a full scene-referred masking and blending option was introduced, allowing masks to be defined for pixel values above 100% and using only unbounded blending operators.

+

Switching to scene-referred is a cognitive leap for most experienced users, who are used thinking in display-referred ways. In a display-referred workflow, it is customary to anchor the white value and let tone adjustments revolve around that point, trying to maximize brightness while avoiding clipping. In a scene-referred workflow, white and black values are fluid and adapted to the output medium. It is advised that users anchor middle-gray (which will be preserved as-is for any output medium) and let the view transform (filmic) dilate or contract the dynamic range around that point. Because 10 bit HDR white is 4 times as bright as 8 bit SDR white, any rigid definition of “white” becomes irrelevant. But anchoring for middle-gray is actually more convenient, since it keeps the average brightness of the picture unchanged through the view transform.

+

Some modules (levels, rgb levels, tone curve, rgb curve) are inherently incompatible with a scene-referred workflow, because their graphical interface implicitly suggests RGB values that are bounded within the 0-100% range. While the pixel operations they perform can be used in either scene-referred or display-referred workflows because they are unbounded internally, their controlling interface does not allow pixels to be selected outside of the 0-100% range.

+

Similarly, blending modes such as overlay, linear light, soft light, hard light, darken, brighten, etc. all have hard-coded thresholds that internally expect display-referred non-linear encoding.

+

In darktable 3.4 and above, hovering the cursor over a module header shows a tooltip detailing the color spaces, ranges and encodings that the module expects, uses and produces. Here are the definitions of the terms used:

+
+
linear
+
Pixel values are proportional to the scene radiometric emission, in a way that enables accurate emulation of physical filters.
+
non-linear
+
Pixel values are re-scaled such that low-lights are given a larger encoding range, usually to remap the 18.45% reference middle-gray to a value between 46 and 50%.
+
display-referred
+
Pixel values are expected to lie between 0 and 100% of the display range, where 100% is understood to be the luminance of a 20% reflective white surface (the white patch of a Color Checker) and 0% is understood to be the maximum density of the output medium (saturated black ink or minimum LED panel backlighting).
+
scene-referred
+
Pixel values are expected to be greater than zero up to +infinity. The meaning of specific pixel values needs to be defined at runtime by the user. Scene-referred values don’t automatically imply a linear, radiometrically scaled, encoding.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/contributing/active-icon.png b/en/special-topics/contributing/active-icon.png new file mode 100644 index 0000000000..1f99bc3e24 Binary files /dev/null and b/en/special-topics/contributing/active-icon.png differ diff --git a/en/special-topics/contributing/index.html b/en/special-topics/contributing/index.html new file mode 100644 index 0000000000..4228c8a4ef --- /dev/null +++ b/en/special-topics/contributing/index.html @@ -0,0 +1,3227 @@ + + + + + +darktable user manual - contributing to dtdocs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Special Topics / contributing to dtdocs + +
+ + + + +
+ +

+ contributing to dtdocs +

+ + + +

This page defines the style guide for dtdocs and information about how to contribute to the project.

+

It is included in the user manual so that you can see how the page is rendered as well as how it is written. Please go to GitHub to see the source for this page.

+

The manual structure and content have been carefully considered based on the following criteria:

+
    +
  1. The manual should be comprehensive – it should describe all of the functionality available in darktable
  2. +
  3. It should have a consistent and logical structure and every piece of functionality should have its own logical place within that structure
  4. +
  5. It should be as long as necessary but as short as possible – brevity is a must
  6. +
  7. It should be objective
  8. +
  9. Functionality should be explained once and only once (with the exception of the basic workflow guidelines in the overview section)
  10. +
  11. Images should be included only where necessary to improve understanding of key principles and should not contain text unless it is unavoidable
  12. +
+

We are generally not interested in:

+
    +
  1. Restructuring the manual
  2. +
  3. Switching markup languages
  4. +
  5. Detailed workflow tutorials (though we are interested in publishing those on the blogs of either darktable.org or pixls.us)
  6. +
+

We are interested in

+
    +
  1. Spelling and grammar corrections
  2. +
  3. Clarification of text
  4. +
  5. Documentation for new features
  6. +
+

We are always extremely interested in hearing about which sections of the manual did not make sense to you and why, so that we can improve the documentation.

+

In general, if you wish to make a major change, please open an issue and discuss it with the maintainers first. This is to avoid doing work that wouldn’t be accepted.

+

🔗format

+

This website is authored in pure markdown, using some extensions. It is initially designed to work with the Hugo SSG but intended to be portable enough that it can be easily rendered with another application if required.

+

Files should be rendered in UTF-8 and should not include any column wrapping.

+

🔗structure

+

The following shows the structure of an example main chapter with subsections in the dtdocs website.

+
example-chapter/
+   _index.md
+   section1-with-subsections/
+      subsection1/
+         image.png
+      _index.md
+      subsection1.md
+      subsection2.md
+   section2.md
+   section3.md
+

A couple of notes on the above structure:

+
    +
  • _index.md files do not contain any content (they contain metadata only) and are used to render section headers and ToC entries. In the above example example-chapter/_index.md defines the title of the example chapter and the order in which it appears in the main table of contents. Similarly example-chapter/section1-with-subsections/_index.md defines metadata for the first section of the chapter.
  • +
  • Media files should be contained in a directory with the same name as the page to which they relate. In this example, example-chapter/section1-with-subsections/subsection1 contains media related to the subsection1.md page.
  • +
+

🔗metadata

+

Metadata for the markdown files is presented at the head of the page using yaml. Any metadata may be defined – the module reference sections contain quite a lot of specific metadata – however the following defines some minimal metadata for the example page example-chapter/section1-with-subsections/subsection1.md.

+
---
+title: Sub Section 1 Title
+id: subsection1
+weight: 10
+---
+
+
title
+
This should contain the rendered title of your page. To include a colon within a title, enclose the title in double-quotes.
+
id
+
This is the id used to identify the page by Hugo. It should usually be the same name as the file (for content files) or the parent directory (for _index.md files).
+
weight
+
This is an optional metadata field used to define the order in which sections are presented in the Table of Contents. If the weight field is not included, pages will be rendered in alphabetic order by default. For example, to define the sections and subsections of the above example in reverse order, the following metadata would need to be set:
+
+
   example-chapter/
+      section1-with-subsections/
+         _index.md               # weight: 30 (place section1 page at the end of example-chapter)
+         subsection1.md             # weight: 20 (place subsection1 page at the end of section1)
+         subsection2.md             # weight: 10 (place subsection2 page at the start of section1)
+      section2.md                # weight: 20 (place section2 in the middle of example-chapter)
+      section3.md                # weight: 10 (place section3 at the start of example-chapter)
+

🔗content

+

🔗general style guidance

+
    +
  • All content should be authored in plain markdown without shortcodes and HTML should be kept to an absolute minimum, if used at all
  • +
  • Minimalism is an absolute must. Fewer words are preferred
  • +
  • Markdown files should be as short as possible
  • +
  • Follow the naming and capitalization norms present in the GUI of the application – namely all headers and titles are in lower case, except for the very top-level chapter names. Similarly, use all lower case when referencing module names and controls.
  • +
  • Headers in a file should not exceed level three (###)
  • +
  • The primary authoring language is English. Avoid idiomatic language where possible as the English version of the documentation may be read by people for whom English is not their native language
  • +
  • Assume the reader has the application open while reading the user manual and only include images where they contribute to the explanation of complex functionality
  • +
  • Use image callouts if you need to annotate an image (i.e. mark parts of the image with a letter or number and then explain the meaning in some text following the image). Do not place words directly into the image for annotations, as this makes localization difficult. See this page for an example.
  • +
  • Changes to the content should be proposed via pull request or a similar mechanism
  • +
  • Your submissions will be copy-edited – don’t take it personally
  • +
+

🔗keyboard and mouse shortcuts

+
    +
  • Reference named keyboard keys using CamelCase (Ctrl, Shift, Alt, Esc, AltGr, CapsLock, PageUp, PageDown)
  • +
  • Reference single letter keys in lower case (this avoids confusion between for example, Ctrl+H and Ctrl+Shift+h). Quotation marks might help with clarification (press “h” to see a list of active shortcuts)
  • +
  • Reference mouse actions using lower case, with multiple words joined by a hyphen (scroll, click, single-click, double-click, right-click)
  • +
  • Connect combinations of keys/actions with a plus sign (Ctrl+Shift+h, Shift+double-click)
  • +
+

🔗definition lists

+

The standard method of presenting information about darktable module controls is with the use of definition lists.

+
+
gui control name
+
A declaration of what the control does. For example “Set the exposure in EV units”.
+
+

You can include as many paragraphs as you like, but try to limit to 2 or 3 where possible.

+
+
+ + + + + + + + +active-icon + + a control accessed through a button with an icon
+
When a control is activated using an icon, take a screenshot of the icon using the standard darktable theme (darktable-elegant-grey) and add it before the name of the control
+
gui combobox name
+
Comboboxes often have multiple options that all need to be displayed with separate definitions. Use bulleted lists with italics for the combobox values.
+
    +
  • the first value: What the first value means
  • +
+
+
    +
  • the second value: What the second value means
  • +
+
+
+

Definition lists are also used throughout the document, wherever a named piece of functionality needs to be defined. See, for example, darktable-cli.

+

🔗notes

+

If you wish to present an important note to the user, use the following format:

+
+

Note: This is an important note.

+
+

🔗fixed-width fonts and code blocks

+

Fixed width fonts (using the ` character) should normally only be used for code blocks and when referencing file names and command line parameters.

+ +

Internal links must be relative to the current file and must point to a valid markdown (.md) file. Start links with either ./ to represent the current directory or ../ to represent the parent directory.

+ +

🔗images

+

When taking screenshots from the darktable application itself, use the default darktable theme (darktable-elegant-grey).

+

Several filename suffixes can be used to control how an image is rendered.

+
+
icon
+
To insert an image as an icon, include #icon after the image name in the link. The markdown ![squirrel icon](./contributing/contributing.png#icon) outputs the following: + + + + + + + + +squirrel icon + +
+
image width
+
You can set the image width to 25, 33, 50, 66, 75 or 100 per cent of the rendered page width by including #wxx after the image name in the link, where xx is the desired width. For example:
+
![squirrel](./contributing/squirrel.png#w25) outputs
+
+ + + + + + + + +squirrel + +
+
![squirrel](./contributing/squirrel.png#w75) outputs
+
+ + + + + + + + +squirrel + +
+
inline
+
With the exception of icons, images are included as block elements by default. You can override this by including #inline after the image name. This can be combined with the width setting as follows.
+
![squirrel](./contributing/squirrel.png#w25#inline) outputs + + + + + + + + +squirrel + +
+
default
+
By default images are presented as block elements with 100% width. So ![squirrel](./contributing/squirrel.png#w100) and ![squirrel](./contributing/squirrel.png) are equivalent and both output the following:
+
+ + + + + + + + +squirrel + +
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/contributing/squirrel.png b/en/special-topics/contributing/squirrel.png new file mode 100644 index 0000000000..8c5adcd59d Binary files /dev/null and b/en/special-topics/contributing/squirrel.png differ diff --git a/en/special-topics/darktable-chart/index.html b/en/special-topics/darktable-chart/index.html new file mode 100644 index 0000000000..31927163f2 --- /dev/null +++ b/en/special-topics/darktable-chart/index.html @@ -0,0 +1,3051 @@ + + + + + +darktable user manual - using darktable-chart + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/darktable-chart/index.xml b/en/special-topics/darktable-chart/index.xml new file mode 100644 index 0000000000..666098baea --- /dev/null +++ b/en/special-topics/darktable-chart/index.xml @@ -0,0 +1,53 @@ + + + + using darktable-chart on darktable user manual + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/ + Recent content in using darktable-chart on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/overview/ + darktable-chart is a tool for extracting luminance and color values from images of color reference cards such as IT8.7/1 charts. Its main purpose is to compare a source image (typically a largely unprocessed raw image) to a target image (typically a JPEG image created in-camera) and produce a darktable style that is able to use the luminance and color values of the source image to produce the target image. This style employs the tone curve module, the input color profile module, and the color look up table module for that purpose. + + + usage + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/usage/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/usage/ + The tool is organized into three tabs in the upper part and a text output frame in the lower part. The first tab is used to define the source image, the second tab defines the reference (target) and the third tab contains the controls to generate the resulting darktable style. + + + source image + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/source-image/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/source-image/ + In the “source image” tab you set your source image, which requires two elements. The first element is an input file in Lab Portable Float Map format (extension .pfm). The source file represents the largely unmodified data as the camera sees it. Information about how to take photos of a color reference card and produce a .pfm output file are described below. The second element is a chart file that contains a formal description of the underlying color reference card&rsquo;s layout (extension . + + + reference values + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/reference-values/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/reference-values/ + The “reference values” tab determines the target values to which the source image must to be modified by the resulting style. You can either supply reference values in the form of measured data of your color reference card (mode “cie/it8 file”), or you can supply a photographic image (mode “color chart image”) much in the same way as described above. This second image must also be supplied in Lab Portable Float Map format. + + + process + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/process/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/process/ + If all of the required settings in the &ldquo;source image&rdquo; and &ldquo;reference values&rdquo; tabs are ready you can move on to the “process” tab. First, you need to tell darktable-chart which of the patches represents the gray ramp. In the screenshot displayed above, the gray ramp is positioned in the lower part of the color reference chart, denoted as &ldquo;GS00&hellip;GS23&rdquo;. The &ldquo;number of final patches&rdquo; input defines how many editable color patches the resulting style will use within the color look up table module. + + + making input images for darktable-chart + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/making-input-images/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/darktable-chart/making-input-images/ + To start with, you need a suitable photo of your color reference card in RAW+JPEG format. It goes beyond the scope of this manual to explain the details of how to take this photo, but in a nutshell you need to make the shot on a sunny day around midday with the light source (the sun) shining at an angle onto the card. You need to avoid any glare in the image. + + + diff --git a/en/special-topics/darktable-chart/making-input-images/index.html b/en/special-topics/darktable-chart/making-input-images/index.html new file mode 100644 index 0000000000..a7e406c7e3 --- /dev/null +++ b/en/special-topics/darktable-chart/making-input-images/index.html @@ -0,0 +1,3024 @@ + + + + + +darktable user manual - making input images for darktable-chart + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / using darktable-chart / making input images for darktable-chart + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ making input images for darktable-chart +

+ + + +

To start with, you need a suitable photo of your color reference card in RAW+JPEG format. It goes beyond the scope of this manual to explain the details of how to take this photo, but in a nutshell you need to make the shot on a sunny day around midday with the light source (the sun) shining at an angle onto the card. You need to avoid any glare in the image. The neutral white color patch in the gray ramp (G00) should end up at the L value specified in the description of your card. Often this is L=92 and requires you to overexpose the shot by about 1/3 EV. Ideally you will make several shots with slightly different exposures and later select the right one in darktable. Make sure that the chart fills up most of the frame. Use a lens with a “normal” focal length (e.g. 50mm equivalent) and stop down a bit to avoid vignetting.

+

You then open the raw file in darktable and disable most modules, especially base curve. Select the standard input matrix in the input color profile module and disable gamut clipping. Select “camera white balance” in the white balance module.

+

There is a special situation if your camera automatically applies some lens corrections (namely vignetting correction) to the resulting JPEG file. In this case you need to activate the lens correction module in darktable so that raw processing matches the JPEG in this respect. However, since darktable’s vignetting correction may not exactly match the in-camera correction, it is better to disable this correction in-camera if possible.

+

To output your image go to the export module in the lighttable.

+

You will need to select “Lab” as the output color profile. This color space is not visible in the combobox by default. You first need to enable it by setting allow_lab_output to TRUE in $HOME/.config/darktable/darktablerc. Alternatively, you can start darktable with:

+
darktable --conf allow_lab_output=true
+

Then select “PFM (float)” as the output format and press “export” to generate the source image file.

+

You can produce the corresponding reference (target) image from the JPEG in a similar way. This time you will need to disable all modules and export with the “Lab” output color profile in “PFM (float)” format.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/darktable-chart/overview/index.html b/en/special-topics/darktable-chart/overview/index.html new file mode 100644 index 0000000000..cc9c039a3d --- /dev/null +++ b/en/special-topics/darktable-chart/overview/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / using darktable-chart / overview + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ overview +

+ + + +

darktable-chart is a tool for extracting luminance and color values from images of color reference cards such as IT8.7/1 charts. Its main purpose is to compare a source image (typically a largely unprocessed raw image) to a target image (typically a JPEG image created in-camera) and produce a darktable style that is able to use the luminance and color values of the source image to produce the target image. This style employs the tone curve module, the input color profile module, and the color look up table module for that purpose.

+

Some cameras offer various film simulation modes of your choice. With the help of darktable-chart and the underlying modules you can create styles that replicate these film simulations from within darktable.

+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/darktable-chart/process/darktable-chart-process.png b/en/special-topics/darktable-chart/process/darktable-chart-process.png new file mode 100644 index 0000000000..15b2786cd9 Binary files /dev/null and b/en/special-topics/darktable-chart/process/darktable-chart-process.png differ diff --git a/en/special-topics/darktable-chart/process/index.html b/en/special-topics/darktable-chart/process/index.html new file mode 100644 index 0000000000..ddca7079c5 --- /dev/null +++ b/en/special-topics/darktable-chart/process/index.html @@ -0,0 +1,3036 @@ + + + + + +darktable user manual - process + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / using darktable-chart / process + +
+ + + + +
+ +

+ process +

+ + + +

If all of the required settings in the “source image” and “reference values” tabs are ready you can move on to the “process” tab.

+

+ + + + + + + + +process + +

+

First, you need to tell darktable-chart which of the patches represents the gray ramp. In the screenshot displayed above, the gray ramp is positioned in the lower part of the color reference chart, denoted as “GS00…GS23”.

+

The “number of final patches” input defines how many editable color patches the resulting style will use within the color look up table module.

+

Click the “process” button to start the calculation.

+

The quality of the result (in terms of average delta-E and maximum delta-E) is displayed below the button. This data shows how closely the resulting style (when applied to the source image) will be able to match the reference values – the lower the better.

+

Once you are happy with the result you can click on “export” to save the generated style.

+

Supply a style name and a style description under which the style will later appear in darktable. darktable-chart saves the style as a .dtstyle file which can be imported into darktable and shared with others. See styles.

+

The “export raw data as csv” button allows you to save the extracted raw data as a CSV file for debugging purposes or later use. darktable-chart offers a command line option to produce a style with the desired number of final patches from a supplied CSV file (see darktable-chart).

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/darktable-chart/reference-values/index.html b/en/special-topics/darktable-chart/reference-values/index.html new file mode 100644 index 0000000000..86eef0a322 --- /dev/null +++ b/en/special-topics/darktable-chart/reference-values/index.html @@ -0,0 +1,3019 @@ + + + + + +darktable user manual - reference values + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / using darktable-chart / reference values + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ reference values +

+ + + +

The “reference values” tab determines the target values to which the source image must to be modified by the resulting style. You can either supply reference values in the form of measured data of your color reference card (mode “cie/it8 file”), or you can supply a photographic image (mode “color chart image”) much in the same way as described above. This second image must also be supplied in Lab Portable Float Map format. There is no need to supply the chart file again as darktable-chart takes the same one as defined under “source image”. You only need to again align the layout grid and the image and potentially adjust the “size” slider.

+

In a typical use case the second image will be based on a JPEG file produced in-camera. This way you can create a style to simulate the in-camera processing within darktable.

+

In the lower text output frame you will see the color values extracted from the available data for each individual color patch. The first column gives the name of the patch, the second and third column show the corresponding color values of the source image in RGB and Lab format, respectively. The fourth column contains the Lab value coming from the reference (or from the chart file if no reference image has been given). Finally, the fifth and sixth columns display how strongly source and reference values deviate in terms of delta-E values.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/darktable-chart/source-image/darktable-chart-source.png b/en/special-topics/darktable-chart/source-image/darktable-chart-source.png new file mode 100644 index 0000000000..23c0f30632 Binary files /dev/null and b/en/special-topics/darktable-chart/source-image/darktable-chart-source.png differ diff --git a/en/special-topics/darktable-chart/source-image/index.html b/en/special-topics/darktable-chart/source-image/index.html new file mode 100644 index 0000000000..30b5a519bc --- /dev/null +++ b/en/special-topics/darktable-chart/source-image/index.html @@ -0,0 +1,3032 @@ + + + + + +darktable user manual - source image + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / using darktable-chart / source image + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ source image +

+ + + +

In the “source image” tab you set your source image, which requires two elements. The first element is an input file in Lab Portable Float Map format (extension .pfm). The source file represents the largely unmodified data as the camera sees it. Information about how to take photos of a color reference card and produce a .pfm output file are described below. The second element is a chart file that contains a formal description of the underlying color reference card’s layout (extension .cht). Chart files are usually shipped with your color reference card or can be downloaded from the internet.

+

+ + + + + + + + +source + +

+

In real life the photo taken from the color reference card will show some perspective distortions relative to the layout defined in the chart file. For that reason the layout is displayed as a grid over the image and can be modified.

+

You can move the corners of the grid using the mouse to reach best alignment of grid and image.

+

A rectangular frame is displayed for each patch and defines the area from which darktable-chart will sample the required input data. You may need to modify the size of these rectangles so that the sampling area is big enough but does not overlap with neighboring patches. Use the “size” slider in the upper right part of the GUI. Higher values lead to smaller sizes.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/darktable-chart/usage/darktable-chart-usage.png b/en/special-topics/darktable-chart/usage/darktable-chart-usage.png new file mode 100644 index 0000000000..6bb2e43266 Binary files /dev/null and b/en/special-topics/darktable-chart/usage/darktable-chart-usage.png differ diff --git a/en/special-topics/darktable-chart/usage/index.html b/en/special-topics/darktable-chart/usage/index.html new file mode 100644 index 0000000000..dc752213a5 --- /dev/null +++ b/en/special-topics/darktable-chart/usage/index.html @@ -0,0 +1,3030 @@ + + + + + +darktable user manual - usage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + + + +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ usage +

+ + + +

The tool is organized into three tabs in the upper part and a text output frame in the lower part.

+

+ + + + + + + + +usage + +

+

The first tab is used to define the source image, the second tab defines the reference (target) and the third tab contains the controls to generate the resulting darktable style.

+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/index.html b/en/special-topics/index.html new file mode 100644 index 0000000000..7e932ab952 --- /dev/null +++ b/en/special-topics/index.html @@ -0,0 +1,3078 @@ + + + + + +darktable user manual - Special Topics + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/index.xml b/en/special-topics/index.xml new file mode 100644 index 0000000000..d129fd6ed5 --- /dev/null +++ b/en/special-topics/index.xml @@ -0,0 +1,53 @@ + + + + Special Topics on darktable user manual + https://darktable-org.github.io/dtdocs/en/special-topics/ + Recent content in Special Topics on darktable user manual + Hugo + en + + + memory & performance tuning + https://darktable-org.github.io/dtdocs/en/special-topics/mem-performance/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/mem-performance/ + 🔗memory requirements Processing a Raw image in darktable requires a great deal of system memory. A simple calculation makes this clear: For a 20 megapixel image, darktable requires a 4x32-bit floating point cell to store each pixel, meaning that each full image of this size will require approximately 300MB of memory just to store the image data. In order to actually process this image through a given module, darktable needs at least two buffers (input and output) of this size, with more complex modules potentially requiring several additional buffers for intermediate data. + + + variables + https://darktable-org.github.io/dtdocs/en/special-topics/variables/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/variables/ + darktable supports variable substitution in a number of modules and preference settings. For example: Defining file names in the export module Displaying image information in the darkroom&rsquo;s image information line Displaying image information in the lighttable&rsquo;s overlays and tooltips (see preferences &gt; lighttable) Placing text on an image in the watermark processing module 🔗available variables The following variables are available, though they may not all be applicable in every context: + + + darktable's color pipeline + https://darktable-org.github.io/dtdocs/en/special-topics/color-pipeline/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/color-pipeline/ + Most image processing applications come from the 1990s and/or inherit a 1990s workflow. These applications processed images encoded with 8 bit unsigned integers because it was more memory- and computationally-efficient. However, due to the use of an integer format (which implies rounding errors) they had to apply a &ldquo;gamma&rdquo; (essentially a transfer function applying a power 1/2.2 or 1/2.4 to encode the RGB values) and increase the bit-depth in the low-lights in order to reduce rounding errors there (humans are very sensitive to low-light details). + + + midi device support + https://darktable-org.github.io/dtdocs/en/special-topics/midi-device-support/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/midi-device-support/ + 🔗introduction MIDI is a communication protocol used by many electronic musical instruments (&ldquo;pianos&rdquo;), digital audio studio equipment (&ldquo;control surfaces&rdquo;) and even dedicated &ldquo;photo editing keyboards&rdquo; like the Loupedeck/Loupedeck+ (but not their later products). Such devices commonly feature sets of keys/buttons and sometimes encoders (knobs/rotors) and faders (sliders). Buttons sometimes feature lights, which makes them ideal for toggling features in darktable, because the lights can reflect the current (on/off) status. Encoders and faders are ideal for use with on-screen sliders in processing modules. + + + contributing to dtdocs + https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ + This page defines the style guide for dtdocs and information about how to contribute to the project. It is included in the user manual so that you can see how the page is rendered as well as how it is written. Please go to GitHub to see the source for this page. The manual structure and content have been carefully considered based on the following criteria: The manual should be comprehensive &ndash; it should describe all of the functionality available in darktable It should have a consistent and logical structure and every piece of functionality should have its own logical place within that structure It should be as long as necessary but as short as possible &ndash; brevity is a must It should be objective Functionality should be explained once and only once (with the exception of the basic workflow guidelines in the overview section) Images should be included only where necessary to improve understanding of key principles and should not contain text unless it is unavoidable We are generally not interested in: + + + translating dtdocs + https://darktable-org.github.io/dtdocs/en/special-topics/translating/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/translating/ + Translation of the darktable documentation is done via our Weblate instance. You can either use Weblate&rsquo;s web UI to translate the documentation or download the translation from Weblate to your computer, edit it, and then upload the changes. Please do all translation work through Weblate. We will not accept pull requests directly on github to update PO files. 🔗Making a new branch in git Make a new branch to work on it in git. + + + diff --git a/en/special-topics/mem-performance/index.html b/en/special-topics/mem-performance/index.html new file mode 100644 index 0000000000..b03e812406 --- /dev/null +++ b/en/special-topics/mem-performance/index.html @@ -0,0 +1,3155 @@ + + + + + +darktable user manual - memory & performance tuning + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Special Topics / memory & performance tuning + +
+ + + + +
+ +

+ memory & performance tuning +

+ + + +

🔗memory requirements

+

Processing a Raw image in darktable requires a great deal of system memory. A simple calculation makes this clear: For a 20 megapixel image, darktable requires a 4x32-bit floating point cell to store each pixel, meaning that each full image of this size will require approximately 300MB of memory just to store the image data. In order to actually process this image through a given module, darktable needs at least two buffers (input and output) of this size, with more complex modules potentially requiring several additional buffers for intermediate data. Without further optimization, anything between 600MB and 3GB of memory might be required to store and process image data as the pixelpipe executes. On top of this is darktable’s code segment, the code and data of any dynamically-linked system libraries, as well as further buffers that darktable uses to store intermediate states (cache) for quick access during interactive work.

+

All in all, darktable requires at least 4GB of physical RAM plus 4 to 8GB of additional swap space to run but it will perform better the more memory you have.

+

As well as executing on your CPU, many darktable modules also have OpenCL implementations that can take full advantage of the parallel processing offered by your graphics card (GPU). Similarly, the more GPU memory you have, the better darktable will perform.

+

🔗tiling

+

If darktable does not have sufficient memory to process the entire image in one go, modules may choose to use a “tiling strategy”, wherein the image is split into smaller parts (tiles) which are processed independently, and then stitched back together at the end. While this allows images to be processed with a much smaller memory footprint, it does also come with some down-sides:

+
    +
  • tiling is always slower – sometimes up to 10x slower, though for some modules the difference is negligible,
  • +
  • tiling is not technically possible for some modules because of the nature of the underlying algorithms
  • +
+

For most systems, tiling will probably only be used for full-sized image exports, with interactive work in the darkroom being processed more efficiently. For best performance (and avoidance of tiling modes) you should run darktable alongside as few other applications as possible and configure darktable to use as much of your system and GPU memory as you can.

+

🔗performance tuning

+

There are a number of configuration parameters that can help you to fine-tune your system’s performance. Some of these parameters are available in preferences > processing > CPU / memory and others need to be modified directly in darktable’s configuration file (found in $HOME/.config/darktable/darktablerc).

+

This section provides some guidance on how to adjust these settings.

+

🔗how to test

+

In order to determine how much your modifications improve (or not) darktable’s performance, you will need one or more sample images to test with, and a method of assessing the speed of the pixelpipe.

+

For sample images, you are advised to use some of the more intensive modules, such as diffuse or sharpen or denoise (profiled). Exports are likely to have more consistent and comparable timings between pipe runs than interactive work (and will also push your hardware more).

+

In order to obtain profiling information you need to start darktable from a terminal with darktable -d opencl -d perf. If you want more information about tiling you should use darktable -d opencl -d tiling -d perf.

+

Each time the pixelpipe is processed (when you change module parameters, zoom, pan, export etc.) you will see (in your terminal session) the total time spent in the pixelpipe and the time spent in each of the OpenCL kernels. The most reliable value is the total time spent the in pixelpipe and you should use this to assess your changes.

+
+

Note: The timings given for each individual module are unreliable when running the OpenCL pixelpipe asynchronously (see asyncronous mode below).

+
+

To allow for efficient processing with OpenCL it is essential that the GPU is kept busy. Any interrupts or a stalled data flow will add to the total processing time. This is especially important for the small image buffers used during interactive work, which can be processed quickly by a fast GPU. However, even short-term stalls of the pixelpipe can easily become a bottleneck.

+

On the other hand darktable’s performance during file exports is more or less only governed by the speed of the algorithms and the horse-power of your GPU. Short-term stalls will not have a noticeable effect on the total time of an export.

+

🔗darktable resources

+

The “darktable resources” preference (in preferences > processing > CPU / memory) allows you to choose between four different approaches to allocating your system’s resources to darktable. Each of these options controls multiple individual parameters, which are defined independently in $HOME/.config/darktable/darktablerc. You can amend any of these directly within your darktablerc file to tweak values for your selected resource level, though you cannot add your own custom resource level to the preferences drop-down.

+
+

Note: The unrestricted mode really “takes it all”. This might seem to be the best setting to use but, especially when exporting large images with high quality, unrestricted memory use can cause swapping, which might lead to impaired performance or darktable being silently killed by your operating system.

+
+

Each of the four “darktable resources” options are defined as follows:

+
resource_default=512 8 128 700
+resource_large=700 16 128 900
+resource_small=128 4 64 400
+resource_unrestricted=16384 1024 128 900
+

More generally, these can be represented as resource_level=a b c d where a - d are defined as follows:

+
+
a. system memory for module processing
+
The maximum amount of system memory made available for module processing. Lower values force memory-hungry modules to process images with an increasing number of tiles. This number is a fraction of the total amount of system memory, divided by 1024. For example, on a system with 16GB of total system memory the amount assigned by resource_default (in GB) is 16 * 512 / 1024, or 8GB of system RAM.
+
b. minimum tiling buffer size
+
The minimum size of a single tiling buffer, similarly expressed as a fraction of total system memory. For example, on a system with 16GB of total system memory the amount assigned by resource_default (in GB) is 16 * 8 / 1024, or 0.125GB of system RAM. Note that this setting is largely historic and is no longer of much practical use – you are advised to leave it at its default value.
+
c. thumbnail cache memory
+
The amount of memory to use for the thumbnail cache. Again, this is expressed as a fraction of total system memory and, on a 16GB system, the amount assigned by resource_default is 16 * 128 / 1024, or 2GB of system RAM.
+
d. OpenCL (GPU) memory
+
The maximum amount of GPU memory made available for module processing. As with system memory, lower values will force memory-hungry modules to process images with an increasing number of tiles. Your GPU memory will likely also be used by other applications on your system. However, in contrast to system memory, your GPU is not able to take advantage of swap files and it is impossible for darktable to know how much memory is available at a given time. If this parameter is set too high, darktable could be forced to fall back to CPU processing (which will be significantly slower but stable and with correctly processed data) or darktable might crash and even make your system unusable. For this reason, the GPU memory parameter fraction also includes an extra 600MB of headroom in an attempt to avoid over-allocation of memory. For example, on a GPU with 6GB of memory, darktable will use approximately (6 - 0.6) * 700 / 1024, or 3.5GB of GPU RAM when using the resource_default level.
+
+

In addition to the resource levels presented in the UI the following options can be set via the command-line (e.g. darktable --conf resourcelevel="notebook"). These modes are designed for debugging tiling issues and testing performance of common systems on larger development machines. The following options are provided:

+
    +
  • “mini” (1GB ram, 2MB single buffer, 128MB thumbnail cache, 200MB OpenCL memory)
  • +
  • “notebook” (4GB ram, 32MB single buffer, 512MB thumbnail cache, 1GB OpenCL memory)
  • +
  • “reference” (8GB ram, 32MB single buffer, 512MB thumbnail cache, 2GB OpenCL memory)
  • +
+

🔗tuning GPU memory usage

+

If you want to make maximal use of your GPU memory for OpenCL, you have three options:

+
    +
  • Choose the “large” resource level. For a 6GB card, this will use approximately 5GB of GPU memory, leaving 1GB for the rest of your system. (recommended)
  • +
  • Alter darktablerc to increase the last number (the OpenCL memory fraction) for your selected resource level. For example, increasing the OpenCL memory fraction to 950 would increase the available memory on a 6GB GPU to approximately 5.3GB. (absolutely not recommended)
  • +
  • Set preferences > processing > OpenCL > use all device memory to “on”, which will use all of your device’s memory, less a 600MB headroom. Please see the section below for “per device setting” of headroom.
  • +
+

🔗balanced OpenCL versus CPU tiling

+

In most cases, running a processing module on a high-powered GPU (the OpenCL codepath) is significantly faster than running the same module using the CPU codepath. However, many users have fast multi-core CPUs with a large amount of system RAM, but a GPU with significantly lower capabilities (typically, integrated graphics with small amounts of dedicated memory). Use of OpenCL code in these cases can lead to excessive tiling, and it is often better to run a module without tiling using the CPU codepath than to attempt to use OpenCL with heavy tiling.

+

While processing the pipeline, darktable attempts to determine which mode will be best for a given module by estimating the expected workloads for both OpenCL and CPU codepaths. In most cases it will prefer the OpenCL codepath even if that would mean tiling the image, since OpenCL is typically much faster than running the CPU code (often as much as 10 times faster if it is a dedicated card).

+

If the ratio of estimated workloads (CPU vs GPU) is larger than the advantage hint (see below), darktable will use the CPU for processing that module, else it will use the GPU.

+

🔗device-specific OpenCL configuration

+

The default darktable settings deliver a reasonable GPU performance on most systems. However, if you want to try to optimize things further, this section describes the relevant configuration parameters (all of which are set in your darktablerc file).

+

Most of the OpenCL-related options are managed with a “per device” strategy. The configuration parameter for each device looks like:

+

cldevice_v5_nvidiacudaquadrortx4000=0 250 0 16 16 128 0 0 0.000 0.000 0.500

+

or, more generally

+

cldevice_version_canonicalname=a b c d e f g h i j k

+

An entry will be automatically created in darktablerc for each newly-detected device when you launch darktable for the first time, with the correct canonical device name and version number. The parameters a - k are defined as follows and can be manually edited:

+
+
a. avoid atomics
+
1 = avoid atomics; 0 = use atomics (default)
+
Atomic operations in OpenCL are a special method of data synchronization and are only used in a few modules. Unfortunately, some old AMD/ATI devices are extremely slow in processing atomics and, on these cards, it is better to process the affected modules on the CPU rather than accepting an ultra-slow GPU codepath. Set this parameter to 1 if you experience slow processing within modules like shadows and highlights, monochrome, local contrast, or global tonemap (deprecated) or if you get intermittent system freezes. Please note that this should not affect any card manufactured since 2015.
+
b. micro nap
+
default 250
+
In an ideal case you will keep your GPU busy at 100% when processing the pixelpipe. However, if your GPU is also required to update your screen, and darktable is using it at 100%, there may not be sufficient time left for this task. This will usually manifest as jerky GUI updates on panning, zooming or when moving sliders. To resolve this issue darktable can add small pauses into its pixelpipe processing so that the GPU can catch its breath and perform GUI related activities. The “micro nap” parameter controls the duration of these pauses in microseconds.
+
+

On all current systems you are safe with the default value. If you are using multiple devices or you are not using your discrete GPU for drawing on your screen, this value can be set to 0 for all non-desktop devices leading to improved performance.

+
+
c. pinned memory
+
0 = disable pinned transfer (default); 1 = enforce pinned transfer
+
During tiling huge amounts of memory need to be transferred between host and device. On some devices direct memory transfers to and from an arbitrary host memory region may give a large performance penalty. This is especially noticeable when exporting large images on smaller graphics cards or while using newer modules like diffuse or sharpen or the guided laplacians mode in the highlight reconstruction module.
+
+

There is no safe method or general rule to predict whether or not this parameter will provide a performance benefit, so you will have to experiment for yourself. However, the chance of pinned transfer leading to an improvement is pretty low if your card was manufactured after 2015.

+
+
d. clroundup wh / e. clroundup ht
+
These parameters should be left at this default value – testing has not shown any benefit to using other values.
+
f. number of event handles
+
default 128
+
Event handles are used by darktable to monitor the success/failure of kernels and provide profiling info even if the pixelpipe is executed asynchronously. The number of event handles is a limited resource of your OpenCL driver – while they can be recycled, there is a limited number that can be used at the same time. Unfortunately, there is no way to find out what the resource limits are for a given device (this is due to darktable using the OpenCL V.1.2 API to support all platforms), so darktable uses a conservative guess of 128 by default. On most current devices and drivers you can expect a number of up to 1024 to be safe (for sure if your driver / card reports OpenCL V.2.0 or larger) leading to a slightly better OpenCL performance. If your driver runs out of free handles you will experience failing OpenCL kernels with error message CL_OUT_OF_RESOURCES or even crashes or system freezes. (If you are running into this problem, please open a github issue)
+
+

A value of 0 will block darktable from using any event handles. This will prevent darktable from properly monitoring the success of your OpenCL kernels but saves some driver overhead leading to a slightly better performance (less than 5%). The consequence is that all failures will lead to garbled output without darktable noticing. This is only recommended if you know for sure that your system runs rock-solid.

+
+
g. asynchronous mode
+
1 = use asynchronous mode; 0 = don’t use (default)
+
This flag controls how often darktable blocks the OpenCL pixelpipe to get a status on success/failure of the kernels that have been run. For optimum latency set this to 1, so that darktable runs the pixelpipe asynchronously and tries to use as few interrupts/events as possible. If you experience OpenCL errors like failing kernels, reset the parameter to 0. This will cause darktable to interrupt after each module so that you can more easily isolate any problems. Issues have been reported with some older AMD/ATI cards (like the HD57xx) which can produce garbled output if this parameter is set to 1. If in doubt, leave it at its default of 0.
+
h. disable device
+
0 = enable device; 1 = disable device
+
If darktable detects a malfunctioning device it will automatically mark it as such by setting this parameter to 1. If you have a device that reports a lot of errors you can manually disable it by setting this field to 1. If darktable has disabled the device but you are sure it should be used you can re-enable it by setting this field to 0.
+
+

i. reserved

+
+
j. advantage hint
+
This defines the advantage hint described in the balanced OpenCL versus CPU tiling section. If you have a fast graphics card with plenty of memory you can safely leave this at its default value of 0.000. However, if you want to adapt this number to your own system, you should use the following process:
+
+
    +
  1. Start darktable with the tiling debug option (darktable -d tiling) and start editing an image in the darkroom. Open the highlight reconstruction module and use the “guided laplacians” method, setting the “diameter of reconstruction” to a high value, while ensuring that tiling does not occur (check the debug information in your terminal session while adjusting the slider).
  2. +
  3. Check the execution times of this module with OpenCL on and off (by running darktable -d perf to examine the performance).
  4. +
  5. Set the “advantage hint option” to approximately (CPU execution time / GPU execution time).
  6. +
+
+
k. shared memory fraction
+
Some OpenCL devices don’t have dedicated memory but share it with the CPU – Apple ARM silicon is one example but also onboard devices from Intel, AMD or ARM SOCs. As we want to keep system memory available for caching or CPU codepaths we restrict the amount of all memory used to the given fraction. So with the default of 0.5 and an Apple computer with 16GB of system RAM, OpenCL would be able to make use of 8GB.
+
+
+

Note: if darktable detects a “buggy” device configuration key it will be rewritten back to default values.

+
+

🔗id-specific OpenCL configuration

+

A second device-specific configuration key is also provided, which takes into account both the device name and the device id (in case you have two identical devices). In this case, the usual key name cldevice_version_canonicalname is followed by _idX with X being the device id. For example, if the above example device was referred to as device 0, the second configuration setting would (by default) be cldevice_v5_quadrortx4000_id0=600.

+

This configuration key currently only has a single parameter defined:

+
+
forced headroom (default 600)
+
The amount of memory (in MB) that will not be used by darktable during OpenCL processing. This setting is only valid if you set preferences > processing > OpenCL > use all device memory to “on”.
+
+

If you are certain that no apps (or your OS) make use of the specific device you can set this parameter to 0 for the otherwise-unused device so that darktable will use all of that device’s memory.

+
+
+

The default of 600MB should be fine for most systems. If you find you run into performance problems due to darktable falling back to CPU, try changing it to 800 or larger.

+
+
+

🔗other configuration keys

+

The following additional configuration keys are also available in darktablerc:

+
+
cldevice_version_canonicalname_building
+
This option is used when compiling OpenCL kernels and may be provided for performance tuning or to work around bugs. You must remove any existing kernels in order to recompile them with the new options. Provide an empty string to recompile without any options. Remove the setting entirely to recompile with default options, default is -cl-fast-relaxed-math for nvidia drivers, all other cards don’t have this compiler option set.
+
The -cl-fast-relaxed-math option significantly improves performance but changes maths in the module’s processing code possibly leading to different results. For current Intel implementations this compiler flag leads to visibly wrong results, on AMD cards the results are non-conclusive. Some card/driver combinations are fine, some are not. As the AMD drivers constantly change we don’t recommend to use it on AMD cards.
+
opencl_mandatory_timeout
+
default 400
+
If darktable wants to make use of any OpenCL device it has to reserve it for further usage. If that device is current used darktable will wait up to opencl_mandatory_timeout * 5ms before it does a fallback to CPU. Increase this value if you would prefer to use OpenCL (because your card is really fast and your CPU is not).
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/midi-device-support/index.html b/en/special-topics/midi-device-support/index.html new file mode 100644 index 0000000000..8b993cdee5 --- /dev/null +++ b/en/special-topics/midi-device-support/index.html @@ -0,0 +1,3064 @@ + + + + + +darktable user manual - midi device support + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Special Topics / midi device support + +
+ + + + +
+ +

+ midi device support +

+ + + +

🔗introduction

+

MIDI is a communication protocol used by many electronic musical instruments (“pianos”), digital audio studio equipment (“control surfaces”) and even dedicated “photo editing keyboards” like the Loupedeck/Loupedeck+ (but not their later products). Such devices commonly feature sets of keys/buttons and sometimes encoders (knobs/rotors) and faders (sliders). Buttons sometimes feature lights, which makes them ideal for toggling features in darktable, because the lights can reflect the current (on/off) status. Encoders and faders are ideal for use with on-screen sliders in processing modules. They can be “endless” (without a start/end point and without any markings on the knob) allowing greater than 360 degrees rotation, and they may be motorized. This is helpful when switching between images or points in the editing history since the “physical” position of the encoders/faders always corresponds to the on-screen position. You may also find a ring of LEDs around an encoder that indicates its current value.

+

🔗endless encoders; absolute / relative encoding

+

Besides their physical features, these devices are often highly configurable in how they send data. Encoders can send their “absolute” position when they are turned, as a value in the range 0-127. Darktable will send back the current position of the on-screen slider, which a ring of LEDs would show (if present) or a motorized fader would respond to (by moving the knob). If the encoder is endless, it can also be used at different speeds and higher resolution than just the 128 steps, with either many rotations or less than a full rotation required to move the on-screen slider between extremes.

+

Endless encoders without ring lights might send relative movements which can be accelerated when turning quickly. Different encoding modes can be used, and the device might come with software to configure these options. It is important that all encoders use the same settings and send on the same “channel” as the keys (ideally the first: 0 or 1). By default darktable tries to figure out which channel and encoding is used by listening to the first five messages. After starting a session you should slowly turn a knob left/down so that 5 identical one-step-down messages are sent. If this fails the input system can be reset (by pressing Ctrl+Alt+Shift+i) for another try. On success, a toast message will be shown in the middle of the screen displaying the discovered encoding mode – 127 (“2s Complement”) and 63 (“Relative Offset”) are common.

+

🔗usage

+

If your device has been successfully configured and connected, you should see messages like “G#–1 (8) not assigned” when you press a button (the first is a musical notation code for the “tone”, the second a numerical representation) or “CC1,up not assigned” when adjusting an encoder. You are now ready to assign buttons and encoders to actions. The easiest way to do this for a bunch of them in one go is to press the visual shortcut mapping button (to the left of the preferences button) to enter shortcut visual mapping mode. In this mode, when you hover the mouse over a button or slider, if you then press a key or turn an encoder on the MIDI device, it gets assigned as a shortcut to that widget. You can immediately test it (while staying in mapping mode) by moving the mouse to the middle of the screen (so you don’t accidentally assign it to a different widget) and then repeating the action. Right-click to switch off mapping mode.

+

You might also want to assign buttons to duplicate the Ctrl and Shift key functions. For this, you need the full shortcuts dialog (right-click on the shortcuts button or open preferences and go to the shortcuts tab). In the top (“action”) list, double-click on “global/modifiers”. Now press the MIDI button you want to assign to Shift. Double click on “global/modifiers” again, but this time after assigning a button change the element for the newly created shortcut in the bottom list from “shift” to “ctrl”. Now you can use your MIDI device together with your mouse to access most of the functionality in darktable. After ticking “enable fallbacks” in the shortcuts dialog, holding Ctrl while turning an encoder will slow it down by a factor 10, whereas holding Shift speeds it up.

+

Several devices produced by Behringer have LEDs in a circle around their encoder knobs. These use different patterns depending on what slider or combobox they are assigned to:

+
    +
  • If the slider goes from -1 to +1, only the middle LED will be lit at zero. Moving negative will gradually light up the left side, moving positive will light the right side.
  • +
  • If the slider goes from 0-100%, you’ll see more LEDs coming on when moving right, until they are all lit at 100%.
  • +
  • Other numeric values will use 1 or 2 LEDs to indicate intermediate values.
  • +
  • Dropdowns will use 1 LED for the options that fit on the first turn of the dial and 2 on the second turn.
  • +
+

🔗troubleshooting and configuration

+

If you don’t see any “not assigned” toast at the top of your screen when pressing keys or turning knobs, you’ll want to test if any other MIDI applications can see the device. Under Linux you’ll need to have Alsa installed. After plugging in the device, dmesg should show lines like these:

+
usb 1-1: new full-speed USB device number 2 using xhci_hcd
+...
+mc: Linux media interface: v0.10
+usbcore: registered new interface driver snd-usb-audio
+

Darktable uses the simple cross-platform layer PortMidi to access the underlying OS API (Alsa, Core Midi, WinMM). If you are self-compiling, make sure you have included this library.

+

Starting darktable with the debug parameters -d input will give additional information. It should try to open up to 10 MIDI devices in the order it finds them. On the command line you might see something like this:

+
[midi_open_devices] opened midi device 'Arturia BeatStep' via 'MMSystem' as midi0
+[midi_open_devices] opened midi device 'BCR2000' via 'MMSystem' as midi1
+[midi_open_devices] opened midi device 'X-TOUCH MINI' via 'MMSystem' as midi2
+

Two issues can arise:

+
    +
  • a device you don’t want to use might be opened anyway (and potentially cause inappropriate behavior, like starting a fireworks show prematurely – see this document); or
  • +
  • devices might appear in a different order at the next startup (for example because they are plugged into a different usb port). Since configurations are stored with the device number only, reordering would cause an incorrect layout to be picked up.
  • +
+

You can fix which devices to load in a specific location and which ones to skip using the configuration parameter preferences > miscellaneous > interface > order or exclude midi devices. To skip loading the BCR2000 in the above example and to fix the other two devices into the number 0 and 2 slots, you could set this config parameter to “BeatStep;dontuse;X-TOUCH;-BCR2000”. This would leave the BeatStep as device midi0, always leave midi1 unused and would not load the BCR2000 at all, but if any other devices are connected, they would appear as midi3, midi4 and so on. Adding “;-” at the end would prevent any further devices loading.

+

If you just specify the configuration parameter as a single minus sign “-”, no devices will be loaded at all.

+

For devices that use relative encoding as mentioned above, you’d have to perform the slow-turn-left procedure on every start-up, or add the found encoding to the configuration string. For example “Loupedeck:127”.

+

Some MIDI controllers have keys with a light beneath them. These can be used to toggle settings and show the current position by having the light on or off. For this to work, darktable checks periodically (a few times a second) whether, say, the position of an on-screen toggle button has been changed, and sends messages to any linked MIDI device buttons to switch their light on or off. But if an unknown device has unintentionally been connected, this could be undesirable. So by default darktable waits until a “note” message is received from a MIDI button before sending any “note” light on/off messages back for that (and any lower numbered) button. That way no more buttons are addressed than exist on the device. If you immediately want all button lights to be used (rather than having to press the highest note once for each session) you can specify the number of buttons in the “order or exclude MIDI devices” preference, for example, “BeatStep:63:16”.

+

🔗supported devices

+

The shortcut mapping system has been most extensively tested with the Behringer devices and contains custom code to deal with their specific features. All other devices are treated as “generic midi” and may or may not work (well). If you succeed in getting a MIDI device up and running that hasn’t been mentioned below, it would be greatly appreciated if you would provide feedback in order to assist others, if any special steps are required. You could do this either by submitting a documentation pull request to amend this page or by filing an issue containing the necessary information.

+

🔗Behringer X-touch Mini / Compact

+

These devices should be in Standard Mode (not MC). Layers A & B are somewhat supported, however, since the device does not send a notification when switching between layers, and since lights (both under buttons and the pattern used around the rotors) are set based on which layer darktable believes is active, everything will only be updated completely after you press or turn something in the “new” layer. Default settings are assumed; if any have been changed they can be restored using this X-Touch Editor

+

🔗Behringer BCR2000 / BCF2000

+

These machines are highly configurable so there are many settings that could complicate the interaction with darktable’s MIDI module. The BC Manager tool (available for Windows and MacOS) can be used to configure them. The easiest thing to do is to reset all encoders and buttons to their simplest settings, which can be done (for the BCR2000) using this file. You can send it to the machine with BC Manager or (under Linux) with amidi. There’s also a global setting called “Deadtime” that determines how long the BCR ignores arriving messages after sending out updates. This is to avoid feedback loops, but for darktable it means that it blocks the adjustments sent back immediately after each rotor move. So Deadtime needs to be set to 0.

+

🔗Arturia Beatstep

+

Individual rotors can be configured to send absolute (0-127) values or changes (+/- 1,2,3,… in different encodings). The recommended setting is Relative #1 for all knobs with Knob Acceleration set to Slow (Off) or Medium. Then put the string BeatStep:63:16 in preferences > miscellaneous > interface > order or exclude midi devices. This can be configured with Midi Control Center, available for Windows or MacOS.

+

🔗Loupedeck / Loupedeck+

+

Put the string Loupedeck:127 in “preferences > miscellaneous > interface > order or exclude midi devices”.

+

@jenshannoschwalm has provided a layout that can be imported in the shortcuts dialog/tab. It can be found, with documentation, here https://github.com/darktable-org/darktable/pull/12829#issuecomment-1320264833

+

🔗Korg nanoKONTROL2

+

The device should be configured first using the Korg Kontrol Editor application to be in the CC mode and every button should be set to the Note type and Momentary button behavior. To control the lights in the buttons the LED mode should be set to External. It is important to note that the Track and the Marker buttons do not have leds in them.

+

There is a Kontrol Editor profile available here, which can be loaded using the Windows application to directly configure all these settings to correctly work with darktable.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/activate-opencl/index.html b/en/special-topics/opencl/activate-opencl/index.html new file mode 100644 index 0000000000..d590715f5e --- /dev/null +++ b/en/special-topics/opencl/activate-opencl/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - activating OpenCL in darktable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / activating OpenCL in darktable + +
+ + + + +
+ +

+ activating OpenCL in darktable +

+ + + +

Using OpenCL in darktable requires that your PC is equipped with a suitable graphics card and that it has the required libraries in place. Most modern graphics cards from NVIDIA, Intel or AMD come with full OpenCL support. The OpenCL compiler is normally shipped as part of the proprietary graphics driver and is used as a dynamic library called libOpenCL.so. This library must be in a folder where it can be found by your system’s dynamic linker.

+

When darktable starts, it will first try to find and load libOpenCL.so and – on success – checks if the available graphics card comes with OpenCL support. A minimally-sufficient amount of graphics memory (1GB+) needs to be available for darktable to take advantage of the GPU. If that check passes, darktable tries to setup its OpenCL environment: a processing context needs to be initialized, a calculation pipeline to be started, OpenCL source code files (extension is .cl) needs to be read and compiled and the included routines (OpenCL kernels) need to be prepared for darktable’s modules. If all of that completes successfully, the preparation is complete.

+

By default, OpenCL support is activated in darktable if all the above steps were successful. If you want to de-activate it you can do so in preferences > processing > OpenCL. This configuration parameter is grayed out if the OpenCL initialization failed.

+

You can switch OpenCL support off and on at any time without requiring a restart. Depending on the type of modules you are using, you will notice the effect as a general speed-up during interactive work and export. Most modules in darktable can take advantage of OpenCL but not all modules are demanding enough to make a noticeable difference. In order to feel a real difference, use modules like diffuse or sharpen, and denoise (profiled).

+

If you are interested in profiling statistics, you can start darktable with command line parameters -d opencl -d perf. After each run of the pixelpipe you will be shown details of processing time for each module plus an even more fine-grained profile for all used OpenCL kernels.

+

Apart from the speed-up you should not see any difference in the results between CPU and GPU processing. Except for some rounding errors, the results are designed to be identical. If, for some reason, darktable fails to properly finish a GPU calculation, it will normally detect the failure and automatically (and transparently) fall back to CPU processing.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/background/index.html b/en/special-topics/opencl/background/index.html new file mode 100644 index 0000000000..9314974b77 --- /dev/null +++ b/en/special-topics/opencl/background/index.html @@ -0,0 +1,3021 @@ + + + + + +darktable user manual - the background + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / the background + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ the background +

+ + + +

Processing high resolution images is a demanding task requiring a modern computer. In terms of both memory and CPU power, getting the best out of a typical 15, 20 or 25 megapixel image can quickly take your computer to its limits.

+

darktable’s requirements are no exception. All calculations are performed on 4 x 32bit floating point numbers. This is slower than “ordinary” 8 or 16 bit integer algebra, but eliminates all problems of tonal breaks or loss of information.

+

A great deal of optimization has been undertaken to make darktable as fast as possible. If you run a current version of darktable on a modern computer, you might not notice any “slowness”. However, there are conditions and certain modules where you will feel (or hear from the howling of your CPU fan) how much your poor multi-core processor has to struggle.

+

That’s where OpenCL comes in. OpenCL allows darktable to take advantage of the enormous power of modern graphics cards. Gamers’ demand for highly detailed 3D worlds in modern shooters (as well as cryptocurrency mining) has fostered rapid GPU development. AMD, NVIDIA and Co had to put enormous processing power into their GPUs to meet these demands. The result is modern graphics cards with highly parallelized GPUs that can quickly calculate surfaces and textures at high frame rates.

+

You are not a gamer and you don’t take advantage of that power? Well, then you should at least use it in darktable! For the task of highly parallel floating point calculations modern GPUs are much faster than CPUs. This is especially true when you want to repeat the same few processing steps millions of times. Typical use case: processing high megapixel images.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/how-opencl-works/index.html b/en/special-topics/opencl/how-opencl-works/index.html new file mode 100644 index 0000000000..2b75a8c8eb --- /dev/null +++ b/en/special-topics/opencl/how-opencl-works/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - how OpenCL works + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / how OpenCL works + +
+ + + + +
+ +

+ how OpenCL works +

+ + + +

As you can imagine, the hardware architecture of GPUs can vary significantly. There are different manufacturers, and even different generations of GPUs from the same manufacturer may not be comparable. At the same time GPU manufacturers don’t normally disclose all the hardware details of their products to the public. One of the consequences of this is the need to use proprietary drivers under Linux, if you want to take full advantage of your graphics card.

+

Fortunately an industry consortium lead by The Khronos Group has developed an open, standardized interface called OpenCL, which allows your GPU to be used as a numerical processing device. OpenCL offers a C99-like programming language with a strong focus on parallel computing. An application that wants to use OpenCL will need OpenCL source code that it hands over to a hardware-specific compiler at run-time. This way applications can use OpenCL on different GPU architectures (even at the same time). All of the hardware “secrets” are hidden in this compiler and are normally not visible to the user (or the application). The compiled OpenCL code is loaded onto your GPU and – with certain API calls – it is ready to perform calculations for you.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/index.html b/en/special-topics/opencl/index.html new file mode 100644 index 0000000000..cc24ec89be --- /dev/null +++ b/en/special-topics/opencl/index.html @@ -0,0 +1,3065 @@ + + + + + +darktable user manual - OpenCL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/index.xml b/en/special-topics/opencl/index.xml new file mode 100644 index 0000000000..ff022f3051 --- /dev/null +++ b/en/special-topics/opencl/index.xml @@ -0,0 +1,67 @@ + + + + OpenCL on darktable user manual + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/ + Recent content in OpenCL on darktable user manual + Hugo + en + + + the background + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/background/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/background/ + Processing high resolution images is a demanding task requiring a modern computer. In terms of both memory and CPU power, getting the best out of a typical 15, 20 or 25 megapixel image can quickly take your computer to its limits. darktable&rsquo;s requirements are no exception. All calculations are performed on 4 x 32bit floating point numbers. This is slower than “ordinary” 8 or 16 bit integer algebra, but eliminates all problems of tonal breaks or loss of information. + + + how OpenCL works + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/how-opencl-works/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/how-opencl-works/ + As you can imagine, the hardware architecture of GPUs can vary significantly. There are different manufacturers, and even different generations of GPUs from the same manufacturer may not be comparable. At the same time GPU manufacturers don&rsquo;t normally disclose all the hardware details of their products to the public. One of the consequences of this is the need to use proprietary drivers under Linux, if you want to take full advantage of your graphics card. + + + activating OpenCL in darktable + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/activate-opencl/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/activate-opencl/ + Using OpenCL in darktable requires that your PC is equipped with a suitable graphics card and that it has the required libraries in place. Most modern graphics cards from NVIDIA, Intel or AMD come with full OpenCL support. The OpenCL compiler is normally shipped as part of the proprietary graphics driver and is used as a dynamic library called libOpenCL.so. This library must be in a folder where it can be found by your system&rsquo;s dynamic linker. + + + setting up OpenCL + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/setting-up/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/setting-up/ + The huge diversity of systems and the marked differences between OpenCL vendors and driver versions makes it impossible to give an comprehensive overview of how to setup OpenCL. We only can give you an example, in this case for NVIDIA driver version 542.29.06 on Fedora 39. We hope that this will serve as a basic introduction and will help you to solve any problems specific to your setup. The principle OpenCL function flow is like this: + + + possible problems & solutions + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/problems-solutions/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/problems-solutions/ + darktable will detect OpenCL run-time errors automatically. On detecting an error, it will then reprocess everything on the CPU. While this will slow down processing it should not affect the end result. There can be various reasons why OpenCL might fail during the initialization phase. OpenCL depends on hardware requirements and on the presence of certain drivers and libraries. In addition all these have to fit in terms of maker, model and revision number. + + + scheduling profile + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/scheduling-profile/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/scheduling-profile/ + darktable can use the CPU and one or several OpenCL capable GPUs. Depending on the relative performance of these devices, users can choose among certain scheduling profiles to optimize performance. This is achieved by setting the configuration parameter preferences &gt; processing &gt; OpenCL &gt; OpenCL scheduling profile, which offers the following choices: default If an OpenCL-capable GPU is found darktable uses it for processing the center image view while the navigation preview window is processed on the CPU in parallel. + + + multiple devices + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/multiple-devices/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/multiple-devices/ + The scheduling of OpenCL devices can be optimized on most systems using the “OpenCL scheduling profile” settings. However, if your system is equipped with more than one GPU, you might want to set the relative device priority manually. To do this you need to select the “default” scheduling profile and change the settings in the “opencl_device_priority” configuration parameter. It is important to understand how darktable uses OpenCL devices. Each processing sequence of an image &ndash; to convert an input to the final output using a history stack &ndash; is run in a pixelpipe. + + + OpenCL still does not run for me + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/still-doesnt-work/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/opencl/still-doesnt-work/ + As has been mentioned, OpenCL systems come with a huge variety of setups: different GPU manufacturers and models, varying amounts of GPU memory, different drivers, different distributions etc.. Many of the potential problems will only appear with very specific combinations of these factors. As the darktable developers only have access to a small fraction of these variations, please understand that we might not be able to fix your specific problem. There is not much we can do if we are unable to reproduce your issue. + + + diff --git a/en/special-topics/opencl/multiple-devices/index.html b/en/special-topics/opencl/multiple-devices/index.html new file mode 100644 index 0000000000..a79b495792 --- /dev/null +++ b/en/special-topics/opencl/multiple-devices/index.html @@ -0,0 +1,3042 @@ + + + + + +darktable user manual - multiple devices + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / multiple devices + +
+ + + + +
+ +

+ multiple devices +

+ + + +

The scheduling of OpenCL devices can be optimized on most systems using the “OpenCL scheduling profile” settings. However, if your system is equipped with more than one GPU, you might want to set the relative device priority manually. To do this you need to select the “default” scheduling profile and change the settings in the “opencl_device_priority” configuration parameter.

+

It is important to understand how darktable uses OpenCL devices. Each processing sequence of an image – to convert an input to the final output using a history stack – is run in a pixelpipe. There are five different types of pixelpipe in darktable. One type is responsible for processing the center image view (or full view) in darkroom mode, another pixelpipe processes the preview image (navigation window, also required for histograms and more internal stuff relevant for correct output of the full view). Another preview pixelpipe would be required for showing a second darkroom window. There can be one of each of these three pixelpipes running at any time, with the full and preview pixelpipes running in parallel. In addition there can be multiple parallel pixelpipes performing file exports as well as multiple parallel pixelpipes generating thumbnails. If an OpenCL device is available, darktable dynamically allocates it to one specific pixelpipe for one run and releases it afterwards.

+

The computational demand varies significantly depending on the type of pixelpipe being executed. The preview image and thumbnails are low resolution and can be processed quickly, whereas processing the center image view or the second window is more demanding. A full export pixelpipe is more demanding still.

+

The configuration parameter “opencl_device_priority” holds a string with the following structure:

+

a,b,c.../d,e,f.../g,h,i.../j,k,l...,m,n,o...

+

Each letter represents one specific OpenCL device. There are five fields in the parameter string separated by a slash, each representing one type of pixelpipe. a,b,c... defines the devices that are allowed to process the center image (full) pixelpipe. Likewise devices d,e,f... can process the preview pixelpipe, devices g,h,i... the export pixelpipes, devices j,k,l... the thumbnail pixelpipes and finally devices m,n,o... preview pixelpipe for the second window. An empty field means that no OpenCL device may serve this type of pixelpipe.

+

darktable has an internal numbering system, whereby the first available OpenCL device receives the number 0. All further devices are numbered consecutively. This number, together with the device name, is displayed when you start darktable with darktable -d opencl. You can specify a device either by number or by its canonical name (upper/lower case and whitespace do not matter). If you have more than one device with the same name you need to use the device numbers in order to differentiate them.

+

A device specifier can be prefixed with an exclamation mark !, in which case the device is excluded from processing a given pixelpipe. You can also use an asterisk * as a wildcard, representing all devices not previously explicitly mentioned in that group.

+

Sequence order within a group matters – darktable will read the list from left to right and whenever it tries to allocate an OpenCL device to a pixelpipe it will scan the devices in that order, taking the first free device it finds.

+

If a pixelpipe process is about to be started and all GPUs in the corresponding group are busy, darktable automatically processes the image on the CPU by default. You can enforce GPU processing by prefixing the list of allowed GPUs with a plus sign +. In this case darktable will not use the CPU but rather suspend processing until the next permitted OpenCL device is available.

+

darktable’s default setting for “opencl_device_priority” is */!0,*/*/*/!0,*.

+

Any detected OpenCL device is permitted to process the center view image. The first OpenCL device (0) is not permitted to process both preview pixelpipes. As a consequence, if there is only one GPU available on your system, the preview pixelpipes will always be processed on the CPU, keeping your single GPU exclusively for the more demanding center image view. This is a reasonable setting for most systems. No such restrictions apply to export and thumbnail pixelpipes.

+

The default is a good choice if you have only one device. If you have several devices it forms a reasonable starting point. However, as your devices might have quite different levels of processing power, it makes sense to invest some time optimizing your priority list.

+

Here is an example. Let’s assume we have a system with two devices, a fast Nvidia Quadro RTX 4000 and a slower GeForce GTX 1050. darktable (started with darktable -d opencl) will report the following devices:

+
[opencl_init] successfully initialized.
+[opencl_init] here are the internal numbers and names of
+                          OpenCL devices available to darktable:
+[opencl_init]           0       'NVIDIA GeForce GTX 1050'
+[opencl_init]           1       'NVIDIA CUDA Quadro RTX 4000'
+[opencl_init] FINALLY: opencl is AVAILABLE on this system.
+

with the canonical names shown above as nvidiagforcegtx1050 and nvidiacudaquadrortx4000

+

Here, the GeForce GTX 1050 is detected as the first device and the Quadro RTX 4000 as the second. This order will normally not change unless the hardware or driver configuration is modified, but it’s better to use device names rather than numbers to be on the safe side.

+

As the GTX 1050 is slower than the RTX 4000, an optimized “opencl_device_priority” could look like:

+

!nvidiagforcegtx1050,*/!nvidiacudaquadrortx4000,*/nvidiacudaquadrortx4000,*/nvidiacudaquadrortx4000,*/!nvidiacudaquadrortx4000.

+

The GTX 1050 is explicitly excluded from processing the center image pixelpipe; this is reserved to “all” other devices (i.e. the RTX 4000). Conversely – for the preview pixelpipes – the RTX 4000, so that only the GTX 1050 is permitted to do the work.

+

For file export and thumbnail generation we want all hands on deck. However, darktable should first check whether the RTX 4000 device is free, because it’s faster. If it is not free, then all other devices – in fact only the GTX 1050 – are checked.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/problems-solutions/index.html b/en/special-topics/opencl/problems-solutions/index.html new file mode 100644 index 0000000000..879a302d4b --- /dev/null +++ b/en/special-topics/opencl/problems-solutions/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - possible problems & solutions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / possible problems & solutions + +
+ + + + +
+ +

+ possible problems & solutions +

+ + + +

darktable will detect OpenCL run-time errors automatically. On detecting an error, it will then reprocess everything on the CPU. While this will slow down processing it should not affect the end result.

+

There can be various reasons why OpenCL might fail during the initialization phase. OpenCL depends on hardware requirements and on the presence of certain drivers and libraries. In addition all these have to fit in terms of maker, model and revision number. If anything does not fit (e.g. your graphics driver – loaded as a kernel module – does not match the version of your libOpenCL.so) OpenCL support will likely not be available.

+

In this case, the best thing to do is start darktable from a console with darktable -d opencl.

+

This will give additional debugging output about the initialization and use of OpenCL. First, if you find a line that starts with [opencl_init] FINALLY ... that should tell you whether OpenCL support is available for you or not. If initialization failed, look at the messages above for anything that reads like could not be detected or could not be created. Check if there is a hint about where it failed.

+

Here are a few cases that have been observed in the past:

+
    +
  • +

    darktable states that no OpenCL aware graphics card is detected or that the available memory on your GPU is too low and the device is discarded. In that case you might need to buy a new card if you really want OpenCL support.

    +
  • +
  • +

    darktable finds your libOpenCL.so but then tell you that it couldn’t get a platform. NVIDIA drivers will often give error code -1001 in this case. This happens because libOpenCL.so is only a wrapper library. For the real work further vendor-specific libraries need to be loaded. This has failed for some reason. There is a structure of files in /etc/OpenCL on your system that libOpenCL.so consults to find these libraries. See if you can find something fishy in there and try to fix it. Often the required libraries cannot be found by your system’s dynamic loader. Giving full path names might help.

    +
  • +
  • +

    darktable states that a context could not be created. This often indicates a version mismatch between the loaded graphics driver and libOpenCL. Check if you have left-over kernel modules or graphics libraries from an older installation and take appropriate action. When in doubt, perform a clean reinstall of your graphics driver. Sometimes, immediately after a driver update, the loaded kernel driver does not match the newly installed libraries. In this case reboot your system before trying again.

    +
  • +
  • +

    darktable crashes during startup. This can happen if your OpenCL setup is completely broken or if your driver/library contains a severe bug. If you can’t fix it, you can still use darktable with option --disable-opencl, which will skip the entire OpenCL initialization step.

    +
  • +
  • +

    darktable fails to compile its OpenCL source files at run-time. In this case you will see a number of error messages looking like typical compiler errors. This could indicate an incompatibility between your OpenCL implementation and darktable’s interpretation of the standard. In that case please raise an issue on github and we will try to assist. Please also report if you see significant differences between CPU and GPU processing of an image.

    +
  • +
  • +

    you have installed a number of OpenCL drivers meant for the same hardware, this will always lead to severe problems and must strictly be avoided. On Windows systems you often have the Microsoft OpenCLon12 driver installed via the OpenCL Compatibility Pack. Inspect and check at preferences > processing > OpenCL.

    +
  • +
  • +

    A few emulated-on-CPU implementations of OpenCL also exist, coming as drivers provided by INTEL or AMD. We have observed that they do not provide any speed gain versus the compiler-optimized CPU code. Therefore darktable simply discards these drivers / devices by default.

    +
  • +
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/scheduling-profile/index.html b/en/special-topics/opencl/scheduling-profile/index.html new file mode 100644 index 0000000000..5800589d5a --- /dev/null +++ b/en/special-topics/opencl/scheduling-profile/index.html @@ -0,0 +1,3026 @@ + + + + + +darktable user manual - scheduling profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / scheduling profile + +
+ + + + +
+ +

+ scheduling profile +

+ + + +

darktable can use the CPU and one or several OpenCL capable GPUs. Depending on the relative performance of these devices, users can choose among certain scheduling profiles to optimize performance. This is achieved by setting the configuration parameter preferences > processing > OpenCL > OpenCL scheduling profile, which offers the following choices:

+
+
default
+
If an OpenCL-capable GPU is found darktable uses it for processing the center image view while the navigation preview window is processed on the CPU in parallel. This is the preferred setting for systems with a reasonably fast CPU and a moderately fast GPU. The exact allocation of devices to the various pixelpipe types can be finetuned with the “opencl_device_priority” configuration parameter (see multiple devices).
+
very fast GPU
+
With this scheduling profile darktable processes the center image view and the preview window on the GPU sequentially. This is the preferred setting for systems with a GPU that strongly outperforms the CPU.
+
multiple GPUs
+
This setting addresses systems with multiple GPUs whose relative performance do not differ significantly. Whenever a processing job is started darktable uses any currently idle GPU but not the CPU. Users of systems with a variety of GPUs will need better control on their relative priority. They would be better off selecting the “default” profile and fine-tuning their system with the “opencl_device_priority” configuration parameter (see multiple devices).
+
+

On first start-up or after any detected change in the GPU configuration of your system darktable tries to identify the best suited profile for you. You can change it at any time in preferences > processing > OpenCL.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/setting-up/index.html b/en/special-topics/opencl/setting-up/index.html new file mode 100644 index 0000000000..41b240f49a --- /dev/null +++ b/en/special-topics/opencl/setting-up/index.html @@ -0,0 +1,3050 @@ + + + + + +darktable user manual - setting up OpenCL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / setting up OpenCL + +
+ + + + +
+ +

+ setting up OpenCL +

+ + + +

The huge diversity of systems and the marked differences between OpenCL vendors and driver versions makes it impossible to give an comprehensive overview of how to setup OpenCL. We only can give you an example, in this case for NVIDIA driver version 542.29.06 on Fedora 39. We hope that this will serve as a basic introduction and will help you to solve any problems specific to your setup.

+

The principle OpenCL function flow is like this:

+

darktable > libOpenCL.so > libnvidia-opencl.so.1 > kernel driver module(s) > GPU

+
    +
  • +

    darktable dynamically loads libOpenCL.so – a system library that must be accessible to the system’s dynamic loader (ld.so).

    +
  • +
  • +

    libOpenCL.so reads the vendor-specific information file (/etc/OpenCL/vendors/nvidia.icd) to find the library that contains the vendor-specific OpenCL implementation.

    +
  • +
  • +

    The vendor-specific OpenCL implementation comes as a library libnvidia-opencl.so.1 (which in our case is a symbolic link to libnvidia-opencl.so.545.29.06).

    +
  • +
  • +

    libnvidia-opencl.so.1 needs to talk to the vendor-specific kernel modules nvidia and nvidia_uvm via device special files /dev/nvidia0, /dev/nvidiactl, and /dev/nvidia-uvm.

    +
  • +
+

At system startup the required device special files (/dev/nvidia*) need to be created. If this does not happen on your system by default, the easiest way to set them up and make sure all modules are loaded is by installing the nvidia-modprobe package.

+

A user account that needs to make use of OpenCL from within darktable must have read/write access to NVIDIA’s device special files. On some systems these files allow world read-write access by default, which avoids permission issues but might be debatable in terms of system security. Other systems restrict the access to a user group, e.g. “video”. In this case your user account has to be member of that group.

+

To summarise, the packages that needed to be installed in this specific case were:

+
xorg-x11-drv-nvidia
+xorg-x11-drv-nvidia-libs
+xorg-x11-drv-nvidia-cuda
+xorg-x11-drv-nvidia-cuda-libs
+xorg-x11-drv-nvidia-power
+akmod-nvidia
+nvidia-settings
+nvidia-modprobe
+nvidia-persistenced
+opencl-headers
+opencl-filesystem
+ocl-icd
+ocd-icd-devel
+

On Linux systems you might also want the clinfo package giving you a lot of information about your OpenCL system and settings.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/opencl/still-doesnt-work/index.html b/en/special-topics/opencl/still-doesnt-work/index.html new file mode 100644 index 0000000000..e3e7392f65 --- /dev/null +++ b/en/special-topics/opencl/still-doesnt-work/index.html @@ -0,0 +1,3022 @@ + + + + + +darktable user manual - OpenCL still does not run for me + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / OpenCL / OpenCL still does not run for me + +
+ + + + +
+ +

+ OpenCL still does not run for me +

+ + + +

As has been mentioned, OpenCL systems come with a huge variety of setups: different GPU manufacturers and models, varying amounts of GPU memory, different drivers, different distributions etc..

+

Many of the potential problems will only appear with very specific combinations of these factors. As the darktable developers only have access to a small fraction of these variations, please understand that we might not be able to fix your specific problem. There is not much we can do if we are unable to reproduce your issue.

+

If you are having issues with a specific device (and you have other OpenCL devices available) the first thing to do would be to try disabling just that device – see memory & performance tuning for more information.

+

If nothing else helps, the best option is probably to start darktable with

+

darktable --disable-opencl

+

In the end there is nothing in darktable that only runs on GPU. Don’t let the lack of OpenCL discourage you – darktable’s CPU code is also highly optimized for performance!

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/darktable-chart/index.html b/en/special-topics/program-invocation/darktable-chart/index.html new file mode 100644 index 0000000000..6adfc3bbc1 --- /dev/null +++ b/en/special-topics/program-invocation/darktable-chart/index.html @@ -0,0 +1,3049 @@ + + + + + +darktable user manual - darktable-chart + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / darktable-chart + +
+ + + + +
+ +

+ darktable-chart +

+ + + +

The darktable-chart binary is a dedicated utility to create styles out of pairs of images such as RAW+JPEG with in-camera processing. Details about its usage can be found in the using darktable-chart section.

+

darktable-chart can either start a GUI or be used as a command-line program.

+
darktable-chart
+              [--help]
+              [<input Lab pfm file>]
+              [<cht file>]
+              [<reference cgats/it8 or Lab pfm file>]
+

All parameters are optional, however, if you want to supply the second file name you also need to supply the first one. Starting darktable-chart this way opens a special GUI (details can be found in the using darktable-chart section).

+
+
--help
+
Provide usage information and terminate.
+
<input Lab pfm file>
+
Open the utility with the given file as source image. The input file needs to be in Lab Portable Float Map format.
+
<cht file>
+
Specify a chart file describing the layout of the used color reference chart.
+
<reference cgats/it8 or Lab pfm file>
+
Specify the reference values, either as measured values according to the CGATS standard, or as a reference image in Lab Portable Float Map format.
+
+

Alternatively darktable-chart can be used as a command line program to generate darktable style files using previously saved CSV files.

+
darktable-chart
+              --csv
+              <csv file>
+              <number patches>
+              <output dtstyle file>
+

All parameters are mandatory.

+
+
<csv file>
+
A CSV file previously saved from within darktable-chart.
+
<number of patches>
+
The number of color patches to be used in the color look up table settings of the created style.
+
<output dtstyle file>
+
The name of the style file to be created.
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/darktable-cli/index.html b/en/special-topics/program-invocation/darktable-cli/index.html new file mode 100644 index 0000000000..2e87c444a0 --- /dev/null +++ b/en/special-topics/program-invocation/darktable-cli/index.html @@ -0,0 +1,3319 @@ + + + + + +darktable user manual - darktable-cli + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / darktable-cli + +
+ + + + +
+ +

+ darktable-cli +

+ + + +

The darktable-cli binary starts the command line interface variant of darktable which allows images to be exported.

+

This variant does not open any display – it works in pure console mode without launching a GUI. This mode is particularly useful for servers running background jobs.

+

darktable-cli can be called with the following command line parameters:

+
darktable-cli [<input file or folder>]
+              [<xmp file>]
+              <output file or folder>
+              [--width <max width>]
+              [--height <max height>]
+              [--hq <0|1|true|false>]
+              [--upscale <0|1|true|false>]
+              [--style <style name>]
+              [--style-overwrite]
+              [--apply-custom-presets <0|1|false|true>]
+              [--out-ext <extension>]
+              [--import <file or dir>]
+              [--icc-type <type>]
+              [--icc-file <file>]
+              [--icc-intent <intent>]
+              [--verbose]
+              [--help [option]]
+              [--core <darktable options>]
+

The user must supply an input filename and an output filename. All other parameters are optional.

+
+
<input file or folder>
+
The name of the input file or folder (containing images) to be exported. If you wish to process multiple images or multiple folders use the --import option instead.
+
<xmp file>
+
The optional name of an XMP sidecar file containing the history stack data to be applied during export. If this option is not provided darktable will search for an XMP file that belongs to the given input file(s).
+
<output file or folder>
+
The name of the output file or destination folder. The export file format is derived from the file extension or from the --out-ext option. You can also use a number of variables in the output filename. For obvious reasons this parameter is mandatory if you use the program on an image folder containing multiple images. If you specify output folder it is recommended that you also specify the file format with --out-ext.
+
--width <max width>
+
Limit the width of the exported image to the given number of pixels.
+
--height <max height>
+
Limit the height of the exported image to the given number of pixels.
+
--hq <0|1|true|false>
+
Define whether to use high quality resampling during export (see the export module reference for more details). Defaults to true.
+
--upscale <0|1|true|false>
+
Define whether allow upscaling during export. Defaults to false.
+
--style <style name>
+
Specify the name of a style to be applied during export. If a style is specified, the path to the darktable configuration directory must also be specified (i.e. --core --configdir ~/.config/darktable). By default no style is applied.
+
--style-overwrite
+
The specified style overwrites the history stack instead of being appended to it.
+
--apply-custom-presets <0|1|false|true>
+
Whether to load data.db which contains presets and styles. Disabling this option allows you to run multiple instances of darktable-cli at the cost of being unable to use the --style option. Defaults to true.
+
--out-ext <extension>
+
Set the export file format to use derived from the extension (jpg, tif, jxl). If specified takes precedence over <output file>. By default this is extracted from <output file>. Defaults to jpg if <output folder> is specified. Note: the extension used in the export filename is predetermined by the export format and not adjustable.
+
--import <file or dir>
+
Specify input file or folder, can be used multiple times. This option cannot be combined with <input file or folder>.
+
--icc-type <type>
+
Specify the ICC profile type, which is the same as specifying the “output profile” in the output color profile module. Defaults to “image specified”. Use --help icc-type to obtain a list of the supported types. See the output color profile module reference for a more detailed description of the available options.
+
--icc-file <file>
+
Specify the ICC profile filename. Defaults to an empty filename.
+
--icc-intent <intent>
+
Specify the rendering intent. Defaults to “image specified”. Use --help icc-intent to obtain a list of the supported intents. See rendering intent for a more detailed description of the available options.
+
--verbose
+
Enables verbose output.
+
--help [option]
+
Prints usage and exits. If option is specified, additionally prints usage for the given option.
+
--core <darktable options>
+
All command line parameters following --core are passed to the darktable core and handled as standard parameters. See the darktable binary section for a detailed description.
+
+

🔗export options

+

Export options for darktable are defined as configuration items, set from within the export module. There are two ways to alter this configuration when using darktable-cli, as described below.

+

🔗use the export module

+

The darktable-cli command will use the last format configuration used in the export module, when run in interactive (gui) mode. You may therefore manually set your desired format options in the darktable gui and then run darktable-cli to export your files.

+

🔗pass options on the command-line

+

You can set any export format configuration option using the following syntax:

+
    --core --conf plugins/imageio/format/<FORMAT>/<OPTION>=<VALUE>
+

where <FORMAT> is the name of the desired output format and <OPTION> is any configuration option for that format.

+

An option set in this way will not be permanently stored but will be used just for this run of darktable-cli.

+

The following sections describe the configuration options/values that are available for each export format:

+

🔗jpeg

+
+
quality
+
The compression quality (5 - 100)
+
+

🔗j2k (jpg2000)

+
+
format
+
The format of the output
+
    +
  • 0: J2K
  • +
+
+
    +
  • 1: jp2
  • +
+
+
quality
+
The compression quality (5 - 100)
+
preset
+
The DCP mode
+
    +
  • 0: Cinema2K, 24 FPS
  • +
+
+
    +
  • 1: Cinema2K, 48 FPS
  • +
+
+
    +
  • 2: Cinema4K, 24 FPS
  • +
+
+
+

🔗exr (OpenEXR)

+
+
bpp
+
The bit depth (16 or 32)
+
compression
+
The compression type
+
    +
  • 0: uncompressed
  • +
+
+
    +
  • 1: RLE
  • +
+
+
    +
  • 2: ZIPS
  • +
+
+
    +
  • 3: ZIP
  • +
+
+
    +
  • 4: PIZ
  • +
+
+
    +
  • 5: PXR24
  • +
+
+
    +
  • 6: B44
  • +
+
+
    +
  • 7: DWAA
  • +
+
+
    +
  • 8: DWAB
  • +
+
+
+

🔗pdf

+
+
title
+
The title of the pdf (any character)
+
size
+
The size of the pdf (a4, a3, letter, legal)
+
orientation
+
the paper orientation of the pdf
+
    +
  • 0: portrait
  • +
+
+
    +
  • 1: landscape
  • +
+
+
border
+
The empty space around the pdf; format: size (a number) + unit; examples: 10 mm, 1 inch
+
dpi
+
The resolution in dots per inch inside the pdf (1 - 5000)
+
rotate
+
Whether to rotate the pdf (0 or 1)
+
icc
+
Whether to embed an icc profile (0 or 1)
+
bpp
+
The bit depth (8 or 16)
+
compression
+
Whether to compress the pdf (0 or 1)
+
mode
+
The mode to put the images in the pdf
+
    +
  • 0: normal: just put the images into the pdf
  • +
+
+
    +
  • 1: draft: images are replaced with boxes
  • +
+
+
    +
  • 2: debug: only show the outlines and bounding boxen
  • +
+
+
+

🔗pfm

+

No options provided.

+

🔗png

+
+
bpp
+
The bit depth (8 or 16)
+
compression
+
The compression level (0 - 9)
+
+

🔗ppm

+

No options provided.

+

🔗tiff

+
+
bpp
+
The bit depth (8, 16, 32)
+
compress
+
The compression type
+
    +
  • 0: uncompressed
  • +
+
+
    +
  • 1: deflate
  • +
+
+
    +
  • 2: deflate with predictor
  • +
+
+
compresslevel
+
The compression level (0 - 9)
+
shortfile
+
B&W or color image
+
    +
  • 0: write rgb colors
  • +
+
+
    +
  • 1: write grayscale
  • +
+
+
+

🔗webp

+
+
comp_type
+
The compression type
+
    +
  • 0: lossy
  • +
+
+
    +
  • 1: lossless
  • +
+
+
quality
+
the compression quality (5 - 100)
+
hint
+
The preferred way to manage the compression
+
    +
  • 0: default
  • +
+
+
    +
  • 1: picture: digital picture, like portrait, inner shot
  • +
+
+
    +
  • 2: photo: outdoor photograph, with natural lighting
  • +
+
+
    +
  • 3: graphic: discrete tone image (graph, map-tile etc)
  • +
+
+
+

🔗copy

+

No options provided.

+

🔗xcf

+
+
bpp
+
The bit depth (8, 16, 32)
+
+

🔗JXL

+
+
bpp
+
The bit depth (8, 10, 12, 16, 32)
+
pixel_type
+
Boolean whether the (16 bit) pixel type is unsigned integer or floating point
+
    +
  • 0: unsigned integer
  • +
+
+
    +
  • 1: floating point
  • +
+
+
quality
+
Integer (4-100): the quality of the image, roughly corresponding to JPEG quality (100 is lossless)
+
original
+
Boolean whether to encode using the original color profile or the internal XYB one
+
    +
  • 0: internal
  • +
+
+
    +
  • 1: original
  • +
+
+
effort
+
Integer between 1-9. Effort with which to encode output; higher is slower (default is 7)
+
tier
+
Integer between 0-4. Higher value favors decoding speed vs quality (default is 0)
+
+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/darktable-cltest/index.html b/en/special-topics/program-invocation/darktable-cltest/index.html new file mode 100644 index 0000000000..ed2635ea22 --- /dev/null +++ b/en/special-topics/program-invocation/darktable-cltest/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - darktable-cltest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / darktable-cltest + +
+ +
+ + +
+ + +
+ +

+ darktable-cltest +

+ + + +

The darktable-cltest binary checks if there is a usable OpenCL environment on your system that darktable can use. It emits some debug output that is equivalent to calling darktable -d opencl and then terminates.

+

darktable-cltest is called without command line parameters.

+ + + +
+ +
+ + +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/darktable-cmstest/index.html b/en/special-topics/program-invocation/darktable-cmstest/index.html new file mode 100644 index 0000000000..ef00ae29fc --- /dev/null +++ b/en/special-topics/program-invocation/darktable-cmstest/index.html @@ -0,0 +1,3018 @@ + + + + + +darktable user manual - darktable-cmstest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / darktable-cmstest + +
+ + + + +
+ +

+ darktable-cmstest +

+ + + +

The darktable-cmstest binary (Linux only) investigates whether the color management subsystem of your computer is correctly configured and displays some useful information about the installed monitor profile(s).

+

darktable-cmstest is called without command line parameters.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/darktable-generate-cache/index.html b/en/special-topics/program-invocation/darktable-generate-cache/index.html new file mode 100644 index 0000000000..03de264bac --- /dev/null +++ b/en/special-topics/program-invocation/darktable-generate-cache/index.html @@ -0,0 +1,3037 @@ + + + + + +darktable user manual - darktable-generate-cache + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / darktable-generate-cache + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ darktable-generate-cache +

+ + + +

The darktable-generate-cache binary updates darktable’s thumbnail cache. Invoke this program to generate all missing thumbnails in the background when your computer is idle.

+

darktable-generate-cache can be called with the following command line parameters:

+
darktable-generate-cache
+              [-h, --help]
+              [--version]
+              [--min-mip <0-8>] [-m, --max-mip <0-8>]
+              [--min-imgid <N>] [--max-imgid <N>]
+              [--core <darktable options>]
+

All parameters are optional. If started without parameters darktable-generate-cache uses reasonable defaults.

+
+
-h, --help
+
Display usage information and terminate.
+
--version
+
Display copyright and version information and terminate.
+
--min-mip <0-8>, -m, --max-mip <0-8>
+
darktable can store thumbnails with up to eight different resolution steps for each image. These parameters define the maximum resolution to be generated (defaults to a range of 0-2). There is normally no need to generate all possible resolutions here – missing ones will be automatically generated by darktable the moment they are needed. When asked to generate multiple resolutions at once, the lower-resolution images are quickly downsampled from the highest-resolution image.
+
--min-imgid <N>, --max-imgid <N>
+
Specifies the range of internal image IDs from the database to work on. If no range is given, darktable-generate-cache will process all images.
+
--core <darktable options>
+
All command line parameters following --core are passed to the darktable core and handled as standard parameters. See the darktable binary section for a detailed description.
+
+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/darktable/index.html b/en/special-topics/program-invocation/darktable/index.html new file mode 100644 index 0000000000..d4567f3cbc --- /dev/null +++ b/en/special-topics/program-invocation/darktable/index.html @@ -0,0 +1,3084 @@ + + + + + +darktable user manual - darktable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / darktable + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ darktable +

+ + + +

The darktable binary starts darktable with its GUI and full functionality. This is the standard way to use darktable.

+

darktable can called with the following command line parameters:

+
darktable [-d {all,act_on,cache,camctl,camsupport,common,control,
+               dev,expose,fswatch,imageio,input,ioporder,lighttable,lua,
+               masks,memory,nan,opencl,params,perf,pipe,print,pwstorage,
+               signal,sql,tiling,undo,verbose}]
+          [--d-signal <signal>]
+          [--d-signal-act <all,raise,connect,disconnect,print-trace>]
+          [--disable-pipecache]
+          [<input file>|<image folder>]
+          [--version]
+          [--disable-opencl]
+          [--configdir <user config directory>]
+          [--library <library file>]
+          [--datadir <data directory>]
+          [--moduledir <module directory>]
+          [--tmpdir <tmp directory>]
+          [--cachedir <user cache directory>]
+          [--localedir <locale directory>]
+          [--luacmd <lua command>]
+          [--noiseprofiles <noiseprofiles json file>]
+          [--conf <key>=<value>]
+          [-t <num openmp threads>]
+

All parameters are optional. In most cases darktable should be started without any additional parameters, in which case darktable uses suitable defaults.

+
+
-d {all,act_on,cache,camctl,camsupport,common,control,dev,expose,fswatch,imageio,input,ioporder,lighttable,lua,masks,memory,nan,opencl,params,perf,pipe,print,pwstorage,signal,sql,tiling,undo,verbose}
+
Enable debug output to the terminal. There are several subsystems of darktable and each of them can be debugged separately. You can use this option multiple times if you want to debug more than one subsystem (e.g. darktable -d opencl -d camctl) or debug all of them at once (with -d all). The -d common switch is provided to give information about most relevant subsystems while debugging darktable or if you want to provide a log for reporting a darktable issue. Some debug options (like -d opencl) can also provide more verbose output, which can be invoked with the additional option -d verbose. The verbose option must be explicitly provided, even when using -d all.
+
--d-signal <signal>
+
If -d signal or -d all is specified, specify the signal to debug using this option. Specify ALL to debug all signals or specify signal using it’s full name. Can be used multiple times.
+
--d-signal-act <all,raise,connect,disconnect,print-trace>
+
If -d signal or -d all is specified, specify the signal action to debug using this option.
+
--disable-pipecache
+
Disable the pixelpipe cache. This option allows only two cachelines per pipe, and should be used for debugging purposes only.
+
<input file>|<image folder>
+
Optionally supply the name of an image file or folder. If a filename is given darktable starts in darkroom view with that file opened. If a folder is given darktable starts in lighttable view with the content of that folder as the current collection.
+
--version
+
Print the darktable version number, a copyright notice, some other useful information, and then terminate.
+
--disable-opencl
+
Prevent darktable from initializing the OpenCL subsystem. Use this option if darktable crashes at startup due to a defective OpenCL implementation.
+
--configdir <config directory>
+
Define the directory where darktable stores user-specific configuration. The default location is $HOME/.config/darktable/.
+
--library <library file>
+
darktable keeps image information in an sqlite database for fast access. The default location of that database file is file name library.db in the directory specified by --configdir or defaulted to $HOME/.config/darktable/. Use this option to provide an alternative location (e.g. if you want to do some experiments without compromising your original library.db). If the database file does not exist, darktable creates it for you. You may also provide :memory: as the library file, in which case the database is kept in system memory – all changes are discarded when darktable terminates.
+
+

Whenever darktable starts, it will lock the library to the current user. It does this by writing the current process identifier (PID) into a lock file <library file>.lock next to the library specified. If darktable finds an existing lock file for the library, it will terminate immediately.

+
+
--datadir <data directory>
+
Define the directory where darktable finds its runtime data. The default location depends on your installation. Typical locations are /opt/darktable/share/darktable/ and /usr/share/darktable/.
+
--moduledir <module directory>
+
darktable has a modular structure and organizes its modules as shared libraries for loading at runtime. This option tells darktable where to look for its shared libraries. The default location depends on your installation. Typical locations are /opt/darktable/lib64/darktable/ and /usr/lib64/darktable/.
+
--tmpdir <tmp directory>
+
Define where darktable should store its temporary files. If this option is not supplied darktable uses the system default.
+
--cachedir <cache directory>
+
darktable keeps a cache of image thumbnails for fast image preview and precompiled OpenCL binaries for fast startup. By default the cache is located in $HOME/.cache/darktable/. Multiple thumbnail caches may exist in parallel – one for each library file.
+
--localedir <locale directory>
+
Define where darktable can find its language-specific text strings. The default location depends on your installation. Typical locations are /opt/darktable/share/locale/ and /usr/share/locale/.
+
--luacmd <lua command>
+
A string containing lua commands to execute after lua initialization. These commands will be run after your “luarc” file.
+
If lua is not compiled-in, this option will be accepted but won’t do anything.
+
--noiseprofiles <noiseprofiles json file>
+
Provide a json file that contains camera-specific noise profiles. The default location depends on your installation. Typical locations are /opt/darktable/share/darktable/noiseprofile.json and /usr/share/darktable/noiseprofile.json.
+
--conf <key>=<value>
+
darktable supports a rich set of configuration parameters defined by the user in file darktablerc, located in the directory specified by --configdir or defaulted to $HOME/.config/darktable/. You may temporarily overwrite individual settings on the command line with this option – these settings will not be stored in darktablerc on exit.
+
-t <num openmp threads>
+
limit number of openmp threads to use in openmp parallel sections.
+
--dump-pfm MODULE_A,MODULE_B, --dump-pipe MODULE_A,MODULE_B, --dumpdir DIR
+
These options are provided for debugging darktable’s internal processing pipeline. For example, if called with --dump-pfm demosaic darktable will dump the input and output of the demosaic module as pfm files. By default the location of these files is defined by the operating system – some temporary folder reported in the log output – but you can also explicitly define it via the --dumpdir option.
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/index.html b/en/special-topics/program-invocation/index.html new file mode 100644 index 0000000000..ca03884400 --- /dev/null +++ b/en/special-topics/program-invocation/index.html @@ -0,0 +1,3058 @@ + + + + + +darktable user manual - program invocation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+ + +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/program-invocation/index.xml b/en/special-topics/program-invocation/index.xml new file mode 100644 index 0000000000..1a422dd494 --- /dev/null +++ b/en/special-topics/program-invocation/index.xml @@ -0,0 +1,60 @@ + + + + program invocation on darktable user manual + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/ + Recent content in program invocation on darktable user manual + Hugo + en + + + darktable + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable/ + The darktable binary starts darktable with its GUI and full functionality. This is the standard way to use darktable. darktable can called with the following command line parameters: darktable [-d {all,act_on,cache,camctl,camsupport,common,control, dev,expose,fswatch,imageio,input,ioporder,lighttable,lua, masks,memory,nan,opencl,params,perf,pipe,print,pwstorage, signal,sql,tiling,undo,verbose}] [--d-signal &lt;signal&gt;] [--d-signal-act &lt;all,raise,connect,disconnect,print-trace&gt;] [--disable-pipecache] [&lt;input file&gt;|&lt;image folder&gt;] [--version] [--disable-opencl] [--configdir &lt;user config directory&gt;] [--library &lt;library file&gt;] [--datadir &lt;data directory&gt;] [--moduledir &lt;module directory&gt;] [--tmpdir &lt;tmp directory&gt;] [--cachedir &lt;user cache directory&gt;] [--localedir &lt;locale directory&gt;] [--luacmd &lt;lua command&gt;] [--noiseprofiles &lt;noiseprofiles json file&gt;] [--conf &lt;key&gt;=&lt;value&gt;] [-t &lt;num openmp threads&gt;] All parameters are optional. + + + darktable-cli + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cli/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cli/ + The darktable-cli binary starts the command line interface variant of darktable which allows images to be exported. This variant does not open any display &ndash; it works in pure console mode without launching a GUI. This mode is particularly useful for servers running background jobs. darktable-cli can be called with the following command line parameters: darktable-cli [&lt;input file or folder&gt;] [&lt;xmp file&gt;] &lt;output file or folder&gt; [--width &lt;max width&gt;] [--height &lt;max height&gt;] [--hq &lt;0|1|true|false&gt;] [--upscale &lt;0|1|true|false&gt;] [--style &lt;style name&gt;] [--style-overwrite] [--apply-custom-presets &lt;0|1|false|true&gt;] [--out-ext &lt;extension&gt;] [--import &lt;file or dir&gt;] [--icc-type &lt;type&gt;] [--icc-file &lt;file&gt;] [--icc-intent &lt;intent&gt;] [--verbose] [--help [option]] [--core &lt;darktable options&gt;] The user must supply an input filename and an output filename. + + + darktable-generate-cache + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-generate-cache/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-generate-cache/ + The darktable-generate-cache binary updates darktable&rsquo;s thumbnail cache. Invoke this program to generate all missing thumbnails in the background when your computer is idle. darktable-generate-cache can be called with the following command line parameters: darktable-generate-cache [-h, --help] [--version] [--min-mip &lt;0-8&gt;] [-m, --max-mip &lt;0-8&gt;] [--min-imgid &lt;N&gt;] [--max-imgid &lt;N&gt;] [--core &lt;darktable options&gt;] All parameters are optional. If started without parameters darktable-generate-cache uses reasonable defaults. -h, --help Display usage information and terminate. --version Display copyright and version information and terminate. + + + darktable-chart + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-chart/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-chart/ + The darktable-chart binary is a dedicated utility to create styles out of pairs of images such as RAW+JPEG with in-camera processing. Details about its usage can be found in the using darktable-chart section. darktable-chart can either start a GUI or be used as a command-line program. darktable-chart [--help] [&lt;input Lab pfm file&gt;] [&lt;cht file&gt;] [&lt;reference cgats/it8 or Lab pfm file&gt;] All parameters are optional, however, if you want to supply the second file name you also need to supply the first one. + + + darktable-cltest + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cltest/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cltest/ + The darktable-cltest binary checks if there is a usable OpenCL environment on your system that darktable can use. It emits some debug output that is equivalent to calling darktable -d opencl and then terminates. darktable-cltest is called without command line parameters. + + + darktable-cmstest + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cmstest/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/darktable-cmstest/ + The darktable-cmstest binary (Linux only) investigates whether the color management subsystem of your computer is correctly configured and displays some useful information about the installed monitor profile(s). darktable-cmstest is called without command line parameters. + + + purge_non_existing_images.sh + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/purge_non_existing_images_sh/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/special-topics/program-invocation/purge_non_existing_images_sh/ + Find and remove entries from the library database referencing images that no longer exist in the filesystem. You must close darktable before running this script. The script can be called with the following command line parameters: purge_non_existing_images.sh [-c|--configdir &lt;path&gt;] [-l|--library &lt;path&gt;] [-p|--purge] Run the script with no options to perform a &ldquo;dry run&rdquo;, which generates a report of the missing files without committing any changes to the database. The available options are: + + + diff --git a/en/special-topics/program-invocation/purge_non_existing_images_sh/index.html b/en/special-topics/program-invocation/purge_non_existing_images_sh/index.html new file mode 100644 index 0000000000..0dcd5cfc5d --- /dev/null +++ b/en/special-topics/program-invocation/purge_non_existing_images_sh/index.html @@ -0,0 +1,3048 @@ + + + + + +darktable user manual - purge_non_existing_images.sh + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + + +darktable / Special Topics / program invocation / purge_non_existing_images.sh + +
+ +
+ +
+ + + +
+
+ + +
+ +

+ purge_non_existing_images.sh +

+ + + +

Find and remove entries from the library database referencing images that no longer exist in the filesystem. You must close darktable before running this script.

+

The script can be called with the following command line parameters:

+
purge_non_existing_images.sh [-c|--configdir <path>]
+                             [-l|--library <path>]
+                             [-p|--purge]
+

Run the script with no options to perform a “dry run”, which generates a report of the missing files without committing any changes to the database.

+

The available options are:

+
+
-c|--configdir <path>
+
Specify the path to the darktable configuration directory to be used by the script. If this option is not provided, the default config directory location will be used.
+
-l|--library <path>
+
Specify the path to the library.db database file to be analysed by the script. If this option is not specified, the default library.db file location will be used.
+
-p|--purge
+
Actually delete any entries in the database that refer to non-existent files. If the option is not provided, a report will be printed without committing any changes to the database.
+
+
+

Notes:

+
    +
  1. +

    The script must be run in a unix shell, and the sqlite3 client must be available in the command search path. For Linux systems, this will normally not be an issue.

    +
  2. +
  3. +

    For Windows systems, you will normally need the MSYS2 environment to be installed, as described in the instructions for building darktable in a Windows environment. If you installed darktable using the standard Windows installer package, the location of the script would normally be something like: C:\Program Files\darktable\share\darktable\tools\purge_non_existing_images.sh.

    +
  4. +
  5. +

    For macOS systems, the Terminal application provides a shell, and the sqlite3 client is provided by the operating system by default. If darktable was installed using an application bundle from a dmg image, then the default location for the script would be /Applications/darktable.app/Contents/Resources/share/darktable/tools/purge_non_existing_images.sh

    +
  6. +
  7. +

    The delete operation can’t be undone. It is therefore strongly recommended that you take a backup of the database before purging any entries.

    +
  8. +
+
+ + + +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/translating/index.html b/en/special-topics/translating/index.html new file mode 100644 index 0000000000..6632a642eb --- /dev/null +++ b/en/special-topics/translating/index.html @@ -0,0 +1,3081 @@ + + + + + +darktable user manual - translating dtdocs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Special Topics / translating dtdocs + +
+ +
+ +
+ +
+
+ + +
+ +

+ translating dtdocs +

+ + + +

Translation of the darktable documentation is done via our Weblate instance.

+

You can either use Weblate’s web UI to translate the documentation or download the translation from Weblate to your computer, edit it, and then upload the changes.

+

Please do all translation work through Weblate. We will not accept pull requests directly on github to update PO files.

+

🔗Making a new branch in git

+
    +
  1. Make a new branch to work on it in git. +For example: +git checkout -b fr-translation-init
  2. +
+

🔗Adding a new language to Hugo

+
    +
  1. +

    In the files config.yaml and config-pdf.yaml, locate the languages: line.

    +
  2. +
  3. +

    Add the language you wish to translate. For example, the English looks like this:

    +
      en-us:
    +    title: darktable 3.4 user manual
    +    weight: 1
    +
  4. +
  5. +

    Save the files.

    +
  6. +
+

🔗Generating a PO file

+

Do the following steps if you want to update the POT and PO files from the markdown source.

+
    +
  1. Create an empty PO file for your language in the po folder with the file name content.<language>.po. +For example: +touch po/content.fr-fr.po
  2. +
  3. Run the script to populate the PO file: +cd tools/ && ./generate-translations.sh --no-translations
  4. +
+

🔗Generating translated files

+

Do the following steps to generate the website files from a translation.

+
    +
  1. Generate the translated files: +cd tools/ && ./generate-translations.sh --no-update.
  2. +
  3. Check the translation by starting hugo’s internal server: +hugo server
  4. +
  5. Open a web browser and check the changes. The URL is in the output of the hugo server command.
  6. +
  7. Remove the translated files, as we never check them into git: +cd tools/ && ./generate-translations.sh --rm-translations.
  8. +
+

🔗Translating website, epub, and PDF strings

+

There are two themes for the darktable documentation: one for the HTML website and one for the PDF. You’ll need to translate the strings for both.

+
    +
  1. Go to themes/hugo-darktable-docs-themes/i18n.
  2. +
  3. Copy content of the file en.yaml and name the new file <your language>.yaml.
  4. +
  5. Translate the content of the new yaml file.
  6. +
  7. Check the translated PO file into git, push it to github, and open a pull request to have your changes accepted.
  8. +
  9. Repeat the last four steps for the other themes, themes/hugo-darktable-docs-epub-theme and themes/hugo-darktable-docs-pdf-theme.
  10. +
+

🔗Integrating new translations from Weblate

+

The following assumes that you’re git working directory is clean, that you have API access to the Weblate instance, that you’ve configured the Weblate git repo as a remote in your local dtdocs git repo, and that wlc, the Weblate command line client, is configured.

+
    +
  1. Commit any changes in Weblate: wlc commit darktable/dtdocs
  2. +
  3. Lock the Weblate project to prevent further changes: wlc lock darktable/dtdocs
  4. +
  5. In your local dtdocs git repo, create a new branch: git checkout -b po-updates
  6. +
  7. Update the Weblate remote: git remote update weblate
  8. +
  9. Merge the Weblate changes into your locally created branch: git merge weblate/master
  10. +
  11. Squash all the Weblate commits, since there are so many: git reset $(git merge-base master $(git rev-parse --abbrev-ref HEAD))
  12. +
  13. Stage the changed PO files: git add -A
  14. +
  15. Commit the PO files: git commit -m "Updated with the PO files from weblate."
  16. +
  17. Update the POT and PO files: cd tools/ && ./generate-translations.sh --no-translations && cd ..
  18. +
  19. Stage the POT and PO files: git add -A
  20. +
  21. Commit the POT andPO files: git commit -m "Updated POT and PO files."
  22. +
  23. Create a Pull Request in Github.
  24. +
  25. After the Pull Request is accepted, reset the Weblate repo to match the dtdocs repo: wlc reset darktable/dtdocs
  26. +
+ + + +
+ +
+ +
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/special-topics/variables/index.html b/en/special-topics/variables/index.html new file mode 100644 index 0000000000..3e213afca0 --- /dev/null +++ b/en/special-topics/variables/index.html @@ -0,0 +1,3163 @@ + + + + + +darktable user manual - variables + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Special Topics / variables + +
+ + + + +
+ +

+ variables +

+ + + +

darktable supports variable substitution in a number of modules and preference settings. For example:

+ +

🔗available variables

+

The following variables are available, though they may not all be applicable in every context:

+
$(ROLL.NAME)               film roll of the input image
+$(FILE.FOLDER)             folder containing the input image
+$(FILE.NAME)               basename of the input image
+$(FILE.EXTENSION)          extension of the input image
+$(ID)                      the image id
+$(VERSION)                 the duplicate version number
+$(VERSION.IF_MULTI)        same as $(VERSION) but null string if only one version exists
+$(VERSION.NAME)            version name from metadata
+$(DARKTABLE.VERSION)       the version of the running darktable instance
+$(DARKTABLE.NAME)          name of darktable
+$(SEQUENCE[n,m])           a sequence number within an export job with n digits and starting with m
+                           parameters are optional, default is [4,1]
+$(WIDTH.SENSOR)            width of RAW data in pixels before RAW crop
+$(HEIGHT.SENSOR)           height of RAW data in pixels before RAW crop
+$(WIDTH.RAW)               width of RAW data in pixels after RAW crop
+$(HEIGHT.RAW)              height of RAW data in pixels after RAW crop
+$(WIDTH.CROP)              image width in pixels at the end of the pixelpipe, but before export resize
+$(HEIGHT.CROP)             image height in pixels at the end of the pixelpipe, but before export resize
+$(WIDTH.EXPORT)            image width in pixels at the end of the pixelpipe and after export resize
+$(HEIGHT.EXPORT)           image height in pixels at the end of the pixelpipe and after export resize
+$(WIDTH.MAX)               maximum width entered in export module
+$(HEIGHT.MAX)              maximum height entered in export module
+$(YEAR)                    year at date of import/export
+$(YEAR.SHORT)              two-digit year at date of import/export
+$(MONTH)                   numeric (1-12) month at date of import/export
+$(MONTH.LONG)              full month name at date of import/export
+$(MONTH.SHORT)             abbreviated month name at date of import/export
+$(DAY)                     day at date of import/export
+$(HOUR)                    hour at time of import/export
+$(MINUTE)                  minute at time of import/export
+$(SECOND)                  second at time of import/export
+$(MSEC)                    millisecond at time of import/export
+$(EXIF.YEAR)               Exif year
+$(EXIF.YEAR.SHORT)         Exif year, two-digit version
+$(EXIF.MONTH)              Exif month, numeric
+$(EXIF.MONTH.LONG)         Exif month, full name
+$(EXIF.MONTH.SHORT)        Exif month, abbreviated name
+$(EXIF.DAY)                Exif day
+$(EXIF.HOUR)               Exif hour
+$(EXIF.MINUTE)             Exif minute
+$(EXIF.SECOND)             Exif second
+$(EXIF.MSEC)               Exif millisecond
+$(EXIF.DATE.REGIONAL)      Exif date using user's preferred regional date format
+$(EXIF.TIME.REGIONAL)      Exif time using user's preferred regional date format
+$(EXIF.ISO)                Exif ISO value
+$(EXIF.EXPOSURE)           Exif exposure
+$(EXIF.EXPOSURE.BIAS)      Exif exposure bias
+$(EXIF.EXPOSURE.PROGRAM)   Exif exposure program set in camera
+$(EXIF.APERTURE)           Exif aperture
+$(EXIF.CROP_FACTOR)        Exif crop factor
+$(EXIF.FLASH)              Exif flash setting
+$(EXIF.FLASH.ICON)         flash symbol if Exif information says flash was fired, empty string if not
+$(EXIF.FOCAL.LENGTH)       Exif focal length
+$(EXIF.FOCAL.LENGTH.EQUIV) Exif 35 mm equivalent focal length
+$(EXIF.FOCUS.DISTANCE)     Exif focus distance
+$(EXIF.LENS)               Exif lens name
+$(EXIF.MAKER)              Exif camera maker
+$(EXIF.METERING)           Exif metering mode
+$(EXIF.MODEL)              Exif camera model
+$(EXIF.WHITEBALANCE)       Exif white balance set in camera
+$(IMAGE.EXIF)              basic exposure information from Exif data (aperture, exposure, ISO)
+$(IMAGE.ID)                the image id (note that this will be 0 during copy&import)
+$(IMAGE.ID[n])             the image id (note that this will be 0 during copy&import), zero-padded to n digits
+$(IMAGE.ID.NEXT)           the next image id to be assigned (can be used during copy&import)
+$(IMAGE.ID.NEXT[n])        the next image id to be assigned (can be used during copy&import), zero-padded to n digits
+$(IMAGE.TAGS)              tags list (Xmp.dc.Subject), with any hierarchy flattened
+$(IMAGE.TAGS.HIERARCHY)    tags list (Xmp.dc.Subject), preserving hierarchy
+$(LONGITUDE)               longitude
+$(LATITUDE)                latitude
+$(ELEVATION)               elevation
+$(GPS.ELEVATION)           elevation
+$(GPS.LATITUDE)            latitude
+$(GPS.LONGITUDE)           longitude
+$(GPS.LOCATION)            latitude, longitude, and elevation (omitting any values which are not set)
+$(GPS.LOCATION.ICON)       symbol to indicate that geolocation information is present, empty string if not
+$(STARS)                   star rating (text only)
+$(RATING.ICONS)            star rating (using star characters)
+$(LABELS)                  colorlabels (color labels as text)
+$(LABELS.ICONS)            colorlabels (color labels as icons)
+$(MAKER)                   camera maker
+$(MODEL)                   camera model
+$(LENS)                    lens
+$(TITLE)                   title from metadata
+$(DESCRIPTION)             description from metadata
+$(CREATOR)                 creator from metadata
+$(PUBLISHER)               publisher from metadata
+$(RIGHTS)                  rights from metadata
+$(TAGS)                    tags list (Xmp.dc.Subject)
+$(CATEGORY[n,category])    tag name of level n [0,9] of selected category (or tag)
+$(SIDECAR_TXT)             content of the text sidecar file (if any)
+$(FOLDER.PICTURES)         pictures folder
+$(FOLDER.HOME)             home folder
+$(FOLDER.DESKTOP)          desktop folder
+$(OPENCL.ACTIVATED)        whether OpenCL is activated
+$(USERNAME)                user name defined by OS
+$(NL)                      newline character
+$(JOBCODE)                 internal jobcode of current job
+

🔗string substitution

+

All of the variables support basic string substitution inspired by bash though some of the details differ.

+

All patterns are treated as simple string comparisons. There is no regex support.

+

The following string replacement functions are provided, where var is one of the variables listed above:

+
$(var-default)                   If var is empty, return "default"
+                                 It is possible to use another variable as "default", e.g.
+                                 $(WIDTH.CROP-$(WIDTH.RAW))
+
+$(var+alt_value)                 If var is set, return "alt_value" else return empty string
+
+$(var:offset)                    Return var starting from offset
+                                 If offset is negative count from the end of the string
+
+$(var:offset:length)             Starting from offset, return at most length characters of var
+                                 If offset is negative the length is counted from the end of var
+                                 If length is negative this indicates the end of the result,
+                                  counted from the end of var, and not an actual length
+
+$(var#pattern)                   Remove "pattern" from the start of var
+
+$(var%pattern)                   Remove "pattern" from the end of var
+
+$(var/pattern/replacement)       Replace the first occurrence of "pattern" in var with "replacement"
+                                 If "replacement" is empty then "pattern" will be removed
+
+$(var//pattern/replacement)      Replace all occurrences of "pattern" in var with "replacement"
+                                 If "replacement" is empty then "pattern" will be removed
+
+$(var/#pattern/replacement)      If var starts with "pattern then "pattern" is replaced with "replacement"
+
+$(var/%pattern/replacement)      If var ends with "pattern" then "pattern" is replaced with "replacement"
+
+$(var^)                          Make the first character of var uppercase
+
+$(var^^)                         Make all characters of var uppercase
+
+$(var,)                          Make the first character of var lowercase
+
+$(var,,)                         Make all characters of var lowercase
+

🔗formatting

+

The image information patterns support markup. For example, adding the following will provide a clear warning (large, red, bold text) when OpenCL has failed to initialise:

+

<span alpha='1%'>$(OPENCL_ACTIVATED/no/<span foreground='red' weight='heavy' size='xx-large' alpha='100%'>OPENCL ACTIVATION FAILED</span>$(NL))</span>

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tags/index.html b/en/tags/index.html new file mode 100644 index 0000000000..2ccde11b33 --- /dev/null +++ b/en/tags/index.html @@ -0,0 +1,3043 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Tags + +
+ +
+ +
+ +
+
+ + +
+ +

Tags

+ +
+ +
+ +
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tags/index.xml b/en/tags/index.xml new file mode 100644 index 0000000000..de8dd974c6 --- /dev/null +++ b/en/tags/index.xml @@ -0,0 +1,18 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/en/tags/ + Recent content in Tags on darktable user manual + Hugo + en + + + Rotate Orientation Basic-Module-Group + https://darktable-org.github.io/dtdocs/en/tags/rotate-orientation-basic-module-group/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tags/rotate-orientation-basic-module-group/ + + + + diff --git a/en/tags/rotate-orientation-basic-module-group/index.html b/en/tags/rotate-orientation-basic-module-group/index.html new file mode 100644 index 0000000000..5062bf537d --- /dev/null +++ b/en/tags/rotate-orientation-basic-module-group/index.html @@ -0,0 +1,3012 @@ + + + + + +darktable user manual - Rotate Orientation Basic-Module-Group + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + + +darktable / Tags / Rotate Orientation Basic-Module-Group + +
+ +
+ +
+ +
+
+ + +
+ +

Rotate Orientation Basic-Module-Group

+ +
+ +
+ +
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tags/rotate-orientation-basic-module-group/index.xml b/en/tags/rotate-orientation-basic-module-group/index.xml new file mode 100644 index 0000000000..c4d9673743 --- /dev/null +++ b/en/tags/rotate-orientation-basic-module-group/index.xml @@ -0,0 +1,18 @@ + + + + Rotate Orientation Basic-Module-Group on darktable user manual + https://darktable-org.github.io/dtdocs/en/tags/rotate-orientation-basic-module-group/ + Recent content in Rotate Orientation Basic-Module-Group on darktable user manual + Hugo + en + + + orientation + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/module-reference/processing-modules/orientation/ + Rotate the image 90 degrees at a time or flip the image horizontally and/or vertically. The module is enabled by default and the orientation (rotation) is automatically set based on the image&rsquo;s Exif data. The orientation can also be set using the actions on selection module in the lighttable view. 🔗module controls transform Double click the label to reset to the default transformations rotate counter-clockwise Rotate the image 90 degrees counter-clockwise rotate clockwise Rotate the image 90 degrees clockwise flip horizontally Flip the image (mirror) horizontally flip vertically Flip the image (mirror) vertically show guides Tick the box to show guide overlays whenever the module is activated. + + + diff --git a/en/tethering/examples/index.html b/en/tethering/examples/index.html new file mode 100644 index 0000000000..ffbbe2ac84 --- /dev/null +++ b/en/tethering/examples/index.html @@ -0,0 +1,3028 @@ + + + + + +darktable user manual - examples + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Tethering / examples + +
+ + + + +
+ +

+ examples +

+ + + +

The following sections show two typical use cases for the tethering view.

+

🔗studio setup with screening

+

This is a pretty common use case. You have your studio and subject set up, the camera is connected to your computer and tethering view is active in darktable. You work at the camera and take images. Whenever you like, you can review the images directly on your computer monitor instead of using the camera LCD.

+

This workflow is efficient and effective, since you can immediately review your captures instead of waiting until after the shoot when everyone is gone. If you’re shooting with a model this is a nice way to preview the captures with the client instead of fumbling around with your camera.

+

Working in the tethering view can save you time and aggravation. Set a session name, shoot your images, and they will be saved to the correct film roll for the session, for easy on-site review.

+

🔗capturing a timelapse

+

A timelapse is a video clip composed of images taken in a timed sequence. A typical example is to take a timelapse of a cityscape to capture the movement of the clouds and traffic etc.

+

To set up a timelapse capture, create a new session. Now decide whether you want to shoot in manual or auto mode. It is recommended that you only use auto mode in situations where the ambient light will change significantly during the time of the shoot, for example, when shooting a timelapse over 24 hours.

+

The camera settings module can be used to define the delay (the number of seconds between capture) and sequence (the number of images to capture) of your timelapse.

+

To start the timelapse click the capture button in the same panel and watch the filmstrip fill up with images. The last captured image is always displayed in the center view.

+

🔗storing images on the camera and computer

+

By default, the gphoto2 framework (used by darktable’s tethering feature) will only download images to your computer, and will not store them on the camera’s memory card. This setting can be changed outside of darktable by using the gphoto2 command line interface. However, there are cases where this method fails, as it requires that darktable use the same configuration file as the gphoto2 command line tool. In particular, if darktable or gphoto2 are installed within a sandbox or container that hides user account settings, you may face this issue (for example, with snap packages and similar).

+

To allow captured images to be retained on the camera’s memory card, connect the camera to your computer for a tethering session, but close darktable. Enter gphoto2 --set-config capturetarget=1 on the command line. If this command is successful, start darktable again. Thereafter, images should be stored (duplicated) on the camera’s memory card during a tethered capture.

+ + + +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tethering/index.html b/en/tethering/index.html new file mode 100644 index 0000000000..86770499fc --- /dev/null +++ b/en/tethering/index.html @@ -0,0 +1,3036 @@ + + + + + +darktable user manual - Tethering + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable / Tethering + +
+ +
+ +
+ + + +
+
+ + +
+ +

Tethering

+ +
+ +
+ +
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tethering/index.xml b/en/tethering/index.xml new file mode 100644 index 0000000000..29e7a96ea9 --- /dev/null +++ b/en/tethering/index.xml @@ -0,0 +1,39 @@ + + + + Tethering on darktable user manual + https://darktable-org.github.io/dtdocs/en/tethering/ + Recent content in Tethering on darktable user manual + Hugo + en + + + overview + https://darktable-org.github.io/dtdocs/en/tethering/overview/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/overview/ + The tethering view allows you to capture images directly into darktable from a connected camera. To use the tethering feature you first need to connect your camera to your PC using a USB cable. Your computer might ask to mount or view the connected camera. Do not mount or view the camera. If your camera is mounted or viewed automatically, you will need to “unmount/eject” the camera before darktable can access it. + + + tethering view layout + https://darktable-org.github.io/dtdocs/en/tethering/tethering-view-layout/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/tethering-view-layout/ + 🔗left panel image information Display image information. 🔗right panel From top to bottom: scopes A graphical depiction of the current image&rsquo;s light levels and colors. This module can be moved to the left-hand panel if desired (see preferences &gt; miscellaneous &gt; position of the scopes module). session Session settings. live view Live view settings. camera settings Camera settings. metadata editor Edit metadata for selected images. tagging Tag selected images. 🔗bottom panel From left to right: + + + examples + https://darktable-org.github.io/dtdocs/en/tethering/examples/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/examples/ + The following sections show two typical use cases for the tethering view. 🔗studio setup with screening This is a pretty common use case. You have your studio and subject set up, the camera is connected to your computer and tethering view is active in darktable. You work at the camera and take images. Whenever you like, you can review the images directly on your computer monitor instead of using the camera LCD. + + + troubleshooting + https://darktable-org.github.io/dtdocs/en/tethering/troubleshooting/ + Mon, 01 Jan 0001 00:00:00 +0000 + https://darktable-org.github.io/dtdocs/en/tethering/troubleshooting/ + This troubleshooting guide can be used to verify whether or not your camera can be used with tethering. This is done using the same (gphoto2) tool that darktable uses to interface with your camera. Before you start, you first need to find your camera port name. Usually the port &ldquo;usb:&rdquo; is sufficient and is therefore used in the following guide. 🔗is your camera detected? The following command will verify that your camera is connected to the computer and detected by gphoto2. + + + diff --git a/en/tethering/overview/index.html b/en/tethering/overview/index.html new file mode 100644 index 0000000000..aad009bafa --- /dev/null +++ b/en/tethering/overview/index.html @@ -0,0 +1,3023 @@ + + + + + +darktable user manual - overview + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Tethering / overview + +
+ +
+
+ + + +
+ +
+ + +
+ +

+ overview +

+ + + +

The tethering view allows you to capture images directly into darktable from a connected camera.

+

To use the tethering feature you first need to connect your camera to your PC using a USB cable. Your computer might ask to mount or view the connected camera. Do not mount or view the camera. If your camera is mounted or viewed automatically, you will need to “unmount/eject” the camera before darktable can access it. This unlocks the camera so that darktable can take control of it – darktable will then re-lock the camera so that it cannot be used by other applications.

+

After the USB cable is connected, go to the import module in the lighttable view. If your camera is available for use, a new section should appear in the import module containing the name of your camera and a “mount camera” button. Click this button to connect your camera and three additional buttons will appear: “copy & import from camera”, “tethered shoot” and “unmount camera”. Click “tethered shoot” to enter the tethering view. When you are finished, press the “unmount camera” button before physically disconnecting it.

+

darktable uses gphoto2 to interface with your camera. If you have problems finding the connected camera as described above, check the troubleshooting section in this chapter to verify that your camera has tethering support.

+

In the center view, images are shown while you capture them. You can capture an image by either using darktable’s user interface or by manually triggering a capture with your camera. If you are using Live View the image will be shown in darktable’s center view.

+

When entering tethering view, a film roll will be created using the same structure as defined for camera import (see preferences > import > session options). The job code will be predefined as “capture”.

+

If you want to group your captures into different film rolls, you should use the session module in the right-hand panel to set a different job code. When entering a new name and pressing Enter, a new film roll will be created and newly-captured images will be added into this new film roll.

+

darktable provides some useful tools to set up an image capture in the user interface. You can set up timelapse captures, brackets for HDR and even sequential captures of bracketed images. For more information read the documentation on the camera settings module and the examples later in this chapter.

+ + + +
+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tethering/tethering-view-layout/index.html b/en/tethering/tethering-view-layout/index.html new file mode 100644 index 0000000000..8c31c1967e --- /dev/null +++ b/en/tethering/tethering-view-layout/index.html @@ -0,0 +1,3044 @@ + + + + + +darktable user manual - tethering view layout + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Tethering / tethering view layout + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ tethering view layout +

+ + + +

🔗left panel

+
+
image information
+
Display image information.
+
+

🔗right panel

+

From top to bottom:

+
+
scopes
+
A graphical depiction of the current image’s light levels and colors. This module can be moved to the left-hand panel if desired (see preferences > miscellaneous > position of the scopes module).
+
session
+
Session settings.
+
live view
+
Live view settings.
+
camera settings
+
Camera settings.
+
metadata editor
+
Edit metadata for selected images.
+
tagging
+
Tag selected images.
+
+

🔗bottom panel

+

From left to right:

+
+
star ratings
+
Apply star ratings to images.
+
color labels
+
Apply color labels to images.
+
+ + + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/en/tethering/troubleshooting/index.html b/en/tethering/troubleshooting/index.html new file mode 100644 index 0000000000..0edbc6ee70 --- /dev/null +++ b/en/tethering/troubleshooting/index.html @@ -0,0 +1,3034 @@ + + + + + +darktable user manual - troubleshooting + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + + + +
+ + + +darktable / Tethering / troubleshooting + +
+ +
+
+ + + +
+
+ + + +
+
+ + +
+ +

+ troubleshooting +

+ + + +

This troubleshooting guide can be used to verify whether or not your camera can be used with tethering. This is done using the same (gphoto2) tool that darktable uses to interface with your camera.

+

Before you start, you first need to find your camera port name. Usually the port “usb:” is sufficient and is therefore used in the following guide.

+

🔗is your camera detected?

+

The following command will verify that your camera is connected to the computer and detected by gphoto2.

+
env LANG=C gphoto2 --auto-detect
+

🔗check the camera’s driver abilities

+

Execute the following command and ensure that the “capture choices” ability supports “Image” and configuration support is “yes” – darktable will check these two abilities to decide whether to show the “tethered shoot” button.

+
env LANG=C gphoto2 --port usb: --abilities
+

🔗remote capture

+

This step will verify that your camera can be remotely controlled – i.e. that it can capture an image, download it to your computer and display it within darktable.

+
env LANG=C gphoto2 --port usb: --capture-image-and-download
+

🔗tethered capture

+

This last step tests if your camera supports “events”, are heavily used by darktable. Running this command will make the gphoto2 process wait for an image capture event which you must manually trigger on your camera. If successful, the image will be downloaded to your computer.

+
env LANG=C gphoto2 --port usb: --capture-tethered
+

🔗now what?

+

If any of the above steps failed, there are problems with your specific camera and driver. Please file an issue on the gphoto2 github page. Add the following flags to the failed command for better support and attach the log output to your issue:

+
--debug --debug-file gphoto2_debug.log
+

If you successfully completed all of the above tests, your camera is probably supported by darktable. If these tests were successful but you nevertheless stumble upon a problem in darktable, please file an issue on the darktable github page. Please attach the log output from the commands above and the log file output produced by starting darktable with the following command:

+
darktable -d camctl 2>1 >camctl.log
+
+ + +
+ +
+
+ + + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/eo/categories/index.html b/eo/categories/index.html new file mode 100644 index 0000000000..28c0d470f9 --- /dev/null +++ b/eo/categories/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Categories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Categories + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Categories

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/eo/categories/index.xml b/eo/categories/index.xml new file mode 100644 index 0000000000..c655faf0d3 --- /dev/null +++ b/eo/categories/index.xml @@ -0,0 +1,11 @@ + + + + Categories on darktable user manual + https://darktable-org.github.io/dtdocs/eo/categories/ + Recent content in Categories on darktable user manual + Hugo + eo + + + diff --git a/eo/darktable_user_manual.epub b/eo/darktable_user_manual.epub new file mode 100644 index 0000000000..ddae1494b4 Binary files /dev/null and b/eo/darktable_user_manual.epub differ diff --git a/eo/darktable_user_manual.pdf b/eo/darktable_user_manual.pdf new file mode 100644 index 0000000000..f150528f61 Binary files /dev/null and b/eo/darktable_user_manual.pdf differ diff --git a/eo/index.html b/eo/index.html new file mode 100644 index 0000000000..e4722b7e80 --- /dev/null +++ b/eo/index.html @@ -0,0 +1,248 @@ + + + + + + +darktable user manual - darktable user manual + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ + + + +
+ + + + + + + + + + + + diff --git a/eo/index.json b/eo/index.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/eo/index.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/eo/index.xml b/eo/index.xml new file mode 100644 index 0000000000..d17f5bfab1 --- /dev/null +++ b/eo/index.xml @@ -0,0 +1,11 @@ + + + + darktable user manual + https://darktable-org.github.io/dtdocs/eo/ + Recent content on darktable user manual + Hugo + eo + + + diff --git a/eo/sitemap.xml b/eo/sitemap.xml new file mode 100644 index 0000000000..f2f8416c25 --- /dev/null +++ b/eo/sitemap.xml @@ -0,0 +1,176 @@ + + + + https://darktable-org.github.io/dtdocs/eo/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/eo/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/eo/tags/ + + + + + + + + + + + + + diff --git a/eo/tags/index.html b/eo/tags/index.html new file mode 100644 index 0000000000..228cb05c0a --- /dev/null +++ b/eo/tags/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Tags + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Tags

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/eo/tags/index.xml b/eo/tags/index.xml new file mode 100644 index 0000000000..6ba3796b18 --- /dev/null +++ b/eo/tags/index.xml @@ -0,0 +1,11 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/eo/tags/ + Recent content in Tags on darktable user manual + Hugo + eo + + + diff --git a/es/categories/index.html b/es/categories/index.html new file mode 100644 index 0000000000..6e45127e87 --- /dev/null +++ b/es/categories/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Categories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Categories + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Categories

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/es/categories/index.xml b/es/categories/index.xml new file mode 100644 index 0000000000..e9b7451a75 --- /dev/null +++ b/es/categories/index.xml @@ -0,0 +1,11 @@ + + + + Categories on darktable user manual + https://darktable-org.github.io/dtdocs/es/categories/ + Recent content in Categories on darktable user manual + Hugo + es + + + diff --git a/es/darktable_user_manual.epub b/es/darktable_user_manual.epub new file mode 100644 index 0000000000..14bd0a42cd Binary files /dev/null and b/es/darktable_user_manual.epub differ diff --git a/es/darktable_user_manual.pdf b/es/darktable_user_manual.pdf new file mode 100644 index 0000000000..e2be971cb4 Binary files /dev/null and b/es/darktable_user_manual.pdf differ diff --git a/es/index.html b/es/index.html new file mode 100644 index 0000000000..93c8c9f8ca --- /dev/null +++ b/es/index.html @@ -0,0 +1,248 @@ + + + + + + +darktable user manual - darktable user manual + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ + + + +
+ + + + + + + + + + + + diff --git a/es/index.json b/es/index.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/es/index.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/es/index.xml b/es/index.xml new file mode 100644 index 0000000000..4f20c603f5 --- /dev/null +++ b/es/index.xml @@ -0,0 +1,11 @@ + + + + darktable user manual + https://darktable-org.github.io/dtdocs/es/ + Recent content on darktable user manual + Hugo + es + + + diff --git a/es/sitemap.xml b/es/sitemap.xml new file mode 100644 index 0000000000..44160ea012 --- /dev/null +++ b/es/sitemap.xml @@ -0,0 +1,176 @@ + + + + https://darktable-org.github.io/dtdocs/es/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/es/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/es/tags/ + + + + + + + + + + + + + diff --git a/es/tags/index.html b/es/tags/index.html new file mode 100644 index 0000000000..e84ab1e85b --- /dev/null +++ b/es/tags/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Tags + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Tags

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/es/tags/index.xml b/es/tags/index.xml new file mode 100644 index 0000000000..b83101365b --- /dev/null +++ b/es/tags/index.xml @@ -0,0 +1,11 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/es/tags/ + Recent content in Tags on darktable user manual + Hugo + es + + + diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000000..c58fbbe881 Binary files /dev/null and b/favicon.ico differ diff --git a/fonts/forkawesome-webfont.eot b/fonts/forkawesome-webfont.eot new file mode 100644 index 0000000000..b96d208fac Binary files /dev/null and b/fonts/forkawesome-webfont.eot differ diff --git a/fonts/forkawesome-webfont.svg b/fonts/forkawesome-webfont.svg new file mode 100644 index 0000000000..e99720454c --- /dev/null +++ b/fonts/forkawesome-webfont.svg @@ -0,0 +1,2849 @@ + + + + + +Created by FontForge 20180321 at Mon Feb 18 18:29:30 2019 + By Julien Deswaef +The Fork Awesome font is licensed under the SIL OFL 1.1 (http://scripts.sil.org/OFL). Fork Awesome is a fork based of off Font Awesome 4.7.0 by Dave Gandy. More info on licenses at https://forkawesome.github.io + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/fonts/forkawesome-webfont.ttf b/fonts/forkawesome-webfont.ttf new file mode 100644 index 0000000000..6cf62efb89 Binary files /dev/null and b/fonts/forkawesome-webfont.ttf differ diff --git a/fonts/forkawesome-webfont.woff b/fonts/forkawesome-webfont.woff new file mode 100644 index 0000000000..477da445ad Binary files /dev/null and b/fonts/forkawesome-webfont.woff differ diff --git a/fonts/forkawesome-webfont.woff2 b/fonts/forkawesome-webfont.woff2 new file mode 100644 index 0000000000..f3520b5334 Binary files /dev/null and b/fonts/forkawesome-webfont.woff2 differ diff --git a/fr/categories/index.html b/fr/categories/index.html new file mode 100644 index 0000000000..19c35f9350 --- /dev/null +++ b/fr/categories/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Categories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Categories + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Categories

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/fr/categories/index.xml b/fr/categories/index.xml new file mode 100644 index 0000000000..4bd3b54fe7 --- /dev/null +++ b/fr/categories/index.xml @@ -0,0 +1,11 @@ + + + + Categories on darktable user manual + https://darktable-org.github.io/dtdocs/fr/categories/ + Recent content in Categories on darktable user manual + Hugo + fr + + + diff --git a/fr/darktable_user_manual.epub b/fr/darktable_user_manual.epub new file mode 100644 index 0000000000..5844099ccd Binary files /dev/null and b/fr/darktable_user_manual.epub differ diff --git a/fr/darktable_user_manual.pdf b/fr/darktable_user_manual.pdf new file mode 100644 index 0000000000..e2308fce1a Binary files /dev/null and b/fr/darktable_user_manual.pdf differ diff --git a/fr/index.html b/fr/index.html new file mode 100644 index 0000000000..68c62b9912 --- /dev/null +++ b/fr/index.html @@ -0,0 +1,248 @@ + + + + + + +darktable user manual - darktable user manual + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ + + + +
+ + + + + + + + + + + + diff --git a/fr/index.json b/fr/index.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/fr/index.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/fr/index.xml b/fr/index.xml new file mode 100644 index 0000000000..0957a606e0 --- /dev/null +++ b/fr/index.xml @@ -0,0 +1,11 @@ + + + + darktable user manual + https://darktable-org.github.io/dtdocs/fr/ + Recent content on darktable user manual + Hugo + fr + + + diff --git a/fr/sitemap.xml b/fr/sitemap.xml new file mode 100644 index 0000000000..94aad71b80 --- /dev/null +++ b/fr/sitemap.xml @@ -0,0 +1,176 @@ + + + + https://darktable-org.github.io/dtdocs/fr/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/fr/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/fr/tags/ + + + + + + + + + + + + + diff --git a/fr/tags/index.html b/fr/tags/index.html new file mode 100644 index 0000000000..027a60aa39 --- /dev/null +++ b/fr/tags/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Tags + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Tags

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/fr/tags/index.xml b/fr/tags/index.xml new file mode 100644 index 0000000000..d5f44cb484 --- /dev/null +++ b/fr/tags/index.xml @@ -0,0 +1,11 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/fr/tags/ + Recent content in Tags on darktable user manual + Hugo + fr + + + diff --git a/gl/categories/index.html b/gl/categories/index.html new file mode 100644 index 0000000000..f7d2ae7e29 --- /dev/null +++ b/gl/categories/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Categories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Categories + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Categories

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/gl/categories/index.xml b/gl/categories/index.xml new file mode 100644 index 0000000000..f4d49b974d --- /dev/null +++ b/gl/categories/index.xml @@ -0,0 +1,11 @@ + + + + Categories on darktable user manual + https://darktable-org.github.io/dtdocs/gl/categories/ + Recent content in Categories on darktable user manual + Hugo + gl + + + diff --git a/gl/darktable_user_manual.epub b/gl/darktable_user_manual.epub new file mode 100644 index 0000000000..93184d55fe Binary files /dev/null and b/gl/darktable_user_manual.epub differ diff --git a/gl/darktable_user_manual.pdf b/gl/darktable_user_manual.pdf new file mode 100644 index 0000000000..f3f3de7c0f Binary files /dev/null and b/gl/darktable_user_manual.pdf differ diff --git a/gl/index.html b/gl/index.html new file mode 100644 index 0000000000..4a1809b22f --- /dev/null +++ b/gl/index.html @@ -0,0 +1,248 @@ + + + + + + +darktable user manual - darktable user manual + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ + + + +
+ + + + + + + + + + + + diff --git a/gl/index.json b/gl/index.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/gl/index.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/gl/index.xml b/gl/index.xml new file mode 100644 index 0000000000..6bf10e2796 --- /dev/null +++ b/gl/index.xml @@ -0,0 +1,11 @@ + + + + darktable user manual + https://darktable-org.github.io/dtdocs/gl/ + Recent content on darktable user manual + Hugo + gl + + + diff --git a/gl/sitemap.xml b/gl/sitemap.xml new file mode 100644 index 0000000000..5fce7f09f0 --- /dev/null +++ b/gl/sitemap.xml @@ -0,0 +1,176 @@ + + + + https://darktable-org.github.io/dtdocs/gl/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/gl/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/gl/tags/ + + + + + + + + + + + + + diff --git a/gl/tags/index.html b/gl/tags/index.html new file mode 100644 index 0000000000..b888a1dbfd --- /dev/null +++ b/gl/tags/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Tags + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Tags

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/gl/tags/index.xml b/gl/tags/index.xml new file mode 100644 index 0000000000..78666e67b6 --- /dev/null +++ b/gl/tags/index.xml @@ -0,0 +1,11 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/gl/tags/ + Recent content in Tags on darktable user manual + Hugo + gl + + + diff --git a/index.html b/index.html new file mode 100644 index 0000000000..d79c3f6422 --- /dev/null +++ b/index.html @@ -0,0 +1,10 @@ + + + + https://darktable-org.github.io/dtdocs/en/ + + + + + + diff --git a/it/categories/index.html b/it/categories/index.html new file mode 100644 index 0000000000..e1710b7642 --- /dev/null +++ b/it/categories/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Categories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Categories + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Categories

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/it/categories/index.xml b/it/categories/index.xml new file mode 100644 index 0000000000..8a666ba703 --- /dev/null +++ b/it/categories/index.xml @@ -0,0 +1,11 @@ + + + + Categories on darktable user manual + https://darktable-org.github.io/dtdocs/it/categories/ + Recent content in Categories on darktable user manual + Hugo + it + + + diff --git a/it/darktable_user_manual.epub b/it/darktable_user_manual.epub new file mode 100644 index 0000000000..81d38839e2 Binary files /dev/null and b/it/darktable_user_manual.epub differ diff --git a/it/darktable_user_manual.pdf b/it/darktable_user_manual.pdf new file mode 100644 index 0000000000..e63fa8a98c Binary files /dev/null and b/it/darktable_user_manual.pdf differ diff --git a/it/index.html b/it/index.html new file mode 100644 index 0000000000..8d9fb89c62 --- /dev/null +++ b/it/index.html @@ -0,0 +1,248 @@ + + + + + + +darktable user manual - darktable user manual + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ + + + +
+ + + + + + + + + + + + diff --git a/it/index.json b/it/index.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/it/index.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/it/index.xml b/it/index.xml new file mode 100644 index 0000000000..ac1a9e11e1 --- /dev/null +++ b/it/index.xml @@ -0,0 +1,11 @@ + + + + darktable user manual + https://darktable-org.github.io/dtdocs/it/ + Recent content on darktable user manual + Hugo + it + + + diff --git a/it/sitemap.xml b/it/sitemap.xml new file mode 100644 index 0000000000..d482060f6f --- /dev/null +++ b/it/sitemap.xml @@ -0,0 +1,176 @@ + + + + https://darktable-org.github.io/dtdocs/it/categories/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/it/ + + + + + + + + + + + + + https://darktable-org.github.io/dtdocs/it/tags/ + + + + + + + + + + + + + diff --git a/it/tags/index.html b/it/tags/index.html new file mode 100644 index 0000000000..2b51ba205b --- /dev/null +++ b/it/tags/index.html @@ -0,0 +1,228 @@ + + + + + +darktable user manual - Tags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+
+
+ + +
+ + +darktable user manual / Tags + +
+ +
+
+ +
+
+ +
+
+ + +
+ +

Tags

+
    + +
+
+ +
+
+ +
+
+ +
+
+ + + +
+ +
+ + + +
+ + + + + + + + + + + + diff --git a/it/tags/index.xml b/it/tags/index.xml new file mode 100644 index 0000000000..50dcfa7fc1 --- /dev/null +++ b/it/tags/index.xml @@ -0,0 +1,11 @@ + + + + Tags on darktable user manual + https://darktable-org.github.io/dtdocs/it/tags/ + Recent content in Tags on darktable user manual + Hugo + it + + + diff --git a/js/.gitkeep b/js/.gitkeep new file mode 100644 index 0000000000..8d1c8b69c3 --- /dev/null +++ b/js/.gitkeep @@ -0,0 +1 @@ + diff --git a/js/app.js b/js/app.js new file mode 100644 index 0000000000..0e2d2304c3 --- /dev/null +++ b/js/app.js @@ -0,0 +1,204 @@ +var lunrIndex; +var pagesIndex; +var pagesMap = {}; +var SEARCH_RESULT_LIMIT = 20; +var SEARCH_RESULT_EXCERPT_LENGTH = 160; + +function sanitizeRegex(src) { + return src.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); +} + +// Initialize lunrjs using our generated index file +function initLunr() { + var request = new XMLHttpRequest(); + request.open('GET', indexURL, true); + + request.onload = function () { + if (request.status >= 200 && request.status < 400) { + pagesIndex = JSON.parse(request.responseText); + console.log('index:', pagesIndex); + + pagesIndex.forEach(function (page) { + pagesMap[page.href] = page; + }); + + // Set up lunrjs by declaring the fields we use + // Also provide their boost level for the ranking + lunrIndex = lunr(function () { + this.pipeline.remove(lunr.stemmer); + this.searchPipeline.remove(lunr.stemmer); + + this.field('title', { boost: 5 }); + this.field('content', { boost: 2 }); + this.field('tags', { boost: 1 }); + + // ref is the result item identifier (I chose the page URL) + this.ref('href'); + this.add({ field: 'test', text: 'hello' }); + for (var i = 0; i < pagesIndex.length; ++i) { + this.add(pagesIndex[i]); + } + }); + } else { + var err = textStatus + ', ' + error; + console.error('Error getting Hugo index flie:', err); + } + }; + + request.send(); +} + +function search(queryString, limit) { + var queryTerms = lunr.tokenizer(queryString); + var searchResults = lunrIndex.query(function (query) { + queryTerms.forEach(function (queryTerm) { + // look for an exact match and apply a large positive boost + query.term(queryTerm, { + usePipeline: true, + boost: 100, + }); + + // look for terms that start or end with queryTerm and apply a medium boost + query.term(queryTerm, { + usePipeline: false, + boost: 5, + wildcard: + lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING, + }); + + // look for terms that match with an edit distance of 1 and apply a small boost + query.term(queryTerm, { + usePipeline: false, + editDistance: 1, + boost: 1, + }); + }); + }); + + // Sort results by relevance + searchResults.sort((a, b) => b.score - a.score); + + searchResults = searchResults.slice(0, limit); + + return searchResults; +} + +function highlightKeyword(sourceText, keyword, tag) { + if (!tag) tag = 'mark'; + + return sourceText.replace(new RegExp(keyword, 'ig'), function (match) { + return '<' + tag + '>' + match + ''; + }); +} + +function getTextExcerpt(text, keyword, length) { + if (!length) length = 80; + + var index = text.search(new RegExp(keyword, 'ig')); + var excerpt = text; + + if (index === -1) excerpt = text.substring(0, length) + '...'; + + var halfLength = Math.round(length / 2); + var excerpt = text.substring( + Math.max(0, index - halfLength), + Math.min(text.length, index + halfLength) + ); + + if (index - halfLength > 0) excerpt = '...' + excerpt; + if (index + halfLength < text.length) excerpt = excerpt + '...'; + + return excerpt; +} + +function renderResults(results) { + var searchResults = document.getElementById('search-results'); + var $searchResults = $(searchResults); + + if (!results.length) { + $searchResults.hide(); + return; + } + + var resultsFragment = document.createDocumentFragment(); + // Only show the first twenty results + results.forEach(function (result) { + var page = pagesMap[result.ref]; + var matchedTerms = Object.keys(result.matchData.metadata) + .map(sanitizeRegex) + .join('|'); + var link = document.createElement('a'); + var title = document.createElement('b'); + var content = document.createElement('small'); + + link.className = 'search-results__item'; + title.className = 'search-results__title'; + content.className = 'search-results__content'; + + link.href = page.href; + title.innerHTML = highlightKeyword(page.title, matchedTerms); + content.innerHTML = highlightKeyword( + getTextExcerpt( + page.content, + matchedTerms, + SEARCH_RESULT_EXCERPT_LENGTH + ), + matchedTerms + ); + + link.appendChild(title); + link.appendChild(content); + + resultsFragment.appendChild(link); + }); + searchResults.appendChild(resultsFragment); + + var header = document.querySelector('header.navbar'); + $searchResults.css('top', header.clientHeight); + $searchResults.css('height', window.innerHeight - header.clientHeight); + $searchResults.show(); +} + +function handleSearchInput() { + var $searchInput = $('#search-input'); + var $searchResults = $('#search-results'); + var query = $searchInput.val(); + + //trigger a search if a search term longer than two characters has been entered + $searchResults.empty().hide(); + + if (query.length < 2) { + return; + } + + renderResults(search(query, SEARCH_RESULT_LIMIT)); +} + +$(document).ready(function () { + var $searchInput = $('#search-input'); + var $searchResults = $('#search-results'); + + $searchResults.hide(); + $searchInput.focus(function () { + //load index file if it's not already been loaded + if (!lunrIndex) { + initLunr(); + } + }); + + $searchInput.keydown(function (e) { + if (e.keyCode === 27) { + $searchResults.hide(); + $searchInput.val(''); + } + + if (e.keyCode === 13) { + //enter key pressed - go to first search result if it exists + e.preventDefault(); + + $('#search-results a').first().get(0).click(); + } + }); + + $searchInput.on('input', handleSearchInput); +}); diff --git a/js/bootstrap.js b/js/bootstrap.js new file mode 100644 index 0000000000..8b95e652f8 --- /dev/null +++ b/js/bootstrap.js @@ -0,0 +1,4418 @@ +/*! + * Bootstrap v4.5.3 (https://getbootstrap.com/) + * Copyright 2011-2020 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors) + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + */ +(function (global, factory) { + typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('jquery'), require('popper.js')) : + typeof define === 'function' && define.amd ? define(['exports', 'jquery', 'popper.js'], factory) : + (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.bootstrap = {}, global.jQuery, global.Popper)); +}(this, (function (exports, $, Popper) { 'use strict'; + + function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; } + + var $__default = /*#__PURE__*/_interopDefaultLegacy($); + var Popper__default = /*#__PURE__*/_interopDefaultLegacy(Popper); + + function _defineProperties(target, props) { + for (var i = 0; i < props.length; i++) { + var descriptor = props[i]; + descriptor.enumerable = descriptor.enumerable || false; + descriptor.configurable = true; + if ("value" in descriptor) descriptor.writable = true; + Object.defineProperty(target, descriptor.key, descriptor); + } + } + + function _createClass(Constructor, protoProps, staticProps) { + if (protoProps) _defineProperties(Constructor.prototype, protoProps); + if (staticProps) _defineProperties(Constructor, staticProps); + return Constructor; + } + + function _extends() { + _extends = Object.assign || function (target) { + for (var i = 1; i < arguments.length; i++) { + var source = arguments[i]; + + for (var key in source) { + if (Object.prototype.hasOwnProperty.call(source, key)) { + target[key] = source[key]; + } + } + } + + return target; + }; + + return _extends.apply(this, arguments); + } + + function _inheritsLoose(subClass, superClass) { + subClass.prototype = Object.create(superClass.prototype); + subClass.prototype.constructor = subClass; + subClass.__proto__ = superClass; + } + + /** + * -------------------------------------------------------------------------- + * Bootstrap (v4.5.3): util.js + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + * -------------------------------------------------------------------------- + */ + /** + * ------------------------------------------------------------------------ + * Private TransitionEnd Helpers + * ------------------------------------------------------------------------ + */ + + var TRANSITION_END = 'transitionend'; + var MAX_UID = 1000000; + var MILLISECONDS_MULTIPLIER = 1000; // Shoutout AngusCroll (https://goo.gl/pxwQGp) + + function toType(obj) { + if (obj === null || typeof obj === 'undefined') { + return "" + obj; + } + + return {}.toString.call(obj).match(/\s([a-z]+)/i)[1].toLowerCase(); + } + + function getSpecialTransitionEndEvent() { + return { + bindType: TRANSITION_END, + delegateType: TRANSITION_END, + handle: function handle(event) { + if ($__default['default'](event.target).is(this)) { + return event.handleObj.handler.apply(this, arguments); // eslint-disable-line prefer-rest-params + } + + return undefined; + } + }; + } + + function transitionEndEmulator(duration) { + var _this = this; + + var called = false; + $__default['default'](this).one(Util.TRANSITION_END, function () { + called = true; + }); + setTimeout(function () { + if (!called) { + Util.triggerTransitionEnd(_this); + } + }, duration); + return this; + } + + function setTransitionEndSupport() { + $__default['default'].fn.emulateTransitionEnd = transitionEndEmulator; + $__default['default'].event.special[Util.TRANSITION_END] = getSpecialTransitionEndEvent(); + } + /** + * -------------------------------------------------------------------------- + * Public Util Api + * -------------------------------------------------------------------------- + */ + + + var Util = { + TRANSITION_END: 'bsTransitionEnd', + getUID: function getUID(prefix) { + do { + prefix += ~~(Math.random() * MAX_UID); // "~~" acts like a faster Math.floor() here + } while (document.getElementById(prefix)); + + return prefix; + }, + getSelectorFromElement: function getSelectorFromElement(element) { + var selector = element.getAttribute('data-target'); + + if (!selector || selector === '#') { + var hrefAttr = element.getAttribute('href'); + selector = hrefAttr && hrefAttr !== '#' ? hrefAttr.trim() : ''; + } + + try { + return document.querySelector(selector) ? selector : null; + } catch (_) { + return null; + } + }, + getTransitionDurationFromElement: function getTransitionDurationFromElement(element) { + if (!element) { + return 0; + } // Get transition-duration of the element + + + var transitionDuration = $__default['default'](element).css('transition-duration'); + var transitionDelay = $__default['default'](element).css('transition-delay'); + var floatTransitionDuration = parseFloat(transitionDuration); + var floatTransitionDelay = parseFloat(transitionDelay); // Return 0 if element or transition duration is not found + + if (!floatTransitionDuration && !floatTransitionDelay) { + return 0; + } // If multiple durations are defined, take the first + + + transitionDuration = transitionDuration.split(',')[0]; + transitionDelay = transitionDelay.split(',')[0]; + return (parseFloat(transitionDuration) + parseFloat(transitionDelay)) * MILLISECONDS_MULTIPLIER; + }, + reflow: function reflow(element) { + return element.offsetHeight; + }, + triggerTransitionEnd: function triggerTransitionEnd(element) { + $__default['default'](element).trigger(TRANSITION_END); + }, + supportsTransitionEnd: function supportsTransitionEnd() { + return Boolean(TRANSITION_END); + }, + isElement: function isElement(obj) { + return (obj[0] || obj).nodeType; + }, + typeCheckConfig: function typeCheckConfig(componentName, config, configTypes) { + for (var property in configTypes) { + if (Object.prototype.hasOwnProperty.call(configTypes, property)) { + var expectedTypes = configTypes[property]; + var value = config[property]; + var valueType = value && Util.isElement(value) ? 'element' : toType(value); + + if (!new RegExp(expectedTypes).test(valueType)) { + throw new Error(componentName.toUpperCase() + ": " + ("Option \"" + property + "\" provided type \"" + valueType + "\" ") + ("but expected type \"" + expectedTypes + "\".")); + } + } + } + }, + findShadowRoot: function findShadowRoot(element) { + if (!document.documentElement.attachShadow) { + return null; + } // Can find the shadow root otherwise it'll return the document + + + if (typeof element.getRootNode === 'function') { + var root = element.getRootNode(); + return root instanceof ShadowRoot ? root : null; + } + + if (element instanceof ShadowRoot) { + return element; + } // when we don't find a shadow root + + + if (!element.parentNode) { + return null; + } + + return Util.findShadowRoot(element.parentNode); + }, + jQueryDetection: function jQueryDetection() { + if (typeof $__default['default'] === 'undefined') { + throw new TypeError('Bootstrap\'s JavaScript requires jQuery. jQuery must be included before Bootstrap\'s JavaScript.'); + } + + var version = $__default['default'].fn.jquery.split(' ')[0].split('.'); + var minMajor = 1; + var ltMajor = 2; + var minMinor = 9; + var minPatch = 1; + var maxMajor = 4; + + if (version[0] < ltMajor && version[1] < minMinor || version[0] === minMajor && version[1] === minMinor && version[2] < minPatch || version[0] >= maxMajor) { + throw new Error('Bootstrap\'s JavaScript requires at least jQuery v1.9.1 but less than v4.0.0'); + } + } + }; + Util.jQueryDetection(); + setTransitionEndSupport(); + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME = 'alert'; + var VERSION = '4.5.3'; + var DATA_KEY = 'bs.alert'; + var EVENT_KEY = "." + DATA_KEY; + var DATA_API_KEY = '.data-api'; + var JQUERY_NO_CONFLICT = $__default['default'].fn[NAME]; + var SELECTOR_DISMISS = '[data-dismiss="alert"]'; + var EVENT_CLOSE = "close" + EVENT_KEY; + var EVENT_CLOSED = "closed" + EVENT_KEY; + var EVENT_CLICK_DATA_API = "click" + EVENT_KEY + DATA_API_KEY; + var CLASS_NAME_ALERT = 'alert'; + var CLASS_NAME_FADE = 'fade'; + var CLASS_NAME_SHOW = 'show'; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Alert = /*#__PURE__*/function () { + function Alert(element) { + this._element = element; + } // Getters + + + var _proto = Alert.prototype; + + // Public + _proto.close = function close(element) { + var rootElement = this._element; + + if (element) { + rootElement = this._getRootElement(element); + } + + var customEvent = this._triggerCloseEvent(rootElement); + + if (customEvent.isDefaultPrevented()) { + return; + } + + this._removeElement(rootElement); + }; + + _proto.dispose = function dispose() { + $__default['default'].removeData(this._element, DATA_KEY); + this._element = null; + } // Private + ; + + _proto._getRootElement = function _getRootElement(element) { + var selector = Util.getSelectorFromElement(element); + var parent = false; + + if (selector) { + parent = document.querySelector(selector); + } + + if (!parent) { + parent = $__default['default'](element).closest("." + CLASS_NAME_ALERT)[0]; + } + + return parent; + }; + + _proto._triggerCloseEvent = function _triggerCloseEvent(element) { + var closeEvent = $__default['default'].Event(EVENT_CLOSE); + $__default['default'](element).trigger(closeEvent); + return closeEvent; + }; + + _proto._removeElement = function _removeElement(element) { + var _this = this; + + $__default['default'](element).removeClass(CLASS_NAME_SHOW); + + if (!$__default['default'](element).hasClass(CLASS_NAME_FADE)) { + this._destroyElement(element); + + return; + } + + var transitionDuration = Util.getTransitionDurationFromElement(element); + $__default['default'](element).one(Util.TRANSITION_END, function (event) { + return _this._destroyElement(element, event); + }).emulateTransitionEnd(transitionDuration); + }; + + _proto._destroyElement = function _destroyElement(element) { + $__default['default'](element).detach().trigger(EVENT_CLOSED).remove(); + } // Static + ; + + Alert._jQueryInterface = function _jQueryInterface(config) { + return this.each(function () { + var $element = $__default['default'](this); + var data = $element.data(DATA_KEY); + + if (!data) { + data = new Alert(this); + $element.data(DATA_KEY, data); + } + + if (config === 'close') { + data[config](this); + } + }); + }; + + Alert._handleDismiss = function _handleDismiss(alertInstance) { + return function (event) { + if (event) { + event.preventDefault(); + } + + alertInstance.close(this); + }; + }; + + _createClass(Alert, null, [{ + key: "VERSION", + get: function get() { + return VERSION; + } + }]); + + return Alert; + }(); + /** + * ------------------------------------------------------------------------ + * Data Api implementation + * ------------------------------------------------------------------------ + */ + + + $__default['default'](document).on(EVENT_CLICK_DATA_API, SELECTOR_DISMISS, Alert._handleDismiss(new Alert())); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + $__default['default'].fn[NAME] = Alert._jQueryInterface; + $__default['default'].fn[NAME].Constructor = Alert; + + $__default['default'].fn[NAME].noConflict = function () { + $__default['default'].fn[NAME] = JQUERY_NO_CONFLICT; + return Alert._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$1 = 'button'; + var VERSION$1 = '4.5.3'; + var DATA_KEY$1 = 'bs.button'; + var EVENT_KEY$1 = "." + DATA_KEY$1; + var DATA_API_KEY$1 = '.data-api'; + var JQUERY_NO_CONFLICT$1 = $__default['default'].fn[NAME$1]; + var CLASS_NAME_ACTIVE = 'active'; + var CLASS_NAME_BUTTON = 'btn'; + var CLASS_NAME_FOCUS = 'focus'; + var SELECTOR_DATA_TOGGLE_CARROT = '[data-toggle^="button"]'; + var SELECTOR_DATA_TOGGLES = '[data-toggle="buttons"]'; + var SELECTOR_DATA_TOGGLE = '[data-toggle="button"]'; + var SELECTOR_DATA_TOGGLES_BUTTONS = '[data-toggle="buttons"] .btn'; + var SELECTOR_INPUT = 'input:not([type="hidden"])'; + var SELECTOR_ACTIVE = '.active'; + var SELECTOR_BUTTON = '.btn'; + var EVENT_CLICK_DATA_API$1 = "click" + EVENT_KEY$1 + DATA_API_KEY$1; + var EVENT_FOCUS_BLUR_DATA_API = "focus" + EVENT_KEY$1 + DATA_API_KEY$1 + " " + ("blur" + EVENT_KEY$1 + DATA_API_KEY$1); + var EVENT_LOAD_DATA_API = "load" + EVENT_KEY$1 + DATA_API_KEY$1; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Button = /*#__PURE__*/function () { + function Button(element) { + this._element = element; + this.shouldAvoidTriggerChange = false; + } // Getters + + + var _proto = Button.prototype; + + // Public + _proto.toggle = function toggle() { + var triggerChangeEvent = true; + var addAriaPressed = true; + var rootElement = $__default['default'](this._element).closest(SELECTOR_DATA_TOGGLES)[0]; + + if (rootElement) { + var input = this._element.querySelector(SELECTOR_INPUT); + + if (input) { + if (input.type === 'radio') { + if (input.checked && this._element.classList.contains(CLASS_NAME_ACTIVE)) { + triggerChangeEvent = false; + } else { + var activeElement = rootElement.querySelector(SELECTOR_ACTIVE); + + if (activeElement) { + $__default['default'](activeElement).removeClass(CLASS_NAME_ACTIVE); + } + } + } + + if (triggerChangeEvent) { + // if it's not a radio button or checkbox don't add a pointless/invalid checked property to the input + if (input.type === 'checkbox' || input.type === 'radio') { + input.checked = !this._element.classList.contains(CLASS_NAME_ACTIVE); + } + + if (!this.shouldAvoidTriggerChange) { + $__default['default'](input).trigger('change'); + } + } + + input.focus(); + addAriaPressed = false; + } + } + + if (!(this._element.hasAttribute('disabled') || this._element.classList.contains('disabled'))) { + if (addAriaPressed) { + this._element.setAttribute('aria-pressed', !this._element.classList.contains(CLASS_NAME_ACTIVE)); + } + + if (triggerChangeEvent) { + $__default['default'](this._element).toggleClass(CLASS_NAME_ACTIVE); + } + } + }; + + _proto.dispose = function dispose() { + $__default['default'].removeData(this._element, DATA_KEY$1); + this._element = null; + } // Static + ; + + Button._jQueryInterface = function _jQueryInterface(config, avoidTriggerChange) { + return this.each(function () { + var $element = $__default['default'](this); + var data = $element.data(DATA_KEY$1); + + if (!data) { + data = new Button(this); + $element.data(DATA_KEY$1, data); + } + + data.shouldAvoidTriggerChange = avoidTriggerChange; + + if (config === 'toggle') { + data[config](); + } + }); + }; + + _createClass(Button, null, [{ + key: "VERSION", + get: function get() { + return VERSION$1; + } + }]); + + return Button; + }(); + /** + * ------------------------------------------------------------------------ + * Data Api implementation + * ------------------------------------------------------------------------ + */ + + + $__default['default'](document).on(EVENT_CLICK_DATA_API$1, SELECTOR_DATA_TOGGLE_CARROT, function (event) { + var button = event.target; + var initialButton = button; + + if (!$__default['default'](button).hasClass(CLASS_NAME_BUTTON)) { + button = $__default['default'](button).closest(SELECTOR_BUTTON)[0]; + } + + if (!button || button.hasAttribute('disabled') || button.classList.contains('disabled')) { + event.preventDefault(); // work around Firefox bug #1540995 + } else { + var inputBtn = button.querySelector(SELECTOR_INPUT); + + if (inputBtn && (inputBtn.hasAttribute('disabled') || inputBtn.classList.contains('disabled'))) { + event.preventDefault(); // work around Firefox bug #1540995 + + return; + } + + if (initialButton.tagName === 'INPUT' || button.tagName !== 'LABEL') { + Button._jQueryInterface.call($__default['default'](button), 'toggle', initialButton.tagName === 'INPUT'); + } + } + }).on(EVENT_FOCUS_BLUR_DATA_API, SELECTOR_DATA_TOGGLE_CARROT, function (event) { + var button = $__default['default'](event.target).closest(SELECTOR_BUTTON)[0]; + $__default['default'](button).toggleClass(CLASS_NAME_FOCUS, /^focus(in)?$/.test(event.type)); + }); + $__default['default'](window).on(EVENT_LOAD_DATA_API, function () { + // ensure correct active class is set to match the controls' actual values/states + // find all checkboxes/readio buttons inside data-toggle groups + var buttons = [].slice.call(document.querySelectorAll(SELECTOR_DATA_TOGGLES_BUTTONS)); + + for (var i = 0, len = buttons.length; i < len; i++) { + var button = buttons[i]; + var input = button.querySelector(SELECTOR_INPUT); + + if (input.checked || input.hasAttribute('checked')) { + button.classList.add(CLASS_NAME_ACTIVE); + } else { + button.classList.remove(CLASS_NAME_ACTIVE); + } + } // find all button toggles + + + buttons = [].slice.call(document.querySelectorAll(SELECTOR_DATA_TOGGLE)); + + for (var _i = 0, _len = buttons.length; _i < _len; _i++) { + var _button = buttons[_i]; + + if (_button.getAttribute('aria-pressed') === 'true') { + _button.classList.add(CLASS_NAME_ACTIVE); + } else { + _button.classList.remove(CLASS_NAME_ACTIVE); + } + } + }); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + $__default['default'].fn[NAME$1] = Button._jQueryInterface; + $__default['default'].fn[NAME$1].Constructor = Button; + + $__default['default'].fn[NAME$1].noConflict = function () { + $__default['default'].fn[NAME$1] = JQUERY_NO_CONFLICT$1; + return Button._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$2 = 'carousel'; + var VERSION$2 = '4.5.3'; + var DATA_KEY$2 = 'bs.carousel'; + var EVENT_KEY$2 = "." + DATA_KEY$2; + var DATA_API_KEY$2 = '.data-api'; + var JQUERY_NO_CONFLICT$2 = $__default['default'].fn[NAME$2]; + var ARROW_LEFT_KEYCODE = 37; // KeyboardEvent.which value for left arrow key + + var ARROW_RIGHT_KEYCODE = 39; // KeyboardEvent.which value for right arrow key + + var TOUCHEVENT_COMPAT_WAIT = 500; // Time for mouse compat events to fire after touch + + var SWIPE_THRESHOLD = 40; + var Default = { + interval: 5000, + keyboard: true, + slide: false, + pause: 'hover', + wrap: true, + touch: true + }; + var DefaultType = { + interval: '(number|boolean)', + keyboard: 'boolean', + slide: '(boolean|string)', + pause: '(string|boolean)', + wrap: 'boolean', + touch: 'boolean' + }; + var DIRECTION_NEXT = 'next'; + var DIRECTION_PREV = 'prev'; + var DIRECTION_LEFT = 'left'; + var DIRECTION_RIGHT = 'right'; + var EVENT_SLIDE = "slide" + EVENT_KEY$2; + var EVENT_SLID = "slid" + EVENT_KEY$2; + var EVENT_KEYDOWN = "keydown" + EVENT_KEY$2; + var EVENT_MOUSEENTER = "mouseenter" + EVENT_KEY$2; + var EVENT_MOUSELEAVE = "mouseleave" + EVENT_KEY$2; + var EVENT_TOUCHSTART = "touchstart" + EVENT_KEY$2; + var EVENT_TOUCHMOVE = "touchmove" + EVENT_KEY$2; + var EVENT_TOUCHEND = "touchend" + EVENT_KEY$2; + var EVENT_POINTERDOWN = "pointerdown" + EVENT_KEY$2; + var EVENT_POINTERUP = "pointerup" + EVENT_KEY$2; + var EVENT_DRAG_START = "dragstart" + EVENT_KEY$2; + var EVENT_LOAD_DATA_API$1 = "load" + EVENT_KEY$2 + DATA_API_KEY$2; + var EVENT_CLICK_DATA_API$2 = "click" + EVENT_KEY$2 + DATA_API_KEY$2; + var CLASS_NAME_CAROUSEL = 'carousel'; + var CLASS_NAME_ACTIVE$1 = 'active'; + var CLASS_NAME_SLIDE = 'slide'; + var CLASS_NAME_RIGHT = 'carousel-item-right'; + var CLASS_NAME_LEFT = 'carousel-item-left'; + var CLASS_NAME_NEXT = 'carousel-item-next'; + var CLASS_NAME_PREV = 'carousel-item-prev'; + var CLASS_NAME_POINTER_EVENT = 'pointer-event'; + var SELECTOR_ACTIVE$1 = '.active'; + var SELECTOR_ACTIVE_ITEM = '.active.carousel-item'; + var SELECTOR_ITEM = '.carousel-item'; + var SELECTOR_ITEM_IMG = '.carousel-item img'; + var SELECTOR_NEXT_PREV = '.carousel-item-next, .carousel-item-prev'; + var SELECTOR_INDICATORS = '.carousel-indicators'; + var SELECTOR_DATA_SLIDE = '[data-slide], [data-slide-to]'; + var SELECTOR_DATA_RIDE = '[data-ride="carousel"]'; + var PointerType = { + TOUCH: 'touch', + PEN: 'pen' + }; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Carousel = /*#__PURE__*/function () { + function Carousel(element, config) { + this._items = null; + this._interval = null; + this._activeElement = null; + this._isPaused = false; + this._isSliding = false; + this.touchTimeout = null; + this.touchStartX = 0; + this.touchDeltaX = 0; + this._config = this._getConfig(config); + this._element = element; + this._indicatorsElement = this._element.querySelector(SELECTOR_INDICATORS); + this._touchSupported = 'ontouchstart' in document.documentElement || navigator.maxTouchPoints > 0; + this._pointerEvent = Boolean(window.PointerEvent || window.MSPointerEvent); + + this._addEventListeners(); + } // Getters + + + var _proto = Carousel.prototype; + + // Public + _proto.next = function next() { + if (!this._isSliding) { + this._slide(DIRECTION_NEXT); + } + }; + + _proto.nextWhenVisible = function nextWhenVisible() { + var $element = $__default['default'](this._element); // Don't call next when the page isn't visible + // or the carousel or its parent isn't visible + + if (!document.hidden && $element.is(':visible') && $element.css('visibility') !== 'hidden') { + this.next(); + } + }; + + _proto.prev = function prev() { + if (!this._isSliding) { + this._slide(DIRECTION_PREV); + } + }; + + _proto.pause = function pause(event) { + if (!event) { + this._isPaused = true; + } + + if (this._element.querySelector(SELECTOR_NEXT_PREV)) { + Util.triggerTransitionEnd(this._element); + this.cycle(true); + } + + clearInterval(this._interval); + this._interval = null; + }; + + _proto.cycle = function cycle(event) { + if (!event) { + this._isPaused = false; + } + + if (this._interval) { + clearInterval(this._interval); + this._interval = null; + } + + if (this._config.interval && !this._isPaused) { + this._interval = setInterval((document.visibilityState ? this.nextWhenVisible : this.next).bind(this), this._config.interval); + } + }; + + _proto.to = function to(index) { + var _this = this; + + this._activeElement = this._element.querySelector(SELECTOR_ACTIVE_ITEM); + + var activeIndex = this._getItemIndex(this._activeElement); + + if (index > this._items.length - 1 || index < 0) { + return; + } + + if (this._isSliding) { + $__default['default'](this._element).one(EVENT_SLID, function () { + return _this.to(index); + }); + return; + } + + if (activeIndex === index) { + this.pause(); + this.cycle(); + return; + } + + var direction = index > activeIndex ? DIRECTION_NEXT : DIRECTION_PREV; + + this._slide(direction, this._items[index]); + }; + + _proto.dispose = function dispose() { + $__default['default'](this._element).off(EVENT_KEY$2); + $__default['default'].removeData(this._element, DATA_KEY$2); + this._items = null; + this._config = null; + this._element = null; + this._interval = null; + this._isPaused = null; + this._isSliding = null; + this._activeElement = null; + this._indicatorsElement = null; + } // Private + ; + + _proto._getConfig = function _getConfig(config) { + config = _extends({}, Default, config); + Util.typeCheckConfig(NAME$2, config, DefaultType); + return config; + }; + + _proto._handleSwipe = function _handleSwipe() { + var absDeltax = Math.abs(this.touchDeltaX); + + if (absDeltax <= SWIPE_THRESHOLD) { + return; + } + + var direction = absDeltax / this.touchDeltaX; + this.touchDeltaX = 0; // swipe left + + if (direction > 0) { + this.prev(); + } // swipe right + + + if (direction < 0) { + this.next(); + } + }; + + _proto._addEventListeners = function _addEventListeners() { + var _this2 = this; + + if (this._config.keyboard) { + $__default['default'](this._element).on(EVENT_KEYDOWN, function (event) { + return _this2._keydown(event); + }); + } + + if (this._config.pause === 'hover') { + $__default['default'](this._element).on(EVENT_MOUSEENTER, function (event) { + return _this2.pause(event); + }).on(EVENT_MOUSELEAVE, function (event) { + return _this2.cycle(event); + }); + } + + if (this._config.touch) { + this._addTouchEventListeners(); + } + }; + + _proto._addTouchEventListeners = function _addTouchEventListeners() { + var _this3 = this; + + if (!this._touchSupported) { + return; + } + + var start = function start(event) { + if (_this3._pointerEvent && PointerType[event.originalEvent.pointerType.toUpperCase()]) { + _this3.touchStartX = event.originalEvent.clientX; + } else if (!_this3._pointerEvent) { + _this3.touchStartX = event.originalEvent.touches[0].clientX; + } + }; + + var move = function move(event) { + // ensure swiping with one touch and not pinching + if (event.originalEvent.touches && event.originalEvent.touches.length > 1) { + _this3.touchDeltaX = 0; + } else { + _this3.touchDeltaX = event.originalEvent.touches[0].clientX - _this3.touchStartX; + } + }; + + var end = function end(event) { + if (_this3._pointerEvent && PointerType[event.originalEvent.pointerType.toUpperCase()]) { + _this3.touchDeltaX = event.originalEvent.clientX - _this3.touchStartX; + } + + _this3._handleSwipe(); + + if (_this3._config.pause === 'hover') { + // If it's a touch-enabled device, mouseenter/leave are fired as + // part of the mouse compatibility events on first tap - the carousel + // would stop cycling until user tapped out of it; + // here, we listen for touchend, explicitly pause the carousel + // (as if it's the second time we tap on it, mouseenter compat event + // is NOT fired) and after a timeout (to allow for mouse compatibility + // events to fire) we explicitly restart cycling + _this3.pause(); + + if (_this3.touchTimeout) { + clearTimeout(_this3.touchTimeout); + } + + _this3.touchTimeout = setTimeout(function (event) { + return _this3.cycle(event); + }, TOUCHEVENT_COMPAT_WAIT + _this3._config.interval); + } + }; + + $__default['default'](this._element.querySelectorAll(SELECTOR_ITEM_IMG)).on(EVENT_DRAG_START, function (e) { + return e.preventDefault(); + }); + + if (this._pointerEvent) { + $__default['default'](this._element).on(EVENT_POINTERDOWN, function (event) { + return start(event); + }); + $__default['default'](this._element).on(EVENT_POINTERUP, function (event) { + return end(event); + }); + + this._element.classList.add(CLASS_NAME_POINTER_EVENT); + } else { + $__default['default'](this._element).on(EVENT_TOUCHSTART, function (event) { + return start(event); + }); + $__default['default'](this._element).on(EVENT_TOUCHMOVE, function (event) { + return move(event); + }); + $__default['default'](this._element).on(EVENT_TOUCHEND, function (event) { + return end(event); + }); + } + }; + + _proto._keydown = function _keydown(event) { + if (/input|textarea/i.test(event.target.tagName)) { + return; + } + + switch (event.which) { + case ARROW_LEFT_KEYCODE: + event.preventDefault(); + this.prev(); + break; + + case ARROW_RIGHT_KEYCODE: + event.preventDefault(); + this.next(); + break; + } + }; + + _proto._getItemIndex = function _getItemIndex(element) { + this._items = element && element.parentNode ? [].slice.call(element.parentNode.querySelectorAll(SELECTOR_ITEM)) : []; + return this._items.indexOf(element); + }; + + _proto._getItemByDirection = function _getItemByDirection(direction, activeElement) { + var isNextDirection = direction === DIRECTION_NEXT; + var isPrevDirection = direction === DIRECTION_PREV; + + var activeIndex = this._getItemIndex(activeElement); + + var lastItemIndex = this._items.length - 1; + var isGoingToWrap = isPrevDirection && activeIndex === 0 || isNextDirection && activeIndex === lastItemIndex; + + if (isGoingToWrap && !this._config.wrap) { + return activeElement; + } + + var delta = direction === DIRECTION_PREV ? -1 : 1; + var itemIndex = (activeIndex + delta) % this._items.length; + return itemIndex === -1 ? this._items[this._items.length - 1] : this._items[itemIndex]; + }; + + _proto._triggerSlideEvent = function _triggerSlideEvent(relatedTarget, eventDirectionName) { + var targetIndex = this._getItemIndex(relatedTarget); + + var fromIndex = this._getItemIndex(this._element.querySelector(SELECTOR_ACTIVE_ITEM)); + + var slideEvent = $__default['default'].Event(EVENT_SLIDE, { + relatedTarget: relatedTarget, + direction: eventDirectionName, + from: fromIndex, + to: targetIndex + }); + $__default['default'](this._element).trigger(slideEvent); + return slideEvent; + }; + + _proto._setActiveIndicatorElement = function _setActiveIndicatorElement(element) { + if (this._indicatorsElement) { + var indicators = [].slice.call(this._indicatorsElement.querySelectorAll(SELECTOR_ACTIVE$1)); + $__default['default'](indicators).removeClass(CLASS_NAME_ACTIVE$1); + + var nextIndicator = this._indicatorsElement.children[this._getItemIndex(element)]; + + if (nextIndicator) { + $__default['default'](nextIndicator).addClass(CLASS_NAME_ACTIVE$1); + } + } + }; + + _proto._slide = function _slide(direction, element) { + var _this4 = this; + + var activeElement = this._element.querySelector(SELECTOR_ACTIVE_ITEM); + + var activeElementIndex = this._getItemIndex(activeElement); + + var nextElement = element || activeElement && this._getItemByDirection(direction, activeElement); + + var nextElementIndex = this._getItemIndex(nextElement); + + var isCycling = Boolean(this._interval); + var directionalClassName; + var orderClassName; + var eventDirectionName; + + if (direction === DIRECTION_NEXT) { + directionalClassName = CLASS_NAME_LEFT; + orderClassName = CLASS_NAME_NEXT; + eventDirectionName = DIRECTION_LEFT; + } else { + directionalClassName = CLASS_NAME_RIGHT; + orderClassName = CLASS_NAME_PREV; + eventDirectionName = DIRECTION_RIGHT; + } + + if (nextElement && $__default['default'](nextElement).hasClass(CLASS_NAME_ACTIVE$1)) { + this._isSliding = false; + return; + } + + var slideEvent = this._triggerSlideEvent(nextElement, eventDirectionName); + + if (slideEvent.isDefaultPrevented()) { + return; + } + + if (!activeElement || !nextElement) { + // Some weirdness is happening, so we bail + return; + } + + this._isSliding = true; + + if (isCycling) { + this.pause(); + } + + this._setActiveIndicatorElement(nextElement); + + var slidEvent = $__default['default'].Event(EVENT_SLID, { + relatedTarget: nextElement, + direction: eventDirectionName, + from: activeElementIndex, + to: nextElementIndex + }); + + if ($__default['default'](this._element).hasClass(CLASS_NAME_SLIDE)) { + $__default['default'](nextElement).addClass(orderClassName); + Util.reflow(nextElement); + $__default['default'](activeElement).addClass(directionalClassName); + $__default['default'](nextElement).addClass(directionalClassName); + var nextElementInterval = parseInt(nextElement.getAttribute('data-interval'), 10); + + if (nextElementInterval) { + this._config.defaultInterval = this._config.defaultInterval || this._config.interval; + this._config.interval = nextElementInterval; + } else { + this._config.interval = this._config.defaultInterval || this._config.interval; + } + + var transitionDuration = Util.getTransitionDurationFromElement(activeElement); + $__default['default'](activeElement).one(Util.TRANSITION_END, function () { + $__default['default'](nextElement).removeClass(directionalClassName + " " + orderClassName).addClass(CLASS_NAME_ACTIVE$1); + $__default['default'](activeElement).removeClass(CLASS_NAME_ACTIVE$1 + " " + orderClassName + " " + directionalClassName); + _this4._isSliding = false; + setTimeout(function () { + return $__default['default'](_this4._element).trigger(slidEvent); + }, 0); + }).emulateTransitionEnd(transitionDuration); + } else { + $__default['default'](activeElement).removeClass(CLASS_NAME_ACTIVE$1); + $__default['default'](nextElement).addClass(CLASS_NAME_ACTIVE$1); + this._isSliding = false; + $__default['default'](this._element).trigger(slidEvent); + } + + if (isCycling) { + this.cycle(); + } + } // Static + ; + + Carousel._jQueryInterface = function _jQueryInterface(config) { + return this.each(function () { + var data = $__default['default'](this).data(DATA_KEY$2); + + var _config = _extends({}, Default, $__default['default'](this).data()); + + if (typeof config === 'object') { + _config = _extends({}, _config, config); + } + + var action = typeof config === 'string' ? config : _config.slide; + + if (!data) { + data = new Carousel(this, _config); + $__default['default'](this).data(DATA_KEY$2, data); + } + + if (typeof config === 'number') { + data.to(config); + } else if (typeof action === 'string') { + if (typeof data[action] === 'undefined') { + throw new TypeError("No method named \"" + action + "\""); + } + + data[action](); + } else if (_config.interval && _config.ride) { + data.pause(); + data.cycle(); + } + }); + }; + + Carousel._dataApiClickHandler = function _dataApiClickHandler(event) { + var selector = Util.getSelectorFromElement(this); + + if (!selector) { + return; + } + + var target = $__default['default'](selector)[0]; + + if (!target || !$__default['default'](target).hasClass(CLASS_NAME_CAROUSEL)) { + return; + } + + var config = _extends({}, $__default['default'](target).data(), $__default['default'](this).data()); + + var slideIndex = this.getAttribute('data-slide-to'); + + if (slideIndex) { + config.interval = false; + } + + Carousel._jQueryInterface.call($__default['default'](target), config); + + if (slideIndex) { + $__default['default'](target).data(DATA_KEY$2).to(slideIndex); + } + + event.preventDefault(); + }; + + _createClass(Carousel, null, [{ + key: "VERSION", + get: function get() { + return VERSION$2; + } + }, { + key: "Default", + get: function get() { + return Default; + } + }]); + + return Carousel; + }(); + /** + * ------------------------------------------------------------------------ + * Data Api implementation + * ------------------------------------------------------------------------ + */ + + + $__default['default'](document).on(EVENT_CLICK_DATA_API$2, SELECTOR_DATA_SLIDE, Carousel._dataApiClickHandler); + $__default['default'](window).on(EVENT_LOAD_DATA_API$1, function () { + var carousels = [].slice.call(document.querySelectorAll(SELECTOR_DATA_RIDE)); + + for (var i = 0, len = carousels.length; i < len; i++) { + var $carousel = $__default['default'](carousels[i]); + + Carousel._jQueryInterface.call($carousel, $carousel.data()); + } + }); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + $__default['default'].fn[NAME$2] = Carousel._jQueryInterface; + $__default['default'].fn[NAME$2].Constructor = Carousel; + + $__default['default'].fn[NAME$2].noConflict = function () { + $__default['default'].fn[NAME$2] = JQUERY_NO_CONFLICT$2; + return Carousel._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$3 = 'collapse'; + var VERSION$3 = '4.5.3'; + var DATA_KEY$3 = 'bs.collapse'; + var EVENT_KEY$3 = "." + DATA_KEY$3; + var DATA_API_KEY$3 = '.data-api'; + var JQUERY_NO_CONFLICT$3 = $__default['default'].fn[NAME$3]; + var Default$1 = { + toggle: true, + parent: '' + }; + var DefaultType$1 = { + toggle: 'boolean', + parent: '(string|element)' + }; + var EVENT_SHOW = "show" + EVENT_KEY$3; + var EVENT_SHOWN = "shown" + EVENT_KEY$3; + var EVENT_HIDE = "hide" + EVENT_KEY$3; + var EVENT_HIDDEN = "hidden" + EVENT_KEY$3; + var EVENT_CLICK_DATA_API$3 = "click" + EVENT_KEY$3 + DATA_API_KEY$3; + var CLASS_NAME_SHOW$1 = 'show'; + var CLASS_NAME_COLLAPSE = 'collapse'; + var CLASS_NAME_COLLAPSING = 'collapsing'; + var CLASS_NAME_COLLAPSED = 'collapsed'; + var DIMENSION_WIDTH = 'width'; + var DIMENSION_HEIGHT = 'height'; + var SELECTOR_ACTIVES = '.show, .collapsing'; + var SELECTOR_DATA_TOGGLE$1 = '[data-toggle="collapse"]'; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Collapse = /*#__PURE__*/function () { + function Collapse(element, config) { + this._isTransitioning = false; + this._element = element; + this._config = this._getConfig(config); + this._triggerArray = [].slice.call(document.querySelectorAll("[data-toggle=\"collapse\"][href=\"#" + element.id + "\"]," + ("[data-toggle=\"collapse\"][data-target=\"#" + element.id + "\"]"))); + var toggleList = [].slice.call(document.querySelectorAll(SELECTOR_DATA_TOGGLE$1)); + + for (var i = 0, len = toggleList.length; i < len; i++) { + var elem = toggleList[i]; + var selector = Util.getSelectorFromElement(elem); + var filterElement = [].slice.call(document.querySelectorAll(selector)).filter(function (foundElem) { + return foundElem === element; + }); + + if (selector !== null && filterElement.length > 0) { + this._selector = selector; + + this._triggerArray.push(elem); + } + } + + this._parent = this._config.parent ? this._getParent() : null; + + if (!this._config.parent) { + this._addAriaAndCollapsedClass(this._element, this._triggerArray); + } + + if (this._config.toggle) { + this.toggle(); + } + } // Getters + + + var _proto = Collapse.prototype; + + // Public + _proto.toggle = function toggle() { + if ($__default['default'](this._element).hasClass(CLASS_NAME_SHOW$1)) { + this.hide(); + } else { + this.show(); + } + }; + + _proto.show = function show() { + var _this = this; + + if (this._isTransitioning || $__default['default'](this._element).hasClass(CLASS_NAME_SHOW$1)) { + return; + } + + var actives; + var activesData; + + if (this._parent) { + actives = [].slice.call(this._parent.querySelectorAll(SELECTOR_ACTIVES)).filter(function (elem) { + if (typeof _this._config.parent === 'string') { + return elem.getAttribute('data-parent') === _this._config.parent; + } + + return elem.classList.contains(CLASS_NAME_COLLAPSE); + }); + + if (actives.length === 0) { + actives = null; + } + } + + if (actives) { + activesData = $__default['default'](actives).not(this._selector).data(DATA_KEY$3); + + if (activesData && activesData._isTransitioning) { + return; + } + } + + var startEvent = $__default['default'].Event(EVENT_SHOW); + $__default['default'](this._element).trigger(startEvent); + + if (startEvent.isDefaultPrevented()) { + return; + } + + if (actives) { + Collapse._jQueryInterface.call($__default['default'](actives).not(this._selector), 'hide'); + + if (!activesData) { + $__default['default'](actives).data(DATA_KEY$3, null); + } + } + + var dimension = this._getDimension(); + + $__default['default'](this._element).removeClass(CLASS_NAME_COLLAPSE).addClass(CLASS_NAME_COLLAPSING); + this._element.style[dimension] = 0; + + if (this._triggerArray.length) { + $__default['default'](this._triggerArray).removeClass(CLASS_NAME_COLLAPSED).attr('aria-expanded', true); + } + + this.setTransitioning(true); + + var complete = function complete() { + $__default['default'](_this._element).removeClass(CLASS_NAME_COLLAPSING).addClass(CLASS_NAME_COLLAPSE + " " + CLASS_NAME_SHOW$1); + _this._element.style[dimension] = ''; + + _this.setTransitioning(false); + + $__default['default'](_this._element).trigger(EVENT_SHOWN); + }; + + var capitalizedDimension = dimension[0].toUpperCase() + dimension.slice(1); + var scrollSize = "scroll" + capitalizedDimension; + var transitionDuration = Util.getTransitionDurationFromElement(this._element); + $__default['default'](this._element).one(Util.TRANSITION_END, complete).emulateTransitionEnd(transitionDuration); + this._element.style[dimension] = this._element[scrollSize] + "px"; + }; + + _proto.hide = function hide() { + var _this2 = this; + + if (this._isTransitioning || !$__default['default'](this._element).hasClass(CLASS_NAME_SHOW$1)) { + return; + } + + var startEvent = $__default['default'].Event(EVENT_HIDE); + $__default['default'](this._element).trigger(startEvent); + + if (startEvent.isDefaultPrevented()) { + return; + } + + var dimension = this._getDimension(); + + this._element.style[dimension] = this._element.getBoundingClientRect()[dimension] + "px"; + Util.reflow(this._element); + $__default['default'](this._element).addClass(CLASS_NAME_COLLAPSING).removeClass(CLASS_NAME_COLLAPSE + " " + CLASS_NAME_SHOW$1); + var triggerArrayLength = this._triggerArray.length; + + if (triggerArrayLength > 0) { + for (var i = 0; i < triggerArrayLength; i++) { + var trigger = this._triggerArray[i]; + var selector = Util.getSelectorFromElement(trigger); + + if (selector !== null) { + var $elem = $__default['default']([].slice.call(document.querySelectorAll(selector))); + + if (!$elem.hasClass(CLASS_NAME_SHOW$1)) { + $__default['default'](trigger).addClass(CLASS_NAME_COLLAPSED).attr('aria-expanded', false); + } + } + } + } + + this.setTransitioning(true); + + var complete = function complete() { + _this2.setTransitioning(false); + + $__default['default'](_this2._element).removeClass(CLASS_NAME_COLLAPSING).addClass(CLASS_NAME_COLLAPSE).trigger(EVENT_HIDDEN); + }; + + this._element.style[dimension] = ''; + var transitionDuration = Util.getTransitionDurationFromElement(this._element); + $__default['default'](this._element).one(Util.TRANSITION_END, complete).emulateTransitionEnd(transitionDuration); + }; + + _proto.setTransitioning = function setTransitioning(isTransitioning) { + this._isTransitioning = isTransitioning; + }; + + _proto.dispose = function dispose() { + $__default['default'].removeData(this._element, DATA_KEY$3); + this._config = null; + this._parent = null; + this._element = null; + this._triggerArray = null; + this._isTransitioning = null; + } // Private + ; + + _proto._getConfig = function _getConfig(config) { + config = _extends({}, Default$1, config); + config.toggle = Boolean(config.toggle); // Coerce string values + + Util.typeCheckConfig(NAME$3, config, DefaultType$1); + return config; + }; + + _proto._getDimension = function _getDimension() { + var hasWidth = $__default['default'](this._element).hasClass(DIMENSION_WIDTH); + return hasWidth ? DIMENSION_WIDTH : DIMENSION_HEIGHT; + }; + + _proto._getParent = function _getParent() { + var _this3 = this; + + var parent; + + if (Util.isElement(this._config.parent)) { + parent = this._config.parent; // It's a jQuery object + + if (typeof this._config.parent.jquery !== 'undefined') { + parent = this._config.parent[0]; + } + } else { + parent = document.querySelector(this._config.parent); + } + + var selector = "[data-toggle=\"collapse\"][data-parent=\"" + this._config.parent + "\"]"; + var children = [].slice.call(parent.querySelectorAll(selector)); + $__default['default'](children).each(function (i, element) { + _this3._addAriaAndCollapsedClass(Collapse._getTargetFromElement(element), [element]); + }); + return parent; + }; + + _proto._addAriaAndCollapsedClass = function _addAriaAndCollapsedClass(element, triggerArray) { + var isOpen = $__default['default'](element).hasClass(CLASS_NAME_SHOW$1); + + if (triggerArray.length) { + $__default['default'](triggerArray).toggleClass(CLASS_NAME_COLLAPSED, !isOpen).attr('aria-expanded', isOpen); + } + } // Static + ; + + Collapse._getTargetFromElement = function _getTargetFromElement(element) { + var selector = Util.getSelectorFromElement(element); + return selector ? document.querySelector(selector) : null; + }; + + Collapse._jQueryInterface = function _jQueryInterface(config) { + return this.each(function () { + var $element = $__default['default'](this); + var data = $element.data(DATA_KEY$3); + + var _config = _extends({}, Default$1, $element.data(), typeof config === 'object' && config ? config : {}); + + if (!data && _config.toggle && typeof config === 'string' && /show|hide/.test(config)) { + _config.toggle = false; + } + + if (!data) { + data = new Collapse(this, _config); + $element.data(DATA_KEY$3, data); + } + + if (typeof config === 'string') { + if (typeof data[config] === 'undefined') { + throw new TypeError("No method named \"" + config + "\""); + } + + data[config](); + } + }); + }; + + _createClass(Collapse, null, [{ + key: "VERSION", + get: function get() { + return VERSION$3; + } + }, { + key: "Default", + get: function get() { + return Default$1; + } + }]); + + return Collapse; + }(); + /** + * ------------------------------------------------------------------------ + * Data Api implementation + * ------------------------------------------------------------------------ + */ + + + $__default['default'](document).on(EVENT_CLICK_DATA_API$3, SELECTOR_DATA_TOGGLE$1, function (event) { + // preventDefault only for elements (which change the URL) not inside the collapsible element + if (event.currentTarget.tagName === 'A') { + event.preventDefault(); + } + + var $trigger = $__default['default'](this); + var selector = Util.getSelectorFromElement(this); + var selectors = [].slice.call(document.querySelectorAll(selector)); + $__default['default'](selectors).each(function () { + var $target = $__default['default'](this); + var data = $target.data(DATA_KEY$3); + var config = data ? 'toggle' : $trigger.data(); + + Collapse._jQueryInterface.call($target, config); + }); + }); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + $__default['default'].fn[NAME$3] = Collapse._jQueryInterface; + $__default['default'].fn[NAME$3].Constructor = Collapse; + + $__default['default'].fn[NAME$3].noConflict = function () { + $__default['default'].fn[NAME$3] = JQUERY_NO_CONFLICT$3; + return Collapse._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$4 = 'dropdown'; + var VERSION$4 = '4.5.3'; + var DATA_KEY$4 = 'bs.dropdown'; + var EVENT_KEY$4 = "." + DATA_KEY$4; + var DATA_API_KEY$4 = '.data-api'; + var JQUERY_NO_CONFLICT$4 = $__default['default'].fn[NAME$4]; + var ESCAPE_KEYCODE = 27; // KeyboardEvent.which value for Escape (Esc) key + + var SPACE_KEYCODE = 32; // KeyboardEvent.which value for space key + + var TAB_KEYCODE = 9; // KeyboardEvent.which value for tab key + + var ARROW_UP_KEYCODE = 38; // KeyboardEvent.which value for up arrow key + + var ARROW_DOWN_KEYCODE = 40; // KeyboardEvent.which value for down arrow key + + var RIGHT_MOUSE_BUTTON_WHICH = 3; // MouseEvent.which value for the right button (assuming a right-handed mouse) + + var REGEXP_KEYDOWN = new RegExp(ARROW_UP_KEYCODE + "|" + ARROW_DOWN_KEYCODE + "|" + ESCAPE_KEYCODE); + var EVENT_HIDE$1 = "hide" + EVENT_KEY$4; + var EVENT_HIDDEN$1 = "hidden" + EVENT_KEY$4; + var EVENT_SHOW$1 = "show" + EVENT_KEY$4; + var EVENT_SHOWN$1 = "shown" + EVENT_KEY$4; + var EVENT_CLICK = "click" + EVENT_KEY$4; + var EVENT_CLICK_DATA_API$4 = "click" + EVENT_KEY$4 + DATA_API_KEY$4; + var EVENT_KEYDOWN_DATA_API = "keydown" + EVENT_KEY$4 + DATA_API_KEY$4; + var EVENT_KEYUP_DATA_API = "keyup" + EVENT_KEY$4 + DATA_API_KEY$4; + var CLASS_NAME_DISABLED = 'disabled'; + var CLASS_NAME_SHOW$2 = 'show'; + var CLASS_NAME_DROPUP = 'dropup'; + var CLASS_NAME_DROPRIGHT = 'dropright'; + var CLASS_NAME_DROPLEFT = 'dropleft'; + var CLASS_NAME_MENURIGHT = 'dropdown-menu-right'; + var CLASS_NAME_POSITION_STATIC = 'position-static'; + var SELECTOR_DATA_TOGGLE$2 = '[data-toggle="dropdown"]'; + var SELECTOR_FORM_CHILD = '.dropdown form'; + var SELECTOR_MENU = '.dropdown-menu'; + var SELECTOR_NAVBAR_NAV = '.navbar-nav'; + var SELECTOR_VISIBLE_ITEMS = '.dropdown-menu .dropdown-item:not(.disabled):not(:disabled)'; + var PLACEMENT_TOP = 'top-start'; + var PLACEMENT_TOPEND = 'top-end'; + var PLACEMENT_BOTTOM = 'bottom-start'; + var PLACEMENT_BOTTOMEND = 'bottom-end'; + var PLACEMENT_RIGHT = 'right-start'; + var PLACEMENT_LEFT = 'left-start'; + var Default$2 = { + offset: 0, + flip: true, + boundary: 'scrollParent', + reference: 'toggle', + display: 'dynamic', + popperConfig: null + }; + var DefaultType$2 = { + offset: '(number|string|function)', + flip: 'boolean', + boundary: '(string|element)', + reference: '(string|element)', + display: 'string', + popperConfig: '(null|object)' + }; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Dropdown = /*#__PURE__*/function () { + function Dropdown(element, config) { + this._element = element; + this._popper = null; + this._config = this._getConfig(config); + this._menu = this._getMenuElement(); + this._inNavbar = this._detectNavbar(); + + this._addEventListeners(); + } // Getters + + + var _proto = Dropdown.prototype; + + // Public + _proto.toggle = function toggle() { + if (this._element.disabled || $__default['default'](this._element).hasClass(CLASS_NAME_DISABLED)) { + return; + } + + var isActive = $__default['default'](this._menu).hasClass(CLASS_NAME_SHOW$2); + + Dropdown._clearMenus(); + + if (isActive) { + return; + } + + this.show(true); + }; + + _proto.show = function show(usePopper) { + if (usePopper === void 0) { + usePopper = false; + } + + if (this._element.disabled || $__default['default'](this._element).hasClass(CLASS_NAME_DISABLED) || $__default['default'](this._menu).hasClass(CLASS_NAME_SHOW$2)) { + return; + } + + var relatedTarget = { + relatedTarget: this._element + }; + var showEvent = $__default['default'].Event(EVENT_SHOW$1, relatedTarget); + + var parent = Dropdown._getParentFromElement(this._element); + + $__default['default'](parent).trigger(showEvent); + + if (showEvent.isDefaultPrevented()) { + return; + } // Disable totally Popper.js for Dropdown in Navbar + + + if (!this._inNavbar && usePopper) { + /** + * Check for Popper dependency + * Popper - https://popper.js.org + */ + if (typeof Popper__default['default'] === 'undefined') { + throw new TypeError('Bootstrap\'s dropdowns require Popper.js (https://popper.js.org/)'); + } + + var referenceElement = this._element; + + if (this._config.reference === 'parent') { + referenceElement = parent; + } else if (Util.isElement(this._config.reference)) { + referenceElement = this._config.reference; // Check if it's jQuery element + + if (typeof this._config.reference.jquery !== 'undefined') { + referenceElement = this._config.reference[0]; + } + } // If boundary is not `scrollParent`, then set position to `static` + // to allow the menu to "escape" the scroll parent's boundaries + // https://github.com/twbs/bootstrap/issues/24251 + + + if (this._config.boundary !== 'scrollParent') { + $__default['default'](parent).addClass(CLASS_NAME_POSITION_STATIC); + } + + this._popper = new Popper__default['default'](referenceElement, this._menu, this._getPopperConfig()); + } // If this is a touch-enabled device we add extra + // empty mouseover listeners to the body's immediate children; + // only needed because of broken event delegation on iOS + // https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html + + + if ('ontouchstart' in document.documentElement && $__default['default'](parent).closest(SELECTOR_NAVBAR_NAV).length === 0) { + $__default['default'](document.body).children().on('mouseover', null, $__default['default'].noop); + } + + this._element.focus(); + + this._element.setAttribute('aria-expanded', true); + + $__default['default'](this._menu).toggleClass(CLASS_NAME_SHOW$2); + $__default['default'](parent).toggleClass(CLASS_NAME_SHOW$2).trigger($__default['default'].Event(EVENT_SHOWN$1, relatedTarget)); + }; + + _proto.hide = function hide() { + if (this._element.disabled || $__default['default'](this._element).hasClass(CLASS_NAME_DISABLED) || !$__default['default'](this._menu).hasClass(CLASS_NAME_SHOW$2)) { + return; + } + + var relatedTarget = { + relatedTarget: this._element + }; + var hideEvent = $__default['default'].Event(EVENT_HIDE$1, relatedTarget); + + var parent = Dropdown._getParentFromElement(this._element); + + $__default['default'](parent).trigger(hideEvent); + + if (hideEvent.isDefaultPrevented()) { + return; + } + + if (this._popper) { + this._popper.destroy(); + } + + $__default['default'](this._menu).toggleClass(CLASS_NAME_SHOW$2); + $__default['default'](parent).toggleClass(CLASS_NAME_SHOW$2).trigger($__default['default'].Event(EVENT_HIDDEN$1, relatedTarget)); + }; + + _proto.dispose = function dispose() { + $__default['default'].removeData(this._element, DATA_KEY$4); + $__default['default'](this._element).off(EVENT_KEY$4); + this._element = null; + this._menu = null; + + if (this._popper !== null) { + this._popper.destroy(); + + this._popper = null; + } + }; + + _proto.update = function update() { + this._inNavbar = this._detectNavbar(); + + if (this._popper !== null) { + this._popper.scheduleUpdate(); + } + } // Private + ; + + _proto._addEventListeners = function _addEventListeners() { + var _this = this; + + $__default['default'](this._element).on(EVENT_CLICK, function (event) { + event.preventDefault(); + event.stopPropagation(); + + _this.toggle(); + }); + }; + + _proto._getConfig = function _getConfig(config) { + config = _extends({}, this.constructor.Default, $__default['default'](this._element).data(), config); + Util.typeCheckConfig(NAME$4, config, this.constructor.DefaultType); + return config; + }; + + _proto._getMenuElement = function _getMenuElement() { + if (!this._menu) { + var parent = Dropdown._getParentFromElement(this._element); + + if (parent) { + this._menu = parent.querySelector(SELECTOR_MENU); + } + } + + return this._menu; + }; + + _proto._getPlacement = function _getPlacement() { + var $parentDropdown = $__default['default'](this._element.parentNode); + var placement = PLACEMENT_BOTTOM; // Handle dropup + + if ($parentDropdown.hasClass(CLASS_NAME_DROPUP)) { + placement = $__default['default'](this._menu).hasClass(CLASS_NAME_MENURIGHT) ? PLACEMENT_TOPEND : PLACEMENT_TOP; + } else if ($parentDropdown.hasClass(CLASS_NAME_DROPRIGHT)) { + placement = PLACEMENT_RIGHT; + } else if ($parentDropdown.hasClass(CLASS_NAME_DROPLEFT)) { + placement = PLACEMENT_LEFT; + } else if ($__default['default'](this._menu).hasClass(CLASS_NAME_MENURIGHT)) { + placement = PLACEMENT_BOTTOMEND; + } + + return placement; + }; + + _proto._detectNavbar = function _detectNavbar() { + return $__default['default'](this._element).closest('.navbar').length > 0; + }; + + _proto._getOffset = function _getOffset() { + var _this2 = this; + + var offset = {}; + + if (typeof this._config.offset === 'function') { + offset.fn = function (data) { + data.offsets = _extends({}, data.offsets, _this2._config.offset(data.offsets, _this2._element) || {}); + return data; + }; + } else { + offset.offset = this._config.offset; + } + + return offset; + }; + + _proto._getPopperConfig = function _getPopperConfig() { + var popperConfig = { + placement: this._getPlacement(), + modifiers: { + offset: this._getOffset(), + flip: { + enabled: this._config.flip + }, + preventOverflow: { + boundariesElement: this._config.boundary + } + } + }; // Disable Popper.js if we have a static display + + if (this._config.display === 'static') { + popperConfig.modifiers.applyStyle = { + enabled: false + }; + } + + return _extends({}, popperConfig, this._config.popperConfig); + } // Static + ; + + Dropdown._jQueryInterface = function _jQueryInterface(config) { + return this.each(function () { + var data = $__default['default'](this).data(DATA_KEY$4); + + var _config = typeof config === 'object' ? config : null; + + if (!data) { + data = new Dropdown(this, _config); + $__default['default'](this).data(DATA_KEY$4, data); + } + + if (typeof config === 'string') { + if (typeof data[config] === 'undefined') { + throw new TypeError("No method named \"" + config + "\""); + } + + data[config](); + } + }); + }; + + Dropdown._clearMenus = function _clearMenus(event) { + if (event && (event.which === RIGHT_MOUSE_BUTTON_WHICH || event.type === 'keyup' && event.which !== TAB_KEYCODE)) { + return; + } + + var toggles = [].slice.call(document.querySelectorAll(SELECTOR_DATA_TOGGLE$2)); + + for (var i = 0, len = toggles.length; i < len; i++) { + var parent = Dropdown._getParentFromElement(toggles[i]); + + var context = $__default['default'](toggles[i]).data(DATA_KEY$4); + var relatedTarget = { + relatedTarget: toggles[i] + }; + + if (event && event.type === 'click') { + relatedTarget.clickEvent = event; + } + + if (!context) { + continue; + } + + var dropdownMenu = context._menu; + + if (!$__default['default'](parent).hasClass(CLASS_NAME_SHOW$2)) { + continue; + } + + if (event && (event.type === 'click' && /input|textarea/i.test(event.target.tagName) || event.type === 'keyup' && event.which === TAB_KEYCODE) && $__default['default'].contains(parent, event.target)) { + continue; + } + + var hideEvent = $__default['default'].Event(EVENT_HIDE$1, relatedTarget); + $__default['default'](parent).trigger(hideEvent); + + if (hideEvent.isDefaultPrevented()) { + continue; + } // If this is a touch-enabled device we remove the extra + // empty mouseover listeners we added for iOS support + + + if ('ontouchstart' in document.documentElement) { + $__default['default'](document.body).children().off('mouseover', null, $__default['default'].noop); + } + + toggles[i].setAttribute('aria-expanded', 'false'); + + if (context._popper) { + context._popper.destroy(); + } + + $__default['default'](dropdownMenu).removeClass(CLASS_NAME_SHOW$2); + $__default['default'](parent).removeClass(CLASS_NAME_SHOW$2).trigger($__default['default'].Event(EVENT_HIDDEN$1, relatedTarget)); + } + }; + + Dropdown._getParentFromElement = function _getParentFromElement(element) { + var parent; + var selector = Util.getSelectorFromElement(element); + + if (selector) { + parent = document.querySelector(selector); + } + + return parent || element.parentNode; + } // eslint-disable-next-line complexity + ; + + Dropdown._dataApiKeydownHandler = function _dataApiKeydownHandler(event) { + // If not input/textarea: + // - And not a key in REGEXP_KEYDOWN => not a dropdown command + // If input/textarea: + // - If space key => not a dropdown command + // - If key is other than escape + // - If key is not up or down => not a dropdown command + // - If trigger inside the menu => not a dropdown command + if (/input|textarea/i.test(event.target.tagName) ? event.which === SPACE_KEYCODE || event.which !== ESCAPE_KEYCODE && (event.which !== ARROW_DOWN_KEYCODE && event.which !== ARROW_UP_KEYCODE || $__default['default'](event.target).closest(SELECTOR_MENU).length) : !REGEXP_KEYDOWN.test(event.which)) { + return; + } + + if (this.disabled || $__default['default'](this).hasClass(CLASS_NAME_DISABLED)) { + return; + } + + var parent = Dropdown._getParentFromElement(this); + + var isActive = $__default['default'](parent).hasClass(CLASS_NAME_SHOW$2); + + if (!isActive && event.which === ESCAPE_KEYCODE) { + return; + } + + event.preventDefault(); + event.stopPropagation(); + + if (!isActive || event.which === ESCAPE_KEYCODE || event.which === SPACE_KEYCODE) { + if (event.which === ESCAPE_KEYCODE) { + $__default['default'](parent.querySelector(SELECTOR_DATA_TOGGLE$2)).trigger('focus'); + } + + $__default['default'](this).trigger('click'); + return; + } + + var items = [].slice.call(parent.querySelectorAll(SELECTOR_VISIBLE_ITEMS)).filter(function (item) { + return $__default['default'](item).is(':visible'); + }); + + if (items.length === 0) { + return; + } + + var index = items.indexOf(event.target); + + if (event.which === ARROW_UP_KEYCODE && index > 0) { + // Up + index--; + } + + if (event.which === ARROW_DOWN_KEYCODE && index < items.length - 1) { + // Down + index++; + } + + if (index < 0) { + index = 0; + } + + items[index].focus(); + }; + + _createClass(Dropdown, null, [{ + key: "VERSION", + get: function get() { + return VERSION$4; + } + }, { + key: "Default", + get: function get() { + return Default$2; + } + }, { + key: "DefaultType", + get: function get() { + return DefaultType$2; + } + }]); + + return Dropdown; + }(); + /** + * ------------------------------------------------------------------------ + * Data Api implementation + * ------------------------------------------------------------------------ + */ + + + $__default['default'](document).on(EVENT_KEYDOWN_DATA_API, SELECTOR_DATA_TOGGLE$2, Dropdown._dataApiKeydownHandler).on(EVENT_KEYDOWN_DATA_API, SELECTOR_MENU, Dropdown._dataApiKeydownHandler).on(EVENT_CLICK_DATA_API$4 + " " + EVENT_KEYUP_DATA_API, Dropdown._clearMenus).on(EVENT_CLICK_DATA_API$4, SELECTOR_DATA_TOGGLE$2, function (event) { + event.preventDefault(); + event.stopPropagation(); + + Dropdown._jQueryInterface.call($__default['default'](this), 'toggle'); + }).on(EVENT_CLICK_DATA_API$4, SELECTOR_FORM_CHILD, function (e) { + e.stopPropagation(); + }); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + $__default['default'].fn[NAME$4] = Dropdown._jQueryInterface; + $__default['default'].fn[NAME$4].Constructor = Dropdown; + + $__default['default'].fn[NAME$4].noConflict = function () { + $__default['default'].fn[NAME$4] = JQUERY_NO_CONFLICT$4; + return Dropdown._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$5 = 'modal'; + var VERSION$5 = '4.5.3'; + var DATA_KEY$5 = 'bs.modal'; + var EVENT_KEY$5 = "." + DATA_KEY$5; + var DATA_API_KEY$5 = '.data-api'; + var JQUERY_NO_CONFLICT$5 = $__default['default'].fn[NAME$5]; + var ESCAPE_KEYCODE$1 = 27; // KeyboardEvent.which value for Escape (Esc) key + + var Default$3 = { + backdrop: true, + keyboard: true, + focus: true, + show: true + }; + var DefaultType$3 = { + backdrop: '(boolean|string)', + keyboard: 'boolean', + focus: 'boolean', + show: 'boolean' + }; + var EVENT_HIDE$2 = "hide" + EVENT_KEY$5; + var EVENT_HIDE_PREVENTED = "hidePrevented" + EVENT_KEY$5; + var EVENT_HIDDEN$2 = "hidden" + EVENT_KEY$5; + var EVENT_SHOW$2 = "show" + EVENT_KEY$5; + var EVENT_SHOWN$2 = "shown" + EVENT_KEY$5; + var EVENT_FOCUSIN = "focusin" + EVENT_KEY$5; + var EVENT_RESIZE = "resize" + EVENT_KEY$5; + var EVENT_CLICK_DISMISS = "click.dismiss" + EVENT_KEY$5; + var EVENT_KEYDOWN_DISMISS = "keydown.dismiss" + EVENT_KEY$5; + var EVENT_MOUSEUP_DISMISS = "mouseup.dismiss" + EVENT_KEY$5; + var EVENT_MOUSEDOWN_DISMISS = "mousedown.dismiss" + EVENT_KEY$5; + var EVENT_CLICK_DATA_API$5 = "click" + EVENT_KEY$5 + DATA_API_KEY$5; + var CLASS_NAME_SCROLLABLE = 'modal-dialog-scrollable'; + var CLASS_NAME_SCROLLBAR_MEASURER = 'modal-scrollbar-measure'; + var CLASS_NAME_BACKDROP = 'modal-backdrop'; + var CLASS_NAME_OPEN = 'modal-open'; + var CLASS_NAME_FADE$1 = 'fade'; + var CLASS_NAME_SHOW$3 = 'show'; + var CLASS_NAME_STATIC = 'modal-static'; + var SELECTOR_DIALOG = '.modal-dialog'; + var SELECTOR_MODAL_BODY = '.modal-body'; + var SELECTOR_DATA_TOGGLE$3 = '[data-toggle="modal"]'; + var SELECTOR_DATA_DISMISS = '[data-dismiss="modal"]'; + var SELECTOR_FIXED_CONTENT = '.fixed-top, .fixed-bottom, .is-fixed, .sticky-top'; + var SELECTOR_STICKY_CONTENT = '.sticky-top'; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Modal = /*#__PURE__*/function () { + function Modal(element, config) { + this._config = this._getConfig(config); + this._element = element; + this._dialog = element.querySelector(SELECTOR_DIALOG); + this._backdrop = null; + this._isShown = false; + this._isBodyOverflowing = false; + this._ignoreBackdropClick = false; + this._isTransitioning = false; + this._scrollbarWidth = 0; + } // Getters + + + var _proto = Modal.prototype; + + // Public + _proto.toggle = function toggle(relatedTarget) { + return this._isShown ? this.hide() : this.show(relatedTarget); + }; + + _proto.show = function show(relatedTarget) { + var _this = this; + + if (this._isShown || this._isTransitioning) { + return; + } + + if ($__default['default'](this._element).hasClass(CLASS_NAME_FADE$1)) { + this._isTransitioning = true; + } + + var showEvent = $__default['default'].Event(EVENT_SHOW$2, { + relatedTarget: relatedTarget + }); + $__default['default'](this._element).trigger(showEvent); + + if (this._isShown || showEvent.isDefaultPrevented()) { + return; + } + + this._isShown = true; + + this._checkScrollbar(); + + this._setScrollbar(); + + this._adjustDialog(); + + this._setEscapeEvent(); + + this._setResizeEvent(); + + $__default['default'](this._element).on(EVENT_CLICK_DISMISS, SELECTOR_DATA_DISMISS, function (event) { + return _this.hide(event); + }); + $__default['default'](this._dialog).on(EVENT_MOUSEDOWN_DISMISS, function () { + $__default['default'](_this._element).one(EVENT_MOUSEUP_DISMISS, function (event) { + if ($__default['default'](event.target).is(_this._element)) { + _this._ignoreBackdropClick = true; + } + }); + }); + + this._showBackdrop(function () { + return _this._showElement(relatedTarget); + }); + }; + + _proto.hide = function hide(event) { + var _this2 = this; + + if (event) { + event.preventDefault(); + } + + if (!this._isShown || this._isTransitioning) { + return; + } + + var hideEvent = $__default['default'].Event(EVENT_HIDE$2); + $__default['default'](this._element).trigger(hideEvent); + + if (!this._isShown || hideEvent.isDefaultPrevented()) { + return; + } + + this._isShown = false; + var transition = $__default['default'](this._element).hasClass(CLASS_NAME_FADE$1); + + if (transition) { + this._isTransitioning = true; + } + + this._setEscapeEvent(); + + this._setResizeEvent(); + + $__default['default'](document).off(EVENT_FOCUSIN); + $__default['default'](this._element).removeClass(CLASS_NAME_SHOW$3); + $__default['default'](this._element).off(EVENT_CLICK_DISMISS); + $__default['default'](this._dialog).off(EVENT_MOUSEDOWN_DISMISS); + + if (transition) { + var transitionDuration = Util.getTransitionDurationFromElement(this._element); + $__default['default'](this._element).one(Util.TRANSITION_END, function (event) { + return _this2._hideModal(event); + }).emulateTransitionEnd(transitionDuration); + } else { + this._hideModal(); + } + }; + + _proto.dispose = function dispose() { + [window, this._element, this._dialog].forEach(function (htmlElement) { + return $__default['default'](htmlElement).off(EVENT_KEY$5); + }); + /** + * `document` has 2 events `EVENT_FOCUSIN` and `EVENT_CLICK_DATA_API` + * Do not move `document` in `htmlElements` array + * It will remove `EVENT_CLICK_DATA_API` event that should remain + */ + + $__default['default'](document).off(EVENT_FOCUSIN); + $__default['default'].removeData(this._element, DATA_KEY$5); + this._config = null; + this._element = null; + this._dialog = null; + this._backdrop = null; + this._isShown = null; + this._isBodyOverflowing = null; + this._ignoreBackdropClick = null; + this._isTransitioning = null; + this._scrollbarWidth = null; + }; + + _proto.handleUpdate = function handleUpdate() { + this._adjustDialog(); + } // Private + ; + + _proto._getConfig = function _getConfig(config) { + config = _extends({}, Default$3, config); + Util.typeCheckConfig(NAME$5, config, DefaultType$3); + return config; + }; + + _proto._triggerBackdropTransition = function _triggerBackdropTransition() { + var _this3 = this; + + if (this._config.backdrop === 'static') { + var hideEventPrevented = $__default['default'].Event(EVENT_HIDE_PREVENTED); + $__default['default'](this._element).trigger(hideEventPrevented); + + if (hideEventPrevented.isDefaultPrevented()) { + return; + } + + var isModalOverflowing = this._element.scrollHeight > document.documentElement.clientHeight; + + if (!isModalOverflowing) { + this._element.style.overflowY = 'hidden'; + } + + this._element.classList.add(CLASS_NAME_STATIC); + + var modalTransitionDuration = Util.getTransitionDurationFromElement(this._dialog); + $__default['default'](this._element).off(Util.TRANSITION_END); + $__default['default'](this._element).one(Util.TRANSITION_END, function () { + _this3._element.classList.remove(CLASS_NAME_STATIC); + + if (!isModalOverflowing) { + $__default['default'](_this3._element).one(Util.TRANSITION_END, function () { + _this3._element.style.overflowY = ''; + }).emulateTransitionEnd(_this3._element, modalTransitionDuration); + } + }).emulateTransitionEnd(modalTransitionDuration); + + this._element.focus(); + } else { + this.hide(); + } + }; + + _proto._showElement = function _showElement(relatedTarget) { + var _this4 = this; + + var transition = $__default['default'](this._element).hasClass(CLASS_NAME_FADE$1); + var modalBody = this._dialog ? this._dialog.querySelector(SELECTOR_MODAL_BODY) : null; + + if (!this._element.parentNode || this._element.parentNode.nodeType !== Node.ELEMENT_NODE) { + // Don't move modal's DOM position + document.body.appendChild(this._element); + } + + this._element.style.display = 'block'; + + this._element.removeAttribute('aria-hidden'); + + this._element.setAttribute('aria-modal', true); + + this._element.setAttribute('role', 'dialog'); + + if ($__default['default'](this._dialog).hasClass(CLASS_NAME_SCROLLABLE) && modalBody) { + modalBody.scrollTop = 0; + } else { + this._element.scrollTop = 0; + } + + if (transition) { + Util.reflow(this._element); + } + + $__default['default'](this._element).addClass(CLASS_NAME_SHOW$3); + + if (this._config.focus) { + this._enforceFocus(); + } + + var shownEvent = $__default['default'].Event(EVENT_SHOWN$2, { + relatedTarget: relatedTarget + }); + + var transitionComplete = function transitionComplete() { + if (_this4._config.focus) { + _this4._element.focus(); + } + + _this4._isTransitioning = false; + $__default['default'](_this4._element).trigger(shownEvent); + }; + + if (transition) { + var transitionDuration = Util.getTransitionDurationFromElement(this._dialog); + $__default['default'](this._dialog).one(Util.TRANSITION_END, transitionComplete).emulateTransitionEnd(transitionDuration); + } else { + transitionComplete(); + } + }; + + _proto._enforceFocus = function _enforceFocus() { + var _this5 = this; + + $__default['default'](document).off(EVENT_FOCUSIN) // Guard against infinite focus loop + .on(EVENT_FOCUSIN, function (event) { + if (document !== event.target && _this5._element !== event.target && $__default['default'](_this5._element).has(event.target).length === 0) { + _this5._element.focus(); + } + }); + }; + + _proto._setEscapeEvent = function _setEscapeEvent() { + var _this6 = this; + + if (this._isShown) { + $__default['default'](this._element).on(EVENT_KEYDOWN_DISMISS, function (event) { + if (_this6._config.keyboard && event.which === ESCAPE_KEYCODE$1) { + event.preventDefault(); + + _this6.hide(); + } else if (!_this6._config.keyboard && event.which === ESCAPE_KEYCODE$1) { + _this6._triggerBackdropTransition(); + } + }); + } else if (!this._isShown) { + $__default['default'](this._element).off(EVENT_KEYDOWN_DISMISS); + } + }; + + _proto._setResizeEvent = function _setResizeEvent() { + var _this7 = this; + + if (this._isShown) { + $__default['default'](window).on(EVENT_RESIZE, function (event) { + return _this7.handleUpdate(event); + }); + } else { + $__default['default'](window).off(EVENT_RESIZE); + } + }; + + _proto._hideModal = function _hideModal() { + var _this8 = this; + + this._element.style.display = 'none'; + + this._element.setAttribute('aria-hidden', true); + + this._element.removeAttribute('aria-modal'); + + this._element.removeAttribute('role'); + + this._isTransitioning = false; + + this._showBackdrop(function () { + $__default['default'](document.body).removeClass(CLASS_NAME_OPEN); + + _this8._resetAdjustments(); + + _this8._resetScrollbar(); + + $__default['default'](_this8._element).trigger(EVENT_HIDDEN$2); + }); + }; + + _proto._removeBackdrop = function _removeBackdrop() { + if (this._backdrop) { + $__default['default'](this._backdrop).remove(); + this._backdrop = null; + } + }; + + _proto._showBackdrop = function _showBackdrop(callback) { + var _this9 = this; + + var animate = $__default['default'](this._element).hasClass(CLASS_NAME_FADE$1) ? CLASS_NAME_FADE$1 : ''; + + if (this._isShown && this._config.backdrop) { + this._backdrop = document.createElement('div'); + this._backdrop.className = CLASS_NAME_BACKDROP; + + if (animate) { + this._backdrop.classList.add(animate); + } + + $__default['default'](this._backdrop).appendTo(document.body); + $__default['default'](this._element).on(EVENT_CLICK_DISMISS, function (event) { + if (_this9._ignoreBackdropClick) { + _this9._ignoreBackdropClick = false; + return; + } + + if (event.target !== event.currentTarget) { + return; + } + + _this9._triggerBackdropTransition(); + }); + + if (animate) { + Util.reflow(this._backdrop); + } + + $__default['default'](this._backdrop).addClass(CLASS_NAME_SHOW$3); + + if (!callback) { + return; + } + + if (!animate) { + callback(); + return; + } + + var backdropTransitionDuration = Util.getTransitionDurationFromElement(this._backdrop); + $__default['default'](this._backdrop).one(Util.TRANSITION_END, callback).emulateTransitionEnd(backdropTransitionDuration); + } else if (!this._isShown && this._backdrop) { + $__default['default'](this._backdrop).removeClass(CLASS_NAME_SHOW$3); + + var callbackRemove = function callbackRemove() { + _this9._removeBackdrop(); + + if (callback) { + callback(); + } + }; + + if ($__default['default'](this._element).hasClass(CLASS_NAME_FADE$1)) { + var _backdropTransitionDuration = Util.getTransitionDurationFromElement(this._backdrop); + + $__default['default'](this._backdrop).one(Util.TRANSITION_END, callbackRemove).emulateTransitionEnd(_backdropTransitionDuration); + } else { + callbackRemove(); + } + } else if (callback) { + callback(); + } + } // ---------------------------------------------------------------------- + // the following methods are used to handle overflowing modals + // todo (fat): these should probably be refactored out of modal.js + // ---------------------------------------------------------------------- + ; + + _proto._adjustDialog = function _adjustDialog() { + var isModalOverflowing = this._element.scrollHeight > document.documentElement.clientHeight; + + if (!this._isBodyOverflowing && isModalOverflowing) { + this._element.style.paddingLeft = this._scrollbarWidth + "px"; + } + + if (this._isBodyOverflowing && !isModalOverflowing) { + this._element.style.paddingRight = this._scrollbarWidth + "px"; + } + }; + + _proto._resetAdjustments = function _resetAdjustments() { + this._element.style.paddingLeft = ''; + this._element.style.paddingRight = ''; + }; + + _proto._checkScrollbar = function _checkScrollbar() { + var rect = document.body.getBoundingClientRect(); + this._isBodyOverflowing = Math.round(rect.left + rect.right) < window.innerWidth; + this._scrollbarWidth = this._getScrollbarWidth(); + }; + + _proto._setScrollbar = function _setScrollbar() { + var _this10 = this; + + if (this._isBodyOverflowing) { + // Note: DOMNode.style.paddingRight returns the actual value or '' if not set + // while $(DOMNode).css('padding-right') returns the calculated value or 0 if not set + var fixedContent = [].slice.call(document.querySelectorAll(SELECTOR_FIXED_CONTENT)); + var stickyContent = [].slice.call(document.querySelectorAll(SELECTOR_STICKY_CONTENT)); // Adjust fixed content padding + + $__default['default'](fixedContent).each(function (index, element) { + var actualPadding = element.style.paddingRight; + var calculatedPadding = $__default['default'](element).css('padding-right'); + $__default['default'](element).data('padding-right', actualPadding).css('padding-right', parseFloat(calculatedPadding) + _this10._scrollbarWidth + "px"); + }); // Adjust sticky content margin + + $__default['default'](stickyContent).each(function (index, element) { + var actualMargin = element.style.marginRight; + var calculatedMargin = $__default['default'](element).css('margin-right'); + $__default['default'](element).data('margin-right', actualMargin).css('margin-right', parseFloat(calculatedMargin) - _this10._scrollbarWidth + "px"); + }); // Adjust body padding + + var actualPadding = document.body.style.paddingRight; + var calculatedPadding = $__default['default'](document.body).css('padding-right'); + $__default['default'](document.body).data('padding-right', actualPadding).css('padding-right', parseFloat(calculatedPadding) + this._scrollbarWidth + "px"); + } + + $__default['default'](document.body).addClass(CLASS_NAME_OPEN); + }; + + _proto._resetScrollbar = function _resetScrollbar() { + // Restore fixed content padding + var fixedContent = [].slice.call(document.querySelectorAll(SELECTOR_FIXED_CONTENT)); + $__default['default'](fixedContent).each(function (index, element) { + var padding = $__default['default'](element).data('padding-right'); + $__default['default'](element).removeData('padding-right'); + element.style.paddingRight = padding ? padding : ''; + }); // Restore sticky content + + var elements = [].slice.call(document.querySelectorAll("" + SELECTOR_STICKY_CONTENT)); + $__default['default'](elements).each(function (index, element) { + var margin = $__default['default'](element).data('margin-right'); + + if (typeof margin !== 'undefined') { + $__default['default'](element).css('margin-right', margin).removeData('margin-right'); + } + }); // Restore body padding + + var padding = $__default['default'](document.body).data('padding-right'); + $__default['default'](document.body).removeData('padding-right'); + document.body.style.paddingRight = padding ? padding : ''; + }; + + _proto._getScrollbarWidth = function _getScrollbarWidth() { + // thx d.walsh + var scrollDiv = document.createElement('div'); + scrollDiv.className = CLASS_NAME_SCROLLBAR_MEASURER; + document.body.appendChild(scrollDiv); + var scrollbarWidth = scrollDiv.getBoundingClientRect().width - scrollDiv.clientWidth; + document.body.removeChild(scrollDiv); + return scrollbarWidth; + } // Static + ; + + Modal._jQueryInterface = function _jQueryInterface(config, relatedTarget) { + return this.each(function () { + var data = $__default['default'](this).data(DATA_KEY$5); + + var _config = _extends({}, Default$3, $__default['default'](this).data(), typeof config === 'object' && config ? config : {}); + + if (!data) { + data = new Modal(this, _config); + $__default['default'](this).data(DATA_KEY$5, data); + } + + if (typeof config === 'string') { + if (typeof data[config] === 'undefined') { + throw new TypeError("No method named \"" + config + "\""); + } + + data[config](relatedTarget); + } else if (_config.show) { + data.show(relatedTarget); + } + }); + }; + + _createClass(Modal, null, [{ + key: "VERSION", + get: function get() { + return VERSION$5; + } + }, { + key: "Default", + get: function get() { + return Default$3; + } + }]); + + return Modal; + }(); + /** + * ------------------------------------------------------------------------ + * Data Api implementation + * ------------------------------------------------------------------------ + */ + + + $__default['default'](document).on(EVENT_CLICK_DATA_API$5, SELECTOR_DATA_TOGGLE$3, function (event) { + var _this11 = this; + + var target; + var selector = Util.getSelectorFromElement(this); + + if (selector) { + target = document.querySelector(selector); + } + + var config = $__default['default'](target).data(DATA_KEY$5) ? 'toggle' : _extends({}, $__default['default'](target).data(), $__default['default'](this).data()); + + if (this.tagName === 'A' || this.tagName === 'AREA') { + event.preventDefault(); + } + + var $target = $__default['default'](target).one(EVENT_SHOW$2, function (showEvent) { + if (showEvent.isDefaultPrevented()) { + // Only register focus restorer if modal will actually get shown + return; + } + + $target.one(EVENT_HIDDEN$2, function () { + if ($__default['default'](_this11).is(':visible')) { + _this11.focus(); + } + }); + }); + + Modal._jQueryInterface.call($__default['default'](target), config, this); + }); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + $__default['default'].fn[NAME$5] = Modal._jQueryInterface; + $__default['default'].fn[NAME$5].Constructor = Modal; + + $__default['default'].fn[NAME$5].noConflict = function () { + $__default['default'].fn[NAME$5] = JQUERY_NO_CONFLICT$5; + return Modal._jQueryInterface; + }; + + /** + * -------------------------------------------------------------------------- + * Bootstrap (v4.5.3): tools/sanitizer.js + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + * -------------------------------------------------------------------------- + */ + var uriAttrs = ['background', 'cite', 'href', 'itemtype', 'longdesc', 'poster', 'src', 'xlink:href']; + var ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i; + var DefaultWhitelist = { + // Global attributes allowed on any supplied element below. + '*': ['class', 'dir', 'id', 'lang', 'role', ARIA_ATTRIBUTE_PATTERN], + a: ['target', 'href', 'title', 'rel'], + area: [], + b: [], + br: [], + col: [], + code: [], + div: [], + em: [], + hr: [], + h1: [], + h2: [], + h3: [], + h4: [], + h5: [], + h6: [], + i: [], + img: ['src', 'srcset', 'alt', 'title', 'width', 'height'], + li: [], + ol: [], + p: [], + pre: [], + s: [], + small: [], + span: [], + sub: [], + sup: [], + strong: [], + u: [], + ul: [] + }; + /** + * A pattern that recognizes a commonly useful subset of URLs that are safe. + * + * Shoutout to Angular 7 https://github.com/angular/angular/blob/7.2.4/packages/core/src/sanitization/url_sanitizer.ts + */ + + var SAFE_URL_PATTERN = /^(?:(?:https?|mailto|ftp|tel|file):|[^#&/:?]*(?:[#/?]|$))/gi; + /** + * A pattern that matches safe data URLs. Only matches image, video and audio types. + * + * Shoutout to Angular 7 https://github.com/angular/angular/blob/7.2.4/packages/core/src/sanitization/url_sanitizer.ts + */ + + var DATA_URL_PATTERN = /^data:(?:image\/(?:bmp|gif|jpeg|jpg|png|tiff|webp)|video\/(?:mpeg|mp4|ogg|webm)|audio\/(?:mp3|oga|ogg|opus));base64,[\d+/a-z]+=*$/i; + + function allowedAttribute(attr, allowedAttributeList) { + var attrName = attr.nodeName.toLowerCase(); + + if (allowedAttributeList.indexOf(attrName) !== -1) { + if (uriAttrs.indexOf(attrName) !== -1) { + return Boolean(attr.nodeValue.match(SAFE_URL_PATTERN) || attr.nodeValue.match(DATA_URL_PATTERN)); + } + + return true; + } + + var regExp = allowedAttributeList.filter(function (attrRegex) { + return attrRegex instanceof RegExp; + }); // Check if a regular expression validates the attribute. + + for (var i = 0, len = regExp.length; i < len; i++) { + if (attrName.match(regExp[i])) { + return true; + } + } + + return false; + } + + function sanitizeHtml(unsafeHtml, whiteList, sanitizeFn) { + if (unsafeHtml.length === 0) { + return unsafeHtml; + } + + if (sanitizeFn && typeof sanitizeFn === 'function') { + return sanitizeFn(unsafeHtml); + } + + var domParser = new window.DOMParser(); + var createdDocument = domParser.parseFromString(unsafeHtml, 'text/html'); + var whitelistKeys = Object.keys(whiteList); + var elements = [].slice.call(createdDocument.body.querySelectorAll('*')); + + var _loop = function _loop(i, len) { + var el = elements[i]; + var elName = el.nodeName.toLowerCase(); + + if (whitelistKeys.indexOf(el.nodeName.toLowerCase()) === -1) { + el.parentNode.removeChild(el); + return "continue"; + } + + var attributeList = [].slice.call(el.attributes); + var whitelistedAttributes = [].concat(whiteList['*'] || [], whiteList[elName] || []); + attributeList.forEach(function (attr) { + if (!allowedAttribute(attr, whitelistedAttributes)) { + el.removeAttribute(attr.nodeName); + } + }); + }; + + for (var i = 0, len = elements.length; i < len; i++) { + var _ret = _loop(i); + + if (_ret === "continue") continue; + } + + return createdDocument.body.innerHTML; + } + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$6 = 'tooltip'; + var VERSION$6 = '4.5.3'; + var DATA_KEY$6 = 'bs.tooltip'; + var EVENT_KEY$6 = "." + DATA_KEY$6; + var JQUERY_NO_CONFLICT$6 = $__default['default'].fn[NAME$6]; + var CLASS_PREFIX = 'bs-tooltip'; + var BSCLS_PREFIX_REGEX = new RegExp("(^|\\s)" + CLASS_PREFIX + "\\S+", 'g'); + var DISALLOWED_ATTRIBUTES = ['sanitize', 'whiteList', 'sanitizeFn']; + var DefaultType$4 = { + animation: 'boolean', + template: 'string', + title: '(string|element|function)', + trigger: 'string', + delay: '(number|object)', + html: 'boolean', + selector: '(string|boolean)', + placement: '(string|function)', + offset: '(number|string|function)', + container: '(string|element|boolean)', + fallbackPlacement: '(string|array)', + boundary: '(string|element)', + sanitize: 'boolean', + sanitizeFn: '(null|function)', + whiteList: 'object', + popperConfig: '(null|object)' + }; + var AttachmentMap = { + AUTO: 'auto', + TOP: 'top', + RIGHT: 'right', + BOTTOM: 'bottom', + LEFT: 'left' + }; + var Default$4 = { + animation: true, + template: '', + trigger: 'hover focus', + title: '', + delay: 0, + html: false, + selector: false, + placement: 'top', + offset: 0, + container: false, + fallbackPlacement: 'flip', + boundary: 'scrollParent', + sanitize: true, + sanitizeFn: null, + whiteList: DefaultWhitelist, + popperConfig: null + }; + var HOVER_STATE_SHOW = 'show'; + var HOVER_STATE_OUT = 'out'; + var Event = { + HIDE: "hide" + EVENT_KEY$6, + HIDDEN: "hidden" + EVENT_KEY$6, + SHOW: "show" + EVENT_KEY$6, + SHOWN: "shown" + EVENT_KEY$6, + INSERTED: "inserted" + EVENT_KEY$6, + CLICK: "click" + EVENT_KEY$6, + FOCUSIN: "focusin" + EVENT_KEY$6, + FOCUSOUT: "focusout" + EVENT_KEY$6, + MOUSEENTER: "mouseenter" + EVENT_KEY$6, + MOUSELEAVE: "mouseleave" + EVENT_KEY$6 + }; + var CLASS_NAME_FADE$2 = 'fade'; + var CLASS_NAME_SHOW$4 = 'show'; + var SELECTOR_TOOLTIP_INNER = '.tooltip-inner'; + var SELECTOR_ARROW = '.arrow'; + var TRIGGER_HOVER = 'hover'; + var TRIGGER_FOCUS = 'focus'; + var TRIGGER_CLICK = 'click'; + var TRIGGER_MANUAL = 'manual'; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Tooltip = /*#__PURE__*/function () { + function Tooltip(element, config) { + if (typeof Popper__default['default'] === 'undefined') { + throw new TypeError('Bootstrap\'s tooltips require Popper.js (https://popper.js.org/)'); + } // private + + + this._isEnabled = true; + this._timeout = 0; + this._hoverState = ''; + this._activeTrigger = {}; + this._popper = null; // Protected + + this.element = element; + this.config = this._getConfig(config); + this.tip = null; + + this._setListeners(); + } // Getters + + + var _proto = Tooltip.prototype; + + // Public + _proto.enable = function enable() { + this._isEnabled = true; + }; + + _proto.disable = function disable() { + this._isEnabled = false; + }; + + _proto.toggleEnabled = function toggleEnabled() { + this._isEnabled = !this._isEnabled; + }; + + _proto.toggle = function toggle(event) { + if (!this._isEnabled) { + return; + } + + if (event) { + var dataKey = this.constructor.DATA_KEY; + var context = $__default['default'](event.currentTarget).data(dataKey); + + if (!context) { + context = new this.constructor(event.currentTarget, this._getDelegateConfig()); + $__default['default'](event.currentTarget).data(dataKey, context); + } + + context._activeTrigger.click = !context._activeTrigger.click; + + if (context._isWithActiveTrigger()) { + context._enter(null, context); + } else { + context._leave(null, context); + } + } else { + if ($__default['default'](this.getTipElement()).hasClass(CLASS_NAME_SHOW$4)) { + this._leave(null, this); + + return; + } + + this._enter(null, this); + } + }; + + _proto.dispose = function dispose() { + clearTimeout(this._timeout); + $__default['default'].removeData(this.element, this.constructor.DATA_KEY); + $__default['default'](this.element).off(this.constructor.EVENT_KEY); + $__default['default'](this.element).closest('.modal').off('hide.bs.modal', this._hideModalHandler); + + if (this.tip) { + $__default['default'](this.tip).remove(); + } + + this._isEnabled = null; + this._timeout = null; + this._hoverState = null; + this._activeTrigger = null; + + if (this._popper) { + this._popper.destroy(); + } + + this._popper = null; + this.element = null; + this.config = null; + this.tip = null; + }; + + _proto.show = function show() { + var _this = this; + + if ($__default['default'](this.element).css('display') === 'none') { + throw new Error('Please use show on visible elements'); + } + + var showEvent = $__default['default'].Event(this.constructor.Event.SHOW); + + if (this.isWithContent() && this._isEnabled) { + $__default['default'](this.element).trigger(showEvent); + var shadowRoot = Util.findShadowRoot(this.element); + var isInTheDom = $__default['default'].contains(shadowRoot !== null ? shadowRoot : this.element.ownerDocument.documentElement, this.element); + + if (showEvent.isDefaultPrevented() || !isInTheDom) { + return; + } + + var tip = this.getTipElement(); + var tipId = Util.getUID(this.constructor.NAME); + tip.setAttribute('id', tipId); + this.element.setAttribute('aria-describedby', tipId); + this.setContent(); + + if (this.config.animation) { + $__default['default'](tip).addClass(CLASS_NAME_FADE$2); + } + + var placement = typeof this.config.placement === 'function' ? this.config.placement.call(this, tip, this.element) : this.config.placement; + + var attachment = this._getAttachment(placement); + + this.addAttachmentClass(attachment); + + var container = this._getContainer(); + + $__default['default'](tip).data(this.constructor.DATA_KEY, this); + + if (!$__default['default'].contains(this.element.ownerDocument.documentElement, this.tip)) { + $__default['default'](tip).appendTo(container); + } + + $__default['default'](this.element).trigger(this.constructor.Event.INSERTED); + this._popper = new Popper__default['default'](this.element, tip, this._getPopperConfig(attachment)); + $__default['default'](tip).addClass(CLASS_NAME_SHOW$4); // If this is a touch-enabled device we add extra + // empty mouseover listeners to the body's immediate children; + // only needed because of broken event delegation on iOS + // https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html + + if ('ontouchstart' in document.documentElement) { + $__default['default'](document.body).children().on('mouseover', null, $__default['default'].noop); + } + + var complete = function complete() { + if (_this.config.animation) { + _this._fixTransition(); + } + + var prevHoverState = _this._hoverState; + _this._hoverState = null; + $__default['default'](_this.element).trigger(_this.constructor.Event.SHOWN); + + if (prevHoverState === HOVER_STATE_OUT) { + _this._leave(null, _this); + } + }; + + if ($__default['default'](this.tip).hasClass(CLASS_NAME_FADE$2)) { + var transitionDuration = Util.getTransitionDurationFromElement(this.tip); + $__default['default'](this.tip).one(Util.TRANSITION_END, complete).emulateTransitionEnd(transitionDuration); + } else { + complete(); + } + } + }; + + _proto.hide = function hide(callback) { + var _this2 = this; + + var tip = this.getTipElement(); + var hideEvent = $__default['default'].Event(this.constructor.Event.HIDE); + + var complete = function complete() { + if (_this2._hoverState !== HOVER_STATE_SHOW && tip.parentNode) { + tip.parentNode.removeChild(tip); + } + + _this2._cleanTipClass(); + + _this2.element.removeAttribute('aria-describedby'); + + $__default['default'](_this2.element).trigger(_this2.constructor.Event.HIDDEN); + + if (_this2._popper !== null) { + _this2._popper.destroy(); + } + + if (callback) { + callback(); + } + }; + + $__default['default'](this.element).trigger(hideEvent); + + if (hideEvent.isDefaultPrevented()) { + return; + } + + $__default['default'](tip).removeClass(CLASS_NAME_SHOW$4); // If this is a touch-enabled device we remove the extra + // empty mouseover listeners we added for iOS support + + if ('ontouchstart' in document.documentElement) { + $__default['default'](document.body).children().off('mouseover', null, $__default['default'].noop); + } + + this._activeTrigger[TRIGGER_CLICK] = false; + this._activeTrigger[TRIGGER_FOCUS] = false; + this._activeTrigger[TRIGGER_HOVER] = false; + + if ($__default['default'](this.tip).hasClass(CLASS_NAME_FADE$2)) { + var transitionDuration = Util.getTransitionDurationFromElement(tip); + $__default['default'](tip).one(Util.TRANSITION_END, complete).emulateTransitionEnd(transitionDuration); + } else { + complete(); + } + + this._hoverState = ''; + }; + + _proto.update = function update() { + if (this._popper !== null) { + this._popper.scheduleUpdate(); + } + } // Protected + ; + + _proto.isWithContent = function isWithContent() { + return Boolean(this.getTitle()); + }; + + _proto.addAttachmentClass = function addAttachmentClass(attachment) { + $__default['default'](this.getTipElement()).addClass(CLASS_PREFIX + "-" + attachment); + }; + + _proto.getTipElement = function getTipElement() { + this.tip = this.tip || $__default['default'](this.config.template)[0]; + return this.tip; + }; + + _proto.setContent = function setContent() { + var tip = this.getTipElement(); + this.setElementContent($__default['default'](tip.querySelectorAll(SELECTOR_TOOLTIP_INNER)), this.getTitle()); + $__default['default'](tip).removeClass(CLASS_NAME_FADE$2 + " " + CLASS_NAME_SHOW$4); + }; + + _proto.setElementContent = function setElementContent($element, content) { + if (typeof content === 'object' && (content.nodeType || content.jquery)) { + // Content is a DOM node or a jQuery + if (this.config.html) { + if (!$__default['default'](content).parent().is($element)) { + $element.empty().append(content); + } + } else { + $element.text($__default['default'](content).text()); + } + + return; + } + + if (this.config.html) { + if (this.config.sanitize) { + content = sanitizeHtml(content, this.config.whiteList, this.config.sanitizeFn); + } + + $element.html(content); + } else { + $element.text(content); + } + }; + + _proto.getTitle = function getTitle() { + var title = this.element.getAttribute('data-original-title'); + + if (!title) { + title = typeof this.config.title === 'function' ? this.config.title.call(this.element) : this.config.title; + } + + return title; + } // Private + ; + + _proto._getPopperConfig = function _getPopperConfig(attachment) { + var _this3 = this; + + var defaultBsConfig = { + placement: attachment, + modifiers: { + offset: this._getOffset(), + flip: { + behavior: this.config.fallbackPlacement + }, + arrow: { + element: SELECTOR_ARROW + }, + preventOverflow: { + boundariesElement: this.config.boundary + } + }, + onCreate: function onCreate(data) { + if (data.originalPlacement !== data.placement) { + _this3._handlePopperPlacementChange(data); + } + }, + onUpdate: function onUpdate(data) { + return _this3._handlePopperPlacementChange(data); + } + }; + return _extends({}, defaultBsConfig, this.config.popperConfig); + }; + + _proto._getOffset = function _getOffset() { + var _this4 = this; + + var offset = {}; + + if (typeof this.config.offset === 'function') { + offset.fn = function (data) { + data.offsets = _extends({}, data.offsets, _this4.config.offset(data.offsets, _this4.element) || {}); + return data; + }; + } else { + offset.offset = this.config.offset; + } + + return offset; + }; + + _proto._getContainer = function _getContainer() { + if (this.config.container === false) { + return document.body; + } + + if (Util.isElement(this.config.container)) { + return $__default['default'](this.config.container); + } + + return $__default['default'](document).find(this.config.container); + }; + + _proto._getAttachment = function _getAttachment(placement) { + return AttachmentMap[placement.toUpperCase()]; + }; + + _proto._setListeners = function _setListeners() { + var _this5 = this; + + var triggers = this.config.trigger.split(' '); + triggers.forEach(function (trigger) { + if (trigger === 'click') { + $__default['default'](_this5.element).on(_this5.constructor.Event.CLICK, _this5.config.selector, function (event) { + return _this5.toggle(event); + }); + } else if (trigger !== TRIGGER_MANUAL) { + var eventIn = trigger === TRIGGER_HOVER ? _this5.constructor.Event.MOUSEENTER : _this5.constructor.Event.FOCUSIN; + var eventOut = trigger === TRIGGER_HOVER ? _this5.constructor.Event.MOUSELEAVE : _this5.constructor.Event.FOCUSOUT; + $__default['default'](_this5.element).on(eventIn, _this5.config.selector, function (event) { + return _this5._enter(event); + }).on(eventOut, _this5.config.selector, function (event) { + return _this5._leave(event); + }); + } + }); + + this._hideModalHandler = function () { + if (_this5.element) { + _this5.hide(); + } + }; + + $__default['default'](this.element).closest('.modal').on('hide.bs.modal', this._hideModalHandler); + + if (this.config.selector) { + this.config = _extends({}, this.config, { + trigger: 'manual', + selector: '' + }); + } else { + this._fixTitle(); + } + }; + + _proto._fixTitle = function _fixTitle() { + var titleType = typeof this.element.getAttribute('data-original-title'); + + if (this.element.getAttribute('title') || titleType !== 'string') { + this.element.setAttribute('data-original-title', this.element.getAttribute('title') || ''); + this.element.setAttribute('title', ''); + } + }; + + _proto._enter = function _enter(event, context) { + var dataKey = this.constructor.DATA_KEY; + context = context || $__default['default'](event.currentTarget).data(dataKey); + + if (!context) { + context = new this.constructor(event.currentTarget, this._getDelegateConfig()); + $__default['default'](event.currentTarget).data(dataKey, context); + } + + if (event) { + context._activeTrigger[event.type === 'focusin' ? TRIGGER_FOCUS : TRIGGER_HOVER] = true; + } + + if ($__default['default'](context.getTipElement()).hasClass(CLASS_NAME_SHOW$4) || context._hoverState === HOVER_STATE_SHOW) { + context._hoverState = HOVER_STATE_SHOW; + return; + } + + clearTimeout(context._timeout); + context._hoverState = HOVER_STATE_SHOW; + + if (!context.config.delay || !context.config.delay.show) { + context.show(); + return; + } + + context._timeout = setTimeout(function () { + if (context._hoverState === HOVER_STATE_SHOW) { + context.show(); + } + }, context.config.delay.show); + }; + + _proto._leave = function _leave(event, context) { + var dataKey = this.constructor.DATA_KEY; + context = context || $__default['default'](event.currentTarget).data(dataKey); + + if (!context) { + context = new this.constructor(event.currentTarget, this._getDelegateConfig()); + $__default['default'](event.currentTarget).data(dataKey, context); + } + + if (event) { + context._activeTrigger[event.type === 'focusout' ? TRIGGER_FOCUS : TRIGGER_HOVER] = false; + } + + if (context._isWithActiveTrigger()) { + return; + } + + clearTimeout(context._timeout); + context._hoverState = HOVER_STATE_OUT; + + if (!context.config.delay || !context.config.delay.hide) { + context.hide(); + return; + } + + context._timeout = setTimeout(function () { + if (context._hoverState === HOVER_STATE_OUT) { + context.hide(); + } + }, context.config.delay.hide); + }; + + _proto._isWithActiveTrigger = function _isWithActiveTrigger() { + for (var trigger in this._activeTrigger) { + if (this._activeTrigger[trigger]) { + return true; + } + } + + return false; + }; + + _proto._getConfig = function _getConfig(config) { + var dataAttributes = $__default['default'](this.element).data(); + Object.keys(dataAttributes).forEach(function (dataAttr) { + if (DISALLOWED_ATTRIBUTES.indexOf(dataAttr) !== -1) { + delete dataAttributes[dataAttr]; + } + }); + config = _extends({}, this.constructor.Default, dataAttributes, typeof config === 'object' && config ? config : {}); + + if (typeof config.delay === 'number') { + config.delay = { + show: config.delay, + hide: config.delay + }; + } + + if (typeof config.title === 'number') { + config.title = config.title.toString(); + } + + if (typeof config.content === 'number') { + config.content = config.content.toString(); + } + + Util.typeCheckConfig(NAME$6, config, this.constructor.DefaultType); + + if (config.sanitize) { + config.template = sanitizeHtml(config.template, config.whiteList, config.sanitizeFn); + } + + return config; + }; + + _proto._getDelegateConfig = function _getDelegateConfig() { + var config = {}; + + if (this.config) { + for (var key in this.config) { + if (this.constructor.Default[key] !== this.config[key]) { + config[key] = this.config[key]; + } + } + } + + return config; + }; + + _proto._cleanTipClass = function _cleanTipClass() { + var $tip = $__default['default'](this.getTipElement()); + var tabClass = $tip.attr('class').match(BSCLS_PREFIX_REGEX); + + if (tabClass !== null && tabClass.length) { + $tip.removeClass(tabClass.join('')); + } + }; + + _proto._handlePopperPlacementChange = function _handlePopperPlacementChange(popperData) { + this.tip = popperData.instance.popper; + + this._cleanTipClass(); + + this.addAttachmentClass(this._getAttachment(popperData.placement)); + }; + + _proto._fixTransition = function _fixTransition() { + var tip = this.getTipElement(); + var initConfigAnimation = this.config.animation; + + if (tip.getAttribute('x-placement') !== null) { + return; + } + + $__default['default'](tip).removeClass(CLASS_NAME_FADE$2); + this.config.animation = false; + this.hide(); + this.show(); + this.config.animation = initConfigAnimation; + } // Static + ; + + Tooltip._jQueryInterface = function _jQueryInterface(config) { + return this.each(function () { + var $element = $__default['default'](this); + var data = $element.data(DATA_KEY$6); + + var _config = typeof config === 'object' && config; + + if (!data && /dispose|hide/.test(config)) { + return; + } + + if (!data) { + data = new Tooltip(this, _config); + $element.data(DATA_KEY$6, data); + } + + if (typeof config === 'string') { + if (typeof data[config] === 'undefined') { + throw new TypeError("No method named \"" + config + "\""); + } + + data[config](); + } + }); + }; + + _createClass(Tooltip, null, [{ + key: "VERSION", + get: function get() { + return VERSION$6; + } + }, { + key: "Default", + get: function get() { + return Default$4; + } + }, { + key: "NAME", + get: function get() { + return NAME$6; + } + }, { + key: "DATA_KEY", + get: function get() { + return DATA_KEY$6; + } + }, { + key: "Event", + get: function get() { + return Event; + } + }, { + key: "EVENT_KEY", + get: function get() { + return EVENT_KEY$6; + } + }, { + key: "DefaultType", + get: function get() { + return DefaultType$4; + } + }]); + + return Tooltip; + }(); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + + $__default['default'].fn[NAME$6] = Tooltip._jQueryInterface; + $__default['default'].fn[NAME$6].Constructor = Tooltip; + + $__default['default'].fn[NAME$6].noConflict = function () { + $__default['default'].fn[NAME$6] = JQUERY_NO_CONFLICT$6; + return Tooltip._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$7 = 'popover'; + var VERSION$7 = '4.5.3'; + var DATA_KEY$7 = 'bs.popover'; + var EVENT_KEY$7 = "." + DATA_KEY$7; + var JQUERY_NO_CONFLICT$7 = $__default['default'].fn[NAME$7]; + var CLASS_PREFIX$1 = 'bs-popover'; + var BSCLS_PREFIX_REGEX$1 = new RegExp("(^|\\s)" + CLASS_PREFIX$1 + "\\S+", 'g'); + + var Default$5 = _extends({}, Tooltip.Default, { + placement: 'right', + trigger: 'click', + content: '', + template: '' + }); + + var DefaultType$5 = _extends({}, Tooltip.DefaultType, { + content: '(string|element|function)' + }); + + var CLASS_NAME_FADE$3 = 'fade'; + var CLASS_NAME_SHOW$5 = 'show'; + var SELECTOR_TITLE = '.popover-header'; + var SELECTOR_CONTENT = '.popover-body'; + var Event$1 = { + HIDE: "hide" + EVENT_KEY$7, + HIDDEN: "hidden" + EVENT_KEY$7, + SHOW: "show" + EVENT_KEY$7, + SHOWN: "shown" + EVENT_KEY$7, + INSERTED: "inserted" + EVENT_KEY$7, + CLICK: "click" + EVENT_KEY$7, + FOCUSIN: "focusin" + EVENT_KEY$7, + FOCUSOUT: "focusout" + EVENT_KEY$7, + MOUSEENTER: "mouseenter" + EVENT_KEY$7, + MOUSELEAVE: "mouseleave" + EVENT_KEY$7 + }; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var Popover = /*#__PURE__*/function (_Tooltip) { + _inheritsLoose(Popover, _Tooltip); + + function Popover() { + return _Tooltip.apply(this, arguments) || this; + } + + var _proto = Popover.prototype; + + // Overrides + _proto.isWithContent = function isWithContent() { + return this.getTitle() || this._getContent(); + }; + + _proto.addAttachmentClass = function addAttachmentClass(attachment) { + $__default['default'](this.getTipElement()).addClass(CLASS_PREFIX$1 + "-" + attachment); + }; + + _proto.getTipElement = function getTipElement() { + this.tip = this.tip || $__default['default'](this.config.template)[0]; + return this.tip; + }; + + _proto.setContent = function setContent() { + var $tip = $__default['default'](this.getTipElement()); // We use append for html objects to maintain js events + + this.setElementContent($tip.find(SELECTOR_TITLE), this.getTitle()); + + var content = this._getContent(); + + if (typeof content === 'function') { + content = content.call(this.element); + } + + this.setElementContent($tip.find(SELECTOR_CONTENT), content); + $tip.removeClass(CLASS_NAME_FADE$3 + " " + CLASS_NAME_SHOW$5); + } // Private + ; + + _proto._getContent = function _getContent() { + return this.element.getAttribute('data-content') || this.config.content; + }; + + _proto._cleanTipClass = function _cleanTipClass() { + var $tip = $__default['default'](this.getTipElement()); + var tabClass = $tip.attr('class').match(BSCLS_PREFIX_REGEX$1); + + if (tabClass !== null && tabClass.length > 0) { + $tip.removeClass(tabClass.join('')); + } + } // Static + ; + + Popover._jQueryInterface = function _jQueryInterface(config) { + return this.each(function () { + var data = $__default['default'](this).data(DATA_KEY$7); + + var _config = typeof config === 'object' ? config : null; + + if (!data && /dispose|hide/.test(config)) { + return; + } + + if (!data) { + data = new Popover(this, _config); + $__default['default'](this).data(DATA_KEY$7, data); + } + + if (typeof config === 'string') { + if (typeof data[config] === 'undefined') { + throw new TypeError("No method named \"" + config + "\""); + } + + data[config](); + } + }); + }; + + _createClass(Popover, null, [{ + key: "VERSION", + // Getters + get: function get() { + return VERSION$7; + } + }, { + key: "Default", + get: function get() { + return Default$5; + } + }, { + key: "NAME", + get: function get() { + return NAME$7; + } + }, { + key: "DATA_KEY", + get: function get() { + return DATA_KEY$7; + } + }, { + key: "Event", + get: function get() { + return Event$1; + } + }, { + key: "EVENT_KEY", + get: function get() { + return EVENT_KEY$7; + } + }, { + key: "DefaultType", + get: function get() { + return DefaultType$5; + } + }]); + + return Popover; + }(Tooltip); + /** + * ------------------------------------------------------------------------ + * jQuery + * ------------------------------------------------------------------------ + */ + + + $__default['default'].fn[NAME$7] = Popover._jQueryInterface; + $__default['default'].fn[NAME$7].Constructor = Popover; + + $__default['default'].fn[NAME$7].noConflict = function () { + $__default['default'].fn[NAME$7] = JQUERY_NO_CONFLICT$7; + return Popover._jQueryInterface; + }; + + /** + * ------------------------------------------------------------------------ + * Constants + * ------------------------------------------------------------------------ + */ + + var NAME$8 = 'scrollspy'; + var VERSION$8 = '4.5.3'; + var DATA_KEY$8 = 'bs.scrollspy'; + var EVENT_KEY$8 = "." + DATA_KEY$8; + var DATA_API_KEY$6 = '.data-api'; + var JQUERY_NO_CONFLICT$8 = $__default['default'].fn[NAME$8]; + var Default$6 = { + offset: 10, + method: 'auto', + target: '' + }; + var DefaultType$6 = { + offset: 'number', + method: 'string', + target: '(string|element)' + }; + var EVENT_ACTIVATE = "activate" + EVENT_KEY$8; + var EVENT_SCROLL = "scroll" + EVENT_KEY$8; + var EVENT_LOAD_DATA_API$2 = "load" + EVENT_KEY$8 + DATA_API_KEY$6; + var CLASS_NAME_DROPDOWN_ITEM = 'dropdown-item'; + var CLASS_NAME_ACTIVE$2 = 'active'; + var SELECTOR_DATA_SPY = '[data-spy="scroll"]'; + var SELECTOR_NAV_LIST_GROUP = '.nav, .list-group'; + var SELECTOR_NAV_LINKS = '.nav-link'; + var SELECTOR_NAV_ITEMS = '.nav-item'; + var SELECTOR_LIST_ITEMS = '.list-group-item'; + var SELECTOR_DROPDOWN = '.dropdown'; + var SELECTOR_DROPDOWN_ITEMS = '.dropdown-item'; + var SELECTOR_DROPDOWN_TOGGLE = '.dropdown-toggle'; + var METHOD_OFFSET = 'offset'; + var METHOD_POSITION = 'position'; + /** + * ------------------------------------------------------------------------ + * Class Definition + * ------------------------------------------------------------------------ + */ + + var ScrollSpy = /*#__PURE__*/function () { + function ScrollSpy(element, config) { + var _this = this; + + this._element = element; + this._scrollElement = element.tagName === 'BODY' ? window : element; + this._config = this._getConfig(config); + this._selector = this._config.target + " " + SELECTOR_NAV_LINKS + "," + (this._config.target + " " + SELECTOR_LIST_ITEMS + ",") + (this._config.target + " " + SELECTOR_DROPDOWN_ITEMS); + this._offsets = []; + this._targets = []; + this._activeTarget = null; + this._scrollHeight = 0; + $__default['default'](this._scrollElement).on(EVENT_SCROLL, function (event) { + return _this._process(event); + }); + this.refresh(); + + this._process(); + } // Getters + + + var _proto = ScrollSpy.prototype; + + // Public + _proto.refresh = function refresh() { + var _this2 = this; + + var autoMethod = this._scrollElement === this._scrollElement.window ? METHOD_OFFSET : METHOD_POSITION; + var offsetMethod = this._config.method === 'auto' ? autoMethod : this._config.method; + var offsetBase = offsetMethod === METHOD_POSITION ? this._getScrollTop() : 0; + this._offsets = []; + this._targets = []; + this._scrollHeight = this._getScrollHeight(); + var targets = [].slice.call(document.querySelectorAll(this._selector)); + targets.map(function (element) { + var target; + var targetSelector = Util.getSelectorFromElement(element); + + if (targetSelector) { + target = document.querySelector(targetSelector); + } + + if (target) { + var targetBCR = target.getBoundingClientRect(); + + if (targetBCR.width || targetBCR.height) { + // TODO (fat): remove sketch reliance on jQuery position/offset + return [$__default['default'](target)[offsetMethod]().top + offsetBase, targetSelector]; + } + } + + return null; + }).filter(function (item) { + return item; + }).sort(function (a, b) { + return a[0] - b[0]; + }).forEach(function (item) { + _this2._offsets.push(item[0]); + + _this2._targets.push(item[1]); + }); + }; + + _proto.dispose = function dispose() { + $__default['default'].removeData(this._element, DATA_KEY$8); + $__default['default'](this._scrollElement).off(EVENT_KEY$8); + this._element = null; + this._scrollElement = null; + this._config = null; + this._selector = null; + this._offsets = null; + this._targets = null; + this._activeTarget = null; + this._scrollHeight = null; + } // Private + ; + + _proto._getConfig = function _getConfig(config) { + config = _extends({}, Default$6, typeof config === 'object' && config ? config : {}); + + if (typeof config.target !== 'string' && Util.isElement(config.target)) { + var id = $__default['default'](config.target).attr('id'); + + if (!id) { + id = Util.getUID(NAME$8); + $__default['default'](config.target).attr('id', id); + } + + config.target = "#" + id; + } + + Util.typeCheckConfig(NAME$8, config, DefaultType$6); + return config; + }; + + _proto._getScrollTop = function _getScrollTop() { + return this._scrollElement === window ? this._scrollElement.pageYOffset : this._scrollElement.scrollTop; + }; + + _proto._getScrollHeight = function _getScrollHeight() { + return this._scrollElement.scrollHeight || Math.max(document.body.scrollHeight, document.documentElement.scrollHeight); + }; + + _proto._getOffsetHeight = function _getOffsetHeight() { + return this._scrollElement === window ? window.innerHeight : this._scrollElement.getBoundingClientRect().height; + }; + + _proto._process = function _process() { + var scrollTop = this._getScrollTop() + this._config.offset; + + var scrollHeight = this._getScrollHeight(); + + var maxScroll = this._config.offset + scrollHeight - this._getOffsetHeight(); + + if (this._scrollHeight !== scrollHeight) { + this.refresh(); + } + + if (scrollTop >= maxScroll) { + var target = this._targets[this._targets.length - 1]; + + if (this._activeTarget !== target) { + this._activate(target); + } + + return; + } + + if (this._activeTarget && scrollTop < this._offsets[0] && this._offsets[0] > 0) { + this._activeTarget = null; + + this._clear(); + + return; + } + + for (var i = this._offsets.length; i--;) { + var isActiveTarget = this._activeTarget !== this._targets[i] && scrollTop >= this._offsets[i] && (typeof this._offsets[i + 1] === 'undefined' || scrollTop < this._offsets[i + 1]); + + if (isActiveTarget) { + this._activate(this._targets[i]); + } + } + }; + + _proto._activate = function _activate(target) { + this._activeTarget = target; + + this._clear(); + + var queries = this._selector.split(',').map(function (selector) { + return selector + "[data-target=\"" + target + "\"]," + selector + "[href=\"" + target + "\"]"; + }); + + var $link = $__default['default']([].slice.call(document.querySelectorAll(queries.join(',')))); + + if ($link.hasClass(CLASS_NAME_DROPDOWN_ITEM)) { + $link.closest(SELECTOR_DROPDOWN).find(SELECTOR_DROPDOWN_TOGGLE).addClass(CLASS_NAME_ACTIVE$2); + $link.addClass(CLASS_NAME_ACTIVE$2); + } else { + // Set triggered link as active + $link.addClass(CLASS_NAME_ACTIVE$2); // Set triggered links parents as active + // With both