This function reads data from a swath field. The values within start, stride, and edge arrays refer to the swath field (input) dimensions. The default values for start and stride are 0 and 1 respectively if these keywords are not set. The default value for edge is (dim – start) / stride where dim refers to the IDL variable dimension.
Note: Array ordering of variables used or returned by this routine changed in IDL 5.5. Programs written for versions of this routine prior to IDL 5.5 may need to be modified to work correctly with the current version.
Examples
In this example, we read data from the 10th track (0-based) of the Longitude field:
start=[10,1]
edge=[1,1000]
status = EOS_SW_READFIELD(swathID, "Longitude", track, $
START = start, EDGE = edge)
Syntax
Result = EOS_SW_READFIELD( swathID, fieldname, buffer [, EDGE=array] [, START=array] [, STRIDE=array] )
Return Value
Returns SUCCEED (0) if successful and FAIL (–1) otherwise.
Arguments
swathID
Swath id (long) returned by EOS_SW_CREATE or EOS_SW_ATTACH.
fieldname
Name of field to read (string).
buffer
A named variable that will contain the data read from the field.
Keywords
EDGE
Array (long) specifying the number of values to read along each dimension.
START
Array (long) specifying the starting location within each dimension.
STRIDE
Set this keyword to an array of integers specifying the number of values to step along each dimension. The default is [1, 1, ...] indicating that every value should be included. Specifying a stride of 0 is equivalent to 1.
Version History