`ResultAnnotationCollection`

A collection of 2D graph annotation.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
app.Views[1]:Close()

    -- Add a Cartesian graph to the application's collection and obtain
    -- the arrow collection

graph = app.CartesianGraphs:Add()
farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1])
graph:ZoomToExtents()
annotations = graph.Annotations

annotation1 = annotations:AddGlobalMaximum(farFieldTrace)

Usage locations

The ResultAnnotationCollection object can be accessed from the following locations:

Collection lists
- SmithChart object has collection Annotations.
- PolarGraph object has collection Annotations.
- CartesianGraph object has collection Annotations.
- Graph object has collection Annotations.

Property List

Count: The number of GraphAnnotation items in the collection. (Read only number)
Type: The object type string. (Read only string)

Method List

AddBandwidth10dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum): Adds a -10dB bandwidth annotation. (Returns a GraphAnnotation object.)
AddBandwidth15dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum): Adds a -15dB bandwidth annotation. (Returns a GraphAnnotation object.)
AddBandwidth3dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum): Adds a -3dB bandwidth annotation. (Returns a GraphAnnotation object.)
AddBandwidthAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum, level number): Adds a bandwidth annotation. (Returns a GraphAnnotation object.)
AddBeamwidthAnnotation (trace ResultTrace, beamwidthtype AnnotationBeamwidthTypeEnum, relativePoint AnnotationRelativeTypeEnum): Adds a beam width annotation. (Returns a GraphAnnotation object.)
AddDeltaAnnotation (trace ResultTrace): Adds a delta annotation. (Returns a GraphAnnotation object.)
AddDerivedWidthAnnotation (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum, offsetType AnnotationWidthDefinitionTypeEnum, offset number): Adds a derived width annotation. (Returns a GraphAnnotation object.)
AddFirstLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first local maximum. (Returns a GraphAnnotation object.)
AddFirstLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first local maximum searching to the left. (Returns a GraphAnnotation object.)
AddFirstLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first local maximum searching to the right. (Returns a GraphAnnotation object.)
AddFirstLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first local minimum. (Returns a GraphAnnotation object.)
AddFirstLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first local minimum searching to the left. (Returns a GraphAnnotation object.)
AddFirstLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first local minimum searching to the right. (Returns a GraphAnnotation object.)
AddFirstNullBeamwidthAnnotation (trace ResultTrace): Adds a beam width annotation. (Returns a GraphAnnotation object.)
AddGlobalMaximum (trace ResultTrace): Adds a GlobalMax annotation to the trace. (Returns a GraphAnnotation object.)
AddGlobalMinimum (trace ResultTrace): Adds a GlobalMin annotation to the trace. (Returns a GraphAnnotation object.)
AddGreatestLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the largest local maximum. (Returns a GraphAnnotation object.)
AddGreatestLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first largest local maximum searching to the left. (Returns a GraphAnnotation object.)
AddGreatestLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first largest local maximum searching to the right. (Returns a GraphAnnotation object.)
AddGreatestLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the largest local minimum. (Returns a GraphAnnotation object.)
AddGreatestLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first largest local minimum searching to the left. (Returns a GraphAnnotation object.)
AddGreatestLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum): Adds an annotation to the first largest local minimum searching to the right. (Returns a GraphAnnotation object.)
AddHalfPowerBeamwidthAnnotation (trace ResultTrace): Adds a beam width annotation. (Returns a GraphAnnotation object.)
AddIndependentValue (trace ResultTrace, horizontalposition number, verticalposition number): Adds an annotation at a position on the graph by defining the horizontal position (independent axis value) and the vertical position (dependent axis value). (Returns a GraphAnnotation object.)
AddNullToNullBeamwidthAnnotation (trace ResultTrace): Adds a beam width annotation. (Returns a GraphAnnotation object.)
AddSideLobeLevelAnnotation (trace ResultTrace): Adds a side lobe level annotation. (Returns a GraphAnnotation object.)
AddValueAtHorizontalPosition (trace ResultTrace, horizontalposition number): Adds an annotation at a horizontal position (independent axis value). (Returns a GraphAnnotation object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number): Returns the GraphAnnotation at the given index. (Returns a GraphAnnotation object.)
Item (label string): Returns the GraphAnnotation with the given label. (Returns a GraphAnnotation object.)
Items (): Returns a table of GraphAnnotation. (Returns a List of GraphAnnotation object.)
UniqueName (label string): Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]: Returns the GraphAnnotation at the given index in the collection. (Read GraphAnnotation)
[string]: Returns the GraphAnnotation with the given name in the collection. (Read GraphAnnotation)

Property Details

Count

The number of GraphAnnotation items in the collection.

Type: number
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Method Details

