Keysight Pathwave 89600 VSA .NET API
Spectrogram Class Members
See Also  Properties  Methods  Events
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace : Spectrogram Class

Glossary Item Box

The following tables list the members exposed by Spectrogram.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyColorCountGets or sets the number of color levels for the spectrogram / 3D map.  
Public PropertyColorMapGets or sets how to map values to colors.  
Public PropertyCountGets the number of scans in the current spectrogram.  
Public PropertyEnhanceGets or sets the color enhancement factor, which affects the distribution of colors in the spectrogram / 3D map.  
Public PropertyFirstGets or sets the first (top) scan displayed in a spectrogram.  
Public PropertyFirstOnTraceGets the first (top) scan that is actually displayed.  
Public PropertyHeightGets or sets the height of the spectrogram (in seconds).  
Public PropertyHeightOnTraceGets the number of scans that are actually displayed.  
Public PropertyIsDisposedGets a value indicating whether the object has been disposed. If an object has been disposed any attempt to use it will lead to an ObjectDisposedException being thrown. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public PropertyIsFirstAutoGets or sets a value indicating whether the first (top) scan is automatically determined (not from the First property).  
Public PropertyIsHeightAutoGets or sets a value indicating whether the height is automatically determined from the size of the window (not from the Height property).  
Public PropertyIsTraceSelectVisibleGets or sets a value indicating whether spectrogram TraceSelect is enabled.  
Public PropertyIsVisibleGets a value indicating whether Style is TracePersistence.Spectrogram and shown in a compatible Trace.Format.  
Public PropertyLastGets or sets the last (bottom) scan displayed in a spectrogram.  
Public PropertyMapColorNamesGets the array of ColorCount color names in the current ColorMap.  
Public PropertyMaxCountGets or sets the maximum number of scans of data persisted in a spectrogram.  
Public PropertyStyleGets or sets whether spectrogram / 3D map is turned on, the persistence model, and how colors are mapped  
Public PropertyThresholdGets or sets the threshold, which affects the minimum amplitude value that will be shown in the spectrogram / 3D map.  
Public PropertyTraceSelectGets or sets the spectrogram trace that is selected.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDoubleDataAtScanGets the raw data as a double array at the specified scan index.  
Public MethodDurationScansGets the time duration between the specified scans in seconds.  
Public MethodFloatDataAtScanGets the raw data as a float array at the specified scan index.  
Public MethodForceRebuildKeyMapThis method is used to force a refresh of the key map. This is necessary in cases where the key mappings to the API objects change. This can happen when the index of an item within a collection is reflected in the key name, and an item is removed from the middle of a collection. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodScanAtTimeGets the nearest scan on the display to the specified time.  
Public MethodScanAtTimeAfterScanGets the nearest scan to the specified time but after the specified scan.  
Public MethodScanAtTimeTraceGets the nearest scan on the display to the specified time.  
Public MethodScansDurationGets the number of scans within the specified bounds.  
Public MethodTimeAtScanGets the time at the specified scan.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Events

 NameDescriptionMinimum SW Version
Public EventPropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventPropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)14.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

See Also