kappa_sdk.Vector#

class kappa_sdk.Vector(dates, values, first_x=None, vector_id=None)[source]#

Vector object.

Container of the data that supports:

  • Conversion of X values between the absolute and elapsed times.

  • Conversion of Y values from the internal units to the given ones.

Important

When initializing the Vector, Y values must be given in internal units. This conversion can be done with the help of the UnitConverter.

Parameters:

  • dates (List[datetime]) – List of X (date) values.

  • values (List[float]) – List of Y (data) values.

  • first_x (Optional[datetime]) – first_x of a step data

  • vector_id (Optional[str])

Attributes

Vector.dates

List of X (date) values in this Vector.

Vector.elapsed_times

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

Vector.first_x

Gets the first_x/ start time of the elapsed times of this Vector

Vector.id

Gets the Vector id.

Vector.values

List of Y (data) values in this Vector.

Methods

Vector.set_elapsed_times(elapsed_times[, ...])

Sets the elapsed times.

Vector.set_first_x(first_x)

__init__(dates, values, first_x=None, vector_id=None)[source]#
Parameters:

  • dates (List[datetime])

  • values (List[float])

  • first_x (datetime | None)

  • vector_id (str | None)

property id: str#

Gets the Vector id.

property first_x: datetime | None#

Gets the first_x/ start time of the elapsed times of this Vector

property dates: List[datetime]#

List of X (date) values in this Vector.

property elapsed_times: List[float]#

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

property values: List[float]#

List of Y (data) values in this Vector.

set_first_x(first_x)[source]#
Parameters:

first_x (datetime)

Return type:

None

set_elapsed_times(elapsed_times, reference_date=None)[source]#

Sets the elapsed times.

Sets the elapsed times and recalculates absolute times based on the provided reference date.

Parameters:

  • elapsed_times (List[float]) – List of X (date) values as elapsed time (in hours)

  • reference_date (datetime | None) – Reference date used to calculate absolute time values. Default value is datetime.now().

Return type:

None