.. _scil_volume_count_non_zero_voxels:

scil_volume_count_non_zero_voxels
=================================

::

	usage: __main__.py [-h] [--out OUT_FILE] [--stats] [--id VALUE_ID]
	                   [-v [{DEBUG,INFO,WARNING,ERROR}]] [-f]
	                   IN_FILE
	
	Count the number of non-zero voxels in an image file.
	
	If you give it an image with more than 3 dimensions, it will summarize the 4th
	(or more) dimension to one voxel, and then find non-zero voxels over this.
	This means that if there is at least one non-zero voxel in the 4th dimension,
	this voxel of the 3D volume will be considered as non-zero.
	
	positional arguments:
	  IN_FILE               Input file name, in nifti format.
	
	options:
	  -h, --help            show this help message and exit
	  --out OUT_FILE        Name of the output file, which will be saved as a text file.
	  --stats               If set, output the value using a stats format. Using this synthax will append
	                        a line to the output file, instead of creating a file with only one line.
	                        This is useful to create a file to be used as the source of data for a graph.
	                        Can be combined with --id
	  --id VALUE_ID         Id of the current count. If used, the value of this argument will be
	                        output (followed by a ":") before the count value.
	                        Mostly useful with --stats.
	  -v [{DEBUG,INFO,WARNING,ERROR}]
	                        Produces verbose output depending on the provided level. 
	                        Default level is warning, default when using -v is info.
	  -f                    Force overwriting of the output files.
	
	2.2.2