hypercoil.github.io/init.html at main · hypercoil/hypercoil.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000

<!DOCTYPE html>


<html lang="en" data-content_root="./" data-theme="dark">

  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>init: Initialisation schemes &#8212; hypercoil prototype (unreleased) documentation</title>


  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "dark";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
  </script>

  <!-- Loaded before other Sphinx assets -->
  <link href="_static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />


  <link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />

    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
    <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />

  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
  <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>

    <script src="_static/documentation_options.js?v=7bbc9f7b"></script>
    <script src="_static/doctools.js?v=888ff710"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'init';</script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="atlas: Atlas initialisation" href="api/hypercoil.init.atlas.html" />
    <link rel="prev" title="sample_overlapping_windows_existing_ax" href="api/hypercoil.functional.window.sample_overlapping_windows_existing_ax.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  </head>


  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="dark">


  <a class="skip-link" href="#main-content">Skip to main content</a>

  <div id="pst-scroll-pixel-helper"></div>


  <button type="button" class="btn rounded-pill" id="pst-back-to-top">
    <i class="fa-solid fa-arrow-up"></i>
    Back to top
  </button>


  <input type="checkbox"
          class="sidebar-toggle"
          name="__primary"
          id="__primary"/>
  <label class="overlay overlay-primary" for="__primary"></label>

  <input type="checkbox"
          class="sidebar-toggle"
          name="__secondary"
          id="__secondary"/>
  <label class="overlay overlay-secondary" for="__secondary"></label>

  <div class="search-button__wrapper">
    <div class="search-button__overlay"></div>
    <div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
      action="search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         id="search-input"
         placeholder="Search the docs ..."
         aria-label="Search the docs ..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
  </div>

    <nav class="bd-header navbar navbar-expand-lg bd-navbar">
<div class="bd-header__inner bd-page-width">
  <label class="sidebar-toggle primary-toggle" for="__primary">
    <span class="fa-solid fa-bars"></span>
  </label>


  <div class="col-lg-3 navbar-header-items__start">

      <div class="navbar-item">


<a class="navbar-brand logo" href="index.html">


    <img src="_static/logo.png" class="logo__image only-dark" alt="hypercoil prototype (unreleased) documentation - Home"/>
    <script>document.write(`<img src="_static/logo.png" class="logo__image only-light" alt="hypercoil prototype (unreleased) documentation - Home"/>`);</script>


</a></div>

  </div>

  <div class="col-lg-9 navbar-header-items">

    <div class="me-auto navbar-header-items__center">

        <div class="navbar-item">
<nav class="navbar-nav">
  <p class="sidebar-header-items__title"
     role="heading"
     aria-level="1"
     aria-label="Site Navigation">
    Site Navigation
  </p>
  <ul class="bd-navbar-elements navbar-nav">

                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="installation.html">
                        Installation
                      </a>
                    </li>


                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="overview.html">
                        Technical overview
                      </a>
                    </li>


                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="diffprog.html">
                        Framework
                      </a>
                    </li>


                    <li class="nav-item current active">
                      <a class="nav-link nav-internal" href="modules.html">
                        API reference
                      </a>
                    </li>


                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="examples.html">
                        Examples
                      </a>
                    </li>

  </ul>
</nav></div>

    </div>


    <div class="navbar-header-items__end">

        <div class="navbar-item navbar-persistent--container">


 <script>
 document.write(`
   <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
    <span class="search-button__default-text">Search</span>
    <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
   </button>
 `);
 </script>
        </div>


        <div class="navbar-item">

<script>
document.write(`
  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
  </button>
`);
</script></div>

    </div>

  </div>


    <div class="navbar-persistent--mobile">

 <script>
 document.write(`
   <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
    <span class="search-button__default-text">Search</span>
    <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
   </button>
 `);
 </script>
    </div>


    <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0">
      <span class="fa-solid fa-outdent"></span>
    </label>

</div>

    </nav>

  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">

      <div class="bd-sidebar-primary bd-sidebar">


  <div class="sidebar-header-items sidebar-primary__section">


      <div class="sidebar-header-items__center">

          <div class="navbar-item">
<nav class="navbar-nav">
  <p class="sidebar-header-items__title"
     role="heading"
     aria-level="1"
     aria-label="Site Navigation">
    Site Navigation
  </p>
  <ul class="bd-navbar-elements navbar-nav">

                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="installation.html">
                        Installation
                      </a>
                    </li>


                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="overview.html">
                        Technical overview
                      </a>
                    </li>


                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="diffprog.html">
                        Framework
                      </a>
                    </li>


                    <li class="nav-item current active">
                      <a class="nav-link nav-internal" href="modules.html">
                        API reference
                      </a>
                    </li>


                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="examples.html">
                        Examples
                      </a>
                    </li>

  </ul>
</nav></div>

      </div>


      <div class="sidebar-header-items__end">

          <div class="navbar-item">

