![]() | Spike Train Analysis Toolkit |
Many of the functions in the toolkit yield estimates of information-theoretic quantities. These quantities are stored in specialized data structures described below.
Holds a 2-dimensional histogram and its mutual information.
Name | Description | Type | Size |
---|---|---|---|
joint | Joint histogram | hist1d | 1 |
row | Marginal histogram (computed over rows) | hist1d | 1 |
col | Marginal histogram (computed over columns) | hist1d | 1 |
information | Mutual information of histogram | estimate | 1 |
Holds a total histogram, class-conditional histograms, and the mutual information.
Name | Description | Type | Size |
---|---|---|---|
class | Class-conditional histogram | hist1dvec | 1 |
total | Total histogram | hist1d | 1 |
information | Mutual information of histogram | estimate | 1 |
Holds a vector of 1-D histograms.
Name | Description | Type | Size |
---|---|---|---|
P | Number of words used to generate the estimate | int | 1 |
M | Number of elements in the vector | int | 1 |
vec | Vector of histograms | hist1d | M |
entropy | Total histogram | estimate | 1 |
Holds a 1-dimensional histogram and its entropy.
Name | Description | Type | Size |
---|---|---|---|
P | Number of words used to generate the estimate | int | 1 |
N | Number of letters per word | int | 1 |
C | Number of unique words | int | 1 |
wordlist | List of unique words | int | C×N |
wordcnt | Counts of unique words | double | C |
entropy | Entropy of histogram | estimate | Number of entropy methods requested by user |
Holds information related to an estimated quantity.
Name | Description | Type | Size |
---|---|---|---|
name | Estimate name | cell array | 1 |
value | Estimate value | double | 1 |
messages | Execution messages | message | 1 |
extras | Extra computed values | nv_pair | E |
ve | Variance of the estimate | nv_pair | V |
Simple structure that holds a name/value pair.
Name | Description | Type | Size |
---|---|---|---|
name | Name | cell array | 1 |
value | Value | double | 1 |
Structure to hold status, warning, and error messages.
Name | Description | Type | Size |
---|---|---|---|
status | Status messages | cell array | i |
warnings | Warning messages | cell array | j |
errors | Error messages | cell array | k |