GridField

Package: kwave.toolbox

Container class for grid field inputs.

Description

Simple container class used to specify virtual properties for classes deriving from kwave.toolbox.GridInput.

Input Arguments

  • name - (char) Name of the virtual property.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

  • Classes - (cell array) Valid data types passed to validateattributes.
  • Attributes - (cell array) Valid attributes passed to validateattributes.
  • ExpansionValue - (cell array) Scalar value to use in the matrix expansion passed to kwave.toolbox.expandMatrix.

Properties

  • name - (char) Name of the grid property.
  • classes - (cell array) Valid data types. Default = {'numeric'}.
  • attributes - (cell array) Valid attributes. Default = {'real', 'positive', 'finite'}.
  • expansionValue - (numeric) Value used in matrix expansion. Default = [].
  • type = (kwave.toolbox.GridFieldsType) Field type used for size validation. Default = kwave.toolbox.GridFieldTypes.ScalarField.

Methods