3.5.1.4.5 IsMasked

Description

The function returns the number of masked points in dataset vd if n = 0. If n is supplied, this function returns the "mask state" of the index number data point: 1 = masked, 0 = not masked.

Syntax

int IsMasked(int n, dataset vd)

Parameter

n

index number.

vd

can be a dataset, a range or column in Origin worksheet.

Return

Returns the number of masked points in dataset vd if n = 0. If n is supplied, this function returns the "mask state" of the index number data point.

Example

newbook;
col(a) = data(1,10);
col(b) = uniform(10);
range bb = col(b)[3:6];
mark -st bb;  
masknum = ismasked(0,bb);
masknum = ; //should return masknum=4
mask1 = ismasked(1,bb);
mask1 = ; //should return mask1=0
mask3 = ismasked(3,bb);  
mask3 = ; //should return mask3=1