User's Reference - Slab

### Slab

Category

Import and Export

Function

Creates a "slab" of data.

Syntax

    output = Slab(input, dimension, position, thickness);

Inputs

Name | Type | Default | Description
--- | --- | --- | ---
`input` | field | none | object to be "slabbed"
`dimension` | integer or string | 0 | spatial orientation of the slab
`position` | integer or integer list | all | starting position(s)
`thickness` | integer | 0 or 1 | thickness of slab (in number of elements)

Outputs

Name | Type | Description
--- | --- | ---
`output` | field or field series | slabbed data

Functional Details

This module creates a multidimensional object consisting of a selected subset of input data.

`data` | specifies the data field to be slabbed. This field must have regular connections.
`dimension` | specifies the dimension in which the slab should be oriented relative to the input object (the output slab will have the same orientation). The n dimensions of the object can be specified by number (from 0 to n - 1). The first three dimensions can also be specified as x, y, and z, respectively. The default for this parameter is dimension 0 (zero). Notes: The `dimension` number refers to the ordering of positions in the "connections" component. Thus, x corresponds to 0 only if the positions have been specified as x varies slowest. Slab can also be used on deformed grids, in which case the connections do not align with any particular axis. Transposing the positions (i.e., with Transpose) does not change the order in the "connections" component.
`position` | specifies the position from which the slab is generated. If the specified value is a single integer, the module creates a single field, with the slab oriented in the specified dimension and containing the number of volume elements specified by `thickness` (see below). If `position` is a list of integers, the module creates a series of specified slabs, and the default value of `thickness` is 1 (one). If this parameter is not specified, the output is a series of slabs (`thickness` = 1) that begin at every grid position along `dimension`.
`thickness` | specifies the thickness of the slab (in volume elements). A specified value of 0 (the default when `position` is a single number) will produce a 2-dimensional slice in a 3-dimensional object.

Notes:

1. This module performs no interpolation, and only data with regular connections can be slabbed.

2. If the input object is already colored, the colors are passed through unaltered.

3. If the input object is a volume and the requested slab is much thinner than the input object, the colors for volume rendering may be dim.

4. If the data are connection dependent, a request for a slab of `thickness` = 0 is ill-defined and the module returns an error.

Components

All input components are propagated to the output.

Example Visual Programs

    Imide_potential.net
    RubberTube.net
    Streamline.net
    SIMPLE/Slab.net

See Also

MapToPlane, Select, Slice

[ OpenDX Home at IBM | OpenDX.org ]