Keysight Pathwave 89600 VSA .NET API
FloatData Method
See Also 
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > Trace Class : FloatData Method


selectedData
Value Description
TraceDataSelect.X The X-axis data is selected.
TraceDataSelect.Y The Y-axis data is selected.
TraceDataSelect.XY Both the X-axis and Y-axis data are selected.
scaleLimit
Specifies how much data is read. If True, only the X scaled data seen on the trace (between XLeft and XRight if IsXScaleAuto is False) is read.

Glossary Item Box

Gets the data (numbers) in the current trace format as an array of floats.

Syntax

Visual Basic (Declaration) 
Public MustOverride Function FloatData( _
   ByVal selectedData As TraceDataSelect, _
   ByVal scaleLimit As Boolean _
) As Single()
C# 
public abstract float[] FloatData( 
   TraceDataSelect selectedData,
   bool scaleLimit
)
C++/CLI 
public:
abstract array<float>^ FloatData( 
   TraceDataSelect selectedData,
   bool scaleLimit
) 

Parameters

selectedData
Value Description
TraceDataSelect.X The X-axis data is selected.
TraceDataSelect.Y The Y-axis data is selected.
TraceDataSelect.XY Both the X-axis and Y-axis data are selected.
scaleLimit
Specifies how much data is read. If True, only the X scaled data seen on the trace (between XLeft and XRight if IsXScaleAuto is False) is read.

Return Value

Float array if there is data, otherwise null.

Remarks

The FloatData property returns the trace data in the Format that is being displayed (e.g. log mag, phase, etc.). The data returned is an array of numbers.

If bScaleLimit is True, then only the X scaled data that you see on the trace (between XLeft and XRight if IsXScaleAuto is False) is read.

The selectedData parameter is used to select which data to read: X data, Y data, or both X and Y data. If both X and Y data are read, then the data is returned interleaved X followed by Y for each point.

You might want to use DoubleData instead of this method to read data if you are reading X data because, for large frequencies, you might need the extra resolution of a double value.

Requirements

Target Platforms: Windows 11 Professional or Enterprise; Windows 10 Professional, Enterprise, or Education (64-bit)

See Also