Analysis

Analysis-related classes and enumerations.

class excentis.xra31.analysis.Analysis(xra31)

Access XRA-31 capture files.

delete(path: Union[str, pathlib.PurePosixPath] = None, *, rolling: bool = False, verbose: bool = False) → None

Remove a capture file or rolling file capture from the XRA-31. If no path is given, remove the latest capture. In case of a rolling file capture (rolling is True), the full collection of files will be removed.

Parameters

  • path (str or pathlib.PurePosixPath, optional) – Path to the file on the XRA-31.

  • rolling (bool, optional) – Remove all files related to a rolling file capture.

  • verbose (bool, optional) – Show progress.

Changed in version v5.0.0: parameters directory and filename dropped in favor of path.

download(path: Union[str, pathlib.PurePosixPath] = None, output: str = '', *, rolling: bool = False, append: bool = False, compress: bool = False, verbose: bool = False) → None

Download a capture file or rolling file capture from the XRA-31. If no filename is given, download the latest capture. In case of rolling file capture (rolling is True), the full collection of files is downloaded and concatenated to a single capture file.

Parameters

  • path (str or pathlib.PurePosixPath, optional) – Path to the file on the XRA-31.

  • output (str, optional) – Filename for local storage, defaults to the filename on the XRA-31.

  • rolling (bool, optional) – Indicate whether the full collection of files in a rolling file capture should be downloaded and concatenated.

  • append (bool, optional) – Append to an existing file.

  • compress (bool, optional) – Compress the file(s) locally (gzip).

  • verbose (bool, optional) – Show progress.

Changed in version v5.0.0: parameters directory and filename dropped in favor of path.