Protocol Documentation
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 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 capability to the CDF tenant. |
SearchSurveys | SearchSurveysRequest | SearchSurveyResponse stream | Lists 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. |
EditSurvey | EditSurveyRequest | Survey | Modifies 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. |
DeleteSurvey | DeleteSurveyRequest | DeleteSurveyResponse | Deletes a specified survey. Must have Seismic scope and Write capability. |
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. 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. |
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. 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. |
IngestSourceSegyFile | IngestSourceSegyFileRequest | IngestSourceSegyFileResponse | Requests queueing of a registered file for ingestion. |
CreateSeismic | CreateSeismicRequest | Seismic | Creates 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. |
SearchSeismics | SearchSeismicsRequest | Seismic stream | Returns metadata for a Seismic object. Can optionally retrieve seismic store & partition info if user has appropriate scope and capability. |
EditSeismic | EditSeismicRequest | Seismic | Edits 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. |
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 or metadata of a seismic store object. |
DeleteSeismicStore | DeleteSeismicStoreRequest | DeleteSeismicStoreResponse | Deletes a seismic store. If any seismic objects 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 | Return 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 | Fetches 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. |
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 once all files matching the search criteria have been returned. |
SearchJobStatus | SearchJobStatusRequest | JobStatusResponse stream | Retrieves ingestion job statuses, filtered by the specified criteria. |
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] A short description for the partition. | |
external_id | string | [required] The unique external identifier for the partition. |
CreateSeismicRequest
Field | Type | Label | Description |
---|---|---|---|
name | string | [optional] A short description for the seismic | |
external_id | string | [required] An externally correlatable unique identifier for the seismic | |
partition | Identifier | [required] The owning partition | |
seismic_store_id | int64 | ||
volume_def | VolumeDef | Deprecated**: Defines the volume as VolumeDef format. Use two_dee_extent or three_dee_extent . | |
geometry | com.cognite.seismic.Geometry | Defines the volume as WKT or GeoJson | |
empty | bool | Will create a seismic with an empty cutout if true | |
two_dee_extent | Seismic2dExtent | Defines the volume as an extent. Only valid if the seismic is 2D | |
three_dee_extent | Seismic3dExtent | Defines the volume as an extent. Only valid if the seismic is 3D | |
metadata | OptionalMap | [optional] Metadata to associate with the seismic. | |
text_header | TextHeader | [optional] A custom text header for the seismic. | |
binary_header | BinaryHeader | [optional] A custom binary header for the seismic. | |
copy_metadata | bool | If true, copy the metadata from the source seismic store. | |
trace_group_extent | SeismicTraceGroupExtent | Valid if the seismic is 2D or 3D |
CreateSurveyRequest
Field | Type | Label | Description |
---|---|---|---|
name | string | [required] Short descriptive name | |
metadata | CreateSurveyRequest.MetadataEntry | repeated | [required] Key-value pairs of metadata for the survey. |
external_id | com.cognite.seismic.ExternalId | [required] Identifier for correlation with systems outside CDF | |
crs | string | [required] CRS used by all members of the survey | |
grid_transformation | com.cognite.seismic.SurveyGridTransformation | [optional] Specifies a grid transformation to use, overriding the defaults. | |
custom_coverage | com.cognite.seismic.CustomSurveyCoverage | [optional] Specifies a coverage to serve as the survey coverage, overriding calculated coverage. |
CreateSurveyRequest.MetadataEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
DeletePartitionRequest
Field | Type | Label | Description |
---|---|---|---|
partition | Identifier | [required] The partition to delete. |
DeletePartitionResponse
Field | Type | Label | Description |
---|---|---|---|
success | bool |
DeleteSeismicRequest
Field | Type | Label | Description |
---|---|---|---|
seismic | Identifier |
DeleteSeismicResponse
Field | Type | Label | Description |
---|---|---|---|
succeeded | bool |
DeleteSeismicStoreRequest
Field | Type | Label | Description |
---|---|---|---|
seismic_store | Identifier | [required] The seismic store to delete. |
DeleteSeismicStoreResponse
Field | Type | Label | Description |
---|---|---|---|
succeeded | bool |
DeleteSurveyRequest
Field | Type | Label | Description |
---|---|---|---|
survey | Identifier | The survey to delete. |
DeleteSurveyResponse
Field | Type | Label | Description |
---|---|---|---|
success | bool |
EditPartitionRequest
Field | Type | Label | Description |
---|---|---|---|
partition | Identifier | [required] The unique identifier for the partition to be edited. | |
new_name | string | [required] The new name. |
EditSeismicRequest
Field | Type | Label | Description |
---|---|---|---|
seismic | Identifier | ||
name | google.protobuf.StringValue | ||
metadata | OptionalMap | ||
text_header | TextHeader | Replaces the existing text header, if specified | |
binary_header | BinaryHeader | Replaces the existing binary header, if specified |
EditSeismicStoreRequest
Field | Type | Label | Description |
---|---|---|---|
seismic_store_id | int64 | Deprecated**. Use identifier instead. | |
name | google.protobuf.StringValue | [optional] The new seismic store name. | |
metadata | OptionalMap | [optional] The new seismic store metadata. If set, this will replace the existing metadata. | |
seismic_store | Identifier | [required] The seismic store to edit. | |
external_id | google.protobuf.StringValue | [optional] The new external id. Will fail if the new external id is not unique. |
EditSourceSegyFileRequest
Field | Type | Label | Description |
---|---|---|---|
file | Identifier | [required] The registered source file to edit | |
path | google.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_id | com.cognite.seismic.ExternalId | [optional] An external identifier - matches service contract field | |
metadata | EditSourceSegyFileRequest.MetadataEntry | repeated | [optional] Any custom-defined metadata |
crs | com.cognite.seismic.CRS | [optional] 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 | [optional] File data dimensionality, either 2D or 3D | |
seismic_data_type | SeismicDataType | [required] The type of seismic data contained in this file. E.g., pre-stack vs. post-stack |
EditSourceSegyFileRequest.MetadataEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
EditSourceSegyFileResponse
Field | Type | Label | Description |
---|---|---|---|
file | SourceSegyFile | The result of the edit. |
EditSurveyRequest
Field | Type | Label | Description |
---|---|---|---|
survey | Identifier | ||
metadata | OptionalMap | [optional] The metadata to replace the existing metadata with. | |
external_id | com.cognite.seismic.ExternalId | [optional] The new external id. | |
crs | com.cognite.seismic.CRS | [optional] The new CRS for all members of the survey. | |
grid_transformation | com.cognite.seismic.SurveyGridTransformation | [optional] The new custom grid transformation. | |
custom_coverage | com.cognite.seismic.CustomSurveyCoverage | [optional] The new custom coverage. | |
new_name | google.protobuf.StringValue | [optional] The new name of the survey. |
GeometryBasedVolume
Field | Type | Label | Description |
---|---|---|---|
geometry | com.cognite.seismic.Geometry | [required] The geometry of the volume. | |
interpolation_method | com.cognite.seismic.InterpolationMethod | [optional] If the geometry describes a line, must be specified. | |
z_range | com.cognite.seismic.LineDescriptor | [optional] The z-ranges to fetch. Defaults to the entire z-range. |
IngestSourceSegyFileRequest
Field | Type | Label | Description |
---|---|---|---|
file | Identifier | [required] The file to queue for ingestion | |
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 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
Field | Type | Label | Description |
---|---|---|---|
job_id | string |
IngestionLog
Field | Type | Label | Description |
---|---|---|---|
timestamp | google.protobuf.Timestamp | The time this log was recorded. | |
log_line | string | The contents of the log. |
InspectIngestionRequest
Field | Type | Label | Description |
---|---|---|---|
seismic_store_id | int64 | Specifies a seismic store by id. | |
file_id | int64 | Specifies a seismic store by source segy file id. | |
job_id | string | Specifies a seismic store by job id. |
InspectIngestionResponse
Field | Type | Label | Description |
---|---|---|---|
seismic_store | SeismicStore | The fetched seismic store. |
JobStatusResponse
Field | Type | Label | Description |
---|---|---|---|
job_id | string | The job id for this status. | |
file_uuid | string | The uuid of the file that this job is associated with. | |
status | com.cognite.seismic.JobStatus | The status of the job. | |
started_at | google.protobuf.Timestamp | When the job was started. | |
updated_at | google.protobuf.Timestamp | When the job was last updated. | |
target_storage_tier_name | google.protobuf.StringValue | The target storage tier of the job. | |
logs | IngestionLog | repeated | Logs recorded by the job. |
file_id | int64 | The id of the file that this job is associated with. |
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 | |
seismic_data_type | SeismicDataType | [required] The type of seismic data contained in this file. E.g., pre-stack vs. post-stack |
RegisterSourceSegyFileRequest.MetadataEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
RegisterSourceSegyFileResponse
Field | Type | Label | Description |
---|---|---|---|
file | SourceSegyFile |
SearchFilesRequest
Used to search files by a given file/seismic-store/survey search specification
Field | Type | Label | Description |
---|---|---|---|
spec | SearchSpec | Finds files by id, name or external id. | |
seismic_store | SearchSpec | Finds files that are the source of the seismic stores specified by id, name, or external id. | |
survey | SearchSpec | Finds files that are included in the surveys specified by id, name, or external id. | |
last_modified | LastModifiedFilter | Finds files by their last modified time. |
SearchJobStatusRequest
Field | Type | Label | Description |
---|---|---|---|
job_id | string | The id of the job. | |
file_uuid | string | The uuid of the file that a job is associated with. | |
file_id | int64 | The id of the file that a job is associated with. | |
status | com.cognite.seismic.JobStatus | [optional] If specified, only returns jobs with the given status. | |
target_storage_tier_name | google.protobuf.StringValue | [optional] If specified, only returns jobs with the given target storage tier. | |
started_before | google.protobuf.Timestamp | [optional] If specified, only returns jobs that started before the timestamp. | |
started_after | google.protobuf.Timestamp | [optional] If specified, only returns jobs that started after the timestamp. | |
updated_before | google.protobuf.Timestamp | [optional] If specified, only returns jobs that were last updated before the timestamp. | |
updated_after | google.protobuf.Timestamp | [optional] If specified, only returns jobs that were last updated after the timestamp. |
SearchPartitionsRequest
Field | Type | Label | Description |
---|---|---|---|
partitions | SearchSpec | Searches for partitions by id, name, or external id. | |
last_modified | LastModifiedFilter | Searches for partitions by last modified time. |
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 | [optional] Whether to include File information in the response. Defaults to false. | |
include_volume_definitions | bool | Deprecated**: Whether to include inline/crossline volume definitions in the response. Use include_extent instead. Defaults to false. | |
include_extent | bool | [optional] Whether to include a description of the traces contained in the seismicstore. Defaults to false. | |
extent_key | TraceHeaderField | [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_headers | bool | [optional] Whether to include text and binary headers in the response. Defaults to false. | |
include_coverage | bool | Deprecated**. Use coverage instead. | |
coverage | CoverageSpec | [optional] If specified, includes coverage in the specified format and CRS. |
SearchSeismicsRequest
Field | Type | Label | Description |
---|---|---|---|
survey | SearchSpec | Searches for seismics which are included in the specified surveys. | |
seismic | SearchSpec | Searches for seismics by their id, name or external id. | |
partition | SearchSpec | Searches for seismics which are included in the specified partitions. Can only search on partitions you can see. | |
seismic_store | SearchSpec | Searches for seismics by their seismic store. Requires ALL scope. | |
last_modified | LastModifiedFilter | Searches for seismics by last modified | |
include_text_header | bool | [optional] Whether to include the text header. Defaults to false. | |
include_binary_header | bool | [optional] Whether to include the binary header. Defaults to false. | |
include_line_range | bool | [optional] Whether to include the line range. Defaults to false. | |
include_volume_definition | bool | Deprecated**. Whether to include the volume definition. Use include_extent instead. Defaults to false. | |
include_cutout | bool | [optional] Whether to include the cutout specification the seismic was created with. Defaults to false. | |
include_extent | bool | [optional] Whether to include a description of the included traces. Defaults to false. | |
extent_key | TraceHeaderField | [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_store | bool | [optional] Whether to include info on the backing seismicstore. Requires ALL scope. Defaults to false. | |
include_partition | bool | [optional] Whether to include info on the partition. Requires ALL scope. Defaults to false. | |
include_coverage | bool | Deprecated**. Use coverage instead. Defaults to false. | |
coverage | CoverageSpec | [optional] If specified, includes coverage as the specified CRS and format. |
SearchSurveyResponse
Field | Type | Label | Description |
---|---|---|---|
survey | Survey | ||
seismic_ids | string | repeated | [optional] The list of ids for seismics included in the survey. |
seismic_store_ids | string | repeated | [optional] The list of ids for seismic stores included in the survey. |
coverage | com.cognite.seismic.Geometry | [optional] The coverage of the survey. | |
coverage_source | SurveyCoverageSource | [optional] The source of the fetched coverage of the survey. |
SearchSurveysRequest
Field | Type | Label | Description |
---|---|---|---|
surveys | SearchSpec | repeated | [optional] Identifier of the survey(s) to fetch. If not specified, retrieves all accessible surveys. |
list_seismic_ids | bool | [optional] Whether to list the survey's seismics in the response (default: false) | |
list_seismic_store_ids | bool | [optional] Whether to list the survey's seismic stores in the response. Requires ALL scope. | |
include_metadata | bool | [optional] Whether to include survey metadata in the response (default: false) | |
include_coverage | com.cognite.seismic.CoverageParameters | Deprecated**. Use coverage instead. | |
coverage | CoverageSpec | [optional] If set, includes coverage in the responses in the specified format and CRS. | |
include_grid_transformation | bool | [optional] Whether to include the manually specified grid transformation in the response (default: false) | |
include_custom_coverage | bool | [optional] Whether to include the customer-provided survey coverage in the response. | |
coverage_source | SurveyCoverageSource | [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_modified | LastModifiedFilter | [optional] If set, will further filter returned objects by the last modified time. |
SegYSeismicRequest
Field | Type | Label | Description |
---|---|---|---|
seismic | Identifier | Specifies a seismic object. | |
seismic_store_id | int64 | Specifies a seismic store. Requires ALL scope. | |
polygon | com.cognite.seismic.Geometry | Traces will be contained within the polygon. | |
lines | com.cognite.seismic.LineBasedRectangle | Deprecated**. Traces will be contained within the rectangle. Only valid if the queried object is 3D. | |
two_dee_extent | Seismic2dExtent | Traces will be contained within the extent. Only valid if the queried object is 2D. | |
three_dee_extent | Seismic3dExtent | Traces will be contained within the extent. Only valid if the queried object is 3D | |
skip_message_count | int32 | [optional] Skips the first n chunks of the download. Useful for resuming aborted downloads. Defaults to 0. | |
trace_group_filter | SeismicTraceGroupExtent | [optional] Select which traces to return within each ensemble. Only valid if the queried object is pre-stack. |
SegYSeismicResponse
Field | Type | Label | Description |
---|---|---|---|
content | bytes | Some bytes of the resulting Seg-Y file. |
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 Seismicstore to stream traces from. Requires ALL scope. | |
two_dee_extent | Seismic2dExtent | Filters traces by 2D header ranges. Only valid if the queried object is 2D. | |
three_dee_extent | Seismic3dExtent | Filters traces by 3D header ranges. Only valid if the queried object is 3D. | |
geometry | GeometryFilter | Filters 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_range | com.cognite.seismic.LineDescriptor | [optional] Which depth indices to return as part of the traces. Defaults to the entire depth. | |
include_trace_header | bool | [optional] Whether to include the binary trace header in the streamed traces. Defaults to false. | |
trace_group_filter | SeismicTraceGroupExtent | [optional] Which traces to return within each ensemble. Only valid if the queried object is pre-stack. |
TraceBounds
Field | Type | Label | Description |
---|---|---|---|
trace_size_bytes | int32 | The size in bytes of one Trace message | |
num_traces | int32 | The number of traces to be 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 | |
cdp_trace_bounds | com.cognite.seismic.LineDescriptor | Null for post-stack data |
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 to be 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
Deprecated**.
Field | Type | Label | Description |
---|---|---|---|
seismic | Identifier | The unique identifier for a seismic object. | |
seismic_store_id | int64 | The unique ID for a seismic store. Requires ALL scope. | |
volume | LineBasedVolume | Retrieves traces by lines. | |
geometry | GeometryBasedVolume | Retrieves traces within a geometry. | |
include_trace_header | bool | [optional] Whether to include trace headers. Defaults to false. |
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.
Field | Type | Label | Description |
---|---|---|---|
file_id | string | Deprecated**: This field will always be empty | |
traces | int32 | ||
trace_data_type | int32 | ||
fixed_length_traces | int32 | ||
segy_revision | int32 | ||
auxtraces | int32 | ||
interval | int32 | ||
interval_original | int32 | ||
samples | int32 | ||
samples_original | int32 | ||
ensemble_fold | int32 | ||
vertical_sum | int32 | ||
trace_type_sorting_code | int32 | ||
sweep_type_code | int32 | ||
sweep_frequency_start | int32 | ||
sweep_frequency_end | int32 | ||
sweep_length | int32 | ||
sweep_channel | int32 | ||
sweep_taper_start | int32 | ||
sweep_taper_end | int32 | ||
sweep_taper_type | int32 | ||
correlated_traces | int32 | ||
amplitude_recovery | int32 | ||
original_measurement_system | int32 | ||
impulse_signal_polarity | int32 | ||
vibratory_polarity_code | int32 | ||
raw_header | bytes |
Coordinate
Describes a coordinate pair in some coordinate system.
Field | Type | Label | Description |
---|---|---|---|
x | float | The x value of the coordinate | |
y | float | The y value of the coordinate |
CoverageSpec
Specifies how to return a coverage.
Field | Type | Label | Description |
---|---|---|---|
crs | string | [optional] Which CRS to return the coverage in. Defaults to the native CRS of the object. | |
format | CoverageSpec.Format | [optional] Which format to return the coverage as. Defaults to WKT. |
Filter
Specify an individual filter.
Field | Type | Label | Description |
---|---|---|---|
key_value_exact_match | KeyValueExactMatch | Match on an exact key-value pair. Both the key and the value must exactly match. |
GeometryFilter
Field | Type | Label | Description |
---|---|---|---|
geometry | com.cognite.seismic.Geometry | ||
interpolation_method | com.cognite.seismic.InterpolationMethod | Only used for linear geometries in 3D |
Identifier
Used to identify zero or one objects by a unique id.
Field | Type | Label | Description |
---|---|---|---|
id | int64 | Identifies an object by internal id. | |
external_id | string | Identifies an object by external id. |
KeyValueExactMatch
A key-value pair exact match filter
Field | Type | Label | Description |
---|---|---|---|
key | string | The key to match on. | |
value | string |
LastModifiedFilter
The last modified timestamp range to search by. Returned objects will satisfy all specified arguments.
Field | Type | Label | Description |
---|---|---|---|
before | google.protobuf.Timestamp | [optional] All returned objects will have a last_modified before this timestamp. | |
after | google.protobuf.Timestamp | [optional] All returned objects will have a last_modified after this timestamp. |
LineBasedExtent
Field | Type | Label | Description |
---|---|---|---|
extents | TraceExtent | repeated |
LineBasedVolume
Describes a volume by line ranges.
Field | Type | Label | Description |
---|---|---|---|
iline | com.cognite.seismic.LineDescriptor | [optional] The inline range. Defaults to the entire inline range, depending on context. | |
xline | com.cognite.seismic.LineDescriptor | [optional] The crossline range. Defaults to the entire crossline range, depending on context. | |
z | com.cognite.seismic.LineDescriptor | [optional] The depth range. Defaults to the entire depth range, depending on context. |
LineRange
Describe a line range.
Field | Type | Label | Description |
---|---|---|---|
inline | com.cognite.seismic.LineDescriptor | [optional] The inline range. Defaults to the entire inline range, depending on context. | |
crossline | com.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.
Field | Type | Label | Description |
---|---|---|---|
filters | Filter | repeated | The list of metadata filters. |
MinorLines
A set of points, described as one or more line descriptors.
Field | Type | Label | Description |
---|---|---|---|
ranges | com.cognite.seismic.LineDescriptor | repeated |
OptionalMap
Used in edit messages to distinguish between an empty map and a missing map.
Field | Type | Label | Description |
---|---|---|---|
data | OptionalMap.DataEntry | repeated | The contents of the map. |
OptionalMap.DataEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
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 | A short description of this partition | |
seismics | Seismic | repeated | Deprecated**: This field will always be empty. Use seismic search by partition instead. |
seismic_ids | int64 | repeated | If specified, 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 plural Read or Search-type endpoints.
Can search by id, name, or prefix.
Field | Type | Label | Description |
---|---|---|---|
id | int64 | Searches by integer id. | |
id_string | string | Searches surveys and files by string-format uuid. This is not a valid way to search other objects. | |
external_id | string | Searches seismics and seismic stores by an exact match of external id. | |
external_id_substring | string | Searches seismics and seismic stores by a substring match of external id. | |
name | string | Searchs any object by an exact match of name. | |
name_substring | string | Searches any object by a substring match of name. | |
metadata | MetadataFilter | Searches surveys by metadata. | |
geometry | com.cognite.seismic.Geometry | Searches surveys by intersection with geometry. |
SegyOverrides
Metadata related to interpreting SEG-Y files.
Field | Type | Label | Description |
---|---|---|---|
inline_offset | google.protobuf.Int32Value | [optional] Position of the inline number field in the trace headers. Defaults to 189 as per the SEG-Y rev1 specification | |
crossline_offset | google.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_offset | google.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_offset | google.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_offset | google.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_offset | google.protobuf.Int32Value | [optional] Position of the energy source point in trace headers. Defaults to 17 as per the SEG-Y rev1 specification | |
shotpoint_offset | google.protobuf.Int32Value | [optional] Position of the shotpoint field in trace headers. Defaults to 197 as per the SEG-Y rev1 specification | |
cdp_trace_offset | google.protobuf.Int32Value | [optional] Position of the trace number within ensemble. Defaults to 21 as per the SEG-Y rev1 specification. | |
offset_header_offset | google.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_override | google.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
Field | Type | Label | Description |
---|---|---|---|
id | int64 | The unique internal id of the seismic. It is always present. | |
external_id | string | The external id of the seismic | |
name | string | A non-unique name for the seismic. It is easily editable and is 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 | Deprecated**: Use the GetTraceBounds API call instead. | |
volume_def | VolumeDef | Deprecated**: The VolumeDef describing the seismic. Use extents instead. | |
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 seismicstore the seismic is derived from. It is present only if you have READ access and ALL scope. | |
coverage | com.cognite.seismic.Geometry | The coverage geometry for the seismic. | |
created_empty | bool | Deprecated**. Whether this seismic was created empty. Use the cutout field instead. | |
trace_count | int64 | 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_data_type | SeismicDataType | Whether this seismic object contains pre-stack or post-stack data. |