vampire.analysis.get_shannon_entropy#

vampire.analysis.get_shannon_entropy(distribution)[source]#

Calculate Shannon entropy from distribution (probability) of each shape mode.

Parameters:
distributionndarray

Distribution of shape modes.

Returns:
entropyfloat

Shannon entropy.

Notes

Shannon entropy here is defined as

\[S = - \sum p_i \ln (p_i)\]

where \(p_i\) is probability of cells in each shape mode.