AFQ.api.participant#

Module Contents#

Classes#

ParticipantAFQ

class AFQ.api.participant.ParticipantAFQ(dwi_data_file, bval_file, bvec_file, output_dir, bids_info=None, **kwargs)[source]#

Bases: object

clobber[source]#
make_workflow()[source]#
export(attr_name='help')[source]#

Export a specific output. To print a list of available outputs, call export without arguments.

Parameters
attr_namestr

Name of the output to export. Default: “help”

Returns
outputany

The specific output, or None if called without arguments.

export_all(viz=True, xforms=True, indiv=True)[source]#
cmd_outputs(cmd='rm', dependent_on=None, exceptions=[], suffix='')[source]#

Perform some command some or all outputs of pyafq. This is useful if you change a parameter and need to recalculate derivatives that depend on it. Some examples: cp, mv, rm . -r will be automtically added when necessary.

Parameters
cmdstr

Command to run on outputs. Default: ‘rm’

dependent_onstr or None

Which derivatives to perform command on . If None, perform on all. If “track”, perform on all derivatives that depend on the tractography. If “recog”, perform on all derivatives that depend on the bundle recognition. Default: None

exceptionslist of str

Name outputs that the command should not be applied to. Default: []

suffixstr

Parts of command that are used after the filename. Default: “”