SEISMIC WIDGET REFERENCE

Seismic Widget Class

Defined Functions

The following functions are defined for creating a Seismic widget and manipulating the display of the seismic section.

Function Name Description
XintCreateSeismic Creates an unmanaged Seismic widget.
XintSeismicChangePanelActivate Invokes the callback that manages the resource editor panel.
XintSeismicDraw Causes a portion of the Seismic widget's window to be redrawn.
XintSeismicEditBackground Changes the background color of a Seismic widget.
XintSeismicEditForeground Causes an EditColor widget to be displayed so that the end-user can edit the color used for the foreground color of the Seismic widget.
XintSeismicEditOverlayForeground Causes an EditColor widget to be displayed so that the end-user can edit the color used for the foreground color of the overlay data displayed by Seismic widget.
XintSeismicGetData Returns a pointer to a subset of the trace data used by the Seismic widget.
XintSeismicGetImage Returns a pointer to the image displayed by the Seismic widget.
XintSeismicGetInfoForMovie Gets the information needed to record the displayed seismic section into a movie using the Movie widget.
XintSeismicGetPickingRecord Returns a pointer to the picking record used by the Seismic widget.
XintSeismicGetPixmapInfo Returns information about the pixmap used by the Seismic widget to display the seismic section.
XintSeismicGetVirtualSize Returns the width and height of the virtual window of a seismic widget.
XintSeismicHeaderCount Returns the number of headers defined for the current dataset.
XintSeismicHeaderName Returns the header name for the specified header index.
XintSeismicHeaderValue Returns a header value for the specified header name for the speci fied trace.
XintSeismicHighlightTrace Causes a specified trace to be highlighted.
XintSeismicKeyTimeToPoint Converts a position specified by key values and a time value into window system coordinates.
XintSeismicKeyToTrace Returns the trace number corresponding to the specified primary and secondary key values.
XintSeismicPointToKeyTime Converts a position expressed in the window coordinate system into a position expressed as key, trace number and time values.
XintSeismicSetArgList Returns an argument list containing the current settings of the resources of a Seismic widget.
XintSeismicSetMute Causes a specified range of traces to be muted using specified top and bottom mute arrays.
XintSeismicSetMuteFromPoints Causes a specified range of traces to be muted above or below a specified polyline.
XintSeismicSetTraceStatus Sets the trace display status for a specified range of traces.
XintSeismicTraceTimeToPoint Converts a position specified by a trace number and time value into window system coordinates.
XintSeismicTraceToKey Returns the primary and secondary key values corresponding to a specified trace number.
XintSeismicUnhighlightTrace Removes the highlight from the currently highlighted trace(s).
XintSeismicUpdateTraceColor Changes the color of a range of traces.
XintSeismicUpdateTraces Causes a specified range of traces to be redrawn on the screen.
XintSeismicZoom Performs a zoom operation for a widget whose class is derived from the XintSeismic widget class.

Function Name	Description
XintCreateSeismic	Creates an unmanaged Seismic widget.
XintSeismicChangePanelActivate	Invokes the callback that manages the resource editor panel.
XintSeismicDraw	Causes a portion of the Seismic widget's window to be redrawn.
XintSeismicEditBackground	Changes the background color of a Seismic widget.
XintSeismicEditForeground	Causes an EditColor widget to be displayed so that the end-user can edit the color used for the foreground color of the Seismic widget.
XintSeismicEditOverlayForeground	Causes an EditColor widget to be displayed so that the end-user can edit the color used for the foreground color of the overlay data displayed by Seismic widget.
XintSeismicGetData	Returns a pointer to a subset of the trace data used by the Seismic widget.
XintSeismicGetImage	Returns a pointer to the image displayed by the Seismic widget.
XintSeismicGetInfoForMovie	Gets the information needed to record the displayed seismic section into a movie using the Movie widget.
XintSeismicGetPickingRecord	Returns a pointer to the picking record used by the Seismic widget.
XintSeismicGetPixmapInfo	Returns information about the pixmap used by the Seismic widget to display the seismic section.
XintSeismicGetVirtualSize	Returns the width and height of the virtual window of a seismic widget.
XintSeismicHeaderCount	Returns the number of headers defined for the current dataset.
XintSeismicHeaderName	Returns the header name for the specified header index.
XintSeismicHeaderValue	Returns a header value for the specified header name for the speci fied trace.
XintSeismicHighlightTrace	Causes a specified trace to be highlighted.
XintSeismicKeyTimeToPoint	Converts a position specified by key values and a time value into window system coordinates.
XintSeismicKeyToTrace	Returns the trace number corresponding to the specified primary and secondary key values.
XintSeismicPointToKeyTime	Converts a position expressed in the window coordinate system into a position expressed as key, trace number and time values.
XintSeismicSetArgList	Returns an argument list containing the current settings of the resources of a Seismic widget.
XintSeismicSetMute	Causes a specified range of traces to be muted using specified top and bottom mute arrays.
XintSeismicSetMuteFromPoints	Causes a specified range of traces to be muted above or below a specified polyline.
XintSeismicSetTraceStatus	Sets the trace display status for a specified range of traces.
XintSeismicTraceTimeToPoint	Converts a position specified by a trace number and time value into window system coordinates.
XintSeismicTraceToKey	Returns the primary and secondary key values corresponding to a specified trace number.
XintSeismicUnhighlightTrace	Removes the highlight from the currently highlighted trace(s).
XintSeismicUpdateTraceColor	Changes the color of a range of traces.
XintSeismicUpdateTraces	Causes a specified range of traces to be redrawn on the screen.
XintSeismicZoom	Performs a zoom operation for a widget whose class is derived from the XintSeismic widget class.

