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

vb_display_factor_new

PURPOSE ^

construct display_factor object.

SYNOPSIS ^

function [obj] = vb_display_factor_new(mtype_cell)

DESCRIPTION ^

 construct display_factor object.
 display_factor object contains display_element object in its member
 and reffered by mri_point_select.
 [USAGE]
    [obj] = vb_display_factor_new([mtype_cell]);
 [IN]
   mtype_cell : marker type list {1xN}
                marker type is the same as defined by plot function.
 [OUT]
    obj : display_factor object.
          is reffered by vb_mri_point_select and plot on mri slice.
          set as AVWVIEW field.
 Sample :
     % plot layer(defined by V, F) on mri slice
     display_factor = vb_display_factor_new({'b-', 'r-', 'c-', 'm-'});
     % add display element(V's coord should be analyze_right_mm)
     display_factor = vb_display_factor_add_element(
                               display_factor, ...
                               vb_surf_element_new(name, coord, V, F, xx));
     avw = avw_read_ras(analyze_file);
     avw.display_factor = display_factor;
     vb_mri_point_select(avw, '', 'init');

 Author: rhayashi
 Created: 2007-07-18

 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] = vb_display_factor_new(mtype_cell)
0002 % construct display_factor object.
0003 % display_factor object contains display_element object in its member
0004 % and reffered by mri_point_select.
0005 % [USAGE]
0006 %    [obj] = vb_display_factor_new([mtype_cell]);
0007 % [IN]
0008 %   mtype_cell : marker type list {1xN}
0009 %                marker type is the same as defined by plot function.
0010 % [OUT]
0011 %    obj : display_factor object.
0012 %          is reffered by vb_mri_point_select and plot on mri slice.
0013 %          set as AVWVIEW field.
0014 % Sample :
0015 %     % plot layer(defined by V, F) on mri slice
0016 %     display_factor = vb_display_factor_new({'b-', 'r-', 'c-', 'm-'});
0017 %     % add display element(V's coord should be analyze_right_mm)
0018 %     display_factor = vb_display_factor_add_element(
0019 %                               display_factor, ...
0020 %                               vb_surf_element_new(name, coord, V, F, xx));
0021 %     avw = avw_read_ras(analyze_file);
0022 %     avw.display_factor = display_factor;
0023 %     vb_mri_point_select(avw, '', 'init');
0024 %
0025 % Author: rhayashi
0026 % Created: 2007-07-18
0027 %
0028 % Copyright (C) 2011, ATR All Rights Reserved.
0029 % License : New BSD License(see VBMEG_LICENSE.txt)
0030 
0031 %
0032 % --- Previous check
0033 %
0034 if ~exist('mtype_cell', 'var')
0035     mtype_cell = { 'y-' , 'r-' , 'c-' , 'g-' , 'w-', 'm-'};
0036 end
0037 
0038 %
0039 % --- Main Procedure
0040 %
0041 obj = struct;
0042 obj.mtype_cell = mtype_cell;
0043 obj.element_cell = cell(0, 1);
0044 
0045 %
0046 % --- After check
0047 %
0048 if nargout ~= 1
0049     error('function caller should receive obj.');
0050 end

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