Toolbar reference¶
The buttons across the top of the window, left to right.
| Button | Tooltip | What it does |
|---|---|---|
| Open data | Press and Hold Shift to open Plate Dialog | Opens the Plate dialog to load a folder of FCS files as a plate |
| Preview mode | Preview mode. Deci(/N)mates cells. | Toggle. When pressed, only a fraction of each file is loaded. Takes effect at the next open. See Preview mode |
| Save / export data | Save or export the data: a new plate, a CSV, or a single FCS file | Opens the parameter selector, then offers three destinations: Save Plate (write a new plate with the chosen and renamed parameters), Export CVS (the events as CSV) or Save As File (as FCS). A renamed parameter's $PnN and $PnS are made from its New Name (the analyte) and New Stain as For FCS standard violators says, and every $PnN is kept unique |
| History | History channel | The History window: recent data folders and recent projects |
| Erase project | Erase project | Clears the gating graph. Offers to save first, and backs up regardless |
| Load last saved protocol | Load last saved protocol | Restores the automatic project backup - the way back from an accidental erase. See The safety net |
| Check for updates | Check for updates | Asks whether a newer build is available |
| Load Project | Load Project | Opens a .ppj |
| Save Project | Save Project | Saves the current project, defaulting to the data folder's INFO folder |
| Create New Parameter | Create New Parameter | Derived parameters - ratios, sums, differences |
| Plot matrix | Plot matrix - every parameter against every other. Double-click a cell to add a node plotting that pair | A parameter-by-parameter grid of small plots of every event; Row Parameters and Column Parameters pick and order the parameters. Double-click a cell to add a chart node plotting that pair to the gating graph - a histogram on the diagonal. The new node has no input, so it plots every event |
| Big Foot | Big Foot - the spectra and detector footprint viewer | The spectra and footprint viewer |
| Spectrum Collection | Open Spectrum Collection | The spectrum collection - the reference spectra your controls have given, to look through, correct, group into virtual assays and reuse on later panels |
| Correlate | Calculate Correlation between Channels | The correlation matrix over the selected parameters |
| CD database | CD database: the cells, their CD markers and their lineage | The CD database editor |
| Help | Open the User Manual | Opens this manual in the built-in help window. Press F1 anywhere instead and it opens at the page covering whatever is under the cursor |
To the right of the buttons:
- File - the data folder currently open, with its total event count in brackets. Hover for the full path.
- Project - the project file currently loaded.
- A progress bar, shown during long operations.
The project panel toolbar¶
Along the bottom of the gating graph, left to right:
| Button | Tooltip | Creates |
|---|---|---|
| Scatter Plot | Scatter Plot | A two-parameter chart node |
| Contour | Scatter Plot | A chart node drawn as contours |
| Histogram | Histogram | A one-parameter chart node |
| Ribbon Plot | Ribbon Plot | A ribbon plot |
| Well Ribbon | Create Well vs Parameter plot. Titration erc. | A well ribbon plot |
| SSM | Spillover Spreding Matrix and Staining Index | An SSM node |
| Cell Cycle | Cell Cycle | A cell cycle node |
| Embedding | Embedding: tSNE, UMAP, autoencoder, PCA or FlowSOM of the events reaching it, applied to all events | An embedding node |
| Spectral Unmixing | Spectral Unmixing: a node that opens the Unmixer on the events reaching it | An Unmixer node, with Select Pars and Unmix: the Unmixer on the events reaching it |
| Boolean AND | Boolean AND | An AND node |
| Boolean OR | Boolean OR | An OR node |
| Boolean XOR | Boolean XOR | An XOR node |
| Boolean NOT | Boolean NOT | A NOT node |
| Phasor | Add phasor parameters from the chosen channels, and two chart nodes for them | Phasor parameters plus two chart nodes |
| Diagram Style | Diagram Style | Toggles links between Arrows and Bezier. Bezier also hides the pins |
| Gate Stats | It Is what it says | The gate statistics window |
| FlowSOM | FlowSOM: a self-organising map of the events reaching it, its metaclusters, and their statistics per well | A FlowSOM node |
| Phenotype | Phenotyping: each marker's events by level, the phenotypes they make and the cells of the CD database each could be | A phenotyping node |
| PeacoQC | PeacoQC: per-well acquisition quality, margin and doublet filters | A PeacoQC node |
At the right end:
| Button | Tooltip | Effect |
|---|---|---|
| Screenshot (camera) | Screenshot of the whole project: to the clipboard and a window to save it | The whole graph as a picture, nodes scrolled out of view included - see Taking a picture of the graph |
| Undock Project Window | Undock Project Window | Floats the project panel in its own window |
The node title bar¶
Across the top of every node:
| Part | Effect |
|---|---|
| Box at the left end | Opens the node menu |
| Caption | The node's name |
| Maximize box | Fills the panel's view with the node; click again to put it back. Every node that shows something has one - the AND, OR, XOR and NOT nodes do not |
| Red ✕ at the right end | Deletes the node, its gates and its links, without asking |
Chart node floating toolbar¶
Appears in the top-right of a chart node when the mouse is over the plot.
| Button | Tooltip | Effect |
|---|---|---|
| Fit | Switch Auto/Manual scaling | Freeze the axes, or let them follow the data |
| Quadrant | Create Quadrant Gate | Four linked quadrant gates, or automatic bands on a histogram |
| Autogate | One gate around the largest ungated population, per click | |
| Iconify | Mini/Maxi mize | Collapse the node to an icon, or restore it |
| Close | Hide This Toolbar | Dismiss the toolbar |
Heat map toolbar¶
Above the plate in the Heat Map tab.
| Button | Tooltip | Effect |
|---|---|---|
| Export | Export Heat Map as CSV file | Per-well values as CSV |
| Copy | Copy Image to Clipboard | The plate picture |
| Gate | Create Gate From Heat Map Selection | A well node from the selected wells |
| Save Layout | Save the plate layout into the data folder's INFO subfolder | Write the plate layout to INFO\Layout.pap. Open Layout beside it is not implemented in this build |
| Show Text | Print each well's value inside the well | Print the value inside each well |
| Colour bar | Click it to toggle Autoscaling ON/OFF | Stretch the colour range to the data, or use the full range |