Utils that are used by modules of pyclustering. More...
Namespaces | |
color | |
Colors used by pyclustering library for visualization. | |
graph | |
Graph representation (uses format GRPR). | |
metric | |
Module provides various distance metrics - abstraction of the notion of distance in a metric space. | |
Functions | |
def | read_sample (filename) |
Returns data sample from simple text file. More... | |
def | calculate_distance_matrix (sample) |
Calculates distance matrix for data sample (sequence of points) using Euclidean distance as a metric. More... | |
def | read_image (filename) |
Returns image as N-dimension (depends on the input image) matrix, where one element of list describes pixel. More... | |
def | rgb2gray (image_rgb_array) |
Returns image as 1-dimension (gray colored) matrix, where one element of list describes pixel. More... | |
def | stretch_pattern (image_source) |
Returns stretched content as 1-dimension (gray colored) matrix with size of input image. More... | |
def | gray_pattern_borders (image) |
Returns coordinates of gray image content on the input image. More... | |
def | average_neighbor_distance (points, num_neigh) |
Returns average distance for establish links between specified number of nearest neighbors. More... | |
def | centroid (points, indexes=None) |
Calculate centroid of input set of points. More... | |
def | median (data, indexes=None, kwargs) |
Calculate geometric median of input set of points using Euclidean distance. More... | |
def | euclidean_distance (a, b) |
Calculate Euclidean distance between vector a and b. More... | |
def | euclidean_distance_square (a, b) |
Calculate square Euclidian distance between vector a and b. More... | |
def | manhattan_distance (a, b) |
Calculate Manhattan distance between vector a and b. More... | |
def | average_inter_cluster_distance (cluster1, cluster2, data=None) |
Calculates average inter-cluster distance between two clusters. More... | |
def | average_intra_cluster_distance (cluster1, cluster2, data=None) |
Calculates average intra-cluster distance between two clusters. More... | |
def | variance_increase_distance (cluster1, cluster2, data=None) |
Calculates variance increase distance between two clusters. More... | |
def | calculate_ellipse_description (covariance, scale=2.0) |
Calculates description of ellipse using covariance matrix. More... | |
def | data_corners (data, data_filter=None) |
Finds maximum and minimum corner in each dimension of the specified data. More... | |
def | norm_vector (vector) |
Calculates norm of an input vector that is known as a vector length. More... | |
def | unit_vector (vector) |
Calculates unit vector. More... | |
def | heaviside (value) |
Calculates Heaviside function that represents step function. More... | |
def | timedcall (executable_function, args) |
Executes specified method or function with measuring of execution time. More... | |
def | extract_number_oscillations (osc_dyn, index=0, amplitude_threshold=1.0) |
Extracts number of oscillations of specified oscillator. More... | |
def | allocate_sync_ensembles (dynamic, tolerance=0.1, threshold=1.0, ignore=None) |
Allocate clusters in line with ensembles of synchronous oscillators where each synchronous ensemble corresponds to only one cluster. More... | |
def | draw_clusters (data, clusters, noise=[], marker_descr='.', hide_axes=False, axes=None, display_result=True) |
Displays clusters for data in 2D or 3D. More... | |
def | draw_dynamics (t, dyn, x_title=None, y_title=None, x_lim=None, y_lim=None, x_labels=True, y_labels=True, separate=False, axes=None) |
Draw dynamics of neurons (oscillators) in the network. More... | |
def | set_ax_param (ax, x_title=None, y_title=None, x_lim=None, y_lim=None, x_labels=True, y_labels=True, grid=True) |
Sets parameters for matplotlib ax. More... | |
def | draw_dynamics_set (dynamics, xtitle=None, ytitle=None, xlim=None, ylim=None, xlabels=False, ylabels=False) |
Draw lists of dynamics of neurons (oscillators) in the network. More... | |
def | draw_image_color_segments (source, clusters, hide_axes=True) |
Shows image segments using colored image. More... | |
def | draw_image_mask_segments (source, clusters, hide_axes=True) |
Shows image segments using black masks. More... | |
def | linear_sum (list_vector) |
Calculates linear sum of vector that is represented by list, each element can be represented by list - multidimensional elements. More... | |
def | square_sum (list_vector) |
Calculates square sum of vector that is represented by list, each element can be represented by list - multidimensional elements. More... | |
def | list_math_subtraction (a, b) |
Calculates subtraction of two lists. More... | |
def | list_math_substraction_number (a, b) |
Calculates subtraction between list and number. More... | |
def | list_math_addition (a, b) |
Addition of two lists. More... | |
def | list_math_addition_number (a, b) |
Addition between list and number. More... | |
def | list_math_division_number (a, b) |
Division between list and number. More... | |
def | list_math_division (a, b) |
Division of two lists. More... | |
def | list_math_multiplication_number (a, b) |
Multiplication between list and number. More... | |
def | list_math_multiplication (a, b) |
Multiplication of two lists. More... | |
Variables | |
float | pi = 3.1415926535 |
The number is a mathematical constant, the ratio of a circle's circumference to its diameter. More... | |
Utils that are used by modules of pyclustering.
def pyclustering.utils.allocate_sync_ensembles | ( | dynamic, | |
tolerance = 0.1 , |
|||
threshold = 1.0 , |
|||
ignore = None |
|||
) |
Allocate clusters in line with ensembles of synchronous oscillators where each synchronous ensemble corresponds to only one cluster.
[in] | dynamic | (dynamic): Dynamic of each oscillator. |
[in] | tolerance | (double): Maximum error for allocation of synchronous ensemble oscillators. |
[in] | threshold | (double): Amlitude trigger when spike is taken into account. |
[in] | ignore | (bool): Set of indexes that shouldn't be taken into account. |
Definition at line 697 of file __init__.py.
Referenced by pyclustering.nnet.fsync.fsync_dynamic.allocate_sync_ensembles().
def pyclustering.utils.average_inter_cluster_distance | ( | cluster1, | |
cluster2, | |||
data = None |
|||
) |
Calculates average inter-cluster distance between two clusters.
Clusters can be represented by list of coordinates (in this case data shouldn't be specified), or by list of indexes of points from the data (represented by list of points), in this case data should be specified.
[in] | cluster1 | (list): The first cluster where each element can represent index from the data or object itself. |
[in] | cluster2 | (list): The second cluster where each element can represent index from the data or object itself. |
[in] | data | (list): If specified than elements of clusters will be used as indexes, otherwise elements of cluster will be considered as points. |
Definition at line 378 of file __init__.py.
def pyclustering.utils.average_intra_cluster_distance | ( | cluster1, | |
cluster2, | |||
data = None |
|||
) |
Calculates average intra-cluster distance between two clusters.
Clusters can be represented by list of coordinates (in this case data shouldn't be specified), or by list of indexes of points from the data (represented by list of points), in this case data should be specified.
[in] | cluster1 | (list): The first cluster. |
[in] | cluster2 | (list): The second cluster. |
[in] | data | (list): If specified than elements of clusters will be used as indexes, otherwise elements of cluster will be considered as points. |
Definition at line 409 of file __init__.py.
def pyclustering.utils.average_neighbor_distance | ( | points, | |
num_neigh | |||
) |
Returns average distance for establish links between specified number of nearest neighbors.
[in] | points | (list): Input data, list of points where each point represented by list. |
[in] | num_neigh | (uint): Number of neighbors that should be used for distance calculation. |
Definition at line 201 of file __init__.py.
def pyclustering.utils.calculate_distance_matrix | ( | sample | ) |
Calculates distance matrix for data sample (sequence of points) using Euclidean distance as a metric.
[in] | sample | (array_like): Data points that are used for distance calculation. |
Definition at line 78 of file __init__.py.
Referenced by pyclustering.utils.metric.minkowski_distance_numpy().
def pyclustering.utils.calculate_ellipse_description | ( | covariance, | |
scale = 2.0 |
|||
) |
Calculates description of ellipse using covariance matrix.
[in] | covariance | (numpy.array): Covariance matrix for which ellipse area should be calculated. |
[in] | scale | (float): Scale of the ellipse. |
Definition at line 529 of file __init__.py.
def pyclustering.utils.centroid | ( | points, | |
indexes = None |
|||
) |
Calculate centroid of input set of points.
[in] | points | (list): Set of points for centroid calculation. |
[in] | indexes | (list): Indexes of objects in input set of points that will be taken into account during centroid calculation. |
Definition at line 233 of file __init__.py.
def pyclustering.utils.data_corners | ( | data, | |
data_filter = None |
|||
) |
Finds maximum and minimum corner in each dimension of the specified data.
[in] | data | (list): List of points that should be analysed. |
[in] | data_filter | (list): List of indexes of the data that should be analysed, if it is 'None' then whole 'data' is analysed to obtain corners. |
Definition at line 553 of file __init__.py.
def pyclustering.utils.draw_clusters | ( | data, | |
clusters, | |||
noise = [] , |
|||
marker_descr = '.' , |
|||
hide_axes = False , |
|||
axes = None , |
|||
display_result = True |
|||
) |
Displays clusters for data in 2D or 3D.
[in] | data | (list): Points that are described by coordinates represented. |
[in] | clusters | (list): Clusters that are represented by lists of indexes where each index corresponds to point in data. |
[in] | noise | (list): Points that are regarded to noise. |
[in] | marker_descr | (string): Marker for displaying points. |
[in] | hide_axes | (bool): If True - axes is not displayed. |
[in] | axes | (ax) Matplotlib axes where clusters should be drawn, if it is not specified (None) then new plot will be created. |
[in] | display_result | (bool): If specified then matplotlib axes will be used for drawing and plot will not be shown. |
Definition at line 793 of file __init__.py.
Referenced by pyclustering.utils.metric.minkowski_distance_numpy().
def pyclustering.utils.draw_dynamics | ( | t, | |
dyn, | |||
x_title = None , |
|||
y_title = None , |
|||
x_lim = None , |
|||
y_lim = None , |
|||
x_labels = True , |
|||
y_labels = True , |
|||
separate = False , |
|||
axes = None |
|||
) |
Draw dynamics of neurons (oscillators) in the network.
It draws if matplotlib is not specified (None), othewise it should be performed manually.
[in] | t | (list): Values of time (used by x axis). |
[in] | dyn | (list): Values of output of oscillators (used by y axis). |
[in] | x_title | (string): Title for Y. |
[in] | y_title | (string): Title for X. |
[in] | x_lim | (double): X limit. |
[in] | y_lim | (double): Y limit. |
[in] | x_labels | (bool): If True - shows X labels. |
[in] | y_labels | (bool): If True - shows Y labels. |
[in] | separate | (list): Consists of lists of oscillators where each such list consists of oscillator indexes that will be shown on separated stage. |
[in] | axes | (ax): If specified then matplotlib axes will be used for drawing and plot will not be shown. |
Definition at line 895 of file __init__.py.
Referenced by pyclustering.utils.draw_dynamics_set(), pyclustering.utils.metric.minkowski_distance_numpy(), and pyclustering.nnet.fsync.fsync_visualizer.show_output_dynamic().
def pyclustering.utils.draw_dynamics_set | ( | dynamics, | |
xtitle = None , |
|||
ytitle = None , |
|||
xlim = None , |
|||
ylim = None , |
|||
xlabels = False , |
|||
ylabels = False |
|||
) |
Draw lists of dynamics of neurons (oscillators) in the network.
[in] | dynamics | (list): List of network outputs that are represented by values of output of oscillators (used by y axis). |
[in] | xtitle | (string): Title for Y. |
[in] | ytitle | (string): Title for X. |
[in] | xlim | (double): X limit. |
[in] | ylim | (double): Y limit. |
[in] | xlabels | (bool): If True - shows X labels. |
[in] | ylabels | (bool): If True - shows Y labels. |
Definition at line 1023 of file __init__.py.
Referenced by pyclustering.nnet.fsync.fsync_visualizer.show_output_dynamics().
def pyclustering.utils.draw_image_color_segments | ( | source, | |
clusters, | |||
hide_axes = True |
|||
) |
Shows image segments using colored image.
Each color on result image represents allocated segment. The first image is initial and other is result of segmentation.
[in] | source | (string): Path to image. |
[in] | clusters | (list): List of clusters (allocated segments of image) where each cluster consists of indexes of pixel from source image. |
[in] | hide_axes | (bool): If True then axes will not be displayed. |
Definition at line 1068 of file __init__.py.
def pyclustering.utils.draw_image_mask_segments | ( | source, | |
clusters, | |||
hide_axes = True |
|||
) |
Shows image segments using black masks.
Each black mask of allocated segment is presented on separate plot. The first image is initial and others are black masks of segments.
[in] | source | (string): Path to image. |
[in] | clusters | (list): List of clusters (allocated segments of image) where each cluster consists of indexes of pixel from source image. |
[in] | hide_axes | (bool): If True then axes will not be displayed. |
Definition at line 1120 of file __init__.py.
Referenced by pyclustering.utils.metric.minkowski_distance_numpy().
def pyclustering.utils.euclidean_distance | ( | a, | |
b | |||
) |
Calculate Euclidean distance between vector a and b.
The Euclidean between vectors (points) a and b is calculated by following formula:
Where N is a length of each vector.
[in] | a | (list): The first vector. |
[in] | b | (list): The second vector. |
Definition at line 310 of file __init__.py.
Referenced by pyclustering.utils.average_neighbor_distance(), and pyclustering.utils.calculate_distance_matrix().
def pyclustering.utils.euclidean_distance_square | ( | a, | |
b | |||
) |
Calculate square Euclidian distance between vector a and b.
[in] | a | (list): The first vector. |
[in] | b | (list): The second vector. |
Definition at line 334 of file __init__.py.
Referenced by pyclustering.utils.average_inter_cluster_distance(), pyclustering.utils.average_intra_cluster_distance(), pyclustering.utils.euclidean_distance(), and pyclustering.utils.variance_increase_distance().
def pyclustering.utils.extract_number_oscillations | ( | osc_dyn, | |
index = 0 , |
|||
amplitude_threshold = 1.0 |
|||
) |
Extracts number of oscillations of specified oscillator.
[in] | osc_dyn | (list): Dynamic of oscillators. |
[in] | index | (uint): Index of oscillator in dynamic. |
[in] | amplitude_threshold | (double): Amplitude threshold when oscillation is taken into account, for example, when oscillator amplitude is greater than threshold then oscillation is incremented. |
Definition at line 658 of file __init__.py.
Referenced by pyclustering.nnet.fsync.fsync_dynamic.extract_number_oscillations().
def pyclustering.utils.gray_pattern_borders | ( | image | ) |
Returns coordinates of gray image content on the input image.
[in] | image | (Image): PIL Image instance that is processed. |
Definition at line 159 of file __init__.py.
Referenced by pyclustering.utils.stretch_pattern().
def pyclustering.utils.heaviside | ( | value | ) |
Calculates Heaviside function that represents step function.
If input value is greater than 0 then returns 1, otherwise returns 0.
[in] | value | (double): Argument of Heaviside function. |
Definition at line 624 of file __init__.py.
def pyclustering.utils.linear_sum | ( | list_vector | ) |
Calculates linear sum of vector that is represented by list, each element can be represented by list - multidimensional elements.
[in] | list_vector | (list): Input vector. |
Definition at line 1200 of file __init__.py.
def pyclustering.utils.list_math_addition | ( | a, | |
b | |||
) |
Addition of two lists.
Each element from list 'a' is added to element from list 'b' accordingly.
[in] | a | (list): List of elements that supports mathematic addition.. |
[in] | b | (list): List of elements that supports mathematic addition.. |
Definition at line 1277 of file __init__.py.
Referenced by pyclustering.utils.centroid(), and pyclustering.utils.variance_increase_distance().
def pyclustering.utils.list_math_addition_number | ( | a, | |
b | |||
) |
Addition between list and number.
Each element from list 'a' is added to number 'b'.
[in] | a | (list): List of elements that supports mathematic addition. |
[in] | b | (double): Value that supports mathematic addition. |
Definition at line 1291 of file __init__.py.
def pyclustering.utils.list_math_division | ( | a, | |
b | |||
) |
Division of two lists.
Each element from list 'a' is divided by element from list 'b' accordingly.
[in] | a | (list): List of elements that supports mathematic division. |
[in] | b | (list): List of elements that supports mathematic division. |
Definition at line 1319 of file __init__.py.
def pyclustering.utils.list_math_division_number | ( | a, | |
b | |||
) |
Division between list and number.
Each element from list 'a' is divided by number 'b'.
[in] | a | (list): List of elements that supports mathematic division. |
[in] | b | (double): Value that supports mathematic division. |
Definition at line 1305 of file __init__.py.
Referenced by pyclustering.utils.centroid(), and pyclustering.utils.variance_increase_distance().
def pyclustering.utils.list_math_multiplication | ( | a, | |
b | |||
) |
Multiplication of two lists.
Each element from list 'a' is multiplied by element from list 'b' accordingly.
[in] | a | (list): List of elements that supports mathematic multiplication. |
[in] | b | (list): List of elements that supports mathematic multiplication. |
Definition at line 1347 of file __init__.py.
Referenced by pyclustering.utils.square_sum().
def pyclustering.utils.list_math_multiplication_number | ( | a, | |
b | |||
) |
Multiplication between list and number.
Each element from list 'a' is multiplied by number 'b'.
[in] | a | (list): List of elements that supports mathematic division. |
[in] | b | (double): Number that supports mathematic division. |
Definition at line 1333 of file __init__.py.
def pyclustering.utils.list_math_substraction_number | ( | a, | |
b | |||
) |
Calculates subtraction between list and number.
Each element from list 'a' is subtracted by number 'b'.
[in] | a | (list): List of elements that supports mathematical subtraction. |
[in] | b | (list): Value that supports mathematical subtraction. |
Definition at line 1263 of file __init__.py.
def pyclustering.utils.list_math_subtraction | ( | a, | |
b | |||
) |
Calculates subtraction of two lists.
Each element from list 'a' is subtracted by element from list 'b' accordingly.
[in] | a | (list): List of elements that supports mathematical subtraction. |
[in] | b | (list): List of elements that supports mathematical subtraction. |
Definition at line 1249 of file __init__.py.
def pyclustering.utils.manhattan_distance | ( | a, | |
b | |||
) |
Calculate Manhattan distance between vector a and b.
[in] | a | (list): The first cluster. |
[in] | b | (list): The second cluster. |
Definition at line 355 of file __init__.py.
def pyclustering.utils.median | ( | data, | |
indexes = None , |
|||
kwargs | |||
) |
Calculate geometric median of input set of points using Euclidean distance.
[in] | data | (list): Set of points for median calculation. |
[in] | indexes | (list): Indexes of objects in input set of points that will be taken into account during median calculation. |
[in] | **kwargs | Arbitrary keyword arguments (available arguments: 'metric', 'data_type'). |
Keyword Args:
Definition at line 260 of file __init__.py.
def pyclustering.utils.norm_vector | ( | vector | ) |
Calculates norm of an input vector that is known as a vector length.
[in] | vector | (list): The input vector whose length is calculated. |
Definition at line 585 of file __init__.py.
Referenced by pyclustering.utils.unit_vector().
def pyclustering.utils.read_image | ( | filename | ) |
Returns image as N-dimension (depends on the input image) matrix, where one element of list describes pixel.
[in] | filename | (string): Path to image. |
Definition at line 92 of file __init__.py.
def pyclustering.utils.read_sample | ( | filename | ) |
Returns data sample from simple text file.
This function should be used for text file with following format:
[in] | filename | (string): Path to file with data. |
Definition at line 54 of file __init__.py.
Referenced by pyclustering.utils.metric.minkowski_distance_numpy().
def pyclustering.utils.rgb2gray | ( | image_rgb_array | ) |
Returns image as 1-dimension (gray colored) matrix, where one element of list describes pixel.
Luma coding is used for transformation and that is calculated directly from gamma-compressed primary intensities as a weighted sum:
[in] | image_rgb_array | (list): Image represented by RGB list. |
Definition at line 107 of file __init__.py.
Referenced by pyclustering.utils.metric.minkowski_distance_numpy(), and pyclustering.utils.stretch_pattern().
def pyclustering.utils.set_ax_param | ( | ax, | |
x_title = None , |
|||
y_title = None , |
|||
x_lim = None , |
|||
y_lim = None , |
|||
x_labels = True , |
|||
y_labels = True , |
|||
grid = True |
|||
) |
Sets parameters for matplotlib ax.
[in] | ax | (Axes): Axes for which parameters should applied. |
[in] | x_title | (string): Title for Y. |
[in] | y_title | (string): Title for X. |
[in] | x_lim | (double): X limit. |
[in] | y_lim | (double): Y limit. |
[in] | x_labels | (bool): If True - shows X labels. |
[in] | y_labels | (bool): If True - shows Y labels. |
[in] | grid | (bool): If True - shows grid. |
Definition at line 979 of file __init__.py.
Referenced by pyclustering.utils.draw_dynamics().
def pyclustering.utils.square_sum | ( | list_vector | ) |
Calculates square sum of vector that is represented by list, each element can be represented by list - multidimensional elements.
[in] | list_vector | (list): Input vector. |
Definition at line 1227 of file __init__.py.
def pyclustering.utils.stretch_pattern | ( | image_source | ) |
Returns stretched content as 1-dimension (gray colored) matrix with size of input image.
[in] | image_source | (Image): PIL Image instance. |
Definition at line 134 of file __init__.py.
def pyclustering.utils.timedcall | ( | executable_function, | |
args | |||
) |
Executes specified method or function with measuring of execution time.
[in] | executable_function | (pointer): Pointer to function or method. |
[in] | args | (*): Arguments of called function or method. |
Definition at line 640 of file __init__.py.
def pyclustering.utils.unit_vector | ( | vector | ) |
Calculates unit vector.
Unit vector calculates of an input vector involves two steps. The first, calculate vector length. The second, divide each vector component by the obtained length.
[in] | vector | (list): The input vector that is used for unit vector calculation. |
Definition at line 604 of file __init__.py.
def pyclustering.utils.variance_increase_distance | ( | cluster1, | |
cluster2, | |||
data = None |
|||
) |
Calculates variance increase distance between two clusters.
Clusters can be represented by list of coordinates (in this case data shouldn't be specified), or by list of indexes of points from the data (represented by list of points), in this case data should be specified.
[in] | cluster1 | (list): The first cluster. |
[in] | cluster2 | (list): The second cluster. |
[in] | data | (list): If specified than elements of clusters will be used as indexes, otherwise elements of cluster will be considered as points. |
Definition at line 460 of file __init__.py.
float pyclustering.utils.pi = 3.1415926535 |
The number is a mathematical constant, the ratio of a circle's circumference to its diameter.
Definition at line 51 of file __init__.py.