Home > database > ensemble_init_data_struct.m

ensemble_init_data_struct

PURPOSE ^

Initializes a data structure used by many of the Ensemble analysis functions.

SYNOPSIS ^

function data_st = ensemble_init_data_struct

DESCRIPTION ^

 Initializes a data structure used by many of the Ensemble analysis functions.

 data_st = ensemble_init_data_struct;

 Fields are:
    .type - This is a string that identifies the data structure
    .vars - A cell array of strings that identifies each of the elements of
            the data cell array. This variable is used for indexing into the
            data array and also by ensemble_filter().
    .data - A cell array containing either data structures or data
    .report - A structure that contains information pertaining to reporting
            tables and figures related to this type of data
            structure. Analysis functions that have reporting sub-functions
            should register function handles within this structure.
    .meta - Structure for holding metadata pertaining to this type of data
            structure.  This might include the parameter structure that was
            passed to the function that generated this structure, or a
            question information structure, etc.


 Copyright (c) 2007-2012 The Regents of the University of California
 All Rights Reserved

 02/03/07 Petr Janata

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function data_st = ensemble_init_data_struct
0002 % Initializes a data structure used by many of the Ensemble analysis functions.
0003 %
0004 % data_st = ensemble_init_data_struct;
0005 %
0006 % Fields are:
0007 %    .type - This is a string that identifies the data structure
0008 %    .vars - A cell array of strings that identifies each of the elements of
0009 %            the data cell array. This variable is used for indexing into the
0010 %            data array and also by ensemble_filter().
0011 %    .data - A cell array containing either data structures or data
0012 %    .report - A structure that contains information pertaining to reporting
0013 %            tables and figures related to this type of data
0014 %            structure. Analysis functions that have reporting sub-functions
0015 %            should register function handles within this structure.
0016 %    .meta - Structure for holding metadata pertaining to this type of data
0017 %            structure.  This might include the parameter structure that was
0018 %            passed to the function that generated this structure, or a
0019 %            question information structure, etc.
0020 %
0021 %
0022 % Copyright (c) 2007-2012 The Regents of the University of California
0023 % All Rights Reserved
0024 %
0025 % 02/03/07 Petr Janata
0026 
0027 data_st.name = '';
0028 data_st.type = '';
0029 data_st.vars = {};
0030 data_st.data = {};
0031 data_st.report = struct();
0032 data_st.meta = struct();;
0033

Generated on Fri 22-Mar-2019 04:00:52 by m2html © 2003