flitsr.advanced.cluster.Cluster

class flitsr.advanced.cluster.Cluster

Bases: ABC

A Cluster technique takes a Spectrum and returns a collection of spectra that are decompositions of the original

__init__()

Methods

__init__()

cluster(inp_file, spectrum[, method_lvl])

Provides the clustering functionality of this Cluster technique.
abstractmethod cluster(inp_file: str, spectrum: Spectrum, method_lvl=False) → List[Spectrum]

Provides the clustering functionality of this Cluster technique. A Cluster takes a Spectrum spectrum and returns a collection of spectra which are decompositions of the input spectrum.

Parameters:

  • inp_file – str: The input file for the input spectrum

  • spectrum – Spectrum: The input spectrum

  • method_lvl – (Default value = False) Whether the input spectrum refers to a method level spectrum

Returns:

A collection of spectra which are decompositions of the input spectrum.