<script>
document.write(`
  <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
    <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
    <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
  </button>
`);
</script></div>

      </div>

  </div>

    <div class="sidebar-primary-items__start sidebar-primary__section">
        <div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
     aria-label="Section Navigation">
  <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="engine.html"><code class="docutils literal notranslate"><span class="pre">engine</span></code>: Differentiable engine</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="functional.html"><code class="docutils literal notranslate"><span class="pre">functional</span></code>: Functions and functionals</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.activation.html"><code class="docutils literal notranslate"><span class="pre">activation</span></code>: Activation functions</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.activation.amplitude_tanh.html"><code class="docutils literal notranslate"><span class="pre">amplitude_tanh</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.activation.amplitude_atanh.html"><code class="docutils literal notranslate"><span class="pre">amplitude_atanh</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.activation.corrnorm.html"><code class="docutils literal notranslate"><span class="pre">corrnorm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.activation.isochor.html"><code class="docutils literal notranslate"><span class="pre">isochor</span></code>: PSD normalisation</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.cmass.html"><code class="docutils literal notranslate"><span class="pre">cmass</span></code>: Centre of mass</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cmass.cmass_coor.html"><code class="docutils literal notranslate"><span class="pre">cmass_coor</span></code>: Centre of mass, any coordinates</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cmass.cmass.html"><code class="docutils literal notranslate"><span class="pre">cmass</span></code>: Centre of mass, array coordinates</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cmass.diffuse.html"><code class="docutils literal notranslate"><span class="pre">diffuse</span></code>: Diffuseness around centre of mass</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cmass.cmass_reference.html">Displacement from a reference centre of mass</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.connectopy.html"><code class="docutils literal notranslate"><span class="pre">connectopy</span></code>: Connectopic manifolds</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.connectopy.laplacian_eigenmaps.html"><code class="docutils literal notranslate"><span class="pre">laplacian_eigenmaps</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.connectopy.diffusion_mapping.html"><code class="docutils literal notranslate"><span class="pre">diffusion_mapping</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.cov.html"><code class="docutils literal notranslate"><span class="pre">cov</span></code>: Covariances and correlations</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.cov.html"><code class="docutils literal notranslate"><span class="pre">cov</span></code>: Covariance</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.corr.html"><code class="docutils literal notranslate"><span class="pre">corr</span></code>: Pearson correlation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.partialcov.html"><code class="docutils literal notranslate"><span class="pre">partialcov</span></code>: Partial covariance</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.partialcorr.html"><code class="docutils literal notranslate"><span class="pre">partialcorr</span></code>: Partial correlation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.pairedcov.html"><code class="docutils literal notranslate"><span class="pre">pairedcov</span></code>: Paired covariance</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.pairedcorr.html"><code class="docutils literal notranslate"><span class="pre">pairedcorr</span></code>: Paired correlation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.conditionalcov.html"><code class="docutils literal notranslate"><span class="pre">conditionalcov</span></code>: Conditional covariance</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.conditionalcorr.html"><code class="docutils literal notranslate"><span class="pre">conditionalcorr</span></code>: Conditional correlation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.cov.precision.html"><code class="docutils literal notranslate"><span class="pre">precision</span></code>: Inverse covariance (precision)</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.fourier.html"><code class="docutils literal notranslate"><span class="pre">fourier</span></code>: Frequency-domain filter</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.product_filter.html"><code class="docutils literal notranslate"><span class="pre">product_filter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.product_filtfilt.html"><code class="docutils literal notranslate"><span class="pre">product_filtfilt</span></code>: Zero-phase filter</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.unwrap.html"><code class="docutils literal notranslate"><span class="pre">unwrap</span></code>: Unwrap phase</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.analytic_signal.html"><code class="docutils literal notranslate"><span class="pre">analytic_signal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.hilbert_transform.html"><code class="docutils literal notranslate"><span class="pre">hilbert_transform</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.envelope.html"><code class="docutils literal notranslate"><span class="pre">envelope</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.instantaneous_phase.html"><code class="docutils literal notranslate"><span class="pre">instantaneous_phase</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.instantaneous_frequency.html"><code class="docutils literal notranslate"><span class="pre">instantaneous_frequency</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.fourier.env_inst.html"><code class="docutils literal notranslate"><span class="pre">env_inst</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.graph.html"><code class="docutils literal notranslate"><span class="pre">graph</span></code>: Graphs and networks</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.graph.girvan_newman_null.html"><code class="docutils literal notranslate"><span class="pre">girvan_newman_null</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.graph.modularity_matrix.html"><code class="docutils literal notranslate"><span class="pre">modularity_matrix</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.graph.coaffiliation.html"><code class="docutils literal notranslate"><span class="pre">coaffiliation</span></code>: Community coaffiliation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.graph.relaxed_modularity.html"><code class="docutils literal notranslate"><span class="pre">relaxed_modularity</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.graph.graph_laplacian.html"><code class="docutils literal notranslate"><span class="pre">graph_laplacian</span></code>: Graph Laplacian</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.interpolate.html"><code class="docutils literal notranslate"><span class="pre">interpolate</span></code>: Interpolation and imputation</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.interpolate.hybrid_interpolate.html"><code class="docutils literal notranslate"><span class="pre">hybrid_interpolate</span></code>: Linear + spectral interpolation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.interpolate.linear_interpolate.html"><code class="docutils literal notranslate"><span class="pre">linear_interpolate</span></code>: Linear interpolation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.interpolate.weighted_interpolate.html"><code class="docutils literal notranslate"><span class="pre">weighted_interpolate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.interpolate.spectral_interpolate.html"><code class="docutils literal notranslate"><span class="pre">spectral_interpolate</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.kernel.html"><code class="docutils literal notranslate"><span class="pre">kernel</span></code>: Parameterised kernels</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.linear_kernel.html"><code class="docutils literal notranslate"><span class="pre">linear_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.param_norm.html"><code class="docutils literal notranslate"><span class="pre">param_norm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.linear_distance.html"><code class="docutils literal notranslate"><span class="pre">linear_distance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.polynomial_kernel.html"><code class="docutils literal notranslate"><span class="pre">polynomial_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.sigmoid_kernel.html"><code class="docutils literal notranslate"><span class="pre">sigmoid_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.gaussian_kernel.html"><code class="docutils literal notranslate"><span class="pre">gaussian_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.rbf_kernel.html"><code class="docutils literal notranslate"><span class="pre">rbf_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.cosine_kernel.html"><code class="docutils literal notranslate"><span class="pre">cosine_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.cov_kernel.html"><code class="docutils literal notranslate"><span class="pre">cov_kernel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.kernel.corr_kernel.html"><code class="docutils literal notranslate"><span class="pre">corr_kernel</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.matrix.html"><code class="docutils literal notranslate"><span class="pre">matrix</span></code>: Matrix operations</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.cholesky_invert.html"><code class="docutils literal notranslate"><span class="pre">cholesky_invert</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.symmetric.html"><code class="docutils literal notranslate"><span class="pre">symmetric</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.spd.html"><code class="docutils literal notranslate"><span class="pre">spd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.expand_outer.html"><code class="docutils literal notranslate"><span class="pre">expand_outer</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.recondition_eigenspaces.html"><code class="docutils literal notranslate"><span class="pre">recondition_eigenspaces</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.delete_diagonal.html"><code class="docutils literal notranslate"><span class="pre">delete_diagonal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.diag_embed.html"><code class="docutils literal notranslate"><span class="pre">diag_embed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.fill_diagonal.html"><code class="docutils literal notranslate"><span class="pre">fill_diagonal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.toeplitz_2d.html"><code class="docutils literal notranslate"><span class="pre">toeplitz_2d</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.toeplitz.html"><code class="docutils literal notranslate"><span class="pre">toeplitz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.sym2vec.html"><code class="docutils literal notranslate"><span class="pre">sym2vec</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.vec2sym.html"><code class="docutils literal notranslate"><span class="pre">vec2sym</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.matrix.squareform.html"><code class="docutils literal notranslate"><span class="pre">squareform</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.functional.resid.residualise.html"><code class="docutils literal notranslate"><span class="pre">residualise</span></code></a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.semidefinite.html"><code class="docutils literal notranslate"><span class="pre">semidefinite</span></code>: Positive semidefinite cone</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.semidefinite.tangent_project_spd.html"><code class="docutils literal notranslate"><span class="pre">tangent_project_spd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.semidefinite.cone_project_spd.html"><code class="docutils literal notranslate"><span class="pre">cone_project_spd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.semidefinite.mean_euc_spd.html"><code class="docutils literal notranslate"><span class="pre">mean_euc_spd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.semidefinite.mean_harm_spd.html"><code class="docutils literal notranslate"><span class="pre">mean_harm_spd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.semidefinite.mean_logeuc_spd.html"><code class="docutils literal notranslate"><span class="pre">mean_logeuc_spd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.semidefinite.mean_geom_spd.html"><code class="docutils literal notranslate"><span class="pre">mean_geom_spd</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.sparse.html"><code class="docutils literal notranslate"><span class="pre">sparse</span></code>: Sparse matrix operations</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.random_sparse.html"><code class="docutils literal notranslate"><span class="pre">random_sparse</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.spdiagmm.html"><code class="docutils literal notranslate"><span class="pre">spdiagmm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.dspdmm.html"><code class="docutils literal notranslate"><span class="pre">dspdmm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.spspmm_full.html"><code class="docutils literal notranslate"><span class="pre">spspmm_full</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.topk.html"><code class="docutils literal notranslate"><span class="pre">topk</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.as_topk.html"><code class="docutils literal notranslate"><span class="pre">as_topk</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.full_as_topk.html"><code class="docutils literal notranslate"><span class="pre">full_as_topk</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.sparse_astype.html"><code class="docutils literal notranslate"><span class="pre">sparse_astype</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.trace_spspmm.html"><code class="docutils literal notranslate"><span class="pre">trace_spspmm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.spspmm.html"><code class="docutils literal notranslate"><span class="pre">spspmm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.spsp_pairdiff.html"><code class="docutils literal notranslate"><span class="pre">spsp_pairdiff</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.select_indices.html"><code class="docutils literal notranslate"><span class="pre">select_indices</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.topkx.html"><code class="docutils literal notranslate"><span class="pre">topkx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.sp_block_serialise.html"><code class="docutils literal notranslate"><span class="pre">sp_block_serialise</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.splr_hadamard.html"><code class="docutils literal notranslate"><span class="pre">splr_hadamard</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.spsp_innerpaired.html"><code class="docutils literal notranslate"><span class="pre">spsp_innerpaired</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.topk_to_bcoo.html"><code class="docutils literal notranslate"><span class="pre">topk_to_bcoo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.topk_diagzero.html"><code class="docutils literal notranslate"><span class="pre">topk_diagzero</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.topk_diagreplace.html"><code class="docutils literal notranslate"><span class="pre">topk_diagreplace</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sparse.block_serialise.html"><code class="docutils literal notranslate"><span class="pre">block_serialise</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.sphere.html"><code class="docutils literal notranslate"><span class="pre">sphere</span></code>: Spherical coordinates</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sphere.spherical_geodesic.html"><code class="docutils literal notranslate"><span class="pre">spherical_geodesic</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sphere.sphere_to_normals.html"><code class="docutils literal notranslate"><span class="pre">sphere_to_normals</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sphere.sphere_to_latlong.html"><code class="docutils literal notranslate"><span class="pre">sphere_to_latlong</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sphere.spatial_conv.html"><code class="docutils literal notranslate"><span class="pre">spatial_conv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sphere.spherical_conv.html"><code class="docutils literal notranslate"><span class="pre">spherical_conv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.sphere.euclidean_conv.html"><code class="docutils literal notranslate"><span class="pre">euclidean_conv</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.functional.sylo.html"><code class="docutils literal notranslate"><span class="pre">sylo</span></code>: Sylo function</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.symmap.html"><code class="docutils literal notranslate"><span class="pre">symmap</span></code>: Symmetric matrix maps</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.symmap.symmap.html"><code class="docutils literal notranslate"><span class="pre">symmap</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.symmap.symexp.html"><code class="docutils literal notranslate"><span class="pre">symexp</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.symmap.symlog.html"><code class="docutils literal notranslate"><span class="pre">symlog</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.symmap.symsqrt.html"><code class="docutils literal notranslate"><span class="pre">symsqrt</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.tsconv.html"><code class="docutils literal notranslate"><span class="pre">tsconv</span></code>: Time series convolution</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.tsconv.conv.html"><code class="docutils literal notranslate"><span class="pre">conv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.tsconv.tsconv2d.html"><code class="docutils literal notranslate"><span class="pre">tsconv2d</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.tsconv.basischan.html"><code class="docutils literal notranslate"><span class="pre">basischan</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.tsconv.basisconv2d.html"><code class="docutils literal notranslate"><span class="pre">basisconv2d</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.tsconv.polychan.html"><code class="docutils literal notranslate"><span class="pre">polychan</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.tsconv.polyconv2d.html"><code class="docutils literal notranslate"><span class="pre">polyconv2d</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.utils.html"><code class="docutils literal notranslate"><span class="pre">utils</span></code>: Miscellaneous</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-17"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.utils.conform_mask.html"><code class="docutils literal notranslate"><span class="pre">conform_mask</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.utils.apply_mask.html"><code class="docutils literal notranslate"><span class="pre">apply_mask</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.utils.mask_tensor.html"><code class="docutils literal notranslate"><span class="pre">mask_tensor</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.utils.complex_decompose.html"><code class="docutils literal notranslate"><span class="pre">complex_decompose</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.utils.complex_recompose.html"><code class="docutils literal notranslate"><span class="pre">complex_recompose</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.utils.amplitude_apply.html"><code class="docutils literal notranslate"><span class="pre">amplitude_apply</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.functional.window.html"><code class="docutils literal notranslate"><span class="pre">window</span></code>: Random windowing</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-18"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.window.sample_windows.html"><code class="docutils literal notranslate"><span class="pre">sample_windows</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.window.sample_nonoverlapping_windows_existing_ax.html"><code class="docutils literal notranslate"><span class="pre">sample_nonoverlapping_windows_existing_ax</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.window.sample_nonoverlapping_windows_new_ax.html"><code class="docutils literal notranslate"><span class="pre">sample_nonoverlapping_windows_new_ax</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.window.sample_overlapping_windows_new_ax.html"><code class="docutils literal notranslate"><span class="pre">sample_overlapping_windows_new_ax</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.functional.window.sample_overlapping_windows_existing_ax.html"><code class="docutils literal notranslate"><span class="pre">sample_overlapping_windows_existing_ax</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">init</span></code>: Initialisation schemes</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-19"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.init.atlas.html"><code class="docutils literal notranslate"><span class="pre">atlas</span></code>: Atlas initialisation</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-20"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.BaseAtlas.html"><code class="docutils literal notranslate"><span class="pre">BaseAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitBaseAtlas.html"><code class="docutils literal notranslate"><span class="pre">DirichletInitBaseAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DiscreteVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">DiscreteVolumetricAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.MultiVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">MultiVolumetricAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.MultifileVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">MultifileVolumetricAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.CortexSubcortexCIfTIAtlas.html"><code class="docutils literal notranslate"><span class="pre">CortexSubcortexCIfTIAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">DirichletInitVolumetricAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitSurfaceAtlas.html"><code class="docutils literal notranslate"><span class="pre">DirichletInitSurfaceAtlas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.AtlasInitialiser.html"><code class="docutils literal notranslate"><span class="pre">AtlasInitialiser</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html"><code class="docutils literal notranslate"><span class="pre">atlasmixins</span></code>: Atlas mixins</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.init.base.html"><code class="docutils literal notranslate"><span class="pre">base</span></code>: Base initialisations</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-21"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.from_distr_init.html"><code class="docutils literal notranslate"><span class="pre">from_distr_init</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.constant_init.html"><code class="docutils literal notranslate"><span class="pre">constant_init</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.identity_init.html"><code class="docutils literal notranslate"><span class="pre">identity_init</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.MappedInitialiser.html"><code class="docutils literal notranslate"><span class="pre">MappedInitialiser</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.DistributionInitialiser.html"><code class="docutils literal notranslate"><span class="pre">DistributionInitialiser</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.IdentityInitialiser.html"><code class="docutils literal notranslate"><span class="pre">IdentityInitialiser</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.deltaplus.html"><code class="docutils literal notranslate"><span class="pre">deltaplus</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.dirichlet.html"><code class="docutils literal notranslate"><span class="pre">dirichlet</span></code></a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.init.freqfilter.html"><code class="docutils literal notranslate"><span class="pre">freqfilter</span></code>: Frequency band init</a><input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-22"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.freqfilter.FreqFilterSpec.html"><code class="docutils literal notranslate"><span class="pre">FreqFilterSpec</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.iirfilter.html"><code class="docutils literal notranslate"><span class="pre">iirfilter</span></code>: IIR filter init</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.laplace.html"><code class="docutils literal notranslate"><span class="pre">laplace</span></code></a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.init.mapparam.html"><code class="docutils literal notranslate"><span class="pre">mapparam</span></code>: Mapped parameters and parameter maps</a><input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-23"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.MappedParameter.html"><code class="docutils literal notranslate"><span class="pre">MappedParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.DomainMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">DomainMappedParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.IdentityMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">IdentityMappedParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.AffineMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">AffineMappedParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.TanhMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">TanhMappedParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.AmplitudeTanhMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">AmplitudeTanhMappedParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.MappedLogits.html"><code class="docutils literal notranslate"><span class="pre">MappedLogits</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.NormSphereParameter.html"><code class="docutils literal notranslate"><span class="pre">NormSphereParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.ProbabilitySimplexParameter.html"><code class="docutils literal notranslate"><span class="pre">ProbabilitySimplexParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.AmplitudeProbabilitySimplexParameter.html"><code class="docutils literal notranslate"><span class="pre">AmplitudeProbabilitySimplexParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.OrthogonalParameter.html"><code class="docutils literal notranslate"><span class="pre">OrthogonalParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.IsochoricParameter.html"><code class="docutils literal notranslate"><span class="pre">IsochoricParameter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.Clip.html"><code class="docutils literal notranslate"><span class="pre">Clip</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.Renormalise.html"><code class="docutils literal notranslate"><span class="pre">Renormalise</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.ForcePositiveDefinite.html"><code class="docutils literal notranslate"><span class="pre">ForcePositiveDefinite</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.PhaseAmplitudeMixin.html"><code class="docutils literal notranslate"><span class="pre">PhaseAmplitudeMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mpbl.html"><code class="docutils literal notranslate"><span class="pre">mpbl</span></code></a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.init.semidefinite.html"><code class="docutils literal notranslate"><span class="pre">semidefinite</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-24"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.semidefinite.TangencyInitialiser.html"><code class="docutils literal notranslate"><span class="pre">TangencyInitialiser</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.semidefinite.SemidefiniteMean.html"><code class="docutils literal notranslate"><span class="pre">SemidefiniteMean</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.sylo.html"><code class="docutils literal notranslate"><span class="pre">sylo</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.toeplitz.html"><code class="docutils literal notranslate"><span class="pre">toeplitz</span></code></a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="loss.html"><code class="docutils literal notranslate"><span class="pre">loss</span></code>: Loss and regularisation</a><input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-25"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.Loss.html"><code class="docutils literal notranslate"><span class="pre">Loss</span></code>: Base class for scalar-valued losses</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.ParameterisedLoss.html"><code class="docutils literal notranslate"><span class="pre">ParameterisedLoss</span></code>: Extensible class for custom parameterised losses</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.MSELoss.html"><code class="docutils literal notranslate"><span class="pre">MSELoss</span></code>: Mean squared error</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.NormedLoss.html"><code class="docutils literal notranslate"><span class="pre">NormedLoss</span></code>: Normed parameter regularisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.identity.html"><code class="docutils literal notranslate"><span class="pre">identity</span></code>: Identity function</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.zero.html"><code class="docutils literal notranslate"><span class="pre">zero</span></code>: Zero function</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.difference.html"><code class="docutils literal notranslate"><span class="pre">difference</span></code>: Elementwise difference</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.constraint_violation.html"><code class="docutils literal notranslate"><span class="pre">constraint_violation</span></code>: Soft constraints</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.unilateral_loss.html"><code class="docutils literal notranslate"><span class="pre">unilateral_loss</span></code>: Unilateral penalties</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.hinge_loss.html"><code class="docutils literal notranslate"><span class="pre">hinge_loss</span></code>: SVM hinge loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.smoothness.html"><code class="docutils literal notranslate"><span class="pre">smoothness</span></code>: Backwards differences</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.bimodal_symmetric.html"><code class="docutils literal notranslate"><span class="pre">bimodal_symmetric</span></code>: Minimal distance from 2 modes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.det_gram.html"><code class="docutils literal notranslate"><span class="pre">det_gram</span></code>: Gramian determinant</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.log_det_gram.html"><code class="docutils literal notranslate"><span class="pre">log_det_gram</span></code>: Gram log-determinant loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.entropy.html"><code class="docutils literal notranslate"><span class="pre">entropy</span></code>: Categorical entropy</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.kl_divergence.html"><code class="docutils literal notranslate"><span class="pre">kl_divergence</span></code>: Kullback-Leibler divergence</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.js_divergence.html"><code class="docutils literal notranslate"><span class="pre">js_divergence</span></code>: Jensen-Shannon divergence</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.bregman_divergence.html"><code class="docutils literal notranslate"><span class="pre">bregman_divergence</span></code>: Bregman divergences</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.equilibrium.html"><code class="docutils literal notranslate"><span class="pre">equilibrium</span></code>: Equilibrium loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.second_moment.html"><code class="docutils literal notranslate"><span class="pre">second_moment</span></code>: Second moments</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.auto_tol.html"><code class="docutils literal notranslate"><span class="pre">auto_tol</span></code>: Significance tolerance</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.batch_corr.html"><code class="docutils literal notranslate"><span class="pre">batch_corr</span></code>: Batch-axis correlation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.qcfc.html"><code class="docutils literal notranslate"><span class="pre">qcfc</span></code>: QC-FC measures and loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.reference_tether.html"><code class="docutils literal notranslate"><span class="pre">reference_tether</span></code>: Spatial tether to reference points</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.interhemispheric_tether.html"><code class="docutils literal notranslate"><span class="pre">interhemispheric_tether</span></code>: Inter-hemispheric tethering loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.compactness.html"><code class="docutils literal notranslate"><span class="pre">compactness</span></code>: Compactness</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.dispersion.html"><code class="docutils literal notranslate"><span class="pre">dispersion</span></code>: Vector dispersion</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.multivariate_kurtosis.html"><code class="docutils literal notranslate"><span class="pre">multivariate_kurtosis</span></code>: Time series stationarity</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.connectopy.html"><code class="docutils literal notranslate"><span class="pre">connectopy</span></code>: Generalised connectopy</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.modularity.html"><code class="docutils literal notranslate"><span class="pre">modularity</span></code>: Relaxed modularity</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.sum_scalarise.html"><code class="docutils literal notranslate"><span class="pre">sum_scalarise</span></code>: Sum scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.mean_scalarise.html"><code class="docutils literal notranslate"><span class="pre">mean_scalarise</span></code>: Mean scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.meansq_scalarise.html"><code class="docutils literal notranslate"><span class="pre">meansq_scalarise</span></code>: Squared mean scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.max_scalarise.html"><code class="docutils literal notranslate"><span class="pre">max_scalarise</span></code>: Maximum-value scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.norm_scalarise.html"><code class="docutils literal notranslate"><span class="pre">norm_scalarise</span></code>: Norm scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.vnorm_scalarise.html"><code class="docutils literal notranslate"><span class="pre">vnorm_scalarise</span></code>: Vector norm scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.wmean_scalarise.html"><code class="docutils literal notranslate"><span class="pre">wmean_scalarise</span></code>: Weighted mean scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scalarise.selfwmean_scalarise.html"><code class="docutils literal notranslate"><span class="pre">selfwmean_scalarise</span></code>: Self-weighted mean scalarisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scheme.LossApply.html"><code class="docutils literal notranslate"><span class="pre">LossApply</span></code>: Selectively apply loss to parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.loss.scheme.LossScheme.html"><code class="docutils literal notranslate"><span class="pre">LossScheme</span></code>: Scheme for multiple losses</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="neuro.html"><code class="docutils literal notranslate"><span class="pre">neuro</span></code>: Neuroscience data utilities</a><input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-26"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.neuro.synth.html"><code class="docutils literal notranslate"><span class="pre">synth</span></code>: Data synthesis</a><input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-27"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.neuro.synth.match_spectra.html"><code class="docutils literal notranslate"><span class="pre">match_spectra</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.neuro.synth.match_covariance.html"><code class="docutils literal notranslate"><span class="pre">match_covariance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.neuro.synth.match_reference.html"><code class="docutils literal notranslate"><span class="pre">match_reference</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.neuro.synth.match_cov_and_spectrum.html"><code class="docutils literal notranslate"><span class="pre">match_cov_and_spectrum</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.neuro.synth.synthesise_matched.html"><code class="docutils literal notranslate"><span class="pre">synthesise_matched</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.neuro.synth.synthesise_from_cov_and_spectrum.html"><code class="docutils literal notranslate"><span class="pre">synthesise_from_cov_and_spectrum</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="nn.html"><code class="docutils literal notranslate"><span class="pre">nn</span></code>: Neural network modules</a><input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-28"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.activation.html"><code class="docutils literal notranslate"><span class="pre">activation</span></code>: Activation functions as modules</a><input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-29"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.activation.CorrelationNorm.html"><code class="docutils literal notranslate"><span class="pre">CorrelationNorm</span></code>: Correlation normalisation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.activation.Isochor.html"><code class="docutils literal notranslate"><span class="pre">Isochor</span></code>: Isochoric normalisation</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.atlas.html"><code class="docutils literal notranslate"><span class="pre">atlas</span></code>: Atlas layers</a><input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-30"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.atlas.AtlasLinear.html"><code class="docutils literal notranslate"><span class="pre">AtlasLinear</span></code>: Linear atlas layer</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.cov.html"><code class="docutils literal notranslate"><span class="pre">cov</span></code>: Covariance modules</a><input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-31"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.BaseCovariance.html"><code class="docutils literal notranslate"><span class="pre">BaseCovariance</span></code>: Covariance base class</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.UnaryCovariance.html"><code class="docutils literal notranslate"><span class="pre">UnaryCovariance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.UnaryCovarianceTW.html"><code class="docutils literal notranslate"><span class="pre">UnaryCovarianceTW</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.UnaryCovarianceUW.html"><code class="docutils literal notranslate"><span class="pre">UnaryCovarianceUW</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.BinaryCovariance.html"><code class="docutils literal notranslate"><span class="pre">BinaryCovariance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.BinaryCovarianceTW.html"><code class="docutils literal notranslate"><span class="pre">BinaryCovarianceTW</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.cov.BinaryCovarianceUW.html"><code class="docutils literal notranslate"><span class="pre">BinaryCovarianceUW</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.nn.freqfilter.FrequencyDomainFilter.html"><code class="docutils literal notranslate"><span class="pre">freqfilter</span></code>: Frequency-domain filter layer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.nn.iirfilter.html"><code class="docutils literal notranslate"><span class="pre">iirfilter</span></code>: IIR filter layer</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.interpolate.html"><code class="docutils literal notranslate"><span class="pre">interpolate</span></code>: Interpolation layers</a><input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-32"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.interpolate.SpectralInterpolate.html"><code class="docutils literal notranslate"><span class="pre">SpectralInterpolate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.interpolate.LinearInterpolate.html"><code class="docutils literal notranslate"><span class="pre">LinearInterpolate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.interpolate.HybridInterpolate.html"><code class="docutils literal notranslate"><span class="pre">HybridInterpolate</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.recombinator.html"><code class="docutils literal notranslate"><span class="pre">recombinator</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-33"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.recombinator.Recombinator.html"><code class="docutils literal notranslate"><span class="pre">Recombinator</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.nn.resid.Residualise.html"><code class="docutils literal notranslate"><span class="pre">Residualise</span></code></a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.semidefinite.html"><code class="docutils literal notranslate"><span class="pre">semidefinite</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-34"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.semidefinite.TangentProject.html"><code class="docutils literal notranslate"><span class="pre">TangentProject</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.semidefinite.BatchTangentProject.html"><code class="docutils literal notranslate"><span class="pre">BatchTangentProject</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.nn.spdnoise.SPDNoise.html"><code class="docutils literal notranslate"><span class="pre">SPDNoise</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.nn.svm.SVM.html"><code class="docutils literal notranslate"><span class="pre">SVM</span></code></a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.sylo.html"><code class="docutils literal notranslate"><span class="pre">sylo</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-35"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.sylo.Sylo.html"><code class="docutils literal notranslate"><span class="pre">Sylo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.sylo.SyloResNet.html"><code class="docutils literal notranslate"><span class="pre">SyloResNet</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/hypercoil.nn.vertcom.html"><code class="docutils literal notranslate"><span class="pre">vertcom</span></code>: Vertex compression</a><input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-36"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.nn.vertcom.VerticalCompression.html"><code class="docutils literal notranslate"><span class="pre">VerticalCompression</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.nn.window.WindowAmplifier.html"><code class="docutils literal notranslate"><span class="pre">WindowAmplifier</span></code></a></li>
