From ftm
Jump to: navigation, search
Line 1: Line 1:
 
=== Under Construction... ===
 
=== Under Construction... ===
  
{{:Module mnm.svd}}
+
{{Module |
{{:Module mnm.pca}}
+
  | name=mnm.delta
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - initialize the input size<br>1 - initialize the filter size<br>
 +
  | attributes=norm - normalization mode 1 (default) or 0<br>inadddel - add a delay to the delayed input<br>
 +
  | messages=clear - clear the memory of inputs<br>getdelay - get the input ring buffer<br>getring - get the input ring buffer<br>getnorm - get the normalization factor<br>getstate - get the internal weights vector<br>norm - normalization
 +
... mode 1 (default) or 0<br>inadddel - add a delay to the delayed input<br>filtersize - set the filter size<br>insize - set the input size<br>
 +
  | inlets=0 - input vector<br>
 +
  | outlets=0 - output delayed inputs (in phase with deltas)<br>1 - output deltas<br>2 - internal values<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.diag
 +
  | brief=
 +
  | descr=
 +
  | arguments=none
 +
  | attributes=out - reference to an external fmat to store the diagonal<br>
 +
  | messages=out - reference to an external fmat to store the diagonal<br>
 +
  | inlets=0 - incoming fmat whose diagonal will be extracted<br>
 +
  | outlets=0 - diagonal of the fmat<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.gmmem
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - number of centers to use<br>
 +
  | attributes=ncenters - number of centers<br>criteria - criteria<br>mode - (diagonal|full|spherical) covariance computation types<br>outpriors - reference to external fmat to store priors<br>outcov - reference to external fmat to store
 +
... covariance<br>outcenters - reference to external fmat to store centers<br>
 +
  | messages=outpriors - reference to external fmat to store priors<br>outcov - reference to external fmat to store covariance<br>outcenters - reference to external fmat to store centers<br>
 +
  | inlets=0 - fmat<br>
 +
  | outlets=0 - fmat centers<br>1 - fmat covariance<br>2 - fmat priors<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.hist
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - number of bins<br>
 +
  | attributes=norm - values: on=max, sum: normalise histogram so that max or sum is 1<br>bpf - output two-column fmat with bin indices and histogram values<br>
 +
  | messages=set_n - number of bins<br>norm - values: on=max, sum: normalise histogram so that max or sum is 1<br>bpf - output two-column fmat with bin indices and histogram values<br>
 +
  | inlets=0 - data fmat or fvec <br>
 +
  | outlets=0 - histogram fmat<br>1 - min data value<br>2 - max data value<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.lu
 +
  | brief=
 +
  | descr=
 +
  | arguments=none
 +
  | attributes=outx - out X<br>outpivot - out pivot<br>outu - out U<br>outl - out L<br>
 +
  | messages=outx - out X<br>outpivot - out pivot<br>outu - out U<br>outl - out L<br>solve - solves system with incoming fmat and decomposed fmat<br>determinant - computes determinant of decomposed fmat<br>
 +
  | inlets=0 - fmat to decompose<br>
 +
  | outlets=0 - L<br>1 - U<br>2 - pivot<br>3 - X<br>4 - determinant<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.mahalanobis
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - fmat of mean values<br>1 - fmat of covariance<br>
 +
  | attributes=out - reference to external fmat to store result<br>
 +
  | messages=out - reference to external fmat to store result<br>set_shift_weight - set shift weight per target (in) line<br>set_shift_weight - set shift weight per target (in) line<br>set_shift - set shift vector per database (mu) line<br>set_shift
 +
... - set shift vector per database (mu) line<br>
 +
  | inlets=0 - vector<br>1 - mu<br>2 - sigma<br>
 +
  | outlets=0 - mahalanobis distance<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.meanstd
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - (1|2|row|col) sum over rows or columns<br>
 +
  | attributes=type - (fmat) always output an fmat even for scalar results<br>mode - (row|col|1|2) computes over rows or columns<br>outstd - reference to an external fmat to store the standard deviation<br>outmean - reference to an external
 +
... fmat to store the mean<br>
 +
  | messages=outstd - reference to an external fmat to store the standard deviation<br>outmean - reference to an external fmat to store the mean<br>
 +
  | inlets=0 - incoming fmat<br>
 +
  | outlets=0 - mean<br>1 - standard deviation<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.minmax
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - (1|2|row|col) sum over rows or columns<br>
 +
  | attributes=type - (fmat) always output an fmat even for scalar results<br>mode - (row|col|1|2) computes over rows or columns<br>outargmax - reference to fmat to store the argmax<br>outmax - reference to fmat to store the max<br>outargmin
 +
... - reference to fmat to store the argmin<br>outmin - reference to fmat to store the min<br>
 +
  | messages=outargmax - reference to fmat to store the argmax<br>outmax - reference to fmat to store the max<br>outargmin - reference to fmat to store the argmin<br>outmin - reference to fmat to store the min<br>
 +
  | inlets=0 - incoming fmat<br>
 +
  | outlets=0 - min<br>1 - argmin<br>2 - max<br>3 - argmax<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.nmd
 +
  | brief=
 +
  | descr=
 +
  | arguments=none
 +
  | attributes=itermax - itermax<br>sH - sH<br>criteria - criteria<br>outh - out H<br>
 +
  | messages=outh - out H<br>
 +
  | inlets=0 - fmat<br>1 - fmat<br>2 - <br>
 +
  | outlets=0 - fmat<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.nmf
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - number of components<br>
 +
  | attributes=itermax - maximum number of iterations<br>rdim - number of components<br>criteria - (float) stopping criteria<br>outh - reference to external fmat to store H<br>outw - reference to external fmat to store W<br>
 +
  | messages=outh - reference to external fmat to store H<br>outw - reference to external fmat to store W<br>
 +
  | inlets=0 - fmat to be decomposed<br>
 +
  | outlets=0 - W<br>1 - H<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.qr
 +
  | brief=
 +
  | descr=
 +
  | arguments=none
 +
  | attributes=outx - reference to external fmat to store X<br>outr - reference to external fmat to store R<br>outq - reference to external fmat to store Q<br>
 +
  | messages=outx - reference to external fmat to store X<br>outr - reference to external fmat to store R<br>outq - reference to external fmat to store Q<br>solve - solve system with QR decomposition<br>
 +
  | inlets=0 - fmat to be decomposed<br>
 +
  | outlets=0 - Q<br>1 - R<br>2 - X<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.stats
 +
  | brief=
 +
  | descr=
 +
  | arguments=output stats<br>
 +
  | attributes=norm - switch normalize<br>
 +
  | messages=set - set histogram vector (fmat)<br>clear - clear histogram<br>bang - output stats<br>norm - switch normalize<br>
 +
  | inlets=0 - data input<br>
 +
  | outlets=0 - average<br>1 - standard deviation<br>2 - count<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.submat
 +
  | brief=
 +
  | descr=
 +
  | arguments=none
 +
  | attributes=out - reference to external fmat to store the sub-matrix<br>
 +
  | messages=out - reference to external fmat to store the sub-matrix<br>end - end of submatrix coordinates<br>begin - start of submatrix coordinates<br>
 +
  | inlets=0 - fmat<br>
 +
  | outlets=0 - sub-matrix<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.sum
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - (1|2|row|col) sum over rows or columns<br>
 +
  | attributes=type - (fmat) always output an fmat even for scalar results<br>mode - (row|col|1|2) perform sum over rows or columns<br>out - reference to external fmat to store the sum<br>
 +
  | messages=out - reference to external fmat to store the sum<br>
 +
  | inlets=0 - incoming fmat<br>
 +
  | outlets=0 - sum of fmat<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.svd
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - number of singular values<br>
 +
  | attributes=mode - (auto|manual) automatically eliminate negligible singular values<br>outvt - reference to external fmat to store V'<br>outs - reference to external fmat to store S<br>outu - reference to external fmat to store U<br>
 +
  | messages=outvt - reference to external fmat to store V'<br>outs - reference to external fmat to store S<br>outu - reference to external fmat to store U<br>
 +
  | inlets=0 - fmat to be decomposed by SVD<br>
 +
  | outlets=0 - U<br>1 - S<br>2 - V'<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.transpose
 +
  | brief=
 +
  | descr=
 +
  | arguments=none
 +
  | attributes=out - reference to external fmat to store the transposition<br>
 +
  | messages=out - reference to external fmat to store the transposition<br>
 +
  | inlets=0 - fmat to be transposed<br>
 +
  | outlets=0 - transposed fmat<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.xdist2
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - fmat to be used as right operand<br>
 +
  | attributes=swap - (yes|no) swaps operands<br>out - reference to external fmat to store the result<br>
 +
  | messages=out - reference to external fmat to store the result<br>
 +
  | inlets=0 - left operand<br>1 - right operand<br>
 +
  | outlets=0 - resulting fmat<br>
 +
}}
 +
 
 +
{{Module |
 +
  | name=mnm.xmul
 +
  | brief=
 +
  | descr=
 +
  | arguments=0 - fmat to be used as right operand<br>
 +
  | attributes=swap - (yes|no) swaps operands<br>out - reference to an external fmat to store the result<br>
 +
  | messages=out - reference to an external fmat to store the result<br>
 +
  | inlets=0 - left hand side fmat operand<br>1 - right hand side fmat operand<br>
 +
  | outlets=0 - fmat result<br>
 +
}}

