Class: DataMatrix
Prev
Next

Class: DataMatrix

A matrix object loaded from a data source.

Inherits: Matrix

Constructors:

  • DataMatrix ( source, field [, xStart, yStart, xN, yN [, skip [, ave]]] )

Methods:

Properties:

DataMatrix ( DataSource source, string field [, number xStart, number yStart, number xN, number yN [, number skip [, boolean ave]]] )

  • DataSource source - The DataSource to load data from. This may be a string containing the url of the DataSource to load. If so, it will attempt to reuse an existing DataSource instance, or fall back to a new DataSource object. It may also be specified as a DataSource object.

  • string field - The field to load from the source.

  • number xStart - The x frame to start reading from. [OPTIONAL]

  • number yStart - The y frame to start reading from.

  • number xN - The number of x frames to read.

  • number yN - The number of y frames to read.

  • number skip - The number of samples to skip by. [OPTIONAL]

  • boolean ave - Set to true to do boxcar filtering. [OPTIONAL]

void reload ( )

void changeFile ( DataSource source )

Switches this DataMatrix to a different DataSource.

void change ( number xStart, number yStart, number xCount, number yCount [, number skip [, boolean ave]] )

  • number xStart - The x starting frame.

  • number yStart - The y starting frame.

  • number xCount - The number of x frames to read.

  • number yCount - The number of y frames to read.

  • number skip - The number of frames to skip by. [OPTIONAL]

  • boolean ave - True to boxcar filter. [OPTIONAL]

Changes the sequence of data that is read in by this matrix.

boolean valid [Read-Only]

True if the data matrix is valid.

boolean skip [Read-Only]

True if the matrix should skip by skipLength samples while reading from the data source.

boolean boxcar [Read-Only]

True if the matrix should be boxcar filtered.

boolean xReadToEnd [Read-Only]

If true, the matrix is read to the end of the source in the x dimension.

boolean yReadToEnd [Read-Only]

If true, the matrix is read to the end of the source in the y dimension.

boolean xCountFromEnd [Read-Only]

If true, the matrix reads only a maximum number of samples from the end of the source in the x dimension.

boolean yCountFromEnd [Read-Only]

If true, the matrix reads only a maximum number of samples from the end of the source in the y dimension.

number skipLength [Read-Only]

The number of samples to skip by.

string field [Read-Only]

The field being read from the data source to create this matrix.

DataSource dataSource [Read-Only]

The data source object used by this DataMatrix.

Prev
Next
Home


Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team