Activity
An
OpenSpirit activity that outputs either an image or the bulk values of
a plane from a 3D volume. The input of the activity takes a Post Stack
3D OpenSpirt data key. The extent of the plane that is output can be specified
on the input panel. The output type of image or bulk values is specified
on the configuration panel. If the output type is image, there are various
inputs that can be specified to customize the image that is generated.
OpenSpirit Seismic 3D Reader Configuration Fields
| Field | Global Var? | Optional? | Description |
| Name | No | No | User assigned name given to activity |
| Description | No | Yes | User assigned description (optional) |
| Output Type | No | No | Specifies the output type. The options are: Image or Bulk Values. The default is Image. |
| Color Model | No | Yes | Specifies the color model to be used when generating the image. This field is only visible when the output type is Image. The options are: Grey Scale, Red White Blue, Rainbow and Custom. The first three are predefined color models. If Custom is chosen, additional inputs will be displayed to specify the minimum color, maximum color and optional zero color. A color ramp will be created based on the HSB (Hue, Saturation and Brightness) color space that includes the color spectrum within the range specified. |
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information about mapping and transforming input data.
The input for the activity is the following.
| Input Item | Datatype | Description |
| OspInput | Complex | Root element for all input elements |
| DataKey | String | This is the OpenSpirit data key from the Post Stack 3D entity (EpiSeismic_PostStack3d). |
| LineType | String | Specifies the type of plane to return. The valid values are: Inline or Crossline. If not supplied, the optimal default type of plane will be chosen based on the storage order of the volume. For example, if the storage order is INLINE_XLINE_Z, then the default line type will be Inline. |
| LineNumber | Float | The line number (Inline or Crossline) to return. If not supplied, the middle line number based on the Line Type will be returned. |
| LineStart | Float | Optionally defines the first line of the plane that is output. If the line type is Inline, then this is the first Crossline number of the plane. If the line type is Crossline, then this is the first Inline number of the plane. If nothing is supplied, the first line number of the data extent of the plane will be used. |
| LineEnd | Float | Optionally defines the last line of the plane that is output. If the line type is Inline, then this is the last Crossline number of the plane. If the line type is Crossline, then this is the last Inline number of the plane. If nothing is supplied, the last line number of the data extent of the plane will be used. |
| MinZ | Float | Optionally defines the minimum Z value of the plane that is output. If nothing is supplied, the minimum Z of the data extent of the plane will be used. |
| MaxZ | Float | Optionally defines the maximum Z value of the plane that is output. If nothing is supplied, the maximum Z of the data extent of the plane will be used. |
| ColorModel | Complex | Defines the color model used when generating the image. This input is only displayed when the output type is Image. |
| Factor | Float | A multiplier (0 - 1+) applied when calculating the pixel value. A value of 1 is the normal contrast and has no change on the output. The contrast decreases as fractional values less than 1 approach 0. Values greater than 1 increase the contrast. This is typically only be used when the data is generally symmetric about zero. The color model is also typically two color dominant (e.g. Grey Scale or Red White Blue). |
| ReverseScale | Boolean | If true, the color ramp generated will be in reverse order. |
| Symmetric | Boolean | If true, the largest amplitude value (minimum or maximum) will be used as the absolute minimum and maximum values when creating the color ramp scale. |
| SimpleModelName | String | If supplied, the value would override what was specified on the configuration panel. Valid values are: grey_scale, red_white_blue or rainbow. |
| Custom | Complex | Specifies the values used when creating the custom color model. If the SimpleModelName is supplied, these values are ignored. |
| MinColor | OspColor | Specifies the minimum color of the spectrum to include when creating the color ramp. The spectrum will be calculated in the HSB (Hue, Saturation and Brightness) color space. |
| MaxColor | OspColor | Specifies the maximum color of the spectrum to include when creating the color ramp. The spectrum will be calculated in the HSB (Hue, Saturation and Brightness) color space. |
| ZeroColor | OspColor | Optionally specifies the mid-range color of the spectrum to when creating the color ramp. The spectrum will be calculated in the HSB (Hue, Saturation and Brightness) color space. |
| ImageWidth | Integer | Optionally specify the width of the image that is generated. This value is ignored unless ImageHeight is also supplied. |
| ImageHeight | Integer | Optionally specify the height of the image that is generated. This value is ignored unless ImageWidth is also supplied. |
The output for the activity is the following.
| Output Item | Datatype | Description |
OspOutput |
Complex | The root element for all output items for the activity. |
| Image | Binary | A base 64 byte array containing the image of the specified 3D plane in PNG format. This field is only visible if the output type is Image. |
| BulkValues | Binary | A base 64 byte array containing the bulk values of the specified 2D line. This field is only visible if the output type is Bulk Values. The DataType output field specifies the actual data type of the values contained in the byte array (e.g. FLOAT, INTEGER, SHORT or BYTE). The INTEGER data type indicates 4 bytes per value (high byte first), SHORT is 2 bytes per value (high byte first) and BYTE is 1 byte per value. The FLOAT data type is 4 bytes per value and the 32 bits are structured as follows: http://docs.oracle.com/javase/6/docs/api/java/lang/Float.html#floatToIntBits(float). |
| LineType | String | Specifies the type of plane returned. The valid values are: Inline or Crossline. |
| LineNumber | Float | The line number (Inline or Crossline) returned. |
| LineStart | Float | The first line number of the returned 3D plane. |
| LineEnd | Float | The last line number of the returned 3D plane. |
| MinZ | Float | The minimum Z value of the 3D plane returned. |
| MaxZ | Float | The maximum Z value of the 3D plane returned. |
| VolumeName | String | The name of the volume of the supplied data key. |
| SurveyName | String | The name of the parent 3D survey of the supplied data key. |
| NumTraces | Integer | The number of traces in the returned 3D plane. |
| NumSamples | Integer | The number of samples per trace in the returned 3D plane. |
| StorageOrder | String | Specifies the storage order of the data in the 3D volume. The valid values are: INLINE_XLINE_Z, XLINE_INLINE_Z, Z_INLINE_XLINE, Z_XLINE_INLINE, INLINE_Z_XLINE and XLINE_Z_INLINE. TRACE volumes are either INLINE_XLINE_Z or XLINE_INLINE_Z. SLICE volumes are either Z_INLINE_XLINE or Z_XLINE_INLINE. BRICK volumes can have a variety of orders. The storage order indicates the order of the axes, with the slowest-changing index first and the fastest last. |
| DataType | String | Specifies the data type returned from the OpenSpirit bulk accessor (e.g. FLOAT, INTEGER, SHORT or BYTE). This value should be used to determine how to process the BulkValues output byte array. |
The Error Output tab lists the possible exceptions that can be thrown by this activity.
| Exception | Thrown When ... |
OspException msg msgCode |
The seismic 3D processing
could not be successfully executed.
The msg element should contain some indication of the reason. The error code (see list of possible codes) |