niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/v_1dgrayplot.py

@@ -0,0 +1,238 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V_1DGRAYPLOT_METADATA = Metadata(
+    id="9f1dfb91ea2888caae64e3a7a65f59bb59e4f314.boutiques",
+    name="1dgrayplot",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+V1dgrayplotParameters = typing.TypedDict('V1dgrayplotParameters', {
+    "__STYX_TYPE__": typing.Literal["1dgrayplot"],
+    "tsfile": InputPathType,
+    "install": bool,
+    "ignore": typing.NotRequired[float | None],
+    "flip": bool,
+    "sep": bool,
+    "use": typing.NotRequired[float | None],
+    "ps": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "1dgrayplot": v_1dgrayplot_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 V1dgrayplotOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v_1dgrayplot(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def v_1dgrayplot_params(
+    tsfile: InputPathType,
+    install: bool = False,
+    ignore: float | None = None,
+    flip: bool = False,
+    sep: bool = False,
+    use: float | None = None,
+    ps: bool = False,
+) -> V1dgrayplotParameters:
+    """
+    Build parameters.
+    
+    Args:
+        tsfile: Input time series file (*.1D format).
+        install: Install a new X11 colormap (for X11 PseudoColor).
+        ignore: Skip first 'nn' rows in the input file [default = 0].
+        flip: Plot x and y axes interchanged [default: data columns plotted\
+            DOWN the screen].
+        sep: Separate scales for each column.
+        use: Plot 'mm' points [default: all of them].
+        ps: Don't draw plot in a window; write it to stdout in PostScript\
+            format.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "1dgrayplot",
+        "tsfile": tsfile,
+        "install": install,
+        "flip": flip,
+        "sep": sep,
+        "ps": ps,
+    }
+    if ignore is not None:
+        params["ignore"] = ignore
+    if use is not None:
+        params["use"] = use
+    return params
+
+
+def v_1dgrayplot_cargs(
+    params: V1dgrayplotParameters,
+    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("1dgrayplot")
+    cargs.append(execution.input_file(params.get("tsfile")))
+    if params.get("install"):
+        cargs.append("-install")
+    if params.get("ignore") is not None:
+        cargs.extend([
+            "-ignore",
+            str(params.get("ignore"))
+        ])
+    if params.get("flip"):
+        cargs.append("-flip")
+    if params.get("sep"):
+        cargs.append("-sep")
+    if params.get("use") is not None:
+        cargs.extend([
+            "-use",
+            str(params.get("use"))
+        ])
+    if params.get("ps"):
+        cargs.append("-ps")
+    return cargs
+
+
+def v_1dgrayplot_outputs(
+    params: V1dgrayplotParameters,
+    execution: Execution,
+) -> V1dgrayplotOutputs:
+    """
+    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 = V1dgrayplotOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def v_1dgrayplot_execute(
+    params: V1dgrayplotParameters,
+    execution: Execution,
+) -> V1dgrayplotOutputs:
+    """
+    Graphs the columns of a *.1D type time series file to the screen in grayscale.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `V1dgrayplotOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v_1dgrayplot_cargs(params, execution)
+    ret = v_1dgrayplot_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v_1dgrayplot(
+    tsfile: InputPathType,
+    install: bool = False,
+    ignore: float | None = None,
+    flip: bool = False,
+    sep: bool = False,
+    use: float | None = None,
+    ps: bool = False,
+    runner: Runner | None = None,
+) -> V1dgrayplotOutputs:
+    """
+    Graphs the columns of a *.1D type time series file to the screen in grayscale.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        tsfile: Input time series file (*.1D format).
+        install: Install a new X11 colormap (for X11 PseudoColor).
+        ignore: Skip first 'nn' rows in the input file [default = 0].
+        flip: Plot x and y axes interchanged [default: data columns plotted\
+            DOWN the screen].
+        sep: Separate scales for each column.
+        use: Plot 'mm' points [default: all of them].
+        ps: Don't draw plot in a window; write it to stdout in PostScript\
+            format.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `V1dgrayplotOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_1DGRAYPLOT_METADATA)
+    params = v_1dgrayplot_params(
+        tsfile=tsfile,
+        install=install,
+        ignore=ignore,
+        flip=flip,
+        sep=sep,
+        use=use,
+        ps=ps,
+    )
+    return v_1dgrayplot_execute(params, execution)
+
+
+__all__ = [
+    "V1dgrayplotOutputs",
+    "V1dgrayplotParameters",
+    "V_1DGRAYPLOT_METADATA",
+    "v_1dgrayplot",
+    "v_1dgrayplot_params",
+]

niwrap_afni/afni/v_1dmatcalc.py

@@ -0,0 +1,180 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V_1DMATCALC_METADATA = Metadata(
+    id="363bd7932d82bc77c3f5fe6e0307d7efddad15de.boutiques",
+    name="1dmatcalc",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+V1dmatcalcParameters = typing.TypedDict('V1dmatcalcParameters', {
+    "__STYX_TYPE__": typing.Literal["1dmatcalc"],
+    "expression": 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 {
+        "1dmatcalc": v_1dmatcalc_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 {
+        "1dmatcalc": v_1dmatcalc_outputs,
+    }.get(t)
+
+
+class V1dmatcalcOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v_1dmatcalc(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    output_file: OutputPathType
+    """Output file resulting from the evaluated expression"""
+
+
+def v_1dmatcalc_params(
+    expression: str | None = None,
+) -> V1dmatcalcParameters:
+    """
+    Build parameters.
+    
+    Args:
+        expression: Expression to evaluate the RPN matrix-valued operations.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "1dmatcalc",
+    }
+    if expression is not None:
+        params["expression"] = expression
+    return params
+
+
+def v_1dmatcalc_cargs(
+    params: V1dmatcalcParameters,
+    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("1dmatcalc")
+    if params.get("expression") is not None:
+        cargs.append(params.get("expression"))
+    return cargs
+
+
+def v_1dmatcalc_outputs(
+    params: V1dmatcalcParameters,
+    execution: Execution,
+) -> V1dmatcalcOutputs:
+    """
+    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 = V1dmatcalcOutputs(
+        root=execution.output_file("."),
+        output_file=execution.output_file("[OUTPUT_FILE]"),
+    )
+    return ret
+
+
+def v_1dmatcalc_execute(
+    params: V1dmatcalcParameters,
+    execution: Execution,
+) -> V1dmatcalcOutputs:
+    """
+    A tool to evaluate space-delimited RPN (Reverse Polish Notation) matrix-valued
+    expressions.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `V1dmatcalcOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v_1dmatcalc_cargs(params, execution)
+    ret = v_1dmatcalc_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v_1dmatcalc(
+    expression: str | None = None,
+    runner: Runner | None = None,
+) -> V1dmatcalcOutputs:
+    """
+    A tool to evaluate space-delimited RPN (Reverse Polish Notation) matrix-valued
+    expressions.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        expression: Expression to evaluate the RPN matrix-valued operations.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `V1dmatcalcOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_1DMATCALC_METADATA)
+    params = v_1dmatcalc_params(
+        expression=expression,
+    )
+    return v_1dmatcalc_execute(params, execution)
+
+
+__all__ = [
+    "V1dmatcalcOutputs",
+    "V1dmatcalcParameters",
+    "V_1DMATCALC_METADATA",
+    "v_1dmatcalc",
+    "v_1dmatcalc_params",
+]

niwrap_afni/afni/v_1dnorm.py

@@ -0,0 +1,224 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V_1DNORM_METADATA = Metadata(
+    id="ea6e83597c9dc8fb3895db8c36d06ddc6f559447.boutiques",
+    name="1dnorm",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+V1dnormParameters = typing.TypedDict('V1dnormParameters', {
+    "__STYX_TYPE__": typing.Literal["1dnorm"],
+    "infile": InputPathType,
+    "outfile": str,
+    "norm1": bool,
+    "normx": bool,
+    "demean": bool,
+    "demed": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "1dnorm": v_1dnorm_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 {
+        "1dnorm": v_1dnorm_outputs,
+    }.get(t)
+
+
+class V1dnormOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v_1dnorm(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    normalized_output: OutputPathType
+    """Normalized output AFNI *.1D file"""
+
+
+def v_1dnorm_params(
+    infile: InputPathType,
+    outfile: str,
+    norm1: bool = False,
+    normx: bool = False,
+    demean: bool = False,
+    demed: bool = False,
+) -> V1dnormParameters:
+    """
+    Build parameters.
+    
+    Args:
+        infile: Input AFNI *.1D file (ASCII list of numbers arranged in\
+            columns); if '-' input will be read from stdin.
+        outfile: Output AFNI *.1D file (normalized); if '-' output will be\
+            written to stdout.
+        norm1: Normalize so sum of absolute values is 1 (L_1 norm).
+        normx: Normalize so that max absolute value is 1 (L_infinity norm).
+        demean: Subtract each column's mean before normalizing.
+        demed: Subtract each column's median before normalizing.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "1dnorm",
+        "infile": infile,
+        "outfile": outfile,
+        "norm1": norm1,
+        "normx": normx,
+        "demean": demean,
+        "demed": demed,
+    }
+    return params
+
+
+def v_1dnorm_cargs(
+    params: V1dnormParameters,
+    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("1dnorm")
+    cargs.append(execution.input_file(params.get("infile")))
+    cargs.append(params.get("outfile"))
+    if params.get("norm1"):
+        cargs.append("-norm1")
+    if params.get("normx"):
+        cargs.append("-normx")
+    if params.get("demean"):
+        cargs.append("-demean")
+    if params.get("demed"):
+        cargs.append("-demed")
+    return cargs
+
+
+def v_1dnorm_outputs(
+    params: V1dnormParameters,
+    execution: Execution,
+) -> V1dnormOutputs:
+    """
+    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 = V1dnormOutputs(
+        root=execution.output_file("."),
+        normalized_output=execution.output_file(params.get("outfile")),
+    )
+    return ret
+
+
+def v_1dnorm_execute(
+    params: V1dnormParameters,
+    execution: Execution,
+) -> V1dnormOutputs:
+    """
+    Normalize columns of a 1D file (AFNI ASCII list of numbers).
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `V1dnormOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v_1dnorm_cargs(params, execution)
+    ret = v_1dnorm_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v_1dnorm(
+    infile: InputPathType,
+    outfile: str,
+    norm1: bool = False,
+    normx: bool = False,
+    demean: bool = False,
+    demed: bool = False,
+    runner: Runner | None = None,
+) -> V1dnormOutputs:
+    """
+    Normalize columns of a 1D file (AFNI ASCII list of numbers).
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        infile: Input AFNI *.1D file (ASCII list of numbers arranged in\
+            columns); if '-' input will be read from stdin.
+        outfile: Output AFNI *.1D file (normalized); if '-' output will be\
+            written to stdout.
+        norm1: Normalize so sum of absolute values is 1 (L_1 norm).
+        normx: Normalize so that max absolute value is 1 (L_infinity norm).
+        demean: Subtract each column's mean before normalizing.
+        demed: Subtract each column's median before normalizing.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `V1dnormOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_1DNORM_METADATA)
+    params = v_1dnorm_params(
+        infile=infile,
+        outfile=outfile,
+        norm1=norm1,
+        normx=normx,
+        demean=demean,
+        demed=demed,
+    )
+    return v_1dnorm_execute(params, execution)
+
+
+__all__ = [
+    "V1dnormOutputs",
+    "V1dnormParameters",
+    "V_1DNORM_METADATA",
+    "v_1dnorm",
+    "v_1dnorm_params",
+]