niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/v__djunct_4d_imager.py

@@ -0,0 +1,225 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V__DJUNCT_4D_IMAGER_METADATA = Metadata(
+    id="3dd204eaacbae468c095a2b5730ff8d05c57b1e8.boutiques",
+    name="@djunct_4d_imager",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+VDjunct4dImagerParameters = typing.TypedDict('VDjunct4dImagerParameters', {
+    "__STYX_TYPE__": typing.Literal["@djunct_4d_imager"],
+    "inset": InputPathType,
+    "prefix": str,
+    "do_movie": typing.NotRequired[typing.Literal["MPEG", "AGIF"] | None],
+    "no_clean": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "@djunct_4d_imager": v__djunct_4d_imager_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 {
+        "@djunct_4d_imager": v__djunct_4d_imager_outputs,
+    }.get(t)
+
+
+class VDjunct4dImagerOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v__djunct_4d_imager(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    onescl_png: OutputPathType
+    """Output montage image with constant brightness range"""
+    sepscl_png: OutputPathType
+    """Output montage image with varying brightness range"""
+    onescl_mpeg: OutputPathType
+    """Output movie with constant brightness range (one slice at a time)"""
+    sepscl_mpeg: OutputPathType
+    """Output movie with varying brightness range (one slice at a time)"""
+    onescl_gif: OutputPathType
+    """Output animated GIF with constant brightness range (one slice at a
+    time)"""
+    sepscl_gif: OutputPathType
+    """Output animated GIF with varying brightness range (one slice at a
+    time)"""
+
+
+def v__djunct_4d_imager_params(
+    inset: InputPathType,
+    prefix: str,
+    do_movie: typing.Literal["MPEG", "AGIF"] | None = None,
+    no_clean: bool = False,
+) -> VDjunct4dImagerParameters:
+    """
+    Build parameters.
+    
+    Args:
+        inset: ULay dataset, probably 4D (required).
+        prefix: Prefix for output files (required).
+        do_movie: Specify type of movie file. Options: MPEG, AGIF.
+        no_clean: Keep the final intermediate files.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "@djunct_4d_imager",
+        "inset": inset,
+        "prefix": prefix,
+        "no_clean": no_clean,
+    }
+    if do_movie is not None:
+        params["do_movie"] = do_movie
+    return params
+
+
+def v__djunct_4d_imager_cargs(
+    params: VDjunct4dImagerParameters,
+    execution: Execution,
+) -> list[str]:
+    """
+    Build command-line arguments from parameters.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Command-line arguments.
+    """
+    cargs = []
+    cargs.append("@djunct_4d_imager")
+    cargs.append(execution.input_file(params.get("inset")))
+    cargs.append(params.get("prefix"))
+    if params.get("do_movie") is not None:
+        cargs.extend([
+            "-do_movie",
+            params.get("do_movie")
+        ])
+    if params.get("no_clean"):
+        cargs.append("-no_clean")
+    return cargs
+
+
+def v__djunct_4d_imager_outputs(
+    params: VDjunct4dImagerParameters,
+    execution: Execution,
+) -> VDjunct4dImagerOutputs:
+    """
+    Build outputs object containing output file paths and possibly stdout/stderr.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Outputs object.
+    """
+    ret = VDjunct4dImagerOutputs(
+        root=execution.output_file("."),
+        onescl_png=execution.output_file(params.get("prefix") + "_onescl.png"),
+        sepscl_png=execution.output_file(params.get("prefix") + "_sepscl.png"),
+        onescl_mpeg=execution.output_file(params.get("prefix") + "_onescl.mpg"),
+        sepscl_mpeg=execution.output_file(params.get("prefix") + "_sepscl.mpg"),
+        onescl_gif=execution.output_file(params.get("prefix") + "_onescl.gif"),
+        sepscl_gif=execution.output_file(params.get("prefix") + "_sepscl.gif"),
+    )
+    return ret
+
+
+def v__djunct_4d_imager_execute(
+    params: VDjunct4dImagerParameters,
+    execution: Execution,
+) -> VDjunct4dImagerOutputs:
+    """
+    The program is useful for viewing the same slice across the 'time' dimension of
+    a 4D data set.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VDjunct4dImagerOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v__djunct_4d_imager_cargs(params, execution)
+    ret = v__djunct_4d_imager_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v__djunct_4d_imager(
+    inset: InputPathType,
+    prefix: str,
+    do_movie: typing.Literal["MPEG", "AGIF"] | None = None,
+    no_clean: bool = False,
+    runner: Runner | None = None,
+) -> VDjunct4dImagerOutputs:
+    """
+    The program is useful for viewing the same slice across the 'time' dimension of
+    a 4D data set.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        inset: ULay dataset, probably 4D (required).
+        prefix: Prefix for output files (required).
+        do_movie: Specify type of movie file. Options: MPEG, AGIF.
+        no_clean: Keep the final intermediate files.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VDjunct4dImagerOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V__DJUNCT_4D_IMAGER_METADATA)
+    params = v__djunct_4d_imager_params(
+        inset=inset,
+        prefix=prefix,
+        do_movie=do_movie,
+        no_clean=no_clean,
+    )
+    return v__djunct_4d_imager_execute(params, execution)
+
+
+__all__ = [
+    "VDjunct4dImagerOutputs",
+    "VDjunct4dImagerParameters",
+    "V__DJUNCT_4D_IMAGER_METADATA",
+    "v__djunct_4d_imager",
+    "v__djunct_4d_imager_params",
+]

niwrap_afni/afni/v__djunct_4d_slices_to_3d_vol.py

@@ -0,0 +1,177 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V__DJUNCT_4D_SLICES_TO_3D_VOL_METADATA = Metadata(
+    id="e85dbe20324eef240907de23abb203630c5e1180.boutiques",
+    name="@djunct_4d_slices_to_3d_vol",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+VDjunct4dSlicesTo3dVolParameters = typing.TypedDict('VDjunct4dSlicesTo3dVolParameters', {
+    "__STYX_TYPE__": typing.Literal["@djunct_4d_slices_to_3d_vol"],
+    "do_something": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "@djunct_4d_slices_to_3d_vol": v__djunct_4d_slices_to_3d_vol_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 {
+        "@djunct_4d_slices_to_3d_vol": v__djunct_4d_slices_to_3d_vol_outputs,
+    }.get(t)
+
+
+class VDjunct4dSlicesTo3dVolOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v__djunct_4d_slices_to_3d_vol(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    outfile: OutputPathType
+    """Output file generated by the tool"""
+
+
+def v__djunct_4d_slices_to_3d_vol_params(
+    do_something: bool = False,
+) -> VDjunct4dSlicesTo3dVolParameters:
+    """
+    Build parameters.
+    
+    Args:
+        do_something: Do something really useful.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "@djunct_4d_slices_to_3d_vol",
+        "do_something": do_something,
+    }
+    return params
+
+
+def v__djunct_4d_slices_to_3d_vol_cargs(
+    params: VDjunct4dSlicesTo3dVolParameters,
+    execution: Execution,
+) -> list[str]:
+    """
+    Build command-line arguments from parameters.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Command-line arguments.
+    """
+    cargs = []
+    cargs.append("@djunct_4d_slices_to_3d_vol")
+    if params.get("do_something"):
+        cargs.append("-do-something")
+    return cargs
+
+
+def v__djunct_4d_slices_to_3d_vol_outputs(
+    params: VDjunct4dSlicesTo3dVolParameters,
+    execution: Execution,
+) -> VDjunct4dSlicesTo3dVolOutputs:
+    """
+    Build outputs object containing output file paths and possibly stdout/stderr.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Outputs object.
+    """
+    ret = VDjunct4dSlicesTo3dVolOutputs(
+        root=execution.output_file("."),
+        outfile=execution.output_file("output_file"),
+    )
+    return ret
+
+
+def v__djunct_4d_slices_to_3d_vol_execute(
+    params: VDjunct4dSlicesTo3dVolParameters,
+    execution: Execution,
+) -> VDjunct4dSlicesTo3dVolOutputs:
+    """
+    Tool description goes here.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VDjunct4dSlicesTo3dVolOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v__djunct_4d_slices_to_3d_vol_cargs(params, execution)
+    ret = v__djunct_4d_slices_to_3d_vol_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v__djunct_4d_slices_to_3d_vol(
+    do_something: bool = False,
+    runner: Runner | None = None,
+) -> VDjunct4dSlicesTo3dVolOutputs:
+    """
+    Tool description goes here.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        do_something: Do something really useful.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VDjunct4dSlicesTo3dVolOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V__DJUNCT_4D_SLICES_TO_3D_VOL_METADATA)
+    params = v__djunct_4d_slices_to_3d_vol_params(
+        do_something=do_something,
+    )
+    return v__djunct_4d_slices_to_3d_vol_execute(params, execution)
+
+
+__all__ = [
+    "VDjunct4dSlicesTo3dVolOutputs",
+    "VDjunct4dSlicesTo3dVolParameters",
+    "V__DJUNCT_4D_SLICES_TO_3D_VOL_METADATA",
+    "v__djunct_4d_slices_to_3d_vol",
+    "v__djunct_4d_slices_to_3d_vol_params",
+]

niwrap_afni/afni/v__djunct_anonymize.py

@@ -0,0 +1,207 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V__DJUNCT_ANONYMIZE_METADATA = Metadata(
+    id="b39c604a1cb220842f1bff1090f5403b2eb497f0.boutiques",
+    name="@djunct_anonymize",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+VDjunctAnonymizeParameters = typing.TypedDict('VDjunctAnonymizeParameters', {
+    "__STYX_TYPE__": typing.Literal["@djunct_anonymize"],
+    "input": InputPathType,
+    "add_note": typing.NotRequired[str | None],
+    "copy_to": typing.NotRequired[InputPathType | None],
+    "overwrite": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "@djunct_anonymize": v__djunct_anonymize_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)
+
+
+class VDjunctAnonymizeOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v__djunct_anonymize(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def v__djunct_anonymize_params(
+    input_: InputPathType,
+    add_note: str | None = None,
+    copy_to: InputPathType | None = None,
+    overwrite: bool = False,
+) -> VDjunctAnonymizeParameters:
+    """
+    Build parameters.
+    
+    Args:
+        input_: Input dataset.
+        add_note: Add a note to the history after anonymizing.
+        copy_to: Copy the input to a new file, which is then anonymized.
+        overwrite: Overwrite the existing file if using -copy_to.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "@djunct_anonymize",
+        "input": input_,
+        "overwrite": overwrite,
+    }
+    if add_note is not None:
+        params["add_note"] = add_note
+    if copy_to is not None:
+        params["copy_to"] = copy_to
+    return params
+
+
+def v__djunct_anonymize_cargs(
+    params: VDjunctAnonymizeParameters,
+    execution: Execution,
+) -> list[str]:
+    """
+    Build command-line arguments from parameters.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Command-line arguments.
+    """
+    cargs = []
+    cargs.append("@djunct_anonymize")
+    cargs.append(execution.input_file(params.get("input")))
+    if params.get("add_note") is not None:
+        cargs.extend([
+            "-add_note",
+            params.get("add_note")
+        ])
+    if params.get("copy_to") is not None:
+        cargs.extend([
+            "-copy_to",
+            execution.input_file(params.get("copy_to"))
+        ])
+    if params.get("overwrite"):
+        cargs.append("-overwrite")
+    return cargs
+
+
+def v__djunct_anonymize_outputs(
+    params: VDjunctAnonymizeParameters,
+    execution: Execution,
+) -> VDjunctAnonymizeOutputs:
+    """
+    Build outputs object containing output file paths and possibly stdout/stderr.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Outputs object.
+    """
+    ret = VDjunctAnonymizeOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def v__djunct_anonymize_execute(
+    params: VDjunctAnonymizeParameters,
+    execution: Execution,
+) -> VDjunctAnonymizeOutputs:
+    """
+    Helper program to anonymize files.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VDjunctAnonymizeOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v__djunct_anonymize_cargs(params, execution)
+    ret = v__djunct_anonymize_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v__djunct_anonymize(
+    input_: InputPathType,
+    add_note: str | None = None,
+    copy_to: InputPathType | None = None,
+    overwrite: bool = False,
+    runner: Runner | None = None,
+) -> VDjunctAnonymizeOutputs:
+    """
+    Helper program to anonymize files.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        input_: Input dataset.
+        add_note: Add a note to the history after anonymizing.
+        copy_to: Copy the input to a new file, which is then anonymized.
+        overwrite: Overwrite the existing file if using -copy_to.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VDjunctAnonymizeOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V__DJUNCT_ANONYMIZE_METADATA)
+    params = v__djunct_anonymize_params(
+        input_=input_,
+        add_note=add_note,
+        copy_to=copy_to,
+        overwrite=overwrite,
+    )
+    return v__djunct_anonymize_execute(params, execution)
+
+
+__all__ = [
+    "VDjunctAnonymizeOutputs",
+    "VDjunctAnonymizeParameters",
+    "V__DJUNCT_ANONYMIZE_METADATA",
+    "v__djunct_anonymize",
+    "v__djunct_anonymize_params",
+]