EOS_PT_EXTRACTPERIOD

Syntax | Return Value | Arguments | Keywords | Examples | Version History

This function reads data from the designated level fields into the data buffer from the subsetted time period.

Syntax

Result = EOS_PT_EXTRACTPERIOD(pointID, periodID, level, fieldlist, buffer)

Return Value

Returns SUCCEED (0) if successful and FAIL (–1) otherwise.

Arguments

pointID

Point id (long).

periodID

Period id (long) returned by EOS_PT_DEFTIMEPERIOD.

level

Point level (0-based long).

fieldlist

List of fields (string) to extract.

buffer

A named variable that will contain the data buffer. This buffer is in packed format. Use HDF_UNPACKDATA to convert it into variables.

Keywords

None

Examples

In this example, we read data within the subsetted time period defined by EOS_PT_DEFTIMEPERIOD from the Time field:

periodID = EOS_PT_DEFTIMEPERIOD(pointID, 35208757.6d, $ 
   35984639.2d) 
IF (periodID NE -1) THEN BEGIN 
   status = EOS_PT_EXTRACTPERIOD(pointID, periodID, 1, $ 
      "Time", buffer) 
   HDF_UNPACKDATA, buffer, dataTime, HDF_TYPE=[6] 
ENDIF 

Version History