.. _scil_tractogram_dps_math:

scil_tractogram_dps_math
========================

::

	usage: __main__.py [-h] [--out_tractogram OUT_TRACTOGRAM]
	                   [--in_dps_file IN_DPS_FILE | --in_dps_single_value IN_DPS_SINGLE_VALUE [IN_DPS_SINGLE_VALUE ...]]
	                   [--out_dps_file OUT_DPS_FILE]
	                   [-v [{DEBUG,INFO,WARNING,ERROR}]] [-f]
	                   in_tractogram OPERATION dps_key
	
	Import, extract or delete dps (data_per_streamline) information to a tractogram
	file. Can be for example SIFT2 weights, processing information, bundle IDs,
	tracking seeds, etc.
	
	This script is not the same as the dps mode of scil_tractogram_dpp_math,
	which performs operations on dpp (data_per_point) and saves the result as dps.
	Instead this script performs operations directly on dps values.
	
	Input and output tractograms must be .trk, unless you are using the 'import'
	operation, in which case a .tck input tractogram is accepted.
	
	Usage examples:
	    > scil_tractogram_dps_math tractogram.trk import "bundle_ids"
	        --in_dps_file my_bundle_ids.txt --out_tractogram tractogram_ids.trk
	    > scil_tractogram_dps_math tractogram.trk export "seeds"
	        --out_dps_file seeds.npy
	
	positional arguments:
	  in_tractogram         Input tractogram (.trk for all operations,.tck accepted for import).
	  OPERATION             The type of operation to be performed on the
	                        tractogram's data_per_streamline at the given
	                        key. Must be one of the following: [import, delete, export].
	                        The additional arguments required for each
	                        operation are specified under each group below.
	  dps_key               Key name used for the operation.
	
	options:
	  -h, --help            show this help message and exit
	  --out_tractogram OUT_TRACTOGRAM
	                        Output tractogram (.trk). Required for "import" and
	                        "delete" operations.
	  -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.
	
	Operation "import" mandatory options:
	  --in_dps_file IN_DPS_FILE
	                        File containing the data to import to
	                        streamlines (.txt, .npy or .mat). There
	                        must be the same amount of entries as
	                        there are streamlines.
	  --in_dps_single_value IN_DPS_SINGLE_VALUE [IN_DPS_SINGLE_VALUE ...]
	                        Single value to import to each
	                        streamline. If the value is an array,
	                        enter each component with a space in
	                        between.
	
	Operation "export" mandatory options:
	  --out_dps_file OUT_DPS_FILE
	                        File in which the extracted data will be
	                        saved (.txt or .npy).
	
	2.2.2