Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

sdynpy.fileio.sdynpy_psv.DataPoint

Signature

class sdynpy.fileio.sdynpy_psv.DataPoint(obj: 'Any') -> 'None'

Wrapper around a COM data point.

Attributes

NameSummary
average_countNumber of traces that contributed to this averaged result.
meas_pointMeasurement point corresponding to this data point.
point_domainParent point domain.

average_count

Number of traces that contributed to this averaged result.

meas_point

Measurement point corresponding to this data point.

point_domain

Parent point domain.

Methods

NameSummary
__init__Initialize self. See help(type(self)) for accurate signature.
get_3d_dataRetrieve 3D data for a given display and frame.
get_3d_data_sectionRetrieve a section of 3D data for a given display.
get_dataRetrieve data for a given display and frame.
get_data_sectionRetrieve a section of data for a given display.
get_frame_boundariesRetrieve frame boundaries for a given time signal.
get_framesRetrieve the frame count for a given display.
get_scan_statusRetrieve the scan status for a given display.

__init__

def sdynpy.fileio.sdynpy_psv.DataPoint.__init__(self, obj: 'Any') -> 'None'

Initialize self. See help(type(self)) for accurate signature.

get_3d_data

def sdynpy.fileio.sdynpy_psv.DataPoint.get_3d_data(self, display: 'Any', frame: 'int' = 0) -> 'np.ndarray'

Retrieve 3D data for a given display and frame.

get_3d_data_section

def sdynpy.fileio.sdynpy_psv.DataPoint.get_3d_data_section(self, display: 'Any', frame: 'int', average: 'int', first_index: 'int', last_index: 'int') -> 'np.ndarray'

Retrieve a section of 3D data for a given display.

get_data

def sdynpy.fileio.sdynpy_psv.DataPoint.get_data(self, display: 'Any', frame: 'int' = 0) -> 'np.ndarray'

Retrieve data for a given display and frame.

get_data_section

def sdynpy.fileio.sdynpy_psv.DataPoint.get_data_section(self, display: 'Any', frame: 'int', average: 'int', first_index: 'int', last_index: 'int') -> 'np.ndarray'

Retrieve a section of data for a given display.

get_frame_boundaries

def sdynpy.fileio.sdynpy_psv.DataPoint.get_frame_boundaries(self, display: 'Any', average: 'int' = 1) -> 'np.ndarray'

Retrieve frame boundaries for a given time signal.

get_frames

def sdynpy.fileio.sdynpy_psv.DataPoint.get_frames(self, display: 'Any') -> 'int'

Retrieve the frame count for a given display.

get_scan_status

def sdynpy.fileio.sdynpy_psv.DataPoint.get_scan_status(self, display: 'Any') -> 'ScanStatus'

Retrieve the scan status for a given display.