XintCreateSeismic

XintCreateSeismic creates an unmanaged Seismic widget.

     Widget XintCreateSeismic (...)

Widget parent Parent of new Seismic widget.
char * name Name of new Seismic widget.
ArgList arglist List of resource/value items.
Cardinal argcount Number of items in arglist.

XintSeismicChangePanelActivate

This function invokes callback XmNchangePanelCallback that activates the panel used to edit the widget resources.

     void XintSeismicChangePanelActivate (Widget widget)

where widget is the widget ID of the Seismic widget.

XintSeismicDraw

Causes a specified portion of the Seismic widget's window to be redrawn.

     void XintSeismicDraw (...)

Widget widget ID of the Seismic widget to be redrawn.
int x The x coordinate (in pixels) of the upper left corner of the area to be redrawn.
int y The y coordinate (in pixels) of the upper left corner of the area to be redrawn.
int width The width (in pixels) of the area to be redrawn.
int height The height (in pixels) of the area to be redrawn.
Boolean flag If set to True, this flag indicates that the expose callback is to be executed.

XintSeismicEditBackground

Causes an EditColor widget to be created and displayed so that the end-user can change the background color of the Seismic widget.

     void XintSeismicEditBackground (Widget widget)

where widget is the widget ID of the Seismic widget whose background color is to be changed.

XintSeismicEditForeground

Causes an EditColor widget to be created and displayed so that the end-user can change the foreground color of the Seismic widget.

     void XintSeismicEditForeground (Widget widget)

where widget is the widget ID of the Seismic widget whose foreground color is to be changed.

XintSeismicEditOverlayForeground

Causes an EditColor widget to be created and displayed so that the end-user can change the foreground color of the overlay data displayed by a Seismic widget.

     void XintSeismicEditOverlayForeground (Widget widget)

where widget is the widget ID of the Seismic widget displaying overlay data whose foreground color is to be changed.

XintSeismicGetData

Returns the address of a copy of a specified subset of the trace data contained in the Seismic widget's XintSeismicDataRec structure. The subset of data to return is specified in terms of trace interval and time interval. You should free the sample data array when you have finished with it using the XtFree function.

     float *XintSeismicGetData (...)

Widget widget Widget ID of the Seismic widget containing subset of data desired.
int tn_start The trace number of the trace at the beginning of the desired interval.
int tn_end The trace number of the trace at the end of the desired interval.
float * time_start Specifies the sample time at the beginning of the time interval desired. Returns the exact starting value.
float * time_end Specifies the sample time at the end of the time interval desired. Returns the exact ending value.
int * ntrace Returns the number of traces selected from the data.
int * nsample Returns the number of samples selected.

The function returns NULL if it cannot return the data requested.

XintSeismicGetImage

Returns a pointer to the image displayed by a Seismic widget.

     XImage *XintSeismicGetImage (Widget widget)

where widget is the widget ID of the Seismic widget displaying the XImage that you wish to access. This function returns NULL if no image is built.

XintSeismicGetInfoForMovie

Gets information about the seismic section currently displayed in a specified Seismic widget so that the image of the seismic section can be recorded into a movie using a Movie widget.

     Boolean XintSeismicGetInfoForMovie (...)

Widget seismic_widget Specifies the widget ID of the Seismic widget whose pixmap you wish to include in a movie.
int * storage Returns a defined integer constant (XintPIXMAP or XintIMAGE) that specifies whether the Seismic widget is displaying the seismic section from a Pixmap or an XImage.
Pixel ** pixels Returns a pointer to the array of pixels (colors) used by the pixmap.
int * ncolors Returns the number of colors in the pixel array.
char ** title Returns a pointer to the character string containing the title of the seismic section in the Seismic widget.

