niwrap-mrtrix 0.8.0__py3-none-any.whl

niwrap_mrtrix/mrtrix/fixel2sh.py

@@ -0,0 +1,430 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+FIXEL2SH_METADATA = Metadata(
+    id="8c1f4206ebf1611310a84b3b1b1527e0a6b154c6.boutiques",
+    name="fixel2sh",
+    package="mrtrix",
+    container_image_tag="mrtrix3/mrtrix3:3.0.4",
+)
+
+
+_Fixel2shConfigParamsDictNoTag = typing.TypedDict('_Fixel2shConfigParamsDictNoTag', {
+    "key": str,
+    "value": str,
+})
+Fixel2shConfigParamsDictTagged = typing.TypedDict('Fixel2shConfigParamsDictTagged', {
+    "@type": typing.Literal["config"],
+    "key": str,
+    "value": str,
+})
+Fixel2shConfigParamsDict = _Fixel2shConfigParamsDictNoTag | Fixel2shConfigParamsDictTagged
+
+
+_Fixel2shParamsDictNoTag = typing.TypedDict('_Fixel2shParamsDictNoTag', {
+    "lmax": typing.NotRequired[int | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[Fixel2shConfigParamsDict] | None],
+    "help": bool,
+    "version": bool,
+    "fixel_in": InputPathType,
+    "sh_out": str,
+})
+Fixel2shParamsDictTagged = typing.TypedDict('Fixel2shParamsDictTagged', {
+    "@type": typing.Literal["mrtrix/fixel2sh"],
+    "lmax": typing.NotRequired[int | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[Fixel2shConfigParamsDict] | None],
+    "help": bool,
+    "version": bool,
+    "fixel_in": InputPathType,
+    "sh_out": str,
+})
+Fixel2shParamsDict = _Fixel2shParamsDictNoTag | Fixel2shParamsDictTagged
+
+
+def fixel2sh_config(
+    key: str,
+    value: str,
+) -> Fixel2shConfigParamsDictTagged:
+    """
+    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 fixel2sh_config_validate(
+    params: typing.Any,
+) -> None:
+    """
+    Validate parameters. Throws an error if `params` is not a valid
+    `Fixel2shConfigParamsDict` 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 fixel2sh_config_cargs(
+    params: Fixel2shConfigParamsDict,
+    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 Fixel2shOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `Fixel2shParamsDict(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    sh_out: OutputPathType
+    """the output sh image."""
+
+
+def fixel2sh_params(
+    fixel_in: InputPathType,
+    sh_out: str,
+    lmax: int | None = None,
+    info: bool = False,
+    quiet: bool = False,
+    debug: bool = False,
+    force: bool = False,
+    nthreads: int | None = None,
+    config: list[Fixel2shConfigParamsDict] | None = None,
+    help_: bool = False,
+    version: bool = False,
+) -> Fixel2shParamsDictTagged:
+    """
+    Build parameters.
+    
+    Args:
+        fixel_in: the input fixel data file.
+        sh_out: the output sh image.
+        lmax: set the maximum harmonic order for the output series (Default: 8).
+        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/fixel2sh",
+        "info": info,
+        "quiet": quiet,
+        "debug": debug,
+        "force": force,
+        "help": help_,
+        "version": version,
+        "fixel_in": fixel_in,
+        "sh_out": sh_out,
+    }
+    if lmax is not None:
+        params["lmax"] = lmax
+    if nthreads is not None:
+        params["nthreads"] = nthreads
+    if config is not None:
+        params["config"] = config
+    return params
+
+
+def fixel2sh_validate(
+    params: typing.Any,
+) -> None:
+    """
+    Validate parameters. Throws an error if `params` is not a valid
+    `Fixel2shParamsDict` 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("lmax", None) is not None:
+        if not isinstance(params["lmax"], int):
+            raise StyxValidationError(f'`lmax` has the wrong type: Received `{type(params.get("lmax", None))}` expected `int | 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[Fixel2shConfigParamsDict] | None`')
+        for e in params["config"]:
+            fixel2sh_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("sh_out", None) is None:
+        raise StyxValidationError("`sh_out` must not be None")
+    if not isinstance(params["sh_out"], str):
+        raise StyxValidationError(f'`sh_out` has the wrong type: Received `{type(params.get("sh_out", None))}` expected `str`')
+
+
+def fixel2sh_cargs(
+    params: Fixel2shParamsDict,
+    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("fixel2sh")
+    if params.get("lmax", None) is not None:
+        cargs.extend([
+            "-lmax",
+            str(params.get("lmax", 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 [fixel2sh_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(params.get("sh_out", None))
+    return cargs
+
+
+def fixel2sh_outputs(
+    params: Fixel2shParamsDict,
+    execution: Execution,
+) -> Fixel2shOutputs:
+    """
+    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 = Fixel2shOutputs(
+        root=execution.output_file("."),
+        sh_out=execution.output_file(params.get("sh_out", None)),
+    )
+    return ret
+
+
+def fixel2sh_execute(
+    params: Fixel2shParamsDict,
+    runner: Runner | None = None,
+) -> Fixel2shOutputs:
+    """
+    fixel2sh
+    
+    Convert a fixel-based sparse-data image into an spherical harmonic image.
+    
+    This command generates spherical harmonic data from fixels that can be
+    visualised using the ODF tool in MRview. The output ODF lobes are scaled
+    according to the values in the input fixel image.
+    
+    The spherical harmonic coefficients are stored according the conventions
+    described the main documentation, which can be found at the following link:
+    https://mrtrix.readthedocs.io/en/3.0.4/concepts/spherical_harmonics.html
+    
+    References:
+    
+    .
+    
+    Author: MRTrix3 Developers
+    
+    URL: https://www.mrtrix.org/
+    
+    Args:
+        params: The parameters.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `Fixel2shOutputs`).
+    """
+    fixel2sh_validate(params)
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(FIXEL2SH_METADATA)
+    params = execution.params(params)
+    cargs = fixel2sh_cargs(params, execution)
+    ret = fixel2sh_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def fixel2sh(
+    fixel_in: InputPathType,
+    sh_out: str,
+    lmax: int | None = None,
+    info: bool = False,
+    quiet: bool = False,
+    debug: bool = False,
+    force: bool = False,
+    nthreads: int | None = None,
+    config: list[Fixel2shConfigParamsDict] | None = None,
+    help_: bool = False,
+    version: bool = False,
+    runner: Runner | None = None,
+) -> Fixel2shOutputs:
+    """
+    fixel2sh
+    
+    Convert a fixel-based sparse-data image into an spherical harmonic image.
+    
+    This command generates spherical harmonic data from fixels that can be
+    visualised using the ODF tool in MRview. The output ODF lobes are scaled
+    according to the values in the input fixel image.
+    
+    The spherical harmonic coefficients are stored according the conventions
+    described the main documentation, which can be found at the following link:
+    https://mrtrix.readthedocs.io/en/3.0.4/concepts/spherical_harmonics.html
+    
+    References:
+    
+    .
+    
+    Author: MRTrix3 Developers
+    
+    URL: https://www.mrtrix.org/
+    
+    Args:
+        fixel_in: the input fixel data file.
+        sh_out: the output sh image.
+        lmax: set the maximum harmonic order for the output series (Default: 8).
+        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 `Fixel2shOutputs`).
+    """
+    params = fixel2sh_params(
+        lmax=lmax,
+        info=info,
+        quiet=quiet,
+        debug=debug,
+        force=force,
+        nthreads=nthreads,
+        config=config,
+        help_=help_,
+        version=version,
+        fixel_in=fixel_in,
+        sh_out=sh_out,
+    )
+    return fixel2sh_execute(params, runner)
+
+
+__all__ = [
+    "FIXEL2SH_METADATA",
+    "Fixel2shConfigParamsDict",
+    "Fixel2shConfigParamsDictTagged",
+    "Fixel2shOutputs",
+    "Fixel2shParamsDict",
+    "Fixel2shParamsDictTagged",
+    "fixel2sh",
+    "fixel2sh_config",
+    "fixel2sh_execute",
+    "fixel2sh_params",
+]