niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/rbox.py

@@ -0,0 +1,245 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+RBOX_METADATA = Metadata(
+    id="4f43f8ba19b6a24114997ab42bf7e5c5e5484c74.boutiques",
+    name="rbox",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+RboxParameters = typing.TypedDict('RboxParameters', {
+    "__STYX_TYPE__": typing.Literal["rbox"],
+    "number_points": str,
+    "dimension": typing.NotRequired[str | None],
+    "integer_coordinates": bool,
+    "bounding_box": typing.NotRequired[float | None],
+    "offset": typing.NotRequired[float | None],
+    "user_seed": typing.NotRequired[float | None],
+    "mesh_lattice": typing.NotRequired[list[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 {
+        "rbox": rbox_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 RboxOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `rbox(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def rbox_params(
+    number_points: str,
+    dimension: str | None = None,
+    integer_coordinates: bool = False,
+    bounding_box: float | None = None,
+    offset: float | None = None,
+    user_seed: float | None = None,
+    mesh_lattice: list[str] | None = None,
+) -> RboxParameters:
+    """
+    Build parameters.
+    
+    Args:
+        number_points: Number of random points in cube, lens, spiral, sphere or\
+            grid.
+        dimension: Dimension (e.g., D3 for 3-d).
+        integer_coordinates: Print integer coordinates, default 'Bn' is 1e+06.
+        bounding_box: Bounding box coordinates, default 0.5.
+        offset: Offset coordinates by n.
+        user_seed: Use n as the random number seed.
+        mesh_lattice: Lattice (Mesh) rotated by [n,-m,0], [m,n,0], [0,0,r], ...
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "rbox",
+        "number_points": number_points,
+        "integer_coordinates": integer_coordinates,
+    }
+    if dimension is not None:
+        params["dimension"] = dimension
+    if bounding_box is not None:
+        params["bounding_box"] = bounding_box
+    if offset is not None:
+        params["offset"] = offset
+    if user_seed is not None:
+        params["user_seed"] = user_seed
+    if mesh_lattice is not None:
+        params["mesh_lattice"] = mesh_lattice
+    return params
+
+
+def rbox_cargs(
+    params: RboxParameters,
+    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("rbox")
+    cargs.append(params.get("number_points"))
+    if params.get("dimension") is not None:
+        cargs.append(params.get("dimension"))
+    if params.get("integer_coordinates"):
+        cargs.append("z")
+    if params.get("bounding_box") is not None:
+        cargs.extend([
+            "B",
+            str(params.get("bounding_box"))
+        ])
+    if params.get("offset") is not None:
+        cargs.extend([
+            "O",
+            str(params.get("offset"))
+        ])
+    if params.get("user_seed") is not None:
+        cargs.extend([
+            "t",
+            str(params.get("user_seed"))
+        ])
+    if params.get("mesh_lattice") is not None:
+        cargs.extend([
+            "M",
+            *params.get("mesh_lattice")
+        ])
+    return cargs
+
+
+def rbox_outputs(
+    params: RboxParameters,
+    execution: Execution,
+) -> RboxOutputs:
+    """
+    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 = RboxOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def rbox_execute(
+    params: RboxParameters,
+    execution: Execution,
+) -> RboxOutputs:
+    """
+    Generate various point distributions. Default is random in cube.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `RboxOutputs`).
+    """
+    params = execution.params(params)
+    cargs = rbox_cargs(params, execution)
+    ret = rbox_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def rbox(
+    number_points: str,
+    dimension: str | None = None,
+    integer_coordinates: bool = False,
+    bounding_box: float | None = None,
+    offset: float | None = None,
+    user_seed: float | None = None,
+    mesh_lattice: list[str] | None = None,
+    runner: Runner | None = None,
+) -> RboxOutputs:
+    """
+    Generate various point distributions. Default is random in cube.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        number_points: Number of random points in cube, lens, spiral, sphere or\
+            grid.
+        dimension: Dimension (e.g., D3 for 3-d).
+        integer_coordinates: Print integer coordinates, default 'Bn' is 1e+06.
+        bounding_box: Bounding box coordinates, default 0.5.
+        offset: Offset coordinates by n.
+        user_seed: Use n as the random number seed.
+        mesh_lattice: Lattice (Mesh) rotated by [n,-m,0], [m,n,0], [0,0,r], ...
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `RboxOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(RBOX_METADATA)
+    params = rbox_params(
+        number_points=number_points,
+        dimension=dimension,
+        integer_coordinates=integer_coordinates,
+        bounding_box=bounding_box,
+        offset=offset,
+        user_seed=user_seed,
+        mesh_lattice=mesh_lattice,
+    )
+    return rbox_execute(params, execution)
+
+
+__all__ = [
+    "RBOX_METADATA",
+    "RboxOutputs",
+    "RboxParameters",
+    "rbox",
+    "rbox_params",
+]

niwrap_afni/afni/read_matlab_files_py.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 *
+
+READ_MATLAB_FILES_PY_METADATA = Metadata(
+    id="228461aad9e4f1abdf8c4f6cdf4dda42da06fc96.boutiques",
+    name="read_matlab_files.py",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+ReadMatlabFilesPyParameters = typing.TypedDict('ReadMatlabFilesPyParameters', {
+    "__STYX_TYPE__": typing.Literal["read_matlab_files.py"],
+    "infiles": list[str],
+    "prefix": typing.NotRequired[str | None],
+    "overwrite": bool,
+    "help": bool,
+    "history": bool,
+    "version": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "read_matlab_files.py": read_matlab_files_py_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 {
+        "read_matlab_files.py": read_matlab_files_py_outputs,
+    }.get(t)
+
+
+class ReadMatlabFilesPyOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `read_matlab_files_py(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    converted_1d_file: OutputPathType | None
+    """Converted 1D format file"""
+
+
+def read_matlab_files_py_params(
+    infiles: list[str],
+    prefix: str | None = None,
+    overwrite: bool = False,
+    help_: bool = False,
+    history: bool = False,
+    version: bool = False,
+) -> ReadMatlabFilesPyParameters:
+    """
+    Build parameters.
+    
+    Args:
+        infiles: Input MATLAB files to be processed.
+        prefix: Prefix for output file names.
+        overwrite: Overwrite any existing output files.
+        help_: Show help message.
+        history: Show revision history.
+        version: Show version number.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "read_matlab_files.py",
+        "infiles": infiles,
+        "overwrite": overwrite,
+        "help": help_,
+        "history": history,
+        "version": version,
+    }
+    if prefix is not None:
+        params["prefix"] = prefix
+    return params
+
+
+def read_matlab_files_py_cargs(
+    params: ReadMatlabFilesPyParameters,
+    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("read_matlab_files.py")
+    cargs.extend(params.get("infiles"))
+    if params.get("prefix") is not None:
+        cargs.extend([
+            "-prefix",
+            params.get("prefix")
+        ])
+    if params.get("overwrite"):
+        cargs.append("-overwrite")
+    if params.get("help"):
+        cargs.append("-help")
+    if params.get("history"):
+        cargs.append("-hist")
+    if params.get("version"):
+        cargs.append("-ver")
+    return cargs
+
+
+def read_matlab_files_py_outputs(
+    params: ReadMatlabFilesPyParameters,
+    execution: Execution,
+) -> ReadMatlabFilesPyOutputs:
+    """
+    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 = ReadMatlabFilesPyOutputs(
+        root=execution.output_file("."),
+        converted_1d_file=execution.output_file(params.get("prefix") + ".[INDEX].[KEY].1D") if (params.get("prefix") is not None) else None,
+    )
+    return ret
+
+
+def read_matlab_files_py_execute(
+    params: ReadMatlabFilesPyParameters,
+    execution: Execution,
+) -> ReadMatlabFilesPyOutputs:
+    """
+    Describe or convert MATLAB files (.mat) to 1D format.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `ReadMatlabFilesPyOutputs`).
+    """
+    params = execution.params(params)
+    cargs = read_matlab_files_py_cargs(params, execution)
+    ret = read_matlab_files_py_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def read_matlab_files_py(
+    infiles: list[str],
+    prefix: str | None = None,
+    overwrite: bool = False,
+    help_: bool = False,
+    history: bool = False,
+    version: bool = False,
+    runner: Runner | None = None,
+) -> ReadMatlabFilesPyOutputs:
+    """
+    Describe or convert MATLAB files (.mat) to 1D format.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        infiles: Input MATLAB files to be processed.
+        prefix: Prefix for output file names.
+        overwrite: Overwrite any existing output files.
+        help_: Show help message.
+        history: Show revision history.
+        version: Show version number.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `ReadMatlabFilesPyOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(READ_MATLAB_FILES_PY_METADATA)
+    params = read_matlab_files_py_params(
+        infiles=infiles,
+        prefix=prefix,
+        overwrite=overwrite,
+        help_=help_,
+        history=history,
+        version=version,
+    )
+    return read_matlab_files_py_execute(params, execution)
+
+
+__all__ = [
+    "READ_MATLAB_FILES_PY_METADATA",
+    "ReadMatlabFilesPyOutputs",
+    "ReadMatlabFilesPyParameters",
+    "read_matlab_files_py",
+    "read_matlab_files_py_params",
+]