CIBC:Documentation:SCIRun:Reference:SCIRun:CalculateFieldDataCompiled
From SCIRun Documentation Wiki
Contents |
CalculateFieldDataCompiled
Information
- Package: SCIRun
- Catagory: ChangeFieldDataCompiled
- Author(s): Michael Callahan
- Status: Supported in latest version
- Version: 3.0
Description
Summary
Calculate a new value for all data in a field using a C++ style function.
Detailed Description
Compute the specified function on each data element in the first input field. Additional input fields may be used as part of the function.
The function is specified using C++ in body of the GUI or via an input string. The function has the form:
result = F(x, y, z, v0, v1, ..., result, count)
where where 'x', 'y', and 'z' are the coordinate values, 'v0', 'v1', 'v2', etc. are data values that correspond to each valid input field, and optionally 'result' corresponds to the previous output field (if cached - otherwise zero) and 'count' corresponds to the number of times the cached output field has been used.
If the data values are scalars they may be accessed directly, i.e. result = v0. If they are vectors individual components may be accessed using the base class methods, i.e result = v0.x() + v0.y() + v0.z() or be used directly result = v0 * v1.
If using multiple input fields each field must have the same mesh or similar meshes.
To use the module in an "accumulation" fashion the 'Cache result" must be checked which then caches the 'result' so that it may be used the next time the module is executed. Pressing the "Clear cached result" will reset the initial value of 'result' to zero as well as setting the count to zero.
Frequently Asked Questions
Known Bugs
Recent Changes
Go back to Documentation:SCIRun:Reference:SCIRun
