[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [seismic](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic) / [data](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#data) / [SegyBinaryField](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#segybinaryfield) / SegyBinaryField

# Class: SegyBinaryField

[data](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#data).[SegyBinaryField](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#segybinaryfield).SegyBinaryField

Define binary header for SEG-Y format

## Hierarchy

- [`BinaryField`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield)
↳ **`SegyBinaryField`**


## Table of contents

Constructors
- [new SegyBinaryField(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield.md#new segybinaryfield(options))


Methods
| [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#clone) | [equalsTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#equalsto) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getclassname) |
|  --- | --- | --- |
| [getClone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getclone) | [getDataType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getdatatype) | [getIdentifier](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getidentifier) |
| [getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getname) | [getOffset](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getoffset) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getproperties) |
| [getTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#gettitle) | [interpret](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#interpret) | [isOptional](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#isoptional) |
| [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#setproperties) | [setTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#settitle) | [toString](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#tostring) |
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield#getclassname-1) |


Css Properties
| Name  | Type  | Description |
|  --- | --- | --- |
| `datatype` | [`DataFormatType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#data-3#dataformattype#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 |


## Contents

Constructors
#### new SegyBinaryField(options)

• **new SegyBinaryField**(`options?`)

Creates a new SegY BinaryField, optional by default

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#segybinaryfield#options) | options |


#### Overrides

BinaryField.constructor

Methods
#### clone

▸ **clone**(): [`FieldDesc`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc)

Returns clone of the field descriptor

#### Returns

[`FieldDesc`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc)

clone

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#clone)

#### equalsTo

▸ **equalsTo**(`header`): `boolean`

Returns true if headers are identical

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `header` | [`FieldDesc`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc) | { `identifier?`: `string` ; `name?`: `string`  } | header |


#### Returns

`boolean`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[equalsTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#equalsto)

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getclassname)

#### getClone

▸ **getClone**(): [`FieldDesc`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc)

Returns clone of the field descriptor

**`Deprecated`**

since 4.0 Use clone instead

#### Returns

[`FieldDesc`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc)

clone

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getClone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getclone)

#### getDataType

▸ **getDataType**(): [`DataFormatType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#dataformattype)

Returns data type

#### Returns

[`DataFormatType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#dataformattype)

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getDataType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getdatatype)

#### getIdentifier

▸ **getIdentifier**(): `string` | `number`

Returns identifier (type)

#### Returns

`string` | `number`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getIdentifier](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getidentifier)

#### getName

▸ **getName**(): `string`

Returns name

#### Returns

`string`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getname)

#### getOffset

▸ **getOffset**(): `number`

Returns offset

#### Returns

`number`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getOffset](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getoffset)

#### getProperties

▸ **getProperties**(): `Required`<[`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#segybinaryfield#options)&gt;

Returns properties

#### Returns

`Required`<[`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#segybinaryfield#options)&gt;

properties

#### Overrides

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getproperties)

#### getTitle

▸ **getTitle**(): `string`

Returns title

#### Returns

`string`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#gettitle)

#### interpret

▸ **interpret**(`val`): `string`

Returns data type

#### Parameters

| Name  | Type  |
|  --- | --- |
| `val` | `number` |


#### Returns

`string`

#### isOptional

▸ **isOptional**(): `boolean`

Returns mandatory

#### Returns

`boolean`

#### setProperties

▸ **setProperties**(`properties?`): [`SegyBinaryField`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield)

Sets properties

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.seismic#segybinaryfield#options) | properties |


#### Returns

[`SegyBinaryField`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield)

this

#### Overrides

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#setproperties)

#### setTitle

▸ **setTitle**(`title`): [`SegyBinaryField`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield)

Set title

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `title` | `string` | title |


#### Returns

[`SegyBinaryField`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.segybinaryfield.segybinaryfield)

this

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[setTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#settitle)

#### toString

▸ **toString**(): `string`

Returns string representation

#### Returns

`string`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[toString](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#tostring)

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[BinaryField](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield#getclassname-1)