| Keyword | Value | Description |
| REPORT | | Indicates the start of a report definition section |
| TYPE | | The name which is used to refer to this object |
| CELLS | | Column | (string) | | Layer | (string) | | CellType | (string) | | Compartment | (string) |
| The source of the report |
| PROB | | The probability that a qualified cell will be included in the reporting. If probability is less than 100%, then cells are chosen randomly. For Eg.: If a cell group has 80 cells at 91% reporting probability, then 73 cells would be reported on. (Actually 72.8 cells, but rounding is done to the nearest integer). |
| CELL_SEQUENCE | | The sequence in which cells are to be reported for a given report. Valid values are: ORIGINAL and RANDOM.
ORIGINAL - Cells are reported in a sequential order, starting from the first cell in the cell group. This was the original way of reporting.
RANDOM - Cells are reported in a random order.
NOTE: 1) Since this keyword was added later on, for sake of backwards compatibility for old input (.in) files, the default value for this keyword is ORIGINAL.
2) The total number of cells reported are exact, rounded to nearest integer, for all CELL_SEQUENCE types. This was not so previously.
3) This keyword does not affect Synapse and Channel reports. Those reports are still reported according to old (or original) algorithm. |
| FREQUENCY | | The rate at which reports will be generated. For example, a one (1) indicates that a report should be produced every time step. A two (2) indicates that a report should be generated every other time step. The total number of timesteps reported will be 1/interval. |
| REPORT_ON | | The type of report to be run. (ex. VOLTAGE) |
| CHANNEL | | Replaces old channel report. By giving the name of a channel owned by the target compartment,
the values are reported in the same pattern as the old Channel Reports (see below). This differs
from the old report in that the channel family is determined during runtime, and it does not just report on the first
instance of that family. Before, if there were multiple channels of the same family, the first one defined would
always be reported. It is not necessary to use the REPORT_ON keyword for this report |
| SYNAPSE | | New USE report. By giving the type of a synapse owned by the target compartment, the USE values are reported. It is not necessary to use the REPORT_ON keyword for this report. See the Report Types section for more information. |
| SYNAPSE_RSE | | New RSE report. By giving the type of a synapse owned by the target compartment, the Redistribution of Synaptic Efficacy (RSE) values are reported. It is not necessary to use the REPORT_ON keyword for this report. See the Report Types section for more information. |
| SYNAPSE_UF | | New USE facilitation report. By giving the type of a synapse owned by the target compartment, the temporary USE value as a result of facilitation will be reported. It is not necessary to use the REPORT_ON keyword for this report. See the Report Types section for more information. |
| SYN_AUGMENTATION | | New SA report. By giving the type of a synapse owned by the target compartment, the Synaptic Augmentation (SA) values are reported. These value are actually the augmentation amount minus 1.0 because NCS requires the augmentation be at least 1.0. During the simulation, NCS will work with the augmentation amount greater than 1.0. For example, if the augmentation is 1.3, NCS will be using 0.3 in any formulas, and send 0.3 to the report. It is not necessary to use the REPORT_ON keyword for this report. See the Report Types section for more information. |
| ASCII | | Indicates that the report file should have its information written in ascii format. If this option is not included, the files will instead be written in binary format. The field after the ASCII keyword can usually be left blank, but if the optional word 'EXP' is included, the outputted values will use scientifc notation. This is useful for reports with very small values that would normally be truncated by the limit of four characters placed after a decimal point. |
| FILENAME | | The report will be written to the filename specified |
| TIME_START | | The times at which this reporting should begin. There can be multiple start times |
| TIME_END | | The times at which reporting should stop. There can be multiple stop times. |
| END_REPORT | | Indicates the end of a report definition section |
| Keyword | Value | Description |
| VOLTAGE | | The voltage of a compartment's membrane |
| NET_CURRENT | | The net current of the compartment |
| STIM_CURRENT | | The total stimulus current of the compartment |
| SYN_CURRENT | | The total synapse current of the compartment |
| LEAK_CURRENT | | the current leak of the compartment |
| ADJ_CURRENT | | The total adjacent compartment current of the compartment |
| CHANNEL_CURRENT | | The total channel current of the compartment |
| FIRE_COUNT | | Count of all cells in a timestep that have reached the peak of a spike |
| CHANNEL_KM | | Km Channels produce (5) values
- affect of activation particle (m): m^mPower
- activation particle (m): base value
- m-infinity (m_oo)
- t_m
- The channel current (I)
This Report has been deprecated. Use CHANNEL_RPT instead. |
| CHANNEL_KA | | Ka Channels produce eight (8) values
- affect of activation (m) and inactivation (h) particles: m^mPower * h^hPower
- activation particle (m): base value
- m-infinity (m_oo)
- t_m
- inactivation particle (h): base value
- h-infinity (h_oo)
- t_h
- The channel current (I)
This Report has been deprecated. Use CHANNEL_RPT instead |
| CHANNEL_KAHP | | Kahp Channels produce seven (7) values
- affect of activation particle (m): m^mPower
- activation particle (m): base value
- m-infinity (m_oo)
- t_m
- Calcium Internal
- funct_m
- The channel current (I)
This Report has been deprecated. Use CHANNEL_RPT instead
|
| SYNAPSE_USE | | The value of a synapse's USE at the reporting timestep.
Must use SYNAPSE keyword and specifying the synapse type desired. This will report on every synapse matching that type. Note that this may report on synapses that come from multiple sources if the synapse type is used in multiple connect statements. As with other reports, each line is one time step. The synapses belonging to each compartment stay together, but there may be a variable number. For example, compartment 0 may have 2 synapses, compartment 1 may have 3, compartment 2 may have 0, etc.
The Utilization of Synaptic Efficacy of a syanpse. USE represents long-term learning in a compartment. A higher USE value results in the release of more neurotransmitters, thereby amplifying a signal whereas a lower USE value results in the release of less neurotransmitters, thereby dampening a signal.
|
| SYNAPSE_RSE | | The value of a synapse's RSE value at the reporting timestep.
Must use SYNAPSE_RSE keyword with the name of a synapse type defined. This will report on every synapse matching that type. Note that this may report on synapses that come from multiple sources if the synapse type is used in multiple connect statements. As with other reports, each line is one time step. The synapses belonging to each compartment stay together, but there may be a variable number. For example, compartment 0 may have 2 synapses, compartment 1 may have 3, compartment 2 may have 0, etc.
|
| SYNAPSE_UF | | The value of a synapse's temporarily modified USE value as a result of facilitation.
Must use SYNAPSE_UF keyword with the name of a synapse type defined. This will report on every synapse matching that type. Note that this may report on synapses that come from multiple sources if the synapse type is used in multiple connect statements. As with other reports, each line is one time step. The synapses belonging to each compartment stay together, but there may be a variable number. For example, compartment 0 may have 2 synapses, compartment 1 may have 3, compartment 2 may have 0, etc.
|
| SYNAPSE_SA | | The value of a synapse's Augmentation value. Note: The value reported is one less than the actual value. This is because during a simulation, the augmentation must be at least 1, so only the remaining amount is used in formulas. Example, if the augmentation is 1.3, on 0.3 will be reported.
Must use SYN_AUGMENTATION keyword with the name of a synapse type defined. This will report on every synapse matching that type. Note that this may report on synapses that come from multiple sources if the synapse type is used in multiple connect statements. As with other reports, each line is one time step. The synapses belonging to each compartment stay together, but there may be a variable number. For example, compartment 0 may have 2 synapses, compartment 1 may have 3, compartment 2 may have 0, etc.
|
| CHANNEL_RPT | | Replaces old channel reports. The final report's layout will be the same as the old corresponding family report (KM, KA, KAHP). The family is determined during runtime.
Must include CHANNEL keyword with name of a channel type defined.
|