niwrap-mrtrix 0.6.2__py3-none-any.whl → 0.7.0__py3-none-any.whl

niwrap_mrtrix/mrtrix/dirmerge.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 DIRMERGE_METADATA = Metadata(
-    id="b2c0d4c611fef0c99c4fd927498667a5d14a0534.boutiques",
+    id="40d07b2a5fb8d4016b42c7968c68cb8ea4d70a1a.boutiques",
     name="dirmerge",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,34 @@ DIRMERGE_METADATA = Metadata(
 
 
 DirmergeConfigParameters = typing.TypedDict('DirmergeConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+DirmergeConfigParametersTagged = typing.TypedDict('DirmergeConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 DirmergeParameters = typing.TypedDict('DirmergeParameters', {
-    "__STYXTYPE__": typing.Literal["dirmerge"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/dirmerge"]],
+    "unipolar_weight": typing.NotRequired[float | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[DirmergeConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "subsets": int,
+    "bvalue_files": list[str],
+    "out": str,
+})
+DirmergeParametersTagged = typing.TypedDict('DirmergeParametersTagged', {
+    "@type": typing.Literal["mrtrix/dirmerge"],
     "unipolar_weight": typing.NotRequired[float | None],
     "info": bool,
     "quiet": bool,
@@ -35,45 +55,12 @@ DirmergeParameters = typing.TypedDict('DirmergeParameters', {
     "bvalue_files": list[str],
     "out": str,
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "dirmerge": dirmerge_cargs,
-        "config": dirmerge_config_cargs,
-    }.get(t)
-
-
-def dyn_outputs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build outputs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build outputs function.
-    """
-    return {
-        "dirmerge": dirmerge_outputs,
-    }.get(t)
 
 
 def dirmerge_config_params(
     key: str,
     value: str,
-) -> DirmergeConfigParameters:
+) -> DirmergeConfigParametersTagged:
     """
     Build parameters.
     
@@ -84,7 +71,7 @@ def dirmerge_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -106,14 +93,14 @@ def dirmerge_config_cargs(
     """
     cargs = []
     cargs.append("-config")
-    cargs.append(params.get("key"))
-    cargs.append(params.get("value"))
+    cargs.append(params.get("key", None))
+    cargs.append(params.get("value", None))
     return cargs
 
 
 class DirmergeOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `dirmerge(...)`.
+    Output object returned when calling `DirmergeParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -136,7 +123,7 @@ def dirmerge_params(
     config: list[DirmergeConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> DirmergeParameters:
+) -> DirmergeParametersTagged:
     """
     Build parameters.
     
@@ -165,7 +152,7 @@ def dirmerge_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "dirmerge",
+        "@type": "mrtrix/dirmerge",
         "info": info,
         "quiet": quiet,
         "debug": debug,
@@ -200,33 +187,33 @@ def dirmerge_cargs(
     """
     cargs = []
     cargs.append("dirmerge")
-    if params.get("unipolar_weight") is not None:
+    if params.get("unipolar_weight", None) is not None:
         cargs.extend([
             "-unipolar_weight",
-            str(params.get("unipolar_weight"))
+            str(params.get("unipolar_weight", None))
         ])
-    if params.get("info"):
+    if params.get("info", False):
         cargs.append("-info")
-    if params.get("quiet"):
+    if params.get("quiet", False):
         cargs.append("-quiet")
-    if params.get("debug"):
+    if params.get("debug", False):
         cargs.append("-debug")
-    if params.get("force"):
+    if params.get("force", False):
         cargs.append("-force")
-    if params.get("nthreads") is not None:
+    if params.get("nthreads", None) is not None:
         cargs.extend([
             "-nthreads",
-            str(params.get("nthreads"))
+            str(params.get("nthreads", None))
         ])
-    if params.get("config") is not None:
-        cargs.extend([a for c in [dyn_cargs(s["__STYXTYPE__"])(s, execution) for s in params.get("config")] for a in c])
-    if params.get("help"):
+    if params.get("config", None) is not None:
+        cargs.extend([a for c in [dirmerge_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"):
+    if params.get("version", False):
         cargs.append("-version")
-    cargs.append(str(params.get("subsets")))
-    cargs.extend(params.get("bvalue_files"))
-    cargs.append(params.get("out"))
+    cargs.append(str(params.get("subsets", None)))
+    cargs.extend(params.get("bvalue_files", None))
+    cargs.append(params.get("out", None))
     return cargs
 
 
@@ -245,16 +232,18 @@ def dirmerge_outputs(
     """
     ret = DirmergeOutputs(
         root=execution.output_file("."),
-        out=execution.output_file(params.get("out")),
+        out=execution.output_file(params.get("out", None)),
     )
     return ret
 
 
 def dirmerge_execute(
     params: DirmergeParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> DirmergeOutputs:
     """
+    dirmerge
+    
     Splice / merge multiple sets of directions in such a way as to maintain
     near-optimality upon truncation.
     
@@ -270,10 +259,12 @@ def dirmerge_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `DirmergeOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(DIRMERGE_METADATA)
     params = execution.params(params)
     cargs = dirmerge_cargs(params, execution)
     ret = dirmerge_outputs(params, execution)
@@ -297,6 +288,8 @@ def dirmerge(
     runner: Runner | None = None,
 ) -> DirmergeOutputs:
     """
+    dirmerge
+    
     Splice / merge multiple sets of directions in such a way as to maintain
     near-optimality upon truncation.
     
@@ -335,8 +328,6 @@ def dirmerge(
     Returns:
         NamedTuple of outputs (described in `DirmergeOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(DIRMERGE_METADATA)
     params = dirmerge_params(
         unipolar_weight=unipolar_weight,
         info=info,
@@ -351,15 +342,14 @@ def dirmerge(
         bvalue_files=bvalue_files,
         out=out,
     )
-    return dirmerge_execute(params, execution)
+    return dirmerge_execute(params, runner)
 
 
 __all__ = [
     "DIRMERGE_METADATA",
-    "DirmergeConfigParameters",
     "DirmergeOutputs",
-    "DirmergeParameters",
     "dirmerge",
     "dirmerge_config_params",
+    "dirmerge_execute",
     "dirmerge_params",
 ]

niwrap_mrtrix/mrtrix/dirorder.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 DIRORDER_METADATA = Metadata(
-    id="81e71a9c447cf1cbb6b544733eb04768520936f0.boutiques",
+    id="86d673e95dbb0fe3b5812cf7b1b03f9ae588651e.boutiques",
     name="dirorder",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,33 @@ DIRORDER_METADATA = Metadata(
 
 
 DirorderConfigParameters = typing.TypedDict('DirorderConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+DirorderConfigParametersTagged = typing.TypedDict('DirorderConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 DirorderParameters = typing.TypedDict('DirorderParameters', {
-    "__STYXTYPE__": typing.Literal["dirorder"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/dirorder"]],
+    "cartesian": bool,
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[DirorderConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "input": InputPathType,
+    "output": str,
+})
+DirorderParametersTagged = typing.TypedDict('DirorderParametersTagged', {
+    "@type": typing.Literal["mrtrix/dirorder"],
     "cartesian": bool,
     "info": bool,
     "quiet": bool,
@@ -34,45 +53,12 @@ DirorderParameters = typing.TypedDict('DirorderParameters', {
     "input": InputPathType,
     "output": str,
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "dirorder": dirorder_cargs,
-        "config": dirorder_config_cargs,
-    }.get(t)
-
-
-def dyn_outputs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build outputs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build outputs function.
-    """
-    return {
-        "dirorder": dirorder_outputs,
-    }.get(t)
 
 
 def dirorder_config_params(
     key: str,
     value: str,
-) -> DirorderConfigParameters:
+) -> DirorderConfigParametersTagged:
     """
     Build parameters.
     
@@ -83,7 +69,7 @@ def dirorder_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -105,14 +91,14 @@ def dirorder_config_cargs(
     """
     cargs = []
     cargs.append("-config")
-    cargs.append(params.get("key"))
-    cargs.append(params.get("value"))
+    cargs.append(params.get("key", None))
+    cargs.append(params.get("value", None))
     return cargs
 
 
 class DirorderOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `dirorder(...)`.
+    Output object returned when calling `DirorderParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -132,7 +118,7 @@ def dirorder_params(
     config: list[DirorderConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> DirorderParameters:
+) -> DirorderParametersTagged:
     """
     Build parameters.
     
@@ -157,7 +143,7 @@ def dirorder_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "dirorder",
+        "@type": "mrtrix/dirorder",
         "cartesian": cartesian,
         "info": info,
         "quiet": quiet,
@@ -190,29 +176,29 @@ def dirorder_cargs(
     """
     cargs = []
     cargs.append("dirorder")
-    if params.get("cartesian"):
+    if params.get("cartesian", False):
         cargs.append("-cartesian")
-    if params.get("info"):
+    if params.get("info", False):
         cargs.append("-info")
-    if params.get("quiet"):
+    if params.get("quiet", False):
         cargs.append("-quiet")
-    if params.get("debug"):
+    if params.get("debug", False):
         cargs.append("-debug")
-    if params.get("force"):
+    if params.get("force", False):
         cargs.append("-force")
-    if params.get("nthreads") is not None:
+    if params.get("nthreads", None) is not None:
         cargs.extend([
             "-nthreads",
-            str(params.get("nthreads"))
+            str(params.get("nthreads", None))
         ])
-    if params.get("config") is not None:
-        cargs.extend([a for c in [dyn_cargs(s["__STYXTYPE__"])(s, execution) for s in params.get("config")] for a in c])
-    if params.get("help"):
+    if params.get("config", None) is not None:
+        cargs.extend([a for c in [dirorder_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"):
+    if params.get("version", False):
         cargs.append("-version")
-    cargs.append(execution.input_file(params.get("input")))
-    cargs.append(params.get("output"))
+    cargs.append(execution.input_file(params.get("input", None)))
+    cargs.append(params.get("output", None))
     return cargs
 
 
@@ -231,16 +217,18 @@ def dirorder_outputs(
     """
     ret = DirorderOutputs(
         root=execution.output_file("."),
-        output=execution.output_file(params.get("output")),
+        output=execution.output_file(params.get("output", None)),
     )
     return ret
 
 
 def dirorder_execute(
     params: DirorderParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> DirorderOutputs:
     """
+    dirorder
+    
     Reorder a set of directions to ensure near-uniformity upon truncation.
     
     The intent of this command is to reorder a set of gradient directions such
@@ -257,10 +245,12 @@ def dirorder_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `DirorderOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(DIRORDER_METADATA)
     params = execution.params(params)
     cargs = dirorder_cargs(params, execution)
     ret = dirorder_outputs(params, execution)
@@ -283,6 +273,8 @@ def dirorder(
     runner: Runner | None = None,
 ) -> DirorderOutputs:
     """
+    dirorder
+    
     Reorder a set of directions to ensure near-uniformity upon truncation.
     
     The intent of this command is to reorder a set of gradient directions such
@@ -318,8 +310,6 @@ def dirorder(
     Returns:
         NamedTuple of outputs (described in `DirorderOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(DIRORDER_METADATA)
     params = dirorder_params(
         cartesian=cartesian,
         info=info,
@@ -333,15 +323,14 @@ def dirorder(
         input_=input_,
         output=output,
     )
-    return dirorder_execute(params, execution)
+    return dirorder_execute(params, runner)
 
 
 __all__ = [
     "DIRORDER_METADATA",
-    "DirorderConfigParameters",
     "DirorderOutputs",
-    "DirorderParameters",
     "dirorder",
     "dirorder_config_params",
+    "dirorder_execute",
     "dirorder_params",
 ]