read_sdt¶
-
glotaran.builtin.file_formats.sdt.sdt_file_reader.
read_sdt
(file_path: str, index: Optional[numpy.ndarray] = None, flim: bool = False, dataset_index: Optional[int] = None, swap_axis: bool = False, orig_time_axis_index: int = 2) → xarray.core.dataset.Dataset[source]¶ Reads a *.sdt file and returns a pd.DataFrame (return_dataframe==True), a SpectralTemporalDataset (type_of_data==’st’) or a FLIMDataset (type_of_data==’flim’).
- Parameters
file_path (str) – Path to the sdt file which should be read.
index (list, np.ndarray) – This is only needed if type_of_data==”st”, since *.sdt files, which only contain spectral temporal data, lack the spectral information. Thus for the spectral axis data need to be given by the user.
flim – Set true if reading a result from a FLIM measurement.
dataset_index (int: default 0) – If the *.sdt file contains multiple datasets the index will used to select the wanted one
swap_axis (bool, default False) – Flag to switch a wavelength explicit input_df to time explicit input_df, before generating the SpectralTemporalDataset.
orig_time_axis_index (int) – Index of the axis which corresponds to the time axis. I.e. for data of shape (64, 64, 256), which are a 64x64 pixel map with 256 time steps, orig_time_axis_index=2.
- Raises
IndexError: – If the length of the index array is incompatible with the data.