/
feature_detection_output.rst
23 lines (14 loc) · 1.24 KB
/
feature_detection_output.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Feature Detection Output
-------------------------
Feature detection outputs a `pandas` dataframe with several variables. The variables, (with column names listed in the `Variable Name` column), are described below with units. Note that while these variables come initially from the feature detection step, segmentation and tracking also share some of these variables as keys (e.g., the :code:`feature` acts as a universal key between each of these). See :doc:`tracking_output` for the additional columns added by tracking.
Variables that are common to all feature detection files:
.. csv-table:: tobac Feature Detection Output Variables
:file: ./feature_detection_base_out_vars.csv
:widths: 3, 35, 3, 3
:header-rows: 1
Variables that are included when using 3D feature detection in addition to those above:
.. csv-table:: tobac 3D Feature Detection Output Variables
:file: ./feature_detection_3D_out_vars.csv
:widths: 3, 35, 3, 3
:header-rows: 1
One can optionally get the bulk statistics of the data points belonging to each feature regiion or volume. This is done using the `statistics` parameter when calling :ufunc:`tobac.feature_detection_multithreshold` . The user-defined metrics are then added as columns to the output dataframe.