This function returns True if the information was successfully obtained. Otherwise, it returns False. Use functions XintSeismicGetPixmapInfo or XintSeismicGetImage to obtain the image or pixmap to record. The pixel array returned by this function should be freed using XtFree after the application has finished with it.

XintSeismicGetPickingRecord

Returns a pointer to the picking record currently connected to a specified Seismic widget.

     XintPickingRecord *XintSeismicGetPickingRecord (Widget widget)

where widget is the widget ID of the Seismic widget whose picking record you wish to reference. This function returns NULL if no picking record is currently connected to the specified Seismic widget.

This function is available only with the Picking library.

XintSeismicGetPixmapInfo

This function allocates a pixmap that will contain the Seismic image and annotation. This pixmap can be used to record the current plot into a Movie.

     Boolean XintSeismicGetPixmapInfo (...)

Widget widget Widget ID of the Seismic widget containing the pixmap of interest.
Pixmap * pixmap Return address of the pixmap.
int * width Returns the width of the pixmap.
int * height Returns the height of the pixmap.
int * depth Returns the depth of the pixmap.

This function returns False if the specified Seismic widget has no pixmap or image allocated. Otherwise, it returns True. The pixmap should be freed using function XFreePixmap after it is no longer needed.

XintSeismicGetVirtualSize

Returns pointers to the width and height of the virtual window of a Seismic widget.

     void XintSeismicGetVirtualSize (...)

Widget widget Widget ID of the Seismic widget containing the pixmap of interest.
int * width Returns the width of the virtual window of the Seismic widget.
int * height Returns the height o f the virtual window of the Seismic widget.

XintSeismicHeaderCount

Returns the number of headers found for the specified Seismic widget.

     int XintSeismicHeaderCount (...)

Widget widget Widget ID of the Seismic widget.

XintSeismicHeaderName

Gets a header name for the specified header index. Note: you can use the XintSeismicHeaderCount function to get the size of this array.

     string XintSeismicHeaderName (...)

Widget widget Widget ID of the Seismic widget.
int index Header index to return a name for.

XintSeismicHeaderValue

Gets a header value for the specified header name for the specified trace.

     float XintSeismicHeaderValue (...)

Widget widget Widget ID of the Seismic widget.
char * name Header name you wish a value returned for.
int tn Trace number you wish header value returned for.

XintSeismicHighlightTrace

Causes a specified trace to be highlighted by a color change. The color used to highlight the trace is specified by the resource XmNhighlightColor inherited by the Seismic widget from the Primitive class. Only one trace at a time can be selected using this mechanism. Use function XintSeismicUpdateTraceColor if you want to change the color of more than one trace. This function re-rasterizes only the specified trace if the current image is not stored in a bitmap, otherwise it will re-rasterize the entire dataset. Set resource XmNuseBitmap to False if you plan to use this function so that the Seismic widget never uses a bitmap.

     void XintSeismicHighlightTrace (...)

Widget widget Widget ID of the Seismic widget containing the trace to be highlighted.
int tn Trace number of the trace to be highlighted.

XintSeismicKeyTimeToPoint

Converts a location in the seismic section (specified as trace and time values) into window coordinates.

     Boolean XintSeismicKeyTimeToPoint (...)

Widget widget Widget ID of the Seismic widget.
int pkey Specifies the primary key associated with the location of interest.
int skey Specifies the secondary key (if defined) associated with the location of interest.
float time Specifies the time at the location of interest.
int * x The return address of the horizontal location specified in window coordinates.
int * y The return address of the vertical location specified in window coordinates.

This function returns False if the specified key or time values are out of range. Otherwise, the function returns True.

XintSeismicKeyToTrace

Converts primary and secondary key values to the corresponding trace sequence number.

     Boolean XintSeismicKeyToTrace (...)

Widget widget Widget ID of the Seismic widget.
int pkey Specifies the primary key associated with trace of interest.
int skey Specifies the secondary key (if defined) associated with the trace of interest.
int *tn Returns the sequence number of the trace of interest.

This function returns False if the specified primary key or secondary key is out of range. Otherwise, it returns True.

XintSeismicPointToKeyTime

Converts a location in the seismic section (specified as window coordinates) into trace and time values.

     Boolean XintSeismicPointToKeyTime (...)

