Helioviewer.org User Guide 3.1.0

From Helioviewer Wiki

Jump to: navigation, search

Contents

Introduction

Helioviewer.org allows users to browse solar data and events from multiple sources, and to make and share movies and screenshots.

Getting to Know Helioviewer.org

Main elements of helioviewer.org For descriptions of each section of the user-interface highlighted in this screenshot, see the table below.



Elements of Helioviewer.org
# name tool Description
1 Viewport Viewer window

Displays the selected image data and/or solar features and event markers.

The Viewport is used to display the selected images and solar features and events. The contents of the Viewport can be repositioned by clicking and holding the mouse button and dragging the cursor

2 Time selector Time selector
Select the Date/Time of the data to display in the Viewport.

Date: can be selected by clicking on input field and using the pop-up calendar window. Also, a new date can be entered manually in yyyy/mm/dd format in the dialog box. On clicking return, the viewer window is updated with data closest to the new date/time.
Time: enter a time in hh:mm:ss format. On clicking return, the viewer window is updated with data closest to the new date/time.
Time-step: Pick a time-step from a drop down menu. On clicking the left and right arrows the observation date/time changes by the time-step and the viewer window is updated with data closest to the new date/time.
Newest: the viewer window is updated with data closest to the current time.

3 Image selector

Data selector
(a) Regular


Data selector
(b) Opened'


Data selector
(c) Opened - Running difference


Data selector
(d) Opened - Base difference'

Add, change and overlay images.

[Add]: pops up a new "opened" window underneath the current overlay list allowing the selection of new images.
Open/close overlay : open/close toggle for the instrument + measurement image layer shown.
Toggle visibility icon : toggle visibility of the given instrument + measurement image layer.
Close element : remove the image layer from the viewer window.
Opacity : dynamically vary the opacity of the image layer in the viewer window.
Difference : select and image difference type. Awailable options is: Regular Image, Running difference and Base difference
Running difference : select time difference for the images.
Base difference : select a date to display base difference images.
Observatory : select an observatory.
Instrument : select an instrument operates at the selected observatory.
Detector : select a detector that is part of the selected instrument.
Measurement : select a measurement made by the selected detector.
Download grey-scale JPEG2000 file : download the full grey-scale JPEG2000 file corresponding to this image.
Open header information window : show the FITS and Helioviewer Project header information for this image layer.

The observation time is color-coded: GREEN indicates that the data was observed close to the requested date/time, YELLOW indicates that the time difference between the data and the requested date/time is a little bit larger. RED indicates that the time difference between the requested date/time and the data is very large.

4 Solar
Features & Events
Solar Features & Events picker

Use the Solar Features & Events checkbox interface to select annotations to overlay onto the images in the viewport.

The data source behind this capability is the Heliophysics Events Knowledgebase (HEK).

Annotations include Marker Pins, Region Polygons, Information Panels, and HEK Dialogs (see Section 5, below).

Clicking a checkbox will toggle the display of the associated annotations On or Off.

Clicking the Toggle visibility icon icon toggles the visibility of ALL annotations On or Off.

Clicking the Toggle visibility icon icon toggles the visibility of all Marker Pin labels On or Off. This can also be done by pressing the 'd' key on your keyboard.

Clicking the Toggle visibility icon icon toggles the visibility of all empty event checkbox rows.

Temporarily highlight just the Feature/Event annotations in the Viewport that you are interested in by 'hovering' your mouse over the appropriate checkbox row.

5 Annotations

Marker Pins, Text Labels, Region Polygons:
Feature/Event Annotations

Information Pop-Overs:
Information Pop-Overs

HEK Dialogs:
HEK Dialog

Marker Pins: Color-coded pins plot the location of each feature or event. A two-character abbreviation indicates the feature/event type.
Text Labels: Text labels provide feature/event-specific physical data or catalog numbers. Hover the mouse over an Marker Pin to display it's label. Toggle labels for all features/events on and off by pressing the 'd' key on your keyboard.
Region Polygons: Region polygons indicate the shape and size a feature associated with an extended region of the Sun. Available for select data sources only.


Info Pop-Overs: An information pop-over is available for each feature/event by clicking on its Marker Pin. Start and end times are displayed for all markers, plus additional feature/event-specific data when available.


HEK Dialogs: All available data from the Heliophysics Events Knowledge-base (HEK) for a feature/event can be browsed by clicking the "View HEK data" button in an Info Pop-Over.

6 Zoom tool

Zoom tool

Zoom tool

Zoom tool

Allows zooming in/out and recentering of data in the viewer window.

Center Viewport : Center. re-center the field of view by moving the center of the Sun to the center of the viewer window.
Zoomin : Zoom in.
Zoomout : Zoom out.

