Interface IOperationsFFTLineDataSeriesViewModel

Namespace: 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

# Get the current file's path and set the path for external modules.
current_dir = __file__.rsplit('\\', 1)[0]
external_modules_path = current_dir + '\\..\\..\\Modules'
sys.path.append(external_modules_path)

# Import necessary modules
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
# This will open the result file in the application.
# When the result is first opened, a Page is created and an Animation View is created on that Page.
applicationHandler.AddDocument(filepaths)

# Get Active Page
# This retrieves the currently active page in the application.
page = applicationHandler.GetActivePage()

# Creating a Chart
# Create a new Chart View on the page
# This will create a new chart view with the specified name.
chartView = page.CreateChart("Chart")

# Set array about combination of characteristic and component
curvePaths = List[str]()
curvePaths.Add(r'Displacement/Magnitude')

# Create a PlotParameters object to specify the parameters for the plot.
# Set the Entity to Plot.
# The Target is the name of the target for which you want to retrieve the curves.
# Set the paths for the curves you want to retrieve.
# This is where you specify the characteristics and components you want to plot.
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

double

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

int

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

double

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.