niwrap-afni 0.5.0__py3-none-any.whl

niwrap_afni/afni/v_1dsound.py

@@ -0,0 +1,292 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V_1DSOUND_METADATA = Metadata(
+    id="27afe9539a9fa717bc8a3162d9645362879cc57c.boutiques",
+    name="1dsound",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+V1dsoundParameters = typing.TypedDict('V1dsoundParameters', {
+    "__STYX_TYPE__": typing.Literal["1dsound"],
+    "tsfile": InputPathType,
+    "prefix": typing.NotRequired[str | None],
+    "encoding_16PCM": bool,
+    "encoding_8PCM": bool,
+    "encoding_8ulaw": bool,
+    "tper_option": typing.NotRequired[float | None],
+    "fm_option": bool,
+    "notes_option": bool,
+    "notewave_option": typing.NotRequired[str | None],
+    "despike_option": bool,
+    "play_option": bool,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "1dsound": v_1dsound_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 {
+        "1dsound": v_1dsound_outputs,
+    }.get(t)
+
+
+class V1dsoundOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v_1dsound(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    output_file: OutputPathType | None
+    """The output audio file."""
+
+
+def v_1dsound_params(
+    tsfile: InputPathType,
+    prefix: str | None = None,
+    encoding_16_pcm: bool = False,
+    encoding_8_pcm: bool = False,
+    encoding_8ulaw: bool = False,
+    tper_option: float | None = None,
+    fm_option: bool = False,
+    notes_option: bool = False,
+    notewave_option: str | None = None,
+    despike_option: bool = False,
+    play_option: bool = False,
+) -> V1dsoundParameters:
+    """
+    Build parameters.
+    
+    Args:
+        tsfile: The input 1D time series file containing the data to transform\
+            into sound.
+        prefix: Prefix for the output filename, which will have '.au'\
+            extension.
+        encoding_16_pcm: Output in 16-bit linear PCM encoding (uncompressed).
+        encoding_8_pcm: Output in 8-bit linear PCM encoding.
+        encoding_8ulaw: Output in 8-bit mu-law encoding.
+        tper_option: Time in seconds per time point in 'tsfile'. Allowed range\
+            is 0.01 to 1.0 (inclusive). [default is 0.2s].
+        fm_option: Output sound is frequency modulated between 110 and 1760 Hz\
+            from min to max in the input 1D file.
+        notes_option: Output sound is a sequence of notes, low to high pitch\
+            based on min to max in the input 1D file. Uses pentatonic scale.
+        notewave_option: Shape of the notes used. Select from [sine, sqsine,\
+            square, triangle].
+        despike_option: Apply a simple despiking algorithm to avoid artifacts\
+            from large/small values in the input.
+        play_option: Plays the sound file after it is written.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "1dsound",
+        "tsfile": tsfile,
+        "encoding_16PCM": encoding_16_pcm,
+        "encoding_8PCM": encoding_8_pcm,
+        "encoding_8ulaw": encoding_8ulaw,
+        "fm_option": fm_option,
+        "notes_option": notes_option,
+        "despike_option": despike_option,
+        "play_option": play_option,
+    }
+    if prefix is not None:
+        params["prefix"] = prefix
+    if tper_option is not None:
+        params["tper_option"] = tper_option
+    if notewave_option is not None:
+        params["notewave_option"] = notewave_option
+    return params
+
+
+def v_1dsound_cargs(
+    params: V1dsoundParameters,
+    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("1dsound")
+    cargs.append(execution.input_file(params.get("tsfile")))
+    if params.get("prefix") is not None:
+        cargs.extend([
+            "-prefix",
+            params.get("prefix")
+        ])
+    if params.get("encoding_16PCM"):
+        cargs.append("-16PCM")
+    if params.get("encoding_8PCM"):
+        cargs.append("-8PCM")
+    if params.get("encoding_8ulaw"):
+        cargs.append("-8ulaw")
+    if params.get("tper_option") is not None:
+        cargs.extend([
+            "-tper",
+            str(params.get("tper_option"))
+        ])
+    if params.get("fm_option"):
+        cargs.append("-FM")
+    if params.get("notes_option"):
+        cargs.append("-notes")
+    if params.get("notewave_option") is not None:
+        cargs.extend([
+            "-notewave",
+            params.get("notewave_option")
+        ])
+    if params.get("despike_option"):
+        cargs.append("-despike")
+    if params.get("play_option"):
+        cargs.append("-play")
+    return cargs
+
+
+def v_1dsound_outputs(
+    params: V1dsoundParameters,
+    execution: Execution,
+) -> V1dsoundOutputs:
+    """
+    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 = V1dsoundOutputs(
+        root=execution.output_file("."),
+        output_file=execution.output_file(params.get("prefix") + ".au") if (params.get("prefix") is not None) else None,
+    )
+    return ret
+
+
+def v_1dsound_execute(
+    params: V1dsoundParameters,
+    execution: Execution,
+) -> V1dsoundOutputs:
+    """
+    Program to create a sound file from a 1D file (column 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 `V1dsoundOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v_1dsound_cargs(params, execution)
+    ret = v_1dsound_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v_1dsound(
+    tsfile: InputPathType,
+    prefix: str | None = None,
+    encoding_16_pcm: bool = False,
+    encoding_8_pcm: bool = False,
+    encoding_8ulaw: bool = False,
+    tper_option: float | None = None,
+    fm_option: bool = False,
+    notes_option: bool = False,
+    notewave_option: str | None = None,
+    despike_option: bool = False,
+    play_option: bool = False,
+    runner: Runner | None = None,
+) -> V1dsoundOutputs:
+    """
+    Program to create a sound file from a 1D file (column of numbers).
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        tsfile: The input 1D time series file containing the data to transform\
+            into sound.
+        prefix: Prefix for the output filename, which will have '.au'\
+            extension.
+        encoding_16_pcm: Output in 16-bit linear PCM encoding (uncompressed).
+        encoding_8_pcm: Output in 8-bit linear PCM encoding.
+        encoding_8ulaw: Output in 8-bit mu-law encoding.
+        tper_option: Time in seconds per time point in 'tsfile'. Allowed range\
+            is 0.01 to 1.0 (inclusive). [default is 0.2s].
+        fm_option: Output sound is frequency modulated between 110 and 1760 Hz\
+            from min to max in the input 1D file.
+        notes_option: Output sound is a sequence of notes, low to high pitch\
+            based on min to max in the input 1D file. Uses pentatonic scale.
+        notewave_option: Shape of the notes used. Select from [sine, sqsine,\
+            square, triangle].
+        despike_option: Apply a simple despiking algorithm to avoid artifacts\
+            from large/small values in the input.
+        play_option: Plays the sound file after it is written.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `V1dsoundOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_1DSOUND_METADATA)
+    params = v_1dsound_params(
+        tsfile=tsfile,
+        prefix=prefix,
+        encoding_16_pcm=encoding_16_pcm,
+        encoding_8_pcm=encoding_8_pcm,
+        encoding_8ulaw=encoding_8ulaw,
+        tper_option=tper_option,
+        fm_option=fm_option,
+        notes_option=notes_option,
+        notewave_option=notewave_option,
+        despike_option=despike_option,
+        play_option=play_option,
+    )
+    return v_1dsound_execute(params, execution)
+
+
+__all__ = [
+    "V1dsoundOutputs",
+    "V1dsoundParameters",
+    "V_1DSOUND_METADATA",
+    "v_1dsound",
+    "v_1dsound_params",
+]

niwrap_afni/afni/v_1dsum.py

@@ -0,0 +1,235 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+V_1DSUM_METADATA = Metadata(
+    id="bc19d515e82be4f6b3c9c9f81c1a201e83b798ea.boutiques",
+    name="1dsum",
+    package="afni",
+    container_image_tag="afni/afni_make_build:AFNI_24.2.06",
+)
+
+
+V1dsumParameters = typing.TypedDict('V1dsumParameters', {
+    "__STYX_TYPE__": typing.Literal["1dsum"],
+    "input_files": list[InputPathType],
+    "ignore_rows": typing.NotRequired[float | None],
+    "use_rows": typing.NotRequired[float | None],
+    "mean_flag": bool,
+    "nocomment_flag": bool,
+    "okempty_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 {
+        "1dsum": v_1dsum_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 {
+        "1dsum": v_1dsum_outputs,
+    }.get(t)
+
+
+class V1dsumOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `v_1dsum(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+    output_file: OutputPathType
+    """Sum or average of columns in the input files"""
+
+
+def v_1dsum_params(
+    input_files: list[InputPathType],
+    ignore_rows: float | None = None,
+    use_rows: float | None = None,
+    mean_flag: bool = False,
+    nocomment_flag: bool = False,
+    okempty_flag: bool = False,
+) -> V1dsumParameters:
+    """
+    Build parameters.
+    
+    Args:
+        input_files: Input ASCII files with numbers arranged in rows and\
+            columns.
+        ignore_rows: Skip the first nn rows of each file.
+        use_rows: Use only mm rows from each file.
+        mean_flag: Compute the average instead of the sum.
+        nocomment_flag: Do not reproduce comments from the header of the first\
+            input file to the output.
+        okempty_flag: If encountering an empty 1D file, print 0 and exit\
+            quietly instead of exiting with an error message.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "1dsum",
+        "input_files": input_files,
+        "mean_flag": mean_flag,
+        "nocomment_flag": nocomment_flag,
+        "okempty_flag": okempty_flag,
+    }
+    if ignore_rows is not None:
+        params["ignore_rows"] = ignore_rows
+    if use_rows is not None:
+        params["use_rows"] = use_rows
+    return params
+
+
+def v_1dsum_cargs(
+    params: V1dsumParameters,
+    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("1dsum")
+    cargs.extend([execution.input_file(f) for f in params.get("input_files")])
+    if params.get("ignore_rows") is not None:
+        cargs.extend([
+            "-ignore",
+            str(params.get("ignore_rows"))
+        ])
+    if params.get("use_rows") is not None:
+        cargs.extend([
+            "-use",
+            str(params.get("use_rows"))
+        ])
+    if params.get("mean_flag"):
+        cargs.append("-mean")
+    if params.get("nocomment_flag"):
+        cargs.append("-nocomment")
+    if params.get("okempty_flag"):
+        cargs.append("-OKempty")
+    return cargs
+
+
+def v_1dsum_outputs(
+    params: V1dsumParameters,
+    execution: Execution,
+) -> V1dsumOutputs:
+    """
+    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 = V1dsumOutputs(
+        root=execution.output_file("."),
+        output_file=execution.output_file("output.txt"),
+    )
+    return ret
+
+
+def v_1dsum_execute(
+    params: V1dsumParameters,
+    execution: Execution,
+) -> V1dsumOutputs:
+    """
+    Sum or average columns of ASCII files with numbers arranged in rows and columns.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `V1dsumOutputs`).
+    """
+    params = execution.params(params)
+    cargs = v_1dsum_cargs(params, execution)
+    ret = v_1dsum_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def v_1dsum(
+    input_files: list[InputPathType],
+    ignore_rows: float | None = None,
+    use_rows: float | None = None,
+    mean_flag: bool = False,
+    nocomment_flag: bool = False,
+    okempty_flag: bool = False,
+    runner: Runner | None = None,
+) -> V1dsumOutputs:
+    """
+    Sum or average columns of ASCII files with numbers arranged in rows and columns.
+    
+    Author: AFNI Developers
+    
+    URL: https://afni.nimh.nih.gov/
+    
+    Args:
+        input_files: Input ASCII files with numbers arranged in rows and\
+            columns.
+        ignore_rows: Skip the first nn rows of each file.
+        use_rows: Use only mm rows from each file.
+        mean_flag: Compute the average instead of the sum.
+        nocomment_flag: Do not reproduce comments from the header of the first\
+            input file to the output.
+        okempty_flag: If encountering an empty 1D file, print 0 and exit\
+            quietly instead of exiting with an error message.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `V1dsumOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(V_1DSUM_METADATA)
+    params = v_1dsum_params(
+        input_files=input_files,
+        ignore_rows=ignore_rows,
+        use_rows=use_rows,
+        mean_flag=mean_flag,
+        nocomment_flag=nocomment_flag,
+        okempty_flag=okempty_flag,
+    )
+    return v_1dsum_execute(params, execution)
+
+
+__all__ = [
+    "V1dsumOutputs",
+    "V1dsumParameters",
+    "V_1DSUM_METADATA",
+    "v_1dsum",
+    "v_1dsum_params",
+]