AddBandwidth10dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum)

Adds a -10dB bandwidth annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
bandwidthtype(AnnotationBandwidthTypeEnum): The bandwidth type.

Return

GraphAnnotation: The annotation on the graph.

AddBandwidth15dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum)

Adds a -15dB bandwidth annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
bandwidthtype(AnnotationBandwidthTypeEnum): The bandwidth type.

Return

GraphAnnotation: The annotation on the graph.

AddBandwidth3dBAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum)

Adds a -3dB bandwidth annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
bandwidthtype(AnnotationBandwidthTypeEnum): The bandwidth type.

Return

GraphAnnotation: The annotation on the graph.

AddBandwidthAnnotation (trace ResultTrace, bandwidthtype AnnotationBandwidthTypeEnum, level number)

Adds a bandwidth annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
bandwidthtype(AnnotationBandwidthTypeEnum): The bandwidth type.
level(number): The bandwidth level (in dB).

Return

GraphAnnotation: The annotation on the graph.

AddBeamwidthAnnotation (trace ResultTrace, beamwidthtype AnnotationBeamwidthTypeEnum, relativePoint AnnotationRelativeTypeEnum)

Adds a beam width annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
beamwidthtype(AnnotationBeamwidthTypeEnum): The beam width type.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddDeltaAnnotation (trace ResultTrace)

Adds a delta annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddDerivedWidthAnnotation (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum, offsetType AnnotationWidthDefinitionTypeEnum, offset number)

Adds a derived width annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point with which the annotation is relative.
offsetType(AnnotationWidthDefinitionTypeEnum): The type of offset.
offset(number): The offset value.

Return

GraphAnnotation: The annotation on the graph.

AddFirstLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first local maximum.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddFirstLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first local maximum searching to the left.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddFirstLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first local maximum searching to the right.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddFirstLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first local minimum.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddFirstLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first local minimum searching to the left.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddFirstLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first local minimum searching to the right.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddFirstNullBeamwidthAnnotation (trace ResultTrace)

Adds a beam width annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddGlobalMaximum (trace ResultTrace)

Adds a GlobalMax annotation to the trace.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddGlobalMinimum (trace ResultTrace)

Adds a GlobalMin annotation to the trace.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddGreatestLocalMaximum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the largest local maximum.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddGreatestLocalMaximumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first largest local maximum searching to the left.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddGreatestLocalMaximumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first largest local maximum searching to the right.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddGreatestLocalMinimum (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the largest local minimum.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddGreatestLocalMinimumToLeft (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first largest local minimum searching to the left.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddGreatestLocalMinimumToRight (trace ResultTrace, relativePoint AnnotationRelativeTypeEnum)

Adds an annotation to the first largest local minimum searching to the right.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
relativePoint(AnnotationRelativeTypeEnum): The point where the search starts.

Return

GraphAnnotation: The annotation on the graph.

AddHalfPowerBeamwidthAnnotation (trace ResultTrace)

Adds a beam width annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddIndependentValue (trace ResultTrace, horizontalposition number, verticalposition number)

Adds an annotation at a position on the graph by defining the horizontal position (independent axis value) and the vertical position (dependent axis value).

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
horizontalposition(number): The horizontal position (independent axis value).
verticalposition(number): The vertical position (dependent axis value).

Return

GraphAnnotation: The annotation on the graph.

AddNullToNullBeamwidthAnnotation (trace ResultTrace)

Adds a beam width annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddSideLobeLevelAnnotation (trace ResultTrace)

Adds a side lobe level annotation.

Input Parameters

trace(ResultTrace): The trace associated with the annotation.

Return

GraphAnnotation: The annotation on the graph.

AddValueAtHorizontalPosition (trace ResultTrace, horizontalposition number)

Adds an annotation at a horizontal position (independent axis value).

Input Parameters

trace(ResultTrace): The trace associated with the annotation.
horizontalposition(number): The horizontal position (independent axis value).

Return

GraphAnnotation: The annotation on the graph.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the GraphAnnotation.

Return

boolean: The success of the check.

Item (index number)

Returns the GraphAnnotation at the given index.

Input Parameters

index(number): The index of the GraphAnnotation.

Return

GraphAnnotation: The GraphAnnotation at the given index.

Item (label string)

Returns the GraphAnnotation with the given label.

Input Parameters

label(string): The label of the GraphAnnotation.

Return

GraphAnnotation: The GraphAnnotation with the given label.

Items ()

Returns a table of GraphAnnotation.

Return

List of GraphAnnotation: A table of GraphAnnotation.

UniqueName (label string)

Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

boolean: The generated unique name label for GraphAnnotation.