...

Section of modes contain Zoom, Add, Move, Select, and Remove buttons with functionality literally explained by their names.

• Zoom
  Mode Zoom works for image and spectral limits.
  Zoom-in image: left mouse button click-drug-release for desired region of image.
  Set limits for spectrum: left/right mouse button click on desired min/max limit on spectrum.
  Reset to full size: middle mouse button click on image or spectral box or "Reset" button.
• Add
  Add is an input mode for forms.
  Input method for Rectangle, Circle, Wedge, and Line: in mode Add click-drug-release the left mouse button. Two points for each form are defined by the click and release positions of the mouse.
  Input method for Polygon: the N-1 points are entered by the left mouse button click, while the Nth point is indicated by the right mouse button click, which closes the polygon.
• Move
  Each form can be moved or edited in this mode;
  in mode Move choose the form, then use left/right mouse button click-drug-release on form boarder to move/edit the form.
• Select
  Forms can be used as regular "positive" for ROI, and inversed "negative" for blemish mask.
  Select button serves to switch between regular and inversed forms.
  In the Select mode choose the form, then use left mouse button click on form boarder. Form color is changed at selection/deselection.
• Remove
  In the Remove mode choose the form, then use any mouse button click on form boarder.
  As an alternative option, currently active form can be removed by the middle mouse button click on its boarder. The "Clear Forms" button from I/O section removes all forms.

I/O

• Load Image
  Loads and displays image from text file. The file name is selected through the standard pop-up dialog window.
• Load Forms
  Loads and displays forms from text file. The file name is selected through the standard pop-up dialog window.
• Save Forms
  Saves forms in text file. The file name is selected through the standard pop-up dialog window.
• Save Mask
  Saves "ROI" (positive) mask in text file. The file name is selected through the standard pop-up dialog window.
• Save inv-M(ask)
  Saves "blemish" (negative) mask in text file. The file name is selected through the standard pop-up dialog window.
• Print Forms
  Prints current forms from the list.
• Clear Forms
  Removes forms from image and from the list.

Status panel

Status panel is a single button-like panel, displaying short status messages.

...

Bottom control bar contains "Help", "Reset", "Save", "ELog", "Close" buttons, "N bins" editable field, "Grid", and "Log" check boxes.

• Help
  Shows pop-up windows with help info about navigation. Use scroll bar to read entire help message.
• Reset
  Restores original image size and spectral limits.
• Save
  Saves content of graphical window in png file. The file name is selected through the standard pop-up dialog window.
• ELog
  Serves to submit message in ELog. The content of graphical window will be added as attachment. Destination of the message is selected through the custom pop-up dialog window.
• Close
  Closes the Mask Editor application.
• Grid
  On/Off coordinate grid on image and spectrum.
• Log
  Serves as a switch between linear and log scale.
• N bins
  "N bins" field can be used to change a number of bins in spectrum. Spectrum will redraw, when edition is ended (press Enter on keyboard or change focus on other field).

How to run Mask Editor

Mask Editor is developed as a part of the integrated data processing environment for XCS time correlation experiments. In this project the Mask Editor is integrated as one of the system GUIs. Also it can be executed as a stand-alone application named med. Stand-alone version of the Mask Editor can launched on any of psana or psexport node using command-line interface, for example, for all default parameters:

...