CIDataFileReaderAPI

The Crystal Instruments (CI) ATFX ODS Signal Reader Application Programming Interface (API) consists of 2 Windows Dynamic-Linked Libraries (DLL) providing third-party applications an interface to access the signal data stored in the ASAM Transport Format XML (ATFX) files.

ATFX files are formatted according to the Association for Standardization of Automation and Measuring Systems (ASAM) Open Data Services (ODS) standardization. This is a standard dedicated for storing vibration data and its different forms. CI software natively stores its data using the ATFX format, for both signals and recordings.

For details about the ATFX ODS format please refer to the official website:

https://www.asam.net/standards/detail/ods/wiki/

The .atfx files are xml-based files which store the signal data along with all the attributes of the signal data including recording properties and time created, length of recording, number of channels, channel parameters (e.g., input channel sensor and sensitivities), geographic coordinates, sampling rate, high pass filter, etc.

The .atfx files contain a reference to a .dat file that are well-defined for storing both raw time data as well as processed spectral data, calculated from methods including Fourier Transform, Frequency Response Functions, Cross-Power Spectrum, Octave Spectrum, etc.

There are 2 additional file types that the .aftx file references that contain raw data: .ts and .gps. The .ts file is a TimeStamp recording that contains an accurate measure of when a recording was saved with accuracy down to nanoseconds. The .gps file is a GPS recording that contains locational data of where a recording was saved (e.g., latitude, longitude, altitude).

The CI Data File Reader API provides end-users with a streamlined file reading and browsing library to decode ATFX, TS and GPS files. Users can integrate the API with their own custom developed application. Currently, we support Windows-based programs, ideally written in C#. The same API also supports Python, MatLab and LabView.

The API offer direct calls to the ASAM ODS model classes and objects used to store data saved in the ATFX file, such as calling the recording NVHMeasurement and NVHEnvironment to read the DateTime with nano seconds elapsed.

The API also provides a Utility class that has functions to return data from the ATFX file without the user needing to understand the complexity of the ASAM ODS model classes. Such as the Utility GetListOfAllSignals that return a list of signals that a ATFX file contains or the Utility GetChannelTable that return a 2D list of strings, where each list is an input channel row.

It is also possible to read any of the signals, time or frequency, in other engineering units (EU), such as Acceleration m/s2 to g. As well as reading frequency domain signals in other spectrum types, such as EUrms to EUPeak. All done by the signal function GetFrame where users can pass in parameters to return a converted signal frame data saved in the ATFX file.

When the ATFX API read the ATFX file, there may be some differences in the signal frame data, this is due to some display related parameters such as spectrum type not being saved into the ATFX file. By default, the spectrum type is EUrms2. Engineering units are saved into the ATFX file and should be the the default EU when reading the signal frame.

Documentation

For more detailed information regarding the CI ATFX Reader API, please refer the CI ATFX Reader API Documentation that can be downloaded in this github repository and visit our website Programming Corner for helpful articles:

https://github.com/Crystal-Instruments/CIDataFileReaderAPI/tree/main/Manual

https://www.crystalinstruments.com/basics-of-test-and-measurement

https://www.crystalinstruments.com/programming-corner

CI ATFX Reader API Package Content

Downloading and Installing

You can clone this repository or download the zip file via the green button.

git clone https://github.com/Crystal-Instruments/CIDataFileReaderAPI.git

It is recommended to use Matlab version R2021b or later. And a compatible version of Python for the Python.NET package, such as 3.8 or 2.7.

The Python scripts also import Matplotlib and Numpy.

API DLL Files

The bin folder contains the DLL files that your software integration needs to reference to fully utilize the CI ATFX Reader API methods and objects.

Demo Code

The CI ATFX Reader API demo are used in 4 coding languages:

• C#
• Python
• Matlab
• LabVIEW

C# is the main coding language and demo for the CI ATFX Reader API, while the other coding languages import and reference the DLL files.

For Python, it uses a package called Python.Net to import the CI ATFX Reader API DLL files.

#---Pythonnet clr import
import clr
# Change file path here to whereever the DLL files are
parentPath = "C:\\MyStuff\\DevelopmentalVer\\bin\\AnyCPU\\Debug\\Utility\\CIATFXReader\\"

clr.AddReference(parentPath + "CI.ATFX.Reader.dll")
clr.AddReference(parentPath + "Common.dll")
clr.AddReference('System.Linq')
clr.AddReference('System.Collections')

import numpy as np
import matplotlib.pyplot as plt

#---C# .NET imports & dll imports
from EDM.Recording import *
from EDM.RecordingInterface import *
from ASAM.ODS.NVH import *
from EDM.Utils import *
from Common import *
from Common import _SpectrumScalingType
from Common.Spider import *
from System import *
from System.Diagnostics import *
from System.Reflection import *
from System.Text import *
from System.IO import *

For Matlab, it uses the in built method that Matlab provides to import the CI ATFX Reader API DLL files.

% Load common and reader dll
NET.addAssembly('C:\MyStuff\DevelopmentalVer\bin\AnyCPU\Debug\Utility\CIATFXReader\Common.dll');
NET.addAssembly('C:\MyStuff\DevelopmentalVer\bin\AnyCPU\Debug\Utility\CIATFXReader\CI.ATFX.Reader.dll');

For LabVIEW, it imports the CI ATFX Reader API methods directly while using another DLL file to assist LabVIEW in comprehending C# objects and methods. Please use the DLL files locate in $CI ATFX Reader API/LabVIEW ATFX API/Private for the LabVIEW demo and integration to work properly.

Manuals

Included with the demo code and API DLL files are technical manuals that can help users in understanding the various methods and objects in the CI ATFX Reader API.

There are .pdfs that provide in-depth explanation and the .chm file that provide a quick reference library.

License & Term Agreement

Linked below is the Crystal Instruments' End License Agreement for usage:

Crystal Instruments End License Agreement