queso_cluster.addon.products

file:

queso_cluster/addon/products.py

lang:

python

synopsis:

author:

Sarah Riley <academic@sriley.dev>

Classes

Products

Detail

Module Contents

class Products(quesoOut)

Detail

Parameters:

quesoOut (timeIndependent or timeDependent) – Analysis object that stores all of the configuration

clusterMapCompound(compoundLabels, timeAxis=False)

Creates a figure showing all of the distinct sequences of spectra

Parameters:

• compoundLabels (char.array) – Character array for all sequence labels

• timeAxis (bool) – Boolean to add an extra axis for time

Returns:

fig – Figure showing the distribution of cluster sequences

Return type:

mpl.Figure

clusterMapSequence(timeAxis=False)

Parameters:

timeAxis (bool, optional) – Boolean to add an extra axis for time

Returns:

• figA (mpl.Figure) – Map of the cluster results for individual time steps

• figB (mpl.Figure) – Map of all distinct sequences

clusterMapSequenceHorizontal(timeAxis)

Horizontal oriented maps of the cluster results for individual time steps

Parameters:

• compoundLabels (char.array)

• timeAxis (bool) – Boolean to add an extra axis for time

Returns:

• fig (mpl.figure) – Map of the cluster results for individual time steps

• compoundLabels (np.char.array) – Character array for all sequence labels

clusterMapSequenceVertical(timeAxis)

Vertically oriented maps of the cluster results for individual time steps

Parameters:

• compoundLabels (char.array)

• timeAxis (bool) – Boolean to add an extra axis for time

Returns:

• fig (mpl.figure) – Map of the cluster results for individual time steps

• compoundLabels (np.char.array) – Character array for all sequence labels

clusterProfiles(dev=False, showContinuum=True)

Figure showing the representative profiles of each of the clusters and the raw data histogram

Parameters:

• showContinuum (bool, optional) – Adds a horizontal line at the continuum. Useful only if normalized to continuum

• dev (bool) – secret testing

Returns:

fig – Figure

Return type:

mpl.figure

clusterProfilesCompound(compoundLabels)

intensityMapSequence(timeAxis=False, **kwargs)

intensityMapSequenceHorizontal(timeAxis, **kwargs)

Horizontal oriented maps of the cluster results for individual time steps

Parameters:

• compoundLabels (char.array)

• timeAxis (bool) – Boolean to add an extra axis for time

Returns:

• fig (mpl.figure) – Map of the cluster results for individual time steps

• compoundLabels (np.char.array) – Character array for all sequence labels

intensityMapSequenceVertical(timeAxis, **kwargs)

Vertical oriented maps of the cluster results for individual time steps

Parameters:

• compoundLabels (char.array)

• timeAxis (bool) – Boolean to add an extra axis for time

Returns:

• fig (mpl.figure) – Map of the cluster results for individual time steps

• compoundLabels (np.char.array) – Character array for all sequence labels

load()

spectralEntry(ax, indx, showContinuum, scores=None, dev=False, neighbor=None)

Calculation function for clusterProfiles()

Parameters:

• ax (mpl.Axes) – matplotlib axes to add content to

• indx (ndarray) – 1D array of data indexes for a given cluster

• color (str) – color string for 2D histogram of raw data. gradient goes as white -> color

• wavelambda (ndarray) – 1D array containing the wavelength

• extent (list) – List containing the left, right, bottom, top of the content

• showContinuum (bool) – Adds a horizontal line at the continuum. Useful only if normalized to continuum

• scores (float, optional) – Validation score to be shown in the figure window

• dev (bool, optional) – secret testing

Returns:

ax – Updated axis with all the content added

Return type:

mpl.Axes

aspect

clusterCmap

mapMake

vfindx

vindx