# This file was auto generated by Styx.
# Do not edit this file directly.

import typing
import pathlib
from styxdefs import *

FIXEL2TSF_METADATA = Metadata(
    id="633221e2ad511634bae92b1740122dc5ec9d02cb.boutiques",
    name="fixel2tsf",
    package="mrtrix",
    container_image_tag="mrtrix3/mrtrix3:3.0.4",
)


_Fixel2tsfConfigParamsDictNoTag = typing.TypedDict('_Fixel2tsfConfigParamsDictNoTag', {
    "key": str,
    "value": str,
})
Fixel2tsfConfigParamsDictTagged = typing.TypedDict('Fixel2tsfConfigParamsDictTagged', {
    "@type": typing.Literal["config"],
    "key": str,
    "value": str,
})
Fixel2tsfConfigParamsDict = _Fixel2tsfConfigParamsDictNoTag | Fixel2tsfConfigParamsDictTagged


_Fixel2tsfParamsDictNoTag = typing.TypedDict('_Fixel2tsfParamsDictNoTag', {
    "angle": typing.NotRequired[float | None],
    "info": bool,
    "quiet": bool,
    "debug": bool,
    "force": bool,
    "nthreads": typing.NotRequired[int | None],
    "config": typing.NotRequired[list[Fixel2tsfConfigParamsDict] | None],
    "help": bool,
    "version": bool,
    "fixel_in": InputPathType,
    "tracks": InputPathType,
    "tsf": str,
})
Fixel2tsfParamsDictTagged = typing.TypedDict('Fixel2tsfParamsDictTagged', {
    "@type": typing.Literal["mrtrix/fixel2tsf"],
    "angle": typing.NotRequired[float | None],
    "info": bool,
    "quiet": bool,
    "debug": bool,
    "force": bool,
    "nthreads": typing.NotRequired[int | None],
    "config": typing.NotRequired[list[Fixel2tsfConfigParamsDict] | None],
    "help": bool,
    "version": bool,
    "fixel_in": InputPathType,
    "tracks": InputPathType,
    "tsf": str,
})
Fixel2tsfParamsDict = _Fixel2tsfParamsDictNoTag | Fixel2tsfParamsDictTagged


def fixel2tsf_config(
    key: str,
    value: str,
) -> Fixel2tsfConfigParamsDictTagged:
    """
    Build parameters.
    
    Args:
        key: temporarily set the value of an MRtrix config file entry.
        value: temporarily set the value of an MRtrix config file entry.
    Returns:
        Parameter dictionary
    """
    params = {
        "@type": "config",
        "key": key,
        "value": value,
    }
    return params


def fixel2tsf_config_validate(
    params: typing.Any,
) -> None:
    """
    Validate parameters. Throws an error if `params` is not a valid
    `Fixel2tsfConfigParamsDict` object.
    
    Args:
        params: The parameters object to validate.
    """
    if params is None or not isinstance(params, dict):
        raise StyxValidationError(f'Params object has the wrong type \'{type(params)}\'')
    if params.get("key", None) is None:
        raise StyxValidationError("`key` must not be None")
    if not isinstance(params["key"], str):
        raise StyxValidationError(f'`key` has the wrong type: Received `{type(params.get("key", None))}` expected `str`')
    if params.get("value", None) is None:
        raise StyxValidationError("`value` must not be None")
    if not isinstance(params["value"], str):
        raise StyxValidationError(f'`value` has the wrong type: Received `{type(params.get("value", None))}` expected `str`')


def fixel2tsf_config_cargs(
    params: Fixel2tsfConfigParamsDict,
    execution: Execution,
) -> list[str]:
    """
    Build command-line arguments from parameters.
    
    Args:
        params: The parameters.
        execution: The execution object for resolving input paths.
    Returns:
        Command-line arguments.
    """
    cargs = []
    cargs.append("-config")
    cargs.append(params.get("key", None))
    cargs.append(params.get("value", None))
    return cargs


class Fixel2tsfOutputs(typing.NamedTuple):
    """
    Output object returned when calling `Fixel2tsfParamsDict(...)`.
    """
    root: OutputPathType
    """Output root folder. This is the root folder for all outputs."""
    tsf: OutputPathType
    """the output track scalar file"""


