Skip to main content

Protocol Documentation

Top

cognite/seismic/protos/v1/seismic_service.proto

SeismicAPI

This is the main service for managing and querying metadata and seismic traces from Cognite Data Fusion (CDF). Survey and Partition objects are primarily metadata-focused, and all seismic traces are queried via references to SeismicStore or Seismic objects.

Queries are divided into these broad categories:

  • Management: Creating, editing and deleting Cognite Data Fusion objects, as well as managing the status of file uploading and processing.
  • Metadata: Information about surveys, partitions, seismic objects, and headers.
  • Trace: Retrieving traces or information about traces.
Method NameRequest TypeResponse TypeDescription
CreateSurveyCreateSurveyRequestSurveyCreates a Survey object in the data model. A Survey object represents a grouping of seismic data in the same area and normally shares acquisition and most processing parameters. Capabilities: Requires Seismic:WRITE capability to the CDF tenant.
SearchSurveysSearchSurveysRequestSearchSurveyResponse streamLists all surveys accessible to the client. You can also choose to receive a list of Seismic and SeismicStore object ids associated with the surveys. The returned surveys can also be limited to those that satisfy one or both of these criteria: - Coverage polygon of files in the survey are within an area delimited by a specified polygon. - Filters on metadata of both the survey and the file.
EditSurveyEditSurveyRequestSurveyModifies the metadata for a survey. The survey crs and grid transformation can only be modified if there are no ingested seismic stores in the survey.
DeleteSurveyDeleteSurveyRequestDeleteSurveyResponseDeletes a specified survey. Must have Seismic:ALL scope and Write capability.
RegisterSourceSegyFileRegisterSourceSegyFileRequestRegisterSourceSegyFileResponseRegisters a new file in a (previously registered) survey as source for ingestion.
EditSourceSegyFileEditSourceSegyFileRequestEditSourceSegyFileResponseEdits a registered source file. Before editing, there must be no ingestion jobs running for the source file. The SeismicStore associated with the source file must also be deleted if it was successfully created. This request will fail if the above criteira aren't met.
UnregisterSourceSegyFileUnregisterSourceSegyFileRequestUnregisterSourceSegyFileResponseUnregisters a file previously registered as the source for ingestion. Before unregistering, there must be no ingestion jobs running for the source file. The SeismicStore associated with the source file must also be deleted if it was successfully created. This request will fail if the above criteira aren't met.
IngestSourceSegyFileIngestSourceSegyFileRequestIngestSourceSegyFileResponseRequests queueing of a registered file for ingestion.
CreateSeismicCreateSeismicRequestSeismicCreates new Seismics and assign them to partitions. Seismic objects are mostly immutable aside from their name and metadata. A Seismic object must be deleted and recreated in order to change properties such as the cutout or the source seismic store.
SearchSeismicsSearchSeismicsRequestSeismic streamReturns metadata for a Seismic object. Can optionally retrieve seismic store & partition info if user has appropriate scope and capability.
EditSeismicEditSeismicRequestSeismicEdits the specified seismic. Seismic object names and metadata can be changed. Other properties such as the cutout, owning partition, or source seismic store can't be changed. The seismic object must be deleted and recreated in order to modify these immutable properties.
DeleteSeismicDeleteSeismicRequestDeleteSeismicResponseDeletes seismic objects.
SearchSeismicStoresSearchSeismicStoresRequestSeismicStore streamSearches and retrieves seismic stores. Can only retrieve seismic stores you own.
InspectIngestionInspectIngestionRequestInspectIngestionResponseInspects the seismicstore resulting from a possibly failed ingestion. Useful for debugging failed ingestions.
EditSeismicStoreEditSeismicStoreRequestSeismicStoreSets the name or metadata of a seismic store object.
DeleteSeismicStoreDeleteSeismicStoreRequestDeleteSeismicStoreResponseDeletes a seismic store. If any seismic objects still reference the specified seismic store, the request will fail.
CreatePartitionCreatePartitionRequestPartitionCreates a data partition, optionally setting a name.
SearchPartitionsSearchPartitionsRequestPartition streamReturns the specified partitions, with the same search options as the other search endpoints.
EditPartitionEditPartitionRequestPartitionEdits partitions. The only modifiable field is the name.
DeletePartitionDeletePartitionRequestDeletePartitionResponseDeletes the specified partition and returns a response if it was successfully deleted.
GetVolumeVolumeRequest.com.cognite.seismic.Trace streamRequests a volume of traces by range of inlines, crosslines, and time. Deprecated - use StreamTraces instead.
GetVolumeBoundsVolumeRequestVolumeBoundsResponseReturn information about what a GetVolume request would return, including bounding boxes of trace header values, and estimated total size. Deprecated - use GetTraceBounds instead.
StreamTracesStreamTracesRequest.com.cognite.seismic.Trace streamRequests a set of seismic traces by ranges of trace headers, such as inline, crossline (for 3d), cdp, or shotpoint (for 2d). Can also filter by geometry, and select a subset of depth indices. See StreamTracesRequest for more information.
GetTraceBoundsStreamTracesRequestTraceBoundsReturns information about what a StreamTraces request would return, including bounding boxes of trace header values, and estimated total size.
GetSegYFileSegYSeismicRequestSegYSeismicResponse streamFetches seismic data in SEG-Y format. Each response in the stream contains a byte array that must be written, in order, to a file-like object to produce a valid SEG-Y file. The ordering of traces in the resulting SEG-Y file is undefined. The request object can be used to specify whether the file should contain the whole set of traces in the source dataset or a subset of the traces (for example, a cropped file). See SegYSeismicRequest for more information. Returns a stream of SegYSeismicResponse objects, each containing a fragment of a SEG-Y data stream.
SearchFilesSearchFilesRequestSourceSegyFile streamRetrieves File objects describing the seismic files registered with the tenant. Search criteria can be specified in the SearchFilesRequest, restricting the data retrieved to a subset of the files in the tenant. See SearchFilesRequest for more information. Returns a stream of file objects, terminating once all files matching the search criteria have been returned.
SearchJobStatusSearchJobStatusRequestJobStatusResponse streamRetrieves ingestion job statuses, filtered by the specified criteria.

Top

cognite/seismic/protos/v1/seismic_service_messages.proto

Messages that describe requests/responses from the Seismic Datastore in Cognite Data Fusion

CreatePartitionRequest

FieldTypeLabelDescription
namestring[optional] A short description for the partition.
external_idstring[required] The unique external identifier for the partition.

CreateSeismicRequest

