WrightTools.data.join

WrightTools.data.join(datas, *, atol=None, rtol=None, name='join', parent=None, method='first', verbose=True) → WrightTools.data._data.Data[source]

Join a list of data objects together.

Joined datas must have the same transformation applied. This transformation will define the array order for the joined dataset. All axes in the applied transformation must be a single variable, the result will have sorted numbers.

Join does not perform any interpolation. For that, look to Data.map_variable or Data.heal

Parameters
  • datas (list of data or WrightTools.Collection) – The list or collection of data objects to join together.

  • atol (numeric or list of numeric) – The absolute tolerance to use (in np.isclose) to consider points overlapped. If given as a single number, applies to all axes. If given as a list, must have same length as the data transformation. None in the list invokes default behavior. Default is 10% of the minimum spacing between consecutive points in any input data file.

  • rtol (numeric or list of numeric) – The relative tolerance to use (in np.isclose) to consider points overlapped. If given as a single number, applies to all axes. If given as a list, must have same length as the data transformation. None in the list invokes default behavior. Default is 4 * np.finfo(dtype).resolution for floating point types, 0 for integer types.

  • name (str (optional)) – The name for the data object which is created. Default is ‘join’.

  • parent (WrightTools.Collection (optional)) – The location to place the joined data object. Default is new temp file at root.

  • method ({'first', 'last', 'min', 'max', 'sum', 'mean'}) – Mode to use for merged points in the joined space. Default is ‘first’.

  • verbose (bool (optional)) – Toggle talkback. Default is True.

Returns

A new Data instance.

Return type

WrightTools.data.Data