niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/v__get_afni_orient.py

@@ -0,0 +1,185 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V__GET_AFNI_ORIENT_METADATA = Metadata(
+    id="f8dbdeb31f2cb6c6cd4aea993002d6be907c16b0.boutiques",
+    name="@GetAfniOrient",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+VGetAfniOrientParameters = typing.TypedDict('VGetAfniOrientParameters', {
+    "__STYX_TYPE__": typing.Literal["@GetAfniOrient"],
+    "exploratory": bool,
+    "infile": InputPathType,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "@GetAfniOrient": v__get_afni_orient_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 {
+        "@GetAfniOrient": v__get_afni_orient_outputs,
+    }.get(t)
+
+
+class VGetAfniOrientOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v__get_afni_orient(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    output_orient_code: OutputPathType
+    """File containing the orientation code"""
+
+
+def v__get_afni_orient_params(
+    infile: InputPathType,
+    exploratory: bool = False,
+) -> VGetAfniOrientParameters:
+    """
+    Build parameters.
+    
+    Args:
+        infile: Input AFNI dataset (e.g. Hello+orig.HEAD).
+        exploratory: Exploratory flag for additional functionalities.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "@GetAfniOrient",
+        "exploratory": exploratory,
+        "infile": infile,
+    }
+    return params
+
+
+def v__get_afni_orient_cargs(
+    params: VGetAfniOrientParameters,
+    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("@GetAfniOrient")
+    if params.get("exploratory"):
+        cargs.append("-exp")
+    cargs.append(execution.input_file(params.get("infile")))
+    return cargs
+
+
+def v__get_afni_orient_outputs(
+    params: VGetAfniOrientParameters,
+    execution: Execution,
+) -> VGetAfniOrientOutputs:
+    """
+    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 = VGetAfniOrientOutputs(
+        root=execution.output_file("."),
+        output_orient_code=execution.output_file(pathlib.Path(params.get("infile")).name + "_orient_code.txt"),
+    )
+    return ret
+
+
+def v__get_afni_orient_execute(
+    params: VGetAfniOrientParameters,
+    execution: Execution,
+) -> VGetAfniOrientOutputs:
+    """
+    Returns the orient code of AFNI datasets.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VGetAfniOrientOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v__get_afni_orient_cargs(params, execution)
+    ret = v__get_afni_orient_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v__get_afni_orient(
+    infile: InputPathType,
+    exploratory: bool = False,
+    runner: Runner | None = None,
+) -> VGetAfniOrientOutputs:
+    """
+    Returns the orient code of AFNI datasets.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        infile: Input AFNI dataset (e.g. Hello+orig.HEAD).
+        exploratory: Exploratory flag for additional functionalities.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VGetAfniOrientOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V__GET_AFNI_ORIENT_METADATA)
+    params = v__get_afni_orient_params(
+        exploratory=exploratory,
+        infile=infile,
+    )
+    return v__get_afni_orient_execute(params, execution)
+
+
+__all__ = [
+    "VGetAfniOrientOutputs",
+    "VGetAfniOrientParameters",
+    "V__GET_AFNI_ORIENT_METADATA",
+    "v__get_afni_orient",
+    "v__get_afni_orient_params",
+]

niwrap_afni/afni/v__get_afni_prefix.py

@@ -0,0 +1,182 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V__GET_AFNI_PREFIX_METADATA = Metadata(
+    id="ae0f36ac76fa0ee57fb99900eaf3197e4b29bbf6.boutiques",
+    name="@GetAfniPrefix",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+VGetAfniPrefixParameters = typing.TypedDict('VGetAfniPrefixParameters', {
+    "__STYX_TYPE__": typing.Literal["@GetAfniPrefix"],
+    "name": InputPathType,
+    "suffix": 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 {
+        "@GetAfniPrefix": v__get_afni_prefix_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 VGetAfniPrefixOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v__get_afni_prefix(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def v__get_afni_prefix_params(
+    name: InputPathType,
+    suffix: str | None = None,
+) -> VGetAfniPrefixParameters:
+    """
+    Build parameters.
+    
+    Args:
+        name: Input file path for which the AFNI prefix will be extracted.
+        suffix: Suffix string to append to the returned prefix.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "@GetAfniPrefix",
+        "name": name,
+    }
+    if suffix is not None:
+        params["suffix"] = suffix
+    return params
+
+
+def v__get_afni_prefix_cargs(
+    params: VGetAfniPrefixParameters,
+    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("@GetAfniPrefix")
+    cargs.append(execution.input_file(params.get("name")))
+    if params.get("suffix") is not None:
+        cargs.append(params.get("suffix"))
+    return cargs
+
+
+def v__get_afni_prefix_outputs(
+    params: VGetAfniPrefixParameters,
+    execution: Execution,
+) -> VGetAfniPrefixOutputs:
+    """
+    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 = VGetAfniPrefixOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def v__get_afni_prefix_execute(
+    params: VGetAfniPrefixParameters,
+    execution: Execution,
+) -> VGetAfniPrefixOutputs:
+    """
+    A tool to extract AFNI prefix from a given file path.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VGetAfniPrefixOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v__get_afni_prefix_cargs(params, execution)
+    ret = v__get_afni_prefix_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v__get_afni_prefix(
+    name: InputPathType,
+    suffix: str | None = None,
+    runner: Runner | None = None,
+) -> VGetAfniPrefixOutputs:
+    """
+    A tool to extract AFNI prefix from a given file path.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        name: Input file path for which the AFNI prefix will be extracted.
+        suffix: Suffix string to append to the returned prefix.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VGetAfniPrefixOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V__GET_AFNI_PREFIX_METADATA)
+    params = v__get_afni_prefix_params(
+        name=name,
+        suffix=suffix,
+    )
+    return v__get_afni_prefix_execute(params, execution)
+
+
+__all__ = [
+    "VGetAfniPrefixOutputs",
+    "VGetAfniPrefixParameters",
+    "V__GET_AFNI_PREFIX_METADATA",
+    "v__get_afni_prefix",
+    "v__get_afni_prefix_params",
+]

niwrap_afni/afni/v__get_afni_res.py

@@ -0,0 +1,183 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V__GET_AFNI_RES_METADATA = Metadata(
+    id="8e9d3bd1817738927cfd2699a3bf4ffe4e305e07.boutiques",
+    name="@GetAfniRes",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+VGetAfniResParameters = typing.TypedDict('VGetAfniResParameters', {
+    "__STYX_TYPE__": typing.Literal["@GetAfniRes"],
+    "output_type": typing.NotRequired[typing.Literal["-min", "-max", "-mean"] | None],
+    "input_dataset": InputPathType,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "@GetAfniRes": v__get_afni_res_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 VGetAfniResOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v__get_afni_res(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def v__get_afni_res_params(
+    input_dataset: InputPathType,
+    output_type: typing.Literal["-min", "-max", "-mean"] | None = None,
+) -> VGetAfniResParameters:
+    """
+    Build parameters.
+    
+    Args:
+        input_dataset: Input dataset.
+        output_type: Output type specifying whether to return the minimum,\
+            maximum, or mean resolution.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "@GetAfniRes",
+        "input_dataset": input_dataset,
+    }
+    if output_type is not None:
+        params["output_type"] = output_type
+    return params
+
+
+def v__get_afni_res_cargs(
+    params: VGetAfniResParameters,
+    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 = []
+    if params.get("output_type") is not None:
+        cargs.append("@GetAfniRes" + params.get("output_type"))
+    cargs.append(execution.input_file(params.get("input_dataset")))
+    return cargs
+
+
+def v__get_afni_res_outputs(
+    params: VGetAfniResParameters,
+    execution: Execution,
+) -> VGetAfniResOutputs:
+    """
+    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 = VGetAfniResOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def v__get_afni_res_execute(
+    params: VGetAfniResParameters,
+    execution: Execution,
+) -> VGetAfniResOutputs:
+    """
+    Tool to return the voxel resolution of a dataset.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VGetAfniResOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v__get_afni_res_cargs(params, execution)
+    ret = v__get_afni_res_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v__get_afni_res(
+    input_dataset: InputPathType,
+    output_type: typing.Literal["-min", "-max", "-mean"] | None = None,
+    runner: Runner | None = None,
+) -> VGetAfniResOutputs:
+    """
+    Tool to return the voxel resolution of a dataset.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        input_dataset: Input dataset.
+        output_type: Output type specifying whether to return the minimum,\
+            maximum, or mean resolution.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VGetAfniResOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V__GET_AFNI_RES_METADATA)
+    params = v__get_afni_res_params(
+        output_type=output_type,
+        input_dataset=input_dataset,
+    )
+    return v__get_afni_res_execute(params, execution)
+
+
+__all__ = [
+    "VGetAfniResOutputs",
+    "VGetAfniResParameters",
+    "V__GET_AFNI_RES_METADATA",
+    "v__get_afni_res",
+    "v__get_afni_res_params",
+]