FieldTypeLabelDescription
namestring[optional] A short description for the seismic
external_idstring[required] An externally correlatable unique identifier for the seismic
partitionIdentifier[required] The owning partition
seismic_store_idint64
volume_defVolumeDefDeprecated**: Defines the volume as VolumeDef format. Use two_dee_extent or three_dee_extent.
geometrycom.cognite.seismic.GeometryDefines the volume as WKT or GeoJson
emptyboolWill create a seismic with an empty cutout if true
two_dee_extentSeismic2dExtentDefines the volume as an extent. Only valid if the seismic is 2D
three_dee_extentSeismic3dExtentDefines the volume as an extent. Only valid if the seismic is 3D
metadataOptionalMap[optional] Metadata to associate with the seismic.
text_headerTextHeader[optional] A custom text header for the seismic.
binary_headerBinaryHeader[optional] A custom binary header for the seismic.
copy_metadataboolIf true, copy the metadata from the source seismic store.
trace_group_extentSeismicTraceGroupExtentValid if the seismic is 2D or 3D

CreateSurveyRequest

FieldTypeLabelDescription
namestring[required] Short descriptive name
metadataCreateSurveyRequest.MetadataEntryrepeated[required] Key-value pairs of metadata for the survey.
external_idcom.cognite.seismic.ExternalId[required] Identifier for correlation with systems outside CDF
crsstring[required] CRS used by all members of the survey
grid_transformationcom.cognite.seismic.SurveyGridTransformation[optional] Specifies a grid transformation to use, overriding the defaults.
custom_coveragecom.cognite.seismic.CustomSurveyCoverage[optional] Specifies a coverage to serve as the survey coverage, overriding calculated coverage.

CreateSurveyRequest.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

DeletePartitionRequest

FieldTypeLabelDescription
partitionIdentifier[required] The partition to delete.

DeletePartitionResponse

FieldTypeLabelDescription
successbool

DeleteSeismicRequest

FieldTypeLabelDescription
seismicIdentifier

DeleteSeismicResponse

FieldTypeLabelDescription
succeededbool

DeleteSeismicStoreRequest

FieldTypeLabelDescription
seismic_storeIdentifier[required] The seismic store to delete.

DeleteSeismicStoreResponse

FieldTypeLabelDescription
succeededbool

DeleteSurveyRequest

FieldTypeLabelDescription
surveyIdentifierThe survey to delete.

DeleteSurveyResponse

FieldTypeLabelDescription
successbool

EditPartitionRequest

FieldTypeLabelDescription
partitionIdentifier[required] The unique identifier for the partition to be edited.
new_namestring[required] The new name.

EditSeismicRequest

FieldTypeLabelDescription
seismicIdentifier
namegoogle.protobuf.StringValue
metadataOptionalMap
text_headerTextHeaderReplaces the existing text header, if specified
binary_headerBinaryHeaderReplaces the existing binary header, if specified

EditSeismicStoreRequest

FieldTypeLabelDescription
seismic_store_idint64Deprecated**. Use identifier instead.
namegoogle.protobuf.StringValue[optional] The new seismic store name.
metadataOptionalMap[optional] The new seismic store metadata. If set, this will replace the existing metadata.
seismic_storeIdentifier[required] The seismic store to edit.
external_idgoogle.protobuf.StringValue[optional] The new external id. Will fail if the new external id is not unique.

EditSourceSegyFileRequest

FieldTypeLabelDescription
fileIdentifier[required] The registered source file to edit
pathgoogle.protobuf.StringValue[optional] Path including protocol, bucket, directory structure, and file name. Example: "gs://cognite-seismic-eu/samples/DN1302M03R16_MERGED_KPSDM_00-32_DEG_T.sgy"
external_idcom.cognite.seismic.ExternalId[optional] An external identifier - matches service contract field
metadataEditSourceSegyFileRequest.MetadataEntryrepeated[optional] Any custom-defined metadata
crscom.cognite.seismic.CRS[optional] Official name of the CRS used. Example: "EPSG:23031"
segy_overridesSegyOverrides[optional] Overrides for the source file
key_fieldsTraceHeaderFieldrepeated[optional] The trace header fields that will be used as keys for indexing
dimensionsDimensions[optional] File data dimensionality, either 2D or 3D
seismic_data_typeSeismicDataType[required] The type of seismic data contained in this file. E.g., pre-stack vs. post-stack

EditSourceSegyFileRequest.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

EditSourceSegyFileResponse

FieldTypeLabelDescription
fileSourceSegyFileThe result of the edit.

EditSurveyRequest

FieldTypeLabelDescription
surveyIdentifier
metadataOptionalMap[optional] The metadata to replace the existing metadata with.
external_idcom.cognite.seismic.ExternalId[optional] The new external id.
crscom.cognite.seismic.CRS[optional] The new CRS for all members of the survey.
grid_transformationcom.cognite.seismic.SurveyGridTransformation[optional] The new custom grid transformation.
custom_coveragecom.cognite.seismic.CustomSurveyCoverage[optional] The new custom coverage.
new_namegoogle.protobuf.StringValue[optional] The new name of the survey.

GeometryBasedVolume

FieldTypeLabelDescription
geometrycom.cognite.seismic.Geometry[required] The geometry of the volume.
interpolation_methodcom.cognite.seismic.InterpolationMethod[optional] If the geometry describes a line, must be specified.
z_rangecom.cognite.seismic.LineDescriptor[optional] The z-ranges to fetch. Defaults to the entire z-range.

IngestSourceSegyFileRequest

FieldTypeLabelDescription
fileIdentifier[required] The file to queue for ingestion
target_storage_tier_namestring[required] Target storage tier for this file. A storage tier is a defined facility for storing the trace data associated with a seismic volume. [Accepted values] Accepted values are defined by the tenant configuration, and allow for optimizing tradeoffs between storage cost, retrieval performance, numeric precision and sampling. Note that currently only one storage tier per trace store is supported, so ingesting an already ingested file will result in the file's data being removed from the previously active storage tier.

IngestSourceSegyFileResponse

FieldTypeLabelDescription
job_idstring

IngestionLog

FieldTypeLabelDescription
timestampgoogle.protobuf.TimestampThe time this log was recorded.
log_linestringThe contents of the log.

InspectIngestionRequest

FieldTypeLabelDescription
seismic_store_idint64Specifies a seismic store by id.
file_idint64Specifies a seismic store by source segy file id.
job_idstringSpecifies a seismic store by job id.

InspectIngestionResponse

FieldTypeLabelDescription
seismic_storeSeismicStoreThe fetched seismic store.

