niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/help_format.py

@@ -0,0 +1,176 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+HELP_FORMAT_METADATA = Metadata(
+    id="2c2e44d1845d44d18c53666d3810111107853205.boutiques",
+    name="help_format",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+HelpFormatParameters = typing.TypedDict('HelpFormatParameters', {
+    "__STYX_TYPE__": typing.Literal["help_format"],
+    "stdin": str,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "help_format": help_format_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 {
+        "help_format": help_format_outputs,
+    }.get(t)
+
+
+class HelpFormatOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `help_format(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    formatted_output: OutputPathType
+    """The formatted text with hyperlinks"""
+
+
+def help_format_params(
+    stdin: str,
+) -> HelpFormatParameters:
+    """
+    Build parameters.
+    
+    Args:
+        stdin: Standard input text to be formatted.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "help_format",
+        "stdin": stdin,
+    }
+    return params
+
+
+def help_format_cargs(
+    params: HelpFormatParameters,
+    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("help_format")
+    cargs.append(params.get("stdin"))
+    return cargs
+
+
+def help_format_outputs(
+    params: HelpFormatParameters,
+    execution: Execution,
+) -> HelpFormatOutputs:
+    """
+    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 = HelpFormatOutputs(
+        root=execution.output_file("."),
+        formatted_output=execution.output_file("formatted_output.html"),
+    )
+    return ret
+
+
+def help_format_execute(
+    params: HelpFormatParameters,
+    execution: Execution,
+) -> HelpFormatOutputs:
+    """
+    Formats text by converting URLs into HTML hyperlinks.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `HelpFormatOutputs`).
+    """
+    params = execution.params(params)
+    cargs = help_format_cargs(params, execution)
+    ret = help_format_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def help_format(
+    stdin: str,
+    runner: Runner | None = None,
+) -> HelpFormatOutputs:
+    """
+    Formats text by converting URLs into HTML hyperlinks.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        stdin: Standard input text to be formatted.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `HelpFormatOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(HELP_FORMAT_METADATA)
+    params = help_format_params(
+        stdin=stdin,
+    )
+    return help_format_execute(params, execution)
+
+
+__all__ = [
+    "HELP_FORMAT_METADATA",
+    "HelpFormatOutputs",
+    "HelpFormatParameters",
+    "help_format",
+    "help_format_params",
+]

niwrap_afni/afni/im2niml.py

@@ -0,0 +1,178 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+IM2NIML_METADATA = Metadata(
+    id="3c92592db9d506b4424ac028f92405630d2fda18.boutiques",
+    name="im2niml",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+Im2nimlParameters = typing.TypedDict('Im2nimlParameters', {
+    "__STYX_TYPE__": typing.Literal["im2niml"],
+    "input_files": list[InputPathType],
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "im2niml": im2niml_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 {
+        "im2niml": im2niml_outputs,
+    }.get(t)
+
+
+class Im2nimlOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `im2niml(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    niml_output: OutputPathType
+    """NIML element"""
+
+
+def im2niml_params(
+    input_files: list[InputPathType],
+) -> Im2nimlParameters:
+    """
+    Build parameters.
+    
+    Args:
+        input_files: Input image file(s) (e.g. image.jpg).
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "im2niml",
+        "input_files": input_files,
+    }
+    return params
+
+
+def im2niml_cargs(
+    params: Im2nimlParameters,
+    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("im2niml")
+    cargs.extend([execution.input_file(f) for f in params.get("input_files")])
+    return cargs
+
+
+def im2niml_outputs(
+    params: Im2nimlParameters,
+    execution: Execution,
+) -> Im2nimlOutputs:
+    """
+    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 = Im2nimlOutputs(
+        root=execution.output_file("."),
+        niml_output=execution.output_file("stdout"),
+    )
+    return ret
+
+
+def im2niml_execute(
+    params: Im2nimlParameters,
+    execution: Execution,
+) -> Im2nimlOutputs:
+    """
+    Converts the input image(s) to a text-based NIML element and writes the result
+    to stdout.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `Im2nimlOutputs`).
+    """
+    params = execution.params(params)
+    cargs = im2niml_cargs(params, execution)
+    ret = im2niml_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def im2niml(
+    input_files: list[InputPathType],
+    runner: Runner | None = None,
+) -> Im2nimlOutputs:
+    """
+    Converts the input image(s) to a text-based NIML element and writes the result
+    to stdout.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        input_files: Input image file(s) (e.g. image.jpg).
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `Im2nimlOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(IM2NIML_METADATA)
+    params = im2niml_params(
+        input_files=input_files,
+    )
+    return im2niml_execute(params, execution)
+
+
+__all__ = [
+    "IM2NIML_METADATA",
+    "Im2nimlOutputs",
+    "Im2nimlParameters",
+    "im2niml",
+    "im2niml_params",
+]

niwrap_afni/afni/images_equal.py

@@ -0,0 +1,195 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+IMAGES_EQUAL_METADATA = Metadata(
+    id="830357495ce35a09c03740c89847cea1c8976199.boutiques",
+    name="images_equal",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+ImagesEqualParameters = typing.TypedDict('ImagesEqualParameters', {
+    "__STYX_TYPE__": typing.Literal["images_equal"],
+    "file_a": InputPathType,
+    "file_b": InputPathType,
+    "all_flag": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "images_equal": images_equal_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 {
+        "images_equal": images_equal_outputs,
+    }.get(t)
+
+
+class ImagesEqualOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `images_equal(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    comparison_result: OutputPathType
+    """Result of the image comparison: 1 if equal, 0 if not."""
+
+
+def images_equal_params(
+    file_a: InputPathType,
+    file_b: InputPathType,
+    all_flag: bool = False,
+) -> ImagesEqualParameters:
+    """
+    Build parameters.
+    
+    Args:
+        file_a: First image file to compare.
+        file_b: Second image file to compare.
+        all_flag: Compare all images in the files; all must be equal for exit\
+            status to be 1.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "images_equal",
+        "file_a": file_a,
+        "file_b": file_b,
+        "all_flag": all_flag,
+    }
+    return params
+
+
+def images_equal_cargs(
+    params: ImagesEqualParameters,
+    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("images_equal")
+    cargs.append(execution.input_file(params.get("file_a")))
+    cargs.append(execution.input_file(params.get("file_b")))
+    if params.get("all_flag"):
+        cargs.append("-all")
+    return cargs
+
+
+def images_equal_outputs(
+    params: ImagesEqualParameters,
+    execution: Execution,
+) -> ImagesEqualOutputs:
+    """
+    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 = ImagesEqualOutputs(
+        root=execution.output_file("."),
+        comparison_result=execution.output_file("comparison_result.txt"),
+    )
+    return ret
+
+
+def images_equal_execute(
+    params: ImagesEqualParameters,
+    execution: Execution,
+) -> ImagesEqualOutputs:
+    """
+    A simple program to test if two 2D images are identical.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `ImagesEqualOutputs`).
+    """
+    params = execution.params(params)
+    cargs = images_equal_cargs(params, execution)
+    ret = images_equal_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def images_equal(
+    file_a: InputPathType,
+    file_b: InputPathType,
+    all_flag: bool = False,
+    runner: Runner | None = None,
+) -> ImagesEqualOutputs:
+    """
+    A simple program to test if two 2D images are identical.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        file_a: First image file to compare.
+        file_b: Second image file to compare.
+        all_flag: Compare all images in the files; all must be equal for exit\
+            status to be 1.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `ImagesEqualOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(IMAGES_EQUAL_METADATA)
+    params = images_equal_params(
+        file_a=file_a,
+        file_b=file_b,
+        all_flag=all_flag,
+    )
+    return images_equal_execute(params, execution)
+
+
+__all__ = [
+    "IMAGES_EQUAL_METADATA",
+    "ImagesEqualOutputs",
+    "ImagesEqualParameters",
+    "images_equal",
+    "images_equal_params",
+]