def fixel2tsf_params(
    fixel_in: InputPathType,
    tracks: InputPathType,
    tsf: str,
    angle: float | None = None,
    info: bool = False,
    quiet: bool = False,
    debug: bool = False,
    force: bool = False,
    nthreads: int | None = None,
    config: list[Fixel2tsfConfigParamsDict] | None = None,
    help_: bool = False,
    version: bool = False,
) -> Fixel2tsfParamsDictTagged:
    """
    Build parameters.
    
    Args:
        fixel_in: the input fixel data file (within the fixel directory).
        tracks: the input track file.
        tsf: the output track scalar file.
        angle: the max anglular threshold for computing correspondence between\
            a fixel direction and track tangent (default = 45 degrees).
        info: display information messages.
        quiet: do not display information messages or progress status;\
            alternatively, this can be achieved by setting the MRTRIX_QUIET\
            environment variable to a non-empty string.
        debug: display debugging messages.
        force: force overwrite of output files (caution: using the same file as\
            input and output might cause unexpected behaviour).
        nthreads: use this number of threads in multi-threaded applications\
            (set to 0 to disable multi-threading).
        config: temporarily set the value of an MRtrix config file entry.
        help_: display this information page and exit.
        version: display version information and exit.
    Returns:
        Parameter dictionary
    """
    params = {
        "@type": "mrtrix/fixel2tsf",
        "info": info,
        "quiet": quiet,
        "debug": debug,
        "force": force,
        "help": help_,
        "version": version,
        "fixel_in": fixel_in,
        "tracks": tracks,
        "tsf": tsf,
    }
    if angle is not None:
        params["angle"] = angle
    if nthreads is not None:
        params["nthreads"] = nthreads
    if config is not None:
        params["config"] = config
    return params


def fixel2tsf_validate(
    params: typing.Any,
) -> None:
    """
    Validate parameters. Throws an error if `params` is not a valid
    `Fixel2tsfParamsDict` object.
    
    Args:
        params: The parameters object to validate.
    """
    if params is None or not isinstance(params, dict):
        raise StyxValidationError(f'Params object has the wrong type \'{type(params)}\'')
    if params.get("angle", None) is not None:
        if not isinstance(params["angle"], (float, int)):
            raise StyxValidationError(f'`angle` has the wrong type: Received `{type(params.get("angle", None))}` expected `float | None`')
    if params.get("info", False) is None:
        raise StyxValidationError("`info` must not be None")
    if not isinstance(params["info"], bool):
        raise StyxValidationError(f'`info` has the wrong type: Received `{type(params.get("info", False))}` expected `bool`')
    if params.get("quiet", False) is None:
        raise StyxValidationError("`quiet` must not be None")
    if not isinstance(params["quiet"], bool):
        raise StyxValidationError(f'`quiet` has the wrong type: Received `{type(params.get("quiet", False))}` expected `bool`')
    if params.get("debug", False) is None:
        raise StyxValidationError("`debug` must not be None")
    if not isinstance(params["debug"], bool):
        raise StyxValidationError(f'`debug` has the wrong type: Received `{type(params.get("debug", False))}` expected `bool`')
    if params.get("force", False) is None:
        raise StyxValidationError("`force` must not be None")
    if not isinstance(params["force"], bool):
        raise StyxValidationError(f'`force` has the wrong type: Received `{type(params.get("force", False))}` expected `bool`')
    if params.get("nthreads", None) is not None:
        if not isinstance(params["nthreads"], int):
            raise StyxValidationError(f'`nthreads` has the wrong type: Received `{type(params.get("nthreads", None))}` expected `int | None`')
    if params.get("config", None) is not None:
        if not isinstance(params["config"], list):
            raise StyxValidationError(f'`config` has the wrong type: Received `{type(params.get("config", None))}` expected `list[Fixel2tsfConfigParamsDict] | None`')
        for e in params["config"]:
            fixel2tsf_config_validate(e)
    if params.get("help", False) is None:
        raise StyxValidationError("`help` must not be None")
    if not isinstance(params["help"], bool):
        raise StyxValidationError(f'`help` has the wrong type: Received `{type(params.get("help", False))}` expected `bool`')
    if params.get("version", False) is None:
        raise StyxValidationError("`version` must not be None")
    if not isinstance(params["version"], bool):
        raise StyxValidationError(f'`version` has the wrong type: Received `{type(params.get("version", False))}` expected `bool`')
    if params.get("fixel_in", None) is None:
        raise StyxValidationError("`fixel_in` must not be None")
    if not isinstance(params["fixel_in"], (pathlib.Path, str)):
        raise StyxValidationError(f'`fixel_in` has the wrong type: Received `{type(params.get("fixel_in", None))}` expected `InputPathType`')
    if params.get("tracks", None) is None:
        raise StyxValidationError("`tracks` must not be None")
    if not isinstance(params["tracks"], (pathlib.Path, str)):
        raise StyxValidationError(f'`tracks` has the wrong type: Received `{type(params.get("tracks", None))}` expected `InputPathType`')
    if params.get("tsf", None) is None:
        raise StyxValidationError("`tsf` must not be None")
    if not isinstance(params["tsf"], str):
        raise StyxValidationError(f'`tsf` has the wrong type: Received `{type(params.get("tsf", None))}` expected `str`')


