tedana.selection.component_selector.ComponentSelector

class ComponentSelector(tree)[source]

Load and classify components based on a specified tree.

__init__(tree)[source]

Initialize the class using the info specified in the json file tree.

Parameters:

tree (str) – The named tree or path to a JSON file that defines one.

Notes

Initializing the ComponentSelector confirms tree is valid and loads all information in the tree json file into ComponentSelector.

Methods

add_manual(indices, classification)

Add nodes that will manually classify components.

are_all_components_accepted_or_rejected()

Check if all component classifications are either "accepted" or "rejected".

are_only_necessary_metrics_used()

Check if all metrics that are declared as necessary are actually used.

check_null(params, fcn)

Check that required parameters for selection node functions are attributes in the class.

select(component_table[, ...])

Apply the decision tree to data.

to_files(io_generator)

Convert this selector into component files.

Attributes

accepted_comps_

A boolean pandas.Series of components that are accepted.

likely_bold_comps_

A boolean pandas.Series of components that are tagged "Likely BOLD".

n_accepted_comps_

The number of components that are accepted.

n_comps_

The number of components in the component table.

n_likely_bold_comps_

The number of components that are tagged "Likely BOLD".

rejected_comps_

A boolean pandas.Series of components that are rejected.