Home > functions > tool_box > mri_toolbox > mri_point_select_dir > display_factor > vb_display_factor_get_element.m

vb_display_factor_get_element

PURPOSE ^

vb_display_factor_get_element returns specified element

SYNOPSIS ^

function [element] = vb_display_factor_get_element(obj, number)

DESCRIPTION ^

 vb_display_factor_get_element returns specified element
 [USAGE]
    [element] = vb_display_factor_get_element(<obj>);
 [IN]
       obj : display_factor object
    number : element number
 [OUT]
    element : display_element object

 Author: rhayashi
 Created: 2007-08-08

 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 [element] = vb_display_factor_get_element(obj, number)
0002 % vb_display_factor_get_element returns specified element
0003 % [USAGE]
0004 %    [element] = vb_display_factor_get_element(<obj>);
0005 % [IN]
0006 %       obj : display_factor object
0007 %    number : element number
0008 % [OUT]
0009 %    element : display_element object
0010 %
0011 % Author: rhayashi
0012 % Created: 2007-08-08
0013 %
0014 % Copyright (C) 2011, ATR All Rights Reserved.
0015 % License : New BSD License(see VBMEG_LICENSE.txt)
0016 
0017 %
0018 % --- Previous check
0019 %
0020 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0021 if ~exist('number', 'var'), error('number is a required parameter.'); end
0022 if (vb_display_factor_get_length(obj) < number) || (number <= 0)
0023     error('specified number is invalid.');
0024 end
0025 
0026 %
0027 % --- Main Procedure
0028 %
0029 element = obj.element_cell{number};

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