toolbox/misc/bst_mat2py.m
function pyObj = bst_mat2py(matArray, isForced)
% BST_MAT2PY: Converts Matlab matrices to Python arrays
% 
% INPUTS:
%    - matArray: Matlab array to convert to a Python array
%    - isForced: Boolean, if 1: force a manual conversion of the array.
%                Useful for preventing Matlab from transposing the row vectors into column vectors.
%
% @=============================================================================
% This function is part of the Brainstorm software:
% https://neuroimage.usc.edu/brainstorm
% 
% Copyright (c) University of Southern California & McGill University
% This software is distributed under the terms of the GNU General Public License
% as published by the Free Software Foundation. Further details on the GPLv3
% license can be found at http://www.gnu.org/copyleft/gpl.html.
% 
% FOR RESEARCH PURPOSES ONLY. THE SOFTWARE IS PROVIDED "AS IS," AND THE
% UNIVERSITY OF SOUTHERN CALIFORNIA AND ITS COLLABORATORS DO NOT MAKE ANY
% WARRANTY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
% MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, NOR DO THEY ASSUME ANY
% LIABILITY OR RESPONSIBILITY FOR THE USE OF THIS SOFTWARE.
%
% For more information type "brainstorm license" at command prompt.
% =============================================================================@
%
% Authors: Martin Cousineau, 2019
%          Francois Tadel, 2020

% Parse inputs
if (nargin < 2) || isempty(isForced)
    isForced = 0;
end

% Get Matlab version
MatlabVersion = bst_get('MatlabVersion');
% Empty objects
if isempty(matArray)
    pyObj = py.None;
% Matlab >= 2020b: Can convert everything
elseif (MatlabVersion >= 909) && ~isForced
    pyObj = matArray;
% Matlab <= 2020a: Must do some manual conversions
else
    switch class(matArray)
        case {'double', 'single', 'logical', 'int8', 'int16', 'int32', 'int64', 'uint8', 'uint16', 'uint32', 'uint64'}
            % Convert numerical matrices to Numpy arrays
            shape = int64(size(matArray));
            pyObj = py.numpy.array(reshape(matArray', 1, []));
            pyObj = pyObj.reshape(shape);

        case 'cell'
            % Convert cell arrays to Python lists (which support mixed types)
            pyObj = py.list(matArray(:)');

        otherwise
            error(['Unsupported class: ' class(matArray)]);
    end
end

