.\" Text automatically generated by txt2man
.TH mlpack_radical 1 "12 December 2020" "mlpack-3.4.2" "User Commands"
.SH NAME
\fBmlpack_radical \fP- radical
.SH SYNOPSIS
.nf
.fam C
 \fBmlpack_radical\fP \fB-i\fP \fIstring\fP [\fB-a\fP \fIint\fP] [\fB-n\fP \fIdouble\fP] [\fB-O\fP \fIbool\fP] [\fB-r\fP \fIint\fP] [\fB-s\fP \fIint\fP] [\fB-S\fP \fIint\fP] [\fB-V\fP \fIbool\fP] [\fB-o\fP \fIstring\fP] [\fB-u\fP \fIstring\fP] [\fB-h\fP \fB-v\fP] 
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION


An implementation of RADICAL, a method for independent component analysis
(ICA). Assuming that we have an input matrix X, the goal is to find a square
unmixing matrix W such that Y = W * X and the dimensions of Y are independent
components. If the algorithm is running particularly slowly, try reducing the
number of replicates.
.PP
The input matrix to perform ICA on should be specified with the '\fB--input_file\fP
(\fB-i\fP)' parameter. The output matrix Y may be saved with the '\fB--output_ic_file\fP
(\fB-o\fP)' output parameter, and the output unmixing matrix W may be saved with the
\(cq\fB--output_unmixing_file\fP (\fB-u\fP)' output parameter.
.PP
For example, to perform ICA on the matrix 'X.csv' with 40 replicates, saving
the independent components to 'ic.csv', the following command may be used: 
.PP
$ \fBmlpack_radical\fP \fB--input_file\fP X.csv \fB--replicates\fP 40 \fB--output_ic_file\fP ic.csv
.RE
.PP

.SH REQUIRED INPUT OPTIONS 

.TP
.B
\fB--input_file\fP (\fB-i\fP) [\fIstring\fP]
Input dataset for ICA.  
.SH OPTIONAL INPUT OPTIONS 

.TP
.B
\fB--angles\fP (\fB-a\fP) [\fIint\fP]
Number of angles to consider in brute-force search during Radical2D. Default value 150. 
.TP
.B
\fB--help\fP (\fB-h\fP) [\fIbool\fP]
Default help info. 
.TP
.B
\fB--info\fP [\fIstring\fP]
Print help on a specific option. Default value ''. 
.TP
.B
\fB--noise_std_dev\fP (\fB-n\fP) [\fIdouble\fP]
Standard deviation of Gaussian noise. Default value 0.175. 
.TP
.B
\fB--objective\fP (\fB-O\fP) [\fIbool\fP]
If set, an estimate of the final objective function is printed. 
.TP
.B
\fB--replicates\fP (\fB-r\fP) [\fIint\fP]
Number of Gaussian-perturbed replicates to use (per point) in Radical2D. Default value 30. 
.TP
.B
\fB--seed\fP (\fB-s\fP) [\fIint\fP]
Random seed. If 0, 'std::time(NULL)' is used.  Default value 0. 
.TP
.B
\fB--sweeps\fP (\fB-S\fP) [\fIint\fP]
Number of sweeps; each sweep calls Radical2D once for each pair of dimensions. Default value 0. 
.TP
.B
\fB--verbose\fP (\fB-v\fP) [\fIbool\fP]
Display informational messages and the full list of parameters and timers at the end of execution. 
.TP
.B
\fB--version\fP (\fB-V\fP) [\fIbool\fP]
Display the version of mlpack.  
.SH OPTIONAL OUTPUT OPTIONS 

.TP
.B
\fB--output_ic_file\fP (\fB-o\fP) [\fIstring\fP]
Matrix to save independent components to. 
.TP
.B
\fB--output_unmixing_file\fP (\fB-u\fP) [\fIstring\fP]
Matrix to save unmixing matrix to.
.SH ADDITIONAL INFORMATION

For further information, including relevant papers, citations, and theory,
consult the documentation found at http://www.mlpack.org or included with your
distribution of mlpack.