flowsom.models.FlowSOMEstimator

class flowsom.models.FlowSOMEstimator(cluster_model=<class 'flowsom.models.som_estimator.SOMEstimator'>, metacluster_model=<class 'flowsom.models.consensus_cluster.ConsensusCluster'>, **kwargs)

A class that implements the FlowSOM model.

Attributes table

cluster_labels	Return the cluster labels.
codes	(n_clusters, n_features).
distances	Return the distances.
metacluster_labels	Return the metacluster labels.

Methods table

fit(X[, y])	Fit the model.
fit_predict(X)	Fit the model and predict the clusters.
get_metadata_routing()	Get metadata routing of this object.
get_params([deep])	Get parameters for this estimator.
predict(X)	Predict the clusters.
set_n_clusters(n_clusters)	Set the number of clusters.
set_params(**params)	Set the parameters of this estimator.
subset(indices)	Subset the model.

Attributes

FlowSOMEstimator.cluster_labels

Return the cluster labels.

FlowSOMEstimator.codes

(n_clusters, n_features).

Type:

Return the codes, shaped

FlowSOMEstimator.distances

Return the distances.

FlowSOMEstimator.metacluster_labels

Return the metacluster labels.

Methods

FlowSOMEstimator.fit(X, y=None)

Fit the model.

FlowSOMEstimator.fit_predict(X)

Fit the model and predict the clusters.

FlowSOMEstimator.get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:

-routing (MetadataRequest) A MetadataRequest encapsulating routing information.

FlowSOMEstimator.get_params(deep=True)

Get parameters for this estimator.

Parameters:

deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

-params (dict) Parameter names mapped to their values.

FlowSOMEstimator.predict(X)

Predict the clusters.

FlowSOMEstimator.set_n_clusters(n_clusters)

Set the number of clusters.

FlowSOMEstimator.set_params(**params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**params (dict) – Estimator parameters.

Returns:

self : estimator instance Estimator instance.

FlowSOMEstimator.subset(indices)

Subset the model.