JobStatusResponse

FieldTypeLabelDescription
job_idstringThe job id for this status.
file_uuidstringThe uuid of the file that this job is associated with.
statuscom.cognite.seismic.JobStatusThe status of the job.
started_atgoogle.protobuf.TimestampWhen the job was started.
updated_atgoogle.protobuf.TimestampWhen the job was last updated.
target_storage_tier_namegoogle.protobuf.StringValueThe target storage tier of the job.
logsIngestionLogrepeatedLogs recorded by the job.
file_idint64The id of the file that this job is associated with.

RegisterSourceSegyFileRequest

FieldTypeLabelDescription
surveyIdentifier[required] The survey this source file belongs to
pathstring[required] Path including protocol, bucket, directory structure, and file name. Example: "gs://cognite-seismic-eu/samples/DN1302M03R16_MERGED_KPSDM_00-32_DEG_T.sgy"
external_idcom.cognite.seismic.ExternalId[optional] An external identifier - matches service contract field
metadataRegisterSourceSegyFileRequest.MetadataEntryrepeated[optional] Any custom-defined metadata
crscom.cognite.seismic.CRS[required] Official name of the CRS used. Example: "EPSG:23031"
segy_overridesSegyOverrides[optional] Overrides for the source file
key_fieldsTraceHeaderFieldrepeated[optional] The trace header fields that will be used as keys for indexing
dimensionsDimensions[required] File data dimensionality, either 2D or 3D
seismic_data_typeSeismicDataType[required] The type of seismic data contained in this file. E.g., pre-stack vs. post-stack

RegisterSourceSegyFileRequest.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

RegisterSourceSegyFileResponse

FieldTypeLabelDescription
fileSourceSegyFile

SearchFilesRequest

Used to search files by a given file/seismic-store/survey search specification

FieldTypeLabelDescription
specSearchSpecFinds files by id, name or external id.
seismic_storeSearchSpecFinds files that are the source of the seismic stores specified by id, name, or external id.
surveySearchSpecFinds files that are included in the surveys specified by id, name, or external id.
last_modifiedLastModifiedFilterFinds files by their last modified time.

SearchJobStatusRequest

FieldTypeLabelDescription
job_idstringThe id of the job.
file_uuidstringThe uuid of the file that a job is associated with.
file_idint64The id of the file that a job is associated with.
statuscom.cognite.seismic.JobStatus[optional] If specified, only returns jobs with the given status.
target_storage_tier_namegoogle.protobuf.StringValue[optional] If specified, only returns jobs with the given target storage tier.
started_beforegoogle.protobuf.Timestamp[optional] If specified, only returns jobs that started before the timestamp.
started_aftergoogle.protobuf.Timestamp[optional] If specified, only returns jobs that started after the timestamp.
updated_beforegoogle.protobuf.Timestamp[optional] If specified, only returns jobs that were last updated before the timestamp.
updated_aftergoogle.protobuf.Timestamp[optional] If specified, only returns jobs that were last updated after the timestamp.

SearchPartitionsRequest

FieldTypeLabelDescription
partitionsSearchSpecSearches for partitions by id, name, or external id.
last_modifiedLastModifiedFilterSearches for partitions by last modified time.

SearchSeismicStoresRequest

FieldTypeLabelDescription
seismic_storeSearchSpec
surveySearchSpec
fileSearchSpec
last_modifiedLastModifiedFilterWill return seismic stores by last modified.
include_file_infobool[optional] Whether to include File information in the response. Defaults to false.
include_volume_definitionsboolDeprecated**: Whether to include inline/crossline volume definitions in the response. Use include_extent instead. Defaults to false.
include_extentbool[optional] Whether to include a description of the traces contained in the seismicstore. Defaults to false.
extent_keyTraceHeaderField[optional] If specified: - for 2D headers, indicates which trace header the extent should be indexed by, or - for 3D headers, what the major direction should be. Leaving extent_key unspecified when include_extent=true means the server will choose a key header for each seismicstore. Any seismicstores not indexed by the given header will have its extent field left as null.
include_headersbool[optional] Whether to include text and binary headers in the response. Defaults to false.
include_coverageboolDeprecated**. Use coverage instead.
coverageCoverageSpec[optional] If specified, includes coverage in the specified format and CRS.

SearchSeismicsRequest

FieldTypeLabelDescription
surveySearchSpecSearches for seismics which are included in the specified surveys.
seismicSearchSpecSearches for seismics by their id, name or external id.
partitionSearchSpecSearches for seismics which are included in the specified partitions. Can only search on partitions you can see.
seismic_storeSearchSpecSearches for seismics by their seismic store. Requires ALL scope.
last_modifiedLastModifiedFilterSearches for seismics by last modified
include_text_headerbool[optional] Whether to include the text header. Defaults to false.
include_binary_headerbool[optional] Whether to include the binary header. Defaults to false.
include_line_rangebool[optional] Whether to include the line range. Defaults to false.
include_volume_definitionboolDeprecated**. Whether to include the volume definition. Use include_extent instead. Defaults to false.
include_cutoutbool[optional] Whether to include the cutout specification the seismic was created with. Defaults to false.
include_extentbool[optional] Whether to include a description of the included traces. Defaults to false.
extent_keyTraceHeaderField[optional] If specified, indicates which trace header the extent should be indexed by (if a 2d header), or which should be the major direction (if a 3d header). Leaving this unspecified with include_extent=true means the server chooses the native key header for each seismic. Any seismic not indexed by the given header will have its extent field left as null.
include_seismic_storebool[optional] Whether to include info on the backing seismicstore. Requires ALL scope. Defaults to false.
include_partitionbool[optional] Whether to include info on the partition. Requires ALL scope. Defaults to false.
include_coverageboolDeprecated**. Use coverage instead. Defaults to false.
coverageCoverageSpec[optional] If specified, includes coverage as the specified CRS and format.

SearchSurveyResponse

FieldTypeLabelDescription
surveySurvey
seismic_idsstringrepeated[optional] The list of ids for seismics included in the survey.
seismic_store_idsstringrepeated[optional] The list of ids for seismic stores included in the survey.
coveragecom.cognite.seismic.Geometry[optional] The coverage of the survey.
coverage_sourceSurveyCoverageSource[optional] The source of the fetched coverage of the survey.

SearchSurveysRequest

