odml-terminologies/v1.1/analysis/psth.xml

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="https://terminologies.g-node.org/_resources/odmlDocument.xsl" xmlns:odml="http://www.g-node.org/odml"?>
<odML version="1.1">
  <repository>https://terminologies.g-node.org/v1.1/terminologies.xml</repository>
  <version>1.0</version>
  <date>2011-01-21</date>
  <!-- ********************************************************* -->
  <!--                     PSTH section                          -->
  <!-- ********************************************************* -->
  <section>
    <type>analysis/psth</type>
    <name>PSTH</name>
    <definition>An Analysis-type section to describe an PSTH.</definition>

    <property>
      <name>Author</name>
      <type>person</type>
      <definition>The name of the person who did the analysis, e.g. 'John Doe' or 'Doe, John'</definition>
    </property>

    <property>
      <name>Date</name>
      <type>date</type>
      <definition>The date of analysis.</definition>
    </property>

    <property>
      <name>Description</name>
      <type>text</type>
      <definition>A general description of the analysis.</definition>
    </property>

    <property>
      <name>Method</name>
      <type>string</type>
      <value>[instantaneous spike rate, sliding window, discrete window]</value>
      <definition>The method used for creating the PSTH. instantaneous spike rate; Estimation of the firing rate by
        using the inverse of the interspike interval.; sliding window: The window function was slid over the data at
        recording resolution.; discrete window: Spikes were averaged within the window, window discretely displaced by
        the window width.
      </definition>
    </property>

    <property>
      <name>WindowType</name>
      <type>string</type>
      <value>[rectangular, gaussian, alpha]</value>
      <definition>The kind of windowing function used to cerate the PSTH.</definition>
    </property>

    <property>
      <name>CommandlineCall</name>
      <type>string</type>
      <definition>The command used to execute the analysis including the command line parameter.</definition>
    </property>

    <property>
      <name>Comment</name>
      <type>text</type>
      <definition>Specific comments on this analysis.</definition>
    </property>

    <property>
      <name>CodeFile</name>
      <type>URL</type>
      <definition>The URL of the applied piece of program code to actually do the analysis.</definition>
    </property>

    <property>
      <name>CodeRevision</name>
      <type>string</type>
      <definition>If the analysis code is under version control the revision number can be specified using this
        property.
      </definition>
    </property>

    <property>
      <name>ConfigFile</name>
      <type>URL</type>
      <definition>The URL to the configuration file used to run the analysis.</definition>
    </property>

    <property>
      <name>DatasetFile</name>
      <type>URL</type>
      <definition>The URL to the dataset file the analysis is applied on.</definition>
    </property>

    <property>
      <name>ResultFile</name>
      <type>URL</type>
      <definition>The URL to the results file the analysis was applied on.</definition>
    </property>

    <property>
      <name>ResultFigure</name>
      <type>URL</type>
      <definition>The URL to a figure file showing the results of the analysis.</definition>
    </property>

    <property>
      <name>PaperDOI</name>
      <type>text</type>
      <definition>If the results of this analysis have been published one can store the doi of the paper.</definition>
    </property>

    <property>
      <name>PaperURL</name>
      <type>URL</type>
      <definition>If the results of this analysis have been published the URL of the document can be given here
      </definition>
    </property>

  </section>
</odML>