niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/plugout_ijk.py

@@ -0,0 +1,297 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+PLUGOUT_IJK_METADATA = Metadata(
+    id="546af73f34fcb7f296f73da1cc63ae4ec231fec2.boutiques",
+    name="plugout_ijk",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+PlugoutIjkParameters = typing.TypedDict('PlugoutIjkParameters', {
+    "__STYX_TYPE__": typing.Literal["plugout_ijk"],
+    "host": typing.NotRequired[str | None],
+    "verbose": bool,
+    "port": typing.NotRequired[float | None],
+    "name": typing.NotRequired[str | None],
+    "port_offset": typing.NotRequired[float | None],
+    "port_quiet": typing.NotRequired[float | None],
+    "port_bloc_offset": typing.NotRequired[float | None],
+    "max_bloc": bool,
+    "max_bloc_quiet": bool,
+    "num_assigned_ports": bool,
+    "num_assigned_ports_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 {
+        "plugout_ijk": plugout_ijk_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 PlugoutIjkOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `plugout_ijk(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def plugout_ijk_params(
+    host: str | None = None,
+    verbose: bool = False,
+    port: float | None = None,
+    name: str | None = None,
+    port_offset: float | None = None,
+    port_quiet: float | None = None,
+    port_bloc_offset: float | None = None,
+    max_bloc: bool = False,
+    max_bloc_quiet: bool = False,
+    num_assigned_ports: bool = False,
+    num_assigned_ports_quiet: bool = False,
+) -> PlugoutIjkParameters:
+    """
+    Build parameters.
+    
+    Args:
+        host: Connect to AFNI running on the specified computer using TCP/IP.
+        verbose: Verbose mode.
+        port: Use TCP/IP port number 'pp'.
+        name: Use the string 'sss' for the name that AFNI assigns to this\
+            plugout.
+        port_offset: Provide a port offset to allow multiple instances of\
+            communicating programs to operate on the same machine.
+        port_quiet: Provide a port offset like -np, but more quiet in the face\
+            of adversity.
+        port_bloc_offset: Provide a port offset block for easier port\
+            management.
+        max_bloc: Print the current value of MAX_BLOC and exit.
+        max_bloc_quiet: Print MAX_BLOC value only and exit.
+        num_assigned_ports: Print the number of assigned ports used by AFNI\
+            then quit.
+        num_assigned_ports_quiet: Prints the number of assigned ports quietly.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "plugout_ijk",
+        "verbose": verbose,
+        "max_bloc": max_bloc,
+        "max_bloc_quiet": max_bloc_quiet,
+        "num_assigned_ports": num_assigned_ports,
+        "num_assigned_ports_quiet": num_assigned_ports_quiet,
+    }
+    if host is not None:
+        params["host"] = host
+    if port is not None:
+        params["port"] = port
+    if name is not None:
+        params["name"] = name
+    if port_offset is not None:
+        params["port_offset"] = port_offset
+    if port_quiet is not None:
+        params["port_quiet"] = port_quiet
+    if port_bloc_offset is not None:
+        params["port_bloc_offset"] = port_bloc_offset
+    return params
+
+
+def plugout_ijk_cargs(
+    params: PlugoutIjkParameters,
+    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("plugout_ijk")
+    if params.get("host") is not None:
+        cargs.extend([
+            "-host",
+            params.get("host")
+        ])
+    if params.get("verbose"):
+        cargs.append("-v")
+    if params.get("port") is not None:
+        cargs.extend([
+            "-port",
+            str(params.get("port"))
+        ])
+    if params.get("name") is not None:
+        cargs.extend([
+            "-name",
+            params.get("name")
+        ])
+    if params.get("port_offset") is not None:
+        cargs.extend([
+            "-np",
+            str(params.get("port_offset"))
+        ])
+    if params.get("port_quiet") is not None:
+        cargs.extend([
+            "-npq",
+            str(params.get("port_quiet"))
+        ])
+    if params.get("port_bloc_offset") is not None:
+        cargs.extend([
+            "-npb",
+            str(params.get("port_bloc_offset"))
+        ])
+    if params.get("max_bloc"):
+        cargs.append("-max_port_bloc")
+    if params.get("max_bloc_quiet"):
+        cargs.append("-max_port_bloc_quiet")
+    if params.get("num_assigned_ports"):
+        cargs.append("-num_assigned_ports")
+    if params.get("num_assigned_ports_quiet"):
+        cargs.append("-num_assigned_ports_quiet")
+    return cargs
+
+
+def plugout_ijk_outputs(
+    params: PlugoutIjkParameters,
+    execution: Execution,
+) -> PlugoutIjkOutputs:
+    """
+    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 = PlugoutIjkOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def plugout_ijk_execute(
+    params: PlugoutIjkParameters,
+    execution: Execution,
+) -> PlugoutIjkOutputs:
+    """
+    Connects to AFNI and sends (i,j,k) dataset indices to control the viewpoint.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `PlugoutIjkOutputs`).
+    """
+    params = execution.params(params)
+    cargs = plugout_ijk_cargs(params, execution)
+    ret = plugout_ijk_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def plugout_ijk(
+    host: str | None = None,
+    verbose: bool = False,
+    port: float | None = None,
+    name: str | None = None,
+    port_offset: float | None = None,
+    port_quiet: float | None = None,
+    port_bloc_offset: float | None = None,
+    max_bloc: bool = False,
+    max_bloc_quiet: bool = False,
+    num_assigned_ports: bool = False,
+    num_assigned_ports_quiet: bool = False,
+    runner: Runner | None = None,
+) -> PlugoutIjkOutputs:
+    """
+    Connects to AFNI and sends (i,j,k) dataset indices to control the viewpoint.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        host: Connect to AFNI running on the specified computer using TCP/IP.
+        verbose: Verbose mode.
+        port: Use TCP/IP port number 'pp'.
+        name: Use the string 'sss' for the name that AFNI assigns to this\
+            plugout.
+        port_offset: Provide a port offset to allow multiple instances of\
+            communicating programs to operate on the same machine.
+        port_quiet: Provide a port offset like -np, but more quiet in the face\
+            of adversity.
+        port_bloc_offset: Provide a port offset block for easier port\
+            management.
+        max_bloc: Print the current value of MAX_BLOC and exit.
+        max_bloc_quiet: Print MAX_BLOC value only and exit.
+        num_assigned_ports: Print the number of assigned ports used by AFNI\
+            then quit.
+        num_assigned_ports_quiet: Prints the number of assigned ports quietly.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `PlugoutIjkOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(PLUGOUT_IJK_METADATA)
+    params = plugout_ijk_params(
+        host=host,
+        verbose=verbose,
+        port=port,
+        name=name,
+        port_offset=port_offset,
+        port_quiet=port_quiet,
+        port_bloc_offset=port_bloc_offset,
+        max_bloc=max_bloc,
+        max_bloc_quiet=max_bloc_quiet,
+        num_assigned_ports=num_assigned_ports,
+        num_assigned_ports_quiet=num_assigned_ports_quiet,
+    )
+    return plugout_ijk_execute(params, execution)
+
+
+__all__ = [
+    "PLUGOUT_IJK_METADATA",
+    "PlugoutIjkOutputs",
+    "PlugoutIjkParameters",
+    "plugout_ijk",
+    "plugout_ijk_params",
+]

niwrap_afni/afni/plugout_tt.py

@@ -0,0 +1,326 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+PLUGOUT_TT_METADATA = Metadata(
+    id="ba7ffb9cb6205a1d454721d39cc9b04cfa68ec9a.boutiques",
+    name="plugout_tt",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+PlugoutTtParameters = typing.TypedDict('PlugoutTtParameters', {
+    "__STYX_TYPE__": typing.Literal["plugout_tt"],
+    "host": typing.NotRequired[str | None],
+    "ijk_option": bool,
+    "verbose": bool,
+    "port": typing.NotRequired[float | None],
+    "name": typing.NotRequired[str | None],
+    "port_offset": typing.NotRequired[float | None],
+    "port_offset_quiet": typing.NotRequired[float | None],
+    "port_bloc": typing.NotRequired[float | None],
+    "max_port_bloc": bool,
+    "max_port_bloc_quiet": bool,
+    "num_assigned_ports": bool,
+    "num_assigned_ports_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 {
+        "plugout_tt": plugout_tt_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 PlugoutTtOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `plugout_tt(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def plugout_tt_params(
+    host: str | None = None,
+    ijk_option: bool = False,
+    verbose: bool = False,
+    port: float | None = None,
+    name: str | None = None,
+    port_offset: float | None = None,
+    port_offset_quiet: float | None = None,
+    port_bloc: float | None = None,
+    max_port_bloc: bool = False,
+    max_port_bloc_quiet: bool = False,
+    num_assigned_ports: bool = False,
+    num_assigned_ports_quiet: bool = False,
+) -> PlugoutTtParameters:
+    """
+    Build parameters.
+    
+    Args:
+        host: Name of the host computer to connect to AFNI on. The default is\
+            to connect on the current host using shared memory.
+        ijk_option: Get voxel indices from AFNI instead of Talairach\
+            coordinates.
+        verbose: Enable verbose mode (prints lots of diagnostic messages).
+        port: TCP/IP port number to use. The default is 8001.
+        name: String to use as the name that AFNI assigns to this plugout. The\
+            default is something silly.
+        port_offset: Provide a port offset to allow multiple instances of\
+            communicating programs to operate on the same computer. Use an integer\
+            in the inclusive range [1025 to 65500].
+        port_offset_quiet: Provide a port offset to allow multiple instances of\
+            communicating programs to operate on the same computer with quiet\
+            output in case of issues. Use an integer in the inclusive range [1025\
+            to 65500].
+        port_bloc: Provide a port offset bloc for easier configuration of\
+            multiple instances. PORT_OFFSET_BLOC is an integer between 0 and\
+            MAX_BLOC (around 4000).
+        max_port_bloc: Print the current value of MAX_BLOC and exit. Stay under\
+            2000 for safety.
+        max_port_bloc_quiet: Print the current value of MAX_BLOC quietly and\
+            exit.
+        num_assigned_ports: Print the number of assigned ports used by AFNI,\
+            then quit.
+        num_assigned_ports_quiet: Print the number of assigned ports used by\
+            AFNI quietly, then quit.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "plugout_tt",
+        "ijk_option": ijk_option,
+        "verbose": verbose,
+        "max_port_bloc": max_port_bloc,
+        "max_port_bloc_quiet": max_port_bloc_quiet,
+        "num_assigned_ports": num_assigned_ports,
+        "num_assigned_ports_quiet": num_assigned_ports_quiet,
+    }
+    if host is not None:
+        params["host"] = host
+    if port is not None:
+        params["port"] = port
+    if name is not None:
+        params["name"] = name
+    if port_offset is not None:
+        params["port_offset"] = port_offset
+    if port_offset_quiet is not None:
+        params["port_offset_quiet"] = port_offset_quiet
+    if port_bloc is not None:
+        params["port_bloc"] = port_bloc
+    return params
+
+
+def plugout_tt_cargs(
+    params: PlugoutTtParameters,
+    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("plugout_tt")
+    if params.get("host") is not None:
+        cargs.extend([
+            "-host",
+            params.get("host")
+        ])
+    if params.get("ijk_option"):
+        cargs.append("-ijk")
+    if params.get("verbose"):
+        cargs.append("-v")
+    if params.get("port") is not None:
+        cargs.extend([
+            "-port",
+            str(params.get("port"))
+        ])
+    if params.get("name") is not None:
+        cargs.extend([
+            "-name",
+            params.get("name")
+        ])
+    if params.get("port_offset") is not None:
+        cargs.extend([
+            "-np",
+            str(params.get("port_offset"))
+        ])
+    if params.get("port_offset_quiet") is not None:
+        cargs.extend([
+            "-npq",
+            str(params.get("port_offset_quiet"))
+        ])
+    if params.get("port_bloc") is not None:
+        cargs.extend([
+            "-npb",
+            str(params.get("port_bloc"))
+        ])
+    if params.get("max_port_bloc"):
+        cargs.append("-max_port_bloc")
+    if params.get("max_port_bloc_quiet"):
+        cargs.append("-max_port_bloc_quiet")
+    if params.get("num_assigned_ports"):
+        cargs.append("-num_assigned_ports")
+    if params.get("num_assigned_ports_quiet"):
+        cargs.append("-num_assigned_ports_quiet")
+    return cargs
+
+
+def plugout_tt_outputs(
+    params: PlugoutTtParameters,
+    execution: Execution,
+) -> PlugoutTtOutputs:
+    """
+    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 = PlugoutTtOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def plugout_tt_execute(
+    params: PlugoutTtParameters,
+    execution: Execution,
+) -> PlugoutTtOutputs:
+    """
+    This program connects to AFNI and receives notification whenever the user
+    changes Talairach coordinates.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `PlugoutTtOutputs`).
+    """
+    params = execution.params(params)
+    cargs = plugout_tt_cargs(params, execution)
+    ret = plugout_tt_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def plugout_tt(
+    host: str | None = None,
+    ijk_option: bool = False,
+    verbose: bool = False,
+    port: float | None = None,
+    name: str | None = None,
+    port_offset: float | None = None,
+    port_offset_quiet: float | None = None,
+    port_bloc: float | None = None,
+    max_port_bloc: bool = False,
+    max_port_bloc_quiet: bool = False,
+    num_assigned_ports: bool = False,
+    num_assigned_ports_quiet: bool = False,
+    runner: Runner | None = None,
+) -> PlugoutTtOutputs:
+    """
+    This program connects to AFNI and receives notification whenever the user
+    changes Talairach coordinates.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        host: Name of the host computer to connect to AFNI on. The default is\
+            to connect on the current host using shared memory.
+        ijk_option: Get voxel indices from AFNI instead of Talairach\
+            coordinates.
+        verbose: Enable verbose mode (prints lots of diagnostic messages).
+        port: TCP/IP port number to use. The default is 8001.
+        name: String to use as the name that AFNI assigns to this plugout. The\
+            default is something silly.
+        port_offset: Provide a port offset to allow multiple instances of\
+            communicating programs to operate on the same computer. Use an integer\
+            in the inclusive range [1025 to 65500].
+        port_offset_quiet: Provide a port offset to allow multiple instances of\
+            communicating programs to operate on the same computer with quiet\
+            output in case of issues. Use an integer in the inclusive range [1025\
+            to 65500].
+        port_bloc: Provide a port offset bloc for easier configuration of\
+            multiple instances. PORT_OFFSET_BLOC is an integer between 0 and\
+            MAX_BLOC (around 4000).
+        max_port_bloc: Print the current value of MAX_BLOC and exit. Stay under\
+            2000 for safety.
+        max_port_bloc_quiet: Print the current value of MAX_BLOC quietly and\
+            exit.
+        num_assigned_ports: Print the number of assigned ports used by AFNI,\
+            then quit.
+        num_assigned_ports_quiet: Print the number of assigned ports used by\
+            AFNI quietly, then quit.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `PlugoutTtOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(PLUGOUT_TT_METADATA)
+    params = plugout_tt_params(
+        host=host,
+        ijk_option=ijk_option,
+        verbose=verbose,
+        port=port,
+        name=name,
+        port_offset=port_offset,
+        port_offset_quiet=port_offset_quiet,
+        port_bloc=port_bloc,
+        max_port_bloc=max_port_bloc,
+        max_port_bloc_quiet=max_port_bloc_quiet,
+        num_assigned_ports=num_assigned_ports,
+        num_assigned_ports_quiet=num_assigned_ports_quiet,
+    )
+    return plugout_tt_execute(params, execution)
+
+
+__all__ = [
+    "PLUGOUT_TT_METADATA",
+    "PlugoutTtOutputs",
+    "PlugoutTtParameters",
+    "plugout_tt",
+    "plugout_tt_params",
+]