.. AUTO-GENERATED FILE -- DO NOT EDIT!

nipype.interfaces.cmtk.convert
==============================


:class:`CFFConverter`
---------------------


Creates a Connectome File Format (CFF) file from input networks, surfaces, volumes, tracts, etcetera....

Example
~~~~~~~

>>> from nipype.interfaces.cmtk.convert import CFFConverter
>>> cvt = CFFConverter()
>>> cvt.inputs.title = 'subject 1'
>>> cvt.inputs.gifti_surfaces = ['lh.pial_converted.gii', 'rh.pial_converted.gii']
>>> cvt.inputs.tract_files = ['streamlines.trk']
>>> cvt.inputs.gpickled_networks = ['network0.gpickle']
>>> cvt.run()                 # doctest: +SKIP

Inputs:: 

	[Optional]
	creator : (a string)
		Creator
	data_files : (an existing file name)
		list of external data files (i.e. Numpy, HD5, XML) 
	description : (a string)
		Description
	email : (a string)
		Email address
	gifti_labels : (an existing file name)
		list of GIFTI surfaces
	gifti_surfaces : (an existing file name)
		list of GIFTI surfaces
	gpickled_networks : (an existing file name)
		list of gpickled Networkx graphs
	graphml_networks : (an existing file name)
		list of graphML networks
	ignore_exception : (a boolean)
		Print an error message instead of throwing an exception in case the interface fails to run
	license : (a string)
		License
	nifti_volumes : (an existing file name)
		list of NIFTI volumes
	out_file : (a file name)
		Unknown
	publisher : (a string)
		Publisher
	references : (a string)
		References
	relation : (a string)
		Relation
	rights : (a string)
		Rights
	script_files : (an existing file name)
		list of script files to include
	species : (a string)
		Species
	timeseries_files : (an existing file name)
		list of HDF5 timeseries files
	title : (a string)
		Connectome Title
	tract_files : (an existing file name)
		list of Trackvis fiber files


Outputs:: 

	connectome_file : (a file name)
		Unknown

:class:`MergeCNetworks`
-----------------------


Merges networks from multiple CFF files into one new CFF file.

Example
~~~~~~~

>>> import nipype.interfaces.cmtk.base as ba                  # doctest: +SKIP
>>> mrg = ba.MergeCNetworks()                  # doctest: +SKIP
>>> mrg.inputs.in_files = ['subj1.cff','subj2.cff']                  # doctest: +SKIP
>>> mrg.run()                  # doctest: +SKIP

Inputs:: 

	[Mandatory]
	in_files : (a file name)
		List of CFF files to extract networks from

	[Optional]
	ignore_exception : (a boolean)
		Print an error message instead of throwing an exception in case the interface fails to run
	out_file : (a file name)
		Unknown


Outputs:: 

	connectome_file : (a file name)
		Single CFF file with all the networks added
