Interface IOperationsFFTLineDataSeriesViewModel
Last update: 16.07.2025Namespace: VM.Operations.Post.Interfaces
Assembly: VM.Operations.Post.dll
Represents a view model for the fft line data series.
public interface IOperationsFFTLineDataSeriesViewModel
Examples
For an example that includes information about interfaces, see this example. To view the examples, refer to the location of the 'Install_Path\Motion\Document\Postprocessor API for Python.zip' file.
# IOperationsFFTLineDataSeriesViewModel.py
import sys
current_dir = __file__.rsplit('\\', 1)[0]
external_modules_path = current_dir + '\\..\\..\\Modules'
sys.path.append(external_modules_path)
from OperationAPI import *
# Start the headless application interface
applicationHandler = ApplicationHandler()
# Import result file
result_file_path = get_result_file_path()
# Set array about result file
filepaths = List[str]()
filepaths.Add(result_file_path)
# Open about result files
applicationHandler.AddDocument(filepaths)
# Get Page
page = applicationHandler.GetActivePage()
# Create PlotView
chartView = page.CreateChart("Chart")
# Set array about combination of characteristic and component
curvePaths = List[str]()
curvePaths.Add(r'Displacement/Magnitude')
# Set a Curve Parameter
parameters = PlotParameters()
parameters.Paths = curvePaths
parameters.Target = "Crank"
# Add Curves (FilePath, Curve Parameter)
# FilePath - The path of the result to access.
# parameters - The class used as a parameter of the AddCurve function.
# The instance of the curve.
curves = chartView.AddCurves(result_file_path, parameters)
# Documentation Example
# create_fft.py
# SeriesNames - A list of curve names.
# FFTType - Magnitude, Phase
# FFTWindowType - Rectangular, Triangular, Bartlett, Hanning, Hamming, Welch, BlackMan, None
# ScaleType - Original, Logarithm, Decibel
# Points - The number of data point for FFT
# Start - The start time for using FFT on target data series
# End - The end time for using FFT on target data series
ffts = chartView.CreateFFT(curves, FFTType.Magnitude, FFTWindowType.Rectangular, ScaleType.Original, 128, 0, 1.0)
ffts[0].Start = 0.02
ffts[0].End = 1.0
ffts[0].FFTScaleType = ScaleType.Logarithm
ffts[0].FFTType = FFTType.Phase
ffts[0].FFTWindowType = FFTWindowType.Hanning
ffts[0].SelectedPoints = 512
# Close the Pages
page.Close()
# Close the Document
applicationHandler.CloseDocument(result_file_path)
Properties
End
Gets or sets the end time for using FFT on the target data series.
double End { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsFFTLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the end time for performing FFT on the target data series.
FFTScaleType
Gets or sets the scale type of FFT.
ScaleType FFTScaleType { get; set; }
Property Value
ScaleType
Examples
For an example that includes this property, see the Interface IOperationsFFTLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the scale type for FFT. The supported types are:
FFTType
Gets or sets the type of FFT.
FFTType FFTType { get; set; }
Property Value
FFTType
Examples
For an example that includes this property, see the Interface IOperationsFFTLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the type of FFT. The supported types are:
FFTWindowType
Gets or sets the window type of FFT.
FFTWindowType FFTWindowType { get; set; }
Property Value
FFTWindowType
Examples
For an example that includes this property, see the Interface IOperationsFFTLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the window type for FFT. The supported types are:
SelectedPoints
Gets or sets the number of data points for FFT.
int SelectedPoints { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsFFTLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the number of data points to be used for FFT.
Start
Gets or sets the start time for using FFT on the target data series.
double Start { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsFFTLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the start time for performing FFT on the target data series.