tedana.selection.selection_nodes.calc_rho_elbow
- calc_rho_elbow(selector, decide_comps, subset_decide_comps='unclassified', rho_elbow_type='kundu', log_extra_info='', custom_node_label='', only_used_metrics=False)[source]
Calculate elbow for rho across components.
- Parameters:
selector (
ComponentSelector
) – If only_used_metrics is False, the updated selector is returned.decide_comps (
str
orlist[str]
) – What classification(s) to operate on. using default or intermediate_classification labels. For example: decide_comps=’unclassified’ means to operate only on unclassified components. Use ‘all’ to include all components.subset_decide_comps (
str
) – This is a string with a single component classification label. For the elbow calculation used by Kundu in MEICA v.27 thresholds are based on all components and on unclassified components. Default=’unclassified’.rho_elbow_type (
str
) – The algorithm used to calculate the rho elbow. Current options are: ‘kundu’ and ‘liberal’. Default=’kundu’.log_extra_info (
str
) – Additional text to the information log. Default=””.custom_node_label (
str
) – A short label to describe what happens in this step. If “” then a label is automatically generated. Default=””.only_used_metrics (
bool
) – If True, only return the component_table metrics that would be used. Default=False.
- Returns:
selector (
ComponentSelector
) – If only_used_metrics is False, the updated selector is returned.used_metrics (
set(str)
) – If only_used_metrics is True, the names of the metrics used in the function are returned.
Note
This script is currently hard coded for a specific way to calculate the rho elbow based on the method by Kundu in the MEICA v2.5 code. To get the same functionality in MEICA v2.5, decide_comps must be ‘all’ and subset_decide_comps must be ‘unclassified’ See
tedana.selection.selection_utils.rho_elbow_kundu_liberal
for a more detailed explanation of the difference between the kundu and liberal options.