Widget widget Widget ID of the Seismic widget.
int x The horizontal location specified in window coordinates.
int y The vertical location specified in window coordinates.
int * pkey The return address of the primary key associated with the (x,y) location.
int * skey The return address of the secondary key (if defined) associated with the (x,y) location.
int * tn The return address of the trace sequence number associated with the (x,y) location.
float * time The return address of the time value associated with the (x,y) location.

This function returns False if the specified x or y values are out of range; otherwise, it returns True. If the value specified for the x argument is out of range, the argument pkey will be set to XintUNDEFINED_KEY. If the value specified for the y value is out of range, the argument time will be set to XintUNDEFINED_TIME.

XintSeismicSetArgList

Returns a copy of the resource argument list used by a Seismic widget. Use this function when you wish to create another Seismic widget that has the same (or similar) resource values as an existing Seismic widget. You must declare the size of the argument array to be at least as large as the defined constant, XintSEISMIC_NUM_ARGS.

     void XintSeismicSetArgList (...)

Widget widget Widget ID of the Seismic widget whose arguments you wish to copy.
ArgList arg The argument list that will contain the resource values upon return.
int * n The return address of the number of arguments returned in the arg array.

XintSeismicSetMute

Causes a specified range of traces to be muted above the values contained in top_array and below the values in the bottom_array.

     void XintSeismicSetMute (...)

Widget widget Widget ID of the Seismic widget displaying the traces you wish to mute.
int ftn The sequence number of the first trace to be muted.
int ltn The sequence number of the last trace to be muted.
float * top_array Floating point array containing the mute values above which the corresponding (ltn - ftn + 1) traces will be muted.
float * bottom_array Floating point array containing the mute values below which the corresponding (ltn - ftn + 1) traces will be muted.

XintSeismicSetMuteFromPoints

Causes the traces intersection with a polyline to be muted above or below the polyline. The specified polyline must not intersect a trace more than once.

     void XintSeismicSetMuteFromPoints (...)

Widget widget Widget ID of the Seismic widget displaying the traces you wish to mute.
int direction Specifies whether the traces will be muted above (XintMUTE_TOP) or below (XintMUTE_BOTTOM) the polyline.
XintPolylinePoint * points An array of polyline points expressed in user coordinates.
int npoints The number of points in the points array.

The coordinates of the points contained in the polyline are defined as an array, where each point is specified using a structure of type XintPolylinePoint, which takes the following form:

   typedef struct {
                   float x;
                   float y;
   } XintPolylinePoint;

XintSeismicSetTraceStatus

Sets the display status of a specified range of traces displayed by an Seismic widget.

     void XintSeismicSetTraceStatus (...)

Widget widget Widget ID of the Seismic widget displaying the traces that will have their display status changed.
int ftn The sequence number of the first trace whose display status is to be changed.
int ltn The sequence number of the last trace whose display status is to be changed.
int status Defined constant specifying the new display status of the traces in the range [ftn, ltn].

The status argument must be specified as XintTRACE_NORMAL, XintTRACE_INVERTED, or XintTRACE_KILLED.

XintSeismicTraceTimeToPoint

Converts a location in the seismic section (specified as trace and time values) into window coordinates.

     Boolean XintSeismicTraceTimeToPoint (...)

Widget widget Widget ID of the Seismic widget.
int tn Specifies the sequence number of the trace associated with the location of interest.
float time Specifies the time at the location of interest.
int * x Returns the horizontal location specified in window coordinates.
int * y Returns the vertical location specified in window coordinates.

This function returns False if the specified trace sequence number or time value are out of range. Otherwise, it returns True.

XintSeismicTraceToKey

Converts a trace sequence number to the corresponding primary and secondary key values.

     Boolean XintSeismicTraceToKey (...)

Widget widget Widget ID of the Seismic widget.
int tn Specifies the sequence number of the trace of interest.
int * pkey Returns the primary key associated with trace of interest.
int * skey Returns the secondary key (if defined) associated with the trace of interest.

This function returns False if the specified trace sequence number is out of range. Otherwise, it returns True.

XintSeismicUnhighlightTrace

Causes the currently highlighted trace to change back to its original color.

     void XintSeismicUnhighlightTrace (Widget widget)

where widget is the widget ID of a Seismic widget.

XintSeismicUpdateTraceColor

Causes a set of traces to change color if displayed using wiggle, and/or monochrome fill. This function re-rasterizes only the specified traces if the current image is not stored in a bitmap, otherwise it will re-rasterize the entire dataset. Set resource XmNuseBitmap to False if you plan to use this function so that the Seismic widget never uses a bitmap.

     void XintSeismicUpdateTraceColor (...)

Widget widget Widget ID of the Seismic widget.
int first_trace Specifies the first trace.
Pixel * pixel_array Specifies a pixel array containing the pixel colors to assign to each trace.
int ntrace Specifies the number of traces whose color will be changed.

