Component Overview

This page describes the Download Overlay, used for selecting files to download.

Component Features and Functionality

A description of the Download Overlay: 'Select By Product Type', 'Select By Product Extension', 'Select By String Match', 'Download Button' (Download By Streaming To A Zip File), and the 'Show API Query Button' (Download Via A Script).

Product type filter component before selectionProduct type filter component after selection

 Displaying Different Product Types with Filters

This filter shows or hides types of products based on their classification as defined by the archive or mission pipelines. Examples include 'CALIBRATED', 'UNCALIBRATED', and 'REFERENCE'. Each option can be toggled on or off, displaying or hiding all products under that type from the file-selection table. When a type is selected from the dropdown list, it shows as checked. Alternatively, use 'SHOW ALL' or select one or more types after clicking 'SHOW NONE' inside the drop-down menu.

By default, datasets for all product types are shown in the file-selection table.

Suffix filter component before selectionSuffix filter component after selection

This video clip demonstrates how to choose products to display in the overlay based on the product suffix.

 Displaying Different Product Suffixes

Another way to refine data products displayed in the table is to use the 'Suffixes' drop-down. It is used to display products based on the product suffix. After clicking the menu, scroll through the available list of suffixes and select those of interest to display in the file-selection table. Alternatively, use 'SHOW ALL' or select individual suffix after clicking 'SHOW NONE' inside the drop-down menu.

'Suffix' indicates the type of data the file contains, not to a file extension. For example, if a file ends in '_x1d.fits', the product suffix is 'x1d' (based on data type containing calibrated science spectra) while the file extension is 'fits'.

There are various product suffixes depending the instruments of each Mission. For HST data, see the HST User documentation page for its filename format convention. 

 Displaying Different Products By String Matching

The string search box in the Download Overlay can be used to match product names, instruments, and filters/gratings. This can be used to further refine the displayed list of products for easy selection to display in the file-selection table. This search box offers type-ahead functionality. For example, the search box can be used to display only "txt" file extension type by entering ".txt" into the search box, which will only display products that include the string. It is not limited to file types, any string in a file name can be searched. These can then be selected for download using the selection checkboxes to the left of the product filename in the file-selection table. Also, the 'ALL',  'NONE', and 'RECOMMENDED' table selection buttons may be used to select or deselect from the currently displayed products. 

 How To Select Products Using The Checkboxes

Any products displayed in the overlay must be selected using the checkboxes to download them. The 'ALL',  'NONE', and 'RECOMMENDED' table selection buttons will select or deselect from currently displayed products. The selection checkbox next to a given Observation ID will select or deselect all products of that Observation matching the filters applied. The selection checkbox next to a displayed product  will select or deselect only that product.

NOTE: Products that are selected will remain selected if they are later hidden using the filters in the Download Overlay. When in doubt, look at the number of Observations and Files at the top of the Overlay, or get a complete list of products and their selection status by displaying all Product Types and Product Extensions and remove any string matching in the search box.

Paging Through Available Products

If there are a large number of products available for the selected observations and filters, they may span multiple pages.  Paging allows a large number of products to be made available without impacting the speed of the browser.  At the bottom of the product-selection table, the current product range (e.g., 1 - 100) and total number of products (e.g., 584) matching the current 'File Type' and 'File Suffix' selections are displayed .  These paging controls can be used to change how many products are displayed on a page and to navigate through the pages of available products.

NOTE: Products that are selected will remain selected while paging through all products.  Additionally, the 'ALL',  'NONE', and 'RECOMMENDED' table selection buttons will select or deselect from all currently displayed products across all pages (not one page at a time).

Summary of Selected Products

When selecting multiple products that may be spread between multiple filters by category or suffix, or across multiple pages, it can be helpful to see a summary of only the selected products.  A product summary can be displayed by clicking the 'Files=xx' link at the top of the overlay, where xx is the number of products currently selected.  This opens a file summary overlay displaying ONLY the selected product files, grouped by their suffix.

NOTE: Products can be deselected from the file summary overlay by unchecking the checkbox next to a product name and then pressing the 'UPDATE SELECTIONS' button.  If products were deselected and the Close ('X') button in the top-right corner is pressed, the updates will not be saved and the unchecked products will not be removed from the selected files.

 Download Button (Download By Streaming To A Zip File)

When ready to download the selected products, click the 'START DOWNLOAD' button. This will begin downloading the products by streaming them to a Zip file. Note that the download location is set by the preference settings of the web browser. Some browsers allow choice of download location, otherwise the Zip file will be downloaded to the default location the browser downloads all files (Likely the download folder).

Pressing the 'DOWNLOAD WITH API QUERY' button will display the overlay below.

 Show API Query Button (Download Via A Script)

Another way to download products is to request a download script using the Mission Search API. Click the 'DOWNLOAD WITH API QUERY' button to show the Download By API Query Overlay. This overlay displays API commands based on the products selected to download the files one at a time. These commands can be copied from the overlay into a text editor and then run as an executable script.

Such API download scripts can be useful in a number of scenarios where a search was conducted at a different time than you want to download the products. Examples include slow internet connections, not being at the machine where the files will be stored, or very large product requests where the products can be requested in smaller batches at different times.

To download non-public products via API Query, an Auth.MAST token must be created and provided to the generated script when prompted.  You will only be prompted for this Auth.MAST token if there are non-public products requested for download.  For more information on Auth.MAST tokens, please visit the Auth.MAST documentation.

The account menu when not logged in.The account menu when logged in.

Example of non-public products in the Download Overlay if not authorized and/or not signed in. Instead of a selection checkbox, a locked icon with a yellow background will appear, indicating permission is not granted to download those products.

 Downloading Non-Public (Exclusive Access) Products

Some missions, such as Hubble, have products that are not publicly available to everyone. These non-public (or "exclusive access") products will appear in the download overlay but will not be available for download except to those who sign in to the STScI account and authorized to retrieve those products.

NOTE: your account might be automatically logged-in if you have also signed in to another STScI service. The sign-in system is shared across many STScI interfaces.

For Further Reading...

  • No labels

Data Use | Acknowledgements | DOI | Privacy

Send comments & corrections on this MAST document to: