Region of Interest Layer

From JMARS Wiki

Jump to: navigation, search

The Region of Interest (ROI) Layer, which is only available in the THEMIS release of JMARS, allows users to specify areas of Mars that should be observed with THEMIS. Entering an ROI is not a specific imaging request, but instead a suggestion for the mission planners. If a user has a specific imaging request, especially one that is time-specific, they should contact the mission planners to schedule the observation.


Image:roi_main.png


Contents


[edit] What is an ROI?

An ROI is defined as a polygon drawn in JMARS along with a description of what types of observations should be collected in that region. Once entered, the ROIs can be designated as either "Online" or "Offline".

  1. Online ROIs are stored in the database and are accessible to the owner and the mission planners, but not to other JMARS users.
  2. Offline ROIs are stored in an external file and are visible only to the user/users who load the file. They are not visible to mission planners or to other JMARS users who do not have access to the file. Offline ROIs can be turned into Online ROIs using the ROI layer.


[edit] Open the Online ROI Layer

  1. Open the ROI Layer: Chose "Add New Layer" -> "ROI" -> "Online"
  2. Enter Search Parameters: Users will usually want to display all of the available ROIs, except possibly mission planners. However, if the user would like to narrow down the number of ROIs displayed, they can enter search parameters in the input box that will appear. The allowable values for each field are given in the quick reference table below followed by more detailed descriptions of each search parameter.
  3. Perform the ROI Search: Clicking "OK" will make the ROI Layer perform the search and display the results in the Viewing Window. Even if the search is for all available ROIs, the process is relatively quick. Once the ROIs are displayed, users can mouse-over them to get their descriptions or right-click on their outlines to edit them.


Image:roi_query.png


Filter Type Acceptable Values
User Login JMARS User Name and Password - Should Be Autofilled
ROI ID #### - Four-Digit ROI ID Number
Blank - All ROI IDs
ROI Title Any Text Title
Blank - All Titles
ROI Description Any Text Description
Blank - All Descriptions
Min/Max Ls 0 - 360 - Solar Longitude (Martian Season)
Blank - All Seasons
Local Time 00:00 - 24:00
Blank - All Times
IR Band Configuration CAL - Band 10
DAY - Bands 1-10
IRSUM - Bands 2-10
NIGHT - Bands 4, 9 & 10
OFF - No IR Bands
POLAR
Triplet - Bands 4, 7, 8, 9 & 10
VIS Band Configuration Bands 2,3,4,5
Bands 2,3,5
Bands 2,4
Bands 2,4,5
ALL - Bands 1,2,3,4,5
OFF - No Vis Bands
RED - Band 3
Repeated Observation Request Yes
No
N/A - All Images
Special Instructions Request Yes
No
N/A - All Images
Special Instructions Any Text Instructions
Blank - All Instructions
High Priority Request Yes
No
N/A - All Images
Active Request Yes
No
N/A - All Images


Search Field Descriptions
  1. Enter User Login: The user's login name and password should already be auto-filled in this field. If not, or if you wish to open the ROI list of another user who has provided their password, the user can enter this information.
  2. More Options: The options under this button point the ROI layer to the database tables where the ROIs are stored. Only advanced users would ever need to change these settings.
  3. Select ROI ID: To find a specific ROI, the unique four-digit ROI ID can be entered here.
  4. Select ROI Title: The default ROI title is the date and time the ROI was added to the database. Users can also specify another title when they add or edit the ROI.
  5. Select ROI Description: The description field of the ROI is left blank by default, but users often put the name of the feature or region being targeted in this field.
  6. Min/Max Solar Longitude (Ls): This is the best way to search for ROIs by specific season. Note that a given Ls will indicate different seasons in the Northern and Southern hemispheres and that some ROIs might not be season-specific.
  7. Select Local Time: This field allows the user to search for ROIs that request images at specific times of day. Since Mars Odyssey is in a near-constant time orbit there will be very little variation in the local time except around the poles. If a user needs to request images at specific local times, they should speak with the mission planners in-person.
  8. Select IR Band Configuration: The THEMIS IR camera has ten bands and, by default, daytime IR observations use all ten bands. However, users may want to specify a different band configuration in their ROI.
  9. Select VIS Band Configuration: The THEMIS VIS camera has five bands, but the default setting for VIS images only uses band 3. Users often submit ROIs with different VIS band configurations.
  10. Select Repeated Observations: This option in the ROI allows the user to specify if observations should be repeated or if a single image of the ROI is enough. If a repeated observation is required, the frequency of the observations is usually put in the "Special Instructions Section.
  11. Select Special Instructions: This field allows users to enter information about the ROI that does not fit into any other field. Users can search for any ROI with special instructions using the drop-down box or for ROIs with specific special instructions using the text box.
  12. Select High Priority ROIs: Some ROIs are given a higher priority so that mission planners can more easily make decisions about which areas to image. Only mission planners can designate an ROI as "High Priority" so other users shouldn't need this option.
  13. Select Active ROIs: Users can designate their ROIs as either "Active" or "Inactive". Users should change any ROIs that won't be needed for a long time to "Inactive" status to help the mission planners sort through the ROIs that need to be covered at any given time. Inactive ROIs remain in the database and can be reactivated by the owner at any time.


