sdynpy.fileio.sdynpy_vic.read_vic3D_mat_files

• Module: sdynpy.fileio.sdynpy_vic

• Source: GitHub

Signature¶

def sdynpy.fileio.sdynpy_vic.read_vic3D_mat_files(files, read_3D=True, read_2D=False, read_quality=False, sigma_tol=0.0, element_triangulation_condition=3.0, dt=1.0, element_color_order=[1, 3, 5, 7, 9, 11, 13, 15, 2, 4, 6, 8, 10, 12, 14], allow_dropouts=False)

Reads in data from Correlated Solutions’ VIC3D

Parameters¶

• files : Iterable of str List of strings pointing to .mat files exported from VIC3D.

• read_3D : bool, optional Flag specifying whether or not to extract 3D information. The default is True.

• read_2D : bool, optional Flag specifying whether or not to extract 2D (pixel) information. The default is False.

• read_quality : bool, optional Flag specifying whether or not to output quality (sigma) information. Note that the quality value will be read regardless in order to discard bad subsets. This flag only specifies whether the values are returned to the user. The default is False.

• sigma_tol : float, optional Tolerance used to discard bad subsets. The default is 0.0.

• element_triangulation_condition : float, optional Maximum condition number for triangular elements generated from subset. positions. The default is 3.0.

• dt : float, optional Time spacing to be used in the returned TimeHistoryArrays. The default is 1.0.

• element_color_order : Iterable, optional Specifies the color order used when creating elements from the various areas of interest in the VIC3D output. The first area of interest will have color specified by the first entry in the array. The array will loop around if more areas of interest exist than values in the array. The default is [1,3,5,7,9,11,13,15,2,4,6,8,10,12,14].

• allow_dropouts : bool, optional Specifies whether or not to allow data to drop out (True) or if the entire point is discarded if any dropouts are detected (False). Default is False.

Returns¶

• geometry_3D : Geometry Geometry object consisting of the 3D node positions from the test. Only returned if read_3D is True

• time_data_3D : TimeHistoryArray 3D Displacement data from the test. Only returned if read_3D is True.

• geometry_2D : Geometry Geometry object consisting of the 2D (pixel) node positions from the test. Only returned if read_2D is True

• time_data_2D : TimeHistoryArray 2D Pixel Displacement data from the test. Only returned if read_2D is True.

• time_data_2D_disparity : TimeHistoryArray 2D Pixel Displacement data from the test for the second camera. Adding this array to the original pixel positions will result in the pixel positions over time for the right image. Only returned if read_2D is True.

• sigma_data : TimeHistoryArray Data quality metric for the test over time. Only returned if read_quality is True