Home > marsbar > @marsy > can_summarize.m

can_summarize

PURPOSE

returns 1 if object contains enough information to be summarized

SYNOPSIS

function tf = can_summarize(o)

DESCRIPTION

 returns 1 if object contains enough information to be summarized
 or is already summarized
 
 $Id$

CROSS-REFERENCE INFORMATION

This function calls:

isempty overloaded isempty method for mardo object
is_summarized returns 1 if object contains calculated summary data
n_regions get number of regions
region_size method to get size of specified region data
sumfunc method to get or set sumfunc

This function is called by:

join joins marsy objects into one object
summary method returns cell array of strings describing marsy object

SOURCE CODE

0001 function tf = can_summarize(o)
0002 % returns 1 if object contains enough information to be summarized
0003 % or is already summarized
0004 %
0005 % $Id$
0006   
0007 tf = 1;
0008 if is_summarized(o), return, end 
0009 for i = 1:n_regions(o);
0010   r_samp = region_size(o, i, 2);
0011   if r_samp > 1 % at least one region needs summarizing
0012     % check for summary function
0013     s = sumfunc(o);
0014     tf = ~isempty(s) & ~strcmp(s, 'unknown');
0015     break
0016   end
0017 end