[edit] Open the Offline ROI Layer

  1. Open the ROI Layer: Chose "Add New Layer" -> "ROI" -> "Offline"
  2. Open an ROI File: Locate an Offline ROI file from a previous session and click "Open". The Offline ROI will then be displayed in the Viewing Window.


[edit] ROI Layer Functions

The functions of the ROI Layer can be accessed by clicking on the "ROI Layer" tab in the Layer Manager, which gives users the following options:
  1. ROI Display Color: This option allows users to change the color of the ROIs so they are visible on the maps in the Viewing Window. The color palate is accessed by clicking on the empty white box.
  2. ROI List: All of the ROIs found by the ROI Layer during the initial search are displayed in this list. These ROIs can be sorted according to any of the columns by clicking on the title of the column the user wants to sort by. Clicking on an entry will also recenter the Main and Panner Views on the selected ROI.
  3. ROI Buttons: The three buttons in the middle of the screen allow the user to save or access ROIs. The "Commit ROIs" button will save any new or edited ROIs to the ROI database. The "Save to File" button will save the selected ROI to a file that can later be retrieved as an Offline ROI. The "Go Online" button will connect the ROI Layer to the ROI database, which usually occurs automatically when the layer is opened.
  4. ROI Attributes & Parameters: When the user left-clicks on an ROI displayed in the Viewing Window, the various parameters associated with the ROI are displayed in this section. (These are the same fields described in the "Search Field Descriptions" section above.)


[edit] Creating an ROI

  1. Change to Add Mode: With the ROI Layer open, right-click in the Main View and chose "Add Mode" near the location you want to designate as an ROI.
  2. Draw ROI Box: Left-click to place the corners of the ROI polygon on the map. When more than one point has been placed, a line will be drawn between the points. When the polygon has been closed (the last point should be placed on top of the first point), the "Attributes and Parameters" section of the ROI Layer tab will become active and values can be entered.
  3. Enter ROI Parameters: Enter all of the necessary ROI attributes, parameters and descriptions in the focus panel fields.
  4. Commit ROI: When all the edits are done, click the "Commit ROIs" button to commit the changes to the database.
  5. Verify Addition: To check that the addition was made properly, mouse-over the new ROI in the Viewing Window and the associated parameters will be displayed on the tooltip.


[edit] Editting an ROI

  1. Select an ROI: With the ROI Layer open, select an ROI in the Viewing Window with a left-click.
  2. View ROI Parameters:In the ROI Layer Tab of the Layer Manager, the parameters of the selected ROI are displayed in the "Attributes and Parameters" Section.
  3. Edit ROI Parameters: Edit any of the values or text.
  4. Edit ROI Dimensions: To edit the dimensions or shape of the ROI box in the Viewing Window, left-click on a corner points and drag it to the desired location.
  5. Commit ROI: When all edits are done, click the "Commit ROIs" button to commit the changes to the database.
  6. Verify Edits: To check that the changes were made properly, mouse-over the ROI in the Viewing Window and the new parameters will be displayed on the tooltip.


[edit] Related Pages

Retrieved from "http://jmars.asu.edu/wiki/index.php/Region_of_Interest_Layer"