FieldTypeLabelDescription
surveysSearchSpecrepeated[optional] Identifier of the survey(s) to fetch. If not specified, retrieves all accessible surveys.
list_seismic_idsbool[optional] Whether to list the survey's seismics in the response (default: false)
list_seismic_store_idsbool[optional] Whether to list the survey's seismic stores in the response. Requires ALL scope.
include_metadatabool[optional] Whether to include survey metadata in the response (default: false)
include_coveragecom.cognite.seismic.CoverageParametersDeprecated**. Use coverage instead.
coverageCoverageSpec[optional] If set, includes coverage in the responses in the specified format and CRS.
include_grid_transformationbool[optional] Whether to include the manually specified grid transformation in the response (default: false)
include_custom_coveragebool[optional] Whether to include the customer-provided survey coverage in the response.
coverage_sourceSurveyCoverageSource[optional] If set, requests that a coverage geometry from a particular source is returned in the SearchSurveysResponse. If set, the coverage field must also be provided. Note that this is independent from the custom coverage returned as part of the survey. If coverage_source is unset but coverage is, the coverage geometry will use custom coverage if available and fall back to the calculated coverage otherwise.
last_modifiedLastModifiedFilter[optional] If set, will further filter returned objects by the last modified time.

SegYSeismicRequest

FieldTypeLabelDescription
seismicIdentifierSpecifies a seismic object.
seismic_store_idint64Specifies a seismic store. Requires ALL scope.
polygoncom.cognite.seismic.GeometryTraces will be contained within the polygon.
linescom.cognite.seismic.LineBasedRectangleDeprecated**. Traces will be contained within the rectangle. Only valid if the queried object is 3D.
two_dee_extentSeismic2dExtentTraces will be contained within the extent. Only valid if the queried object is 2D.
three_dee_extentSeismic3dExtentTraces will be contained within the extent. Only valid if the queried object is 3D
skip_message_countint32[optional] Skips the first n chunks of the download. Useful for resuming aborted downloads. Defaults to 0.
trace_group_filterSeismicTraceGroupExtent[optional] Select which traces to return within each ensemble. Only valid if the queried object is pre-stack.

SegYSeismicResponse

FieldTypeLabelDescription
contentbytesSome bytes of the resulting Seg-Y file.

StreamTracesRequest

FieldTypeLabelDescription
seismicIdentifierThe identifier of the Seismic object to stream traces from
seismic_store_idint64The id of the Seismicstore to stream traces from. Requires ALL scope.
two_dee_extentSeismic2dExtentFilters traces by 2D header ranges. Only valid if the queried object is 2D.
three_dee_extentSeismic3dExtentFilters traces by 3D header ranges. Only valid if the queried object is 3D.
geometryGeometryFilterFilters traces by geometry. If the geometry is a polygon, traces will be contained within the geometry. If the geometry is a line or a linestring, the traces will be interpolated traces onto the line.
z_rangecom.cognite.seismic.LineDescriptor[optional] Which depth indices to return as part of the traces. Defaults to the entire depth.
include_trace_headerbool[optional] Whether to include the binary trace header in the streamed traces. Defaults to false.
trace_group_filterSeismicTraceGroupExtent[optional] Which traces to return within each ensemble. Only valid if the queried object is pre-stack.

TraceBounds

FieldTypeLabelDescription
trace_size_bytesint32The size in bytes of one Trace message
num_tracesint32The number of traces to be returned
sample_countint32The number of samples per trace
crsstringCRS of the returned trace coordinates
z_rangecom.cognite.seismic.LineDescriptorThe actual range of z values returned
three_dee_boundsLineRangeThree-dimensional bounds for the case when the seismic object is 3D
two_dee_boundsTwoDeeBoundsTwo-dimensional bounds for the case when the seismic object is 2D
cdp_trace_boundscom.cognite.seismic.LineDescriptorNull for post-stack data

TwoDeeBounds

FieldTypeLabelDescription
requested_boundsSeismic2dRangeA range bounding the trace header values of the returned traces, using the trace key specified in the extent (if any), or CDP if no extent was specified
cdp_boundscom.cognite.seismic.LineDescriptorA range bounding the CDP numbers of the returned traces

UnregisterSourceSegyFileRequest

FieldTypeLabelDescription
fileIdentifier[required] The file to unregister

UnregisterSourceSegyFileResponse

VolumeBoundsResponse

FieldTypeLabelDescription
trace_size_bytesint32The size in bytes of one Trace message
num_tracesint32The number of traces to be returned
sample_countint32The number of samples per trace
crsstringCRS of the returned trace coordinates
boundsLineBasedVolumeUpper and lower bounds and step sizes in each direction for the returned traces. Null if the result is empty. The iline and xline fields will be null for a line-like geometry.

VolumeRequest

Deprecated**.

FieldTypeLabelDescription
seismicIdentifierThe unique identifier for a seismic object.
seismic_store_idint64The unique ID for a seismic store. Requires ALL scope.
volumeLineBasedVolumeRetrieves traces by lines.
geometryGeometryBasedVolumeRetrieves traces within a geometry.
include_trace_headerbool[optional] Whether to include trace headers. Defaults to false.

Top

cognite/seismic/protos/v1/seismic_service_datatypes.proto

Messages that describe data types used by Seismic Datastore in Cognite Data Fusion

BinaryHeader

A representation of binary headers used to create or edit existing headers. BinaryHeader FIELDS contains the list of valid fields. to set after the object is constructed.

FieldTypeLabelDescription
file_idstringDeprecated**: This field will always be empty
tracesint32
trace_data_typeint32
fixed_length_tracesint32
segy_revisionint32
auxtracesint32
intervalint32
interval_originalint32
samplesint32
samples_originalint32
ensemble_foldint32
vertical_sumint32
trace_type_sorting_codeint32
sweep_type_codeint32
sweep_frequency_startint32
sweep_frequency_endint32
sweep_lengthint32
sweep_channelint32
sweep_taper_startint32
sweep_taper_endint32
sweep_taper_typeint32
correlated_tracesint32
amplitude_recoveryint32
original_measurement_systemint32
impulse_signal_polarityint32
vibratory_polarity_codeint32
raw_headerbytes

Coordinate

Describes a coordinate pair in some coordinate system.

FieldTypeLabelDescription
xfloatThe x value of the coordinate
yfloatThe y value of the coordinate

CoverageSpec

Specifies how to return a coverage.

FieldTypeLabelDescription
crsstring[optional] Which CRS to return the coverage in. Defaults to the native CRS of the object.
formatCoverageSpec.Format[optional] Which format to return the coverage as. Defaults to WKT.

Filter

Specify an individual filter.

FieldTypeLabelDescription
key_value_exact_matchKeyValueExactMatchMatch on an exact key-value pair. Both the key and the value must exactly match.

