Parcourir la source

Mettre à jour 'README.md'

Matthieu PUIGT il y a 5 ans
Parent
commit
a0b30e8a33
1 fichiers modifiés avec 19 ajouts et 20 suppressions
  1. 19 20
      README.md

+ 19 - 20
README.md

@@ -16,33 +16,32 @@ Algorithme C-FICA - Convolutive extension of FastICA
  
 Inputs (place the deconvolution parameters before the recoloration ones themselves before iter_max) :
 
-*     x : observation vector
-*     non-lin : non-linearity, ’k’>kurtosis, ’g’>gaussian, ’t’>tanh (by default ’g’)
-*     init : ’i’ to initialize with unit filters (optional)
-*     epsi : stopping criterion (between 0 and 1) default 10^-12
-*     Re : order of the extraction filters (default 80)
-*     [we1,we2] : extraction time window (optional)
-*     Rc : order of the recoloration filters (default 3R1)
-*     [wc1,wc2] : recoloration time window (optional)
-*     itermax : maximum number of iterations (default 10000)
-*     verbose : ’v’ for verbose (optional)
-
+* x : observation vector
+* non-lin : non-linearity, ’k’>kurtosis, ’g’>gaussian, ’t’>tanh (by default ’g’)
+* init : ’i’ to initialize with unit filters (optional)
+* epsi : stopping criterion (between 0 and 1) default 10^-12
+* Re : order of the extraction filters (default 80)
+* [we1,we2] : extraction time window (optional)
+* Rc : order of the recoloration filters (default 3R1)
+* [wc1,wc2] : recoloration time window (optional)
+* itermax : maximum number of iterations (default 10000)
+* verbose : ’v’ for verbose (optional)
 
 Outputs :
 
-*     Sc : most powerful contributions for each estimated source
-*     sc : estimated source contributions (tensor N*N*nb_samples)
-*     Isc : indices of the most powerful contributions
-*     y : N-1 estimated innovation processes (matrix N*nb_samples)
-*     fe : extraction filters
-*     fc : recoloration filters
-*     te : times of extraction
-*     tc : times of recoloration
+* Sc : most powerful contributions for each estimated source
+* sc : estimated source contributions (tensor N*N*nb_samples)
+* Isc : indices of the most powerful contributions
+* y : N-1 estimated innovation processes (matrix N*nb_samples)
+* fe : extraction filters
+* fc : recoloration filters
+* te : times of extraction
+* tc : times of recoloration
 
 ```
 
 # About this version
-The original C-FICA code was written by J. Thomas and was providing an error message because of some change in the way to process tensors in recent Matlab releases. The current version is maintained by Matthieu PUIGT (Matthieu [dot] Puigt [at] univ-littoral [dot] fr) and Yannick DEVILLE (Yannick [dot] Deville [at] irap [dot] omp [dot] eu).
+The original C-FICA code was written by J. Thomas. Unfortunately, it was providing an error message because of some changes in the way to process tensors in recent Matlab releases. The current version corrects this bug and is maintained by Matthieu PUIGT (Matthieu [dot] Puigt [at] univ-littoral [dot] fr) and Yannick DEVILLE (Yannick [dot] Deville [at] irap [dot] omp [dot] eu).
 
 Please acknowledge the use of this software in any publication: "The C-FICA software is available at https://gogs.univ-littoral.fr/puigt/" and cite the reference :
 > J. Thomas, Y. Deville, S. Hosseini, Time-domain fast fixed-point algorithms for convolutive ICA, IEEE Signal Processing Letters, vol. 13, no. 4, pp. 228-231, April 2006.