mia_processes package

Mia_processes is the official bricks library for populse_mia. A brick can be an atomic operation or a pipeline (a succession of atomic calculations).

Contains:
Packages:
  • bricks: the library of atomic bricks

  • pipelines: the pipelines library

  • utils: various general tools used in bricks or pipelines

Subpackages

Submodules

mia_processes.info module

The module dedicated to the main information on mia_processes.

The info.py module is mainly used by the setup.py module.

mia_processes.info.get_gitversion()[source]

Mia_processes version as reported by the last commit in git Returns the version or None if nothing was found

mia_processes.process_matlab module

The toobox to run a brick using Matlab.

Basically, this module provides the necessary tools for the launch of the bricks using Matlab.

Contains:
Class:
  • ProcessMatlab

class mia_processes.process_matlab.ProcessMatlab[source]

Bases: ProcessMIA

Class overriding the ProcessMIA class, in order to use Matlab.

Note

  • Type ‘ProcessMatlab.help()’ for a full description of this process parameters.

  • Type ‘<ProcessMatlab>.get_input_spec()’ for a full description of this process input trait types.

  • Type ‘<ProcessMatlab>.get_output_spec()’ for a full description of this process output trait types.

__init__()[source]

Initialize the Process class.

add_exit()[source]

Adds an exit to the Matlab script.

add_path(path)[source]

Adds a Matlab path to the Matlab script.

Parameters:

path – Matlab path

change_directory(directory)[source]

Changes the working directory in the Matlab script.

Parameters:

directory – directory

display_parameter(parameter_name)[source]

Displays a given parameter in the Matlab script.

Parameters:

parameter_name – name of the parameter

run()[source]

Runs the Matlab script.

set_global_variable(variable_name)[source]

Adds a global variable to the Matlab script.

Parameters:

variable_name – name of the variable

set_variable(variable_name, value)[source]

Assign a value to a variable in the Matlab script.

Parameters:
  • variable_name – name of the variable

  • value – value of the variable