`capsul.study_config`: Study Configuration¶

Study Configuration: How to configure a study.

class capsul.study_config.StudyConfig(init_config=None)¶

Class to store study parameters and processing options.

This in turn is used to evaluate a Process instance or a Pipeline

Attributes

input_directory	str	parameter to set the study input directory
output_directory	str	parameter to set the study output directory
shared_directory	dict (default None)	parameter to set the study shared directory
generate_logging	bool (default False)	parameter to control the log generation
spm_directory	str	parameter to set the SPM directory
matlab_exec	str	parameter to set the Matlab command path
fsl_config	str	parameter to specify the fsl.sh path
spm_exec_cmd	bool (default False)	parameter to set the SPM standalone (MCR) command path
use_spm_mcr	bool	parameter to select the standalone or matlab SPM version to use
use_fsl	bool	parameter to tell that we need to configure FSL
use_smart_caching	bool (default False)	parameter to use smart-caching during the execution
use_soma_workflow	bool (default False)	parameter to choose soma woklow for the execution

Methods

`run`(process_or_pipeline)	Function to execute a process or a pipline with the Study
`set_trait_value`(trait_name, trait_value)	Method to set the value of a parameter.
`get_trait`(trait_name)	Method to access StudyConfig parameter.
`get_trait_value`(trait_name)	Method to access the value of a parameter.
`_use_smart_caching_changed`(old_trait_value, ...)	Event to setup the the caller
`_use_spm_mcr_changed`(old_trait_value, ...)	Event to setup SPM environment
`_use_fsl_changed`(new_trait_value)	Event tp setup FSL environment

get_trait(trait_name)¶

Method to access StudyConfig parameter.

Parameters :

trait_name: str (mandatory) :

the trait name we want to access

Returns :

trait: trait :

the trait we want to access

get_trait_value(trait_name)¶

Method to access the value of a parameter.

Parameters :

trait_name: str (mandatory) :

the trait name we want to modify

Returns :

value: object :

the trait value we want to access

run(process_or_pipeline)¶

Function to execute a process or a pipline with the Study configuration

Parameters :

process_or_pipeline: Process or Pipeline (mandatory) :

the process or pipeline we want to execute

set_trait_value(trait_name, trait_value)¶

Method to set the value of a parameter.

Parameters :

trait_name: str (mandatory) :

the trait name we want to modify

trait_value: object (madatory) :

the trait value we want to set

capsul.study_config: Study Configuration¶