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

niwrap_afni/afni/v_3dmask_tool.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 V_3DMASK_TOOL_METADATA = Metadata(
-    id="3803728aed061b1e42816745d337535ee20c4e5d.boutiques",
+    id="c4f0b25b49abea733203c66ca291c958eea5a775.boutiques",
     name="3dmask_tool",
     package="afni",
     container_image_tag="afni/afni_make_build:AFNI_24.2.06",
@@ -14,7 +14,23 @@ V_3DMASK_TOOL_METADATA = Metadata(
 
 
 V3dmaskToolParameters = typing.TypedDict('V3dmaskToolParameters', {
-    "__STYXTYPE__": typing.Literal["3dmask_tool"],
+    "@type": typing.NotRequired[typing.Literal["afni/3dmask_tool"]],
+    "count": bool,
+    "datum": typing.NotRequired[typing.Literal["byte", "short", "float"] | None],
+    "dilate_inputs": typing.NotRequired[str | None],
+    "dilate_results": typing.NotRequired[str | None],
+    "fill_dirs": typing.NotRequired[str | None],
+    "fill_holes": bool,
+    "frac": typing.NotRequired[float | None],
+    "in_file": InputPathType,
+    "inter": bool,
+    "num_threads": typing.NotRequired[int | None],
+    "outputtype": typing.NotRequired[typing.Literal["NIFTI", "AFNI", "NIFTI_GZ"] | None],
+    "union": bool,
+    "verbose": typing.NotRequired[int | None],
+})
+V3dmaskToolParametersTagged = typing.TypedDict('V3dmaskToolParametersTagged', {
+    "@type": typing.Literal["afni/3dmask_tool"],
     "count": bool,
     "datum": typing.NotRequired[typing.Literal["byte", "short", "float"] | None],
     "dilate_inputs": typing.NotRequired[str | None],
@@ -29,43 +45,11 @@ V3dmaskToolParameters = typing.TypedDict('V3dmaskToolParameters', {
     "union": bool,
     "verbose": typing.NotRequired[int | None],
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "3dmask_tool": v_3dmask_tool_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 {
-        "3dmask_tool": v_3dmask_tool_outputs,
-    }.get(t)
 
 
 class V3dmaskToolOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `v_3dmask_tool(...)`.
+    Output object returned when calling `V3dmaskToolParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -89,7 +73,7 @@ def v_3dmask_tool_params(
     outputtype: typing.Literal["NIFTI", "AFNI", "NIFTI_GZ"] | None = None,
     union: bool = False,
     verbose: int | None = None,
-) -> V3dmaskToolParameters:
+) -> V3dmaskToolParametersTagged:
     """
     Build parameters.
     
@@ -120,7 +104,7 @@ def v_3dmask_tool_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "3dmask_tool",
+        "@type": "afni/3dmask_tool",
         "count": count,
         "fill_holes": fill_holes,
         "in_file": in_file,
@@ -161,51 +145,51 @@ def v_3dmask_tool_cargs(
     """
     cargs = []
     cargs.append("3dmask_tool")
-    if params.get("count"):
+    if params.get("count", False):
         cargs.append("-count")
-    if params.get("datum") is not None:
+    if params.get("datum", None) is not None:
         cargs.extend([
             "-datum",
-            params.get("datum")
+            params.get("datum", None)
         ])
-    if params.get("dilate_inputs") is not None:
+    if params.get("dilate_inputs", None) is not None:
         cargs.extend([
             "-dilate_inputs",
-            params.get("dilate_inputs")
+            params.get("dilate_inputs", None)
         ])
-    if params.get("dilate_results") is not None:
+    if params.get("dilate_results", None) is not None:
         cargs.extend([
             "-dilate_results",
-            params.get("dilate_results")
+            params.get("dilate_results", None)
         ])
-    if params.get("fill_dirs") is not None:
+    if params.get("fill_dirs", None) is not None:
         cargs.extend([
             "-fill_dirs",
-            params.get("fill_dirs")
+            params.get("fill_dirs", None)
         ])
-    if params.get("fill_holes"):
+    if params.get("fill_holes", False):
         cargs.append("-fill_holes")
-    if params.get("frac") is not None:
+    if params.get("frac", None) is not None:
         cargs.extend([
             "-frac",
-            str(params.get("frac"))
+            str(params.get("frac", None))
         ])
     cargs.extend([
         "-input",
-        execution.input_file(params.get("in_file"))
+        execution.input_file(params.get("in_file", None))
     ])
-    if params.get("inter"):
+    if params.get("inter", False):
         cargs.append("-inter")
-    if params.get("num_threads") is not None:
-        cargs.append(str(params.get("num_threads")))
-    if params.get("outputtype") is not None:
-        cargs.append(params.get("outputtype"))
-    if params.get("union"):
+    if params.get("num_threads", None) is not None:
+        cargs.append(str(params.get("num_threads", None)))
+    if params.get("outputtype", None) is not None:
+        cargs.append(params.get("outputtype", None))
+    if params.get("union", False):
         cargs.append("-union")
-    if params.get("verbose") is not None:
+    if params.get("verbose", None) is not None:
         cargs.extend([
             "-verb",
-            str(params.get("verbose"))
+            str(params.get("verbose", None))
         ])
     return cargs
 
@@ -225,7 +209,7 @@ def v_3dmask_tool_outputs(
     """
     ret = V3dmaskToolOutputs(
         root=execution.output_file("."),
-        out_file=execution.output_file(pathlib.Path(params.get("in_file")).name + "_mask"),
+        out_file=execution.output_file(pathlib.Path(params.get("in_file", None)).name + "_mask"),
         out_file_=execution.output_file("out_file"),
     )
     return ret
@@ -233,9 +217,11 @@ def v_3dmask_tool_outputs(
 
 def v_3dmask_tool_execute(
     params: V3dmaskToolParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> V3dmaskToolOutputs:
     """
+    3dmask_tool
+    
     3dmask_tool - for combining/dilating/eroding/filling masks.
     
     Author: AFNI Developers
@@ -244,10 +230,12 @@ def v_3dmask_tool_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `V3dmaskToolOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_3DMASK_TOOL_METADATA)
     params = execution.params(params)
     cargs = v_3dmask_tool_cargs(params, execution)
     ret = v_3dmask_tool_outputs(params, execution)
@@ -272,6 +260,8 @@ def v_3dmask_tool(
     runner: Runner | None = None,
 ) -> V3dmaskToolOutputs:
     """
+    3dmask_tool
+    
     3dmask_tool - for combining/dilating/eroding/filling masks.
     
     Author: AFNI Developers
@@ -305,8 +295,6 @@ def v_3dmask_tool(
     Returns:
         NamedTuple of outputs (described in `V3dmaskToolOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(V_3DMASK_TOOL_METADATA)
     params = v_3dmask_tool_params(
         count=count,
         datum=datum,
@@ -322,13 +310,13 @@ def v_3dmask_tool(
         union=union,
         verbose=verbose,
     )
-    return v_3dmask_tool_execute(params, execution)
+    return v_3dmask_tool_execute(params, runner)
 
 
 __all__ = [
     "V3dmaskToolOutputs",
-    "V3dmaskToolParameters",
     "V_3DMASK_TOOL_METADATA",
     "v_3dmask_tool",
+    "v_3dmask_tool_execute",
     "v_3dmask_tool_params",
 ]

niwrap_afni/afni/v_3dmaskave.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 V_3DMASKAVE_METADATA = Metadata(
-    id="c5b975dfce2d2bdf5e26413b56b508d45f7a0ccb.boutiques",
+    id="a7a97cee55262ef3866235d2381e6d9f7bde653b.boutiques",
     name="3dmaskave",
     package="afni",
     container_image_tag="afni/afni_make_build:AFNI_24.2.06",
@@ -14,50 +14,26 @@ V_3DMASKAVE_METADATA = Metadata(
 
 
 V3dmaskaveParameters = typing.TypedDict('V3dmaskaveParameters', {
-    "__STYXTYPE__": typing.Literal["3dmaskave"],
+    "@type": typing.NotRequired[typing.Literal["afni/3dmaskave"]],
+    "in_file": InputPathType,
+    "mask": typing.NotRequired[InputPathType | None],
+    "num_threads": typing.NotRequired[int | None],
+    "outputtype": typing.NotRequired[typing.Literal["NIFTI", "AFNI", "NIFTI_GZ"] | None],
+    "quiet": bool,
+})
+V3dmaskaveParametersTagged = typing.TypedDict('V3dmaskaveParametersTagged', {
+    "@type": typing.Literal["afni/3dmaskave"],
     "in_file": InputPathType,
     "mask": typing.NotRequired[InputPathType | None],
     "num_threads": typing.NotRequired[int | None],
     "outputtype": typing.NotRequired[typing.Literal["NIFTI", "AFNI", "NIFTI_GZ"] | None],
     "quiet": bool,
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "3dmaskave": v_3dmaskave_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 {
-        "3dmaskave": v_3dmaskave_outputs,
-    }.get(t)
 
 
 class V3dmaskaveOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `v_3dmaskave(...)`.
+    Output object returned when calling `V3dmaskaveParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -73,7 +49,7 @@ def v_3dmaskave_params(
     num_threads: int | None = None,
     outputtype: typing.Literal["NIFTI", "AFNI", "NIFTI_GZ"] | None = None,
     quiet: bool = False,
-) -> V3dmaskaveParameters:
+) -> V3dmaskaveParametersTagged:
     """
     Build parameters.
     
@@ -87,7 +63,7 @@ def v_3dmaskave_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "3dmaskave",
+        "@type": "afni/3dmaskave",
         "in_file": in_file,
         "quiet": quiet,
     }
@@ -115,17 +91,17 @@ def v_3dmaskave_cargs(
     """
     cargs = []
     cargs.append("3dmaskave")
-    cargs.append(execution.input_file(params.get("in_file")))
-    if params.get("mask") is not None:
+    cargs.append(execution.input_file(params.get("in_file", None)))
+    if params.get("mask", None) is not None:
         cargs.extend([
             "-mask",
-            execution.input_file(params.get("mask"))
+            execution.input_file(params.get("mask", None))
         ])
-    if params.get("num_threads") is not None:
-        cargs.append(str(params.get("num_threads")))
-    if params.get("outputtype") is not None:
-        cargs.append(params.get("outputtype"))
-    if params.get("quiet"):
+    if params.get("num_threads", None) is not None:
+        cargs.append(str(params.get("num_threads", None)))
+    if params.get("outputtype", None) is not None:
+        cargs.append(params.get("outputtype", None))
+    if params.get("quiet", False):
         cargs.append("-quiet")
     return cargs
 
@@ -145,7 +121,7 @@ def v_3dmaskave_outputs(
     """
     ret = V3dmaskaveOutputs(
         root=execution.output_file("."),
-        out_file=execution.output_file(pathlib.Path(params.get("in_file")).name + "_maskave.1D"),
+        out_file=execution.output_file(pathlib.Path(params.get("in_file", None)).name + "_maskave.1D"),
         out_file_=execution.output_file("out_file"),
     )
     return ret
@@ -153,11 +129,13 @@ def v_3dmaskave_outputs(
 
 def v_3dmaskave_execute(
     params: V3dmaskaveParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> V3dmaskaveOutputs:
     """
-    Computes average of all voxels in the input dataset which satisfy the criterion
-    in the options list.
+    3dmaskave
+    
+    Computes average of all voxels in the input dataset which satisfy the
+    criterion in the options list.
     
     Author: AFNI Developers
     
@@ -165,10 +143,12 @@ def v_3dmaskave_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `V3dmaskaveOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_3DMASKAVE_METADATA)
     params = execution.params(params)
     cargs = v_3dmaskave_cargs(params, execution)
     ret = v_3dmaskave_outputs(params, execution)
@@ -185,8 +165,10 @@ def v_3dmaskave(
     runner: Runner | None = None,
 ) -> V3dmaskaveOutputs:
     """
-    Computes average of all voxels in the input dataset which satisfy the criterion
-    in the options list.
+    3dmaskave
+    
+    Computes average of all voxels in the input dataset which satisfy the
+    criterion in the options list.
     
     Author: AFNI Developers
     
@@ -202,8 +184,6 @@ def v_3dmaskave(
     Returns:
         NamedTuple of outputs (described in `V3dmaskaveOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(V_3DMASKAVE_METADATA)
     params = v_3dmaskave_params(
         in_file=in_file,
         mask=mask,
@@ -211,13 +191,13 @@ def v_3dmaskave(
         outputtype=outputtype,
         quiet=quiet,
     )
-    return v_3dmaskave_execute(params, execution)
+    return v_3dmaskave_execute(params, runner)
 
 
 __all__ = [
     "V3dmaskaveOutputs",
-    "V3dmaskaveParameters",
     "V_3DMASKAVE_METADATA",
     "v_3dmaskave",
+    "v_3dmaskave_execute",
     "v_3dmaskave_params",
 ]