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

niwrap_mrtrix/mrtrix/dirflip.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 DIRFLIP_METADATA = Metadata(
-    id="1bc40c1342a5e6b2fe13e011f0393b92cd599ded.boutiques",
+    id="d8812d8343a227a55e2791ff77c8b329d1aaf85d.boutiques",
     name="dirflip",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,34 @@ DIRFLIP_METADATA = Metadata(
 
 
 DirflipConfigParameters = typing.TypedDict('DirflipConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+DirflipConfigParametersTagged = typing.TypedDict('DirflipConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 DirflipParameters = typing.TypedDict('DirflipParameters', {
-    "__STYXTYPE__": typing.Literal["dirflip"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/dirflip"]],
+    "permutations": typing.NotRequired[int | None],
+    "cartesian": bool,
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[DirflipConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "in": InputPathType,
+    "out": str,
+})
+DirflipParametersTagged = typing.TypedDict('DirflipParametersTagged', {
+    "@type": typing.Literal["mrtrix/dirflip"],
     "permutations": typing.NotRequired[int | None],
     "cartesian": bool,
     "info": bool,
@@ -35,45 +55,12 @@ DirflipParameters = typing.TypedDict('DirflipParameters', {
     "in": InputPathType,
     "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 {
-        "dirflip": dirflip_cargs,
-        "config": dirflip_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 {
-        "dirflip": dirflip_outputs,
-    }.get(t)
 
 
 def dirflip_config_params(
     key: str,
     value: str,
-) -> DirflipConfigParameters:
+) -> DirflipConfigParametersTagged:
     """
     Build parameters.
     
@@ -84,7 +71,7 @@ def dirflip_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -106,14 +93,14 @@ def dirflip_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 DirflipOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `dirflip(...)`.
+    Output object returned when calling `DirflipParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -134,7 +121,7 @@ def dirflip_params(
     config: list[DirflipConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> DirflipParameters:
+) -> DirflipParametersTagged:
     """
     Build parameters.
     
@@ -160,7 +147,7 @@ def dirflip_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "dirflip",
+        "@type": "mrtrix/dirflip",
         "cartesian": cartesian,
         "info": info,
         "quiet": quiet,
@@ -195,34 +182,34 @@ def dirflip_cargs(
     """
     cargs = []
     cargs.append("dirflip")
-    if params.get("permutations") is not None:
+    if params.get("permutations", None) is not None:
         cargs.extend([
             "-permutations",
-            str(params.get("permutations"))
+            str(params.get("permutations", None))
         ])
-    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 [dirflip_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("in")))
-    cargs.append(params.get("out"))
+    cargs.append(execution.input_file(params.get("in", None)))
+    cargs.append(params.get("out", None))
     return cargs
 
 
@@ -241,16 +228,18 @@ def dirflip_outputs(
     """
     ret = DirflipOutputs(
         root=execution.output_file("."),
-        out=execution.output_file(params.get("out")),
+        out=execution.output_file(params.get("out", None)),
     )
     return ret
 
 
 def dirflip_execute(
     params: DirflipParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> DirflipOutputs:
     """
+    dirflip
+    
     Invert the polarity of individual directions so as to optimise a unipolar
     electrostatic repulsion model.
     
@@ -268,10 +257,12 @@ def dirflip_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `DirflipOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(DIRFLIP_METADATA)
     params = execution.params(params)
     cargs = dirflip_cargs(params, execution)
     ret = dirflip_outputs(params, execution)
@@ -295,6 +286,8 @@ def dirflip(
     runner: Runner | None = None,
 ) -> DirflipOutputs:
     """
+    dirflip
+    
     Invert the polarity of individual directions so as to optimise a unipolar
     electrostatic repulsion model.
     
@@ -332,8 +325,6 @@ def dirflip(
     Returns:
         NamedTuple of outputs (described in `DirflipOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(DIRFLIP_METADATA)
     params = dirflip_params(
         permutations=permutations,
         cartesian=cartesian,
@@ -348,15 +339,14 @@ def dirflip(
         in_=in_,
         out=out,
     )
-    return dirflip_execute(params, execution)
+    return dirflip_execute(params, runner)
 
 
 __all__ = [
     "DIRFLIP_METADATA",
-    "DirflipConfigParameters",
     "DirflipOutputs",
-    "DirflipParameters",
     "dirflip",
     "dirflip_config_params",
+    "dirflip_execute",
     "dirflip_params",
 ]

niwrap_mrtrix/mrtrix/dirgen.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 DIRGEN_METADATA = Metadata(
-    id="c60059a08fda0ae43d6c84d28c511d2352efa309.boutiques",
+    id="cda69ea8a57022773ddb6022ca8ca9caa5cc0e2b.boutiques",
     name="dirgen",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,37 @@ DIRGEN_METADATA = Metadata(
 
 
 DirgenConfigParameters = typing.TypedDict('DirgenConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+DirgenConfigParametersTagged = typing.TypedDict('DirgenConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 DirgenParameters = typing.TypedDict('DirgenParameters', {
-    "__STYXTYPE__": typing.Literal["dirgen"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/dirgen"]],
+    "power": typing.NotRequired[int | None],
+    "niter": typing.NotRequired[int | None],
+    "restarts": typing.NotRequired[int | None],
+    "unipolar": bool,
+    "cartesian": bool,
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[DirgenConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "ndir": int,
+    "dirs": str,
+})
+DirgenParametersTagged = typing.TypedDict('DirgenParametersTagged', {
+    "@type": typing.Literal["mrtrix/dirgen"],
     "power": typing.NotRequired[int | None],
     "niter": typing.NotRequired[int | None],
     "restarts": typing.NotRequired[int | None],
@@ -38,45 +61,12 @@ DirgenParameters = typing.TypedDict('DirgenParameters', {
     "ndir": int,
     "dirs": str,
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "dirgen": dirgen_cargs,
-        "config": dirgen_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 {
-        "dirgen": dirgen_outputs,
-    }.get(t)
 
 
 def dirgen_config_params(
     key: str,
     value: str,
-) -> DirgenConfigParameters:
+) -> DirgenConfigParametersTagged:
     """
     Build parameters.
     
@@ -87,7 +77,7 @@ def dirgen_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -109,14 +99,14 @@ def dirgen_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 DirgenOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `dirgen(...)`.
+    Output object returned when calling `DirgenParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -140,7 +130,7 @@ def dirgen_params(
     config: list[DirgenConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> DirgenParameters:
+) -> DirgenParametersTagged:
     """
     Build parameters.
     
@@ -172,7 +162,7 @@ def dirgen_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "dirgen",
+        "@type": "mrtrix/dirgen",
         "unipolar": unipolar,
         "cartesian": cartesian,
         "info": info,
@@ -212,46 +202,46 @@ def dirgen_cargs(
     """
     cargs = []
     cargs.append("dirgen")
-    if params.get("power") is not None:
+    if params.get("power", None) is not None:
         cargs.extend([
             "-power",
-            str(params.get("power"))
+            str(params.get("power", None))
         ])
-    if params.get("niter") is not None:
+    if params.get("niter", None) is not None:
         cargs.extend([
             "-niter",
-            str(params.get("niter"))
+            str(params.get("niter", None))
         ])
-    if params.get("restarts") is not None:
+    if params.get("restarts", None) is not None:
         cargs.extend([
             "-restarts",
-            str(params.get("restarts"))
+            str(params.get("restarts", None))
         ])
-    if params.get("unipolar"):
+    if params.get("unipolar", False):
         cargs.append("-unipolar")
-    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 [dirgen_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("ndir")))
-    cargs.append(params.get("dirs"))
+    cargs.append(str(params.get("ndir", None)))
+    cargs.append(params.get("dirs", None))
     return cargs
 
 
@@ -270,18 +260,20 @@ def dirgen_outputs(
     """
     ret = DirgenOutputs(
         root=execution.output_file("."),
-        dirs=execution.output_file(params.get("dirs")),
+        dirs=execution.output_file(params.get("dirs", None)),
     )
     return ret
 
 
 def dirgen_execute(
     params: DirgenParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> DirgenOutputs:
     """
-    Generate a set of uniformly distributed directions using a bipolar electrostatic
-    repulsion model.
+    dirgen
+    
+    Generate a set of uniformly distributed directions using a bipolar
+    electrostatic repulsion model.
     
     Directions are distributed by analogy to an electrostatic repulsion system,
     with each direction corresponding to a single electrostatic charge (for
@@ -307,10 +299,12 @@ def dirgen_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `DirgenOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(DIRGEN_METADATA)
     params = execution.params(params)
     cargs = dirgen_cargs(params, execution)
     ret = dirgen_outputs(params, execution)
@@ -337,8 +331,10 @@ def dirgen(
     runner: Runner | None = None,
 ) -> DirgenOutputs:
     """
-    Generate a set of uniformly distributed directions using a bipolar electrostatic
-    repulsion model.
+    dirgen
+    
+    Generate a set of uniformly distributed directions using a bipolar
+    electrostatic repulsion model.
     
     Directions are distributed by analogy to an electrostatic repulsion system,
     with each direction corresponding to a single electrostatic charge (for
@@ -390,8 +386,6 @@ def dirgen(
     Returns:
         NamedTuple of outputs (described in `DirgenOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(DIRGEN_METADATA)
     params = dirgen_params(
         power=power,
         niter=niter,
@@ -409,15 +403,14 @@ def dirgen(
         ndir=ndir,
         dirs=dirs,
     )
-    return dirgen_execute(params, execution)
+    return dirgen_execute(params, runner)
 
 
 __all__ = [
     "DIRGEN_METADATA",
-    "DirgenConfigParameters",
     "DirgenOutputs",
-    "DirgenParameters",
     "dirgen",
     "dirgen_config_params",
+    "dirgen_execute",
     "dirgen_params",
 ]