def fixel2tsf_cargs(
    params: Fixel2tsfParamsDict,
    execution: Execution,
) -> list[str]:
    """
    Build command-line arguments from parameters.
    
    Args:
        params: The parameters.
        execution: The execution object for resolving input paths.
    Returns:
        Command-line arguments.
    """
    cargs = []
    cargs.append("fixel2tsf")
    if params.get("angle", None) is not None:
        cargs.extend([
            "-angle",
            str(params.get("angle", None))
        ])
    if params.get("info", False):
        cargs.append("-info")
    if params.get("quiet", False):
        cargs.append("-quiet")
    if params.get("debug", False):
        cargs.append("-debug")
    if params.get("force", False):
        cargs.append("-force")
    if params.get("nthreads", None) is not None:
        cargs.extend([
            "-nthreads",
            str(params.get("nthreads", None))
        ])
    if params.get("config", None) is not None:
        cargs.extend([a for c in [fixel2tsf_config_cargs(s, execution) for s in params.get("config", None)] for a in c])
    if params.get("help", False):
        cargs.append("-help")
    if params.get("version", False):
        cargs.append("-version")
    cargs.append(execution.input_file(params.get("fixel_in", None)))
    cargs.append(execution.input_file(params.get("tracks", None)))
    cargs.append(params.get("tsf", None))
    return cargs


def fixel2tsf_outputs(
    params: Fixel2tsfParamsDict,
    execution: Execution,
) -> Fixel2tsfOutputs:
    """
    Build outputs object containing output file paths and possibly stdout/stderr.
    
    Args:
        params: The parameters.
        execution: The execution object for resolving input paths.
    Returns:
        Outputs object.
    """
    ret = Fixel2tsfOutputs(
        root=execution.output_file("."),
        tsf=execution.output_file(params.get("tsf", None)),
    )
    return ret


def fixel2tsf_execute(
    params: Fixel2tsfParamsDict,
    runner: Runner | None = None,
) -> Fixel2tsfOutputs:
    """
    fixel2tsf
    
    Map fixel values to a track scalar file based on an input tractogram.
    
    This command is useful for visualising all brain fixels (e.g. the output
    from fixelcfestats) in 3D.
    
    References:
    
    .
    
    Author: MRTrix3 Developers
    
    URL: https://www.mrtrix.org/
    
    Args:
        params: The parameters.
        runner: Command runner.
    Returns:
        NamedTuple of outputs (described in `Fixel2tsfOutputs`).
    """
    fixel2tsf_validate(params)
    runner = runner or get_global_runner()
    execution = runner.start_execution(FIXEL2TSF_METADATA)
    params = execution.params(params)
    cargs = fixel2tsf_cargs(params, execution)
    ret = fixel2tsf_outputs(params, execution)
    execution.run(cargs)
    return ret


def fixel2tsf(
    fixel_in: InputPathType,
    tracks: InputPathType,
    tsf: str,
    angle: float | None = None,
    info: bool = False,
    quiet: bool = False,
    debug: bool = False,
    force: bool = False,
    nthreads: int | None = None,
    config: list[Fixel2tsfConfigParamsDict] | None = None,
    help_: bool = False,
    version: bool = False,
    runner: Runner | None = None,
) -> Fixel2tsfOutputs:
    """
    fixel2tsf
    
    Map fixel values to a track scalar file based on an input tractogram.
    
    This command is useful for visualising all brain fixels (e.g. the output
    from fixelcfestats) in 3D.
    
    References:
    
    .
    
    Author: MRTrix3 Developers
    
    URL: https://www.mrtrix.org/
    
    Args:
        fixel_in: the input fixel data file (within the fixel directory).
        tracks: the input track file.
        tsf: the output track scalar file.
        angle: the max anglular threshold for computing correspondence between\
            a fixel direction and track tangent (default = 45 degrees).
        info: display information messages.
        quiet: do not display information messages or progress status;\
            alternatively, this can be achieved by setting the MRTRIX_QUIET\
            environment variable to a non-empty string.
        debug: display debugging messages.
        force: force overwrite of output files (caution: using the same file as\
            input and output might cause unexpected behaviour).
        nthreads: use this number of threads in multi-threaded applications\
            (set to 0 to disable multi-threading).
        config: temporarily set the value of an MRtrix config file entry.
        help_: display this information page and exit.
        version: display version information and exit.
        runner: Command runner.
    Returns:
        NamedTuple of outputs (described in `Fixel2tsfOutputs`).
    """
    params = fixel2tsf_params(
        angle=angle,
        info=info,
        quiet=quiet,
        debug=debug,
        force=force,
        nthreads=nthreads,
        config=config,
        help_=help_,
        version=version,
        fixel_in=fixel_in,
        tracks=tracks,
        tsf=tsf,
    )
    return fixel2tsf_execute(params, runner)


__all__ = [
    "FIXEL2TSF_METADATA",
    "Fixel2tsfConfigParamsDict",
    "Fixel2tsfConfigParamsDictTagged",
    "Fixel2tsfOutputs",
    "Fixel2tsfParamsDict",
    "Fixel2tsfParamsDictTagged",
    "fixel2tsf",
    "fixel2tsf_config",
    "fixel2tsf_execute",
    "fixel2tsf_params",
]
