- SalineWater.num_throats(labels='all', mode='union')#
Return the number of throats of the specified labels
labels (list of strings, optional) – The throat labels that should be included in the count. If not supplied, all throats are counted.
mode (str, optional) –
Specifies how the count should be performed. The options are:
Throats with one or more of the given labels are counted. Also accepts ‘union’ and ‘any’.
Throats with all of the given labels are returned. Also accepts ‘intersection’ and ‘all’.
Throats with only one of the given labels are counted. Also accepts ‘exclusive_or’.
Throats with none of the given labels are counted. Also accepts ‘not’ and ‘none’.
Throats with not all of the given labels are counted.
Throats with more than one of the given labels are counted.
Nt – Number of throats with the specified labels
- Return type
Technically, ‘nand’ and ‘xnor’ should also count throats with none of the labels, however, to make the count more useful these are not included.