das2c_dsinfo

FUNCTION

das2c_dsinfo

PURPOSE

Output summary information string about a dataset

CALLING SEQUENCE

info_string = das2c_dsinfo(dataset)

INPUTS

Parameter	Type	Purpose
dataset	DAS2C_DSET	A dataset structure, as returned by das2c_datasets

OUTPUT

A multi-line human readable formatted string providing an overview of all organization levels of the dataset.

EXAMPLES

Query a server for data and print summary information

query = 'https://planet.physics.uiowa.edu/das/das2Server?server=dataset' + $
'&dataset=Galileo/PWS/Survey_Electric&start_time=2001-001&end_time=2001-002'
result = das2c_readhttp(query)
ds = das2c_datasets(result, 0)
print, das2c_dsinfo(ds)
das2c_free(result)

This should output a multi-line string describing a rank-2 dataset similar to the following.

Dataset: 'electric_10' from group 'electric' | i:0..4483, j:0..152
   Property: String | title | Galileo PWS - LRS Electric

   Data Dimension: electric
      Property: String | label | Spectral Density (V!a2!n m!a-2!n Hz!a-1!n)
      Property: String | scaleType | log
      Property: DatumRange | range | 1.0e-17 to 1.0e-4 V**2 m**-2 Hz**-1
      Property: double | fill | 0.0
   
      Variable: center | electric[i][j] V**2 m**-2 Hz**-1 | i:0..4483, j:0..152
   
   Coordinate Dimension: time
      Property: Datum | tagWidth | 80 s
      Property: DatumRange | cacheRange | 2001-01-01T00:00:00.000 to 2001-01-02T00:00:00.000 UTC
      Property: String | label | %{RANGE}
   
      Variable: center | time[i] us2000 | i:0..4483, j:-
   
   Coordinate Dimension: frequency
      Property: String | label | Frequency (Hz)
      Property: String | scaleType | log
      Property: DatumRange | range | 5 to 6000000 Hz
      Property: Datum | tagWidth | 1.4 lo
		
      Variable: center | frequency[j] Hz | i:-, j:0..152

MODIFICATION HISTORY

C. Piker, 2020-03-10 - Initial Version