</ul>
</li>
</ul>
</div>
</nav></div>
    </div>


  <div class="sidebar-primary-items__end sidebar-primary__section">
  </div>

  <div id="rtd-footer-container"></div>


      </div>

      <main id="main-content" class="bd-main">


          <div class="bd-content">
            <div class="bd-article-container">

              <div class="bd-header-article">
<div class="header-article-items header-article__inner">

    <div class="header-article-items__start">

        <div class="header-article-item">


<nav aria-label="Breadcrumb">
  <ul class="bd-breadcrumbs">

    <li class="breadcrumb-item breadcrumb-home">
      <a href="index.html" class="nav-link" aria-label="Home">
        <i class="fa-solid fa-home"></i>
      </a>
    </li>

    <li class="breadcrumb-item"><a href="modules.html" class="nav-link">API reference</a></li>

    <li class="breadcrumb-item active" aria-current="page"><code...</li>
  </ul>
</nav>
</div>

    </div>


</div>
</div>


<div id="searchbox"></div>
                <article class="bd-article" role="main">

  <section id="module-hypercoil.init">
<span id="init-initialisation-schemes"></span><h1><code class="docutils literal notranslate"><span class="pre">init</span></code>: Initialisation schemes<a class="headerlink" href="#module-hypercoil.init" title="Link to this heading">#</a></h1>
<p>Parameter initialisation schemes.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">init</span></code> submodule contains functionality for initialising (neural
network) module parameters to reasonable defaults.</p>
<p>In the differentiable programming setting, initialisation provides a path for
integrating <strong>domain expertise</strong> into neural network models. The
initialisation schemes and routines provided here present a transparent
framework for incorporating the discipline’s existing best practices as
starting points for a differentiable workflow.</p>
<p>For example, the routines here enable the
<a class="reference internal" href="api/hypercoil.nn.atlas.AtlasLinear.html"><span class="doc">linear atlas layer</span></a>
to be initialised as most available volumetric and surface-based neuroimaging
parcellations. Modifications can be applied easily to promote better learning
signals. For the case of the atlas layer, for instance, hard parcels can be
smoothed (in either Euclidean or
<a class="reference internal" href="api/hypercoil.functional.sphere.html"><span class="doc">spherical topology</span></a>
) or constrained to the
<a class="reference internal" href="api/hypercoil.init.mapparam.ProbabilitySimplexParameter.html"><span class="doc">probability simplex</span></a>
(using a softmax domain transformation) to change the properties of the
gradients they receive.</p>
<p>Also available are more general initialisation schemes for use cases where a
clean slate is desired as a starting point. For example, a random
<a class="reference internal" href="api/hypercoil.init.dirichlet.html"><span class="doc">Dirichlet initialisation</span></a>
, when combined with a
<a class="reference internal" href="api/hypercoil.init.mapparam.ProbabilitySimplexParameter.html"><span class="doc">probability simplex projection</span></a>
, lends columns in a parcellation matrix the intuitive interpretation of
probability distributions over parcels.</p>
<p>Most initialisation scheme classes (eventually, all) can be combined with a
<a class="reference internal" href="api/hypercoil.init.mapparam.html"><span class="doc">parameter mapping</span></a>.
If a parameter mapping is used to initialise a compatible module’s parameters,
the parameters are internally stored by the module as “original parameters”
and then transformed through the mapping before they interact with inputs.
Some schemes are paired with a mapping by default. For instance,
<a class="reference internal" href="api/hypercoil.init.dirichlet.html"><span class="doc">Dirichlet initialisation</span></a>
is by default paired with a
<span class="xref std std-doc">probability simplex projection</span>
domain to constrain Dirichlet-initialised weights to always be valid
probability distributions.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Any and all APIs here are experimental and subject to change. Test
coverage is inadequate and extreme discretion is warranted when using this
functionality. Please report any bugs by opening an issue.</p>
</div>
<div class="toctree-wrapper compound">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.atlas.html"><code class="docutils literal notranslate"><span class="pre">atlas</span></code>: Atlas initialisation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.BaseAtlas.html"><code class="docutils literal notranslate"><span class="pre">BaseAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.BaseAtlas.html#hypercoil.init.atlas.BaseAtlas"><code class="docutils literal notranslate"><span class="pre">BaseAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.BaseAtlas.html#hypercoil.init.atlas.BaseAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">BaseAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitBaseAtlas.html"><code class="docutils literal notranslate"><span class="pre">DirichletInitBaseAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitBaseAtlas.html#hypercoil.init.atlas.DirichletInitBaseAtlas"><code class="docutils literal notranslate"><span class="pre">DirichletInitBaseAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitBaseAtlas.html#hypercoil.init.atlas.DirichletInitBaseAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">DirichletInitBaseAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.DiscreteVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">DiscreteVolumetricAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DiscreteVolumetricAtlas.html#hypercoil.init.atlas.DiscreteVolumetricAtlas"><code class="docutils literal notranslate"><span class="pre">DiscreteVolumetricAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.DiscreteVolumetricAtlas.html#hypercoil.init.atlas.DiscreteVolumetricAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">DiscreteVolumetricAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.MultiVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">MultiVolumetricAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.MultiVolumetricAtlas.html#hypercoil.init.atlas.MultiVolumetricAtlas"><code class="docutils literal notranslate"><span class="pre">MultiVolumetricAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.MultiVolumetricAtlas.html#hypercoil.init.atlas.MultiVolumetricAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">MultiVolumetricAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.MultifileVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">MultifileVolumetricAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.MultifileVolumetricAtlas.html#hypercoil.init.atlas.MultifileVolumetricAtlas"><code class="docutils literal notranslate"><span class="pre">MultifileVolumetricAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.MultifileVolumetricAtlas.html#hypercoil.init.atlas.MultifileVolumetricAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">MultifileVolumetricAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.CortexSubcortexCIfTIAtlas.html"><code class="docutils literal notranslate"><span class="pre">CortexSubcortexCIfTIAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.CortexSubcortexCIfTIAtlas.html#hypercoil.init.atlas.CortexSubcortexCIfTIAtlas"><code class="docutils literal notranslate"><span class="pre">CortexSubcortexCIfTIAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.CortexSubcortexCIfTIAtlas.html#hypercoil.init.atlas.CortexSubcortexCIfTIAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">CortexSubcortexCIfTIAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitVolumetricAtlas.html"><code class="docutils literal notranslate"><span class="pre">DirichletInitVolumetricAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitVolumetricAtlas.html#hypercoil.init.atlas.DirichletInitVolumetricAtlas"><code class="docutils literal notranslate"><span class="pre">DirichletInitVolumetricAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitVolumetricAtlas.html#hypercoil.init.atlas.DirichletInitVolumetricAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">DirichletInitVolumetricAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitSurfaceAtlas.html"><code class="docutils literal notranslate"><span class="pre">DirichletInitSurfaceAtlas</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitSurfaceAtlas.html#hypercoil.init.atlas.DirichletInitSurfaceAtlas"><code class="docutils literal notranslate"><span class="pre">DirichletInitSurfaceAtlas</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.DirichletInitSurfaceAtlas.html#hypercoil.init.atlas.DirichletInitSurfaceAtlas.__call__"><code class="docutils literal notranslate"><span class="pre">DirichletInitSurfaceAtlas.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlas.AtlasInitialiser.html"><code class="docutils literal notranslate"><span class="pre">AtlasInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlas.AtlasInitialiser.html#hypercoil.init.atlas.AtlasInitialiser"><code class="docutils literal notranslate"><span class="pre">AtlasInitialiser</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.atlas.AtlasInitialiser.html#hypercoil.init.atlas.AtlasInitialiser.__call__"><code class="docutils literal notranslate"><span class="pre">AtlasInitialiser.__call__()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html"><code class="docutils literal notranslate"><span class="pre">atlasmixins</span></code>: Atlas mixins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#referencemixin"><code class="docutils literal notranslate"><span class="pre">~ReferenceMixin</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._VolumeObjectReferenceMixin"><code class="docutils literal notranslate"><span class="pre">_VolumeObjectReferenceMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._SurfaceObjectReferenceMixin"><code class="docutils literal notranslate"><span class="pre">_SurfaceObjectReferenceMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._VolumeSingleReferenceMixin"><code class="docutils literal notranslate"><span class="pre">_VolumeSingleReferenceMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._SurfaceSingleReferenceMixin"><code class="docutils literal notranslate"><span class="pre">_SurfaceSingleReferenceMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._VolumeMultiReferenceMixin"><code class="docutils literal notranslate"><span class="pre">_VolumeMultiReferenceMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._PhantomReferenceMixin"><code class="docutils literal notranslate"><span class="pre">_PhantomReferenceMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#maskmixin"><code class="docutils literal notranslate"><span class="pre">~MaskMixin</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._LogicMaskMixin"><code class="docutils literal notranslate"><span class="pre">_LogicMaskMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._CortexSubcortexCIfTIMaskMixin"><code class="docutils literal notranslate"><span class="pre">_CortexSubcortexCIfTIMaskMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._FromNullMaskMixin"><code class="docutils literal notranslate"><span class="pre">_FromNullMaskMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#compartmentmixin"><code class="docutils literal notranslate"><span class="pre">~CompartmentMixin</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._SingleCompartmentMixin"><code class="docutils literal notranslate"><span class="pre">_SingleCompartmentMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._MultiCompartmentMixin"><code class="docutils literal notranslate"><span class="pre">_MultiCompartmentMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._CortexSubcortexCIfTICompartmentMixin"><code class="docutils literal notranslate"><span class="pre">_CortexSubcortexCIfTICompartmentMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#labelmixin"><code class="docutils literal notranslate"><span class="pre">~LabelMixin</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._DiscreteLabelMixin"><code class="docutils literal notranslate"><span class="pre">_DiscreteLabelMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._ContinuousLabelMixin"><code class="docutils literal notranslate"><span class="pre">_ContinuousLabelMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._DirichletLabelMixin"><code class="docutils literal notranslate"><span class="pre">_DirichletLabelMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#meshmixin"><code class="docutils literal notranslate"><span class="pre">~MeshMixin</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._VolumetricMeshMixin"><code class="docutils literal notranslate"><span class="pre">_VolumetricMeshMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._VertexCIfTIMeshMixin"><code class="docutils literal notranslate"><span class="pre">_VertexCIfTIMeshMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#convmixin"><code class="docutils literal notranslate"><span class="pre">~ConvMixin</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._EvenlySampledConvMixin"><code class="docutils literal notranslate"><span class="pre">_EvenlySampledConvMixin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins._SpatialConvMixin"><code class="docutils literal notranslate"><span class="pre">_SpatialConvMixin</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#abstractions">Abstractions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins.Reference"><code class="docutils literal notranslate"><span class="pre">Reference</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins.Mask"><code class="docutils literal notranslate"><span class="pre">Mask</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins.Compartment"><code class="docutils literal notranslate"><span class="pre">Compartment</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.atlasmixins.html#hypercoil.init.atlasmixins.CompartmentSet"><code class="docutils literal notranslate"><span class="pre">CompartmentSet</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.base.html"><code class="docutils literal notranslate"><span class="pre">base</span></code>: Base initialisations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.base.from_distr_init.html"><code class="docutils literal notranslate"><span class="pre">from_distr_init</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.from_distr_init.html#hypercoil.init.base.from_distr_init"><code class="docutils literal notranslate"><span class="pre">from_distr_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.base.constant_init.html"><code class="docutils literal notranslate"><span class="pre">constant_init</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.constant_init.html#hypercoil.init.base.constant_init"><code class="docutils literal notranslate"><span class="pre">constant_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.base.identity_init.html"><code class="docutils literal notranslate"><span class="pre">identity_init</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.identity_init.html#hypercoil.init.base.identity_init"><code class="docutils literal notranslate"><span class="pre">identity_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.base.MappedInitialiser.html"><code class="docutils literal notranslate"><span class="pre">MappedInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.MappedInitialiser.html#hypercoil.init.base.MappedInitialiser"><code class="docutils literal notranslate"><span class="pre">MappedInitialiser</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.base.DistributionInitialiser.html"><code class="docutils literal notranslate"><span class="pre">DistributionInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.DistributionInitialiser.html#hypercoil.init.base.DistributionInitialiser"><code class="docutils literal notranslate"><span class="pre">DistributionInitialiser()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.base.IdentityInitialiser.html"><code class="docutils literal notranslate"><span class="pre">IdentityInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.base.IdentityInitialiser.html#hypercoil.init.base.IdentityInitialiser"><code class="docutils literal notranslate"><span class="pre">IdentityInitialiser</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.deltaplus.html"><code class="docutils literal notranslate"><span class="pre">deltaplus</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.deltaplus.html#deltaplus-init"><code class="docutils literal notranslate"><span class="pre">deltaplus_init</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.deltaplus.html#hypercoil.init.deltaplus.deltaplus_init"><code class="docutils literal notranslate"><span class="pre">deltaplus_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.deltaplus.html#deltaplusinitialiser"><code class="docutils literal notranslate"><span class="pre">DeltaPlusInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.deltaplus.html#hypercoil.init.deltaplus.DeltaPlusInitialiser"><code class="docutils literal notranslate"><span class="pre">DeltaPlusInitialiser</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.dirichlet.html"><code class="docutils literal notranslate"><span class="pre">dirichlet</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.dirichlet.html#dirichlet-init"><code class="docutils literal notranslate"><span class="pre">dirichlet_init</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.dirichlet.html#hypercoil.init.dirichlet.dirichlet_init"><code class="docutils literal notranslate"><span class="pre">dirichlet_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.dirichlet.html#dirichletinitialiser"><code class="docutils literal notranslate"><span class="pre">DirichletInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.dirichlet.html#hypercoil.init.dirichlet.DirichletInitialiser"><code class="docutils literal notranslate"><span class="pre">DirichletInitialiser</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.freqfilter.html"><code class="docutils literal notranslate"><span class="pre">freqfilter</span></code>: Frequency band init</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.freqfilter.FreqFilterSpec.html"><code class="docutils literal notranslate"><span class="pre">FreqFilterSpec</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.freqfilter.FreqFilterSpec.html#hypercoil.init.freqfilter.FreqFilterSpec"><code class="docutils literal notranslate"><span class="pre">FreqFilterSpec</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.freqfilter.FreqFilterSpec.html#hypercoil.init.freqfilter.FreqFilterSpec.initialise_spectrum"><code class="docutils literal notranslate"><span class="pre">FreqFilterSpec.initialise_spectrum()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.freqfilter.FreqFilterSpec.html#hypercoil.init.freqfilter.FreqFilterSpec.get_clamps"><code class="docutils literal notranslate"><span class="pre">FreqFilterSpec.get_clamps()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.iirfilter.html"><code class="docutils literal notranslate"><span class="pre">iirfilter</span></code>: IIR filter init</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.iirfilter.html#iirfilterspec"><code class="docutils literal notranslate"><span class="pre">IIRFilterSpec</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.iirfilter.html#hypercoil.init.iirfilter.IIRFilterSpec"><code class="docutils literal notranslate"><span class="pre">IIRFilterSpec</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/hypercoil.init.iirfilter.html#hypercoil.init.iirfilter.IIRFilterSpec.initialise_coefs"><code class="docutils literal notranslate"><span class="pre">IIRFilterSpec.initialise_coefs()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.laplace.html"><code class="docutils literal notranslate"><span class="pre">laplace</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.laplace.html#laplace-init"><code class="docutils literal notranslate"><span class="pre">laplace_init</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.laplace.html#hypercoil.init.laplace.laplace_init"><code class="docutils literal notranslate"><span class="pre">laplace_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.laplace.html#laplaceinitialiser"><code class="docutils literal notranslate"><span class="pre">LaplaceInitialiser</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.laplace.html#hypercoil.init.laplace.LaplaceInitialiser"><code class="docutils literal notranslate"><span class="pre">LaplaceInitialiser</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/hypercoil.init.mapparam.html"><code class="docutils literal notranslate"><span class="pre">mapparam</span></code>: Mapped parameters and parameter maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.MappedParameter.html"><code class="docutils literal notranslate"><span class="pre">MappedParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.MappedParameter.html#hypercoil.init.mapparam.MappedParameter"><code class="docutils literal notranslate"><span class="pre">MappedParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.DomainMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">DomainMappedParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.DomainMappedParameter.html#hypercoil.init.mapparam.DomainMappedParameter"><code class="docutils literal notranslate"><span class="pre">DomainMappedParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.IdentityMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">IdentityMappedParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.IdentityMappedParameter.html#hypercoil.init.mapparam.IdentityMappedParameter"><code class="docutils literal notranslate"><span class="pre">IdentityMappedParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.AffineMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">AffineMappedParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.AffineMappedParameter.html#hypercoil.init.mapparam.AffineMappedParameter"><code class="docutils literal notranslate"><span class="pre">AffineMappedParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.TanhMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">TanhMappedParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.TanhMappedParameter.html#hypercoil.init.mapparam.TanhMappedParameter"><code class="docutils literal notranslate"><span class="pre">TanhMappedParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.AmplitudeTanhMappedParameter.html"><code class="docutils literal notranslate"><span class="pre">AmplitudeTanhMappedParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.AmplitudeTanhMappedParameter.html#hypercoil.init.mapparam.AmplitudeTanhMappedParameter"><code class="docutils literal notranslate"><span class="pre">AmplitudeTanhMappedParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.MappedLogits.html"><code class="docutils literal notranslate"><span class="pre">MappedLogits</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.MappedLogits.html#hypercoil.init.mapparam.MappedLogits"><code class="docutils literal notranslate"><span class="pre">MappedLogits</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.NormSphereParameter.html"><code class="docutils literal notranslate"><span class="pre">NormSphereParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.NormSphereParameter.html#hypercoil.init.mapparam.NormSphereParameter"><code class="docutils literal notranslate"><span class="pre">NormSphereParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.ProbabilitySimplexParameter.html"><code class="docutils literal notranslate"><span class="pre">ProbabilitySimplexParameter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/hypercoil.init.mapparam.ProbabilitySimplexParameter.html#hypercoil.init.mapparam.ProbabilitySimplexParameter"><code class="docutils literal notranslate"><span class="pre">ProbabilitySimplexParameter</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/hypercoil.init.mapparam.AmplitudeProbabilitySimplexParameter.html"><code class="docutils literal notranslate"><span class="pre">AmplitudeProbabilitySimplexParameter</span></code></a><ul>