niwrap-mrtrix 0.8.0__py3-none-any.whl

niwrap_mrtrix/mrtrix/dwigradcheck.py

@@ -0,0 +1,665 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+DWIGRADCHECK_METADATA = Metadata(
+    id="da91c0d77a46dd23fc98bad56497487a81e19371.boutiques",
+    name="dwigradcheck",
+    package="mrtrix",
+    container_image_tag="mrtrix3/mrtrix3:3.0.4",
+)
+
+
+_DwigradcheckFslgradParamsDictNoTag = typing.TypedDict('_DwigradcheckFslgradParamsDictNoTag', {
+    "bvecs": InputPathType,
+    "bvals": InputPathType,
+})
+DwigradcheckFslgradParamsDictTagged = typing.TypedDict('DwigradcheckFslgradParamsDictTagged', {
+    "@type": typing.Literal["fslgrad"],
+    "bvecs": InputPathType,
+    "bvals": InputPathType,
+})
+DwigradcheckFslgradParamsDict = _DwigradcheckFslgradParamsDictNoTag | DwigradcheckFslgradParamsDictTagged
+
+
+_DwigradcheckExportGradFslParamsDictNoTag = typing.TypedDict('_DwigradcheckExportGradFslParamsDictNoTag', {
+    "bvecs_path": str,
+    "bvals_path": str,
+})
+DwigradcheckExportGradFslParamsDictTagged = typing.TypedDict('DwigradcheckExportGradFslParamsDictTagged', {
+    "@type": typing.Literal["export_grad_fsl"],
+    "bvecs_path": str,
+    "bvals_path": str,
+})
+DwigradcheckExportGradFslParamsDict = _DwigradcheckExportGradFslParamsDictNoTag | DwigradcheckExportGradFslParamsDictTagged
+
+
+_DwigradcheckParamsDictNoTag = typing.TypedDict('_DwigradcheckParamsDictNoTag', {
+    "input_image": InputPathType,
+    "grad": typing.NotRequired[InputPathType | None],
+    "fslgrad": typing.NotRequired[DwigradcheckFslgradParamsDict | None],
+    "mask_image": typing.NotRequired[InputPathType | None],
+    "number": typing.NotRequired[int | None],
+    "export_grad_mrtrix": typing.NotRequired[str | None],
+    "export_grad_fsl": typing.NotRequired[DwigradcheckExportGradFslParamsDict | None],
+    "nocleanup": bool,
+    "scratch_dir": typing.NotRequired[InputPathType | None],
+    "continue_scratch_dir": typing.NotRequired[list[InputPathType] | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[float | None],
+    "config": typing.NotRequired[list[str] | None],
+    "help": bool,
+    "version": bool,
+})
+DwigradcheckParamsDictTagged = typing.TypedDict('DwigradcheckParamsDictTagged', {
+    "@type": typing.Literal["mrtrix/dwigradcheck"],
+    "input_image": InputPathType,
+    "grad": typing.NotRequired[InputPathType | None],
+    "fslgrad": typing.NotRequired[DwigradcheckFslgradParamsDict | None],
+    "mask_image": typing.NotRequired[InputPathType | None],
+    "number": typing.NotRequired[int | None],
+    "export_grad_mrtrix": typing.NotRequired[str | None],
+    "export_grad_fsl": typing.NotRequired[DwigradcheckExportGradFslParamsDict | None],
+    "nocleanup": bool,
+    "scratch_dir": typing.NotRequired[InputPathType | None],
+    "continue_scratch_dir": typing.NotRequired[list[InputPathType] | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[float | None],
+    "config": typing.NotRequired[list[str] | None],
+    "help": bool,
+    "version": bool,
+})
+DwigradcheckParamsDict = _DwigradcheckParamsDictNoTag | DwigradcheckParamsDictTagged
+
+
+def dwigradcheck_fslgrad(
+    bvecs: InputPathType,
+    bvals: InputPathType,
+) -> DwigradcheckFslgradParamsDictTagged:
+    """
+    Build parameters.
+    
+    Args:
+        bvecs: Provide the diffusion-weighted gradient scheme used in the\
+            acquisition in FSL bvecs/bvals format files. If a diffusion gradient\
+            scheme is present in the input image header, the data provided with\
+            this option will be instead used.
+        bvals: Provide the diffusion-weighted gradient scheme used in the\
+            acquisition in FSL bvecs/bvals format files. If a diffusion gradient\
+            scheme is present in the input image header, the data provided with\
+            this option will be instead used.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "@type": "fslgrad",
+        "bvecs": bvecs,
+        "bvals": bvals,
+    }
+    return params
+
+
+def dwigradcheck_fslgrad_validate(
+    params: typing.Any,
+) -> None:
+    """
+    Validate parameters. Throws an error if `params` is not a valid
+    `DwigradcheckFslgradParamsDict` 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("bvecs", None) is None:
+        raise StyxValidationError("`bvecs` must not be None")
+    if not isinstance(params["bvecs"], (pathlib.Path, str)):
+        raise StyxValidationError(f'`bvecs` has the wrong type: Received `{type(params.get("bvecs", None))}` expected `InputPathType`')
+    if params.get("bvals", None) is None:
+        raise StyxValidationError("`bvals` must not be None")
+    if not isinstance(params["bvals"], (pathlib.Path, str)):
+        raise StyxValidationError(f'`bvals` has the wrong type: Received `{type(params.get("bvals", None))}` expected `InputPathType`')
+
+
+def dwigradcheck_fslgrad_cargs(
+    params: DwigradcheckFslgradParamsDict,
+    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("-fslgrad")
+    cargs.append(execution.input_file(params.get("bvecs", None)))
+    cargs.append(execution.input_file(params.get("bvals", None)))
+    return cargs
+
+
+class DwigradcheckExportGradFslOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `DwigradcheckExportGradFslParamsDict | None(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    bvecs_path: OutputPathType
+    """export the diffusion-weighted gradient table to files in FSL (bvecs /
+    bvals) format"""
+    bvals_path: OutputPathType
+    """export the diffusion-weighted gradient table to files in FSL (bvecs /
+    bvals) format"""
+
+
+def dwigradcheck_export_grad_fsl(
+    bvecs_path: str,
+    bvals_path: str,
+) -> DwigradcheckExportGradFslParamsDictTagged:
+    """
+    Build parameters.
+    
+    Args:
+        bvecs_path: export the diffusion-weighted gradient table to files in\
+            FSL (bvecs / bvals) format.
+        bvals_path: export the diffusion-weighted gradient table to files in\
+            FSL (bvecs / bvals) format.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "@type": "export_grad_fsl",
+        "bvecs_path": bvecs_path,
+        "bvals_path": bvals_path,
+    }
+    return params
+
+
+def dwigradcheck_export_grad_fsl_validate(
+    params: typing.Any,
+) -> None:
+    """
+    Validate parameters. Throws an error if `params` is not a valid
+    `DwigradcheckExportGradFslParamsDict` 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("bvecs_path", None) is None:
+        raise StyxValidationError("`bvecs_path` must not be None")
+    if not isinstance(params["bvecs_path"], str):
+        raise StyxValidationError(f'`bvecs_path` has the wrong type: Received `{type(params.get("bvecs_path", None))}` expected `str`')
+    if params.get("bvals_path", None) is None:
+        raise StyxValidationError("`bvals_path` must not be None")
+    if not isinstance(params["bvals_path"], str):
+        raise StyxValidationError(f'`bvals_path` has the wrong type: Received `{type(params.get("bvals_path", None))}` expected `str`')
+
+
+def dwigradcheck_export_grad_fsl_cargs(
+    params: DwigradcheckExportGradFslParamsDict,
+    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("-export_grad_fsl")
+    cargs.append(params.get("bvecs_path", None))
+    cargs.append(params.get("bvals_path", None))
+    return cargs
+
+
+def dwigradcheck_export_grad_fsl_outputs(
+    params: DwigradcheckExportGradFslParamsDict,
+    execution: Execution,
+) -> DwigradcheckExportGradFslOutputs:
+    """
+    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 = DwigradcheckExportGradFslOutputs(
+        root=execution.output_file("."),
+        bvecs_path=execution.output_file(params.get("bvecs_path", None)),
+        bvals_path=execution.output_file(params.get("bvals_path", None)),
+    )
+    return ret
+
+
+class DwigradcheckOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `DwigradcheckParamsDict(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    export_grad_mrtrix: OutputPathType | None
+    """export the diffusion-weighted gradient table to file in MRtrix format """
+    export_grad_fsl: OutputPathType | None
+    """export the diffusion-weighted gradient table to file in FSL format """
+    export_grad_fsl_: DwigradcheckExportGradFslOutputs | None
+    """Outputs from `dwigradcheck_export_grad_fsl_outputs`."""
+
+
+def dwigradcheck_params(
+    input_image: InputPathType,
+    grad: InputPathType | None = None,
+    fslgrad: DwigradcheckFslgradParamsDict | None = None,
+    mask_image: InputPathType | None = None,
+    number: int | None = None,
+    export_grad_mrtrix: str | None = None,
+    export_grad_fsl: DwigradcheckExportGradFslParamsDict | None = None,
+    nocleanup: bool = False,
+    scratch_dir: InputPathType | None = None,
+    continue_scratch_dir: list[InputPathType] | None = None,
+    info: bool = False,
+    quiet: bool = False,
+    debug: bool = False,
+    force: bool = False,
+    nthreads: float | None = None,
+    config: list[str] | None = None,
+    help_: bool = False,
+    version: bool = False,
+) -> DwigradcheckParamsDictTagged:
+    """
+    Build parameters.
+    
+    Args:
+        input_image: The input DWI series to be checked.
+        grad: Provide the diffusion gradient table in MRtrix format.
+        fslgrad: Provide the diffusion-weighted gradient scheme used in the\
+            acquisition in FSL bvecs/bvals format files. If a diffusion gradient\
+            scheme is present in the input image header, the data provided with\
+            this option will be instead used.
+        mask_image: Provide a brain mask image.
+        number: Set the number of tracks to generate for each test.
+        export_grad_mrtrix: export the diffusion-weighted gradient table to\
+            file in MRtrix format.
+        export_grad_fsl: export the diffusion-weighted gradient table to files\
+            in FSL (bvecs / bvals) format.
+        nocleanup: Do not delete intermediate files during script execution,\
+            and do not delete scratch directory at script completion.
+        scratch_dir: Manually specify the path in which to generate the scratch\
+            directory.
+        continue_scratch_dir: Continue the script from a previous execution;\
+            must provide the scratch directory path.
+        info: Display information messages.
+        quiet: Do not display information messages or progress status.
+        debug: Display debugging messages.
+        force: Force overwrite of output files.
+        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 help information and exit.
+        version: Display version information and exit.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "@type": "mrtrix/dwigradcheck",
+        "input_image": input_image,
+        "nocleanup": nocleanup,
+        "info": info,
+        "quiet": quiet,
+        "debug": debug,
+        "force": force,
+        "help": help_,
+        "version": version,
+    }
+    if grad is not None:
+        params["grad"] = grad
+    if fslgrad is not None:
+        params["fslgrad"] = fslgrad
+    if mask_image is not None:
+        params["mask_image"] = mask_image
+    if number is not None:
+        params["number"] = number
+    if export_grad_mrtrix is not None:
+        params["export_grad_mrtrix"] = export_grad_mrtrix
+    if export_grad_fsl is not None:
+        params["export_grad_fsl"] = export_grad_fsl
+    if scratch_dir is not None:
+        params["scratch_dir"] = scratch_dir
+    if continue_scratch_dir is not None:
+        params["continue_scratch_dir"] = continue_scratch_dir
+    if nthreads is not None:
+        params["nthreads"] = nthreads
+    if config is not None:
+        params["config"] = config
+    return params
+
+
+def dwigradcheck_validate(
+    params: typing.Any,
+) -> None:
+    """
+    Validate parameters. Throws an error if `params` is not a valid
+    `DwigradcheckParamsDict` 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("input_image", None) is None:
+        raise StyxValidationError("`input_image` must not be None")
+    if not isinstance(params["input_image"], (pathlib.Path, str)):
+        raise StyxValidationError(f'`input_image` has the wrong type: Received `{type(params.get("input_image", None))}` expected `InputPathType`')
+    if params.get("grad", None) is not None:
+        if not isinstance(params["grad"], (pathlib.Path, str)):
+            raise StyxValidationError(f'`grad` has the wrong type: Received `{type(params.get("grad", None))}` expected `InputPathType | None`')
+    if params.get("fslgrad", None) is not None:
+        dwigradcheck_fslgrad_validate(params["fslgrad"])
+    if params.get("mask_image", None) is not None:
+        if not isinstance(params["mask_image"], (pathlib.Path, str)):
+            raise StyxValidationError(f'`mask_image` has the wrong type: Received `{type(params.get("mask_image", None))}` expected `InputPathType | None`')
+    if params.get("number", None) is not None:
+        if not isinstance(params["number"], int):
+            raise StyxValidationError(f'`number` has the wrong type: Received `{type(params.get("number", None))}` expected `int | None`')
+    if params.get("export_grad_mrtrix", None) is not None:
+        if not isinstance(params["export_grad_mrtrix"], str):
+            raise StyxValidationError(f'`export_grad_mrtrix` has the wrong type: Received `{type(params.get("export_grad_mrtrix", None))}` expected `str | None`')
+    if params.get("export_grad_fsl", None) is not None:
+        dwigradcheck_export_grad_fsl_validate(params["export_grad_fsl"])
+    if params.get("nocleanup", False) is None:
+        raise StyxValidationError("`nocleanup` must not be None")
+    if not isinstance(params["nocleanup"], bool):
+        raise StyxValidationError(f'`nocleanup` has the wrong type: Received `{type(params.get("nocleanup", False))}` expected `bool`')
+    if params.get("scratch_dir", None) is not None:
+        if not isinstance(params["scratch_dir"], (pathlib.Path, str)):
+            raise StyxValidationError(f'`scratch_dir` has the wrong type: Received `{type(params.get("scratch_dir", None))}` expected `InputPathType | None`')
+    if params.get("continue_scratch_dir", None) is not None:
+        if not isinstance(params["continue_scratch_dir"], list):
+            raise StyxValidationError(f'`continue_scratch_dir` has the wrong type: Received `{type(params.get("continue_scratch_dir", None))}` expected `list[InputPathType] | None`')
+        if len(params["continue_scratch_dir"]) != 2:
+            raise StyxValidationError("Parameter `continue_scratch_dir` must contain exactly 2 elements")
+        for e in params["continue_scratch_dir"]:
+            if not isinstance(e, (pathlib.Path, str)):
+                raise StyxValidationError(f'`continue_scratch_dir` has the wrong type: Received `{type(params.get("continue_scratch_dir", None))}` expected `list[InputPathType] | 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"], (float, int)):
+            raise StyxValidationError(f'`nthreads` has the wrong type: Received `{type(params.get("nthreads", None))}` expected `float | 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[str] | None`')
+        for e in params["config"]:
+            if not isinstance(e, str):
+                raise StyxValidationError(f'`config` has the wrong type: Received `{type(params.get("config", None))}` expected `list[str] | None`')
+    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`')
+
+
+def dwigradcheck_cargs(
+    params: DwigradcheckParamsDict,
+    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("dwigradcheck")
+    cargs.append(execution.input_file(params.get("input_image", None)))
+    if params.get("grad", None) is not None:
+        cargs.extend([
+            "-grad",
+            execution.input_file(params.get("grad", None))
+        ])
+    if params.get("fslgrad", None) is not None:
+        cargs.extend(dwigradcheck_fslgrad_cargs(params.get("fslgrad", None), execution))
+    if params.get("mask_image", None) is not None:
+        cargs.extend([
+            "-mask",
+            execution.input_file(params.get("mask_image", None))
+        ])
+    if params.get("number", None) is not None:
+        cargs.extend([
+            "-number",
+            str(params.get("number", None))
+        ])
+    if params.get("export_grad_mrtrix", None) is not None:
+        cargs.extend([
+            "-export_grad_mrtrix",
+            params.get("export_grad_mrtrix", None)
+        ])
+    if params.get("export_grad_fsl", None) is not None:
+        cargs.extend(dwigradcheck_export_grad_fsl_cargs(params.get("export_grad_fsl", None), execution))
+    if params.get("nocleanup", False):
+        cargs.append("-nocleanup")
+    if params.get("scratch_dir", None) is not None:
+        cargs.extend([
+            "-scratch",
+            execution.input_file(params.get("scratch_dir", None))
+        ])
+    if params.get("continue_scratch_dir", None) is not None:
+        cargs.extend([
+            "-continue",
+            *[execution.input_file(f) for f in params.get("continue_scratch_dir", 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([
+            "-config",
+            *params.get("config", None)
+        ])
+    if params.get("help", False):
+        cargs.append("-help")
+    if params.get("version", False):
+        cargs.append("-version")
+    return cargs
+
+
+def dwigradcheck_outputs(
+    params: DwigradcheckParamsDict,
+    execution: Execution,
+) -> DwigradcheckOutputs:
+    """
+    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 = DwigradcheckOutputs(
+        root=execution.output_file("."),
+        export_grad_mrtrix=execution.output_file(params.get("export_grad_mrtrix", None)) if (params.get("export_grad_mrtrix") is not None) else None,
+        export_grad_fsl=execution.output_file(params.get("export_grad_mrtrix", None)) if (params.get("export_grad_mrtrix") is not None) else None,
+        export_grad_fsl_=dwigradcheck_export_grad_fsl_outputs(params.get("export_grad_fsl"), execution) if params.get("export_grad_fsl") else None,
+    )
+    return ret
+
+
+def dwigradcheck_execute(
+    params: DwigradcheckParamsDict,
+    runner: Runner | None = None,
+) -> DwigradcheckOutputs:
+    """
+    dwigradcheck
+    
+    Check the orientation of the diffusion gradient table.
+    
+    Author: MRTrix3 Developers
+    
+    URL: https://www.mrtrix.org/
+    
+    Args:
+        params: The parameters.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `DwigradcheckOutputs`).
+    """
+    dwigradcheck_validate(params)
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(DWIGRADCHECK_METADATA)
+    params = execution.params(params)
+    cargs = dwigradcheck_cargs(params, execution)
+    ret = dwigradcheck_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def dwigradcheck(
+    input_image: InputPathType,
+    grad: InputPathType | None = None,
+    fslgrad: DwigradcheckFslgradParamsDict | None = None,
+    mask_image: InputPathType | None = None,
+    number: int | None = None,
+    export_grad_mrtrix: str | None = None,
+    export_grad_fsl: DwigradcheckExportGradFslParamsDict | None = None,
+    nocleanup: bool = False,
+    scratch_dir: InputPathType | None = None,
+    continue_scratch_dir: list[InputPathType] | None = None,
+    info: bool = False,
+    quiet: bool = False,
+    debug: bool = False,
+    force: bool = False,
+    nthreads: float | None = None,
+    config: list[str] | None = None,
+    help_: bool = False,
+    version: bool = False,
+    runner: Runner | None = None,
+) -> DwigradcheckOutputs:
+    """
+    dwigradcheck
+    
+    Check the orientation of the diffusion gradient table.
+    
+    Author: MRTrix3 Developers
+    
+    URL: https://www.mrtrix.org/
+    
+    Args:
+        input_image: The input DWI series to be checked.
+        grad: Provide the diffusion gradient table in MRtrix format.
+        fslgrad: Provide the diffusion-weighted gradient scheme used in the\
+            acquisition in FSL bvecs/bvals format files. If a diffusion gradient\
+            scheme is present in the input image header, the data provided with\
+            this option will be instead used.
+        mask_image: Provide a brain mask image.
+        number: Set the number of tracks to generate for each test.
+        export_grad_mrtrix: export the diffusion-weighted gradient table to\
+            file in MRtrix format.
+        export_grad_fsl: export the diffusion-weighted gradient table to files\
+            in FSL (bvecs / bvals) format.
+        nocleanup: Do not delete intermediate files during script execution,\
+            and do not delete scratch directory at script completion.
+        scratch_dir: Manually specify the path in which to generate the scratch\
+            directory.
+        continue_scratch_dir: Continue the script from a previous execution;\
+            must provide the scratch directory path.
+        info: Display information messages.
+        quiet: Do not display information messages or progress status.
+        debug: Display debugging messages.
+        force: Force overwrite of output files.
+        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 help information and exit.
+        version: Display version information and exit.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `DwigradcheckOutputs`).
+    """
+    params = dwigradcheck_params(
+        input_image=input_image,
+        grad=grad,
+        fslgrad=fslgrad,
+        mask_image=mask_image,
+        number=number,
+        export_grad_mrtrix=export_grad_mrtrix,
+        export_grad_fsl=export_grad_fsl,
+        nocleanup=nocleanup,
+        scratch_dir=scratch_dir,
+        continue_scratch_dir=continue_scratch_dir,
+        info=info,
+        quiet=quiet,
+        debug=debug,
+        force=force,
+        nthreads=nthreads,
+        config=config,
+        help_=help_,
+        version=version,
+    )
+    return dwigradcheck_execute(params, runner)
+
+
+__all__ = [
+    "DWIGRADCHECK_METADATA",
+    "DwigradcheckExportGradFslOutputs",
+    "DwigradcheckExportGradFslParamsDict",
+    "DwigradcheckExportGradFslParamsDictTagged",
+    "DwigradcheckFslgradParamsDict",
+    "DwigradcheckFslgradParamsDictTagged",
+    "DwigradcheckOutputs",
+    "DwigradcheckParamsDict",
+    "DwigradcheckParamsDictTagged",
+    "dwigradcheck",
+    "dwigradcheck_execute",
+    "dwigradcheck_export_grad_fsl",
+    "dwigradcheck_fslgrad",
+    "dwigradcheck_params",
+]