Owning Palette: Array VIs and Functions
Requires: Base Development System
Returns the element or subarray of n-dimension array at index.
When you wire an array to this function, the function resizes automatically to display index inputs for each dimension in the array you wire to n-dimension array. You also can add additional element or subarray terminals by resizing the function. The connector pane displays the default data types for this polymorphic function.
Add to the block diagram | Find on the palette |
n-dimension array can be an n-dimensional array of any type. If n-dimension array is an empty array, element or subarray returns the default value of the defined data type for the array. | |
index 0..n-1 specifies a number that refers to a location within the input array. LabVIEW automatically provides an index input for each dimension of the array.
|
|
element or subarray has the same type as the elements of n-dimension array. |
You can disable indexing along a dimension by leaving the corresponding index input unwired, unless you are indexing a 1D array. By default, the first dimension has indexing enabled, with the others disabled. If disabled, the input terminal is an outlined black rectangle. If enabled, it is filled. You can wire a constant or control to the index inputs that you want enabled.
For example, if you want to index a row in a 2D array, the first index input is enabled and the second index input is disabled. If you want to index that same 2D array also by column, you can resize the function to show another set of input terminals. This next set of inputs has its own corresponding subarray output. By default, if you do not wire any index input terminals, the first subarray indexes row 0, the second subarray indexes row 1, and so on.
The following image and table illustrate this function's behavior for a variety of input values:
Output | Value | Comments |
---|---|---|
element, all indexes wired | 1 | --- |
subarray, row wired | [1, 1, 1] | Without a value for the column dimension, Index Array returns the entire row specified by the row input. |
subarray, indexes unwired | [2, 2, 2] | This output has no values specified for its corresponding row and column inputs. Therefore, the function returns the subarray that immediately follows the previous output. |
subarray, column wired | [0, 1, 2] | Without a value for the row dimension, Index Array returns the entire column specified by the column input. |