Revision as of 00:56, 15 November 2007

Under Construction...


mnm.delta '
arguments: 0 - initialize the input size
1 - initialize the filter size
attributes: norm - normalization mode 1 (default) or 0
inadddel - add a delay to the delayed input
messages: clear - clear the memory of inputs
getdelay - get the input ring buffer
getring - get the input ring buffer
getnorm - get the normalization factor
getstate - get the internal weights vector
norm - normalization

... mode 1 (default) or 0
inadddel - add a delay to the delayed input
filtersize - set the filter size
insize - set the input size

inlets: 0 - input vector
outlets: 0 - output delayed inputs (in phase with deltas)
1 - output deltas
2 - internal values

mnm.diag '
arguments: none
attributes: out - reference to an external fmat to store the diagonal
messages: out - reference to an external fmat to store the diagonal
inlets: 0 - incoming fmat whose diagonal will be extracted
outlets: 0 - diagonal of the fmat

mnm.gmmem '
arguments: 0 - number of centers to use
attributes: ncenters - number of centers
criteria - criteria
mode - (diagonal
messages: outpriors - reference to external fmat to store priors
outcov - reference to external fmat to store covariance
outcenters - reference to external fmat to store centers
inlets: 0 - fmat
outlets: 0 - fmat centers
1 - fmat covariance
2 - fmat priors

mnm.hist '
arguments: 0 - number of bins
attributes: norm - values: on=max, sum: normalise histogram so that max or sum is 1
bpf - output two-column fmat with bin indices and histogram values
messages: set_n - number of bins
norm - values: on=max, sum: normalise histogram so that max or sum is 1
bpf - output two-column fmat with bin indices and histogram values
inlets: 0 - data fmat or fvec
outlets: 0 - histogram fmat
1 - min data value
2 - max data value

mnm.lu '
arguments: none
attributes: outx - out X
outpivot - out pivot
outu - out U
outl - out L
messages: outx - out X
outpivot - out pivot
outu - out U
outl - out L
solve - solves system with incoming fmat and decomposed fmat
determinant - computes determinant of decomposed fmat
inlets: 0 - fmat to decompose
outlets: 0 - L
1 - U
2 - pivot
3 - X
4 - determinant

mnm.mahalanobis '
arguments: 0 - fmat of mean values
1 - fmat of covariance
attributes: out - reference to external fmat to store result
messages: out - reference to external fmat to store result
set_shift_weight - set shift weight per target (in) line
set_shift_weight - set shift weight per target (in) line
set_shift - set shift vector per database (mu) line
set_shift

... - set shift vector per database (mu) line

inlets: 0 - vector
1 - mu
2 - sigma
outlets: 0 - mahalanobis distance

mnm.meanstd '
arguments: 0 - (1
attributes: type - (fmat) always output an fmat even for scalar results
mode - (row
messages: outstd - reference to an external fmat to store the standard deviation
outmean - reference to an external fmat to store the mean
inlets: 0 - incoming fmat
outlets: 0 - mean
1 - standard deviation

mnm.minmax '
arguments: 0 - (1
attributes: type - (fmat) always output an fmat even for scalar results
mode - (row
messages: outargmax - reference to fmat to store the argmax
outmax - reference to fmat to store the max
outargmin - reference to fmat to store the argmin
outmin - reference to fmat to store the min
inlets: 0 - incoming fmat
outlets: 0 - min
1 - argmin
2 - max
3 - argmax

mnm.nmd '
arguments: none
attributes: itermax - itermax
sH - sH
criteria - criteria
outh - out H
messages: outh - out H
inlets: 0 - fmat
1 - fmat
2 -
outlets: 0 - fmat

mnm.nmf '
arguments: 0 - number of components
attributes: itermax - maximum number of iterations
rdim - number of components
criteria - (float) stopping criteria
outh - reference to external fmat to store H
outw - reference to external fmat to store W
messages: outh - reference to external fmat to store H
outw - reference to external fmat to store W
inlets: 0 - fmat to be decomposed
outlets: 0 - W
1 - H

mnm.qr '
arguments: none
attributes: outx - reference to external fmat to store X
outr - reference to external fmat to store R
outq - reference to external fmat to store Q
messages: outx - reference to external fmat to store X
outr - reference to external fmat to store R
outq - reference to external fmat to store Q
solve - solve system with QR decomposition
inlets: 0 - fmat to be decomposed
outlets: 0 - Q
1 - R
2 - X

mnm.stats '
arguments: output stats
attributes: norm - switch normalize
messages: set - set histogram vector (fmat)
clear - clear histogram
bang - output stats
norm - switch normalize
inlets: 0 - data input
outlets: 0 - average
1 - standard deviation
2 - count

mnm.submat '
arguments: none
attributes: out - reference to external fmat to store the sub-matrix
messages: out - reference to external fmat to store the sub-matrix
end - end of submatrix coordinates
begin - start of submatrix coordinates
inlets: 0 - fmat
outlets: 0 - sub-matrix

mnm.sum '
arguments: 0 - (1
attributes: type - (fmat) always output an fmat even for scalar results
mode - (row
messages: out - reference to external fmat to store the sum
inlets: 0 - incoming fmat
outlets: 0 - sum of fmat

mnm.svd '
arguments: 0 - number of singular values
attributes: mode - (auto
messages: outvt - reference to external fmat to store V'
outs - reference to external fmat to store S
outu - reference to external fmat to store U
inlets: 0 - fmat to be decomposed by SVD
outlets: 0 - U
1 - S
2 - V'

mnm.transpose '
arguments: none
attributes: out - reference to external fmat to store the transposition
messages: out - reference to external fmat to store the transposition
inlets: 0 - fmat to be transposed
outlets: 0 - transposed fmat

mnm.xdist2 '
arguments: 0 - fmat to be used as right operand
attributes: swap - (yes
messages: out - reference to external fmat to store the result
inlets: 0 - left operand
1 - right operand
outlets: 0 - resulting fmat

mnm.xmul '
arguments: 0 - fmat to be used as right operand
attributes: swap - (yes
messages: out - reference to an external fmat to store the result
inlets: 0 - left hand side fmat operand
1 - right hand side fmat operand
outlets: 0 - fmat result