7 Mouse Coordinates

Mouse co-ordinates

Mouse co-ordinates

The location of the mouse is reported.

This feature can be switched on by pressing m on your keyboard. Repeatedly pressing 'm' switches between different co-ordinate systems.

8 Size-of-Earth Indicator Earth-scale Indicator

Earth-scale Indicator

User can select one of the two types of Scale indicators:
(a) The image of the Earth displayed in the box labeled "Earth Scale" shows the size of the Earth relative to the image(s) of the Sun displayed in the Viewport.
(b) The Bar and distance in kilometers displayed in the box labeled "Scale Bar" shows the size of the Bar relative to the image(s) of the Sun displayed in the Viewport.

9 Navigation Menu Navigation Menu.

Navigation Menu

News : Helioviewer Project Announcements.
Youtube : View Helioviewer Movies Shared to YouTube.
Create a movie : Create a movie.
Create a screenshot : Create a screenshot.
Science Data : Request Science Data Download from External Partners.
Share : Share the current viewport on social media.
Help : Get Help with Helioviewer.
Settings : Edit Settings & Defaults.



10 Sidebar Panels Sidebar Panel
Example of "Create a Helioviewer Movie" Panel.

You can read more about each panel panel below at Sidebar Panels category.



11 Image Timeline

Image Timeline

Image Timeline.

Contain Data Availability Timeline and other time-series data for selected image sources.

Logarithmic View': Display chart using Logarithmic scale.

Image Timeline Navigation.
and : Move timeline chart. This can also be done by dragging the chart with Mouse Left Button.
Center Viewport : Center. re-center Image Timeline to the current Observation Date.
Zoomin : Zoom in. Zooming in can also be done by double clicking on the data bar or using SHIFT + Mouse Left Button to select desired length.
Zoomout : Zoom out.



12 Events Timeline

Events Timeline - histogram view

Events Timeline - events view

Events Timeline.

View features and events as a function of time. Browse and select data based on those features and events.

Logarithmic View': Display chart using Logarithmic scale.

Evetns Timeline Navigation.
and : Move timeline chart. This can also be done by dragging the chart with Mouse Left Button.
Center Viewport : Center. re-center Image Timeline to the current Observation Date.
Zoomin : Zoom in. Zooming in can also be done by double clicking on the data bar or using SHIFT + Mouse Left Button to select desired length.
Zoomout : Zoom out.




Sidebar Panels

Sidebar Drawers
# name tool Description
1 News panel

Helioviewer News

News from the Helioviewer Project.

Links to the most recent news articles from the Helioviewer Project blog are shown. The Visit Blog... button goes directly to the blog.

2 Movies uploaded to YouTube from Helioviewer.org

YouTube uploads
YouTube movies

Recent YouTube uploads
Recently shared

Recent YouTube uploads
Movies spanning observation date

Thumbnail links to movies uploaded to YouTube from Helioviewer.org.

3 Movie Generation

Area selection and previous movie history
(a) Area selection and movie history.


Advanced movie settings
(b) Movie settings.


Advanced movie settings
(c) Advanced movie settings.


In browser movie player
(d) In-browser movie player.

Create a movie, download it, upload it YouTube, share it via social media networks.

(a) Open the movie dialog.

Full viewport : make a movie using the full viewport.

Select Area : make a movie of a selected area in the current viewport.

A list of movies made (or in progress) is also shown, ordered by when they were made. The list can be cleared using the Clear History button. Pointing the mouse over the movie titles pops up a short description of the movie and a thumbnail image. Clicking on the movie title brings up an in-browser movie player.

(b) Movie settings dialog.

Choose the parameters of the movie. The movie is centered on the time given in the time-selector with the chosen duration. The movie frame rate can be changed, and since the maximum number of frames is fixed, the duration of the movie can be changed by this. Alternatively, the duration of the movie can be set by the user, which fixes the frame rate.

(c) Advanced movie settings dialog.

Choose the advanced parameters of the movie. Advance settings allow the user to set movie time manually, select movie size, show other movies icon and rotate field of view with the Sun.

(d) In-browser movie player.

Download movie button : download a high quality version of the movie.

Upload movie to YouTube : upload movie to YouTube. If you are not already logged in to YouTube, you will be asked to log in. On logging in to YouTube, www.helioviewer.org provides a short form that has been pre-filled with information about the movie. You have the option to share it with other users of www.helioviewer.org. If you choose to share it, a link to the movie will eventually appear in the "Movies uploaded to YouTube from Helioviewer.org" element (see 13).

Link to movie : provides a link to the movie. Pasting this link in a browser will point it to http://www.helioviewer.org and launch the movie player, and start playing the movie.

