Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add segy endian check #21

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

kerim371
Copy link
Contributor

@kerim371 kerim371 commented Jun 7, 2023

Reopen PR.

The poing is now SegyIO assumes that all SEGY are big endian.
It doesn't work with little endian.
Moreover it doesn't check the endianness of the machine.

This PR aims to check whether endianness of the machine and SEGY file are different or not.
Based on this we should make a decision whether to swap bytes or not.
Swap bytes or not depends on the value in file binary header 3224-3225 bytes (Data Sample Format).
This header is mandatory for all SEGY.
It must be in range [1,16].
If not -> then swap bytes and check again.

Also it is important to be careful with IBM32 format.
Does the function ntoh in IBM32->FLOAT32 converter works as expected on both BIG and LITTLE endian machines?

Finally we have to check carefully the following cases:

  1. Float32 LE segy on LE machine
  2. Float32 BE segy on LE machine
  3. Float32 LE segy on BE machine
  4. Float32 BE segy on BE machine
  5. IBM32 LE segy on LE machine
  6. IBM32 BE segy on LE machine
  7. IBM32 LE segy on BE machine
  8. IBM32 BE segy on BE machine

My machines are LE only :)

mloubout and others added 3 commits January 3, 2023 18:47
SEGY may have BIG or LITTLE endian byte order.
Machine also may have BIG or LITTLE endian order.
If machine and SEGY have different byte order then we have to swap bytes while reading data.

To check whether machine and SEGY byte order are same we can use 3225-3226 bytes (Data Sample Format).
According to SEGY revision document this value may have only value in range 1-16.
Than concerns any type greater > 1 byte (even INT16, FLOAT32 or IBMFLOAT32 or any other).

For `bswap_needed` correct work it is important that stream (`s::IO)` is opened from the begining of the file.
Thus we can't use the stream when reading traces or trace header (there we pass stream that is opened from some offset).
That is why in some functions we don't have default value for `swap_bytes::Bool` argument.
@kerim371 kerim371 mentioned this pull request Jun 7, 2023
src/read/endianness.jl Outdated Show resolved Hide resolved
@mloubout
Copy link
Member

mloubout commented Jun 7, 2023

As a reference the following is the breaking tests (lots of errors) in JUDI

GROUP=test_judiVector.jl julia --color=yes --check-bounds=no --project -e 'using Pkg;Pkg.test("JUDI", coverage=false)'

If we swap bytes of traces and headers then SEGY will always be of another endianness than machine.
No need to swap bytes when writing SEGY.
@kerim371
Copy link
Contributor Author

kerim371 commented Jun 7, 2023

Seems to me that tests passed but could please test it on your own as I'm not 100% sure that I didn't messed up with branches.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants