Retrieves the parameters and attributes of datasets. This is not the math dot product function, see the dot command.
Syntax |
Description |
---|---|
result = A.result; |
Retrieves the parameter or attribute "result" from the existing dataset A. The result is a scalar matrix. |
Examples
This example retrieves the dataset results "E" from a profile monitor, and then uses the getparameter command to get the "f" parameter, and the getattribute command to get the "Ex" and "E2" attributes from the dataset. Note that f, Ex and E2 are all scalar matrices, like the results one would get with the getdata command.
E = getresult("profile","E"); f = E.getparameter("f"); # the parameter f Ex = E.getattribute("Ex"); # the x component of the electric field E2 = E.getattribute("E2"); # the electric field intensity, note that this only works if E is a vector
Note that one can also use the "." operator to retrieve the parameters and attributes directly. For example:
E = getresult("profile","E"); f = E.f; # the parameter f Ex = E.Ex; # the x component of the electric field E2 = E.E2; # the electric field intensity, note that this only works if E is a vector
See Also
matrixdataset , rectilineardataset , getparameter , getattribute , visualize , getelectric , getmagnetic