GeometryFilter

FieldTypeLabelDescription
geometrycom.cognite.seismic.Geometry
interpolation_methodcom.cognite.seismic.InterpolationMethodOnly used for linear geometries in 3D

Identifier

Used to identify zero or one objects by a unique id.

FieldTypeLabelDescription
idint64Identifies an object by internal id.
external_idstringIdentifies an object by external id.

KeyValueExactMatch

A key-value pair exact match filter

FieldTypeLabelDescription
keystringThe key to match on.
valuestring

LastModifiedFilter

The last modified timestamp range to search by. Returned objects will satisfy all specified arguments.

FieldTypeLabelDescription
beforegoogle.protobuf.Timestamp[optional] All returned objects will have a last_modified before this timestamp.
aftergoogle.protobuf.Timestamp[optional] All returned objects will have a last_modified after this timestamp.

LineBasedExtent

FieldTypeLabelDescription
extentsTraceExtentrepeated

LineBasedVolume

Describes a volume by line ranges.

FieldTypeLabelDescription
ilinecom.cognite.seismic.LineDescriptor[optional] The inline range. Defaults to the entire inline range, depending on context.
xlinecom.cognite.seismic.LineDescriptor[optional] The crossline range. Defaults to the entire crossline range, depending on context.
zcom.cognite.seismic.LineDescriptor[optional] The depth range. Defaults to the entire depth range, depending on context.

LineRange

Describe a line range.

FieldTypeLabelDescription
inlinecom.cognite.seismic.LineDescriptor[optional] The inline range. Defaults to the entire inline range, depending on context.
crosslinecom.cognite.seismic.LineDescriptor[optional] The crossline range. Defaults to the entire crossline range, depending on context.

MetadataFilter

Specifies a set of metadata filters. An object will be considered a match if it satisfies ALL filters. All strings are case sensitive.

FieldTypeLabelDescription
filtersFilterrepeatedThe list of metadata filters.

MinorLines

A set of points, described as one or more line descriptors.

FieldTypeLabelDescription
rangescom.cognite.seismic.LineDescriptorrepeated

OptionalMap

Used in edit messages to distinguish between an empty map and a missing map.

FieldTypeLabelDescription
dataOptionalMap.DataEntryrepeatedThe contents of the map.

OptionalMap.DataEntry

FieldTypeLabelDescription
keystring
valuestring

Partition

Represents partitions, used for granular access control

FieldTypeLabelDescription
idint64The unique internal id for this partition.
external_idstringThe external id of the partition
namestringA short description of this partition
seismicsSeismicrepeatedDeprecated**: This field will always be empty. Use seismic search by partition instead.
seismic_idsint64repeatedIf specified, the list of ids of seismics that belong to this partition.
last_modifiedgoogle.protobuf.TimestampThe last time this object was created or edited.

SearchSpec

Used to identify any number of objects, intended for plural Read or Search-type endpoints.

Can search by id, name, or prefix.

FieldTypeLabelDescription
idint64Searches by integer id.
id_stringstringSearches surveys and files by string-format uuid. This is not a valid way to search other objects.
external_idstringSearches seismics and seismic stores by an exact match of external id.
external_id_substringstringSearches seismics and seismic stores by a substring match of external id.
namestringSearchs any object by an exact match of name.
name_substringstringSearches any object by a substring match of name.
metadataMetadataFilterSearches surveys by metadata.
geometrycom.cognite.seismic.GeometrySearches surveys by intersection with geometry.

SegyOverrides

Metadata related to interpreting SEG-Y files.

FieldTypeLabelDescription
inline_offsetgoogle.protobuf.Int32Value[optional] Position of the inline number field in the trace headers. Defaults to 189 as per the SEG-Y rev1 specification
crossline_offsetgoogle.protobuf.Int32Value[optional] Position of the crossline number field in the trace headers. Defaults to 193 as per the SEG-Y rev1 specification
cdp_x_offsetgoogle.protobuf.Int32Value[optional] Position of the X coordinate of ensemble (CDP) in trace headers. Defaults to 181 as per the SEG-Y rev1 specification
cdp_y_offsetgoogle.protobuf.Int32Value[optional] Position of the Y coordinate of ensemble (CDP) in trace headers. Defaults to 185 as per the SEG-Y rev1 specification
cdp_number_offsetgoogle.protobuf.Int32Value[optional] Position of the ensemble (CDP) number in trace headers. Defaults to 21 as per the SEG-Y rev1 specification
energy_source_point_offsetgoogle.protobuf.Int32Value[optional] Position of the energy source point in trace headers. Defaults to 17 as per the SEG-Y rev1 specification
shotpoint_offsetgoogle.protobuf.Int32Value[optional] Position of the shotpoint field in trace headers. Defaults to 197 as per the SEG-Y rev1 specification
cdp_trace_offsetgoogle.protobuf.Int32Value[optional] Position of the trace number within ensemble. Defaults to 21 as per the SEG-Y rev1 specification.
offset_header_offsetgoogle.protobuf.Int32Value[optional] Position of the 'offset' field in the trace header. Defaults to 37 as per the SEG-Y rev1 specification.
source_group_scalar_overridegoogle.protobuf.FloatValue[optional] Multiplier for CDP-X and CDP-Y values that overrides the scalar factor obtained from the trace header. Note that this is a floating point multiplier used directly to scale CDP-X and CDP-Y values, and it is not interpreted in the way that the "source group scalar trace header field" in the SEG-Y specification is. In other words, to divide by 100 you must specify 0.01, not -100. Negative values and values greater than 1 are not permitted. To remove the override from a file where an override has previously been set, set the source_group_scalar_override to 0 or NaN. The next ingestion process for that file will then use the source group scalar values found in trace headers.

Seismic

A cutout of a seismic store

