Source code for WrightTools.data._spcm

"""SPCM."""


# --- import --------------------------------------------------------------------------------------


import os
import pathlib
import collections
import time

import numpy as np

from ._data import Data
from .. import exceptions as wt_exceptions
from ..kit import _timestamp as timestamp


# --- define --------------------------------------------------------------------------------------


__all__ = ["from_spcm"]


# --- from function -------------------------------------------------------------------------------


[docs]def from_spcm(filepath, name=None, *, delimiter=",", parent=None, verbose=True) -> Data: """Create a ``Data`` object from a Becker & Hickl spcm file (ASCII-exported, ``.asc``). If provided, setup parameters are stored in the ``attrs`` dictionary of the ``Data`` object. See the `spcm`__ software hompage for more info. __ http://www.becker-hickl.com/software/spcm.htm Parameters ---------- filepath : path-like Path to SPC-xxx .asc file. Can be either a local or remote file (http/ftp). Can be compressed with gz/bz2, decompression based on file name. name : string (optional) Name to give to the created data object. If None, filename is used. Default is None. delimiter : string (optional) The string used to separate values. Default is ','. parent : WrightTools.Collection (optional) Collection to place new data object within. Default is None. verbose : boolean (optional) Toggle talkback. Default is True. Returns ------- WrightTools.data.Data object """ filestr = os.fspath(filepath) filepath = pathlib.Path(filepath) # check filepath if not ".asc" in filepath.suffixes: wt_exceptions.WrongFileTypeWarning.warn(filepath, ".asc") # parse name if not name: name = filepath.name.split(".")[0] # create headers dictionary headers = collections.OrderedDict() header_lines = 0 ds = np.DataSource(None) f = ds.open(filestr, "rt") while True: line = f.readline().strip() header_lines += 1 if len(line) == 0: break else: key, value = line.split(":", 1) if key.strip() == "Revision": headers["resolution"] = int(value.strip(" bits ADC")) else: headers[key.strip()] = value.strip() line = f.readline().strip() while "_BEGIN" in line: header_lines += 1 section = line.split("_BEGIN")[0] while True: line = f.readline().strip() header_lines += 1 if section + "_END" in line: break if section == "SYS_PARA": use_type = { "B": lambda b: int(b) == 1, "C": str, # e.g. #SP [SP_OVERFL,C,N] "F": float, "I": int, "L": int, # e.g. #DI [DI_MAXCNT,L,128] "S": str, "U": int, # unsigned int? } item = line[line.find("[") + 1 : line.find("]")].split(",") key = item[0] value = use_type[item[1]](item[2]) headers[key] = value else: splitted = line.split() value = splitted[-1][1:-1].split(",") key = " ".join(splitted[:-1]) headers[key] = value line = f.readline().strip() if "END" in line: header_lines += 1 break if "Date" in headers.keys() and "Time" in headers.keys(): # NOTE: reports created in local time, no-way to calculate absolute time created = " ".join([headers["Date"], headers["Time"]]) created = time.strptime(created, "%Y-%m-%d %H:%M:%S") created = timestamp.TimeStamp(time.mktime(created)).RFC3339 headers["created"] = created # initialize data object kwargs = {"name": name, "kind": "spcm", "source": filestr, **headers} if parent: data = parent.create_data(**kwargs) else: data = Data(**kwargs) # import data f.seek(0) arr = np.genfromtxt( f, skip_header=(header_lines + 1), skip_footer=1, delimiter=delimiter, unpack=True ) f.close() # construct data data.create_variable(name="time", values=arr[0], units="ns") data.create_channel(name="counts", values=arr[1]) data.transform("time") # finish if verbose: print("data created at {0}".format(data.fullpath)) print(" kind: {0}".format(data.kind)) print(" range: {0} to {1} (ns)".format(data.time[0], data.time[-1])) print(" size: {0}".format(data.size)) if "SP_COL_T" in data.attrs.keys(): print(" collection time: {0} sec".format(data.attrs["SP_COL_T"])) return data