This page was created by the IDL library routine
mk_html_help2.
Last modified: Thu Oct 7 03:02:31 1999.
FUNCTION:
get_<_satellite_>_<_inst_>
DESCRIPTION:
This is a template function to be used to build get_* routines to get
1-D multidimensional type data from the SDT program shared memory buffers.
Where modifications should be made, they are indicated by strings
such as: <_xxxx_>. Comments should be keeped up as well, which
we find to be the most time consuming part. This template is setup
to support the FAST/WIND/CLUSTER/POLAR data analysis software. One may
want to return a completely different format
A structure of the following format is returned:
DATA_NAME STRING '<_your-data-name_>' ; Data Quantity name
VALID INT 1 ; Data valid flag
PROJECT_NAME STRING '<_yourProject_>' ; project name
UNITS_NAME STRING '<_unitsOfData_>' ; Units of this data
UNITS_PROCEDURE STRING '<_unitsProcedure_>' ; Units conversion proc
NROWS INT nrows ; Number of rows in array
TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
DATA _Type_ array(nrows) ; Data component 1
NMINMAX INT nminmax ; number of arr-desc.
MIN1 DOUBLE array(nminmax) ; min array descriptors
MAX1 DOUBLE array(nminmax) ; max array descriptors
MASS DOUBLE <_mass-off-entity_> ; Particle Mass
GEOMFACTOR DOUBLE <_your-geom-factor_> ; Bin GF
HEADER_BYTES BYTE Array(25) ; Header bytes
CALLING SEQUENCE:
data = get_<_satellite_>_<_inst_> (time, [START=start | EN=en | ADVANCE=advance |
RETREAT=retreat])
ARGUMENTS:
time This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
KEYWORDS:
START If non-zero, get data from the start time
of the data instance in the SDT buffers
EN If non-zero, get data at the end time
of the data instance in the SDT buffers
ADVANCE If non-zero, advance to the next data point
following the time input
RETREAT If non-zero, retreat (reverse) to the previous
data point before the time input
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_1d_from_sdt_template.pro 1.2 07/12/96
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. June '96
(See sdtDataToIdl/get_1d_from_sdt_template.pro)
FUNCTION:
get_<_satellite_>_<_inst_>
DESCRIPTION:
This is a template function to be used to build get_* routines to get
2-D multidimensional type data from the SDT program shared memory buffers.
Where modifications should be made, they are indicated by strings
such as: <_xxxx_>. Comments should be keeped up as well, which
we find to be the most time consuming part. This template is setup
to support the FAST/WIND/CLUSTER/POLAR data analysis software. One may
want to return a completely different format
A structure of the following format is returned:
DATA_NAME STRING '<_yourDataName_>' ; Data Quantity name
VALID INT 1 ; Data valid flag
PROJECT_NAME STRING '<_yourProject_>' ; project name
UNITS_NAME STRING '<_unitsOfData_>' ; Units of this data
UNITS_PROCEDURE STRING '<_unitsProcedure_>'; Units conversion proc
TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
INTEG_T DOUBLE 3.0000000 ; Integration time
NBINS INT nbins ; Number of angle bins
NENERGY INT nnrgs ; Number of energy bins
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
DATA FLOAT Array(nnrgs, nbins) ; Data qauantities
ENERGY FLOAT Array(nnrgs, nbins) ; Energy steps
THETA FLOAT Array(nnrgs, nbins) ; Angle for bins
GEOM FLOAT Array(nbins) ; Geometry factor
DENERGY FLOAT Array(nnrgs, nbins) ; Energies for bins
DTHETA FLOAT Array(nbins) ; Delta Theta
EFF FLOAT Array(nnrgs) ; Efficiency (GF)
MASS DOUBLE <_mass-off-entity_> ; Particle Mass
GEOMFACTOR DOUBLE <_your-geom-factor_>; Bin GF
HEADER_BYTES BYTE Array(25) ; Header bytes
CALLING SEQUENCE:
data = get_<_satellite_>_<_inst_> (time, [START=start | EN=en | ADVANCE=advance |
RETREAT=retreat])
ARGUMENTS:
time This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
KEYWORDS:
START If non-zero, get data from the start time
of the data instance in the SDT buffers
EN If non-zero, get data at the end time
of the data instance in the SDT buffers
ADVANCE If non-zero, advance to the next data point
following the time input
RETREAT If non-zero, retreat (reverse) to the previous
data point before the time input
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_2d_from_sdt_template.pro 1.4 07/12/96
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. May '96
(See sdtDataToIdl/get_2d_from_sdt_template.pro)
FUNCTION:
get_<_satellite_>_<_inst_>
DESCRIPTION:
This is a template function to be used to build get_* routines to get
3-D multidimensional type data from the SDT program shared memory buffers.
Where modifications should be made, they are indicated by strings
such as: <_xxxx_>. Comments should be keeped up as well, which
we find to be the most time consuming part. This template is setup
to support the FAST/WIND/CLUSTER/POLAR data analysis software. One may
want to return a completely different format
A structure of the following format is returned:
DATA_NAME STRING '<_yourDataName_>' ; Data Quantity name
VALID INT 1 ; Data valid flag
PROJECT_NAME STRING '<_yourProject_>' ; project name
UNITS_NAME STRING '<_unitsOfData_>' ; Units of this data
UNITS_PROCEDURE STRING '<_unitsProcedure_>'; Units conversion proc
TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
INTEG_T DOUBLE 3.0000000 ; Integration time
NBINS INT nbins ; Number of angle bins
NENERGY INT nnrgs ; Number of energy bins
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
DATA FLOAT Array(nnrgs, nbins) ; Data qauantities
ENERGY FLOAT Array(nnrgs, nbins) ; Energy steps
THETA FLOAT Array(nnrgs, nbins) ; Angle for bins
PHI FLOAT Array(nnrgs, nbins) ; Phi angle for bins
GEOM FLOAT Array(nbins) ; Geometry factor
DENERGY FLOAT Array(nnrgs, nbins) ; Energies for bins
DTHETA FLOAT Array(nbins) ; Delta Theta
DPHI FLOAT Array(nbins) ; Delta Phi
DOMEGA FLOAT Array(nbins) ; Solid angle for bins
MAP INT Array(16,8) ; Angles to bin # map
PT_LIMITS FLOAT Array(4) ; Angle min/max limits
EFF FLOAT Array(nnrgs) ; Efficiency (GF)
MASS DOUBLE <_mass-off-entity_> ; Particle Mass
GEOMFACTOR DOUBLE <_your-geom-factor_>; Bin GF
HEADER_BYTES BYTE Array(25) ; Header bytes
CALLING SEQUENCE:
data = get_<_satellite_>_<_inst_> (time, [START=start | EN=en | ADVANCE=advance |
RETREAT=retreat])
ARGUMENTS:
time This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
KEYWORDS:
START If non-zero, get data from the start time
of the data instance in the SDT buffers
EN If non-zero, get data at the end time
of the data instance in the SDT buffers
ADVANCE If non-zero, advance to the next data point
following the time input
RETREAT If non-zero, retreat (reverse) to the previous
data point before the time input
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_3d_from_sdt_template.pro 1.4 07/12/96
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. May '96
(See sdtDataToIdl/get_3d_from_sdt_template.pro)
FUNCTION: GET_CACHE_MD_FROM_SDT DESCRIPTION: function to manage a time series cache of multi-dimensional sdt data. If the data selected is found in the sdt buffers, a cache of size cache_hsk.def_size will be returned in the cache argument, and this function will return the index into the cache that the selection applies to. CALLING SEQUENCE: arr_idx= get_cache_md_from_sdt (data_name, sat_code, cache_hsk, cache, TIME=time, [START = start | EN = en | ADVANCE = advance | RETREAT = retreat | INDEX = index], [FLUSH = flush, CACHE_SIZE = cs ]) ARGUMENTS: data_name The SDT data quantity name sat_code The SDT satellite code cache_hsk Contains the cache housekeeping info cache The actual cache KEYWORDS: TIME This argument gives a time handle from which to take data from. It may be either a string with the following possible formats: 'YY-MM-DD/HH:MM:SS.MSC' or 'HH:MM:SS' (use reference date) or a number, which will represent seconds since 1970 (must be a double > 94608000.D), or a hours from a reference time, if set. time will always be returned as a double representing the actual data time found in seconds since 1970. START If non-zero, get data from the start time of the data instance in the SDT buffers EN If non-zero, get data at the end time of the data instance in the SDT buffers ADVANCE If non-zero, advance to the next data point following the time input RETREAT If non-zero, retreat (reverse) to the previous data point before the time input INDEX If index is gt 0, it is used for selecting the index to get data. FLUSH If non-zero, will flush the data cache This is useful to force a re-read of sdt buffers in case the data has changed. CACHE_SIZE If non-zero, will reset the default cache size. RETURN VALUE: Upon success, a non-zero index is returned. Upon failure, -1 is returned. REVISION HISTORY: @(#)get_cache_md_from_sdt.pro 1.2 05/06/98 Originally written by Jonathan M. Loran, University of California at Berkeley, Space Sciences Lab. May '97
(See sdtDataToIdl/get_cache_md_from_sdt.pro)
FUNCTION:
GET_CACHE_TS_1P_FROM_SDT
DESCRIPTION:
function to manage a cache of time series sdt data. If the data
selected is found in the sdt buffers, a cache of size cache_hsk.def_size
will be returned in the cache argument, and this function will return
the index into the cache that the selection applies to.
CALLING SEQUENCE:
arr_idx= get_cache_ts_1p_from_sdt (data_name, sat_code, cache_hsk, cache,
TIME=time, | INDEX = index,
[FLUSH = flush, CACHE_SIZE = cs])
ARGUMENTS:
data_name The SDT data quantity name
sat_code The SDT satellite code
cache_hsk Contains the cache housekeeping info
cache The actual cache
KEYWORDS:
TIME This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
INDEX If index is gt 0, it is used for selecting
the index to get data.
FLUSH If non-zero, will flush the data cache
This is useful to force a re-read of sdt
buffers in case the data has changed.
CACHE_SIZE If non-zero, will reset the default cache
size.
RETURN VALUE:
Upon success, a non-zero index is returned. Upon failure,
-1 is returned.
REVISION HISTORY:
@(#)get_cache_ts_1p_from_sdt.pro 1.3 05/06/98
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. May '97
(See sdtDataToIdl/get_cache_ts_1p_from_sdt.pro)
FUNCTION:
GET_DQI_INFO
DESCRIPTION:
function to get information about an sdt loaded DQI
CALLING SEQUENCE:
data = get_dqi_info(sat_code, dqi_name, [TIME=time, INDEX=idx])
ARGUMENTS:
sat_code The sdt satellite code for the data quantity
to be queried. Current known codes are:
CRRES 1
ISEE 2
ISEE2 3
GEOTAIL 24
WIND 25
POLAR 26
CLUSTER 30
GEOTAIL_SURVEY 241
CRRES_SURVEY 1001
FAST 2001
dqi_name The sdt data quatity string. Hint, use the
procedure show_dqis to get these strings.
KEYWORDS:
The index and time keywords are to be used together:
index: If defined, return in the time keyword the time at
index.
time: If defined, return in the index keyword, the index at
time.
If either time or index is out of range, the returned keyword
of interest will be negative.
RETURN VALUE:
Upon failure, a scaler -1 is returned, else a stucture
of the following format is returned:
{ SAT_CODE LONG ; same as calling arg
DQI_NAME STRING ; same as calling arg
STYEAR LONG ; start year of data
STMONTH LONG ; start month of data
STDAYOFMONTH LONG ; start day of month of data
STSEC DOUBLE ; start seconds of day of data
ENYEAR LONG ; end year of data
ENMONTH LONG ; end month of data
ENDAYOFMONTH LONG ; end day of month of data
ENSEC DOUBLE ; end seconds of day of data
STORAGE_TYPE LONG ; see below
NPTS LONG ; number of data points in dqi
DONE LONG ; 1 if dqi filled, 0 if waiting
}
STORAGE_TYPE is defined as:
0 time series
1 Multi-dimensional, one dimension
2 Multi-dimensional, two dimensions
3 Multi-dimensional, three dimensions
REVISION HISTORY:
@(#)get_dqi_info.pro 1.5 03/20/98
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Dec. '96
(See sdtDataToIdl/get_dqi_info.pro)
FUNCTION:
GET_MD_FROM_SDT
DESCRIPTION:
function to load generic multi dimensional data sample from the SDT program
shared memory buffers.
A structure of the following format is returned:
DATA_NAME STRING 'QTY' ; Data Quantity name
VALID INT 1 ; Data valid flag
YEAR LONG year ; Data year
MONTH LONG month ; Data month
DAY LONG day ; Data day
TIME DOUBLE time ; Start Time of sample
ENDTIME DOUBLE end_time ; End time of sample
INTEG_T DOUBLE integ_t ; Integration time
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
VALUES <TYPE> Array(dimsizes(0..3)); Data qauantities
NDIMS LONG ndims ; Number of data dimensions
DIMSIZES LONG dimsizes(3) ; Sizes of each dimension
NCOMP LONG ncomp ; number of data components
NMINMAX INT array(ndims) ; number of array desc(dim)
MIN1 DOUBLE array(dimsizes(0) ; Array descriptor min (0)
MAX1 DOUBLE array(dimsizes(0) ; Array descriptor max (0)
MIN2 DOUBLE array(dimsizes(1) ; Array descriptor min (1)
MAX2 DOUBLE array(dimsizes(1) ; Array descriptor max (1)
MIN3 DOUBLE array(dimsizes(2) ; Array descriptor min (2)
MAX3 DOUBLE array(dimsizes(2) ; Array descriptor max (2)
INDEX LONG idx ; index into sdt buffers
CALLING SEQUENCE:
data = get_md_from_sdt (data_name, sat_code, TIME=time,
[START = start | EN = en | ADVANCE = advance |
RETREAT=retreat], INDEX=idx)
ARGUMENTS:
data_name The SDT data quantity name
sat_code The SDT satellite code
KEYWORDS:
TIME This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
START If non-zero, get data from the start time
of the data instance in the SDT buffers
EN If non-zero, get data at the end time
of the data instance in the SDT buffers
ADVANCE If non-zero, advance to the next data point
following the time input
RETREAT If non-zero, retreat (reverse) to the previous
data point before the time input
INDEX If defined, data will be selected by this
index
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_md_from_sdt.pro 1.11 07/23/97
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Jan '95
(See sdtDataToIdl/get_md_from_sdt.pro)
FUNCTION:
GET_MD_TS_FROM_SDT
DESCRIPTION:
function to load generic multi dimensional data time series
from the SDT program shared memory buffers.
A structure of the following format is returned:
DATA_NAME STRING 'QTY' ; Data Quantity name
VALID INT 1 ; Data valid flag
START_TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
NPTS INT npts ; Number of time samples
TIMES DOUBLE Array(npts) ; start timetags
ENDTIMES DOUBLE Array(npts) ; end timetags
INTEG_T DOUBLE array(npts) ; Integration time
CALIBRATED LONG calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
VALUES <TYPE> Array(dimsizes(0..3)); Data qauantities
NDIMS LONG ndims ; Number of data dimensions
DIMSIZES LONG dimsizes(3) ; Sizes of each dimension
NCOMP LONG ncomp ; number of data components
NMINMAX LONG array(ndims) ; number of array desc(dim)
MIN1 DOUBLE array(dimsizes(0),npts) ; Array desc min (0)
MAX1 DOUBLE array(dimsizes(0),npts) ; Array desc max (0)
MIN2 DOUBLE array(dimsizes(1),npts) ; Array desc min (1)
MAX2 DOUBLE array(dimsizes(1),npts) ; Array desc max (1)
MIN3 DOUBLE array(dimsizes(2),npts) ; Array desc min (2)
MAX3 DOUBLE array(dimsizes(2),npts) ; Array desc max (2)
ST_INDEX LONG stidx ; index of 1st pt in sdt
EN_INDEX LONG enidx ; index of last pt in sdt
CALLING SEQUENCE:
data = get_md_ts_from_sdt (data_name, sat_code, t1=time1, t2=time2,
[NPTS=npts], [START=st | EN=en |
PANF=panf | PANB=panb | IDXST=startidx])
ARGUMENTS:
data_name The SDT data quantity name
sat_code The SDT satellite code
KEYWORDS:
t1 This argument gives the start time from
which to take data, or, if START or EN keywords
are non-zero, the length of time to take data.
It may be either a string with the following
possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
Time will always be returned as a double
representing the actual data start time found
in seconds since 1970.
t2 The same as time1, except it represents the
end time.
If the NPTS, START, EN, PANF or PANB keywords
are non-zero, THEN time2 will be ignored as an
input paramter.
Data time selection is determined from the keywords as given in the
following truth table (NZ == non-zero, DF == defined):
|ALL |NPTS |START| EN |IDXST|PANF |PANB |selection |use time1|use time2|
|----|-----|-----|-----|-----|-----|-----|---------------------|---------|---------|
| NZ | 0 | 0 | 0 | 0 | 0 | 0 | start -> end | X | X |
| 0 | 0 | 0 | 0 | 0 | 0 | 0 | time1 -> time2 | X | X |
| 0 | 0 | NZ | 0 | 0 | 0 | 0 | start -> time1 secs | X | |
| 0 | 0 | 0 | NZ | 0 | 0 | 0 | end-time1 secs ->end| X | |
| 0 | 0 | 0 | 0 | 0 | NZ | 0 | pan fwd from | X | X |
| | | | | | | | time1->time2 | | |
| 0 | 0 | 0 | 0 | 0 | 0 | NZ | pan back from | X | X |
| | | | | | | | time1->time2 | | |
| 0 | NZ | 0 | 0 | 0 | 0 | 0 | time1 -> time1+npts | X | |
| 0 | NZ | NZ | 0 | 0 | 0 | 0 | start -> start+npts | | |
| 0 | NZ | 0 | NZ | 0 | 0 | 0 | end-npts -> end | | |
| 0 | NZ | 0 | 0 | DF | 0 | 0 | st-index -> | | |
| | | | | | | | st_index + npts | | |
Any other combination of keywords is not allowed.
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_md_ts_from_sdt.pro 1.3 05/30/97
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Mar '97
(See sdtDataToIdl/get_md_ts_from_sdt.pro)
FUNCTION:
get_<_satellite_>_<_inst_>
DESCRIPTION:
This is a template function to be used to build get_* routines
to get a time series of multi-dimensional type data from the SDT
program shared memory buffers. The coder should look at the
get_<x>d_from_sdt_from_std_template.pro files for info on
handling your data for each sample.
Where modifications should be made, they are indicated by strings
such as: <_xxxx_>. Comments should be keeped up as well, which
we find to be the most time consuming part.
At structure of the following format is returned:
DATA_NAME STRING '<_your-data-name_>' ; Data Quantity name
VALID INT 1 ; Data valid flag
PROJECT_NAME STRING '<_yourProject_>' ; project name
UNITS_NAME STRING '<_unitsOfData_>' ; Units of this data
UNITS_PROCEDURE STRING '<_unitsProcedure_>' ; Units conversion proc
START_TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
NPTS INT npts ; Number of time samples
NDIMS INT ndims(rows,cols,echs) ; size of each dimension
TIMES DOUBLE array(double) ; Timetags of samples
END_TIMES DOUBLE array(double) ; End timetags of samples
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
DATA _Type_ array(ndims) ; Data component 1
NMINMAX INT nminmax ; number of arr-desc.
MIN1 DOUBLE array(nminmax(0)) ; min array descriptors
MAX1 DOUBLE array(nminmax(0)) ; max array descriptors
_ below here, delete unused MIN/MAX array descriptors based upon the number of dims: _>
MIN2 DOUBLE array(nminmax(1)) ; min array descriptors
MAX2 DOUBLE array(nminmax(1)) ; max array descriptors
MIN3 DOUBLE array(nminmax(1)) ; min array descriptors
MAX3 DOUBLE array(nminmax(1)) ; max array descriptors
CALLING SEQUENCE:
data = get_<_satellite_>_<_inst_> (time1, time2, [NPTS=npts], [START=st | EN=en |
PANF=panf | PANB = panb], STIDX=stidx)
ARGUMENTS:
time1 This argument gives the start time from
which to take data, or, if START or EN keywords
are non-zero, the length of time to take data.
It may be either a string with the following
possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
Time will always be returned as a double
representing the actual data start time found
in seconds since 1970.
time2 The same as time1, except it represents the
end time.
If the NPTS, START, EN, PANF or PANB keywords
are non-zero, THEN time2 will be ignored as an
input paramter.
KEYWORDS:
Data time selection is determined from the keywords as given in the
following truth table (NZ == non-zero):
|ALL |NPTS |START| EN |STIDX|PANF |PANB |selection |use time1|use time2|
|----|-----|-----|-----|-----|-----|-----|---------------------|---------|---------|
| NZ | 0 | 0 | 0 | 0 | 0 | 0 | start -> end | X | X |
| 0 | 0 | 0 | 0 | 0 | 0 | 0 | time1 -> time2 | X | X |
| 0 | 0 | NZ | 0 | 0 | 0 | 0 | start -> time1 secs | X | |
| 0 | 0 | 0 | NZ | 0 | 0 | 0 | end-time1 secs ->end| X | |
| 0 | 0 | 0 | 0 | 0 | NZ | 0 | pan fwd from | X | X |
| | | | | | | | time1->time2 | | |
| 0 | 0 | 0 | 0 | 0 | 0 | NZ | pan back from | X | X |
| | | | | | | | time1->time2 | | |
| 0 | NZ | 0 | 0 | 0 | 0 | 0 | time1 -> time1+npts | X | |
| 0 | NZ | NZ | 0 | 0 | 0 | 0 | start -> start+npts | | |
| 0 | NZ | 0 | NZ | 0 | 0 | 0 | end-npts -> end | | |
| 0 | NZ | 0 | 0 | NZ | 0 | 0 | st-index -> | | |
| | | | | | | | st_index + npts | | |
Any other combination of keywords is not allowed.
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_md_ts_from_sdt_template.pro 1.1 03/26/97
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Mar '97
(See sdtDataToIdl/get_md_ts_from_sdt_template.pro)
FUNCTION:
GET_TS_1P_FROM_SDT
DESCRIPTION:
function to load one data point of generic time series data
type from the SDT program shared memory buffers at a
specific time.
At structure of the following format is returned:
DATA_NAME STRING 'QTY' ; Data Quantity name
VALID INT 1 ; Data valid flag
TIME DOUBLE 8.0118726e+08 ; Time of sample, returned
NCOMP INT ncomp ; Number of components
DEPTH INT Array(ncomp) ; depth of component
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
INDEX LONG idx ; index into sdt data
COMP1 FLOAT Array(depth(0)) ; Data component 1
COMP2 FLOAT Array(depth(1)) ; Data component 2
COMP3 FLOAT Array(depth(2)) ; Data component 3
COMP4 FLOAT Array(depth(3)) ; Data component 4
COMP5 FLOAT Array(depth(4)) ; Data component 5
COMP6 FLOAT Array(depth(5)) ; Data component 6
COMP7 FLOAT Array(depth(6)) ; Data component 7
COMP8 FLOAT Array(depth(7)) ; Data component 8
COMP9 FLOAT Array(depth(8)) ; Data component 9
COMP10 FLOAT Array(depth(9)) ; Data component 10
COMP11 FLOAT Array(depth(10)) ; Data component 11
COMP12 FLOAT Array(depth(11)) ; Data component 12
COMP13 FLOAT Array(depth(12)) ; Data component 13
COMP14 FLOAT Array(depth(13)) ; Data component 14
COMP15 FLOAT Array(depth(14)) ; Data component 15
COMP16 FLOAT Array(depth(15)) ; Data component 16
COMP17 FLOAT Array(depth(16)) ; Data component 17
COMP18 FLOAT Array(depth(17)) ; Data component 18
COMP19 FLOAT Array(depth(18)) ; Data component 19
COMP20 FLOAT Array(depth(19)) ; Data component 20
CALLING SEQUENCE:
data = get_ts_1p_from_sdt (data_name, sat_code, time)
ARGUMENTS:
data_name The SDT data quantity name
sat_code The SDT satellite code
time This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
KEYWORDS:
INDEX: get data at this index.
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_ts_1p_from_sdt.pro 1.8 07/23/97
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. May '96
(See sdtDataToIdl/get_ts_1p_from_sdt.pro)
FUNCTION:
get_<_satellite_>_<_inst_>
DESCRIPTION:
This is a template function to be used to build get_* routines to get
1 sample of time series type data from the SDT program shared memory
buffers. Where modifications should be made, they are indicated by
strings such as: <_xxxx_>. Comments should be keeped up as well, which
we find to be the most time consuming part.
At structure of the following format is returned:
DATA_NAME STRING '<_yourDataName_>' ; Data Quantity name
VALID INT 1 ; Data valid flag
PROJECT_NAME STRING '<_yourProject_>' ; project name
UNITS_NAME STRING '<_unitsOfData_>' ; Units of this data
UNITS_PROCEDURE STRING '<_unitsProcedure_>'; Units conversion proc
TIME DOUBLE 8.0118726e+08 ; Time of sample
NCOMP INT <_NumberOfDataComp_>; Number of components
DEPTH INT <_DepthOfEachComp_> ; depth of component(s)
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
DATA1 <_Type_> Array(<_depth(0)_>) ; Data component 1
_ Here, enter a data spec for each component in this data set _>
DATA2 <_Type_> Array(<_depth(1)_>) ; Data component 2
DATA3 <_Type_> Array(<_depth(2)_>) ; Data component 3
_ .. _>
DATAn <_Type_> Array(<_depth(n-1)_>); Data component 4
HEADER_BYTES BYTE Array(1) ; Header bytes (not implemented)
CALLING SEQUENCE:
data = get_<_satellite_>_<_inst_> (time1, time2)
ARGUMENTS:
time This argument gives a time handle from which
to take data from. It may be either a string
with the following possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
time will always be returned as a double
representing the actual data time found in
seconds since 1970.
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_ts_1p_from_sdt_template.pro 1.3 07/12/96
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. May '96
(See sdtDataToIdl/get_ts_1p_from_sdt_template.pro)
FUNCTION:
GET_TS_FROM_SDT
DESCRIPTION:
function to load generic time series data from the SDT program
shared memory buffers.
At structure of the following format is returned:
DATA_NAME STRING 'QTY' ; Data Quantity name
VALID INT 1 ; Data valid flag
START_TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
NPTS INT npts ; Number of time samples
NCOMP INT ncomp ; Number of components
DEPTH INT Array(ncomp) ; depth of component
TIME DOUBLE Array(npts) ; timetags
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
COMP1 FLOAT Array(npts,depth(0)) ; Data component 1
COMP2 FLOAT Array(npts,depth(1)) ; Data component 2
COMP3 FLOAT Array(npts,depth(2)) ; Data component 3
COMP4 FLOAT Array(npts,depth(3)) ; Data component 4
COMP5 FLOAT Array(npts,depth(4)) ; Data component 5
COMP6 FLOAT Array(npts,depth(5)) ; Data component 6
COMP7 FLOAT Array(npts,depth(6)) ; Data component 7
COMP8 FLOAT Array(npts,depth(7)) ; Data component 8
COMP9 FLOAT Array(npts,depth(8)) ; Data component 9
COMP10 FLOAT Array(npts,depth(9)) ; Data component 10
COMP11 FLOAT Array(npts,depth(10)) ; Data component 11
COMP12 FLOAT Array(npts,depth(11)) ; Data component 12
COMP13 FLOAT Array(npts,depth(12)) ; Data component 13
COMP14 FLOAT Array(npts,depth(13)) ; Data component 14
COMP15 FLOAT Array(npts,depth(14)) ; Data component 15
COMP16 FLOAT Array(npts,depth(15)) ; Data component 16
COMP17 FLOAT Array(npts,depth(16)) ; Data component 17
COMP18 FLOAT Array(npts,depth(17)) ; Data component 18
COMP19 FLOAT Array(npts,depth(18)) ; Data component 19
COMP20 FLOAT Array(npts,depth(19)) ; Data component 20
COMP21 FLOAT Array(npts,depth(20)) ; Data component 21
COMP22 FLOAT Array(npts,depth(21)) ; Data component 22
COMP23 FLOAT Array(npts,depth(22)) ; Data component 23
COMP24 FLOAT Array(npts,depth(23)) ; Data component 24
COMP25 FLOAT Array(npts,depth(24)) ; Data component 25
COMP26 FLOAT Array(npts,depth(25)) ; Data component 26
COMP27 FLOAT Array(npts,depth(26)) ; Data component 27
COMP28 FLOAT Array(npts,depth(27) ; Data component 28
COMP29 FLOAT Array(npts,depth(28)) ; Data component 29
COMP30 FLOAT Array(npts,depth(29)) ; Data component 30
COMP31 FLOAT Array(npts,depth(30)) ; Data component 31
COMP32 FLOAT Array(npts,depth(31)) ; Data component 32
COMP33 FLOAT Array(npts,depth(32)) ; Data component 33
COMP34 FLOAT Array(npts,depth(33)) ; Data component 34
COMP35 FLOAT Array(npts,depth(34)) ; Data component 35
COMP36 FLOAT Array(npts,depth(35)) ; Data component 36
COMP37 FLOAT Array(npts,depth(36)) ; Data component 37
COMP38 FLOAT Array(npts,depth(37)) ; Data component 38
COMP39 FLOAT Array(npts,depth(38)) ; Data component 39
ST_INDEX LONG stidx ; index of 1st pt in sdt
EN_INDEX LONG enidx ; index of last pt in sdt
CALLING SEQUENCE:
data = get_ts_from_sdt (data_name, sat_code, t1=time1, t2=time2,
[NPTS=npts], [START=st | EN=en |
PANF=panf | PANB=panb | IDXST=startidx])
ARGUMENTS:
data_name The SDT data quantity name
sat_code The SDT satellite code
KEYWORDS:
t1 This argument gives the start time from
which to take data, or, if START or EN keywords
are non-zero, the length of time to take data.
It may be either a string with the following
possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
Time will always be returned as a double
representing the actual data start time found
in seconds since 1970.
t2 The same as time1, except it represents the
end time.
If the NPTS, START, EN, PANF or PANB keywords
are non-zero, THEN time2 will be ignored as an
input paramter.
Data time selection is determined from the keywords as given in the
following truth table (NZ == non-zero):
|ALL |NPTS |START| EN |IDXST|PANF |PANB |selection |use time1|use time2|
|----|-----|-----|-----|-----|-----|-----|---------------------|---------|---------|
| NZ | 0 | 0 | 0 | 0 | 0 | 0 | start -> end | X | X |
| 0 | 0 | 0 | 0 | 0 | 0 | 0 | time1 -> time2 | X | X |
| 0 | 0 | NZ | 0 | 0 | 0 | 0 | start -> time1 secs | X | |
| 0 | 0 | 0 | NZ | 0 | 0 | 0 | end-time1 secs ->end| X | |
| 0 | 0 | 0 | 0 | 0 | NZ | 0 | pan fwd from | X | X |
| | | | | | | | time1->time2 | | |
| 0 | 0 | 0 | 0 | 0 | 0 | NZ | pan back from | X | X |
| | | | | | | | time1->time2 | | |
| 0 | NZ | 0 | 0 | 0 | 0 | 0 | time1 -> time1+npts | X | |
| 0 | NZ | NZ | 0 | 0 | 0 | 0 | start -> start+npts | | |
| 0 | NZ | 0 | NZ | 0 | 0 | 0 | end-npts -> end | | |
| 0 | NZ | 0 | 0 | NZ | 0 | 0 | st-index -> | | |
| | | | | | | | st_index + npts | | |
Any other combination of keywords is not allowed.
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_ts_from_sdt.pro 1.12 07/14/98
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Jan '96
(See sdtDataToIdl/get_ts_from_sdt.pro)
FUNCTION:
get_<_satellite_>_<_inst_>
DESCRIPTION:
This is a template function to be used to build get_* routines to get
time series type data from the SDT program shared memory buffers.
Where modifications should be made, they are indicated by strings
such as: <_xxxx_>. Comments should be keeped up as well, which
we find to be the most time consuming part.
At structure of the following format is returned:
DATA_NAME STRING '<_yourDataName_>' ; Data Quantity name
VALID INT 1 ; Data valid flag
PROJECT_NAME STRING '<_yourProject_>' ; project name
UNITS_NAME STRING '<_unitsOfData_>' ; Units of this data
UNITS_PROCEDURE STRING '<_unitsProcedure_>'; Units conversion proc
START_TIME DOUBLE 8.0118726e+08 ; Start Time of sample
END_TIME DOUBLE 7.9850884e+08 ; End time of sample
NPTS INT npts ; Number of time samples
NCOMP INT <_NumberOfDataComp_>; Number of components
DEPTH INT <_DepthOfEachComp_> ; depth of component(s)
TIME DOUBLE Array(npts) ; timetags
CALIBRATED INT calibrated ; flags calibrated data
CALIBRATED_UNITS STRING units ; calibrated units string
DATA1 <_Type_> Array(npts,<_depth(0)_>); Data component 1
_ Here, enter a data spec for each component in this data set _>
DATA2 <_Type_> Array(npts,<_depth(1)_>); Data component 2
DATA3 <_Type_> Array(npts,<_depth(2)_>); Data component 3
_ .. _>
DATAn <_Type_> Array(npts,<_depth(n-1)_>); Data component 4
HEADER_BYTES BYTE Array(1) ; Header bytes (not implemented)
CALLING SEQUENCE:
data = get_<_satellite_>_<_inst_> (time1, time2, [NPTS=npts], [START=st | EN=en |
PANF=panf | PANB = panb])
ARGUMENTS:
time1 This argument gives the start time from
which to take data, or, if START or EN keywords
are non-zero, the length of time to take data.
It may be either a string with the following
possible formats:
'YY-MM-DD/HH:MM:SS.MSC' or
'HH:MM:SS' (use reference date)
or a number, which will represent seconds
since 1970 (must be a double > 94608000.D), or
a hours from a reference time, if set.
Time will always be returned as a double
representing the actual data start time found
in seconds since 1970.
time2 The same as time1, except it represents the
end time.
If the NPTS, START, EN, PANF or PANB keywords
are non-zero, THEN time2 will be ignored as an
input paramter.
KEYWORDS:
Data time selection is determined from the keywords as given in the
following truth table (NZ == non-zero):
|ALL |NPTS |START| EN |PANF |PANB |selection |use time1|use time2|
|----|-----|-----|-----|-----|-----|---------------------------|---------|---------|
| NZ | 0 | 0 | 0 | 0 | 0 | start -> end | X | X |
| 0 | 0 | 0 | 0 | 0 | 0 | time1 -> time2 | X | X |
| 0 | 0 | NZ | 0 | 0 | 0 | start -> time1 secs | X | |
| 0 | 0 | 0 | NZ | 0 | 0 | end-time1 secs -> end | X | |
| 0 | 0 | 0 | 0 | NZ | 0 | pan fwd from time1->time2 | X | X |
| 0 | 0 | 0 | 0 | 0 | NZ | pan back from time1->time2| X | X |
| 0 | NZ | 0 | 0 | 0 | 0 | time1 -> time1+npts | X | |
| 0 | NZ | NZ | 0 | 0 | 0 | start -> start+npts | | |
| 0 | NZ | 0 | NZ | 0 | 0 | end-npts -> end | | |
Any other combination of keywords is not allowed.
RETURN VALUE:
Upon success, the above structure is returned, with the valid tag
set to 1. Upon failure, the valid tag will be 0.
REVISION HISTORY:
@(#)get_ts_from_sdt_template.pro 1.9 07/12/96
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Jan '96
(See sdtDataToIdl/get_ts_from_sdt_template.pro)
FUNCTION: MD_DIMS_OK DESCRIPTION: function to check that the array descriptors have the correct number of elements. This function assumes that all dimensions should have array descriptors. CALLING SEQUENCE: ok = md_dims_ok(dat) ARGUMENTS: dat the structure returned from the get_md_from_sdt routine. RETURN VALUE: Upon success, 1 is returned, else 0 REVISION HISTORY: @(#)md_dims_ok.pro 1.1 09/04/96 Originally written by Jonathan M. Loran, University of California at Berkeley, Space Sciences Lab. Sep. '96
(See sdtDataToIdl/md_dims_ok.pro)
PROCEDURE: PLOT_MAP DESCRIPTION: Plot the map from the standard 3-D data structure that is returned from the IDL from SDT interface. The THETA, PHI, DTHETA, DPHI, DATA_NAME and PROJECT_NAME tags must exist for this routine to work. (The standard 3-D data structure should contain these.) CALLING SEQUENCE: plot_map, data_structure ARGUMENTS: data_structure The standard 3-D data structure to plot the map from. REVISION HISTORY: @(#)plot_map.pro 1.1 08/22/95 Originally written by Jonathan M. Loran, University of California at Berkeley, Space Sciences Lab. Aug. '95
(See sdtDataToIdl/plot_map.pro)
DEFINITIONS FILE: SDT_DATA_CACHE_DEFS DESCRIPTION: Defs for idl caches while getting sdt data. REVISION HISTORY: @(#)sdt_data_cache_defs.pro 1.1 05/31/97 Originally written by Jonathan M. Loran, University of California at Berkeley, Space Sciences Lab. Apr '97
(See sdtDataToIdl/sdt_data_cache_defs.pro)
PROCEDURE:
SHOW_DQIS
DESCRIPTION:
Procedure to show what sdt data quantities are loaded into
local shared memory. These quantities should be accessable
from the loadSDTBuf package.
CALLING SEQUENCE:
show_dqis
REVISION HISTORY:
@(#)show_dqis.pro 1.4 08/19/97
Originally written by Jonathan M. Loran, University of
California at Berkeley, Space Sciences Lab. Sep '95
Added RESULT keyword 19-Aug-97, Bill Peria
(See sdtDataToIdl/show_dqis.pro)