rvmd/functionSignatures.json at main · ZimoLiao/rvmd · 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
{
  "_schemaVersion": "1.0.0",
  "rvmd": {
    "inputs": [
      {
        "name": "Q",
        "kind": "required",
        "type": ["numeric"],
        "purpose": "finite real- or complex-valued S-by-T data matrix"
      },
      {
        "name": "K",
        "kind": "required",
        "type": ["numeric", "integer", "scalar", ">0"],
        "purpose": "number of modes"
      },
      {
        "name": "Alpha",
        "kind": "required",
        "type": ["numeric", "scalar", ">=0"],
        "purpose": "bandwidth penalty in 1/(1+2*Alpha*d^2)"
      },
      {
        "name": "Weight",
        "kind": "namevalue",
        "type": ["numeric"],
        "purpose": "positive scalar or spatial weight vector"
      },
      {
        "name": "Tolerance",
        "kind": "namevalue",
        "type": ["numeric", "scalar", ">=0"],
        "purpose": "iteration stopping tolerance"
      },
      {
        "name": "MaximumSteps",
        "kind": "namevalue",
        "type": ["numeric", "integer", "scalar", ">0"],
        "purpose": "total iteration cap, including saved restart steps"
      },
      {
        "name": "InitFreqType",
        "kind": "namevalue",
        "type": "choices={-1,0,1}",
        "purpose": "random, zero, or uniform frequency initialization"
      },
      {
        "name": "InitFreqMaximum",
        "kind": "namevalue",
        "type": ["numeric", "scalar", ">=0"],
        "purpose": "initial frequency upper bound, capped at 0.5"
      },
      {
        "name": "Device",
        "kind": "namevalue",
        "type": "choices={'cpu','gpu'}",
        "purpose": "computation device"
      },
      {
        "name": "FPPrecision",
        "kind": "namevalue",
        "type": "choices={'single','double'}",
        "purpose": "floating-point precision"
      },
      {
        "name": "nDC",
        "kind": "namevalue",
        "type": ["numeric", "integer", "scalar", ">=0"],
        "purpose": "number of leading modes fixed at zero frequency"
      },
      {
        "name": "InitialFrequencies",
        "kind": "namevalue",
        "type": ["numeric"],
        "purpose": "optional K-vector of initial center frequencies in [0,0.5]"
      },
      {
        "name": "Display",
        "kind": "namevalue",
        "type": "choices={'off','final','iter'}",
        "purpose": "iteration display mode"
      },
      {
        "name": "DisplayInterval",
        "kind": "namevalue",
        "type": ["numeric", "integer", "scalar", ">0"],
        "purpose": "iteration interval for command-window progress"
      },
      {
        "name": "OutputFcn",
        "kind": "namevalue",
        "purpose": "callback stop = fcn(progress,phase)"
      },
      {
        "name": "TimeLimit",
        "kind": "namevalue",
        "type": ["numeric", "scalar", ">=0"],
        "purpose": "per-call wall-time limit in seconds"
      },
      {
        "name": "CheckpointFile",
        "kind": "namevalue",
        "purpose": "MAT-file path for atomic periodic checkpoints"
      },
      {
        "name": "CheckpointInterval",
        "kind": "namevalue",
        "type": ["numeric", "integer", "scalar", ">0"],
        "purpose": "checkpoint interval in completed sweeps"
      }
    ]
  },
  "rvmdplot": {
    "inputs": [
      {
        "name": "info",
        "kind": "required",
        "purpose": "info struct returned by rvmd"
      },
      {
        "name": "SampleRate",
        "kind": "namevalue",
        "type": ["numeric", "scalar", ">0"],
        "purpose": "frequency scaling from cycles per sample"
      }
    ]
  },
  "rvmdhilbert": {
    "inputs": [
      {
        "name": "mode",
        "kind": "required",
        "purpose": "mode struct returned by rvmd"
      },
      {
        "name": "sampleRate",
        "kind": "required",
        "type": ["numeric", "scalar", ">0"],
        "purpose": "sampling rate in physical units"
      },
      {
        "name": "ModeIndices",
        "kind": "namevalue",
        "type": ["numeric", "integer"],
        "purpose": "subset of modes to analyze"
      },
      {
        "name": "MirrorExtension",
        "kind": "namevalue",
        "purpose": "logical or finite numeric scalar controlling reflection before the transform"
      },
      {
        "name": "AmplitudeThreshold",
        "kind": "namevalue",
        "type": ["numeric", "scalar", ">=0"],
        "purpose": "relative threshold for meaningful instantaneous frequency"
      },
      {
        "name": "FrequencyBins",
        "kind": "namevalue",
        "type": ["numeric", "integer", "scalar", ">0"],
        "purpose": "number of Hilbert spectrum bins"
      },
      {
        "name": "FrequencyLimits",
        "kind": "namevalue",
        "type": ["numeric"],
        "purpose": "two-element Hilbert spectrum frequency range"
      }
    ]
  },
  "rvmdhilbertplot": {
    "inputs": [
      {
        "name": "analysis",
        "kind": "required",
        "purpose": "analysis struct returned by rvmdhilbert"
      }
    ]
  }
}