kappa_sdk.Data#

class kappa_sdk.Data(field_id, well_id, data_id, vector_id, automation_id, name, kind, data_type, is_by_step, is_reference, is_high_frequency, labels, filters, raw_data, measure_depth, true_vertical_depth, true_vertical_depth_subsea, cluster_apis, data_dto_converter)[source]#

Data object.

Presents a KAPPA Automate data object that is used to read and write the vector values.

Note

Should not be instantiated directly.

Attributes

Data.automation_id

Gets the automation_id of the Data.

Data.cumulative_vector_id

Gets the internal id of the Data's XY vector.

Data.data_type

Gets the alias of the associated data-type for this Data.

Data.datasource_name

Data.filters

Gets a list of filters of this Data.

Data.first_x

Gets a reference date, or the first X (date) in the Data's vector if a reference date is not defined.

Data.id

Gets the id of the Data object.

Data.is_by_step

Gets a value indicating whether this Data is defined as steps or points.

Data.is_high_frequency

Gets a value indicating whether this Data has high frequency data.

Data.is_reference

Gets a value indicating whether this Data is a reference data of its data-type in the well.

Data.kind

Gets the kind of the Data (gauge or basic data).

Data.labels

Gets a list of labels associated with this Data.

Data.last_x

Gets the last X (date) in the Data's vector.

Data.md

Get the measure depth property value of the Data.

Data.metadata

Get the associated metadata of this data object :returns: Metadata

Data.name

Gets the name of the Data.

Data.raw_data

Gets the associated raw data (raw filter, raw shut-in, etc.)

Data.size

Gets the size of the Data (the number of points).

Data.tvd

Get the True vertical depth property value of the Data.

Data.tvdss

Get the True vertical depth sub sea property value of the Data.

Data.vector_id

Gets the internal id of the Data's XY vector.

Methods

Data.add_labels(labels)

Adds a list of user-defined labels to the current object.

Data.append(vector[, unit])

Appends given values to the data.

Data.clean()

Removes all values of the data.

Data.get_automation_status()

Get automation status

Data.get_shutin_data_dto()

Get the shut in data dto of the object

Data.overwrite(vector)

Overwrites the content of the data with given values.

Data.read([from_time, to_time, count, last, ...])

Reads the data values as Vector.

Data.read_by_chunks(chunk_size[, from_time, ...])

Reads the data values by chunks of a given size.

Data.read_cumulative([from_time, to_time, ...])

Reads the cumulative values associated to this data object as Vector.

Data.read_cumulative_by_chunks(chunk_size[, ...])

Reads the cumulative values associated to this data by chunks of a given size.

Data.refresh_metadata()

Refresh cache to be able to grab the updated metadata

Data.reload_gauge_from_date(date)

Data.update_first_x(first_x)

Updates a value of the first X (reference date).
Parameters:

  • field_id (str)

  • well_id (str)

  • data_id (str)

  • vector_id (str)

  • automation_id (Optional[str])

  • name (str)

  • kind (DataKindEnum)

  • data_type (str)

  • is_by_step (bool)

  • is_reference (bool)

  • is_high_frequency (bool)

  • labels (List[str])

  • filters (List[Data])

  • raw_data (Optional[Data])

  • measure_depth (Optional[float])

  • true_vertical_depth (Optional[float])

  • true_vertical_depth_subsea (Optional[float])

  • cluster_apis (ClusterAPIS)

  • data_dto_converter (DataDtoConverter)

On this page