Skip to content

Commit 52b4aa2

Browse files
alperkentalperkent
committed
Deploying to gh-pages from @ fcaf7d9 🚀
1 parent 8553e38 commit 52b4aa2

10 files changed

Lines changed: 1509 additions & 1510 deletions

File tree

‎graphomotor.html‎

Lines changed: 24 additions & 378 deletions
Large diffs are not rendered by default.

‎graphomotor/core.html‎

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
<input type="search" placeholder="Search..." role="searchbox" aria-label="search"
2727
pattern=".+" required>
2828

29+
<h2>Contents</h2>
30+
<ul>
31+
<li><a href="#data-models-and-validation">Data Models and Validation</a></li>
32+
<li><a href="#configuration-and-logging">Configuration and Logging</a></li>
33+
<li><a href="#pipeline-orchestration">Pipeline Orchestration</a></li>
34+
<li><a href="#command-line-interface">Command-Line Interface</a></li>
35+
</ul>
36+
2937

3038
<h2>Submodules</h2>
3139
<ul>
@@ -49,14 +57,99 @@ <h2>Submodules</h2>
4957
<h1 class="modulename">
5058
<a href="./../graphomotor.html">graphomotor</a><wbr>.core </h1>
5159

52-
<div class="docstring"><p></p>
60+
<div class="docstring"><p>Core functionality for graphomotor data processing and analysis.</p>
61+
62+
<p>This module provides the essential infrastructure for the graphomotor toolkit:</p>
63+
64+
<h2 id="data-models-and-validation">Data Models and Validation</h2>
65+
66+
<ul>
67+
<li><strong><code>Spiral</code></strong>: Pydantic model for spiral drawing data validation with strict
68+
metadata requirements (7-digit participant IDs starting with '5', Dom/NonDom
69+
hand designation, spiral_trace/spiral_recall tasks numbered 1-5)</li>
70+
<li><strong><code>FeatureCategories</code></strong>: Registry of all 4 feature extractors (duration,
71+
velocity, hausdorff, AUC) with dynamic extractor mapping</li>
72+
</ul>
73+
74+
<h2 id="configuration-and-logging">Configuration and Logging</h2>
75+
76+
<ul>
77+
<li><strong><code>SpiralConfig</code></strong>: Immutable dataclass for Archimedean spiral parameters
78+
(center coordinates, growth rate, angles, point density) with custom
79+
parameter override support</li>
80+
<li><strong>Logger</strong>: Centralized logging with configurable verbosity levels
81+
(WARNING/INFO/DEBUG) and structured formatting</li>
82+
</ul>
83+
84+
<h2 id="pipeline-orchestration">Pipeline Orchestration</h2>
85+
86+
<ul>
87+
<li><strong><code>run_pipeline()</code></strong>: Main entry point supporting both single-file and
88+
batch directory processing with progress tracking, error handling, and
89+
configurable feature extraction</li>
90+
<li><strong>Feature Extraction</strong>: Coordinates spiral centering, reference generation,
91+
and execution of all feature extractors</li>
92+
<li><strong>Export System</strong>: Automated CSV export with metadata preservation and
93+
timestamp-based naming</li>
94+
</ul>
95+
96+
<h2 id="command-line-interface">Command-Line Interface</h2>
97+
98+
<ul>
99+
<li><strong><code>extract</code></strong>: CLI command for feature extraction with extensive configuration
100+
options and help documentation</li>
101+
<li><strong><code>plot-features</code></strong>: CLI command for generating publication-ready visualizations
102+
from extracted feature datasets</li>
103+
</ul>
104+
105+
<p>The core module serves as the foundation for all graphomotor operations, ensuring
106+
data quality, processing consistency, and user-friendly interfaces.</p>
53107
</div>
54108

55109
<input id="mod-core-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
56110

57111
<label class="view-source-button" for="mod-core-view-source"><span>View Source</span></label>
58112

59-
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="sd">&quot;&quot;&quot;.. include:: ../../README.md&quot;&quot;&quot;</span> <span class="c1"># noqa: D415</span>
113+
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="sd">&quot;&quot;&quot;Core functionality for graphomotor data processing and analysis.</span>
114+
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a>
115+
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="sd">This module provides the essential infrastructure for the graphomotor toolkit:</span>
116+
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a>
117+
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a><span class="sd">## Data Models and Validation</span>
118+
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a>
119+
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="sd">- **`Spiral`**: Pydantic model for spiral drawing data validation with strict</span>
120+
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="sd"> metadata requirements (7-digit participant IDs starting with &#39;5&#39;, Dom/NonDom</span>
121+
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="sd"> hand designation, spiral_trace/spiral_recall tasks numbered 1-5)</span>
122+
</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a><span class="sd">- **`FeatureCategories`**: Registry of all 4 feature extractors (duration,</span>
123+
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="sd"> velocity, hausdorff, AUC) with dynamic extractor mapping</span>
124+
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a>
125+
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="sd">## Configuration and Logging</span>
126+
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a>
127+
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="sd">- **`SpiralConfig`**: Immutable dataclass for Archimedean spiral parameters</span>
128+
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a><span class="sd"> (center coordinates, growth rate, angles, point density) with custom</span>
129+
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a><span class="sd"> parameter override support</span>
130+
</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a><span class="sd">- **Logger**: Centralized logging with configurable verbosity levels</span>
131+
</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a><span class="sd"> (WARNING/INFO/DEBUG) and structured formatting</span>
132+
</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a>
133+
</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="sd">## Pipeline Orchestration</span>
134+
</span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a>
135+
</span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a><span class="sd">- **`run_pipeline()`**: Main entry point supporting both single-file and</span>
136+
</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a><span class="sd"> batch directory processing with progress tracking, error handling, and</span>
137+
</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a><span class="sd"> configurable feature extraction</span>
138+
</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a><span class="sd">- **Feature Extraction**: Coordinates spiral centering, reference generation,</span>
139+
</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a><span class="sd"> and execution of all feature extractors</span>
140+
</span><span id="L-28"><a href="#L-28"><span class="linenos">28</span></a><span class="sd">- **Export System**: Automated CSV export with metadata preservation and</span>
141+
</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a><span class="sd"> timestamp-based naming</span>
142+
</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a>
143+
</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a><span class="sd">## Command-Line Interface</span>
144+
</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a>
145+
</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a><span class="sd">- **`extract`**: CLI command for feature extraction with extensive configuration</span>
146+
</span><span id="L-34"><a href="#L-34"><span class="linenos">34</span></a><span class="sd"> options and help documentation</span>
147+
</span><span id="L-35"><a href="#L-35"><span class="linenos">35</span></a><span class="sd">- **`plot-features`**: CLI command for generating publication-ready visualizations</span>
148+
</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a><span class="sd"> from extracted feature datasets</span>
149+
</span><span id="L-37"><a href="#L-37"><span class="linenos">37</span></a>
150+
</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a><span class="sd">The core module serves as the foundation for all graphomotor operations, ensuring</span>
151+
</span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a><span class="sd">data quality, processing consistency, and user-friendly interfaces.</span>
152+
</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a><span class="sd">&quot;&quot;&quot;</span>
60153
</span></pre></div>
61154

62155

0 commit comments

Comments
 (0)