Home > functions > gui > bm_editor > bm_list > bm_list_overwrite_model.m

bm_list_overwrite_model

PURPOSE ^

overwrite brain_data.

SYNOPSIS ^

function [obj, index] = bm_list_overwrite_model(obj, brain_data, index_no)

DESCRIPTION ^

 overwrite brain_data.
 [USAGE]
    [obj, index] = bm_list_overwrite_model(<obj>, <brain_data>, <index_no>);
 [IN]
           obj : bm_list object
    brain_data : brain_data object
      index_no : overwritten index number(scalar)
 [OUT]
      obj : bm_list object
    index : bm_list index

 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 [obj, index] = bm_list_overwrite_model(obj, brain_data, index_no)
0002 % overwrite brain_data.
0003 % [USAGE]
0004 %    [obj, index] = bm_list_overwrite_model(<obj>, <brain_data>, <index_no>);
0005 % [IN]
0006 %           obj : bm_list object
0007 %    brain_data : brain_data object
0008 %      index_no : overwritten index number(scalar)
0009 % [OUT]
0010 %      obj : bm_list object
0011 %    index : bm_list index
0012 %
0013 % Copyright (C) 2011, ATR All Rights Reserved.
0014 % License : New BSD License(see VBMEG_LICENSE.txt)
0015 
0016 %
0017 % --- Previous check
0018 %
0019 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0020 if ~exist('brain_data', 'var')
0021     error('brain_data is a required parameter.');
0022 end
0023 if ~strcmp(obj.class_type, 'bm_list')
0024     error('class type is invalid.');
0025 end
0026 if ~exist('index_no', 'var')
0027     error('index_no is a required parameter.');
0028 end
0029 
0030 % index range check
0031 index = bm_list_get_brain_model_index(obj);
0032 if isempty(find(index == index_no ))
0033     error('specified index_no is invalid.');
0034 end
0035 
0036 %
0037 % --- Main Procedure
0038 %
0039 obj.brain_data_list{index_no} = brain_data;
0040 
0041 %
0042 % --- After check
0043 %
0044 if nargout == 0
0045     error('function caller should receive obj.');
0046 end

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