resistics.time.reader_ats module

class resistics.time.reader_ats.TimeReaderATS(dataPath: str)[source]

Bases: resistics.time.reader.TimeReader

Data reader for ATS formatted data

For ATS files, header information is XML formatted. The end time in ATS header files is actually one sample past the time of the last sample. The dataReader handles this and gives an end time corresponding to the actual time of the last sample.

Notes

The raw data units for ATS data are in counts. To get data in field units, ATS data is first multipled by the least significat bit (lsb) defined in the header files,

data = data * leastSignificantBit,

giving data in mV. The lsb includes the gain removal, so no separate gain removal needs to be performed.

For electrical channels, there is additional step of dividing by the electrode spacing, which is provided in metres. The extra factor of a 1000 is to convert this to km to give mV/km for electric channels

data = (1000 * data)/electrodeSpacing

Finally, to get magnetic channels in nT, the magnetic channels need to be calibrated.

Methods

setParameters()

Set data format parameters

dataHeaders()

Headers to read in

readHeaders()

Specific function for reading the headers for internal format

lineToKeyAndValue(line)

Separate a line into key and value with = as a delimiter

dataHeaders(self)[source]

Return the data headers in the internal file format

Returns
recordingHeadersList[str]

Headers with information about the recording

globalHeadersList[str]

Common headers with information about the recording

channelHeadersInputList[str]

Channel setup headers

channelHeadersOutputList[str]

Channel recording headers

readHeader(self)[source]

Read time data header file for ATS format

Headers for ATS files are XML formatted.

setParameters(self) → None[source]

Set data reader parameters for ATS files