Streamtraces

Functions
Boolean_t	TecUtilStreamtraceAddX (ArgList_pa ArgList)
	Add one or more streamtraces to the plot of the current frame.
Boolean_t	TecUtilStreamtraceAdd (EntIndex_t 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 (EntIndex_t Start, EntIndex_t End)
	Delete a range of streamtraces.
Boolean_t	TecUtilStreamtraceSetTermLine (EntIndex_t 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.
EntIndex_t	TecUtilStreamtraceGetCount (void)
	Get the number of active streamtraces.
Boolean_t	TecUtilStreamtracesAreActive (void)
void	TecUtilStreamtraceGetPos (EntIndex_t StreamNumber, double *X, double *Y, double *Z)
	Get the starting position for a given streamtrace.
Streamtrace_e	TecUtilStreamtraceGetType (EntIndex_t StreamNumber)
	Get the type of a given streamtrace.

---

Function Documentation

Boolean_t TecUtilStreamtraceAdd	(	EntIndex_t	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.

Parameters:

	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.

Returns:

TRUE if successful, otherwise FALSE.

Fortran Syntax:

    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 TecUtilStreamtraceAddX

(

ArgList_pa

ArgList

)

Add one or more streamtraces to the plot of the current frame.

The frame must be either a Cartesian 2D or 3D field plot.

Parameters:

ArgList

Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_STREAMTYPE

Type:	Streamtrace_e
Arg Function:	TecUtilArgListAppendInt()
Required:	Yes
Notes:	Type of streamtraces that are being added. The possible values are: Streamtrace_SurfaceLine, Streamtrace_VolumeLine, Streamtrace_VolumeRibbon, Streamtrace_VolumeRod, and Streamtrace_TwoDLine.

SV_DISTRIBUTIONREGION

Type:	DistributionRegion_e
Arg Function:	TecUtilArgListAppendInt()
Required:	Yes
Notes:	Specifies the region for distributing the streamtraces. The possible values are: DistributionRegion_Point, DistributionRegion_Rake, DistributionRegion_SurfacesOfActiveZones, and DistributionRegion_SurfacesOfSelectedObjects.

SV_STREAMDIRECTION

Type:	StreamDir_e
Arg Function:	TecUtilArgListAppendInt()
Default:	StreamDir_Both
Required:	No
Notes:	Direction of propagation of the streamtraces being added. The possible values are: StreamDir_Forward, StreamDir_Reverse, and StreamDir_Both.

SV_NUMPTS

Type:	LgIndex_t
Arg Function:	TecUtilArgListAppendInt()
Default:	1 for point distribution, $!FrameSetup NumStreamRakePoints for rake, and $!FrameSetup NumStreamSurfacePoints for surfaces.
Required:	No
Notes:	Number of seed points for distributing along a rake or on defined surfaces.

SV_X1

Type:	double
Arg Function:	TecUtilArgListAppendDouble()
Required:	Yes
Notes:	X ordinate of seed point or starting rake point. Required for distribution regions of DistributionRegion_Point or DistributionRegion_Rake.

SV_Y1

Type:	double
Arg Function:	TecUtilArgListAppendDouble()
Required:	Yes
Notes:	Y ordinate of seed point or starting rake point. Required for distribution regions of DistributionRegion_Point or DistributionRegion_Rake.

SV_Z1

Type:	double
Arg Function:	TecUtilArgListAppendDouble()
Required:	Yes
Notes:	Z ordinate of seed point or starting rake point. Required for distribution regions of DistributionRegion_Point or DistributionRegion_Rake for Cartesian 3D plots.

SV_X2

Type:	double
Arg Function:	TecUtilArgListAppendDouble()
Required:	Yes
Notes:	X ordinate of ending rake point. Required for distribution region of DistributionRegion_Point if the streamtrace type is a rod or ribbon or for a region of DistributionRegion_Rake. For DistributionRegion_Point the value is used to orient the streamtrace.

SV_Y2

Type:	double
Arg Function:	TecUtilArgListAppendDouble()
Required:	Yes
Notes:	Y ordinate of ending rake point. Required for distribution region of DistributionRegion_Point if the streamtrace type is a rod or ribbon or for a region of DistributionRegion_Rake. For DistributionRegion_Point the value is used to orient the streamtrace.

SV_Z2

Type:	double
Arg Function:	TecUtilArgListAppendDouble()
Required:	Yes
Notes:	Z ordinate of ending rake point. Required for distribution region of DistributionRegion_Point if the streamtrace type is a rod or ribbon or for a region of DistributionRegion_Rake. For DistributionRegion_Point the value is used to orient the streamtrace. Only applicable to Cartesian 3D plots.

Returns:

TRUE if successful, FALSE otherwise.

Distribute a rake of 10 volume streamtrace rods at the specified location (absent of any error handling).

   ArgList_pa argList;
   argList = TecUtilArgListAlloc();
   TecUtilArgListAppendInt(argList,SV_NUMPTS,10);
   TecUtilArgListAppendInt(argList,SV_STREAMTYPE, (LgIndex_t)(Streamtrace_VolumeRod));
   TecUtilArgListAppendInt(argList,SV_STREAMDIRECTION, (LgIndex_t)(StreamDir_Both));
   TecUtilArgListAppendInt(argList,SV_DISTRIBUTIONREGION, (LgIndex_t)(DistributionRegion_Rake));
   TecUtilArgListAppendDouble(argList,SV_X1, 0.5);
   TecUtilArgListAppendDouble(argList,SV_Y1, 0.3311);
   TecUtilArgListAppendDouble(argList,SV_Z1, 0.4310);
   TecUtilArgListAppendDouble(argList,SV_X2, 0.5);
   TecUtilArgListAppendDouble(argList,SV_Y2, 0.3311);
   TecUtilArgListAppendDouble(argList,SV_Z2, 0.4312);
   isOk = TecUtilStreamtraceAddX(argList);
   TecUtilArgListDealloc(&argList);
   ...

Precondition:

Must have one or more pages.

Must have one or more frames.

ArgList Argument list must be valid.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilStreamtraceAddX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.StreamtraceAddX(ArgList)

  Input:
                  ArgList              dictionary
  Output:
    Results[0]    ReturnVal            boolean

Since:

13.4.0

See also:

TecUtilStreamtraceAdd

Boolean_t TecUtilStreamtraceDeleteAll

(

void

)

Delete all streamtraces in the current frame.

Streamtraces are numbered sequentially.

Returns:

TRUE if successful, otherwise FALSE.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilStreamtraceDeleteAll()

Python Syntax:

  Results = TecUtil.StreamtraceDeleteAll()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilStreamtraceDeleteRange	(	EntIndex_t	Start,
		EntIndex_t	End
	)

Delete a range of streamtraces.

Streamtraces are numbered sequentially in the order they were created.

Parameters:

	Start	Starting stream in the range of Streamtraces to delete.
	End	Ending stream in the range of Streamtraces to delete.

Returns:

TRUE if successful, otherwise FALSE.

Fortran Syntax:

    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
         .
         .
         .
     }

EntIndex_t TecUtilStreamtraceGetCount

(

void

)

Get the number of active streamtraces.

This function is Thread Safe.

Returns:

Returns the number of streamtraces currently defined.

Precondition:

Must have one or more frames.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilStreamtraceGetCount()

Python Syntax:

  Results = TecUtil.StreamtraceGetCount()

  Output:
    Results[0]    ReturnVal            int

void TecUtilStreamtraceGetPos	(	EntIndex_t	StreamNumber,
		double *	X,
		double *	Y,
		double *	Z
	)

Get the starting position for a given streamtrace.

This function is Thread Safe.

Parameters:

	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.

Precondition:

Must have one or more frames.

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.

Fortran Syntax:

    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

(

EntIndex_t

StreamNumber

)

Get the type of a given streamtrace.

This function is Thread Safe.

Parameters:

StreamNumber

Number of the streamtrace. The valid range is between 1 and the return value of the TecUtilStreamtraceGetCount function.

Precondition:

Must have one or more frames.

Fortran Syntax:

    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);

Since:

11.3-17-015

Boolean_t TecUtilStreamtraceHasTermLine

(

void

)

Determines if streamtraces have the terminating line.

This function is Thread Safe.

Returns:

Returns TRUE if the terminating line exists. The terminating line is visible if it is active. To activate the termination line use the SV_STREAMATTRIBUTES, SV_TERMLINE, SV_ISACTIVE style.

Precondition:

Must have one or more frames.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilStreamtraceHasTermLine()

Python Syntax:

  Results = TecUtil.StreamtraceHasTermLine()

  Output:
    Results[0]    ReturnVal            boolean

Since:

11.3-17-015

Boolean_t TecUtilStreamtraceResetDelta

(

void

)

Resets the time interval between stream markers.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilStreamtraceResetDelta()

Python Syntax:

  Results = TecUtil.StreamtraceResetDelta()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilStreamtracesAreActive

(

void

)

Deprecated:

Please use TecUtilQueryStreamtracesAreActive instead.

Determines if streamtraces are active. This function is Thread Safe.

Returns:

Returns TRUE if streamtraces are active.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilStreamtracesAreActive()

Python Syntax:

  Results = TecUtil.StreamtracesAreActive()

  Output:
    Results[0]    ReturnVal            boolean

Since:

11.3-17-015

Boolean_t TecUtilStreamtraceSetTermLine	(	EntIndex_t	NumPoints,
		const double *	XTermLinePts_Array,
		const double *	YTermLinePts_Array
	)

Set the position of the termination line for streamtraces.

Parameters:

	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

Returns:

TRUE if successful, FALSE if not.

Precondition:

XTermLinePts_Array Pointer must be a valid address and non-NULL.

YTermLinePts_Array Pointer must be a valid address and non-NULL.

Fortran Syntax:

    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
         .
         .
         .
     }