Protocol Documentation
Top
cognite/seismic/protos/v1/seismic_service.proto
SeismicAPI
Service for querying data and metadata from seismic tracestore in Cognite Data Fusion (CDF) seismic datastore.
Queries are done primarily on cubes, with some management endpoints for tracestores $ partitions.
Queries are divided in:
- Metadata: General information and headers for surveys and files.
- Trace: Retrieve traces by geometry, line, or volume.
- Artificial sampling: Get the (calculated/interpolated) values of properties in the file/tracestore given arbitrary positions.
Metadata queries
| Method Name | Request Type | Response Type | Description |
|---|
| CreateSurvey | CreateSurveyRequest | Survey | Creates 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. |
| SearchSurveys | SearchSurveysRequest | SearchSurveyResponse stream | Lists all surveys accessible to the client. Optionally, it includes Cubes associated with the surveys. Can optionally search surveys based on both/either of two 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. |
| EditSurvey | EditSurveyRequest | Survey | Modifies the metadata for a survey. |
| DeleteSurvey | DeleteSurveyRequest | DeleteSurveyResponse | Deletes a specified survey. Must have ALL scope and Write capabilities. In the case of Surveys, the "name" should be input into the external_ids field of the Identifier. |
| RegisterSourceSegyFile | RegisterSourceSegyFileRequest | RegisterSourceSegyFileResponse | Registers a new file in a (previously registered) survey as source for ingestion. |
| EditSourceSegyFile | EditSourceSegyFileRequest | EditSourceSegyFileResponse | Edits a registered source file. Before editing, there must be no ingestion jobs running for the source file, and if already ingested, any SeismicStore associated with the source file must be deleted. This request will fail if the above criteria aren't met. |
| UnregisterSourceSegyFile | UnregisterSourceSegyFileRequest | UnregisterSourceSegyFileResponse | Unregisters a file previously registered as the source for ingestion. Before unregistering, there must be no ingestion jobs running for the source file, and if already ingested, any SeismicStore associated with the source file must be deleted. This request will fail if the above criteria aren't met. |
| IngestSourceSegyFile | IngestSourceSegyFileRequest | IngestSourceSegyFileResponse | Requests queueing of a registered file for ingestion. |
| CreateSeismic | CreateSeismicRequest | Seismic | Creates new Seismics and assign them to partitions. Seismics are mostly immutable save for their name and metadata. The user needs to delete an existing cutout and create a new one if, for example, the definition or the seismic store must be changed. |
| SearchSeismics | SearchSeismicsRequest | Seismic stream | Returns Seismic metadata given its id. Can optionally retrieve seismic store & partition info if user has the right scope. Use GetVolume to retrieve traces. |
| EditSeismic | EditSeismicRequest | Seismic | Edits the specified seismic. Seismic object names and metadata can be changed. The cutout definition, however, can't be changed. To modify the definition or the owning partition, delete the seismic object and create a new one. |
| DeleteSeismic | DeleteSeismicRequest | DeleteSeismicResponse | Deletes seismic objects. |
| SearchSeismicStores | SearchSeismicStoresRequest | SeismicStore stream | Searches and retrieves seismic stores. Can only retrieve seismic stores you own. |
| InspectIngestion | InspectIngestionRequest | InspectIngestionResponse | Inspects the seismicstore resulting from a possibly failed ingestion. Useful for debugging failed ingestions. |
| EditSeismicStore | EditSeismicStoreRequest | SeismicStore | Sets the name of a seismic store object. |
| DeleteSeismicStore | DeleteSeismicStoreRequest | DeleteSeismicStoreResponse | Deletes a seismic store. If any seismics still reference the specified seismic store, the request will fail. |
| CreatePartition | CreatePartitionRequest | Partition | Creates a data partition, optionally setting a name. |
| SearchPartitions | SearchPartitionsRequest | Partition stream | Returns the specified partitions with the same search options as the other search endpoints. |
| EditPartition | EditPartitionRequest | Partition | Edits partitions. The only modifiable field is the name. |
| DeletePartition | DeletePartitionRequest | DeletePartitionResponse | Deletes the specified partition and returns a response if it was successfully deleted. |
| GetVolume | VolumeRequest | .com.cognite.seismic.Trace stream | Requests a volume of traces by range of inlines, crosslines, and time Deprecated - use StreamTraces instead. |
| GetVolumeBounds | VolumeRequest | VolumeBoundsResponse | Returns information about what a GetVolume request would return, including bounding boxes of trace header values and estimated total size. Deprecated - use GetTraceBounds instead. |
| StreamTraces | StreamTracesRequest | .com.cognite.seismic.Trace stream | Requests 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. |
| GetTraceBounds | StreamTracesRequest | TraceBounds | Returns information about what a StreamTraces request would return, including bounding boxes of trace header values, and estimated total size. |
| GetSegYFile | SegYSeismicRequest | SegYSeismicResponse stream | Fetch seismic data in SEG-Y format. The stream of responses each containing a byte array that must be written sequentially to a file to produce a SEG-Y file. The ordering of traces in the output is unspecified. 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 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. |
| SearchFiles | SearchFilesRequest | SourceSegyFile stream | Retrieves 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 all files matching the search criteria that have been returned. |
| SearchJobStatus | SearchJobStatusRequest | JobStatusResponse stream | Retrieves 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
| Field | Type | Label | Description |
|---|
| name | string | | optional name |
| external_id | string | | not optional externalid |
CreateSeismicRequest
CreateSurveyRequest
CreateSurveyRequest.MetadataEntry
DeletePartitionRequest
DeletePartitionResponse
| Field | Type | Label | Description |
|---|
| success | bool | | |
DeleteSeismicRequest
DeleteSeismicResponse
| Field | Type | Label | Description |
|---|
| succeeded | bool | | |
DeleteSeismicStoreRequest
DeleteSeismicStoreResponse
| Field | Type | Label | Description |
|---|
| succeeded | bool | | |
DeleteSurveyRequest
DeleteSurveyResponse
| Field | Type | Label | Description |
|---|
| success | bool | | |
EditPartitionRequest
| Field | Type | Label | Description |
|---|
| partition | Identifier | | Must uniquely identify a partition |
| new_name | string | | |
EditSeismicRequest
EditSeismicStoreRequest
| Field | Type | Label | Description |
|---|
| seismic_store_id | int64 | | Deprecated. Use identifier instead. |
| name | google.protobuf.StringValue | | If not null, will change the seismic store name. |
| metadata | OptionalMap | | If not null, will replace the seismic store metadata. |
| seismic_store | Identifier | | Uniquely identifies one seismic store. |
| external_id | google.protobuf.StringValue | | If not null, will attempt to change the seismic store external id. Can fail if the new external id is not unique. |
EditSourceSegyFileRequest
EditSourceSegyFileRequest.MetadataEntry
EditSourceSegyFileResponse
EditSurveyRequest
GeometryBasedVolume
IngestSourceSegyFileRequest
| Field | Type | Label | Description |
|---|
| file | Identifier | | [required] The file to queue for ingesting. |
| target_storage_tier_name | string | | [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 consider 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 removing the file's data from the previously active storage tier. |
IngestSourceSegyFileResponse
| Field | Type | Label | Description |
|---|
| job_id | string | | |
IngestionLog
InspectIngestionRequest
InspectIngestionResponse
JobStatusResponse
RegisterSourceSegyFileRequest
| Field | Type | Label | Description |
|---|
| survey | Identifier | | [required] The survey this source file belongs to |
| path | string | | [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_id | com.cognite.seismic.ExternalId | | [optional] An external identifier - matches service contract field |
| metadata | RegisterSourceSegyFileRequest.MetadataEntry | repeated | [optional] Any custom-defined metadata |
| crs | com.cognite.seismic.CRS | | [required] Official name of the CRS used. Example: "EPSG:23031" |
| segy_overrides | SegyOverrides | | [optional] Overrides for the source file. |
| key_fields | TraceHeaderField | repeated | [optional] The trace header fields that will be used as keys for indexing. |
| dimensions | Dimensions | | [required] File data dimensionality, either 2D or 3D. |
RegisterSourceSegyFileRequest.MetadataEntry
RegisterSourceSegyFileResponse
SearchFilesRequest
Used to search files by a given file/seismic-store/survey search specification.
| Field | Type | Label | Description |
|---|
| spec | SearchSpec | | Find files using a file search specification. |
| seismic_store | SearchSpec | | Find files using a seismic store search specification. |
| survey | SearchSpec | | Find files using a survey search specification. |
| last_modified | LastModifiedFilter | | Filter files by last modified. |
SearchJobStatusRequest
SearchPartitionsRequest
SearchSeismicStoresRequest
| Field | Type | Label | Description |
|---|
| seismic_store | SearchSpec | | |
| survey | SearchSpec | | |
| file | SearchSpec | | |
| last_modified | LastModifiedFilter | | Will return seismic stores by last modified. |
| include_file_info | bool | | If true, includes File information in the response. |
| include_volume_definitions | bool | | If true, includes inline/crossline volume definitions for store. |
| include_extent | bool | | If true, includes a description of the traces contained in the seismic store. |
| extent_key | TraceHeaderField | | 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 a key header for each seismic store. Any seismic stores not indexed by the given header will have their extent field left as null. |
| include_headers | bool | | If true, includes text and binary headers in the response. |
| include_coverage | bool | | Deprecated. Use coverage instead. |
| coverage | CoverageSpec | | If specified, include coverage. |
SearchSeismicsRequest
| Field | Type | Label | Description |
|---|
| survey | SearchSpec | | |
| seismic | SearchSpec | | |
| partition | SearchSpec | | Can only search on partitions you can see. |
| seismic_store | SearchSpec | | Must be a data manager to search by seismic store. |
| last_modified | LastModifiedFilter | | Search for seismics by last modified. |
| include_text_header | bool | | |
| include_binary_header | bool | | |
| include_line_range | bool | | |
| include_volume_definition | bool | | If true, include the volume definition. |
| include_cutout | bool | | If true, include the cutout specification the seismic was created with. |
| include_extent | bool | | If true, include a description of the included traces. |
| extent_key | TraceHeaderField | | 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_store | bool | | If true, include info on the backing seismic store. Must be data manager. |
| include_partition | bool | | If true, includes info on the partition. Must be data manager.\ |
| include_coverage | bool | | Deprecated. Use coverage instead. |
| coverage | CoverageSpec | | If specified, requests coverage as well. |
SearchSurveyResponse
SearchSurveysRequest
| Field | Type | Label | Description |
|---|
| surveys | SearchSpec | repeated | Optional identifier of the survey. If empty, retrieves all accessible surveys. |
| list_seismic_ids | bool | | Set to true to list the survey's seismics in the response (default: false). |
| list_seismic_store_ids | bool | | Set to true to list the survey's seismic stores in the response. Only tenant users can see this. |
| include_metadata | bool | | Set to true to include survey metadata in the response (default: false). |
| include_coverage | com.cognite.seismic.CoverageParameters | | Deprecated. Use coverage instead. |
| coverage | CoverageSpec | | Set this field to include coverage in the response (default: No coverage). |
| include_grid_transformation | bool | | Set this field to include the manually specified grid transformation in the response (default: false). |
| include_custom_coverage | bool | | Set this field to include the customer-provided survey coverage in the response. |
| coverage_source | SurveyCoverageSource | | Requests that a coverage geometry from a particular source is returned in the SearchSurveysResponse. If this field is specified, the coverage parameters in the include_coverage field must also be set. Note that this is independent of the custom coverage returned as part of the survey. If no coverage source is provided, but the coverage parameters are provided, the coverage geometry will be fetched from the custom coverage if one has been provided, and the calculated coverage in other cases. |
| last_modified | LastModifiedFilter | | If set, will further filter returned objects by last modified. |
SegYSeismicRequest
SegYSeismicResponse
| Field | Type | Label | Description |
|---|
| content | bytes | | |
StreamTracesRequest
| Field | Type | Label | Description |
|---|
| seismic | Identifier | | The identifier of the Seismic object to stream traces from. |
| seismic_store_id | int64 | | The id of the Seismic store to stream traces from. Only accessible by data managers. |
| two_dee_extent | Seismic2dExtent | | Filter traces by 2D header ranges. Only valid if the queried object is 2D. |
| three_dee_extent | Seismic3dExtent | | Filter traces by 3D header ranges. Only valid if the queried object is 3D. |
| geometry | GeometryFilter | | Filter traces by geometry. If the geometry is a polygon, select traces contained in the geometry. If the geometry is a line or a line string, interpolate traces onto the line. |
| z_range | com.cognite.seismic.LineDescriptor | | Select which depth indices to return as part of the traces. |
| include_trace_header | bool | | Whether to include the binary trace header in the streamed traces. |
TraceBounds
| Field | Type | Label | Description |
|---|
| trace_size_bytes | int32 | | The size in bytes of one Trace message |
| num_traces | int32 | | The number of traces returned |
| sample_count | int32 | | The number of samples per trace |
| crs | string | | CRS of the returned trace coordinates |
| z_range | com.cognite.seismic.LineDescriptor | | The actual range of z values returned |
| three_dee_bounds | LineRange | | Three-dimensional bounds for the case when the seismic object is 3D |
| two_dee_bounds | TwoDeeBounds | | Two-dimensional bounds for the case when the seismic object is 2D |
TwoDeeBounds
| Field | Type | Label | Description |
|---|
| requested_bounds | Seismic2dRange | | A 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_bounds | com.cognite.seismic.LineDescriptor | | A range bounding the CDP numbers of the returned traces. |
UnregisterSourceSegyFileRequest
| Field | Type | Label | Description |
|---|
| file | Identifier | | [required] The file to unregister. |
UnregisterSourceSegyFileResponse
VolumeBoundsResponse
| Field | Type | Label | Description |
|---|
| trace_size_bytes | int32 | | The size in bytes of one Trace message. |
| num_traces | int32 | | The number of traces returned. |
| sample_count | int32 | | The number of samples per trace. |
| crs | string | | CRS of the returned trace coordinates. |
| bounds | LineBasedVolume | | Upper 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
Top
cognite/seismic/protos/v1/seismic_service_datatypes.proto
Messages that describe data types used by Seismic Datastore in Cognite Data Fusion
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.
Coordinate
| Field | Type | Label | Description |
|---|
| x | float | | The x value of the coordinate. |
| y | float | | The y value of the coordinate. |
CoverageSpec
| Field | Type | Label | Description |
|---|
| crs | string | | If CRS isn't specified (aka is blank), uses default CRS from file. |
| format | CoverageSpec.Format | | |
Filter
Specify an individual filter.
GeometryFilter
Identifier
Used to identify zero or one objects that may have an external id.
KeyValueExactMatch
Matches when the key AND value are exact matches.
LastModifiedFilter
Specifies a last modified timestamp range to search.
Returned objects will satisfy all arguments that aren't null.
LineBasedExtent
LineBasedVolume
LineRange
LineSelect
Specifying how to filter metadata. An object will be considered a match if it satisfies ALL filters.
All strings are case sensitive.
| Field | Type | Label | Description |
|---|
| filters | Filter | repeated | |
MinorLines
OptionalMap
Used in edit messages to distinguish between an empty map, and a missing map.
OptionalMap.DataEntry
Partition
Represents partitions, used for granular access control.
| Field | Type | Label | Description |
|---|
| id | int64 | | The unique internal id for this partition. |
| external_id | string | | The external id of the partition. |
| name | string | | The human-friendly name for this partition. |
| seismics | Seismic | repeated | DEPRECATED: This field will always be empty. Use seismic search by partition instead. |
| seismic_ids | int64 | repeated | The list of ids of seismics that belong to this partition. |
| last_modified | google.protobuf.Timestamp | | The last time this object was created or edited. |
SearchSpec
Used to identify any number of objects, intended for any plural Read endpoints. Set endpoints should use Identifier.
Can search by id, name, or prefix.
| Field | Type | Label | Description |
|---|
| id | int64 | | |
| id_string | string | | Surveys and files must have string format ids. Other objects can't use this. |
| external_id | string | | External ids only exist for partitions and seismics. Exact match required. |
| external_id_substring | string | | |
| name | string | | Names exist for everything. An exact string match is required. |
| name_substring | string | | Searches for names having this substring. |
| metadata | MetadataFilter | | Filters by metadata. Currently, only supported by Surveys. |
| geometry | com.cognite.seismic.Geometry | | Filters by intersection with a geometry. Currently, only supported by Surveys. |
SegyOverrides
Metadata related to interpreting SEG-Y files.
| Field | Type | Label | Description |
|---|
| inline_offset | google.protobuf.Int32Value | | Position of the inline number field in the trace headers. Defaults to 189 per the SEG-Y rev1 specification. |
| crossline_offset | google.protobuf.Int32Value | | Position of the crossline number field in the trace headers. Defaults to 193 per the SEG-Y rev1 specification. |
| cdp_x_offset | google.protobuf.Int32Value | | Position of the X coordinate of ensemble (CDP) in trace headers. Defaults to 181 per the SEG-Y rev1 specification. |
| cdp_y_offset | google.protobuf.Int32Value | | Position of the Y coordinate of ensemble (CDP) in trace headers. Defaults to 185 per the SEG-Y rev1 specification. |
| cdp_number_offset | google.protobuf.Int32Value | | Position of the ensemble (CDP) number in trace headers. Defaults to 21 per the SEG-Y rev1 specification. |
| energy_source_point_offset | google.protobuf.Int32Value | | Position of the energy source point in trace headers. Defaults to 17 per the SEG-Y rev1 specification. |
| shotpoint_offset | google.protobuf.Int32Value | | Position of the shotpoint field in trace headers. Defaults to 197 per the SEG-Y rev1 specification. |
| cdp_trace_offset | google.protobuf.Int32Value | | Position of the trace number within ensemble. Defaults to 21 per the SEG-Y rev1 specification. |
| offset_header_offset | google.protobuf.Int32Value | | Position of the "offset" field in the trace header. Defaults to 37 per the SEG-Y rev1 specification. |
| source_group_scalar_override | google.protobuf.FloatValue | | [optional] Multiplier for CDP-X and CDP-Y values that overrides scalar factor obtained from trace header. Note that this is a floating point multiplier used directly to scale CDP-X and CDP-Y values, and it's not interpreted in the manner of the source group scalar trace header field in the SEG-Y specification. That is: To divide by 100, specify 0.01, not -100. Negative values and values greater than 1 aren't 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 processing of a file will then use the source group scalar values found in trace headers. |
Seismic
A cut-out of a seismic store.
| Field | Type | Label | Description |
|---|
| id | int64 | | The unique internal id of the seismic. it's always present. |
| external_id | string | | The external id of the seismic. |
| name | string | | A non-unique name for the seismic. It's editable and intended to be used as a human-friendly reference. |
| crs | string | | The Coordinate Reference System of the seismic. |
| metadata | Seismic.MetadataEntry | repeated | Any custom-defined metadata. |
| text_header | TextHeader | | The text header that corresponds to the seismic. |
| binary_header | BinaryHeader | | The binary header that corresponds to the seismic. |
| line_range | LineRange | | The minimum and maximum extents of the seismic's grid, described in inlines and crosslines. |
| volume_def | VolumeDef | | The VolumeDef describing the seismic. |
| cutout | SeismicCutout | | The cutout the seismic object was created with. |
| extent | SeismicExtent | | A description of the traces contained in the seismic. |
| partition_id | int64 | | The id of the partition the seismic belongs to. |
| seismicstore_id | int64 | | The id of the seismic store the seismic is derived from. It's present only if agent has READ access and ALL scope. |
| coverage | com.cognite.seismic.Geometry | | The coverage geometry for the seismic. |
| created_empty | bool | | If true, this seismic was created empty (deprecated). |
| trace_count | int64 | | Provides an estimate of the number of traces contained within the seismic. |
| trace_header_fields | TraceHeaderField | repeated | The 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. |
| dimensions | Dimensions | | The underlying file's data dimensionality, either 2D or 3D. This will always match the dimensionality for the underlying seismic store. |
| last_modified | google.protobuf.Timestamp | | The last time this object was created or edited. |
Seismic.MetadataEntry
Seismic2dExtent
Seismic2dRange
Seismic3dDef
Seismic3dDef.LinesEntry
Seismic3dExtent
Seismic3dRect
Seismic3dRects
SeismicCutout
| Field | Type | Label | Description |
|---|
| two_dee_extent | Seismic2dExtent | | Indicates that the seismic was requested with this 2D extent. |
| three_dee_extent | Seismic3dExtent | | Indicates that the seismic was requested with this 3D extent (or an equivalent VolumeDef). |
| geometry | com.cognite.seismic.Geometry | | Indicates that the seismic was requested with this geometry. |
| empty | bool | | Indicates that the seismic was created empty. |
| full | bool | | Indicates that the seismic was created to cover the entire seismic store. |
SeismicExtent
SeismicStore
Represents a seismic store.
| Field | Type | Label | Description |
|---|
| id | int64 | | The unique internal id of the seismic store. |
| name | string | | The unique name of the seismic store. Will become non-unique in the future, and external_id will become the unique identifier. |
| survey_id | string | | The survey this seismic store belongs to, in the old UUID format. |
| survey_id_int | int64 | | The survey this seismic store belongs to. |
| ingestion_source | com.cognite.seismic.IngestionSource | | The source of the seismic store. It indicates how the file was ingested. |
| metadata | SeismicStore.MetadataEntry | repeated | Any custom-defined metadata. |
| ingested_file | com.cognite.seismic.File | | Same as ingested_source_file. This field is deprecated and will be removed in the future. |
| ingested_source_file | SourceSegyFile | | If present, the file this SeismicStore was ingested from. |
| inline_volume_def | VolumeDef | | Volume definition for the store, indexed on inlines. Maps from an inline to all its valid crosslines. |
| crossline_volume_def | VolumeDef | | Volume definition for the store, indexed on crosslines. Maps from a crossline to all its valid inlines. |
| extent | SeismicExtent | | Description of the traces contained in the seismicstore. |
| text_header | TextHeader | | If present, the text header for this seismic store. |
| binary_header | BinaryHeader | | If present, the binary header for this seismic store. |
| storage_tier_name | string | repeated | Tenant specific name for the storage facility the trace data are stored in. If empty, it's stored in an unspecified trace store. While support for many storage backends per store is planned, this isn't currently offered. |
| coverage | com.cognite.seismic.Geometry | | If present, the coverage geometry for this seismic store. |
| trace_header_fields | TraceHeaderField | repeated | The trace header fields that have been registered as keys for indexing. |
| dimensions | Dimensions | | The underlying file's data dimensionality, either 2D or 3D. |
| crs | string | | The coordinate reference system used by this seismic store. |
| last_modified | google.protobuf.Timestamp | | The last time this object was created or edited. |
SeismicStore.MetadataEntry
SourceSegyFile
File or dataset or cube derived from a single SEG-Y file.
SourceSegyFile.MetadataEntry
Survey
Representation of the data for a survey
| Field | Type | Label | Description |
|---|
| id | string | | Unique identifier for the survey in CDF. The identifier is generated by CDF on creation and not editable. |
| id_int | int64 | | The integer unique ID for the survey. This ID should be used for V1 survey operations. |
| name | string | | Survey 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. Survey name. |
| metadata | Survey.MetadataEntry | repeated | Metadata describing the survey with named fields and values. |
| external_id | com.cognite.seismic.ExternalId | | External 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. |
| crs | string | | Coordinate reference system to be used by all members of this survey. |
| grid_transformation | com.cognite.seismic.SurveyGridTransformation | | Manually specify an 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_coverage | com.cognite.seismic.CustomSurveyCoverage | | User-provided coverage override. |
| last_modified | google.protobuf.Timestamp | | The last time this object was created or edited. |
Survey.MetadataEntry
A representation of text headers used to create or edit existing headers.
| Field | Type | Label | Description |
|---|
| file_id | string | | DEPRECATED: This field will always be empty. |
| header | string | | The text content of the header. |
| raw_header | string | | The raw bytes of a header as a string. |
TraceExtent
VolumeDef
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.
| Field | Type | Label | Description |
|---|
| json | string | | Uses the Volume Definition schema. |
| Name | Number | Description |
|---|
| WKT | 0 | |
| GEOJSON | 1 | |
Dimensions
| Name | Number | Description |
|---|
| UNSPECIFIED_DIMENSION | 0 | |
| TWO_DEE | 2 | |
| THREE_DEE | 3 | |
SurveyCoverageSource
| Name | Number | Description |
|---|
| UNSPECIFIED_SURVEY_COVERAGE_SOURCE | 0 | Used as the default when a specific source isn't requested by the user. |
| CUSTOM | 1 | Requesting or returning custom coverage. |
| CALCULATED | 2 | Requesting or returning calculated coverage. |
| Name | Number | Description |
|---|
| UNSPECIFIED_TRACE_HEADER_FIELD | 0 | |
| ENERGY_SOURCE_POINT | 1 | |
| CDP | 2 | |
| INLINE | 3 | |
| CROSSLINE | 4 | |
| SHOTPOINT | 5 | |
| CDP_TRACE | 6 | Bytes 25-28 of standard trace header: trace number within ensemble. |
| OFFSET | 7 | 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
| Field | Type | Label | Description |
|---|
| crs | string | | |
Coordinate
Basic type representing (x,y) coordinate in the given CRS.
| Field | Type | Label | Description |
|---|
| crs | string | | The Coordinate Reference System of the coordinate. Generally should be an EPSG code including the EPSG: prefix, for example, EPSG:23031. |
| x | float | | The x value of the coordinate. |
| y | float | | The y value of the coordinate. |
CoverageParameters
Parameters for requesting coverage of survey.
| Field | Type | Label | Description |
|---|
| crs | CRS | | [optional] If CRS provided converts coverage to given CRS. Otherwise, will return in the survey's original CRS. |
| in_wkt | bool | | Set this to true to return in WKT format. Otherwise, response will be in geojson format by default. |
CustomSurveyCoverage
Customer-provided custom coverage for surveys.
| Field | Type | Label | Description |
|---|
| custom_coverage | Geometry | | Overrides survey coverage with the provided custom coverage geometry. |
| no_custom_coverage | CustomSurveyCoverage.NoCustomCoverage | | Specifies that no custom coverage is provided, so survey coverage is computed from the seismicstores 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.
| Field | Type | Label | Description |
|---|
| iline | int32 | | The inline number. Within a 3D survey, a inline represents a seismic line parallel to the direction in which the data was adquired. |
| xline | int32 | | The xline number. Within a 3D survey, a xline represents a seismic line perpendicular to the direction in which the data was adquired. |
| x | float | | The x value of the coordinate. |
| y | float | | The y value of the coordinate. |
ExternalId
| Field | Type | Label | Description |
|---|
| external_id | string | | |
File
File, dataset, or cube derived from a single SEG-Y file.
File.MetadataEntry
GeoJSON
The GeoJSON format (RFC 7946).
Supported geometry: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, and GeometryCollection.
Example:
{
"type": "Point",
"coordinates": [100.0, 0.0]
}
Geometry
Geometry can be specified using either wkt or geoJSON. CRS is always required.
Identifier
Specify either id or name to find a file or survey.
LineBasedRectangle
Range of inline and crossline indices defining a 2D region.
LineDescriptor
LineRange
Object to store the line range. From and to are optional.
LineSelect
Specify either inline OR crossline.
| Field | Type | Label | Description |
|---|
| iline | int32 | | The inline number. Within a 3D survey, an inline represents a seismic line parallel to the direction in which the data was adquired. |
| xline | int32 | | The xline number. Within a 3D survey, an xline represents a seismic line perpendicular to the direction in which the data was adquired. |
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
| Field | Type | Label | Description |
|---|
| handedness | Handedness | | |
| origin | DoubleTraceCoordinates | | A point in the grid. |
| iline_bin_width | float | | The bin width along the inline axis. |
| xline_bin_width | float | | The bin width along the crossline axis. |
| xline_azimuth | float | | Map bearing of the crossline axis in clockwise degrees from north. |
| iline_bin_inc | int32 | | Inline increment corresponding to a bin. |
| xline_bin_inc | int32 | | Crossline increment corresponding to a bin. |
PositionQuery
Point defined by its inline and crossline indices.
| Field | Type | Label | Description |
|---|
| iline | int32 | | The inline number. Within a 3D survey, a inline represents a seismic line parallel to the direction in which the data was adquired. |
| xline | int32 | | The xline number. Within a 3D survey, a xline represents a seismic line perpendicular to the direction in which the data was adquired. |
Project
SlabTrace
Wrapper over Trace type that additionally provide information about the range of z values
included in the trace.
SurfacePoint
Basic type to represent a point in a surface defined by a horizontal grid.
Used in horizontal slice queries.
| Field | Type | Label | Description |
|---|
| iline | int32 | | The inline number. Within a 3D survey, an inline represents a seismic line parallel to the direction in which the data was adquired. |
| xline | int32 | | The xline number. Within a 3D survey, an xline represents a seismic line perpendicular to the direction in which the data was adquired. |
| value | float | | |
Survey
A survey represents a collection of files in the same area.
Survey.MetadataEntry
Specify the affine transformation between line indices and coordinates.
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 isn't valid for traces that are synthetically generated from interpolation.
TraceCorners
Specify the transformation by giving the coordinates of three or more corners.
Wkt
Well-known text representation of geometry (WKT)
| Field | Type | Label | Description |
|---|
| geometry | string | | |
FileStep
| Name | Number | Description |
|---|
| REGISTER | 0 | |
| INSERT_FILE_HEADERS | 1 | |
| INSERT_TRACE_HEADERS | 2 | |
| INSERT_DATA | 3 | |
| COMPUTE_COVERAGE | 4 | |
| COMPUTE_GRID | 5 | |
| COMPUTE_TRACE_INDICES | 6 | |
| DELETING | 254 | |
| DELETE | 255 | |
Handedness
| Name | Number | Description |
|---|
| RIGHTHANDED | 0 | Inline axis is 90 deg clockwise from crossline AKA EPSG code 9666. |
| LEFTHANDED | 1 | Inline axis is 90 deg counterclockwise from crossline AKA EPSG code 1049. |
IngestionSource
| Name | Number | Description |
|---|
| INVALID_SOURCE | 0 | |
| FILE_SOURCE | 1 | |
| TRACE_WRITER | 2 | TraceWriter |
InterpolationMethod
| Name | Number | Description |
|---|
| NEAREST_TRACE | 0 | |
| INVERSE_DISTANCE_WEIGHTING | 1 | |
JobStatus
| Name | Number | Description |
|---|
| NONE | 0 | |
| QUEUED | 1 | |
| IN_PROGRESS | 2 | |
| SUCCESS | 3 | |
| FAILED | 4 | |
| TIMEOUT | 5 | |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|
| double | | double | double | float | float64 | double | float | Float |
| float | | float | float | float | float32 | float | float | Float |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |