niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/balloon.py

@@ -0,0 +1,210 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+BALLOON_METADATA = Metadata(
+    id="d38a0b74f4c93d5365bdded27c362f4ddc6e6b5f.boutiques",
+    name="balloon",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+BalloonParameters = typing.TypedDict('BalloonParameters', {
+    "__STYX_TYPE__": typing.Literal["balloon"],
+    "tr": float,
+    "num_scans": int,
+    "event_times": InputPathType,
+    "t_fall": typing.NotRequired[list[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 {
+        "balloon": balloon_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 BalloonOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `balloon(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def balloon_params(
+    tr: float,
+    num_scans: int,
+    event_times: InputPathType,
+    t_fall: list[float] | None = None,
+) -> BalloonParameters:
+    """
+    Build parameters.
+    
+    Args:
+        tr: Scan repetition time in seconds (TR), the interval at which the\
+            output curve will be sampled.
+        num_scans: Number of scans (N), the output curve will comprise this\
+            number of samples.
+        event_times: The name of a file containing the event timings, in\
+            seconds, as ASCII strings separated by white space, with time 0 being\
+            the time at which the initial scan occurred.
+        t_fall: Haemodynamic fall time in seconds (typically between 4s and\
+            6s).
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "balloon",
+        "tr": tr,
+        "num_scans": num_scans,
+        "event_times": event_times,
+    }
+    if t_fall is not None:
+        params["t_fall"] = t_fall
+    return params
+
+
+def balloon_cargs(
+    params: BalloonParameters,
+    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("balloon")
+    cargs.append(str(params.get("tr")))
+    cargs.append(str(params.get("num_scans")))
+    cargs.append(execution.input_file(params.get("event_times")))
+    if params.get("t_fall") is not None:
+        cargs.extend(map(str, params.get("t_fall")))
+    return cargs
+
+
+def balloon_outputs(
+    params: BalloonParameters,
+    execution: Execution,
+) -> BalloonOutputs:
+    """
+    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 = BalloonOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def balloon_execute(
+    params: BalloonParameters,
+    execution: Execution,
+) -> BalloonOutputs:
+    """
+    Simulation of haemodynamic response using the balloon model. Based on the
+    theoretical model proposed by Buxton et al. (1998).
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `BalloonOutputs`).
+    """
+    params = execution.params(params)
+    cargs = balloon_cargs(params, execution)
+    ret = balloon_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def balloon(
+    tr: float,
+    num_scans: int,
+    event_times: InputPathType,
+    t_fall: list[float] | None = None,
+    runner: Runner | None = None,
+) -> BalloonOutputs:
+    """
+    Simulation of haemodynamic response using the balloon model. Based on the
+    theoretical model proposed by Buxton et al. (1998).
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        tr: Scan repetition time in seconds (TR), the interval at which the\
+            output curve will be sampled.
+        num_scans: Number of scans (N), the output curve will comprise this\
+            number of samples.
+        event_times: The name of a file containing the event timings, in\
+            seconds, as ASCII strings separated by white space, with time 0 being\
+            the time at which the initial scan occurred.
+        t_fall: Haemodynamic fall time in seconds (typically between 4s and\
+            6s).
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `BalloonOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(BALLOON_METADATA)
+    params = balloon_params(
+        tr=tr,
+        num_scans=num_scans,
+        event_times=event_times,
+        t_fall=t_fall,
+    )
+    return balloon_execute(params, execution)
+
+
+__all__ = [
+    "BALLOON_METADATA",
+    "BalloonOutputs",
+    "BalloonParameters",
+    "balloon",
+    "balloon_params",
+]

niwrap_afni/afni/bayes_view.py

@@ -0,0 +1,196 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+BAYES_VIEW_METADATA = Metadata(
+    id="6b7c34a2ea4931bfe8ed6b989b43904d7d18f61b.boutiques",
+    name="bayes_view",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+BayesViewParameters = typing.TypedDict('BayesViewParameters', {
+    "__STYX_TYPE__": typing.Literal["bayes_view"],
+    "input_folder": str,
+    "help": bool,
+    "shiny_folder": 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 {
+        "bayes_view": bayes_view_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 BayesViewOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `bayes_view(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def bayes_view_params(
+    input_folder: str,
+    help_: bool = False,
+    shiny_folder: str | None = None,
+) -> BayesViewParameters:
+    """
+    Build parameters.
+    
+    Args:
+        input_folder: Path to a folder containing .RData files.
+        help_: Show help message.
+        shiny_folder: Use a custom shiny folder (for testing purposes).
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "bayes_view",
+        "input_folder": input_folder,
+        "help": help_,
+    }
+    if shiny_folder is not None:
+        params["shiny_folder"] = shiny_folder
+    return params
+
+
+def bayes_view_cargs(
+    params: BayesViewParameters,
+    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("bayes_view")
+    cargs.append(params.get("input_folder"))
+    if params.get("help"):
+        cargs.append("-help")
+    if params.get("shiny_folder") is not None:
+        cargs.extend([
+            "-ShinyFolder",
+            params.get("shiny_folder")
+        ])
+    return cargs
+
+
+def bayes_view_outputs(
+    params: BayesViewParameters,
+    execution: Execution,
+) -> BayesViewOutputs:
+    """
+    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 = BayesViewOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def bayes_view_execute(
+    params: BayesViewParameters,
+    execution: Execution,
+) -> BayesViewOutputs:
+    """
+    Launch a shiny app to visualize RBA output files. The files must have the .RData
+    extension.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `BayesViewOutputs`).
+    """
+    params = execution.params(params)
+    cargs = bayes_view_cargs(params, execution)
+    ret = bayes_view_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def bayes_view(
+    input_folder: str,
+    help_: bool = False,
+    shiny_folder: str | None = None,
+    runner: Runner | None = None,
+) -> BayesViewOutputs:
+    """
+    Launch a shiny app to visualize RBA output files. The files must have the .RData
+    extension.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        input_folder: Path to a folder containing .RData files.
+        help_: Show help message.
+        shiny_folder: Use a custom shiny folder (for testing purposes).
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `BayesViewOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(BAYES_VIEW_METADATA)
+    params = bayes_view_params(
+        input_folder=input_folder,
+        help_=help_,
+        shiny_folder=shiny_folder,
+    )
+    return bayes_view_execute(params, execution)
+
+
+__all__ = [
+    "BAYES_VIEW_METADATA",
+    "BayesViewOutputs",
+    "BayesViewParameters",
+    "bayes_view",
+    "bayes_view_params",
+]