correlation_graph

`CorrelationGraph`

Bases: Graph

Create a graph with delays instead of DelataLAT for weights

`correlations` `property`

`delay_cv_max = None` `instance-attribute`

`delay_cv_min = None` `instance-attribute`

`delay_selection = CvDelaySelection` `instance-attribute`

`delay_selections = {'cvdelayselection': CvDelaySelection, 'mindelayselection': MinDelaySelection}` `instance-attribute`

`delays` `property`

`filters = copy.deepcopy(Graph.filters)` `class-attribute` `instance-attribute`

`max_correlation = None` `instance-attribute`

`min_correlation = None` `instance-attribute`

`min_peak_distance = None` `instance-attribute`

`sampling_frequency = None` `instance-attribute`

`init(points, scalars, indices=None)`

`reset_propeties()`

`set_correlation_range(min_correlation, max_correlation)`

`set_delay_cv_max(delay_cv_max)`

`set_delay_cv_min(delay_cv_min)`

`set_delay_cv_range(delay_cv_min, delay_cv_max)`

`set_delay_selection(selection)`

Sets the delay selection parameter. A delay selector selects a single delay and correlation value for each edge based on the value of said delay.

Parameters:

Name	Type	Description	Default
`selection`	`Type[DelaySelector] \| DelaySelector \| str`	a selector class	required

Returns:

Type	Description
`Self`	self

`set_max_correlation(max_correlation)`

`set_min_correlation(min_correlation)`

`set_min_peak_distance(min_peak_distance)`

`set_sampling_frequency(sampling_frequency)`

`CvDelaySelection`

Bases: MinDelaySelection

Class for choosing delay between pairs of signals.

`select(graph)` `staticmethod`

Apply filter that selects one delay value for each signal pair.

Parameters:

Name	Type	Description	Default
`graph`	`Graph`	Dgm graph object with full_delays and full_correlations attributes.	required

Returns: np.ndarray[N,]: Array of the selected delays. np.ndarray[N,]: Array of the selected coorelation values.

`DelaySelection`

Bases: ABC

`select(graph)` `abstractmethod` `staticmethod`

`MinDelaySelection`

Bases: DelaySelection

Class for choosing delay between pairs of signals.

`select(graph)` `staticmethod`

Apply filter that selects one delay value for each signal pair.

Parameters:

Name	Type	Description	Default
`graph`	`Graph`	Dgm graph object with full_delays and full_correlations attributes.	required

Returns: np.ndarray[N,]: Array of the selected delays. np.ndarray[N,]: Array of the selected correlation values.

correlation_graph