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

niwrap_afni/afni/v_3d_tcorrelate.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 V_3D_TCORRELATE_METADATA = Metadata(
-    id="ecc97c11254ea3d0a351c5592302c585980958d1.boutiques",
+    id="a3ab8a0beffb40435bf40983a8b4de8e9d88e384.boutiques",
     name="3dTcorrelate",
     package="afni",
     container_image_tag="afni/afni_make_build:AFNI_24.2.06",
@@ -14,7 +14,26 @@ V_3D_TCORRELATE_METADATA = Metadata(
 
 
 V3dTcorrelateParameters = typing.TypedDict('V3dTcorrelateParameters', {
-    "__STYXTYPE__": typing.Literal["3dTcorrelate"],
+    "@type": typing.NotRequired[typing.Literal["afni/3dTcorrelate"]],
+    "xset": InputPathType,
+    "yset": InputPathType,
+    "pearson": bool,
+    "spearman": bool,
+    "quadrant": bool,
+    "ktaub": bool,
+    "covariance": bool,
+    "partial": typing.NotRequired[InputPathType | None],
+    "ycoef": bool,
+    "fisher": bool,
+    "polort": typing.NotRequired[int | None],
+    "ort": typing.NotRequired[InputPathType | None],
+    "autoclip": bool,
+    "automask": bool,
+    "zcensor": bool,
+    "prefix": typing.NotRequired[str | None],
+})
+V3dTcorrelateParametersTagged = typing.TypedDict('V3dTcorrelateParametersTagged', {
+    "@type": typing.Literal["afni/3dTcorrelate"],
     "xset": InputPathType,
     "yset": InputPathType,
     "pearson": bool,
@@ -32,43 +51,11 @@ V3dTcorrelateParameters = typing.TypedDict('V3dTcorrelateParameters', {
     "zcensor": bool,
     "prefix": 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 {
-        "3dTcorrelate": v_3d_tcorrelate_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 {
-        "3dTcorrelate": v_3d_tcorrelate_outputs,
-    }.get(t)
 
 
 class V3dTcorrelateOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `v_3d_tcorrelate(...)`.
+    Output object returned when calling `V3dTcorrelateParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -93,7 +80,7 @@ def v_3d_tcorrelate_params(
     automask: bool = False,
     zcensor: bool = False,
     prefix: str | None = None,
-) -> V3dTcorrelateParameters:
+) -> V3dTcorrelateParametersTagged:
     """
     Build parameters.
     
@@ -138,7 +125,7 @@ def v_3d_tcorrelate_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "3dTcorrelate",
+        "@type": "afni/3dTcorrelate",
         "xset": xset,
         "yset": yset,
         "pearson": pearson,
@@ -178,47 +165,47 @@ def v_3d_tcorrelate_cargs(
     """
     cargs = []
     cargs.append("3dTcorrelate")
-    cargs.append(execution.input_file(params.get("xset")))
-    cargs.append(execution.input_file(params.get("yset")))
-    if params.get("pearson"):
+    cargs.append(execution.input_file(params.get("xset", None)))
+    cargs.append(execution.input_file(params.get("yset", None)))
+    if params.get("pearson", False):
         cargs.append("-pearson")
-    if params.get("spearman"):
+    if params.get("spearman", False):
         cargs.append("-spearman")
-    if params.get("quadrant"):
+    if params.get("quadrant", False):
         cargs.append("-quadrant")
-    if params.get("ktaub"):
+    if params.get("ktaub", False):
         cargs.append("-ktaub")
-    if params.get("covariance"):
+    if params.get("covariance", False):
         cargs.append("-covariance")
-    if params.get("partial") is not None:
+    if params.get("partial", None) is not None:
         cargs.extend([
             "-partial",
-            execution.input_file(params.get("partial"))
+            execution.input_file(params.get("partial", None))
         ])
-    if params.get("ycoef"):
+    if params.get("ycoef", False):
         cargs.append("-ycoef")
-    if params.get("fisher"):
+    if params.get("fisher", False):
         cargs.append("-Fisher")
-    if params.get("polort") is not None:
+    if params.get("polort", None) is not None:
         cargs.extend([
             "-polort",
-            str(params.get("polort"))
+            str(params.get("polort", None))
         ])
-    if params.get("ort") is not None:
+    if params.get("ort", None) is not None:
         cargs.extend([
             "-ort",
-            execution.input_file(params.get("ort"))
+            execution.input_file(params.get("ort", None))
         ])
-    if params.get("autoclip"):
+    if params.get("autoclip", False):
         cargs.append("-autoclip")
-    if params.get("automask"):
+    if params.get("automask", False):
         cargs.append("-automask")
-    if params.get("zcensor"):
+    if params.get("zcensor", False):
         cargs.append("-zcensor")
-    if params.get("prefix") is not None:
+    if params.get("prefix", None) is not None:
         cargs.extend([
             "-prefix",
-            params.get("prefix")
+            params.get("prefix", None)
         ])
     return cargs
 
@@ -238,18 +225,20 @@ def v_3d_tcorrelate_outputs(
     """
     ret = V3dTcorrelateOutputs(
         root=execution.output_file("."),
-        out_file=execution.output_file(params.get("prefix")) if (params.get("prefix") is not None) else None,
+        out_file=execution.output_file(params.get("prefix", None)) if (params.get("prefix") is not None) else None,
     )
     return ret
 
 
 def v_3d_tcorrelate_execute(
     params: V3dTcorrelateParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> V3dTcorrelateOutputs:
     """
-    3dTcorrelate. Computes the correlation coefficient between corresponding voxel
-    time series in two input 3D+time datasets 'xset' and 'yset'.
+    3dTcorrelate
+    
+    3dTcorrelate. Computes the correlation coefficient between corresponding
+    voxel time series in two input 3D+time datasets 'xset' and 'yset'.
     
     Author: AFNI Developers
     
@@ -257,10 +246,12 @@ def v_3d_tcorrelate_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `V3dTcorrelateOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_3D_TCORRELATE_METADATA)
     params = execution.params(params)
     cargs = v_3d_tcorrelate_cargs(params, execution)
     ret = v_3d_tcorrelate_outputs(params, execution)
@@ -288,8 +279,10 @@ def v_3d_tcorrelate(
     runner: Runner | None = None,
 ) -> V3dTcorrelateOutputs:
     """
-    3dTcorrelate. Computes the correlation coefficient between corresponding voxel
-    time series in two input 3D+time datasets 'xset' and 'yset'.
+    3dTcorrelate
+    
+    3dTcorrelate. Computes the correlation coefficient between corresponding
+    voxel time series in two input 3D+time datasets 'xset' and 'yset'.
     
     Author: AFNI Developers
     
@@ -336,8 +329,6 @@ def v_3d_tcorrelate(
     Returns:
         NamedTuple of outputs (described in `V3dTcorrelateOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(V_3D_TCORRELATE_METADATA)
     params = v_3d_tcorrelate_params(
         xset=xset,
         yset=yset,
@@ -356,13 +347,13 @@ def v_3d_tcorrelate(
         zcensor=zcensor,
         prefix=prefix,
     )
-    return v_3d_tcorrelate_execute(params, execution)
+    return v_3d_tcorrelate_execute(params, runner)
 
 
 __all__ = [
     "V3dTcorrelateOutputs",
-    "V3dTcorrelateParameters",
     "V_3D_TCORRELATE_METADATA",
     "v_3d_tcorrelate",
+    "v_3d_tcorrelate_execute",
     "v_3d_tcorrelate_params",
 ]

niwrap_afni/afni/v_3d_tfilter.py

@@ -6,7 +6,7 @@ import pathlib
 from styxdefs import *
 
 V_3D_TFILTER_METADATA = Metadata(
-    id="806ba81a851aeaa8b72fdcc2ee762dd9eadeb854.boutiques",
+    id="3297bc9e743e70fe53ae189965f0b3c2844915ef.boutiques",
     name="3dTfilter",
     package="afni",
     container_image_tag="afni/afni_make_build:AFNI_24.2.06",
@@ -14,48 +14,22 @@ V_3D_TFILTER_METADATA = Metadata(
 
 
 V3dTfilterParameters = typing.TypedDict('V3dTfilterParameters', {
-    "__STYXTYPE__": typing.Literal["3dTfilter"],
+    "@type": typing.NotRequired[typing.Literal["afni/3dTfilter"]],
+    "inputdataset": InputPathType,
+    "outputdataset": str,
+    "filters": list[str],
+})
+V3dTfilterParametersTagged = typing.TypedDict('V3dTfilterParametersTagged', {
+    "@type": typing.Literal["afni/3dTfilter"],
     "inputdataset": InputPathType,
     "outputdataset": str,
     "filters": list[str],
 })
-
-
-def dyn_cargs(
-    t: str,
-) -> typing.Any:
-    """
-    Get build cargs function by command type.
-    
-    Args:
-        t: Command type.
-    Returns:
-        Build cargs function.
-    """
-    return {
-        "3dTfilter": v_3d_tfilter_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 {
-        "3dTfilter": v_3d_tfilter_outputs,
-    }.get(t)
 
 
 class V3dTfilterOutputs(typing.NamedTuple):
     """
-    Output object returned when calling `v_3d_tfilter(...)`.
+    Output object returned when calling `V3dTfilterParameters(...)`.
     """
     root: OutputPathType
     """Output root folder. This is the root folder for all outputs."""
@@ -67,7 +41,7 @@ def v_3d_tfilter_params(
     inputdataset: InputPathType,
     outputdataset: str,
     filters: list[str],
-) -> V3dTfilterParameters:
+) -> V3dTfilterParametersTagged:
     """
     Build parameters.
     
@@ -79,7 +53,7 @@ def v_3d_tfilter_params(
         Parameter dictionary
     """
     params = {
-        "__STYXTYPE__": "3dTfilter",
+        "@type": "afni/3dTfilter",
         "inputdataset": inputdataset,
         "outputdataset": outputdataset,
         "filters": filters,
@@ -104,15 +78,15 @@ def v_3d_tfilter_cargs(
     cargs.append("3dTfilter")
     cargs.extend([
         "-input",
-        execution.input_file(params.get("inputdataset"))
+        execution.input_file(params.get("inputdataset", None))
     ])
     cargs.extend([
         "-prefix",
-        params.get("outputdataset")
+        params.get("outputdataset", None)
     ])
     cargs.extend([
         "-filter",
-        *params.get("filters")
+        *params.get("filters", None)
     ])
     return cargs
 
@@ -132,18 +106,20 @@ def v_3d_tfilter_outputs(
     """
     ret = V3dTfilterOutputs(
         root=execution.output_file("."),
-        output_dataset=execution.output_file(params.get("outputdataset")),
+        output_dataset=execution.output_file(params.get("outputdataset", None)),
     )
     return ret
 
 
 def v_3d_tfilter_execute(
     params: V3dTfilterParameters,
-    execution: Execution,
+    runner: Runner | None = None,
 ) -> V3dTfilterOutputs:
     """
-    3dTfilter filters the time series in each voxel according to the user-specified
-    filter functions.
+    3dTfilter
+    
+    3dTfilter filters the time series in each voxel according to the
+    user-specified filter functions.
     
     Author: AFNI Developers
     
@@ -151,10 +127,12 @@ def v_3d_tfilter_execute(
     
     Args:
         params: The parameters.
-        execution: The execution object.
+        runner: Command runner.
     Returns:
         NamedTuple of outputs (described in `V3dTfilterOutputs`).
     """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_3D_TFILTER_METADATA)
     params = execution.params(params)
     cargs = v_3d_tfilter_cargs(params, execution)
     ret = v_3d_tfilter_outputs(params, execution)
@@ -169,8 +147,10 @@ def v_3d_tfilter(
     runner: Runner | None = None,
 ) -> V3dTfilterOutputs:
     """
-    3dTfilter filters the time series in each voxel according to the user-specified
-    filter functions.
+    3dTfilter
+    
+    3dTfilter filters the time series in each voxel according to the
+    user-specified filter functions.
     
     Author: AFNI Developers
     
@@ -184,20 +164,18 @@ def v_3d_tfilter(
     Returns:
         NamedTuple of outputs (described in `V3dTfilterOutputs`).
     """
-    runner = runner or get_global_runner()
-    execution = runner.start_execution(V_3D_TFILTER_METADATA)
     params = v_3d_tfilter_params(
         inputdataset=inputdataset,
         outputdataset=outputdataset,
         filters=filters,
     )
-    return v_3d_tfilter_execute(params, execution)
+    return v_3d_tfilter_execute(params, runner)
 
 
 __all__ = [
     "V3dTfilterOutputs",
-    "V3dTfilterParameters",
     "V_3D_TFILTER_METADATA",
     "v_3d_tfilter",
+    "v_3d_tfilter_execute",
     "v_3d_tfilter_params",
 ]