Home > functions > gui > bm_editor > brain_data > brain_data_set_conductivity.m

brain_data_set_conductivity

PURPOSE ^

set conductivity

SYNOPSIS ^

function [obj] = brain_data_set_conductivity(obj, conductivity)

DESCRIPTION ^

 set conductivity
 [USAGE]
    [obj] = brain_data_set_conductivity(<obj>, <conductivity>);
 [IN]
             obj : brain_data object
    conductivity : conductivity value
 [OUT]
    obj : brain_data object

 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] = brain_data_set_conductivity(obj, conductivity)
0002 % set conductivity
0003 % [USAGE]
0004 %    [obj] = brain_data_set_conductivity(<obj>, <conductivity>);
0005 % [IN]
0006 %             obj : brain_data object
0007 %    conductivity : conductivity value
0008 % [OUT]
0009 %    obj : brain_data object
0010 %
0011 % Copyright (C) 2011, ATR All Rights Reserved.
0012 % License : New BSD License(see VBMEG_LICENSE.txt)
0013 
0014 %
0015 % --- Previous check
0016 %
0017 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0018 if ~exist('conductivity', 'var')
0019     error('conductivity is a required parameter.');
0020 end
0021 
0022 %
0023 % --- Main Procedure
0024 %
0025 obj.conductivity = conductivity;
0026 
0027 %
0028 % --- After check
0029 %
0030 if nargout ~= 1
0031     error('function caller should receive obj.');
0032 end

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