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 THEMIS science team members to specify areas of Mars they would like to observe with THEMIS. An ROI is a general imaging request that helps the mission planners to prioritize observations. If a science team member has a specific imaging request (ie. a very time-sensitive request), they should contact the mission planners to schedule the observation.


Image:roi_main.png



[edit] What is an ROI?

An ROI is 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 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: In the Layer Manager, 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. Descriptions and allowable values for each field are given in the quick reference table below.
  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
Description
     
ID
 #### - Four-Digit ROI ID Number
Blank - All ROI IDs		 To find a specific ROI, the unique four-digit ROI ID can be entered here.
Title
 Any Text Title
Blank - All Titles		 Users can choose to assign a title to each ROI.
Description
 Any Text Description
Blank - All Descriptions		 This field is left blank by default, but users often put the name of the feature or region being targeted in this field.
Campaign
 Any Imaging Campaign Name
Blank - All Campaigns		 he campaign field of the ROI is left blank by default, but users can enter the name of an established THEMIS imaging campaign if the ROI is part of that campaign.
Min/Max Ls
 0 - 360 - Solar Longitude
Blank - All Seasons		 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.
Local Time
 0.00 - 24.00
Blank - All Times		 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.
IR Band Configuration
 CAL - Band 10
DAY - Bands 1-10
IRSUM - Bands 2-10
NIGHT - Bands 4, 9 & 10
OFF - No IR Bands
Triplet - Bands 4, 7, 8, 9 & 10		 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.
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		 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.
Repeated Observation
 Yes
No
N/A - All Images		 This option 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.
Special Instructions Request
 Yes
No
N/A - All Images		 Enables/Disables the addition of text to the "Special Instructions" box.
Special Instructions
 Any Text Instructions
Blank - All Instructions		 This field allows users to enter information about the ROI that does not fit into any other field.
High Priority Request
 Yes
No
N/A - All Images		 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 won't need this option.
Active Request
 Yes
No
N/A - All Images		 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.
Expired Request
 Yes
No
N/A - All Images		 Users must now designate an expiration date for their ROIs. This could be anything from the end of a Martian season (in Earth dates) to their expected graduation dates. When the ROI expires, it is listed as "Expired" in the database and is no longer visible to the mission planners, but is not deleted from the database.


[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. Users can then choose from two tabs inside the ROI Layer: the "Data" tab and the "Settings" tab.
Data Tab
  1. 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.
  2. ROI Buttons: The four buttons below the ROI list allow the user to save or access ROIs.
  1. The "Commit ROIs" button will save any new or edited ROIs to the ROI database.
  2. The "Save to File" button will save the selected ROIs to a file that can later be retrieved as an Offline ROI file.
  3. The "Go Online" button will connect the ROI Layer to the ROI database, which usually occurs automatically when the layer is opened.
  4. The "Import ROIs" button will allow users to load an existing Offline ROI file.
  1. 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 table above.)


Image:roi_data.png


Settings Tab
  1. Color Settings: Users can change the colors of ROIs based on their states (Regular, Deleted, New, Modified, Selected or Inactive). Users can also adjusted the Fill Alpha using the slider.
  2. Misc Settings: Users can adjust the ROI outline thickness and the minimum pixel size, which is very helpful when zooming out on very small ROIs.


Image:roi_settings.png


[edit] Creating an ROI

  1. Change to Add Mode: With the ROI Layer open, right-click in the Main View and chose "Add Mode".
  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 values for all of the ROI parameters. (This will now be strictly enforced in order to make the ROI Layer more efficient for all users. If you are unsure about how to fill out one of the fields, please email either help@jmars.asu.edu or planners@mars.asu.edu.)
  4. Commit ROI: When all the edits are done, click the "Commit ROIs" button to commit the changes to the database. The new ROI should change to white.
  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 point 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. The ROI should change to white.
  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?title=Region_of_Interest_Layer"