The F(x) nodes all have a similar role as the Calculator Tables node. But where the Calculator Tables node shines when the calculations are simple, the f(x) nodes are better suited for more advanced calculations since the code is kept in a separate python file. You can place this python file anywhere, but it might be a good idea to keep it in the same folder as your workflow or in a subfolder to that folder.
The script file¶
When writing a “function” (it is actually a python class) you need to inherit
FxWrapper provides access to the input and output
self.res respectively. These variables are of the
same type as the input on port2 consult the API for that type to figure out
arg_types is a list containing string representations of types
(as shown in port tooltips) that you intend your script to support and
determines the types for which the function is available.
from sympathy.api import fx_wrapper class MyCalculation(fx_wrapper.FxWrapper): arg_types = ['table'] def execute(self): spam = self.arg.get_column_to_array('spam') # My super advanced calculation that totally couldn't be # done in the :ref:`Calculator Tables` node: more_spam = spam + 1 self.res.set_column_from_array('more spam', more_spam)
Debugging your script¶
F(x) scripts can be debugged in spyder by following these simple steps:
- Open the script file in spyder and place a breakpoint somewhere in the execute method that you want to debug.
- Go back to Sympathy and right-click and choose Debug on the f(x) node with that function selected.
- Make sure that the file node_fx_selector.py is the active file in spyder and press Debug file (Ctrl+F5).
- A third python file will open as the debugging starts. Press Continue (Ctrl+F12) to arrive at the breakpoint in your f(x) script. From here you can step through your code however you want to.
When Copy input is disabled (the default) the output table will be empty when the functions are run.
When the Copy input setting is enabled the entire input table will get copied to the output before running the functions in the file. This is useful when your functions should only add a few columns to a data table, but in this case you must make sure that the output has the same number of rows as the input.
By default (pass-through disabled) only the functions that you have manually selected in the configuration will be run when you execute the node, but with the pass-through setting enabled the node will run all the functions in the selected file. This can be convenient in some situations when new functions are added often.
Apply functions to an item.
Functions based on FxWrapper will be invoked once on the item. The functions available are the ones where
arg_typesof the function matches the type of the item port (port2).
Ref. nodes: Inputs:
- port1 : datasource
Path to Python file with scripted functions.
- port2 : <a>
Item with data to apply functions on
- port3 : <a>
Item with the results from the applied functions
- Copy input
If enabled the incoming data will be copied to the output before running the nodes.
- Select functions
Choose one or many of the listed functions to apply to the content of the incoming item.