Home > functions > gui > batch > batch_mgr > vb_batch_mgr_get_parm.m

vb_batch_mgr_get_parm

PURPOSE ^

Get parameter from specified parameter set.

SYNOPSIS ^

function [parm, parm_type, parm_set_name] =vb_batch_mgr_get_parm(obj, ix_main, ix_sub)

DESCRIPTION ^

 Get parameter from specified parameter set.
 [USAGE]
    [parm, parm_type, parm_set_name] = ...
                                vb_batch_mgr_get_parm(<obj>, <ix_main>, <ix_sub>);
 [IN]
        obj : vb_batch_mgr object.
    ix_main : parameter set specifier
               = 0 : template parameter set
               >=1 : batch parameter set
     ix_sub : Nth parameter in the parameter set.
 [OUT]
             parm : parameter
        parm_type : parameter type
                     such as 'brain_parm', 'head_parm',.. [STRING]
    parm_set_name : The name of parameter set.

 Copyright (C) 2011, ATR All Rights Reserved.
 License : New BSD License(see VBMEG_LICENSE.txt)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [parm, parm_type, parm_set_name] = ...
0002                                  vb_batch_mgr_get_parm(obj, ix_main, ix_sub)
0003 % Get parameter from specified parameter set.
0004 % [USAGE]
0005 %    [parm, parm_type, parm_set_name] = ...
0006 %                                vb_batch_mgr_get_parm(<obj>, <ix_main>, <ix_sub>);
0007 % [IN]
0008 %        obj : vb_batch_mgr object.
0009 %    ix_main : parameter set specifier
0010 %               = 0 : template parameter set
0011 %               >=1 : batch parameter set
0012 %     ix_sub : Nth parameter in the parameter set.
0013 % [OUT]
0014 %             parm : parameter
0015 %        parm_type : parameter type
0016 %                     such as 'brain_parm', 'head_parm',.. [STRING]
0017 %    parm_set_name : The name of parameter set.
0018 %
0019 % Copyright (C) 2011, ATR All Rights Reserved.
0020 % License : New BSD License(see VBMEG_LICENSE.txt)
0021 
0022 %
0023 % --- Previous check
0024 %
0025 if ~exist('obj', 'var')
0026     error('obj is a required parameter.');
0027 end
0028 if ~exist('ix_main', 'var')
0029     error('ix_main is a required parameter.');
0030 end
0031 if ~exist('ix_sub', 'var')
0032     error('ix_sub is a required parameter.');
0033 end
0034 
0035 %
0036 % --- Main Procedure
0037 %
0038 
0039 % get specified parameter set
0040 parm_set = vb_batch_mgr_get_parm_set(obj, ix_main);
0041 
0042 % get parameter
0043 [parm, parm_type] = vb_batch_parm_set_get_parm(parm_set, ix_sub);
0044 
0045 % get the name of parameter set
0046 parm_set_name = vb_batch_parm_set_get_name(parm_set);

Generated on Tue 27-Aug-2013 11:46:04 by m2html © 2005