ReadText

DESCRIPTION

This module is designed as a general purpose ASCII file reader module. It reads column oriented ASCII data files into an IRIS Explorer lattice.

Users can select whether the data is read as a 2D array or whether each column is interpreted as an independent variable. In the latter case, columns can be used as coordinates, otherwise a default set of coordinates are created.

INPUTS

Port: Verbose
Type: Parameter
Optional: This port is optional.

The module can be set to report on its behaviour using this menu.

Port: Conversion Report
Type: Parameter
Optional: This port is optional.

Setting this parameter enables an extremely verbose report containing details of the fields being read and converted. Note that this can be extremely time consuming and is not recommended for files longer than a few lines. It is intended for use with test cases.

WIDGETS

Port: Filename
Type: Text

Set this port to be the name of the file to be read.

Port: Number of Data Columns
Type: Slider

This slider displays the number of columns detected in the file. It can also be used for manual intervention by switching off "Auto Count Columns".

Port: Auto Count Columns
Type: Check Box

This check box enables the user to override the numder of columns detected.

Port: No Sample Lines
Type: Slider

The "sample" is used within the module to establish the number of columns. Note that this number is also used when the "Preview Sample" button is pressed.

Port: Preview Sample
Type: Button

Clicking on this button allows a portion of the file to be viewed. The number of lines displayed is determined by the "No Sample Lines" slider.

Port: Header Length
Type: Slider

If your file has a header, the number of lines this occupies should be entered here to ensure the reader does not scan and import the header.

Port: Footer Length
Type: Slider

If the data does not run to the end of the file (ie: there is a footer) you can use this dial to specify the length. This prevents it being read and interpreted as data.

Port: Column Type
Type: Radio Box
Menu Item: Array of vectors
Menu Item: 2D Array

This option enables you to switch between importing the data as a rectangular 2D array, and a vector for each column of the file.

Port: Read Now
Type: Button

In order to stop the module from firing during changes, you must press this button to execute the read. Note that the scanning of the file always occurs.

Port: Missing Value
Type: Slider

This defines the value that is inserted for fields that are missing or cannot be interpreted as a number.

Port: Number of Coordinates
Type: Slider

This controls the number of columns to be interpretted as coordinates. The mapping of a column to a coordinate is controlled by the "X/Y/Z Column" sliders below.

Port: X Column
Type: Slider

The column to be used for the X-coordinate.

Port: Y Column
Type: Slider

The column to be used for the Y-coordinate.

Port: Z Column
Type: Slider

The column to be used for the Z-coordinate.

Port: Separator
Type: Text

Each character in this field is used to determine the end of the field. Note that multiple separators can be used. (Note that one of these characters may be a space which can be difficult to see.)

Port: Comment
Type: Text

Lines beginning with the character in the comment field are ignored.

OUTPUTS

Port: Data Out
Type: Lattice
Constraints: 1..2-D
Constraints: float

The output data.

KNOWN PROBLEMS

This reader has difficulty with files where the last field on a line is missing (ie: the separator is followed immediately by a line break).

SEE ALSO

Mixer, ChannelSelect, LatToGeom


[Documentation Home]