kappa_sdk.DocumentVector#

class kappa_sdk.DocumentVector(dates, values, name, measure, is_derivative, is_model, is_by_step=False, vector_id=None, first_x=None)[source]#

KW document vector object.

Container of the document data that, in addition to the Vector, stores the name and the dimension of the data.

Note

Should not be instantiated directly.

Attributes

DocumentVector.data_measure

KW Measure associated with this DocumentVector.

DocumentVector.data_name

Name of this DocumentVector.

DocumentVector.dates

List of X (date) values in this vector.

DocumentVector.elapsed_times

List of X (date) values as elapsed time (in hours), counted from the first date in this vector.

DocumentVector.first_x

Gets the first_x/ start time of the elapsed times

DocumentVector.id

Gets the vector id.

DocumentVector.is_by_step

A value indicating whether this DocumentVector is a step data or not.

DocumentVector.is_derivative

A value indicating whether this DocumentVector is a derivative data or not.

DocumentVector.is_model

A value indicating whether this DocumentVector is a model data or not.

DocumentVector.values

List of Y (data) values in this vector.

Methods

DocumentVector.set_elapsed_times(elapsed_times)

Sets the elapsed times.

DocumentVector.set_first_x(first_x)

Sets the first_x and invalidates cached elapsed times.
Parameters:

  • dates (List[datetime])

  • values (List[float])

  • name (str)

  • measure (str)

  • is_derivative (bool)

  • is_model (bool)

  • is_by_step (bool)

  • vector_id (str | None)

  • first_x (datetime | None)

__init__(dates, values, name, measure, is_derivative, is_model, is_by_step=False, vector_id=None, first_x=None)[source]#
Parameters:

  • dates (List[datetime])

  • values (List[float])

  • name (str)

  • measure (str)

  • is_derivative (bool)

  • is_model (bool)

  • is_by_step (bool)

  • vector_id (str | None)

  • first_x (datetime | None)

property data_name: str#

Name of this DocumentVector.

property data_measure: str#

KW Measure associated with this DocumentVector.

property is_derivative: bool#

A value indicating whether this DocumentVector is a derivative data or not.

property is_model: bool#

A value indicating whether this DocumentVector is a model data or not.

property is_by_step: bool#

A value indicating whether this DocumentVector is a step data or not.