canari.component.base_component

canari.component.base_component#

class canari.component.base_component.BaseComponent[source]#

Bases: ABC

BaseComponent abstract class. It defines the required attributes and methods for any other Canari’s component. Subclasses must implement all abstract methods including:

  • Initialize the component’s name

  • Initialize the component’s number of hidden states

  • Initialize hidden states’ names

  • Initialize the mean values for hidden states

  • Initialize the covariance matrix for hidden states

  • Initialize the component’s transition matrix

  • Initialize the component’s observation matrix

  • Initialize the component’s process noise matrix

property component_name#

Name of the component.

Type:

str

abstract initialize_component_name()[source]#

Initialize the component’s name. str.

abstract initialize_mu_states()[source]#

Initialize the mean of the hidden states. Output an 2D array.

abstract initialize_num_states()[source]#

Initialize the number of hidden states. int.

abstract initialize_observation_matrix()[source]#

Initialize the observation matrix. Output an 2D array.

abstract initialize_process_noise_matrix()[source]#

Initialize the process noise covariance matrix. Output an 2D array.

abstract initialize_states_name()[source]#

Initialize the names of all hidden states. list[str].

abstract initialize_transition_matrix()[source]#

Initialize the transition matrix. Output an 2D array.

abstract initialize_var_states()[source]#

Initialize the covariance matrix of the hidden states. Output an 2D array.

property mu_states#

mean values as an 2D array.

Type:

np.ndarray

property num_states#

Number of hidden states in the component.

Type:

int

property observation_matrix#

Observation matrix for the component as an 2D array.

Type:

np.ndarray

property process_noise_matrix#

Process noise covariance matrix as an 2D array.

Type:

np.ndarray

property states_name#

Names of each hidden state in the component.

Type:

list[str]

property transition_matrix#

Transition matrix for the component as an 2D array.

Type:

np.ndarray

property var_states#

covariance matrix as an 2D array.

Type:

np.ndarray

Contents