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

:orphan:

.. currentmodule:: morphologist.capsul.axon.sulcilabelling


.. _morphologist.capsul.axon.sulcilabelling.SulciLabelling:

morphologist.capsul.axon.sulcilabelling.SulciLabelling
======================================================

SulciLabelling
--------------




.. note::

    * Type 'SulciLabelling.help()' for a full description of this process parameters.
    * Type '<SulciLabelling>.get_input_spec()' for a full description of this process input trait types.
    * Type '<SulciLabelling>.get_output_spec()' for a full description of this process output trait types.


.. _morphologist.capsul.axon.sulcilabelling.SulciLabelling_inputs:


Inputs
~~~~~~

[Mandatory]

**nodes_activation**: a legal value (['ControllerTrait'] - mandatory)
    No description.
**select_Sulci_Recognition**: a legal value (['Enum'] - mandatory)
    No description.
**data_graph**: a string or os.PathLike object (['File'] - mandatory)
    No description.
**fix_random_seed**: a boolean (['Bool'] - mandatory)
    No description.

[Optional]

**recognition2000_model**: a string or os.PathLike object (['File'] - optional)
    No description.
**recognition2000_model_hint**: a legal value (['Enum'] - optional)
    No description.
**recognition2000_rate**: a float (['Float'] - optional)
    No description.
**recognition2000_stopRate**: a float (['Float'] - optional)
    No description.
**recognition2000_niterBelowStopProp**: an integer (['Int'] - optional)
    No description.
**recognition2000_forbid_unknown_label**: a boolean (['Bool'] - optional)
    No description.
**SPAM_recognition09_local_or_markovian**: a legal value (['Enum'] - optional)
    No description.
**SPAM_recognition09_global_recognition_labels_translation_map**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_global_recognition_initial_transformation**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_global_recognition_labels_priors**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_global_recognition_model_type**: a legal value (['Enum'] - optional)
    No description.
**SPAM_recognition09_global_recognition_model**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_local_recognition_model**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_local_recognition_local_referentials**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_local_recognition_direction_priors**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_local_recognition_angle_priors**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_local_recognition_translation_priors**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_markovian_recognition_model**: a string or os.PathLike object (['File'] - optional)
    No description.
**SPAM_recognition09_markovian_recognition_segments_relations_model**: a string or os.PathLike object (['File'] - optional)
    No description.
**CNN_recognition19_roots**: a string or os.PathLike object (['File'] - optional)
    root file corresponding to the input graph
**CNN_recognition19_model_file**: a string or os.PathLike object (['File'] - optional)
    file (.mdsm) storing neural network parameters
**CNN_recognition19_param_file**: a string or os.PathLike object (['File'] - optional)
    file (.json) storing the hyperparameters (cutting threshold)
**CNN_recognition19_rebuild_attributes**: a boolean (['Bool'] - optional)
    No description.
**CNN_recognition19_skeleton**: a string or os.PathLike object (['File'] - optional)
    skeleton file corresponding to the input graph
**CNN_recognition19_allow_multithreading**: a boolean (['Bool'] - optional)
    No description.
**CNN_recognition19_cuda**: an integer (['Int'] - optional)
    device on which to run the training(-1 for cpu, i>=0 for the i-th gpu)

.. _morphologist.capsul.axon.sulcilabelling.SulciLabelling_outputs:


Outputs
~~~~~~~

**output_graph**: a string or os.PathLike object (['File (filename: input)'] - mandatory)
    No description.
**recognition2000_energy_plot_file**: a string or os.PathLike object (['File (filename: input)'] - optional)
    No description.
**SPAM_recognition09_global_recognition_posterior_probabilities**: a string or os.PathLike object (['File (filename: input)'] - optional)
    No description.
**SPAM_recognition09_global_recognition_output_transformation**: a string or os.PathLike object (['File (filename: input)'] - optional)
    No description.
**SPAM_recognition09_global_recognition_output_t1_to_global_transformation**: a string or os.PathLike object (['File (filename: input)'] - optional)
    No description.
**SPAM_recognition09_local_recognition_posterior_probabilities**: a string or os.PathLike object (['File (filename: input)'] - optional)
    No description.
**SPAM_recognition09_local_recognition_output_local_transformations**: a string or os.PathLike object (['Directory (filename: input)'] - optional)
    No description.
**SPAM_recognition09_markovian_recognition_posterior_probabilities**: a string or os.PathLike object (['File (filename: input)'] - optional)
    No description.

Pipeline schema
~~~~~~~~~~~~~~~

.. image:: ../schema/morphologist.capsul.axon.sulcilabelling.SulciLabelling.png
    :height: 400px
    :align: center