sdynpy.fileio.sdynpy_psv - SDynPy: A Structural Dynamics Python Package

Source: GitHub

Load and wrap data from Polytec PSV files.

This module provides a Python wrapper around the Polytec Polyfile COM interface, along with convenience methods for extracting common data products into sdynpy objects.

Notes¶

This module requires pywin32 and therefore only works on Windows.
Many objects exposed by this module are thin wrappers around COM objects.
Where the exact runtime type returned by COM is uncertain, conservative type annotations such as Any are used.

Classes¶

Name	Summary
`AcqBoard`	Acquisition-board type.
`AcquisitionMode`	Measurement acquisition mode.
`Alignment2D`	Wrapper around COM 2D alignment data and operations.
`Alignment3D`	Wrapper around COM 3D alignment data and operations.
`AlignmentCamera`	Wrapper around COM camera-alignment data and operations.
`AlignmentPoint2D`	Wrapper around a COM 2D alignment point.
`AlignmentPoint3D`	Wrapper around a COM 3D alignment point.
`AlignmentPoint3DCaps`	3D alignment-point capability flags.
`AlignmentPoint3DType`	3D alignment-point type.
`Alignments`	Wrapper around the COM alignments info object.
`Attribute`	Wrapper around a COM signal attribute.
`AverageProperties`	Wrapper around COM average settings.
`AverageType`	Averaging mode.
`BandwidthExtension`	Bandwidth-extension setting.
`BurstChirpWaveform`	Burst-chirp waveform settings.
`BurstRandomWaveform`	Burst-random waveform settings.
`CameraSize`	Wrapper around COM camera-size information.
`Channel`	Wrapper around a COM signal channel.
`ChannelCaps`	Signal channel capability flags.
`ChannelsProperties`	Wrapper around COM acquisition channel properties.
`ChannelType`	Acquisition channel type.
`ControllerCaps`	Controller capability flags.
`ControllerInfo`	Wrapper around COM controller-information settings.
`ControllerSettings`	Wrapper around COM vibrometer-controller settings.
`CoordDefinitionMode`	3D coordinate-definition mode.
`Coupling`	Input coupling mode.
`DataPoint`	Wrapper around a COM data point.
`DataType`	Signal data type.
`DecoderInfo`	Wrapper around COM decoder information.
`DegreeOfFreedomID`	Wrapper around a COM degree-of-freedom identifier.
`DigitalFilter`	Wrapper around COM digital filter settings.
`DigitalFilterQuality`	Quality setting for digital filters.
`DigitalFilterType`	Digital filter type.
`Direction`	Measurement direction.
`Display`	Wrapper around a COM signal display.
`DisplayType`	Display type for a signal.
`DistanceSensorControl`	Wrapper around COM distance-sensor control.
`DistanceSensorType`	Distance-sensor type.
`DOFDirection`	Degree-of-freedom direction.
`Domain`	Wrapper around a COM domain.
`DomainType`	Signal domain type.
`Element`	Wrapper around a COM geometry element.
`FastScanProperties`	Wrapper around COM FastScan acquisition properties.
`FFTProperties`	Wrapper around COM FFT acquisition properties.
`FilterSettings`	Wrapper around COM controller-filter settings.
`FilterType`	Filter type used in controller/filter settings.
`FocusStatus`	Laser-focus status flags.
`FrontEnd`	Wrapper around COM front-end information.
`FrontEndCaps`	Front-end capability flags.
`FrontEndProperties`	Wrapper around COM front-end acquisition properties.
`FrontEndType`	Front-end type.
`FunctionType`	Signal function type.
`GeneralProperties`	Wrapper around COM general acquisition properties.
`GeneratorsProperties`	Wrapper around COM signal-generator properties.
`GeneratorType`	Signal-generator type.
`GeometryComponent`	Wrapper around a COM geometry component.
`GeometryStatus`	3D geometry status flags.
`GraphicFormatType`	Graphics export format.
`Hardware`	Wrapper around COM hardware info.
`LensCalibration`	Wrapper around COM lens calibration information.
`LensCalibrationCaps`	Lens-calibration capability flags.
`MeasPoint`	Wrapper around a COM measurement point.
`MeasPoints`	Pythonic wrapper around the COM measurement-point collection.
`MeasurementLocation`	Wrapper around a COM measurement-location object.
`MeasurementLocationMode`	Measurement-location mode.
`MultiCarrierCWWaveform`	Multi-carrier continuous-wave waveform settings.
`MultiFrameMode`	Multi-frame acquisition mode.
`MultiFrameProperties`	Wrapper around COM multi-frame acquisition properties.
`PeriodicChirpWaveform`	Periodic-chirp waveform.
`PhysicalQuantity`	Physical quantity identifier.
`PointDomain`	Wrapper around a COM point domain.
`PolyFile`	High-level wrapper around a Polytec PSV file COM object.
`PreferredScanDirection`	Preferred scan direction.
`Profile`	Wrapper around a COM profile object.
`ProfileType`	Profile type.
`PseudoRandomWaveform`	Pseudo-random waveform.
`QuantitySettings`	Wrapper around COM quantity settings.
`QuantityType`	Quantity type used in controller quantity settings.
`RampWaveform`	Ramp waveform settings.
`ScanHeadCaps`	Scanning-head capability flags.
`ScanHeadDevice`	Wrapper around a COM scan-head device.
`ScanHeadDevicesInfo`	Wrapper around COM scan-head-devices info.
`ScanHeadLaserFocus`	Wrapper around COM scan-head focus settings.
`ScanHeadScanner`	Wrapper around COM scan-head scanner settings.
`ScanHeadType`	Scanning-head type.
`ScanHeadVideo`	Wrapper around COM scan-head video settings.
`ScanHeadVideoType`	Scanning-head video capability/type flags.
`ScanStatus`	Scan-point status flags.
`SensorHeadCaps`	Sensor-head capability flags.
`SensorHeadCaps2`	Extended sensor-head capability flags.
`SensorHeadInfo`	Wrapper around COM sensor-head information.
`SensorHeadSettings`	Wrapper around COM sensor-head settings.
`Signal`	Wrapper around a COM signal.
`SignalBalanceState`	Signal-balance state.
`SignalDescription`	Wrapper around COM signal metadata.
`SignalEnhancementMode`	Signal enhancement (SE) mode.
`SignalEnhancementProperties`	Wrapper around COM signal-enhancement properties.
`SignalXAxis`	Wrapper around a COM signal x-axis descriptor.
`SignalYAxis`	Wrapper around a COM signal y-axis descriptor.
`SineWaveform`	Sine waveform settings.
`SpectrogramInfo`	Wrapper around COM spectrogram/campbell-diagram info.
`SquareWaveform`	Square waveform settings.
`SweepWaveform`	Sweep waveform settings.
`Texture`	Wrapper around a COM texture object.
`TimeProperties`	Wrapper around COM time-acquisition properties.
`TriangleWaveform`	Triangle waveform settings.
`TriggerEdge`	Trigger edge polarity.
`TriggerProperties`	Wrapper around COM trigger properties.
`TriggerSource`	Trigger source.
`UserDefinedWaveform`	User-defined waveform settings.
`VibrometerProperties`	Wrapper around COM vibrometer acquisition properties.
`VideoBitmap`	Wrapper around COM video-bitmap info.
`VideoCameraSettings`	Wrapper around COM video-camera settings.
`VideoMappingInfo`	Wrapper around COM video-mapping information.
`Waveform`	Base wrapper for generator waveform settings.
`WaveformType`	Signal-generator waveform type.
`WhiteNoiseWaveform`	White-noise waveform.
`WindowFunction`	Window function used for time/FFT processing.
`XAxis`	Wrapper around a COM x-axis descriptor.
`YAxis`	Wrapper around a COM y-axis descriptor.
`ZoomFFTProperties`	Wrapper around COM zoom-FFT acquisition properties.

Functions¶

Name	Summary
`controller_caps_list`	Return individual controller capability flags set in `caps_value`.
`decode_controller_caps`	Decode an integer bitmask into :class:`ControllerCaps`.
`make_waveform`	Wrap a COM waveform object in the appropriate Python subclass.