num_throats

Water.num_throats(labels='all', mode='union')

Return the number of throats of the specified labels

Parameters

• 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:

  mode	meaning
  ’or’	Throats with one or more of the given labels are counted. Also accepts ‘union’ and ‘any’.
  ’and’	Throats with all of the given labels are returned. Also accepts ‘intersection’ and ‘all’.
  ’xor’	Throats with only one of the given labels are counted. Also accepts ‘exclusive_or’.
  ’nor’	Throats with none of the given labels are counted. Also accepts ‘not’ and ‘none’.
  ’nand’	Throats with not all of the given labels are counted.
  ’xnor’	Throats with more than one of the given labels are counted.

Returns

Nt – Number of throats with the specified labels

Return type

int

See also

num_pores, count

Notes

Technically, ‘nand’ and ‘xnor’ should also count throats with none of the labels, however, to make the count more useful these are not included.