NCL Home > Documentation > Graphics > Resources

CoordArrays (ca) Resources

caCopyArrays

This resource is used to determine if the CoordArrays object should make its own copy of the caXArray and caYArray data. If this resource is False, it is important for the programmer to keep the data around without modifying it. However; it is more efficient--if more dangerous--that way.

Default: True

caXArray

This resource specifies the X values of the X/Y coordinate data. It is an array of X values. If it is a one-dimensional array, then it specifies a single vector of X values. If it is a two-dimensional array, then the caXCast resource is used to determine which dimension indicates the number of vectors, and which dimension indicates the number of elements within each vector. If the caXArray resource is not set, then all of the Y values set with the caYArray resource will be paired with their integer array index. For example, assuming caYCast is MultipleVectors and C syntax:


(1, yarray[0][0])
(2, yarray[0][1])
(N, yarray[0][N-1])

If the caXArray resource is not set, then the caYArray resource must be set.

Default: NULL

caXCast

This resource is used to tell the CoordArrays object how to interpret the caXArray resource. The three valid values are:

SingleVector

The value SingleVector indicates that the caXArray provides the data for a single vector. This vector will be reused to match every vector specified by the caYArray. If the caXArray resource is set with a one-dimensional array, then the entire array will be used for the vector. If the caXArray resource is set with a two-dimensional array, then the vector will be made up from the values in the fastest-changing dimension. For example, in pseudo C array notation:


float	xarray[0][0-(N-1)];

In pseudo Fortran array notation:


REAL	XARR(1-N,1)

Where N is the length of the given dimension.

MultipleVectors

The value MultipleVectors indicates that if the caXArray resource is set with a one-dimensional array, then the entire array is used to specify a single vector that is not reused. If the caXArray resource is set with a two-dimensional array, then the caXArray has the array ordered such that the fastest-changing dimension contains the elements of each vector, and the other dimension contains the vectors. For example, in pseudo C array notation:


float	xarray[NUM_VECTORS][NUM_ELEMENTS];

In pseudo Fortran array notation:


REAL	XARR(NUM_ELEMENTS,NUM_VECTORS)

SplitVectors

The value SplitVectors indicates that the caXArray has the array ordered such that the fastest-changing dimension contains the vectors, and the other dimension contains the elements. For example, in pseudo C array notation:


float	xarray[NUM_ELEMENTS][NUM_VECTORS];

In pseudo Fortran array notation:


REAL	XARR(NUM_VECTORS,NUM_ELEMENTS)

Default: <dynamic>
If the caXArray resource is specified with a one-dimensional array or not at all, then the default value is SingleVector. Otherwise, the default value is MultipleVectors.
NOTE: If the caXCast resource is set to SplitVectors, then the caXArray resource will need to be reordered and copied internally so it is not as efficient.

caXMaxV

This resource is used to tell the CoordArrays object the maximum value contained in the caXArray resource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caXMinV

This resource is used to tell the CoordArrays object the minimum value contained in the caXArray resource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caXMissingV

This resource indicates a missing value for the elements in the caXArray resource. When the HLU library is parsing the data in the caXArray elements, it will treat any element with this value as missing data. This resource has a dynamic type so that elements of any type can be set to it.

Default: None

caYArray

This resource specifies the Y values of the X/Y coordinate data. It is an array of Y values. If it is a one-dimensional array, then it specifies a single vector of Y values. If it is a two-dimensional array, then the caYCast resource is used to determine which dimension indicates the number of vectors, and which dimension indicates the number of elements within each vector. If the caYArray resource is not set, then all of the X values set with the caXArray resource will be paired with their integer array index. For example, assuming caYCast is MultipleVectors and C array syntax:


(xarray[0][0],1)
(xarray[0][1],2)
(xarray[0][N-1],N)

If the caYArray resource is not set, then the caXArray resource must be set.

Default: NULL

caYCast

This resource is used to tell the CoordArrays object how to interpret the caYArray resource. The three valid values are:

SingleVector

The value SingleVector indicates that the caYArray provides the data for a single vector. This vector will be reused to match every vector specified by the caXArray. If the caYArray resource is set with a one dimensional array, then the entire array will be used for the vector. If the caYArray resource is set with a two dimensional array, then the vector will be made up from the values in the fastest changing dimension. For example, in pseudo C array notation:


float	yarray[0][0-(N-1)];

In pseudo Fortran array notation:


REAL	YARR(1-N,1)

Where N is the length of the given dimension.

MultipleVectors

The value MultipleVectors indicates that if the caYArray resource is set with a one-dimensional array, then the entire array is used to specify a single vector that is not reused. If the caYArray resource is set with a two-dimensional array, then the caYArray has the array ordered such that the fastest-changing dimension contains the elements of each vector, and the other dimension contains the vectors. For example, in pseudo C array notation:


float	yarray[NUM_VECTORS][NUM_ELEMENTS];

In pseudo Fortran array notation:


REAL	YARR(NUM_ELEMENTS,NUM_VECTORS)

SplitVectors

The value SplitVectors indicates that the caYArray has the array ordered such that the fastest-changing dimension contains the vectors, and the other dimension contains the elements. For example, in pseudo C array notation:


float	yarray[NUM_ELEMENTS][NUM_VECTORS];

In pseudo Fortran array notation:


REAL	YARR(NUM_VECTORS,NUM_ELEMENTS)

Default: <dynamic>
If the caYArray resource is specified with a one-dimensional array or not at all, then the default value is SingleVector. Otherwise, the default value is MultipleVectors.
Note: If the caYCast resource is set to SplitVectors, then the caYArray resource will need to be reordered and copied internally so it is not as efficient.

caYMaxV

This resource is used to tell the CoordArrays object the maximum value contained in the caYArrayresource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caYMinV

This resource is used to tell the CoordArrays object the minimum value contained in the caYArray resource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caYMissingV

This resource indicates a missing value for elements in the caYArray resource. When the HLU library is parsing the data in the caYArray elements, it will treat any element with this value as missing data. This resource has a dynamic type so that elements of any type can be set to it.

Default: None