The unchecked module "series_shift_domain_" of the Mastrave modelling library

Daniele de Rigo

The file series_shift_domain_.m is part of Mastrave.

Mastrave is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Mastrave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Mastrave. If not, see http://www.gnu.org/licenses/.

Function declaration

shifted_series_cell = series_shift_domain_( series_cell )



Description

Warning: series_shift_domain_ should not be used in end-user code because it deliberately skips input and output arguments checks and other pre- and post-condition testing. End-user code should use instead the series_shift_domain function (without the ending underscore).

Rearranges a set of data series whose domain has two dimensions and whose codomain is n -dimensional. This utility may help to visualize complex data using the standard 2-D plot facilities. See the example for an intuitive introduction. The input set of data must be passed as a cell array of n_param matrices each of them representing an n -dimensional data series. All data series must have the same number of n_elem vectors of data (i.e each matrix must be composed by n_elem rows, each row being a row-vector of n columns). Each series of data is supposed to be ordered with respect to a parameter p1 which is the first dimension of the data domain. Matrices are supposed to be ordered with respect to a parameter p2 which is the second dimension of the data domain. That is, vectors in the same row of different matrices should represent n -dimensional data points measured for different values of the parameter p2 while the parameter p1 remains constant. Vectors of the same matrix should represent measures for different values of the parameter p1 while the parameter p2 remains constant. In case of multi-array, all dimensions beyond the second one are splitted and considered as data matrices corresponding to different values of p2 .

The output set of data is a cell array of matrices in which the role of the domain dimensions (i.e. of the parameters p1 and p2 ) is inverted.

Input arguments


series_cell       ::cellnumeric-1::
cell array of matrices all having the same size.



Example of usage

version: 0.2.8

Support

The Mastrave modelling library is committed to provide reusable and general - but also robust and scalable - modules for research modellers dealing with computational science.  You can help the Mastrave project by providing feedbacks on unexpected behaviours of this module.  Despite all efforts, all of us - either developers or users - (should) know that errors are unavoidable.  However, the free software paradigm successfully highlights that scientific knowledge freedom also implies an impressive opportunity for collectively evolve the tools and ideas upon which our daily work is based.  Reporting a problem that you found using Mastrave may help the developer team to find a possible bug.  Please, be aware that Mastrave is entirely based on voluntary efforts: in order for your help to be as effective as possible, please read carefully the section on reporting problems.  Thank you for your collaboration.

Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Daniele de Rigo