niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/plugout_tta.py

@@ -0,0 +1,290 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+PLUGOUT_TTA_METADATA = Metadata(
+    id="527ba3843cf35faf98349b2c5641637095261844.boutiques",
+    name="plugout_tta",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+PlugoutTtaParameters = typing.TypedDict('PlugoutTtaParameters', {
+    "__STYX_TYPE__": typing.Literal["plugout_tta"],
+    "host": typing.NotRequired[str | None],
+    "port": typing.NotRequired[int | None],
+    "verbose": bool,
+    "port_offset": typing.NotRequired[int | None],
+    "port_offset_quiet": typing.NotRequired[int | None],
+    "port_offset_bloc": typing.NotRequired[int | 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_tta": plugout_tta_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 PlugoutTtaOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `plugout_tta(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def plugout_tta_params(
+    host: str | None = None,
+    port: int | None = None,
+    verbose: bool = False,
+    port_offset: int | None = None,
+    port_offset_quiet: int | None = None,
+    port_offset_bloc: int | None = None,
+    max_port_bloc: bool = False,
+    max_port_bloc_quiet: bool = False,
+    num_assigned_ports: bool = False,
+    num_assigned_ports_quiet: bool = False,
+) -> PlugoutTtaParameters:
+    """
+    Build parameters.
+    
+    Args:
+        host: Connect to AFNI running on the specified computer using TCP/IP.\
+            Use '-host localhost' to connect on current host with TCP/IP.
+        port: Use TCP/IP port number 'pp'. Default is 8005.
+        verbose: Verbose mode: prints out progress reports.
+        port_offset: Provide a port offset to allow multiple instances of\
+            programs to communicate on the same machine. All ports are assigned\
+            numbers relative to PORT_OFFSET. Range: [1025, 65500].
+        port_offset_quiet: Like -np, but more quiet in the face of adversity.
+        port_offset_bloc: Provide a port offset block. Easier to use than -np.\
+            Range: [0, MAX_BLOC]. Using this reduces chances of port conflicts.
+        max_port_bloc: Print the current value of MAX_BLOC and exit.
+        max_port_bloc_quiet: Print MAX_BLOC value and exit quietly.
+        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 then quit quietly.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "plugout_tta",
+        "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 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_offset_bloc is not None:
+        params["port_offset_bloc"] = port_offset_bloc
+    return params
+
+
+def plugout_tta_cargs(
+    params: PlugoutTtaParameters,
+    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_tta")
+    if params.get("host") is not None:
+        cargs.extend([
+            "-host",
+            params.get("host")
+        ])
+    if params.get("port") is not None:
+        cargs.extend([
+            "-port",
+            str(params.get("port"))
+        ])
+    if params.get("verbose"):
+        cargs.append("-v")
+    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_offset_bloc") is not None:
+        cargs.extend([
+            "-npb",
+            str(params.get("port_offset_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_tta_outputs(
+    params: PlugoutTtaParameters,
+    execution: Execution,
+) -> PlugoutTtaOutputs:
+    """
+    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 = PlugoutTtaOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def plugout_tta_execute(
+    params: PlugoutTtaParameters,
+    execution: Execution,
+) -> PlugoutTtaOutputs:
+    """
+    Connects to AFNI and receives notification whenever the user changes Talairach
+    coordinates, then drives Netscape to display the closest figures from the
+    Talairach-Tournoux atlas.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `PlugoutTtaOutputs`).
+    """
+    params = execution.params(params)
+    cargs = plugout_tta_cargs(params, execution)
+    ret = plugout_tta_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def plugout_tta(
+    host: str | None = None,
+    port: int | None = None,
+    verbose: bool = False,
+    port_offset: int | None = None,
+    port_offset_quiet: int | None = None,
+    port_offset_bloc: int | 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,
+) -> PlugoutTtaOutputs:
+    """
+    Connects to AFNI and receives notification whenever the user changes Talairach
+    coordinates, then drives Netscape to display the closest figures from the
+    Talairach-Tournoux atlas.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        host: Connect to AFNI running on the specified computer using TCP/IP.\
+            Use '-host localhost' to connect on current host with TCP/IP.
+        port: Use TCP/IP port number 'pp'. Default is 8005.
+        verbose: Verbose mode: prints out progress reports.
+        port_offset: Provide a port offset to allow multiple instances of\
+            programs to communicate on the same machine. All ports are assigned\
+            numbers relative to PORT_OFFSET. Range: [1025, 65500].
+        port_offset_quiet: Like -np, but more quiet in the face of adversity.
+        port_offset_bloc: Provide a port offset block. Easier to use than -np.\
+            Range: [0, MAX_BLOC]. Using this reduces chances of port conflicts.
+        max_port_bloc: Print the current value of MAX_BLOC and exit.
+        max_port_bloc_quiet: Print MAX_BLOC value and exit quietly.
+        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 then quit quietly.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `PlugoutTtaOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(PLUGOUT_TTA_METADATA)
+    params = plugout_tta_params(
+        host=host,
+        port=port,
+        verbose=verbose,
+        port_offset=port_offset,
+        port_offset_quiet=port_offset_quiet,
+        port_offset_bloc=port_offset_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_tta_execute(params, execution)
+
+
+__all__ = [
+    "PLUGOUT_TTA_METADATA",
+    "PlugoutTtaOutputs",
+    "PlugoutTtaParameters",
+    "plugout_tta",
+    "plugout_tta_params",
+]

niwrap_afni/afni/prompt_popup.py

@@ -0,0 +1,205 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+PROMPT_POPUP_METADATA = Metadata(
+    id="56ce96c081577f794f865f7030869659d97db1e1.boutiques",
+    name="prompt_popup",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+PromptPopupParameters = typing.TypedDict('PromptPopupParameters', {
+    "__STYX_TYPE__": typing.Literal["prompt_popup"],
+    "message_pause": typing.NotRequired[str | None],
+    "buttons_b": typing.NotRequired[list[str] | None],
+    "timeout_to": typing.NotRequired[float | None],
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "prompt_popup": prompt_popup_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 PromptPopupOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `prompt_popup(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def prompt_popup_params(
+    message_pause: str | None = None,
+    buttons_b: list[str] | None = None,
+    timeout_to: float | None = None,
+) -> PromptPopupParameters:
+    """
+    Build parameters.
+    
+    Args:
+        message_pause: Same as -message to match the old prompt_user.
+        buttons_b: Same as -button.
+        timeout_to: Same as -timeout TT.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "prompt_popup",
+    }
+    if message_pause is not None:
+        params["message_pause"] = message_pause
+    if buttons_b is not None:
+        params["buttons_b"] = buttons_b
+    if timeout_to is not None:
+        params["timeout_to"] = timeout_to
+    return params
+
+
+def prompt_popup_cargs(
+    params: PromptPopupParameters,
+    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("prompt_popup")
+    if params.get("message_pause") is not None:
+        cargs.extend([
+            "-pause",
+            params.get("message_pause")
+        ])
+    if params.get("buttons_b") is not None:
+        cargs.extend([
+            "-b",
+            *params.get("buttons_b")
+        ])
+    if params.get("timeout_to") is not None:
+        cargs.extend([
+            "-to",
+            str(params.get("timeout_to"))
+        ])
+    return cargs
+
+
+def prompt_popup_outputs(
+    params: PromptPopupParameters,
+    execution: Execution,
+) -> PromptPopupOutputs:
+    """
+    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 = PromptPopupOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def prompt_popup_execute(
+    params: PromptPopupParameters,
+    execution: Execution,
+) -> PromptPopupOutputs:
+    """
+    A command-line tool that pops up a window prompting user interaction with a
+    message and buttons.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `PromptPopupOutputs`).
+    """
+    params = execution.params(params)
+    cargs = prompt_popup_cargs(params, execution)
+    ret = prompt_popup_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def prompt_popup(
+    message_pause: str | None = None,
+    buttons_b: list[str] | None = None,
+    timeout_to: float | None = None,
+    runner: Runner | None = None,
+) -> PromptPopupOutputs:
+    """
+    A command-line tool that pops up a window prompting user interaction with a
+    message and buttons.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        message_pause: Same as -message to match the old prompt_user.
+        buttons_b: Same as -button.
+        timeout_to: Same as -timeout TT.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `PromptPopupOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(PROMPT_POPUP_METADATA)
+    params = prompt_popup_params(
+        message_pause=message_pause,
+        buttons_b=buttons_b,
+        timeout_to=timeout_to,
+    )
+    return prompt_popup_execute(params, execution)
+
+
+__all__ = [
+    "PROMPT_POPUP_METADATA",
+    "PromptPopupOutputs",
+    "PromptPopupParameters",
+    "prompt_popup",
+    "prompt_popup_params",
+]

niwrap_afni/afni/prompt_user.py

@@ -0,0 +1,190 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+PROMPT_USER_METADATA = Metadata(
+    id="eeffbea4e522408c1d4978572830a23c9b27d7fb.boutiques",
+    name="prompt_user",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+PromptUserParameters = typing.TypedDict('PromptUserParameters', {
+    "__STYX_TYPE__": typing.Literal["prompt_user"],
+    "pause_message": str,
+    "timeout_alias": typing.NotRequired[float | None],
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "prompt_user": prompt_user_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 PromptUserOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `prompt_user(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def prompt_user_params(
+    pause_message: str,
+    timeout_alias: float | None = None,
+) -> PromptUserParameters:
+    """
+    Build parameters.
+    
+    Args:
+        pause_message: Pops a window prompting the user with MESSAGE. If\
+            MESSAGE is '-', it is read from stdin.
+        timeout_alias: Alias for -timeout.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "prompt_user",
+        "pause_message": pause_message,
+    }
+    if timeout_alias is not None:
+        params["timeout_alias"] = timeout_alias
+    return params
+
+
+def prompt_user_cargs(
+    params: PromptUserParameters,
+    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("prompt_user")
+    cargs.extend([
+        "<-pause>",
+        params.get("pause_message")
+    ])
+    if params.get("timeout_alias") is not None:
+        cargs.extend([
+            "-to",
+            str(params.get("timeout_alias"))
+        ])
+    return cargs
+
+
+def prompt_user_outputs(
+    params: PromptUserParameters,
+    execution: Execution,
+) -> PromptUserOutputs:
+    """
+    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 = PromptUserOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def prompt_user_execute(
+    params: PromptUserParameters,
+    execution: Execution,
+) -> PromptUserOutputs:
+    """
+    Tool that prompts a window requesting user input with a custom message.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `PromptUserOutputs`).
+    """
+    params = execution.params(params)
+    cargs = prompt_user_cargs(params, execution)
+    ret = prompt_user_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def prompt_user(
+    pause_message: str,
+    timeout_alias: float | None = None,
+    runner: Runner | None = None,
+) -> PromptUserOutputs:
+    """
+    Tool that prompts a window requesting user input with a custom message.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        pause_message: Pops a window prompting the user with MESSAGE. If\
+            MESSAGE is '-', it is read from stdin.
+        timeout_alias: Alias for -timeout.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `PromptUserOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(PROMPT_USER_METADATA)
+    params = prompt_user_params(
+        pause_message=pause_message,
+        timeout_alias=timeout_alias,
+    )
+    return prompt_user_execute(params, execution)
+
+
+__all__ = [
+    "PROMPT_USER_METADATA",
+    "PromptUserOutputs",
+    "PromptUserParameters",
+    "prompt_user",
+    "prompt_user_params",
+]