FieldTypeLabelDescription
idint64The unique internal id of the seismic. It is always present.
external_idstringThe external id of the seismic
namestringA non-unique name for the seismic. It is easily editable and is intended to be used as a human-friendly reference.
crsstringThe Coordinate Reference System of the seismic
metadataSeismic.MetadataEntryrepeatedAny custom-defined metadata
text_headerTextHeaderThe text header that corresponds to the seismic
binary_headerBinaryHeaderThe binary header that corresponds to the seismic
line_rangeLineRangeDeprecated**: Use the GetTraceBounds API call instead.
volume_defVolumeDefDeprecated**: The VolumeDef describing the seismic. Use extents instead.
cutoutSeismicCutoutThe cutout the seismic object was created with.
extentSeismicExtentA description of the traces contained in the seismic.
partition_idint64The id of the partition the seismic belongs to.
seismicstore_idint64The id of the seismicstore the seismic is derived from. It is present only if you have READ access and ALL scope.
coveragecom.cognite.seismic.GeometryThe coverage geometry for the seismic.
created_emptyboolDeprecated**. Whether this seismic was created empty. Use the cutout field instead.
trace_countint64An estimate of the number of traces contained within the seismic.
trace_header_fieldsTraceHeaderFieldrepeatedThe trace header fields that have been registered as keys for indexing. This will always match the trace header fields registered for the underlying seismic store.
dimensionsDimensionsThe underlying file's data dimensionality, either 2D or 3D This will always match the dimensionality for the underlying seismic store.
last_modifiedgoogle.protobuf.TimestampThe last time this object was created or edited.
seismic_data_typeSeismicDataTypeWhether this seismic object contains pre-stack or post-stack data.

Seismic.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

Seismic2dExtent

Describes the extent of a 2d seismic object.

FieldTypeLabelDescription
trace_keyTraceHeaderFieldMust be an applicable field for 2D
trace_rangescom.cognite.seismic.LineDescriptorrepeatedRange of header values to use

Seismic2dRange

FieldTypeLabelDescription
trace_keyTraceHeaderFieldMust be an applicable field for 2D
trace_rangecom.cognite.seismic.LineDescriptor

Seismic3dDef

A enumeration of inline/crossline coordinates.

FieldTypeLabelDescription
major_headerTraceHeaderFieldWhether inline or crossline is the first coordinate.
minor_headerTraceHeaderFieldWhether inline or crossline is the second coordinate. Must be different to major_header.
linesSeismic3dDef.LinesEntryrepeatedThe set of included coordinates. The key is major_header and values are minor_header.

Seismic3dDef.LinesEntry

FieldTypeLabelDescription
keyint32
valueMinorLines

Seismic3dExtent

Describes the extent of a 3d seismic object.

FieldTypeLabelDescription
rectsSeismic3dRectsAn extent described as a set of rectangles.
defSeismic3dDefAn extent described by an enumeration of inline/crossline pairs.

Seismic3dRect

A single rectangle described by a stepped inline and crossline.

FieldTypeLabelDescription
inline_rangecom.cognite.seismic.LineDescriptor
xline_rangecom.cognite.seismic.LineDescriptor

Seismic3dRects

A set of rectangles, the union of which describes the extent.

FieldTypeLabelDescription
rectsSeismic3dRectrepeatedThe rectangles that compose the extent.

SeismicCutout

Describes a cutout for a seismic.

FieldTypeLabelDescription
two_dee_extentSeismic2dExtentIndicates that the seismic was created with this 2D extent.
three_dee_extentSeismic3dExtentIndicates that the seismic was created with this 3D extent (or an equivalent VolumeDef).
geometrycom.cognite.seismic.GeometryIndicates that the seismic was created with this geometry.
emptyboolIndicates that the seismic was created empty.
fullboolIndicates that the seismic was created to cover the entire seismicstore.

SeismicExtent

Describes the extent of a seismic object.

FieldTypeLabelDescription
two_dee_extentSeismic2dExtentA two dimensional extent.
three_dee_extentSeismic3dExtentA three dimensional extent.

SeismicStore

Represents a seismic store.

FieldTypeLabelDescription
idint64The unique internal id of the seismic store
namestringThe unique name of the seismic store. This will become non-unique in the future, and external_id will be the only unique string-based identifier for seismic stores.
survey_idstringThe uuid of the survey this seismic store belongs to.
survey_id_intint64The integer id of the survey this seismic store belongs to.
ingestion_sourcecom.cognite.seismic.IngestionSourceThe source of the seismicstore. It indicates how the file was ingested
metadataSeismicStore.MetadataEntryrepeatedCustom-defined metadata.
ingested_filecom.cognite.seismic.FileDeprecated**. Same as ingested_source_file.
ingested_source_fileSourceSegyFileIf present, the file this SeismicStore was ingested from.
inline_volume_defVolumeDefDeprecated**: Volume definition for the store, indexed on inlines. Maps from an inline to all of its valid crosslines. Use extents instead.
crossline_volume_defVolumeDefDeprecated**: Volume definition for the store, indexed on crosslines. Maps from a crossline to all of its valid inlines. Use extents instead.
extentSeismicExtentDescription of the traces contained in the seismicstore.
text_headerTextHeaderIf present, the text header for this seismic store.
binary_headerBinaryHeaderIf present, the binary header for this seismic store.
storage_tier_namestringrepeatedTenant specific name for the storage facility the trace data are stored in. If empty, it is stored in an unspecified trace store. While support for multiple storage backends per store is planned, this is not currently offered.
coveragecom.cognite.seismic.GeometryIf present, the coverage geometry for this seismic store.
trace_header_fieldsTraceHeaderFieldrepeatedThe trace header fields that have been registered as keys for indexing.
dimensionsDimensionsThe underlying file's data dimensionality, either 2D or 3D.
crsstringThe coordinate reference system used by this seismicstore.
last_modifiedgoogle.protobuf.TimestampThe last time this object was created or edited.
seismic_data_typeSeismicDataTypeWhether this seismic store contains pre-stack or post-stack data.

SeismicStore.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

SeismicTraceGroupExtent

FieldTypeLabelDescription
group_headerTraceHeaderFieldThe trace header to differentiate between prestack migrated traces in the same bin
linesSeismicTraceGroupLines

SeismicTraceGroupLines

FieldTypeLabelDescription
linescom.cognite.seismic.LineDescriptorrepeated

SourceSegyFile

Metadata about a SEG-Y file registered for ingestion. Trace data for the file after ingestion is available via the corresponding seismic store object.

FieldTypeLabelDescription
uuidstringA unique string id.
idint64A unique numerical id.
external_idcom.cognite.seismic.ExternalIdA unique external id.
namestringThe name of the file
cloud_storage_pathstringThe cloud storage path including protocol, bucket, directory structure, and file name. Usually in format gs://path/to/file/some_name.sgy
metadataSourceSegyFile.MetadataEntryrepeatedAssociated key-value metadata.
segy_overridesSegyOverridesOverrides for various Seg-Y options.
key_fieldsTraceHeaderFieldrepeatedThe trace header fields that will be used as keys for indexing.
dimensionsDimensionsFile data dimensionality, either 2D or 3D
crsstringThe coordinate reference system used by this file
survey_idint64The integer id of the survey this file is contained in
last_modifiedgoogle.protobuf.TimestampThe last time this object was created or edited.
seismic_data_typeSeismicDataTypeWhether this file contains pre-stack or post-stack data.