Link to movie : provides a link to IMGUR service to generate GIF movie.

Share movie via social media : enables the user to share the movie over many different social media networks and websites.

4 Screenshot Generation

Open screenshot dialog
(a) Open the screenshot dialog.


Area selection and screenshot history
(b) Area selection and screenshot history.

Takes a screenshot of the current contents of the viewer window.

(a) Open the screenshot dialog.

(b) Screenshot options.
Full viewport : take a screenshot of the full viewport.
Select Area : take a screenshot of a selected area in the current viewport.
A list of screenshots made is also shown, ordered by when they were made. The list can be cleared using the Clear button. Pointing the mouse over the screenshot titles pops up a short description of the screenshot and a thumbnail image. Clicking on the screenshot title creates and downloads the screenshot.

5 Science Data

Open Science Data dialog
(a) Open the Science Data dialog.


Open Science Data dialog
(b) Virtual Solar Observatory.

Open Science Data dialog
(c) SDO AIA/HMI Cut-Out Service.

Takes a screenshot of the current contents of the viewer window.

(a) Open the Science Data dialog.

(b) Virtual Solar Observatory.

Data will be passed to the Virtual Solar Observatory using via URLs containing a query string that is customized to match as best as possible the the current state of the end user's Helioviewer Web Client session.

Only one Start/End date pair may be specified per request. As a result, two methods or requesting data are required: all images for all selected AIA/HMI data sources within a specified time range; an individual image having a known date/time. See mockup image.

Additionally, the Virtual Solar Observatory is accessible from within the SolarSoftware/IDL (SSWIDL) and SunPy/Python environments. So in addition to directly linking to pre-populated HTML Web Service forms, the Helioviewer Web Client could dynamically construct IDL and Python scripts that are hard-coded to request associated science data.

(c) SDO AIA/HMI Cut-Out Service.

Similar to the Virtual Solar Observatory, the SDO AIA/HMI Cut-Out Service may be accessed via pre-populated HTML Web Service forms, or the SolarSoftware/IDL scripts. It cannot at the present time be accessed directly via SunPy.

The Cut-Out Service is intended primarily to provide sub-field regions of large AIA and HMI images. The Helioviewer Web Client should leverage it's existing region-of-interest selection user-interface widget to provide a user-friendly way of defining this region. Additionally, a set of input text boxes could provide feedback and precise editing of the location and extent of this region via text entry.

6 Share Link to Current Viewport Share Link to Current Viewport
'

Create a link to the current view in the viewer window.

Clicking the 'link' button (a) generates a link that describes the current view in the viewer window. The link appears in a highlighted box (b) for copying and pasting into other applications. A shortened version can be optionally generated using bit.ly.

Also user can share the link over many different social media networks and websites.

7 Helioviewer information Helioviewer information
More information about the Helioviewer Project.

About Helioviewer.org: Information on the Helioviewer Project team.
User's Guide: jump to the Helioviewer,org User Guide (this web page).
Visual Glossary: a visual glossary of solar and heliospheric related features, events, science, missions and instruments.
Keyboard Shortcuts: Keyboard and mouse shortcuts are shown.
Documentation: Go to the Helioviewer Project wiki at http://wiki.helioviewer.org .
Public API Documentation: Open a new browser tab pointing to a description of the Helioviewer API at http://www.helioviewer.org/api .
Blog: Go to the Helioviewer Project blog at http://blog.helioviewer.org .
JHelioviewer: Go to the JHelioviewer page at http://www.jhelioviewer.org .
Contact: Send an email to the Helioviewer Project team.
Report problem: Report a problem to the Helioviewer Project (via GitHub).

8 User Settings

Settings dialog.

Settings.

Controls the behavior of images displayed in the viewport when starting and using Helioviewer.org.

Keyboard and mouse shortcuts for Helioviewer.org

Helioviewer.org also has a number of keyboard and mouse shortcuts to speed up your browsing. You can see a list of shortcuts on Helioviewer.org at any time by clicking on the "Usage Tips" button in the "Helioviewer information" bar (see entry 5 in the table above).


Keyboard and mouse shortcuts
shortcutaction
c Center the screen.
d Display detailed feature/event labels.
f Toggle fullscreen display.
m Toggle mouse coordinates display.
s Toggle Earth/Bar scale display.
+ Zoom-in once.
- Zoom-out once.
Pan left.
Pan upward.
Pan Right.
Pan downward.
< or , Step backward in time.
> or . Step forward in time.



Additional Support

In addition to this user guide, the Helioviewer team offers a number of resources that can help you use and enjoy Helioviewer.org. These include:


buy lasix online
Personal tools