Interface ZOSAPI::Analysis::IUserAnalysisData

Definition:

Properties and methods used to generate a User Analysis. This interface can be accessed via the IZOSAPI_Application interface. Note that this interface is only available when creating a User Analysis plugin application.

Members

• AnalysisNumber
• FeatureDescription
• HeaderData
• Make2DLinePlot
• Make2DLinePlotSafe
• MakeGridPlot
• MakeGridRGBPlot
• MakeText
• PlotType
• RunAnalysisOnSettingsClosed
• ShowLegend
• UserSettings
• WindowTitle

Properties

Property AnalysisNumber

Definition:

int ZOSAPI.Analysis.IUserAnalysisData.AnalysisNumber

Gets the position of this user analysis in the primary IOpticalSystem. Note that this number may change when other analyses are opened or closed.

The analysis number.

Return type: int

Property PlotType

Definition:

UserAnalysisDataType ZOSAPI.Analysis.IUserAnalysisData.PlotType

Gets the type of this plot window.

The type of the plot.

Return type: UserAnalysisDataType

Property WindowTitle

Definition:

string ZOSAPI.Analysis.IUserAnalysisData.WindowTitle

Return type: string

Property FeatureDescription

Definition:

string ZOSAPI.Analysis.IUserAnalysisData.FeatureDescription

Return type: string

Property HeaderData

Definition:

string [] ZOSAPI.Analysis.IUserAnalysisData.HeaderData

Return type: string[]

Property ShowLegend

Definition:

bool ZOSAPI.Analysis.IUserAnalysisData.ShowLegend

Return type: bool

Property UserSettings

Definition:

ISettingsData ZOSAPI.Analysis.IUserAnalysisData.UserSettings

Return type: ISettingsData

Property RunAnalysisOnSettingsClosed

Definition:

bool ZOSAPI.Analysis.IUserAnalysisData.RunAnalysisOnSettingsClosed

Return type: bool

Public functions

Function Make2DLinePlot

IUser2DLineData ZOSAPI.Analysis.IUserAnalysisData.Make2DLinePlot(String PlotDescription, uint numValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]double[] xValues)

Gets an interface used to configure a 2D line plot.

Parameters:

• PlotDescription: The plot description.
• numValues: The number of x-values. Note that multiple series are supported, but they all must share the same x data.
• xValues: The x values.

Returns:

Parameters:

• String PlotDescription
• uint numValues
• [In] double[] xValues

Return type: IUser2DLineData

Function Make2DLinePlotSafe

IUser2DLineData ZOSAPI.Analysis.IUserAnalysisData.Make2DLinePlotSafe(String PlotDescription, [In]double[] xValues)

Gets an interface used to configure a 2D line plot.

Parameters:

• PlotDescription: The plot description.
• xValues: The x values.

Returns:

Parameters:

• String PlotDescription
• [In] double[] xValues

Return type: IUser2DLineData

Function MakeGridPlot

IUserGridData ZOSAPI.Analysis.IUserAnalysisData.MakeGridPlot(String PlotDescription)

Gets an interface used to configure a 2D grid plot.

Parameters:

• PlotDescription: The plot description.

Returns:

Parameters:

• String PlotDescription

Return type: IUserGridData

Function MakeGridRGBPlot

IUserGridRGBData ZOSAPI.Analysis.IUserAnalysisData.MakeGridRGBPlot(String PlotDescription)

Gets an interface used to configure a 2D RGB grid plot.

Parameters:

• PlotDescription: The plot description.

Returns:

Parameters:

• String PlotDescription

Return type: IUserGridRGBData

Function MakeText

IUserTextData ZOSAPI.Analysis.IUserAnalysisData.MakeText()

Gets an interface used to configure a simple text window.

Returns:

Return type: IUserTextData