SourceSegyFile.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

Survey

Representation of the data for a survey

FieldTypeLabelDescription
idstringThe unique uuid for the survey in CDF. The identifier is generated by CDF on creation and not editable.
id_intint64The unique integer ID for the survey. This ID should be used for V1 survey operations.
namestringSurvey name: Should be a short but recognizable name for the survey. Must be unique within a single CDF tenant, and may be used to refer to the survey in API calls.
metadataSurvey.MetadataEntryrepeatedMetadata describing the survey with named fields and values. @exclude TODO: Augment surveys with a predefined set of fields giving a predictable metadata model and better integration with Discover.
external_idcom.cognite.seismic.ExternalIdExternal identifier of the survey. The value of this field must be unique among all the surveys in the CDF tenant. It may be used for correlating with systems outside CDF, and for search and retrieval operations later.
crsstringCoordinate reference system to be used by all members of this survey
grid_transformationcom.cognite.seismic.SurveyGridTransformationA manually specified affine transformation between bin grid coordinates and projected crs coordinates, either using an origin point and the azimuth of the xline axis (P6Transformation), or by specifying three or more corners of the grid as a list of DoubleTraceCoordinates. This transformation must be valid for all members of this survey.
custom_coveragecom.cognite.seismic.CustomSurveyCoverageA user-provided coverage override
last_modifiedgoogle.protobuf.TimestampThe last time this object was created or edited.

Survey.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

TextHeader

A representation of text headers used to create or edit existing headers.

FieldTypeLabelDescription
file_idstringDeprecated**: This field will always be empty
headerstringThe text content of the header
raw_headerstringThe raw bytes of a header as a string

TraceExtent

FieldTypeLabelDescription
xlineint32
ilineint32
zcom.cognite.seismic.LineDescriptor

VolumeDef

Deprecated**: VolumeDef is a simple, versioned, flexible format for describing which grid points of a seismic volume contain data.

The grid is described per line. Each line contains a series of descriptors that specify the points on the axis perpendicular to the line. For example, a volumedef that is indexed as inline-major will use inline numbers as keys in the lines object, and have descriptors with crossline numbers.

For more information refer to the SDK docs.

FieldTypeLabelDescription
jsonstringUses the Volume Definition schema

CoverageSpec.Format

NameNumberDescription
WKT0
GEOJSON1

Dimensions

Used to specify dimensionality of a seismic object.

NameNumberDescription
UNSPECIFIED_DIMENSION0
TWO_DEE2
THREE_DEE3

SeismicDataType

The type of seismic data.

NameNumberDescription
UNSPECIFIED_DATA_TYPE0
POSTSTACK1
PRESTACK_DEPTH_MIGRATED2

SurveyCoverageSource

NameNumberDescription
UNSPECIFIED_SURVEY_COVERAGE_SOURCE0Used as the default when a specific source isn't requested by the user.
CUSTOM1Requesting or returning custom coverage
CALCULATED2Requesting or returning calculated coverage

TraceHeaderField

Enumeration of possible trace header fields used for indexing seismic objects.

NameNumberDescription
UNSPECIFIED_TRACE_HEADER_FIELD0
ENERGY_SOURCE_POINT1Valid for 2d seismic objects. Corresponds to bytes 17-20 of standard trace header: energy source point number.
CDP2Valid for 2d seismic objects. Corresponds to bytes 21-24 of standard trace header: ensemble number.
INLINE3Valid for 3d seismic objects. Corresponds to bytes 189-192 of standard trace header: inline number.
CROSSLINE4Valid for 3d seismic objects. Corresponds to bytes 193-196 of standard trace header: crossline number.
SHOTPOINT5Valid for 2d seismic objects. Corresponds to bytes 197-202 of standard trace header: shotpoint number.
CDP_TRACE6Valid for pre-stack seismic objects. Corresponds to bytes 25-28 of standard trace header: trace number within ensemble
OFFSET7Valid for pre-stack seismic objects. Corresponds to bytes 37-40 of standard trace header: distance from center of source point to the center of receiver group.

Top

cognite/seismic/protos/types.proto

Messages for types used in ingestion and query services in Seismic Datastore in Cognite Data Fusion

CRS

FieldTypeLabelDescription
crsstringA coordinate reference system specified as a full EPSG code, for example "EPSG:4326".

Coordinate

Basic type representing (x,y) coordinate in the given coordinate reference system (CRS).

FieldTypeLabelDescription
crsstringThe CRS of the coordinate. Must be a full EPSG code, for example EPSG:23031.
xfloatThe x value of the coordinate
yfloatThe y value of the coordinate

CoverageParameters

Deprecated**: use CoverageSpec instead. Parameters for requesting coverage of survey

FieldTypeLabelDescription
crsCRS[optional] If CRS provided converts coverage to given CRS. Otherwise, will return in the survey's original CRS
in_wktbool[optional] Whether to use WKT format in the response. Defaults to false, returning GeoJSON.

CustomSurveyCoverage

Customer-provided custom coverage for surveys.

FieldTypeLabelDescription
custom_coverageGeometryOverrides survey coverage with the provided custom coverage geometry
no_custom_coverageCustomSurveyCoverage.NoCustomCoverageNo custom coverage is provided. Survey coverage will be computed from the seismicstores contained in the survey.

CustomSurveyCoverage.NoCustomCoverage

DeduceFromTraces

Have the seismic service try to deduce the affine transformation for each file by reading trace coordinates

DoubleTraceCoordinates

Correlated grid indices and coordinates

FieldTypeLabelDescription
ilineint32The inline number. Within a 3D survey, a inline represents a seismic line parallel to the direction in which the data was adquired.
xlineint32The xline number. Within a 3D survey, a xline represents a seismic line perpendicular to the direction in which the data was adquired.
xfloatThe x value of the coordinate
yfloatThe y value of the coordinate

ExternalId

An external ID.

FieldTypeLabelDescription
external_idstring

File

Deprecated**. File or dataset or cube derived from a single SEG-Y file

FieldTypeLabelDescription
idstring
namestring
metadataFile.MetadataEntryrepeated
is_temporarybool
external_idExternalId

File.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

GeoJson

The GeoJSON format (RFC 7946) Supported geometry: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, and GeometryCollection. Example:

{
"type": "Point",
"coordinates": [100.0, 0.0]
}
FieldTypeLabelDescription
jsongoogle.protobuf.Struct

Geometry

Geometry can be specified using either wkt or geoJSON. CRS is always required.

