1.5. browseDf

Full Name: herschel.hifi.dp.access.BrowseDfTask
Alias: browseDf
Type: Jython Task -
Import:

from herschel.hifi.dp.access import BrowseDfTask

Category:

HIFI/Pipeline/ICC

Description

Browse DataFrames

The BrowseDf task is used to display dataframes data associated with an observation stored in any accessible database. To change to a new database type the name of the database into the local database text field located on the database tab. The fastest way to access data from the database is to lookup data using a specific obsid. If the times in the time selector panel are the same the script will automatically get the begin and end time of the observation and add it to the query string. If the times are different this will override the automatic process and search the database based on those times

The execute button is used to acquire data from the database. The clear button will clear all dataframes from memory and remove them from the selection box. This ICC task is not intended for astronomer use.

Example

Example 1: How to use BrowseDf
 
# Interactive mode (Database: ilt_fm_2_prop obsid: 268435480)
from herschel.hifi.dp.access.BrowseDfTask import *
dfBrowser = BrowseDfTask()
dfBrowser.gui = 1
# This only brings up the browser. Once selections are made, and the 
# execute button is pressed, then one can export df(s) in their 
# session
#
# resulting_dfs = dfBrowser.query
# selected_df = dfBrowser.selected
#
# The task also also be pre-initialized from the command-line
# dfBrowser = BrowseDf()(db="ilt_fm_2_prop@iccdb1.sron.rug.nl 0 READ", obsid=268435480)
# or
# dfBrowser = BrowseDfTask()
# dfBrowser.db = "ilt_fm_2_prop@iccdb1.sron.rug.nl 0 READ"
# dfBrowser.obsid = 268435480
# dfBrowser()

API Summary

Properties
Dataframe[] query [OUTPUT, OPTIONAL, default=None]
Boolean gui [INPUT, OPTIONAL, default=false]
Dataframe selected [OUTPUT, OPTIONAL, default=None]
Long obsid [INPUT, OPTIONAL, default=None]
Integer apid [INPUT, OPTIONAL, default=None]
Integer[] apids [INPUT, OPTIONAL, default=None]
Long bbtype [INPUT, OPTIONAL, default=None]
String db [INPUT, OPTIONAL, default=None]

API details

Properties

Dataframe[] query [OUTPUT, OPTIONAL, default=None]
 

This is the array of dataframe returned from the query to the database

Boolean gui [INPUT, OPTIONAL, default=false]
 

When gui = true a GUI will show up to allow input by user-friendly swing components. Note: This option is currently forced true

Dataframe selected [OUTPUT, OPTIONAL, default=None]
 

This is the user selected dataframe

Long obsid [INPUT, OPTIONAL, default=None]
 

This is the observation id

Integer apid [INPUT, OPTIONAL, default=None]
 

This is a single APID of an Observation

Integer[] apids [INPUT, OPTIONAL, default=None]
 

This is an array of APIDs of an Observation

Long bbtype [INPUT, OPTIONAL, default=None]
 

This is a BBType of an Observation

String db [INPUT, OPTIONAL, default=None]
 

Point to a different database other than default

History

  • 2006-04-11 - KE: Created
  • 2006-05-11 - KE: Updated with the new gui plot
  • 2006-05-22 - KE: Fixed documentation format
  • 2006-06-07 - PAZ: update to Task.views API
  • 2006-06-22 - KE: Clear dataframe from memory
  • 2006-06-28 - KE: Enable changing the database without using pop-up window
  • 2007-06-29 - KE: Removing gui components from constructor
  • 2007-11-12 - KE: Added additional task parameters from AccessDataFrameTask
  • 2009-04-15 - KE: Updated to reflect changes in IA_TASK - TaskParameter Flushing