Read class

Returns

No return value

Example

To read a Bulk Data file named "example.bdf"

 Read.Bulk("example.bdf");

To read a Bulk Data file named "example.bdf" at the lowest free curve

var options = new Object();
options.outputOpt = "#";
Read.Bulk("example.bdf",options);

CSV(Filename[String], Options (optional)[object]) [static]

Description

Reads a CSV file into T/HIS.

Returns

No return value

Example

To read an XYYY CSV file with X-values in column 3, named "example.csv" starting at curve 5.

var options = new Object();
options.csvType = Read.CSV_XYYY;
options.xColIndex = 3;
options.outputOpt = "#5";
Read.CSV("example.csv", options);

CSV(Filename[String], CSV type (optional)[integer], Row containing curve labels (optional)[integer], Row containing axis labels (optional)[integer], CSV separation option (optional)[integer], X values column number (optional)[integer], X axis start value (optional)[real], X axis interval (optional)[real]) [static]  [deprecated]

This function is deprecated in version 18.1. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Reads a CSV file into T/HIS.

Returns

No return value

Example

To read an XYYY CSV file with X-values in column 3, named "example.csv"

 Read.CSV("example.csv", Read.CSV_XYYY, 0, 0, Read.CSV_COMMA, 3);

Cur(Filename[String], Options (optional)[object]) [static]

Description

Reads a Curve file into T/HIS.

Returns

No return value

Example

To read a Curve file named "example.cur"

 Read.Cur("example.cur");

To read a Curve file named "example.cur" at the curve ID 15

var options = new Object();
options.outputOpt = 15;
Read.Cur("example.cur",options);

DIAdem(Filename[String], X-axis channel[integer], Options (optional)[object]) [static]

Description

Reads a DIAdem file into T/HIS.

Returns

No return value

Example

To read DIAdem channels from "EXAMPLE.DAT", with channel comments filtered by "EXAMPLE" and X-values taken from channel 1, starting at curve 10 onwards sequentially:

 var options = new Object();
options.filter = "EXAMPLE";
options.outputOpt = 10; 

Read.DIAdem("./files/DIAdem/EXAMPLE.DAT",1,options);
      

DIAdem(Filename[String], X-axis channel [integer], X-axis start value (optional)[real], X axis interval (optional)[real], Show channel names (optional)[real], Filter (optional)[String]) [static]  [deprecated]

This function is deprecated in version 18.1. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Reads a DIAdem file into T/HIS.

Returns

No return value

Example

To read DIAdem channels from "EXAMPLE.DAT", with channel comments filtered by "EXAMPLE" and X-values taken from channel 1:

 Read.DIAdem("EXAMPLE.DAT",1,0,0,Read.DIADEM_COMMENT,"EXAMPLE");

Equation(Formula[String], Options (optional)[object]) [static]

Description

Create a curve from a user-defined equation.

Returns

No return value

Example

To plot the line y = x^2+2 for x in [-1,1] and an interval between points of 0.02 and set this curve as ID 3:

var options = new Object();
options.xStartVal = -1;
options.xEndVal = 1;
options.xInterval = 0.02;
options.xValOpt = Read.EQUATION_X_VALS;
options.curveID = 3;
Read.Equation("x^2+2",options);

Equation(Formula[String], X values option (optional)[integer], X start (optional)[real], X end (optional)[real], X interval (optional)[real]) [static]  [deprecated]

This function is deprecated in version 18.1. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Create a curve from a user-defined equation.

Returns

No return value

Example

To plot the line y = x^2+2 for x in [-1,1] and an interval between points of 0.02:

 Read.Equation("x^2+2",0,-1,1,0.02);

ISO(Filename[String], Options (optional)[object]) [static]

Description

Reads an ISO file into T/HIS.

Returns

No return value

Example

To read a single channel ISO file named "example.001" to curve ID 7

var options = new Object();
options.fileFormat = Read.ISO_SINGLE_CHANNEL;
options.outputOpt = 7;
Read.ISO("example.001", options);

ISO(Filename[String], File format (optional)[integer], Label type (optional)[integer]) [static]  [deprecated]

This function is deprecated in version 18.1. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Reads an ISO file into T/HIS.

Returns

No return value

Example

To read a single channel ISO file named "example.001"

 Read.ISO("example.001", Read.ISO_SINGLE_CHANNEL);

Key(Filename[String], Options (optional)[object]) [static]

Description

Reads a Keyword file into T/HIS.

Returns

No return value

Example

To read a Keyword file named "example.key"

 Read.Key("example.key");

To read a Keyword file named "example.key" starting at curve 5 and sequentially incrementing if the file contains multiple curves.

 var options = new Object();
options.outputOpt = 5;
Read.Key("example.key",options);

LSPP(Filename[String], Options (optional)[object]) [static]

Description

Reads an LS-PREPOST file into T/HIS.

Returns

No return value

Example

To read an LS-PREPOST XY pairs file named "example.xy"

var options = new Object();
options.fileFormat = Read.LSPP_XY_PAIRS;
Read.LSPP("example.xy", options);

LSPP(Filename[String], File format (optional)[integer]) [static]  [deprecated]

This function is deprecated in version 18.1. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Reads an LS-PREPOST file into T/HIS.

Returns

No return value

Example

To read an LS-PREPOST XY pairs file named "example.xy"

 Read.LSPP("example.xy", Read.LSPP_XY_PAIRS);