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 the `Vector`.
`DocumentVector.first_x`	Gets the first_x/ start time of the elapsed times of this `Vector`
`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)

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)