Queue: Difference between revisions

From RawPedia
Jump to navigation Jump to search
(Fixed formatting)
m (Typo fixed GitHub issue #6300)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Open a photo for editing, tweak it, click on ''Save current image'' [[Image:gtk-save-large.png]], add it to the tail of the processing queue and click ''OK''. Go to the ''Queue'' tab. You will see your photo there, waiting to be processed.
<div class="pagetitle">The Queue</div>


The ''File format'' panel resides in the top-right side of the ''Queue'' tab. You can save to JPG (8 bits per channel), TIFF (8 or 16 bits per channel) and to PNG (also 8 or 16 bits per channel). You can also select ''Save processing parameters with image'' - this options writes a sidecar file with all your adjustments made to that photo in a plain text file. This file will have the same filename as your photo, but it will have a ".pp3" extension.
== Introduction ==


You can set where you want the resulting JPG, PNG or TIFF image saved to by entering an appropriate template in the ''Use template'' field in the ''Output Directory'' panel. To find out how to create a template, hover your mouse over the ''Use template'' input box and a tooltip with an explanation will pop up:
[[Saving Images|Saving images]] from RawTherapee can be done in several ways, the two most common of which are either saving the image immediately [[File:Save.png]] from the Editor tab, or adding it to the batch processing queue [[File:Gears.png]] which resides in the Queue tab.


You can use the following formatting strings:
Using the "Save immediately" feature will put your CPU immediately to work, and as a result, opening and tweaking other images in the Editor will be somewhat slow while the image is being saved. The queue mechanism allows you to put edited images which are ready to be saved to a virtual queue which you can start processing at a later time. Adding them to the queue is instant, so you can continue editing other images and making the most of your CPU for editing. Once you are done editing and putting images to the queue, you can flip the large "On" switch and go off to brew yourself a coffee while RawTherapee grinds away at all the images in the queue.
<b>%f</b>, <b>%d1</b>, <b>%d2</b>, ..., <b>%p1</b>, <b>%p2</b>, ..., <b>%r</b>, <b>%s1</b>, <b>%s2</b>, ...
 
The queue is persistent - you can exit RawTherapee and restart it later; the queued images will still be there. The queue can even survive a crash.
  These formatting strings refer to the different parts of the photo's pathname, some attributes of the photo or an arbitrary sequence index in the batch job.
 
== Adding Images to the Queue ==
 
There are several ways of adding an image to the queue:
# When you are done tweaking an image in the Editor, click the "Put current image to processing queue" button [[File:Gears.png]].
# Also in the Editor tab, click the "Save current image" button [[File:Save.png]] and select "Put to the head/tail of the processing queue".
# Right-click on a thumbnail in the [[File Browser]] or the [[Editor#The_Filmstrip|Filmstrip]] and select "Put to queue".
 
Regardless which method you use, when you go to the ''Queue'' tab you will see your photos lined up, ready for processing (if you had the queue set to "Auto-start", it may have finished processing before you viewed it).
 
== Queue Settings ==
 
[[File:Save window.png|thumb|500px|right|The "Save current image" window. Notice the "Force saving options" checkbox, which is disabled in the screenshot because neither of the "Put to the head/tail of the processing queue" options are enabled.]]
 
The Queue has several settings, such as the output file format and destination. These settings take effect in all cases except when you use the "Save current image" button [[File:Save.png]], select "Put to the head/tail of the processing queue" and enable the "Force saving options" checkbox. In this case, the settings seen in the "Save" window will be used, and the ones from the Queue tab ignored. In all other cases, the settings from the Queue tab will be used.
 
The settings speak for themselves. Two things worth pointing out:
# "Save processing parameters with image" will save a sidecar file alongside the output file, with the same filename as the output image but with a ".pp3" extension. This is useful when you want to save multiple copies of the same photo, each one tweaked a bit differently.
# The destination folder can be set by selecting "Save to folder", but if you need to dynamically customize the destination folder and filename then select "Use template" instead. Hover your mouse over the ''Use template'' input box and a tooltip with an explanation will pop up:
 
  Specify the output location based on the source photo's location, rank, trash status or position in the queue.
   
   
  For example, if the photo being processed has the following pathname:
  Using the following pathname as an example:
  <b><i>/home/tom/photos/2010-10-31/dsc0042.nef</i></b>
  <b>/home/tom/photos/2010-10-31/photo1.raw</b>
  the meaning of the formatting strings are:
  the meaning of the formatting strings follows:
  <b>%d4</b> = <i>home</i>
  <b>%d4</b> = <i>home</i>
  <b>%d3</b> = <i>tom</i>
  <b>%d3</b> = <i>tom</i>
  <b>%d2</b> = <i>photos</i>
  <b>%d2</b> = <i>photos</i>
  <b>%d1</b> = <i>2010-10-31</i>
  <b>%d1</b> = <i>2010-10-31</i>
  <b>%f</b> = <i>dsc0042</i>
  <b>%f</b> = <i>photo1</i>
  <b>%p1</b> = <i>/home/tom/photos/2010-10-31/</i>
  <b>%p1</b> = <i>/home/tom/photos/2010-10-31/</i>
  <b>%p2</b> = <i>/home/tom/photos/</i>
  <b>%p2</b> = <i>/home/tom/photos/</i>
Line 23: Line 43:
  <b>%p4</b> = <i>/home/</i>
  <b>%p4</b> = <i>/home/</i>
   
   
  <b>%r</b> will be replaced by the rank of the photo. If the photo is unranked, %r will be replaced by '0'. If the photo is in the trash bin, %r will be replaced by 'x'.
  <b>%r</b> will be replaced by the photo's rank. If the photo is unranked, '<i>0</i>' is used. If the photo is in the trash, '<i>x</i>' is used.
  <b>%s1</b>, <b>%s2</b>, etc. will be replaced by a sequence index which is padded to between 1 and 9 digits. The sequence index will start at one each time the queue processing is started and is incremented by one for each image processed.
  <b>%s1</b>, ..., <b>%s9</b> will be replaced by the photo's initial position in the queue at the time the queue is started. The number specifies the padding, e.g. <b>%s3</b> results in '<i>001</i>'.
   
   
  If you want to save the output image where the original is, write:
  If you want to save the output image alongside the source image, write:
  <b>%p1/%f</b>
  <b>%p1/%f</b>
   
   
  If you want to save the output image in a directory named "<i>converted</i>" located in the directory of the opened image, write:
  If you want to save the output image in a folder named '<i>converted</i>' located in the source photo's folder, write:
  <b>%p1/converted/%f</b>
  <b>%p1/converted/%f</b>
   
   
  If you want to save the output image in a directory named "<i>/home/tom/photos/converted/2010-10-31</i>", write:
  If you want to save the output image in
'<i>/home/tom/photos/converted/2010-10-31</i>', write:
  <b>%p2/converted/%d1/%f</b>
  <b>%p2/converted/%d1/%f</b>


Alternatively, you can save directly to a specific directory, but in the long run it is much easier to use a template.
== Running the Queue ==
 
In the top-left corner of the Queue tab you will find an "On/Off" switch, and an "Auto-start" checkbox.
# If "Auto-start" is enabled, processing will start as soon as an image is sent to the queue. Usually you will not want this, as this will use your CPU for processing the photos in the queue leaving very little CPU time for allowing RawTherapee to be responsive while you tweak other photos.
# If "Auto-start" is not checked, you will have to activate the queue manually by hitting the "On/Off" switch.
 
You can pause the queue by hitting the "On/Off" switch - RawTherapee will first finish processing the current photo.


On the left you see a ''Start/Stop'' processing button, and an ''Auto start'' checkbox.
== Clearing the Queue ==
If ''Auto start'' is enabled, every time a raw is sent to the queue, processing will start immediately. Usually you will not want this, as this will use up your CPU on developing the photos in the queue, and as a result all adjustments you do while the queue is running will take much longer to get applied so that you can see their effect in the preview - RT will become sluggish.
If ''Auto start'' is unchecked, you will have to activate the queue manually by clicking the ''Start processing'' button once ready to do so.
You can pause the queue by pressing the ''Stop processing'' button, but RawTherapee will first finish processing the current photo.


You can delete the contents of the processing queue by right-clicking on a thumbnail and choosing "''Select all > Cancel job''".
You can remove a specific image from the queue by clicking the small "Cancel job" [[File:Cancel-small.png]] button in the corner of each thumbnail.


You can exit the program and restart it later; the batch queue will still be there. The queue can even survive a crash of RawTherapee, as the batch queue info is written to disk each time you add a photo to it, each time a photo is done processing and each time you delete a photo from it.
You can clear the whole queue right-clicking on a thumbnail and clicking "Select all" and "Cancel job", or by using the {{k|Ctrl}} + {{k|a}} keyboard shortcut to select all thumbnails and then hitting the {{k|Delete}} key on the keyboard.

Latest revision as of 19:11, 8 July 2021

The Queue

Introduction

Saving images from RawTherapee can be done in several ways, the two most common of which are either saving the image immediately Save.png from the Editor tab, or adding it to the batch processing queue Gears.png which resides in the Queue tab.

Using the "Save immediately" feature will put your CPU immediately to work, and as a result, opening and tweaking other images in the Editor will be somewhat slow while the image is being saved. The queue mechanism allows you to put edited images which are ready to be saved to a virtual queue which you can start processing at a later time. Adding them to the queue is instant, so you can continue editing other images and making the most of your CPU for editing. Once you are done editing and putting images to the queue, you can flip the large "On" switch and go off to brew yourself a coffee while RawTherapee grinds away at all the images in the queue.

The queue is persistent - you can exit RawTherapee and restart it later; the queued images will still be there. The queue can even survive a crash.

Adding Images to the Queue

There are several ways of adding an image to the queue:

  1. When you are done tweaking an image in the Editor, click the "Put current image to processing queue" button Gears.png.
  2. Also in the Editor tab, click the "Save current image" button Save.png and select "Put to the head/tail of the processing queue".
  3. Right-click on a thumbnail in the File Browser or the Filmstrip and select "Put to queue".

Regardless which method you use, when you go to the Queue tab you will see your photos lined up, ready for processing (if you had the queue set to "Auto-start", it may have finished processing before you viewed it).

Queue Settings

The "Save current image" window. Notice the "Force saving options" checkbox, which is disabled in the screenshot because neither of the "Put to the head/tail of the processing queue" options are enabled.

The Queue has several settings, such as the output file format and destination. These settings take effect in all cases except when you use the "Save current image" button Save.png, select "Put to the head/tail of the processing queue" and enable the "Force saving options" checkbox. In this case, the settings seen in the "Save" window will be used, and the ones from the Queue tab ignored. In all other cases, the settings from the Queue tab will be used.

The settings speak for themselves. Two things worth pointing out:

  1. "Save processing parameters with image" will save a sidecar file alongside the output file, with the same filename as the output image but with a ".pp3" extension. This is useful when you want to save multiple copies of the same photo, each one tweaked a bit differently.
  2. The destination folder can be set by selecting "Save to folder", but if you need to dynamically customize the destination folder and filename then select "Use template" instead. Hover your mouse over the Use template input box and a tooltip with an explanation will pop up:
Specify the output location based on the source photo's location, rank, trash status or position in the queue.

Using the following pathname as an example:
/home/tom/photos/2010-10-31/photo1.raw
the meaning of the formatting strings follows:
%d4 = home
%d3 = tom
%d2 = photos
%d1 = 2010-10-31
%f = photo1
%p1 = /home/tom/photos/2010-10-31/
%p2 = /home/tom/photos/
%p3 = /home/tom/
%p4 = /home/

%r will be replaced by the photo's rank. If the photo is unranked, '0' is used. If the photo is in the trash, 'x' is used.

%s1, ..., %s9 will be replaced by the photo's initial position in the queue at the time the queue is started. The number specifies the padding, e.g. %s3 results in '001'.

If you want to save the output image alongside the source image, write:
%p1/%f

If you want to save the output image in a folder named 'converted' located in the source photo's folder, write:
%p1/converted/%f

If you want to save the output image in
'/home/tom/photos/converted/2010-10-31', write:
%p2/converted/%d1/%f

Running the Queue

In the top-left corner of the Queue tab you will find an "On/Off" switch, and an "Auto-start" checkbox.

  1. If "Auto-start" is enabled, processing will start as soon as an image is sent to the queue. Usually you will not want this, as this will use your CPU for processing the photos in the queue leaving very little CPU time for allowing RawTherapee to be responsive while you tweak other photos.
  2. If "Auto-start" is not checked, you will have to activate the queue manually by hitting the "On/Off" switch.

You can pause the queue by hitting the "On/Off" switch - RawTherapee will first finish processing the current photo.

Clearing the Queue

You can remove a specific image from the queue by clicking the small "Cancel job" Cancel-small.png button in the corner of each thumbnail.

You can clear the whole queue right-clicking on a thumbnail and clicking "Select all" and "Cancel job", or by using the ^ Ctrl + a keyboard shortcut to select all thumbnails and then hitting the Delete key on the keyboard.