FieldTypeLabelDescription
crsCRS[required] The CRS of the geometry.
wktWktA wkt format geometry.
geoGeoJsonA GeoJSON format geometry.

Identifier

Deprecated**. Specify either id or name to find a file or survey.

FieldTypeLabelDescription
idstring
namestring

LineBasedRectangle

Deprecated**. Range of inline and crossline indices defining a 2D region

FieldTypeLabelDescription
top_leftPositionQuery
bottom_rightPositionQuery

LineDescriptor

Describes a series of points. The first point is min, the next point is min+step, the point after that is min+step*2, and so on. None of the points will be greater than max.

FieldTypeLabelDescription
mingoogle.protobuf.Int32Value[optional] The first element of the line. Defaults to the minimum value, depending on context.
maxgoogle.protobuf.Int32Value[optional] The maximum value of a point on the line. Defaults to the maximum value, depending on context.
stepgoogle.protobuf.Int32Value[optional] The 'step' of the line. Defaults to 1.

LineRange

Object to store the line range. From and to are optional

FieldTypeLabelDescription
from_linegoogle.protobuf.Int32Value
to_linegoogle.protobuf.Int32Value

LineSelect

Deprecated**. Specifies an inline or a crossline

FieldTypeLabelDescription
ilineint32The inline number. Within a 3D survey, a inline represents a seismic line parallel to the direction in which the data was adquired.
xlineint32The xline number. Within a 3D survey, a xline represents a seismic line perpendicular to the direction in which the data was adquired.

P6Transformation

Specify the transformation by an origin point and the crossline azimuth Format inspired by IOGP guidance note 373-7-2 section 2.3.2.4. https://ge0mlib.com/papers/Guide/IOGP/373-07-2-1_2017.pdf

FieldTypeLabelDescription
handednessHandedness
originDoubleTraceCoordinatesA point in the grid
iline_bin_widthfloatThe bin width along the inline axis
xline_bin_widthfloatThe bin width along the crossline axis
xline_azimuthfloatMap bearing of the crossline axis in clockwise degrees from north
iline_bin_incint32Inline increment corresponding to a bin
xline_bin_incint32Crossline increment corresponding to a bin

PositionQuery

Deprecated**. Point defined by its inline and crossline indices

FieldTypeLabelDescription
ilineint32The inline number. Within a 3D survey, a inline represents a seismic line parallel to the direction in which the data was adquired.
xlineint32The xline number. Within a 3D survey, a xline represents a seismic line perpendicular to the direction in which the data was adquired.

Project

Deprecated**.

FieldTypeLabelDescription
idstring
aliasstring

SlabTrace

Deprecated**. Wrapper over Trace type that additionally provide information about the range of z values included in the trace.

FieldTypeLabelDescription
traceTrace
z_fromint32
z_toint32

SurfacePoint

Deprecated**. Basic type to represent a point in a surface defined by a horizontal grid Used in horizontal slice queries

FieldTypeLabelDescription
ilineint32The inline number. Within a 3D survey, a inline represents a seismic line parallel to the direction in which the data was adquired.
xlineint32The xline number. Within a 3D survey, a xline represents a seismic line perpendicular to the direction in which the data was adquired.
valuefloat

Survey

Deprecated**. A survey represents a collection of files in the same area

FieldTypeLabelDescription
idstringSurvey ID
namestringSurvey name
metadataSurvey.MetadataEntryrepeated
external_idExternalIdSurvey external ID
crsCRSThe Coordinate Reference System of the survey
grid_transformationSurveyGridTransformation
custom_coverageCustomSurveyCoverage

Survey.MetadataEntry

FieldTypeLabelDescription
keystring
valuestring

SurveyGridTransformation

Specify the affine transformation between line indices and coordinates

FieldTypeLabelDescription
p6_transformationP6Transformation
trace_cornersTraceCorners
deduce_from_tracesDeduceFromTraces

Trace

Basic type to represent a seismic trace Used in trace, vertical slices and volume queries Contains the samples and information on positioning If a trace is an original trace in the file, it can optionally contain the trace header. This is not valid for traces that are synthetically generated from interpolation.

FieldTypeLabelDescription
trace_headerbytesThe binary SEGY trace header, if requested.
ilinegoogle.protobuf.Int32ValueThe inline number. Only populated for 3D seismics.
xlinegoogle.protobuf.Int32ValueThe xline number. Only populated for 3D seismics.
cdpgoogle.protobuf.Int32ValueThe cdp number. Only populated for 2D seismics indexed by cdp.
shotpointgoogle.protobuf.Int32ValueThe shotpoint number. Only populated for 2D seismics indexed by shotpoint.
energy_source_pointgoogle.protobuf.Int32ValueThe energy source point number. Only populated for 2D seismics indexed by energy source point.
cdp_tracegoogle.protobuf.Int32ValueThe cdp trace number. Only populated for prestack-migrated seismics indexed by cdp_trace.
offsetgoogle.protobuf.Int32ValueThe offset number. Only populated for prestack-migrated seismics indexed by offset.
tracefloatrepeatedThe underlying array of floats representing samples
coordinateCoordinateThe CDP X and Y coordinates of the trace.

TraceCorners

Specify the transformation by giving the coordinates of three or more corners

FieldTypeLabelDescription
cornersDoubleTraceCoordinatesrepeated

Wkt

Well-known text representation of geometry (WKT)

FieldTypeLabelDescription
geometrystring

FileStep

Deprecated**.

NameNumberDescription
REGISTER0
INSERT_FILE_HEADERS1
INSERT_TRACE_HEADERS2
INSERT_DATA3
COMPUTE_COVERAGE4
COMPUTE_GRID5
COMPUTE_TRACE_INDICES6
DELETING254
DELETE255

Handedness

NameNumberDescription
RIGHTHANDED0inline axis is 90 deg clockwise from crossline AKA EPSG code 9666
LEFTHANDED1inline axis is 90 deg counterclockwise from crossline AKA EPSG code 1049

IngestionSource

NameNumberDescription
INVALID_SOURCE0
FILE_SOURCE1
TRACE_WRITER2TraceWriter

InterpolationMethod

NameNumberDescription
NEAREST_TRACE0
INVERSE_DISTANCE_WEIGHTING1

JobStatus

NameNumberDescription
NONE0Default value for the enum.
QUEUED1The job is in the queue but has not been worked on.
IN_PROGRESS2The job is being processed.
SUCCESS3The job has terminated correctly.
FAILED4The job has failed.
TIMEOUT5The job took too long and has timed out. No more work will be done on the job.

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)