pw-csp
Version:
Common spatial pattern
444 lines (136 loc) • 6.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>CSP - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CSP.html">CSP</a><ul class='methods'><li data-type='method'><a href="CSP.html#project">project</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">CSP</h1>
<section>
<header>
<h2>
CSP
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="CSP"><span class="type-signature"></span>new CSP<span class="signature">(class1, class2)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a new CSP object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>class1</code></td>
<td class="type">
<span class="param-type">Array.<Array.<number>></span>
</td>
<td class="description last">Data samples for class 1. Rows should be samples, columns should be signals.</td>
</tr>
<tr>
<td class="name"><code>class2</code></td>
<td class="type">
<span class="param-type">Array.<Array.<number>></span>
</td>
<td class="description last">Data samples for class 2. Rows should be samples, columns should be signals.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="project"><span class="type-signature"></span>project<span class="signature">(data, dimensions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Array.<number>>}</span></h4>
<div class="description">
Projects data and reduces to given number of dimensions
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Array.<Array.<number>></span>
</td>
<td class="attributes">
</td>
<td class="description last">Data points to be projected. Rows should be samples, columns should be signals.</td>
</tr>
<tr>
<td class="name"><code>dimensions</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Number of dimensions to be returned. Can range from 1 to number of signals. Defaults to number of signals.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Projected data. Rows are samples, columns are dimensions sorted by descending importance.
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array.<number>></span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated at Thu Nov 16 2017 22:31:54 GMT-0600 (Central Standard Time)
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>