Skip to content

Commit ee2af72

Browse files
docs: enhance documentation for higher sample precision option in StreamConverter
1 parent 9468114 commit ee2af72

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

seismic_zfp/conversion.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,10 @@ def __init__(
540540
- 2D numpy array of integers in inline-major order, representing trace header values to be inserted
541541
542542
use_higher_samples_precision : bool, optional
543-
Whether to use higher precision for sample interval and sample time. Default is False.
543+
Specifies whether to use higher precision for the sample interval and sample time.
544+
Default is `False`. When set to `True`, stores sample interval and sample time as
545+
64-bit floating-point numbers for increased precision. If `False`, they are stored
546+
as 32-bit integers.
544547
"""
545548
# Get ilines axis. If overspecified check consistency, and generate if unspecified.
546549
if segyio.tracefield.TraceField.INLINE_3D in trace_headers:

0 commit comments

Comments
 (0)