class xpipeline.cluster.cluster.XCluster(data=None, index=None, columns=None, dtype=None, copy=False)[source]

Bases: pandas.core.frame.DataFrame

Initiate an XCluster class

This class is designed to take the output from clusterproperties.clusterproperities_wrapper and provide wrapper methods for calculating a variety of statistics for the cluster of pixels

Returns:

XCluster

classmethod nearest_neighbor(cluster_array, labelled_map, **kwargs)[source]
supercluster(self, statistic_column='energy_of_cluster')[source]