Skip to content

extract_trigger.py

EXTRACT_trigger

Source code in element_interface/extract_trigger.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class EXTRACT_trigger:
    m_template = dedent(
        """
        % Load Data
        data = load('{scanfile}');
        M = data.M;

        % Input Paramaters
        config = struct();
        {parameters_list_string}

        % Run EXTRACT
        output = extractor(M, config);
        save('{output_fullpath}', 'output');
        """
    )

    def __init__(
        self,
        scanfile: Union[str, Path],
        parameters: dict,
        output_dir: Union[str, Path],
    ) -> None:
        """A helper class to trigger EXTRACT analysis in element-calcium-imaging.

        Args:
            scanfile (Union[str, Path]): Full path of the scan
            parameters (dict): EXTRACT input paramaters.
            output_dir (Union[str, Path]): Directory to store the outputs of EXTRACT analysis.
        """
        assert isinstance(parameters, dict)

        self.scanfile = Path(scanfile)
        self.output_dir = Path(output_dir)
        self.parameters = parameters

    def write_matlab_run_script(self):
        """Compose a matlab script and save it with the name run_extract.m.

        The composed script is basically the formatted version of the m_template attribute."""

        self.output_fullpath = (
            self.output_dir / f"{self.scanfile.stem}_extract_output.mat"
        )

        m_file_content = self.m_template.format(
            **dict(
                parameters_list_string="\n".join(
                    [
                        f"config.{k} = '{v}';"
                        if isinstance(v, str)
                        else f"config.{k} = {str(v).lower()};"
                        if isinstance(v, bool)
                        else f"config.{k} = {v};"
                        for k, v in self.parameters.items()
                    ]
                ),
                scanfile=self.scanfile.as_posix(),
                output_fullpath=self.output_fullpath.as_posix(),
            )
        ).lstrip()

        self.m_file_fp = self.output_dir / "run_extract.m"

        with open(self.m_file_fp, "w") as f:
            f.write(m_file_content)

    def run(self):
        """Run the matlab run_extract.m script."""

        self.write_matlab_run_script()

        current_dir = Path.cwd()
        os.chdir(self.output_dir)

        try:
            import matlab.engine

            eng = matlab.engine.start_matlab()
            eng.run_extract()
        except Exception as e:
            raise e
        finally:
            os.chdir(current_dir)

__init__(scanfile, parameters, output_dir)

A helper class to trigger EXTRACT analysis in element-calcium-imaging.

Parameters:

Name Type Description Default
scanfile Union[str, Path]

Full path of the scan

 required
parameters dict

EXTRACT input paramaters.

 required
output_dir Union[str, Path]

Directory to store the outputs of EXTRACT analysis.

 required
Source code in element_interface/extract_trigger.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def __init__(
    self,
    scanfile: Union[str, Path],
    parameters: dict,
    output_dir: Union[str, Path],
) -> None:
    """A helper class to trigger EXTRACT analysis in element-calcium-imaging.

    Args:
        scanfile (Union[str, Path]): Full path of the scan
        parameters (dict): EXTRACT input paramaters.
        output_dir (Union[str, Path]): Directory to store the outputs of EXTRACT analysis.
    """
    assert isinstance(parameters, dict)

    self.scanfile = Path(scanfile)
    self.output_dir = Path(output_dir)
    self.parameters = parameters

run()

Run the matlab run_extract.m script.

Source code in element_interface/extract_trigger.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def run(self):
    """Run the matlab run_extract.m script."""

    self.write_matlab_run_script()

    current_dir = Path.cwd()
    os.chdir(self.output_dir)

    try:
        import matlab.engine

        eng = matlab.engine.start_matlab()
        eng.run_extract()
    except Exception as e:
        raise e
    finally:
        os.chdir(current_dir)

write_matlab_run_script()

Compose a matlab script and save it with the name run_extract.m.

The composed script is basically the formatted version of the m_template attribute.

Source code in element_interface/extract_trigger.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def write_matlab_run_script(self):
    """Compose a matlab script and save it with the name run_extract.m.

    The composed script is basically the formatted version of the m_template attribute."""

    self.output_fullpath = (
        self.output_dir / f"{self.scanfile.stem}_extract_output.mat"
    )

    m_file_content = self.m_template.format(
        **dict(
            parameters_list_string="\n".join(
                [
                    f"config.{k} = '{v}';"
                    if isinstance(v, str)
                    else f"config.{k} = {str(v).lower()};"
                    if isinstance(v, bool)
                    else f"config.{k} = {v};"
                    for k, v in self.parameters.items()
                ]
            ),
            scanfile=self.scanfile.as_posix(),
            output_fullpath=self.output_fullpath.as_posix(),
        )
    ).lstrip()

    self.m_file_fp = self.output_dir / "run_extract.m"

    with open(self.m_file_fp, "w") as f:
        f.write(m_file_content)