Functions | |
| Boolean_t | TecUtilStreamtraceAdd (int NumRakePoints, Streamtrace_e StreamType, StreamDir_e Direction, double StartXPos, double StartYPos, double StartZPos, double AltStartXPos, double AltStartYPos, double AltStartZPos) |
| Add a single streamtrace or a rake of streamtraces to the current frame. | |
| Boolean_t | TecUtilStreamtraceDeleteAll (void) |
| Delete all streamtraces in the current frame. | |
| Boolean_t | TecUtilStreamtraceDeleteRange (int Start, int End) |
| Delete a range of streamtraces. | |
| Boolean_t | TecUtilStreamtraceSetTermLine (int NumPoints, const double *XTermLinePts_Array, const double *YTermLinePts_Array) |
| Set the position of the termination line for streamtraces. | |
| Boolean_t | TecUtilStreamtraceHasTermLine (void) |
| Determines if streamtraces have the terminating line. | |
| Boolean_t | TecUtilStreamtraceResetDelta (void) |
| Resets the time interval between stream markers. | |
| int | TecUtilStreamtraceGetCount (void) |
| Get the number of active streamtraces. | |
| int | TecUtilStreamtracesAreActive (void) |
| Determines if streamtraces are active. | |
| void | TecUtilStreamtraceGetPos (int StreamNumber, double *X, double *Y, double *Z) |
| Get the starting position for a given streamtrace. | |
| Streamtrace_e | TecUtilStreamtraceGetType (int StreamNumber) |
| Get the type of a given streamtrace. | |
| Boolean_t TecUtilStreamtraceAdd | ( | int | NumRakePoints, | |
| Streamtrace_e | StreamType, | |||
| StreamDir_e | Direction, | |||
| double | StartXPos, | |||
| double | StartYPos, | |||
| double | StartZPos, | |||
| double | AltStartXPos, | |||
| double | AltStartYPos, | |||
| double | AltStartZPos | |||
| ) |
Add a single streamtrace or a rake of streamtraces to the current frame.
The frame must be a 2-D or 3-D field plot.
| NumRakePoints | The number of points in the rake of streamtraces which are being added. Use one if just one streamtrace is being added. The number must be greater than zero | |
| StreamType | The type of streamtraces which are being added. The possible values are: Streamtrace_SurfaceLine, Streamtrace_VolumeLine, Streamtrace_VolumeRibbon, Streamtrace_VolumeRod, Streamtrace_TwoDLine | |
| Direction | The direction of the streamtraces which are being added. The possible values are: StreamDir_Forward, StreamDir_Reverse, or StreamDir_Both | |
| StartXPos | X-Coordinate for the starting position of the streamtraces being added. If NumRakePoints is greater than one, then this is the starting position of the rake of streamtraces which are being added. StartZPos is only used for 3-D streamtraces | |
| StartYPos | Y-Coordinate for the starting position of the streamtraces being added. | |
| StartZPos | Z-Coordinate for the starting position of the streamtraces being added. Only used streamtraces are 3-D. | |
| AltStartXPos | X-Coordinate for the alternate starting position of the streamtraces which are being added. If NumRakePoints is one, this value is ignored (except in the case of streamtraces of type ribbon or rod, in which case the alternate starting position defines the streamtrace orientation). Otherwise, these values define the ending position of the rake of streamtraces which are being added. | |
| AltStartYPos | Y-Coordinate for the alternate starting position of the streamtraces which are being added. See AltStartXPos. | |
| AltStartZPos | Z-Coordinate for the alternate starting position of the streamtraces which are being added. See AltStartXPos. |
INTEGER*4 FUNCTION TecUtilStreamtraceAdd( & NumRakePoints, & StreamType, & Direction, & StartXPos, & StartYPos, & StartZPos, & AltStartXPos, & AltStartYPos, & AltStartZPos) INTEGER*4 NumRakePoints INTEGER*4 StreamType INTEGER*4 Direction REAL*8 StartXPos REAL*8 StartYPos REAL*8 StartZPos REAL*8 AltStartXPos REAL*8 AltStartYPos REAL*8 AltStartZPos
Python Syntax:
Results = TecUtil.StreamtraceAdd(NumRakePoints, StreamType, Direction, StartXPos, StartYPos, StartZPos, AltStartXPos, AltStartYPos, AltStartZPos)
Input:
NumRakePoints int
StreamType Streamtrace_e (defined in TecVals.py)
Direction StreamDir_e (defined in TecVals.py)
StartXPos double
StartYPos double
StartZPos double
AltStartXPos double
AltStartYPos double
AltStartZPos double
Output:
Results[0] ReturnVal boolean
Add a single 2-D line streamtrace to the current frame:
Boolean_t IsOk = FALSE; double Xp = 0.0; double Yp = 0.0; Xp = 10.0; Yp = 15.0; IsOk = TecUtilStreamtraceAdd(1, Streamtrace_TwoDLine, StreamDir_Forward, Xp, Yp, 0.0, 0.0, 0.0, 0.0); if (IsOk) { // do more processing . . . }
| Boolean_t TecUtilStreamtraceDeleteAll | ( | void | ) |
Delete all streamtraces in the current frame.
Streamtraces are numbered sequentially.
INTEGER*4 FUNCTION TecUtilStreamtraceDeleteAll()
Python Syntax:
Results = TecUtil.StreamtraceDeleteAll()
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilStreamtraceDeleteRange | ( | int | Start, | |
| int | End | |||
| ) |
Delete a range of streamtraces.
Streamtraces are numbered sequentially in the order they were created.
| Start | Starting stream in the range of Streamtraces to delete. | |
| End | Ending stream in the range of Streamtraces to delete. |
INTEGER*4 FUNCTION TecUtilStreamtraceDeleteRange( & Start, & End) INTEGER*4 Start INTEGER*4 End
Python Syntax:
Results = TecUtil.StreamtraceDeleteRange(Start, End)
Input:
Start int
End int
Output:
Results[0] ReturnVal boolean
Delete streamtraces 1 through 5.
Boolean_t IsOk = FALSE; IsOk = TecUtilStreamtraceDeleteRange(1, 5); if (IsOk) { // do more processing . . . }
| int TecUtilStreamtraceGetCount | ( | void | ) |
Get the number of active streamtraces.
This function is Thread Safe.
INTEGER*4 FUNCTION TecUtilStreamtraceGetCount()
Python Syntax:
Results = TecUtil.StreamtraceGetCount()
Output:
Results[0] ReturnVal int
| void TecUtilStreamtraceGetPos | ( | int | StreamNumber, | |
| double * | X, | |||
| double * | Y, | |||
| double * | Z | |||
| ) |
Get the starting position for a given streamtrace.
This function is Thread Safe.
| StreamNumber | Number of the streamtrace | |
| X | References to the Variable in which to store the X-position of the streamtrace. | |
| Y | References to the Variable in which to store the Y-position of the streamtrace. | |
| Z | References to the Variable in which to store the Z-position of the streamtrace. |
X Pointer must be a valid address and non-NULL.
Y Pointer must be a valid address and non-NULL.
Z Pointer must be a valid address and non-NULL.
SUBROUTINE TecUtilStreamtraceGetPos( & StreamNumber, & X, & Y, & Z) INTEGER*4 StreamNumber REAL*8 X REAL*8 Y REAL*8 Z
Python Syntax:
Results = TecUtil.StreamtraceGetPos(StreamNumber)
Input:
StreamNumber int
Output:
Results[0] X double
Results[1] Y double
Results[2] Z double
Get the position of streamtrace number 3.
double X,Y,Z; TecUtilStreamtraceGetPos(3,&X,&Y,&Z);
| Streamtrace_e TecUtilStreamtraceGetType | ( | int | StreamNumber | ) |
Get the type of a given streamtrace.
This function is Thread Safe.
| StreamNumber | Number of the streamtrace. The valid range is between 1 and the return value of the TecUtilStreamtraceGetCount function. |
INTEGER*4 FUNCTION TecUtilStreamtraceGetType( & StreamNumber) INTEGER*4 StreamNumber
Python Syntax:
Results = TecUtil.StreamtraceGetType(StreamNumber)
Input:
StreamNumber int
Output:
Results[0] ReturnVal Streamtrace_e (defined in TecVals.py)
Get the type of streamtrace number 3.
Streamtrace_e streamTraceType = TecUtilStreamtraceGetType(3);
| Boolean_t TecUtilStreamtraceHasTermLine | ( | void | ) |
Determines if streamtraces have the terminating line.
This function is Thread Safe.
INTEGER*4 FUNCTION TecUtilStreamtraceHasTermLine()
Python Syntax:
Results = TecUtil.StreamtraceHasTermLine()
Output:
Results[0] ReturnVal boolean
| Boolean_t TecUtilStreamtraceResetDelta | ( | void | ) |
Resets the time interval between stream markers.
INTEGER*4 FUNCTION TecUtilStreamtraceResetDelta()
Python Syntax:
Results = TecUtil.StreamtraceResetDelta()
Output:
Results[0] ReturnVal boolean
| int TecUtilStreamtracesAreActive | ( | void | ) |
Determines if streamtraces are active.
This function is Thread Safe.
INTEGER*4 FUNCTION TecUtilStreamtraceGetCount()
Python Syntax:
Results = TecUtil.StreamtracesAreActive()
Output:
Results[0] ReturnVal int
| Boolean_t TecUtilStreamtraceSetTermLine | ( | int | NumPoints, | |
| const double * | XTermLinePts_Array, | |||
| const double * | YTermLinePts_Array | |||
| ) |
Set the position of the termination line for streamtraces.
| NumPoints | The number of XY-termination line points supplied. The number must be greater than zero, and less than or equal to the number of XY-termination points supplied | |
| XTermLinePts_Array | Array of X-termination line ordinates | |
| YTermLinePts_Array | Array of Y-termination line ordinates |
YTermLinePts_Array Pointer must be a valid address and non-NULL.
INTEGER*4 FUNCTION TecUtilStreamtraceSetTermLine( & NumPoints, & XTermLinePts_Array, & YTermLinePts_Array) INTEGER*4 NumPoints REAL*8 XTermLinePts_Array REAL*8 YTermLinePts_Array
Python Syntax:
Results = TecUtil.StreamtraceSetTermLine(NumPoints, XTermLinePts_Array, YTermLinePts_Array)
Input:
NumPoints int
XTermLinePts_Array list of doubles
YTermLinePts_Array list of doubles
Output:
Results[0] ReturnVal boolean
Define a line for terminating streamtraces.
Boolean_t IsOk = FALSE; double Xp[2]; double Yp[2]; Xp[0] = 0.0; Yp[0] = 0.0; Xp[1] = 5.0; Yp[1] = 8.0; IsOk = TecUtilStreamtraceSetTermLine(2, Xp, Yp); if (IsOk) { // do more processing . . . }
1.5.5