.\" Text automatically generated by txt2man
.TH mlpack_image_converter 1 "11 January 2024" "mlpack-4.3.0" "User Commands"
.SH NAME
\fBmlpack_image_converter \fP- image converter
.SH SYNOPSIS
.nf
.fam C
 \fBmlpack_image_converter\fP \fB-i\fP \fIvector\fP [\fB-c\fP \fIint\fP] [\fB-I\fP \fIunknown\fP] [\fB-H\fP \fIint\fP] [\fB-q\fP \fIint\fP] [\fB-s\fP \fIbool\fP] [\fB-V\fP \fIbool\fP] [\fB-w\fP \fIint\fP] [\fB-o\fP \fIunknown\fP] [\fB-h\fP \fB-v\fP] 
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION


This utility takes an image or an array of images and loads them to a matrix.
You can optionally specify the height '\fB--height\fP (\fB-H\fP)' width '\fB--width\fP (\fB-w\fP)' and
channel '\fB--channels\fP (\fB-c\fP)' of the images that needs to be loaded; otherwise,
these parameters will be automatically detected from the image.
There are other options too, that can be specified such as '\fB--quality\fP (\fB-q\fP)'.
.PP
You can also provide a dataset and save them as images using '\fB--dataset_file\fP
(\fB-I\fP)' and '\fB--save\fP (\fB-s\fP)' as an parameter.
.PP
.nf
.fam C
  An example to load an image : 

.fam T
.fi
$ \fBmlpack_image_converter\fP \fB--input\fP X \fB--height\fP 256 \fB--width\fP 256 \fB--channels\fP 3
\fB--output_file\fP Y.csv
.RS
.PP
An example to save an image is :
.RE
.PP
$ \fBmlpack_image_converter\fP \fB--input\fP X \fB--height\fP 256 \fB--width\fP 256 \fB--channels\fP 3
\fB--dataset_file\fP Y.csv \fB--save\fP
.RE
.PP

.SH REQUIRED INPUT OPTIONS 

.TP
.B
\fB--input\fP (\fB-i\fP) [\fIvector\fP]
Image filenames which have to be loaded/saved.  
.SH OPTIONAL INPUT OPTIONS 

.TP
.B
\fB--channels\fP (\fB-c\fP) [\fIint\fP]
Number of channels in the image. Default value 0. 
.TP
.B
\fB--dataset_file\fP (\fB-I\fP) [\fIunknown\fP]
Input matrix to save as images. 
.TP
.B
\fB--height\fP (\fB-H\fP) [\fIint\fP]
Height of the images. Default value 0. 
.TP
.B
\fB--help\fP (\fB-h\fP) [\fIbool\fP]
Default help info. 
.TP
.B
\fB--info\fP [string]
Print help on a specific option. Default value ''. 
.TP
.B
\fB--quality\fP (\fB-q\fP) [\fIint\fP]
Compression of the image if saved as jpg (0-100). Default value 90. 
.TP
.B
\fB--save\fP (\fB-s\fP) [\fIbool\fP]
Save a dataset as images. 
.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. 
.TP
.B
\fB--width\fP (\fB-w\fP) [\fIint\fP]
Width of the image. Default value 0.  
.SH OPTIONAL OUTPUT OPTIONS 

\fB--output_file\fP (\fB-o\fP) [\fIunknown\fP] Matrix to save images data to, Onlyneeded if you are specifying 'save' option.
.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.