Capture Image of Window Dialog

This purpose of this dialog is to capture images of Caret windows.  It is available by selecting File Menu->Capture Image of Window.

It is also possible to generate images of a data set from the command line.


Scenes may be useful when capturing images of some windows, particularly the graphics windows (where brain models are drawn).  Creating a scene at the time of the window capture allows one to quickly reproduce all of the display settings, loaded files, open windows, etc. during a future Caret session.  This can save substantial time if the figure needs to be "tweaked" or shown to a colleague in the future.  See the Display Control's Scene Page and the Scenes FAQ for more information.

Capturing Images of Caret Window

It should be possible to capture images of most, if not all, of Caret's windows.  On most Caret dialogs and windows, using the context menu (click the right mouse button Linux and Windows or hold down the CONTROL button and click the mouse on Mac OSX) will place an image of the dialog or window onto the clipboard.  With some windows in Caret, it may be necessary to do the mouse click on the window's titlebar.

Capture Image of Section

This section of the dialog is used to select the region or window that will be captured. 

Windows That May Be Captured
Images Per Row - This value is used only when capturing images of the Main Window and Open Viewing Window graphics areas.  It sets the number of images that are in each row of the composite image.

A Note About Capturing Windows

When capturing images of "Windows" (not graphics areas), it is important that there are no other windows obscuring the window that is being captured.  Otherwise, any overlaying windows will appear in the captured image.  When entire windows are captured, a screen capture is performed covering the pixels occupied by the desired window.

Capture Image Options Section

Automatically Crop Image - This checkbox is enabled only when capturing the graphics area of the main window, the graphics area of a viewing window, or the combined image of the main windows and open viewing windows' graphics areas.  When this item is selected, the image of the graphics area will be cropped so that the background is removed from the sides of the brain model.

Margin - This value is the number of pixels in the background image that remain on each side of the brain model when Automatically Crop Image is selected.

Popup Dialog to Adjust Captured Image Size - If this item is checked, a dialog for adjusting the image size appears after the image is captured but prior to sending the image to its destination.

Image Destination

This section determines destination of the captured image and it is permissible to have multiple destinations.

Add to Loaded Images - If selected, the captured image is added to the images loaded in Caret and may be viewed in the Main Window, the Image Editor Window, or a Image Viewing Window.

Copy to Clipboard - If selected, the captured image is added to the computer system's clipboard so that it may be pasted into a program such as Adobe Photoshop or Microsoft Word.  Note that the image's resolution (ie: dots per inch) does not get copied to the clipboard.

Print Image - A Print Dialog appears after the image is captured so that the user may choose the printer and other printing related options.

Save to File - Saves the captured image into an image file.  Options for saving the file are contained in the File Save Options section.

File Save Options

Add to Spec File - If checked the image's filename is added to the spec file.

Name - Pressing this button will popup a file selection dialog for choose the directory and filename in which the image will be stored.

Format - The desired image file format.  JPEG (jpg) is recommended.


Capture - Press this button to start the image capture process.

Help - Displays this Help Page.

Close - Closes this dialog.

Image Size Dialog

This dialog appears if the Capture Image Options'  Popup Dialog to Adjust Captured Image Size checkbox is checked.  It allows the user to adjust the size of the captured image.

Pixel Dimensions Section

This section contains the size of the image in pixels.  When the width or height values are changed, the Image Size width and height are automatically adjusted.

Image Size Section

This section contains the size of the image in U.S. Customary (also called Engish or Imperial) Units or Metric Units. 

Width and Height - The width or height of the image may be set in centimeters, inches, millimeters.  As this width or height is adjusted, the Pixel Dimensions of the image will automatically change.

Resolution - This controls the number of pixels per unit of measure.  As the resolution value is adjusted, the Pixel Dimensions of the image will automatically change.

Options Section

Keep Aspect Ratio - If this checkbox is checked, the aspect ratio is preserved as the Pixel Dimensions Width or Height or Image Size Width or Height are changed.  This prevents distortion of the image as the image's size is changed.  So, as a Width (Height) value is adjusted, its corresponding Height (Widget) is adjusted to preserve the aspect ratio of the image. 


OK - Applies the selections to the image and closes the dialog.

Cancel - Closes the dialog without altering the image.

Example Image Captures

Desktop - This captures an image of the computer's desktop.      

Main Window Graphics Area

Main Window Graphics Area with Automatically Crop Image selected

Main Window Including Toolbar

Main Window and Open Viewing Window Graphics Areas

Viewing an Image in the Main Window

An image can be set as a background for the Main Window.  When images are loaded into Caret, the Images Page is enabled on the Display Control Dialog.  To display an image in the Main Window background, check the Show Image in Main Window checkbox and select the desired image by clicking the radio button next to the image name.

Viewing an Image in an Image Viewing Window

From the Window Menu, select New Image Viewing Window.  A control at the top of the Image Viewing Window is used to select the image for display in the window.

Editing Images in Caret

From the Window Menu, select Image Editor.  A control at the top of the Image Editor Window is provided for selection of the image.  Toolbar buttons are available for Opening, Saving, Printing, Copying to clipboard, Anotating, Cropping, and Resizing of the image.

Pasting Images into Photoshop

Pasting Images into Microsoft Word

Capturing Images on the Command Line

The caret_command program can be used to generate images of sufaces, volumes, and scenes from the command line.  Running any of the following commands without any additional arguments will print information on how to use the command.  Running just "caret_command" will list all available commands. 
An example data set that demonstrates a sequence of the above commands is available for download from  In the data set is a file named "".  This file is a Python language script that will function on all operating systems provided Python is installed and "caret_command" is in the user's PATH environment variable.  The image generated by the python script is shown below.

image from command line

Creating a Montage of All Loaded Metrics on a Single Surface

image montage