XintSeismicUpdateTraces

Causes the specified Seismic widget to update the given range of traces in the image displayed.

     void XintSeismicUpdateTraces (...)

Widget widget Widget ID of the Seismic widget displaying the image to be updated.
int ftn Specifies the sequence number of the first trace to update.
int ltn Specifies the sequence number of the last trace to update.

XintSeismicZoom

Causes a selected area of a widget's displayed image to be zoomed. The widget must be an instance of the XintSeismic widget class or a class derived from the Seismic widget class. The area to be scaled must have been previously selected and returned to the application via an area selection callback. The zoom operation can be performed so that the scaled image replaces the previous image displayed by the widget. Alternatively, a new widget can be created to display the scaled area.

     Widget XintSeismicZoom (...)

Widget current Widget ID of the widget containing the area to be scaled.
Widget parent Specify the parent's widget ID so that a new widget will be created as a child of the widget's parent, to display the zoomed area, or specify NULL so that the original widget will be used to display the zoomed area.
XintSeismicAreaSelectionCallbackStruct * selection Specify the address of an XintSeismicAreaSelectionCallback structure that indicates the area to be zoomed, or specify NULL to indicate that the currently displayed area in the widget is the area to be zoomed.
float zx The horizontal scale factor to be used to zoom the selected area.
float zy The vertical scale factor to be used to zoom the selected area.

This function returns the widget ID of the widget containing the zoomed area (i.e., the original widget or the new widget) if it is successful. Otherwise, it returns NULL.

Widget	parent	Parent of new Seismic widget.
char *	name	Name of new Seismic widget.
ArgList	arglist	List of resource/value items.
Cardinal	argcount	Number of items in arglist.

Widget	widget	ID of the Seismic widget to be redrawn.
int	x	The x coordinate (in pixels) of the upper left corner of the area to be redrawn.
int	y	The y coordinate (in pixels) of the upper left corner of the area to be redrawn.
int	width	The width (in pixels) of the area to be redrawn.
int	height	The height (in pixels) of the area to be redrawn.
Boolean	flag	If set to True, this flag indicates that the expose callback is to be executed.

Widget	widget	Widget ID of the Seismic widget containing subset of data desired.
int	tn_start	The trace number of the trace at the beginning of the desired interval.
int	tn_end	The trace number of the trace at the end of the desired interval.
float *	time_start	Specifies the sample time at the beginning of the time interval desired. Returns the exact starting value.
float *	time_end	Specifies the sample time at the end of the time interval desired. Returns the exact ending value.
int *	ntrace	Returns the number of traces selected from the data.
int *	nsample	Returns the number of samples selected.

Widget	seismic_widget	Specifies the widget ID of the Seismic widget whose pixmap you wish to include in a movie.
int *	storage	Returns a defined integer constant (XintPIXMAP or XintIMAGE) that specifies whether the Seismic widget is displaying the seismic section from a Pixmap or an XImage.
Pixel **	pixels	Returns a pointer to the array of pixels (colors) used by the pixmap.
int *	ncolors	Returns the number of colors in the pixel array.
char **	title	Returns a pointer to the character string containing the title of the seismic section in the Seismic widget.

Widget	widget	Widget ID of the Seismic widget.
int	index	Header index to return a name for.

Widget	widget	Widget ID of the Seismic widget whose arguments you wish to copy.
ArgList	arg	The argument list that will contain the resource values upon return.
int *	n	The return address of the number of arguments returned in the arg array.

Widget	widget	Widget ID of the Seismic widget displaying the traces you wish to mute.
int	ftn	The sequence number of the first trace to be muted.
int	ltn	The sequence number of the last trace to be muted.
float *	top_array	Floating point array containing the mute values above which the corresponding (ltn - ftn + 1) traces will be muted.
float *	bottom_array	Floating point array containing the mute values below which the corresponding (ltn - ftn + 1) traces will be muted.

Widget	current	Widget ID of the widget containing the area to be scaled.
Widget	parent	Specify the parent's widget ID so that a new widget will be created as a child of the widget's parent, to display the zoomed area, or specify NULL so that the original widget will be used to display the zoomed area.
XintSeismicAreaSelectionCallbackStruct *	selection	Specify the address of an XintSeismicAreaSelectionCallback structure that indicates the area to be zoomed, or specify NULL to indicate that the currently displayed area in the widget is the area to be zoomed.
float	zx	The horizontal scale factor to be used to zoom the selected area.
float	zy	The vertical scale factor to be used to zoom the selected area.