API / geotoolkit / seismic / data / SegyBinaryField / SegyBinaryField
data.SegyBinaryField.SegyBinaryField
Define binary header for SEG-Y format
↳
SegyBinaryField
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
datatype | DataFormatType | Type of the data |
fieldid | string | number | Identifier (type) |
name | string | Name of the field |
offset | number | Offset of the header |
optional | boolean | Optional or mandatory |
title | string | Title of the field |
Constructors
• new SegyBinaryField(options?)
Creates a new SegY BinaryField, optional by default
| Name | Type | Description |
|---|---|---|
Optional options | Options | options |
BinaryField.constructor
Methods
▸ clone(): FieldDesc
Returns clone of the field descriptor
clone
▸ equalsTo(header): boolean
Returns true if headers are identical
| Name | Type | Description |
|---|---|---|
header | FieldDesc | { identifier?: string ; name?: string } | header |
boolean
▸ getClassName(): string
string
▸ getClone(): FieldDesc
Returns clone of the field descriptor
Deprecated
since 4.0 Use clone instead
clone
▸ getDataType(): DataFormatType
Returns data type
▸ getIdentifier(): string | number
Returns identifier (type)
string | number
▸ getName(): string
Returns name
string
▸ getOffset(): number
Returns offset
number
▸ getProperties(): Required<Options>
Returns properties
Required<Options>
properties
▸ getTitle(): string
Returns title
string
▸ interpret(val): string
Returns data type
| Name | Type |
|---|---|
val | number |
string
▸ isOptional(): boolean
Returns mandatory
boolean
▸ setProperties(properties?): SegyBinaryField
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
▸ setTitle(title): SegyBinaryField
Set title
| Name | Type | Description |
|---|---|---|
title | string | title |
this
▸ toString(): string
Returns string representation
string
▸ Static getClassName(): string
string