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

niwrap_mrtrix/mrtrix/labelstats.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 LABELSTATS_METADATA = Metadata(
-    id="320ec0010567d702a48cec5fa615ccb045cd158a.boutiques",
+    id="df8064dca9e1446035277a06d1872158b80f29f1.boutiques",
     name="labelstats",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,33 @@ LABELSTATS_METADATA = Metadata(
 
 
 LabelstatsConfigParameters = typing.TypedDict('LabelstatsConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+LabelstatsConfigParametersTagged = typing.TypedDict('LabelstatsConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 LabelstatsParameters = typing.TypedDict('LabelstatsParameters', {
-    "__STYXTYPE__": typing.Literal["labelstats"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/labelstats"]],
+    "output": typing.NotRequired[str | None],
+    "voxelspace": bool,
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[LabelstatsConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "input": InputPathType,
+})
+LabelstatsParametersTagged = typing.TypedDict('LabelstatsParametersTagged', {
+    "@type": typing.Literal["mrtrix/labelstats"],
     "output": typing.NotRequired[str | None],
     "voxelspace": bool,
     "info": bool,
@@ -34,44 +53,12 @@ LabelstatsParameters = typing.TypedDict('LabelstatsParameters', {
     "version": bool,
     "input": InputPathType,
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "labelstats": labelstats_cargs,
-        "config": labelstats_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 {
-    }.get(t)
 
 
 def labelstats_config_params(
     key: str,
     value: str,
-) -> LabelstatsConfigParameters:
+) -> LabelstatsConfigParametersTagged:
     """
     Build parameters.
     
@@ -82,7 +69,7 @@ def labelstats_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -104,14 +91,14 @@ def labelstats_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 LabelstatsOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `labelstats(...)`.
+    Output object returned when calling `LabelstatsParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -129,7 +116,7 @@ def labelstats_params(
     config: list[LabelstatsConfigParameters] | None = None,
     help_: bool = False,
     version: bool = False,
-) -> LabelstatsParameters:
+) -> LabelstatsParametersTagged:
     """
     Build parameters.
     
@@ -154,7 +141,7 @@ def labelstats_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "labelstats",
+        "@type": "mrtrix/labelstats",
         "voxelspace": voxelspace,
         "info": info,
         "quiet": quiet,
@@ -188,33 +175,33 @@ def labelstats_cargs(
     """
     cargs = []
     cargs.append("labelstats")
-    if params.get("output") is not None:
+    if params.get("output", None) is not None:
         cargs.extend([
             "-output",
-            params.get("output")
+            params.get("output", None)
         ])
-    if params.get("voxelspace"):
+    if params.get("voxelspace", False):
         cargs.append("-voxelspace")
-    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 [labelstats_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(execution.input_file(params.get("input", None)))
     return cargs
 
 
@@ -239,9 +226,11 @@ def labelstats_outputs(
 
 def labelstats_execute(
     params: LabelstatsParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> LabelstatsOutputs:
     """
+    labelstats
+    
     Compute statistics of parcels within a label image.
     
     
@@ -256,10 +245,12 @@ def labelstats_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `LabelstatsOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(LABELSTATS_METADATA)
     params = execution.params(params)
     cargs = labelstats_cargs(params, execution)
     ret = labelstats_outputs(params, execution)
@@ -282,6 +273,8 @@ def labelstats(
     runner: Runner | None = None,
 ) -> LabelstatsOutputs:
     """
+    labelstats
+    
     Compute statistics of parcels within a label image.
     
     
@@ -315,8 +308,6 @@ def labelstats(
     Returns:
         NamedTuple of outputs (described in `LabelstatsOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(LABELSTATS_METADATA)
     params = labelstats_params(
         output=output,
         voxelspace=voxelspace,
@@ -330,15 +321,14 @@ def labelstats(
         version=version,
         input_=input_,
     )
-    return labelstats_execute(params, execution)
+    return labelstats_execute(params, runner)
 
 
 __all__ = [
     "LABELSTATS_METADATA",
-    "LabelstatsConfigParameters",
     "LabelstatsOutputs",
-    "LabelstatsParameters",
     "labelstats",
     "labelstats_config_params",
+    "labelstats_execute",
     "labelstats_params",
 ]

niwrap_mrtrix/mrtrix/maskdump.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 MASKDUMP_METADATA = Metadata(
-    id="3cb50f33bf33aebf8bfc348f927db251f908e51a.boutiques",
+    id="2eb2e4e159fba58b9701608239b0227569dc91cd.boutiques",
     name="maskdump",
     package="mrtrix",
     container_image_tag="mrtrix3/mrtrix3:3.0.4",
@@ -14,14 +14,32 @@ MASKDUMP_METADATA = Metadata(
 
 
 MaskdumpConfigParameters = typing.TypedDict('MaskdumpConfigParameters', {
-    "__STYXTYPE__": typing.Literal["config"],
+    "@type": typing.NotRequired[typing.Literal["config"]],
+    "key": str,
+    "value": str,
+})
+MaskdumpConfigParametersTagged = typing.TypedDict('MaskdumpConfigParametersTagged', {
+    "@type": typing.Literal["config"],
     "key": str,
     "value": str,
 })
 
 
 MaskdumpParameters = typing.TypedDict('MaskdumpParameters', {
-    "__STYXTYPE__": typing.Literal["maskdump"],
+    "@type": typing.NotRequired[typing.Literal["mrtrix/maskdump"]],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[MaskdumpConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "input": InputPathType,
+    "output": typing.NotRequired[str | None],
+})
+MaskdumpParametersTagged = typing.TypedDict('MaskdumpParametersTagged', {
+    "@type": typing.Literal["mrtrix/maskdump"],
     "info": bool,
     "quiet": bool,
     "debug": bool,
@@ -33,45 +51,12 @@ MaskdumpParameters = typing.TypedDict('MaskdumpParameters', {
     "input": InputPathType,
     "output": typing.NotRequired[str | None],
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "maskdump": maskdump_cargs,
-        "config": maskdump_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 {
-        "maskdump": maskdump_outputs,
-    }.get(t)
 
 
 def maskdump_config_params(
     key: str,
     value: str,
-) -> MaskdumpConfigParameters:
+) -> MaskdumpConfigParametersTagged:
     """
     Build parameters.
     
@@ -82,7 +67,7 @@ def maskdump_config_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "config",
+        "@type": "config",
         "key": key,
         "value": value,
     }
@@ -104,14 +89,14 @@ def maskdump_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 MaskdumpOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `maskdump(...)`.
+    Output object returned when calling `MaskdumpParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -130,7 +115,7 @@ def maskdump_params(
     help_: bool = False,
     version: bool = False,
     output: str | None = None,
-) -> MaskdumpParameters:
+) -> MaskdumpParametersTagged:
     """
     Build parameters.
     
@@ -153,7 +138,7 @@ def maskdump_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "maskdump",
+        "@type": "mrtrix/maskdump",
         "info": info,
         "quiet": quiet,
         "debug": debug,
@@ -186,28 +171,28 @@ def maskdump_cargs(
     """
     cargs = []
     cargs.append("maskdump")
-    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 [maskdump_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")))
-    if params.get("output") is not None:
-        cargs.append(params.get("output"))
+    cargs.append(execution.input_file(params.get("input", None)))
+    if params.get("output", None) is not None:
+        cargs.append(params.get("output", None))
     return cargs
 
 
@@ -226,16 +211,18 @@ def maskdump_outputs(
     """
     ret = MaskdumpOutputs(
         root=execution.output_file("."),
-        output=execution.output_file(params.get("output")) if (params.get("output") is not None) else None,
+        output=execution.output_file(params.get("output", None)) if (params.get("output") is not None) else None,
     )
     return ret
 
 
 def maskdump_execute(
     params: MaskdumpParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> MaskdumpOutputs:
     """
+    maskdump
+    
     Print out the locations of all non-zero voxels in a mask image.
     
     If no destination file is specified, the voxel locations will be printed to
@@ -251,10 +238,12 @@ def maskdump_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `MaskdumpOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(MASKDUMP_METADATA)
     params = execution.params(params)
     cargs = maskdump_cargs(params, execution)
     ret = maskdump_outputs(params, execution)
@@ -276,6 +265,8 @@ def maskdump(
     runner: Runner | None = None,
 ) -> MaskdumpOutputs:
     """
+    maskdump
+    
     Print out the locations of all non-zero voxels in a mask image.
     
     If no destination file is specified, the voxel locations will be printed to
@@ -308,8 +299,6 @@ def maskdump(
     Returns:
         NamedTuple of outputs (described in `MaskdumpOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(MASKDUMP_METADATA)
     params = maskdump_params(
         info=info,
         quiet=quiet,
@@ -322,15 +311,14 @@ def maskdump(
         input_=input_,
         output=output,
     )
-    return maskdump_execute(params, execution)
+    return maskdump_execute(params, runner)
 
 
 __all__ = [
     "MASKDUMP_METADATA",
-    "MaskdumpConfigParameters",
     "MaskdumpOutputs",
-    "MaskdumpParameters",
     "maskdump",
     "maskdump_config_params",
+    "maskdump_execute",
     "maskdump_params",
 ]