Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / IDL Reference / I/O - EOS / EOS_GD_WRITEFIELD

EOS_GD_WRITEFIELD

EOS_GD_WRITEFIELD

This function writes data to the grid field. The values within start, stride, and edge arrays refer to the grid field (output) dimensions. The input data in the data buffer is read from contiguously. The default values for start and stride are 0 and 1 respectively. The default value for edge is (dim - start) / stride where dim refers to the size of the dimension. Note that the data buffer for a compressed field must be the size of the entire field as incremental writes are not supported by the underlying HDF routines.

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 write data to the Temperature field:

; Define elements of temperature array:
temperature = indegen (200, 120)
status = EOS_GD_WRITEFIELD(gridID, "Temperature", temperature)
 
; Update Row 10 (0-based) in this field:
start=[0,10], edge=[2000,1]
 
; Define elements of newrow array: 
status = EOS_GD_WRITEFIELD(gridID, "Temperature", $
   START=start, EDGE=edge, newrow)

Syntax


Result = EOS_GD_WRITEFIELD( gridID, fieldname, data [, EDGE=array] [, START=array] [, STRIDE=array] )

Return Value


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

Arguments


gridID

Grid id (long) returned by EOS_GD_CREATE or EOS_GD_ATTACH.

fieldname

Name of field (string) to write.

data

Values (long) to be written to the field.

Keywords


EDGE

Array (long) specifying the number of values to write along each dimension.

START

Array (long) specifying the starting location within each dimension (0-based).

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


5.2

Introduced



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us