Interface IOperationsHeatmapLineDataSeriesViewModel
Last update: 16.07.2025Namespace: VM.Operations.Post.Interfaces
Assembly: VM.Operations.Post.dll
Represents a view model for the heatmap line data series.
public interface IOperationsHeatmapLineDataSeriesViewModel : IOperationsLineDataSeriesViewModelBase, ILineDataSeriesViewModelBase, IHasSourceViewModel, IViewModel, IObservableObject, IDisposableObject, IEnabled, IExpanded, ISelected, IVisible, IThicknessProperty, IOperationsBase
Implements
IOperationsLineDataSeriesViewModelBase, ILineDataSeriesViewModelBase, IHasSourceViewModel, IViewModel, IObservableObject, IDisposableObject, IEnabled, IExpanded, ISelected, IVisible, IThicknessProperty, IOperationsBase
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.
# IOperationsHeatmapLineDataSeriesViewModel.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)
# SamplingFrequency - the number of the interval for dividing Y direction grids on color map.
# TimeSlice - the number of the interval for dividing X direction grids on color map.
# Overlap - the value of the percentage for setting overlapped intervals.
# SelectedPoints - 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.
# ReferenceValue - the reference value on decibel as the type of the scale.
# ScaleFactor - the scale factor to change from time domain to another domain.
# SelectedScaleType - the scale type of STFT. STFT Scale Type has Original, Decibel.
data = HeatMapSTFTDataViewModel()
data.SamplingFrequency = 100
data.TimeSlice = 0.05
data.Overlap = 50
data.SelectedPoints = 256
data.Start = 0
data.End = 0.5
data.ReferenceValue = 1E-05
data.ScaleFactor = 1.0
data.SelectedScaleType = STFTScaleType.Original
stfts = chartView.CreateSTFT(data, curves)
# Documentation Example
parameters = List[INumericParameter](2)
parameter = NumericParameter()
parameter.Name = r'Y'
parameter.TargetX = r'X'
parameter.TargetY = r'Y'
parameters.Add(parameter)
# The output path is 'examples/Output'.
output_dir = get_output_directory()
export_filepath = combine_path(output_dir, r'example.csv')
applicationHandler.ImportNumeric(stfts[0], export_filepath, parameters)
curves = stfts[0].STFT2DViewModel.GetCurves("Y")
curves[0].Harmonic = 5
curves[0].Interval = 0.3
# Close the Pages
page.Close()
# Close Document
applicationHandler.CloseDocument(result_file_path)
Properties
Harmonic
Gets or sets the slope of the curve at the start point.
double Harmonic { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsHeatmapLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the slope of the curve at the start point.
Interval
Gets or sets the value of the interval.
double Interval { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsHeatmapLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the value of the interval.