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

niwrap_mrtrix/mrtrix/maskfilter.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 MASKFILTER_METADATA = Metadata(
-    id="d840afad55e7b22d2468db1a39492bd06fd9a30d.boutiques",
+    id="b76a6dd73084b9b3914644ade090d2c6bf379b1d.boutiques",
     name="maskfilter",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,33 +14,67 @@ MASKFILTER_METADATA = Metadata(
 
 
 MaskfilterVariousStringParameters = typing.TypedDict('MaskfilterVariousStringParameters', {
-    "__STYXTYPE__": typing.Literal["VariousString"],
+    "@type": typing.NotRequired[typing.Literal["VariousString"]],
+    "obj": str,
+})
+MaskfilterVariousStringParametersTagged = typing.TypedDict('MaskfilterVariousStringParametersTagged', {
+    "@type": typing.Literal["VariousString"],
     "obj": str,
 })
 
 
 MaskfilterVariousFileParameters = typing.TypedDict('MaskfilterVariousFileParameters', {
-    "__STYXTYPE__": typing.Literal["VariousFile"],
+    "@type": typing.NotRequired[typing.Literal["VariousFile"]],
+    "obj": InputPathType,
+})
+MaskfilterVariousFileParametersTagged = typing.TypedDict('MaskfilterVariousFileParametersTagged', {
+    "@type": typing.Literal["VariousFile"],
     "obj": InputPathType,
 })
 
 
 MaskfilterConfigParameters = typing.TypedDict('MaskfilterConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+MaskfilterConfigParametersTagged = typing.TypedDict('MaskfilterConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 MaskfilterParameters = typing.TypedDict('MaskfilterParameters', {
-    "__STYXTYPE__": typing.Literal["maskfilter"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/maskfilter"]],
+    "scale": typing.NotRequired[int | None],
+    "axes": typing.NotRequired[list[int] | None],
+    "largest": bool,
+    "connectivity": bool,
+    "npass": typing.NotRequired[int | None],
+    "extent": typing.NotRequired[list[int] | None],
+    "strides": typing.NotRequired[typing.Union[MaskfilterVariousStringParametersTagged, MaskfilterVariousFileParametersTagged] | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[MaskfilterConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "input": InputPathType,
+    "filter": str,
+    "output": str,
+})
+MaskfilterParametersTagged = typing.TypedDict('MaskfilterParametersTagged', {
+    "@type": typing.Literal["mrtrix/maskfilter"],
     "scale": typing.NotRequired[int | None],
     "axes": typing.NotRequired[list[int] | None],
     "largest": bool,
     "connectivity": bool,
     "npass": typing.NotRequired[int | None],
     "extent": typing.NotRequired[list[int] | None],
-    "strides": typing.NotRequired[typing.Union[MaskfilterVariousStringParameters, MaskfilterVariousFileParameters] | None],
+    "strides": typing.NotRequired[typing.Union[MaskfilterVariousStringParametersTagged, MaskfilterVariousFileParametersTagged] | None],
     "info": bool,
     "quiet": bool,
     "debug": bool,
@@ -55,7 +89,7 @@ MaskfilterParameters = typing.TypedDict('MaskfilterParameters', {
 })
 
 
-def dyn_cargs(
+def maskfilter_strides_cargs_dyn_fn(
     t: str,
 ) -> typing.Any:
     """
@@ -67,14 +101,12 @@ def dyn_cargs(
         Build cargs function.
     """
     return {
-        "maskfilter": maskfilter_cargs,
         "VariousString": maskfilter_various_string_cargs,
         "VariousFile": maskfilter_various_file_cargs,
-        "config": maskfilter_config_cargs,
     }.get(t)
 
 
-def dyn_outputs(
+def maskfilter_strides_outputs_dyn_fn(
     t: str,
 ) -> typing.Any:
     """
@@ -86,13 +118,12 @@ def dyn_outputs(
         Build outputs function.
     """
     return {
-        "maskfilter": maskfilter_outputs,
     }.get(t)
 
 
 def maskfilter_various_string_params(
     obj: str,
-) -> MaskfilterVariousStringParameters:
+) -> MaskfilterVariousStringParametersTagged:
     """
     Build parameters.
     
@@ -102,7 +133,7 @@ def maskfilter_various_string_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "VariousString",
+        "@type": "VariousString",
         "obj": obj,
     }
     return params
@@ -122,13 +153,13 @@ def maskfilter_various_string_cargs(
         Command-line arguments.
     """
     cargs = []
-    cargs.append(params.get("obj"))
+    cargs.append(params.get("obj", None))
     return cargs
 
 
 def maskfilter_various_file_params(
     obj: InputPathType,
-) -> MaskfilterVariousFileParameters:
+) -> MaskfilterVariousFileParametersTagged:
     """
     Build parameters.
     
@@ -138,7 +169,7 @@ def maskfilter_various_file_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "VariousFile",
+        "@type": "VariousFile",
         "obj": obj,
     }
     return params
@@ -158,14 +189,14 @@ def maskfilter_various_file_cargs(
         Command-line arguments.
     """
     cargs = []
-    cargs.append(execution.input_file(params.get("obj")))
+    cargs.append(execution.input_file(params.get("obj", None)))
     return cargs
 
 
 def maskfilter_config_params(
     key: str,
     value: str,
-) -> MaskfilterConfigParameters:
+) -> MaskfilterConfigParametersTagged:
     """
     Build parameters.
     
@@ -176,7 +207,7 @@ def maskfilter_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -198,14 +229,14 @@ def maskfilter_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 MaskfilterOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `maskfilter(...)`.
+    Output object returned when calling `MaskfilterParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -223,7 +254,7 @@ def maskfilter_params(
     connectivity: bool = False,
     npass: int | None = None,
     extent: list[int] | None = None,
-    strides: typing.Union[MaskfilterVariousStringParameters, MaskfilterVariousFileParameters] | None = None,
+    strides: typing.Union[MaskfilterVariousStringParametersTagged, MaskfilterVariousFileParametersTagged] | None = None,
     info: bool = False,
     quiet: bool = False,
     debug: bool = False,
@@ -232,7 +263,7 @@ def maskfilter_params(
     config: list[MaskfilterConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> MaskfilterParameters:
+) -> MaskfilterParametersTagged:
     """
     Build parameters.
     
@@ -273,7 +304,7 @@ def maskfilter_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "maskfilter",
+        "@type": "mrtrix/maskfilter",
         "largest": largest,
         "connectivity": connectivity,
         "info": info,
@@ -318,57 +349,57 @@ def maskfilter_cargs(
     """
     cargs = []
     cargs.append("maskfilter")
-    if params.get("scale") is not None:
+    if params.get("scale", None) is not None:
         cargs.extend([
             "-scale",
-            str(params.get("scale"))
+            str(params.get("scale", None))
         ])
-    if params.get("axes") is not None:
+    if params.get("axes", None) is not None:
         cargs.extend([
             "-axes",
-            ",".join(map(str, params.get("axes")))
+            ",".join(map(str, params.get("axes", None)))
         ])
-    if params.get("largest"):
+    if params.get("largest", False):
         cargs.append("-largest")
-    if params.get("connectivity"):
+    if params.get("connectivity", False):
         cargs.append("-connectivity")
-    if params.get("npass") is not None:
+    if params.get("npass", None) is not None:
         cargs.extend([
             "-npass",
-            str(params.get("npass"))
+            str(params.get("npass", None))
         ])
-    if params.get("extent") is not None:
+    if params.get("extent", None) is not None:
         cargs.extend([
             "-extent",
-            ",".join(map(str, params.get("extent")))
+            ",".join(map(str, params.get("extent", None)))
         ])
-    if params.get("strides") is not None:
+    if params.get("strides", None) is not None:
         cargs.extend([
             "-strides",
-            *dyn_cargs(params.get("strides")["__STYXTYPE__"])(params.get("strides"), execution)
+            *maskfilter_strides_cargs_dyn_fn(params.get("strides", None)["@type"])(params.get("strides", None), execution)
         ])
-    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 [maskfilter_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("filter"))
-    cargs.append(params.get("output"))
+    cargs.append(execution.input_file(params.get("input", None)))
+    cargs.append(params.get("filter", None))
+    cargs.append(params.get("output", None))
     return cargs
 
 
@@ -387,16 +418,18 @@ def maskfilter_outputs(
     """
     ret = MaskfilterOutputs(
         root=execution.output_file("."),
-        output=execution.output_file(params.get("output")),
+        output=execution.output_file(params.get("output", None)),
     )
     return ret
 
 
 def maskfilter_execute(
     params: MaskfilterParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> MaskfilterOutputs:
     """
+    maskfilter
+    
     Perform filtering operations on 3D / 4D mask images.
     
     The available filters are: clean, connect, dilate, erode, median.
@@ -413,10 +446,12 @@ def maskfilter_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `MaskfilterOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(MASKFILTER_METADATA)
     params = execution.params(params)
     cargs = maskfilter_cargs(params, execution)
     ret = maskfilter_outputs(params, execution)
@@ -434,7 +469,7 @@ def maskfilter(
     connectivity: bool = False,
     npass: int | None = None,
     extent: list[int] | None = None,
-    strides: typing.Union[MaskfilterVariousStringParameters, MaskfilterVariousFileParameters] | None = None,
+    strides: typing.Union[MaskfilterVariousStringParametersTagged, MaskfilterVariousFileParametersTagged] | None = None,
     info: bool = False,
     quiet: bool = False,
     debug: bool = False,
@@ -446,6 +481,8 @@ def maskfilter(
     runner: Runner | None = None,
 ) -> MaskfilterOutputs:
     """
+    maskfilter
+    
     Perform filtering operations on 3D / 4D mask images.
     
     The available filters are: clean, connect, dilate, erode, median.
@@ -497,8 +534,6 @@ def maskfilter(
     Returns:
         NamedTuple of outputs (described in `MaskfilterOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(MASKFILTER_METADATA)
     params = maskfilter_params(
         scale=scale,
         axes=axes,
@@ -519,18 +554,15 @@ def maskfilter(
         filter_=filter_,
         output=output,
     )
-    return maskfilter_execute(params, execution)
+    return maskfilter_execute(params, runner)
 
 
 __all__ = [
     "MASKFILTER_METADATA",
-    "MaskfilterConfigParameters",
     "MaskfilterOutputs",
-    "MaskfilterParameters",
-    "MaskfilterVariousFileParameters",
-    "MaskfilterVariousStringParameters",
     "maskfilter",
     "maskfilter_config_params",
+    "maskfilter_execute",
     "maskfilter_params",
     "maskfilter_various_file_params",
     "maskfilter_various_string_params",

niwrap_mrtrix/mrtrix/mesh2voxel.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 MESH2VOXEL_METADATA = Metadata(
-    id="121d27a04e5be0003ec7fd7a1de2dfc3d8768d28.boutiques",
+    id="75e8f4f5578fd6f6ca18cc54925c6087e0adc3bc.boutiques",
     name="mesh2voxel",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,33 @@ MESH2VOXEL_METADATA = Metadata(
 
 
 Mesh2voxelConfigParameters = typing.TypedDict('Mesh2voxelConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+Mesh2voxelConfigParametersTagged = typing.TypedDict('Mesh2voxelConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 Mesh2voxelParameters = typing.TypedDict('Mesh2voxelParameters', {
-    "__STYXTYPE__": typing.Literal["mesh2voxel"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/mesh2voxel"]],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[Mesh2voxelConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "source": InputPathType,
+    "template": InputPathType,
+    "output": str,
+})
+Mesh2voxelParametersTagged = typing.TypedDict('Mesh2voxelParametersTagged', {
+    "@type": typing.Literal["mrtrix/mesh2voxel"],
     "info": bool,
     "quiet": bool,
     "debug": bool,
@@ -34,45 +53,12 @@ Mesh2voxelParameters = typing.TypedDict('Mesh2voxelParameters', {
     "template": 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 {
-        "mesh2voxel": mesh2voxel_cargs,
-        "config": mesh2voxel_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 {
-        "mesh2voxel": mesh2voxel_outputs,
-    }.get(t)
 
 
 def mesh2voxel_config_params(
     key: str,
     value: str,
-) -> Mesh2voxelConfigParameters:
+) -> Mesh2voxelConfigParametersTagged:
     """
     Build parameters.
     
@@ -83,7 +69,7 @@ def mesh2voxel_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -105,14 +91,14 @@ def mesh2voxel_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 Mesh2voxelOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `mesh2voxel(...)`.
+    Output object returned when calling `Mesh2voxelParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -132,7 +118,7 @@ def mesh2voxel_params(
     config: list[Mesh2voxelConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> Mesh2voxelParameters:
+) -> Mesh2voxelParametersTagged:
     """
     Build parameters.
     
@@ -157,7 +143,7 @@ def mesh2voxel_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "mesh2voxel",
+        "@type": "mrtrix/mesh2voxel",
         "info": info,
         "quiet": quiet,
         "debug": debug,
@@ -190,28 +176,28 @@ def mesh2voxel_cargs(
     """
     cargs = []
     cargs.append("mesh2voxel")
-    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 [mesh2voxel_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("source")))
-    cargs.append(execution.input_file(params.get("template")))
-    cargs.append(params.get("output"))
+    cargs.append(execution.input_file(params.get("source", None)))
+    cargs.append(execution.input_file(params.get("template", None)))
+    cargs.append(params.get("output", None))
     return cargs
 
 
@@ -230,16 +216,18 @@ def mesh2voxel_outputs(
     """
     ret = Mesh2voxelOutputs(
         root=execution.output_file("."),
-        output=execution.output_file(params.get("output")),
+        output=execution.output_file(params.get("output", None)),
     )
     return ret
 
 
 def mesh2voxel_execute(
     params: Mesh2voxelParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> Mesh2voxelOutputs:
     """
+    mesh2voxel
+    
     Convert a mesh surface to a partial volume estimation image.
     
     
@@ -257,10 +245,12 @@ def mesh2voxel_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `Mesh2voxelOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(MESH2VOXEL_METADATA)
     params = execution.params(params)
     cargs = mesh2voxel_cargs(params, execution)
     ret = mesh2voxel_outputs(params, execution)
@@ -283,6 +273,8 @@ def mesh2voxel(
     runner: Runner | None = None,
 ) -> Mesh2voxelOutputs:
     """
+    mesh2voxel
+    
     Convert a mesh surface to a partial volume estimation image.
     
     
@@ -319,8 +311,6 @@ def mesh2voxel(
     Returns:
         NamedTuple of outputs (described in `Mesh2voxelOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(MESH2VOXEL_METADATA)
     params = mesh2voxel_params(
         info=info,
         quiet=quiet,
@@ -334,15 +324,14 @@ def mesh2voxel(
         template=template,
         output=output,
     )
-    return mesh2voxel_execute(params, execution)
+    return mesh2voxel_execute(params, runner)
 
 
 __all__ = [
     "MESH2VOXEL_METADATA",
-    "Mesh2voxelConfigParameters",
     "Mesh2voxelOutputs",
-    "Mesh2voxelParameters",
     "mesh2voxel",
     "mesh2voxel_config_params",
+    "mesh2voxel_execute",
     "mesh2voxel_params",
 ]