Manual Book
Manual Book
Operating Manual
All rights reserved. No part of this manual may be reproduced, transcribed or translated in any form
or by any means electronic or otherwise, without the prior permission of Sysmex Partec GmbH.
Table of contents
1 Introduction ............................................................................................. 6
1.1 About this operating manual .................................................... 6
1.2 Typographical conventions ...................................................... 7
1.3 General conditions .................................................................... 8
1.4 CE compliance ........................................................................... 8
2 Safety ....................................................................................................... 9
2.1 Intended use............................................................................... 9
2.2 Prohibited use ............................................................................ 9
2.3 Reasonably foreseeable misuse .............................................. 9
2.4 User definition.......................................................................... 10
2.4.1 User qualification groups ........................................................... 10
2.4.2 User qualification table............................................................... 11
2.5 Environmental conditions....................................................... 11
2.6 Prohibition and warning signs on the device ....................... 12
2.7 Personal protective equipment .............................................. 12
2.8 Laser safety .............................................................................. 13
2.9 Electrical safety........................................................................ 13
2.10 Alterations to the device ......................................................... 13
3 Overview ................................................................................................ 14
3.1 Components of the device ...................................................... 17
3.2 Type plate ................................................................................. 18
3.3 Scope of delivery ..................................................................... 19
3.4 Accessories and spare parts .................................................. 21
5 Installation ............................................................................................. 23
5.1 Positioning the device............................................................. 23
5.2 Installation and uninstallation ................................................ 23
6 Operation ...............................................................................................24
6.1 Inserting the Software dongle.................................................24
6.2 Start-up procedure...................................................................24
6.2.1 Switching on the device .............................................................24
6.2.2 Logging in and logging out .........................................................25
6.2.3 Performing a Prime ....................................................................26
6.3 Performing a measurement.....................................................27
6.4 Performing an intermediate cleaning.....................................28
6.5 Shutdown procedure ...............................................................29
6.5.1 Cleaning for shutdown ...............................................................29
6.5.2 Switching off the device .............................................................29
6.6 Software operation...................................................................30
6.6.1 Preparing measurements using the Worklist .............................30
6.6.2 Analysing data and creating reports using the Playlist...............37
7 Troubleshooting....................................................................................39
7.1 Performing a de-bubble procedure ........................................39
7.2 Performing a de-clog procedure.............................................39
7.3 Sheath fluid, waste and fluids.................................................40
7.4 Calibration and Count Check Beads (low, medium, high) ...41
7.5 Measurements and data acquisition ......................................41
8 Cleaning .................................................................................................42
8.1 Cleaning the device .................................................................42
8.2 Performing a cleaning procedure...........................................43
9 Maintenance ..........................................................................................44
10 Disposal .................................................................................................45
Index..................................................................................................... 195
1 Introduction
Type of hazard
This will result in death or have a serious impact on health.
Information about avoiding the hazard.
Type of hazard
This could result in death or have a serious impact on health.
Information about avoiding the hazard.
Type of hazard
This may have a minor impact on health.
Information about avoiding the hazard.
Type of hazard
This could result in material damage.
Information about avoiding the hazard.
All warnings are structured according to the same model. The type of hazard
is stated after the signal word. Then the consequences that may result from
the hazardous situation are described. And finally, how the hazardous
situation can be avoided.
1.4 CE compliance
The device is marked with a CE mark of conformity, which confirms the
compliance with the essential requirements of the following European
Directives:
2014/35/EC on electrical equipment designed for use within certain
voltage limits;
2014/30/EC on electromagnetic compatibility;
2011/65/EC on the restriction of the use of certain hazardous substances
in electrical and electronic equipment.
1.5
2 Safety
Instructed personnel
Instructed personnel have to be trained by qualified personnel or personnel
authorised by Sysmex to operate the device within the scope of the intended
use. They have to be able to assess if the device can be safely used and are
proficient in handling hazardous substances.
Qualified personnel
Qualified personnel have in-depth knowledge of the device and the
applications. They have been trained by personnel authorised by Sysmex to
operate the device, to perform cleaning and certain maintenance operations.
Qualified personnel have a scientific or technical education and several
years of experience in flow cytometry and are proficient in handling
hazardous substances.
Laser radiation
Electrical hazards
Beware of electrical currents and electrical shocks
The main electrical source used must be grounded or earthed due to local
specifications.
Please place the device in such a way that the electrical power cord can
easily be unplugged. Removable power cords should not be replaced by
inadequate wiring.
Beware of possible voltage when changing the fuse (T 4.0 A 250 V).
2.11
3 Overview
Your CyFlow® Cube device is a fully equipped desktop Flow Cytometer
(FCM). Which features a modular optical concept. This allows different
lasers with different wavelength ranges be used as light sources and the
detection of up to 8 optical channels (parameters).
The device allows the optics to be optimised for any application simply by
exchanging optical filters and mirrors. The device runs with an internal PC.
Data acquisition, device control, and data analysis are controlled and
performed by the software.
1 2 3 4 5 6
15 7
14 8
13 12 11 10 9
1
2
5
1
2
4
Control elements
The device is operated via keyboard and mouse. The On switch is located
on the top, when the display of the device is lifted up. The power switch is
located on the rear side of the device.
The following signs are part of the type plate which has been affixed to the device.
Symbol Meaning
Manufacturer
Certification mark
Reference Number
Serial Number
Manufacturing date
Operating manual
Caution
4 3
1 Blue cap with electrodes, cabling and tubing for sheath including inline
filter;
1 Red cap with electrodes, cabling and tubing for waste.
The scope of operation includes:
1 CyFlow® Cube device;
1 Power cord;
1 Software dongle;
1 Operating manual;
1 Keyboard and 1 mouse;
1 Laboratory bottle, 1 liter, labeled with sheath;
1 Laboratory bottle, 1 liter, labeled with waste;
1 Blue cap with electrodes, cabling and tubing for sheath;
1 Red cap with electrodes, cabling and tubing for waste.
3.5
In order to transport the device to a different location all external data and
supply connections have to be disconnected.
The device should be carried in an upright position.
The device is supplied in packaging that protects it against damage and
contamination. Please retain the packaging. Place the device in the
packaging for transport and storage.
The storage environment must be dry, clean and dust-free:
Storage temperature: between 5 °C and 50 °C;
Relative humidity: between 20 % and 85 %, non-condensing.
4.1
5 Installation
Heavy weight
When moving the device (packed or unpacked) or removing it from its
packaging, a person is exposed to a high risk of damaging his or her body
due to the heavy weight of the device.
At least two persons are required for transport and installation.
Carefully select the place where to position and operate the device. Comply
with the following criteria when positioning the device:
Place the device on a solid, dry and clean horizontal surface.
Avoid smoke, dust, vibrations, direct sunlight and any source of direct
heat.
Leave a minimum distance of 15 cm between the back of the device and
a wall to keep the ventilation effective.
Do not block the ventilation grid at the back of the device.
Do not place any objects on the device.
5.3
6 Operation
Due to heavy use of software-related content in the following chapter please
also refer to chapter 12 Software description on page 50.
Result
The software will check automatically in regular intervals if the dongle is
plugged in. If the dongle is not plugged in, the software will not be
functional.
Before switching on the device make sure the sheath fluid bottle is filled with
800 ml of clean, filtered and degassed sheath fluid and is closed with the
blue screw cap. It is recommended to replace the sheath fluid at least once a
week or before any daily use.
Requirements
The sheath fluid bottle is filled and connected to the device.
The waste bottle is empty and connected to the device.
Procedure
1. Switch on the device using the power switch on the rear side of the
device.
2. Lift up the display of the device.
3. Push the On switch on the top of the device.
– The device is switched on.
Each user is assigned to a user role. Each user role has specific privileges.
Some functions of the software are not available for each user role and
availability depends on the assigned privileges.
User management
Role Privileges
Service operator User administration
Worklist creation
Worklist management
Sample analysis
Manage Workspace and settings
Create comp setup
User administrator User administration
Parameter properties
Assay developer Manage Workspace and settings
Worklist creation
Worklist management
Sample analysis
Create comp setup
Logging in
Requirements
The log-in dialogue is displayed.
User access must be set up and the user name and password must be
known to log into the software.
Procedure
1. Enter the user name.
2. Enter the password.
3. Click the Log-in button.
– The log-in dialogue closes.
– The user role dialogue will be displayed.
Logging out
Procedure
1. On the File tab of the Ribbon (see chapter 12.4.1 File tab on page 58)
click the Log-out button.
– The current user is logged out.
– The log-in dialogue is displayed.
A Prime mode is available as a start-up process for the device. This process
includes cleaning, filling the tubes with sheath fluid and controlling the device
set-up.
The Prime should be performed in the following cases:
Starting the device for the first time of the day,
After the sheath fluid bottle has been filled,
As a trouble-shooting procedure (no/bad signals, blocking, etc.).
Requirements
Sample tube with 1.6 ml Decontamination Solution (Order No.
04-4010_R) connected.
Procedure
1. On the Cytometer tab of the Ribbon (see chapter 12.4.10 Cytometer tab
on page 105) or on the Acquire pane (see chapter 12.5.4 Acquire pane
on page 140) click the Prime button.
– The instruction dialogue for the Prime procedure is displayed.
2. Follow the instructions until the finish message is displayed.
– The device is ready for the sample measurements.
3. Remove emptied sample tube.
26 CyFlow® Cube 8 | Operating Manual | May 2018 | Revision 032
6 Operation
Procedure
1. Fill the sample tube with the sample fluid.
2. Insert the sample tube into the sample port of the device until the sample
tube audibly clicks.
3. On the Acquire pane (see chapter 12.5.4 Acquire pane on page 140)
click the Start button.
– Data acquisition starts. Progress is displayed in the status bar.
4. If a stop condition is set, wait until acquisition stops.
If no stop condition is set, click the Stop button on the Acquire pane to
stop acquisition.
– A measurement is performed.
5. Remove emptied sample tube.
Requirements
Log-in as a user with the respective role.
The respective Worklist is loaded.
Sample tube with 1.6 ml Cleaning Solution (Order No. 04-4009_R)
connected.
Procedure
1. On the Cytometer tab of the Ribbon (see chapter 12.4.10 Cytometer tab
on page 105) click the Clean button.
– An instruction dialogue is displayed.
2. Follow the instructions until the finish message is displayed.
– An intermediate cleaning was performed.
– The device is ready for the next sample measurement.
Requirements
No acquisition is in progress.
Sample tube with 1.6 ml Decontamination Solution (Order No.
04-4010_R) connected.
Procedure
1. On the File tab of the Ribbon (see chapter 12.4.1 File tab on page 58)
click the Exit CyFlow Software button.
– If the Worklist or Playlist is currently open and has been modified, a
save changes dialogue appears.
– A dialogue asking for a shutdown cleaning procedure appears.
2. Select Yes in the dialogue.
– The dialogue closes and initiates the shutdown cleaning procedure.
– After the cleaning procedure is complete the software closes.
3. Remove emptied sample tube.
Requirements
The shutdown cleaning procedure was successful and the software is
closed.
Procedure
1. In the Windows menu, click the Shut down button.
– The device shuts down.
2. Switch off the device using the power switch on the rear side of the
device.
– The device is switched off.
Requirements
To create a Worklist for future measurements, login as an assay
developer is necessary.
Procedure
1. On the File tab of the Ribbon (see chapter 12.4.1 File tab on page 58)
select "File > New > New Worklist".
In Worklist mode, a new Worklist can also be created by clicking the New
button in the Worklist pane (see chapter 12.6 Worklist pane on
page 146).
– A new default Worklist containing 400 blank Worklist items is created
and displayed in the Worklist pane.
– The software is in Worklist mode.
Procedure
1. Double-click a Worklist item to open it in the Workspace.
2. In the Worklist, enter a Lab # and sample ID for the Worklist item as
desired.
3. Define which plots to be displayed in the Plots area of the Workspace:
On the Home tab of the Ribbon (see chapter 12.4.2 Home tab on
page 65), click the Density Plot button or the Histogram Plot button to
add a corresponding plot to the Workspace.
Alternatively, select the desired plots by double-clicking on the plots in
the Previews area of the Workspace.
4. To change the parameter for an axis of a plot, right-click on the axis and
select the parameter from the drop-down list.
Alternatively, select the parameter from the Parameters group of the
Home tab of the Ribbon (see chapter Parameters group on page 66).
5. To change the scaling of the axes, select a plot, then select the scaling
(linear or logarithmic) on the Parameters group of the Home tab.
6. To change the plot title, double-click the current plot title and enter a new
title.
– A new Workspace is defined.
Procedure
1. Select the Settings pane (see chapter 12.5.3 Settings pane on
page 139).
2. To select a parameter as trigger parameter, set a parameter to "ON" in
the "Logic" column (only available if all other parameters are set to
"OFF").
Data of this parameter are acquired.
If desired, combine other parameters for trigger by setting them to "AND"
or "OR".
3. To predefine threshold values, enter a value in the "Threshold" column
for the relevant parameters.
4. To predefine the signal intensity to be displayed for each parameter,
enter a value in the "Voltage" column for the relevant parameters.
5. Select the Acquire pane (see chapter 12.5.4 Acquire pane on page 140).
6. Select the flow rate for the measurement by clicking the Low, Medium or
High button or by using the flow rate slider.
– The selected flow rate is displayed next to the flow rate slider.
– The instrument settings are preset.
Requirements
The device is primed.
A Worklist item is active with a defined Workspace.
Procedure
1. Insert the sample tube containing the sample into the sample port of the
device until the sample tube audibly clicks.
2. On the Acquire pane (see chapter 12.5.4 Acquire pane on page 140)
click the Start button.
To refresh the view, click the Restart button on the Acquire pane.
– Data acquisition starts. Progress is displayed in the status bar.
– In the Plots tab of the Workspace (see chapter 12.8.1 Plots tab of the
Workspace on page 160) the plots display the acquired data.
Procedure
1. Select the Settings pane (see chapter 12.5.3 Settings pane on
page 139).
2. In the "Voltage" column, adapt the voltage until the desired cell
populations are displayed in the proper range in the plots and can be
clearly separated.
When measuring an unstained control, edit the values for all
fluorescence parameters until the auto-fluorescence signals display
within the first/between the first and second decade of log scale.
3. In the "Threshold" column, adapt the threshold values to reduce
background for each parameter triggered. Increase or decrease the
threshold settings if the background is still too high or if the cell
population of interest is cut off.
– The instrument settings are adapted.
– The plots will automatically refresh according to the new instrument
settings.
Creating a region
To select the events of interest, regions can be created on the plots.
Procedure
1. Select the Home tab of the Ribbon (see chapter 12.4.2 Home tab on
page 65).
2. To preselect creating an elliptical region, a rectangular region, a
polygonal region, a linear region or a quadrant region, click the
corresponding button on the Region group (see chapter 12.4.2 Home tab
on page 65).
– The button is highlighted in orange.
3. For elliptical, rectangular or linear regions (on single-parameter plots),
draw out the region on the plot.
For a polygonal region, click on a plot to determine the first point of the
region, then click to define additional points. Complete the polygon by
clicking on the start point or by right-clicking.
For a quadrant region, click on the plot at the point you wish the
quadrant’s intercept point to appear.
4. To assign a name to the region, select the region and double-click the
region name on the plot. Enter a region name in the edit field or select a
name from the drop-down list.
Alternatively, select the region, select the Region Format tab of the
Ribbon (see chapter 12.4.15 Region Format tab on page 128) and use
the "Region Name" box to enter a name or to select a name from the
drop-down list.
– A region is created.
Procedure
1. In the Plots area of the Workspace, select the desired plot.
To select several plots, hold the Ctrl key while selecting or draw a
selection rectangle.
2. On the Home tab of the Ribbon (see chapter 12.4.2 Home tab on
page 65) click the arrow on the "Gate" box to expand a drop-down list
and select the desired region to be applied as a parent gate.
– A parent gate will be automatically created for the selected region.
– The parent gate will be applied to the selected plots, indicated by a
gate-coloured frame around the plots.
Procedure
1. On the Acquire pane (see chapter 12.5.4 Acquire pane on page 140)
click the Stop button.
– The measurement is stopped.
After finishing a measurement a dialogue box will appear. Press OK button
to proceed with an intermediate cleaning step. Please note that the
remaining sample will be aspirated during the cleaning step. Alternatively,
remove sample tube and press OK button. The cleaning step will be
performed with air. To skip the intermediate cleaning step press Cancel
button. The device is ready for the next sample measurement.
Procedure
1. On the Compensation tab of the Ribbon (see chapter 12.4.6
Compensation tab on page 84) click the Manual Compensation button
and the Plot Compensation button.
2. On the plot, draw the desired population of events into the required area
of the plot.
If using a quadrant, statistics are displayed on the Compensation tab of
the Ribbon and can be used to arrange the population. Negative events
are displayed in the lower left quadrant. A population negative for a
parameter on Y scale should be placed in the lower right quadrant to the
same height as the negative events. A population negative for a
parameter on X scale should be placed in the upper left quadrant to the
same range as the negative events.
For fine adjustment of compensation, use the arrow buttons on the
Compensation tab of the Ribbon. The direction of the arrow icons
indicates the way the plot populations move rather than the way the
compensation values change.
– A manual compensation is performed.
Procedure
1. To save the Workspace of a Worklist item, select the File tab of the
Ribbon (see chapter 12.4.1 File tab on page 58) and select "File > Save
> Save Workspace" or "File > Save > Save Workspace As".
Alternatively, right-click the Worklist item in the Worklist to open the
context menu and select "Workspace > Save Workspace (As)".
– The Workspace is saved.
2. To save the instrument settings of a Worklist item, right-click the Worklist
item in the Worklist to open the context menu and select "Instrument
Settings > Save Instrument Settings".
– The instrument settings are saved.
Procedure
1. In the Worklist, enter a Lab # and sample IDs for the Worklist items as
desired.
2. To apply the Workspace developed from the sample to all Worklist items,
right-click the Worklist item to open the context menu and select
"Workspace > Apply To".
– A dialogue appears.
3. Select whether to apply the Workspace to the current panel or to the
entire Worklist.
4. If differing instrument settings are to be used, click into the "Instrument
Settings" cell of the Worklist item, select "Load from file" and select the
desired instrument settings file.
5. To apply the differing instrument settings to other Worklist items,
right-click the "Instrument Settings" cell to open the context menu and
select "Apply to Panel".
6. To define differing stop conditions for the remaining samples, select the
desired stop conditions from the Stops pane (see chapter 12.5.6 Stops
pane on page 144).
Or right-click the "Stop Conditions" and "Stop Value" columns in the
Worklist to open the context menu and select the desired stop conditions.
– The Worklist for remaining samples is defined.
Procedure
1. To save the Worklist, select the File tab of the Ribbon (see chapter
12.4.1 File tab on page 58) and select "File > Save > Save Worklist" or
"Save Worklist As".
– The Worklist is saved.
Data can be analysed offline by using a Playlist (see chapter 12.7 Playlist
pane on page 154).
All data created for analyses, including plots, statistics, compensation
matrices and overlays, can be summarised in a page-based report that can
be printed.
Procedure
1. To create a new Playlist, select the File tab of the Ribbon (see chapter
12.4.1 File tab on page 58) and select "File > New > New Playlist".
In Worklist mode, a new Playlist can also be created by clicking the New
button in the Worklist pane (see chapter 12.6 Worklist pane on
page 146).
Alternatively, drag and drop a Playlist file from the Windows Explorer into
the Workspace or the Playlist pane.
– A new blank Playlist is opened and displayed in the Playlist pane (see
chapter 12.7 Playlist pane on page 154).
– The software is in Playlist mode.
2. To open a Playlist item in the Playlist, select the File tab of the Ribbon
and select "File > Open > Open Listmode".
Alternatively, click the Open Listmode button on the Quick Access
Toolbar, or click the Open Listmode button on the Home tab of the
Ribbon (see chapter 12.4.2 Home tab on page 65), or drag and drop an
FCS file from the Windows Explorer into the Playlist, or press Ctrl + O.
3. Plots, regions and gates can be edited in the Plots tab of the Workspace
as desired (see chapter 12.8.1 Plots tab of the Workspace on page 160).
4. Statistics can be displayed and edited in the Results tab of the
Workspace (see chapter 12.8.2 Results tab of the Workspace on
page 171).
5. In Playlist mode, for setting compensations, the Compensation Wizard
from the Compensation tab of the Ribbon can be used (see chapter
12.4.6 Compensation tab on page 84).
6. To save the compensation, select the File tab of the Ribbon and select
"File > Save > Save Compensation As".
7. For comparing plots to each other, overlay plots can be created manually
(see chapter 12.8.3 Overlays tab of the Workspace on page 174).
In Playlist mode, the Overlay Wizard on the Overlay tab of the Ribbon
can be used (see chapter 12.4.11 Overlay tab on page 109).
– The data are analysed.
Creating a report
A report can be created manually in the Reports tab of the Workspace (see
chapter 12.8.4 Reports tab of the Workspace on page 179). Alternatively, in
Playlist mode, the Report Wizard from the Report tab of the Ribbon can be
used (see chapter 12.4.12 Report tab on page 114). When using the Report
Wizard, first select the page orientation, page size and header and footer
information (steps 1 to 4 in the following procedure).
Procedure
1. Select the Reports tab of the Workspace.
– A blank report page is displayed.
– The Ribbon switches to its Report tab.
2. From the Page Setup group on the Report tab of the Ribbon (see chapter
Pages group on page 119), select the desired page orientation (portrait
or landscape) and page size (A4 or letter).
3. From the Insert group on the Report tab of the Ribbon (see chapter
Insert group on page 120select the items to be shown in the report.
4. Click on the desired section of the report page (header, body, footer) to
insert the selected item in a default size or draw an insertion rectangle to
get a custom size.
If using the Report Wizard, select the items to be shown in the header
and footer sections of all pages of the report here before starting the
Wizard.
5. Use the options provided in the Report tab of the Ribbon to insert and
organise pages, to edit text and other items and to arrange items.
– A report is created.
6.7
7 Troubleshooting
If no data are displayed in the plots or histograms after acquisition process,
air bubbles or contaminations may have blocked the flow cuvette.
To solve this problem perform a de-bubble or de-clog procedure.
Procedure
1. On the Cytometer tab of the Ribbon, click the De-bubble button.
– An instruction dialogue is displayed.
2. Follow the instructions until the finish message is displayed.
– After successful de-bubble process the device is ready for the sample
measurements.
– If the de-bubble process was not successful, please contact your local
Sysmex representative.
Procedure
1. On the Cytometer tab of the Ribbon, click the De-clog button.
– An instruction dialogue is displayed.
2. Follow the instructions until the finish message is displayed.
– After a successful de-clog process the device is ready for the sample
measurements.
– If the de-clog process was not successful, please contact your local
Sysmex representative.
7.6
8 Cleaning
Requirements
Log-in as a user with the respective role.
Procedure
1. On the Cytometer tab of the Ribbon, click the Clean button.
– An instruction dialogue is displayed.
2. Follow the instructions until the finish message is displayed.
– The device is ready for the sample measurements.
8.3
9 Maintenance
Servicing is to be performed by an authorised service engineer. Please
contact your local Sysmex representative for further instructions.
9.1
10 Disposal
Service life of the device is limited by aging of mechanical components.
Regular cleaning, maintenance and service ensure high-quality function and
prevent any premature end-of-life.
The device was developed and manufactured with high-quality materials and
components which can be recycled.
10.1
11 Technical data
Heavy weight
When moving the device (packed or unpacked) or removing it from its
packaging, a person is exposed to a high risk of damaging his or her body
due to the heavy weight of the device.
At least two persons are required for transport and installation.
Hardware data
Dimensions Width: 500 mm
Depth: 470 mm
Height: 370 mm (670 mm with open display)
Weight 40 kg
Maximum sound <70 dBA
Power 100 to 240 V AC
50/60 Hz
200 VA
Fuse T 4.0 A 250 V
Overvoltage 2/II
category
EMC class Class A
Degree of protection IP 20
Hardware data
Operating Temperature:
environment Operation: 15 °C to 30 °C
Transport and storage: 5 °C to 50 °C
Relative humidity:
Operation: 20 % to 85 %, non-condensing
Transport and storage: 20 % to 85 %,
non-condensing
Room:
Clean environment. Direct sun light should be
avoided
Operation specifications
Setup time Max. 5 minutes
Parameters detected Up to 8 optical parameters: FSC, SSC, FL1, FL2,
FL3, FL4, FL5, FL6
Particle size range 0.1 μm to 100 μm
Maximum data 15000 events/second
Data acquisition Max. 15000 events/second
Acquisition stop Event-based or volume-based
condition
Trigger On all parameters, on multiple parameters or on
single trigger parameter, selectable in software
Data resolution 16 bit
Application specifications
Application Immunophenotyping, DNA analysis, apoptosis,
microbiology, industrial applications, 3 to 6 colour
analysis.
True Volumetric Absolute Counts = counting per
volume
True Volumetric Based on precise counting and mechanical fluid
Absolute Counting volume measurement no need for reference sample
or beads.
Fluids
Fluid system Completely closed system for sheath fluid and
sample volumes;
no fluid droplets or aerosols generated nor released
from the device
Flow cuvette Synthetic quartz flow cuvette with small centric flow
channel (capillary diameter 350 µm x 250 µm) for
laminar sample transport with sheath fluid.
Sample delivery Computer controlled precision syringe pump for
contamination-free sample transport.
Built-in vacuum pump for waste bottle; vacuum
pressure is adjustable (computer controlled)
Sample volume Continuous up to 1200 μl
Minimal content of sample volume 850 μl
200 μl for electrode based precision absolute
counting (other counting volumes upon request)
Minimal sampling volume 10 μl
5 µl to 1000 μl for syringe-based precision absolute
counting
Flow rates Sample volume speed adjustable continuously
between 0.1 µl/s and 20 μl/s)
Sheath fluid flow continuously adjustable in expert
mode
Fluids volume 2 glass bottles (each litre) for sheath fluid and waste
Bio safety system Avoids sample droplets and sample cross
contamination (computer controlled)
11.1
12 Software description
The device is operated by means of the CyFlow® software. This chapter
describes the software functions. Performing routine tasks using the
software is described in chapter 6.6 Software operation on page 30.
12.1 Overview
Data acquisition, device control and data analysis are controlled and
performed by the integrated software.
The software can be run in two different modes:
In Worklist mode, data can be acquired. The hardware and software
settings for each measurement are predefined and organised in a list
called Worklist.
In Playlist mode, acquired data can be analysed and settings for future
measurements can be prepared. Files are organised and edited in a
Playlist.
Opening a Playlist sets the software to Playlist mode. Opening a Worklist
sets the software to Worklist mode. Only one Worklist or Playlist can be
open at a time.
When starting the device, the software is opened in Worklist mode.
1
2
5
6
1 Quick Access Toolbar 4 Worklist pane
2 Ribbon 5 Status bar
3 Workspace 6 Panes
The default view of the software window contains the following elements:
Quick Access Toolbar: The Quick Access Toolbar provides quick
access to some of the most commonly used options in the software.
Ribbon: The Ribbon provides access to the main functionality groups of
the software. The Ribbon is organised into a set of tabs.
Workspace: The Workspace contains four tabs for creating and editing
plots, results, overlays and reports.
Worklist pane: In the Worklist pane, a Worklist can be created or
opened. The Worklist then can be edited.
Status bar: The status bar displays status information. On the right, it
contains functions for resizing objects in the Workspace.
Panes: This area of the software window contains a set of panes for
editing instrument settings, for acquiring data and for displaying
information on FCS files.
If a Playlist is opened, the software changes to Playlist mode. The Worklist
pane is no longer displayed. A Playlist pane is displayed on the left-hand
side of the Workspace and nested with the other panes.
To re-expand a pane, click the desired tab. The pane is visible as long as the
cursor is over the pane.
To refix the panes in this open position so they are always visible, click the
Auto Hide button on the expanded pane.
2
3
3
3 4 3
To dock the pane to the previous position, double-click the title bar again or
click the Dock button.
The pane can be docked to other positions by using the blue relocation
arrows that are displayed while dragging the pane. To dock the pane to
bottom, top, right or left of the software window, drag the cursor onto the
corresponding relocation arrow. When the cursor is over a relocation arrow,
the position where the pane will be located on dropping is highlighted in blue.
The Worklist pane can be docked and nested with the other panes by
dragging it and placing the cursor in the centre of the relocation arrows on
the left-hand side of the software window.
The size of docked panes can be adjusted by dragging the splitter bar to the
desired position.
To get back to the default view of the software window, select the Views tab
of the Ribbon and click the Default Position button.
12.4 Ribbon
The Ribbon is the area at the top of the software window that presents an
easy-to-browse main set of commands.
The Ribbon is organised into a set of tabs which represent the main
functionality groups of the software.
The File tab contains file open, printing and export options. The File tab also
provides access to the user management and to the software options.
Recent documents
When clicking on the File tab, a list of recently used documents is displayed.
In Worklist mode, recently used Worklist files are shown. In Playlist mode,
the list comprises of recently used listmode, Workspace and Playlist files. A
maximum of 10 files can be presented in this list.
Click a file name to open the file.
New
The New menu contains the following options:
New Playlist: Click the menu item to create a new Playlist. Selecting this
option will clear the current Playlist or Worklist, and a new blank Playlist
will be displayed in the Playlist pane.
New Worklist: Click the menu item to create a new Worklist. Selecting
this option will clear the current Worklist or Playlist.
A new Worklist with 400 blank Worklist items is created.
Open
The Open menu contains the following options:
Open Worklist…: Click the menu item to open a Worklist file (XMLWL
file). Only one Worklist file can be open at a time.
Open Listmode…: This menu item is only displayed in Playlist mode.
Click the menu item to open one or more listmode files (LMD or FCS
files) and select the desired files to add them to the Playlist. The Playlist
item of the first added listmode file will be activated automatically in the
Playlist.
Open Workspace…: This menu item is only enabled if a listmode file of
a Playlist is open in the Workspace. Click the menu item to open a
Workspace file (XMLW file) and select the desired file to load it with the
currently open listmode file.
Open Playlist…: Click the menu item to open a Playlist file (XMLP file).
Only one Playlist file can be open at a time.
Open Compensation File…: This menu item is only enabled if a
compensable listmode file of a Playlist is open in the Workspace. Click
the menu item to open a compensation file (XMLC file) and select the
desired file to load it into the currently open Playlist item. If a new
compensation file is selected, this will replace the one currently loaded.
Only one compensation file can be opened at a time and compensation
is only available on high-resolution data files.
Save
In Worklist mode, the Save menu contains the following options:
Save Worklist: Click the menu item to save the current Worklist with the
current Worklist file name.
When saving a Worklist, Workspace file paths and file extensions (if
present) are removed and the Workspace files are saved within the
associated panel within the Worklist file. If there are multiple Workspace
files present within a panel with the same name, a unique identifier is
added to the Workspace file name to differentiate the Workspace files.
Save Worklist As…: Click the menu item to save the current Worklist
with a new file name and an XMLWL extension.
Save Workspace: Click the menu item to save the current Workspace
with the current Workspace file name. A Workspace includes plots,
regions, gates, colour precedence, selected statistics and displayed
parameters. The Workspace file is always saved with an XMLW
extension.
Save Workspace As…: Click the menu item to save an untitled
Workspace or the current Workspace with a new file name and an XMLW
extension.
Print
The Print menu contains the following options:
Print…: Click the menu item to print plots, statistics or reports. A
dialogue box appears. Select the printer, define the print range and the
number of copies and select what to print (plots and statistics for the
current Workspace or the current report).
Print Preview: Click the menu item to display a preview of the current
plots in the Workspace or the current report to be printed. Modify the
printing options if necessary and click the Print… button. A dialogue box
appears. Change the printing options if necessary and click the OK
button.
Print Setup…: Click the menu item to select the required default setup
for your printer.
Export
The Export menu is only available in Playlist mode except for the Export
Report to PDF menu item which is also accessible in Worklist mode.
The menu contains the following options:
Export Statistics to CSV: This menu item is only enabled when there
are results present in the results table. The results exported to a CSV file
are the columns displayed in the results table in the Results tab of the
Workspace. The format of the export is either single row per file or one
row per result, depending on the selection in the software options (see
chapter 12.10 CyFlow Options on page 187). Click the menu item to save
a CSV formatted file containing the results of the currently open Playlist
item only. A dialogue box appears. Enter a name for the export, select
the destination folder and click the Open button.
If the entered file name already exists and the format of the exported
data matches the formatting of the data in the file, the results are
appended to those already in the file.
If the entered file name already exists but the headers in the two files do
not match, you will have the option to overwrite the existing file. After the
file has been saved, the Windows Explorer opens with the exported file
highlighted.
Export All Statistics to CSV: This menu item is only enabled when
there are results present in the results table in the Results tab of the
Workspace. Click the menu item to save a CSV formatted file containing
the results of all files in the Playlist. A dialogue box appears. Enter a
name for the export, select the destination folder and click the Open
button.
If the entered file name already exists and the format of the exported
data matches the formatting of the data in the file, the results are
appended to those already in the file.
If the entered file name already exists but the headers in the two files do
not match, you will have the option to overwrite the existing file. After the
file has been saved, the Windows Explorer opens with the exported file
highlighted.
Export Playlist: This menu item is for exporting a Playlist for sharing
with other users and colleagues or for archiving. Any modifications to the
Playlist need to be saved before it can be exported.
Click the menu item and select the destination folder for the export.
Click the OK button to perform the export. A folder with the same name
as the current Playlist is created inside the destination folder. The
exported Playlist is placed in it. The exported listmode files are placed in
a subfolder called "LMD". The exported image files are placed in a
subfolder called "Images". Worklist and compensation files are stored as
part of the Playlist file (XMLP file).
If the original Playlist (before export) contains the same LMD file in more
than one of its items, only one copy of the file is in the export LMD folder.
If the original Playlist (before export) contains LMD files that have the
same name but are in different folders, they are all placed in the exported
LMD folder with numbers in parenthesis appended to the file name, so
they can be distinguished.
If a Playlist of the same name already exists in the selected folder, you
will have the option to replace the existing Playlist. If you choose not to
replace the existing Playlist, the new Playlist is saved with an appended
number to the name to distinguish it from the existing one.
If some of the LMD or image files that are to be exported have the same
name as the ones in the export LMD and images folders, the Windows
Copy File dialogue is displayed and allows you to resolve the conflicts.
When re-exporting a Playlist to the same folder it was exported before,
you should use Copy & Replace in the Windows Copy File dialogue.
Otherwise duplicate files will be created.
For an exported Playlist to open properly, the folder structure of the
export folder has to be preserved.
Export Statistics to XML: The menu item is enabled when a Playlist
item containing a listmode file is active. Click the menu item to save an
XML file containing the results of the currently open file only. A dialogue
box appears. Enter a name for the export, select the destination folder
and click the Open button.
If the entered file name already exists and the format of the exported
data matches the formatting of the data in the file, the results are
appended to those already in the file. If the entered file name already
exists but the headers in the two files do not match, you will have the
option to overwrite the existing file.
After the file has been saved, the Windows Explorer opens with the
exported file highlighted.
Export All Statistics to XML: The menu item is enabled if one or more
Playlist items contain a listmode file. Click the menu item to save an XML
file containing the results of all files in the Playlist. A dialogue box
appears. Enter a name for the export, select the destination folder and
click the Open button.
If the entered file name already exists and the format of the exported
data matches the formatting of the data in the file, the results are
appended to those already in the file. If the entered file name already
exists but the headers in the two files do not match, you will have the
option to overwrite the existing file.
After the file has been saved, the Windows Explorer opens with the
exported file highlighted.
Export Report to PDF: The menu item is enabled if there is an active
item in the Worklist or the Playlist, the Reports tab of the Workspace is
open and if acquisition is not in progress. Click the menu item to export a
report as PDF file and select a name and a destination folder for the PDF.
Tools
The Tools menu contains the following option:
Listmode File Keywords...: This menu item is only enabled if a Worklist
item or Playlist item containing a listmode file is open in the Workspace.
Click the menu item to open the Keywords dialogue. The dialogue
displays the keywords and values from the header of the active listmode
file. Click the Copy Keywords button to copy the keywords and values
displayed in the dialogue to the clipboard. This list can then be pasted
into other applications (e.g. Microsoft® Excel).
User Management
Click the button to open the Task Pad. The Task Pad contains options to
change your password, to lock the software or to view an Audit Log report.
If logged in with user administration privilege, the Task Pad contains options
for administration of user accounts.
Accessible: Click the button to restore access for the selected user.
Access is locked when a user enters a defined number of incorrect
passwords consecutively. The number is defined in the "Log In Attempts"
item.
Password: Click the button to enter a temporary password for the
selected user.
Groups: Click the button to define the roles for the selected user. Click in
the "Status" column to select or deselect the corresponding role for a
user.
Sort Order: Click the button to toggle the sorting order in the table
between sorting by first name or sorting by last name.
Refresh: Click the button to refresh the table.
The following options for system settings and reports are provided :
Log In Attempts: Click the item to define the number of login attempts
before the account will be locked (1 to 10 attempts).
Password Expiry: Click the item to define the number of days before
expiry of the passwords (1 to 90 days).
Password History: Click the item to define the number of passwords
that is stored in the password history (3 to 12 per user account).
Audit Log: Click the item to view an Audit Log report.
Log Out
Click the button to log out. You are logged out, and a log-in dialogue is
displayed.
If acquisition is in progress when logging out, a message is displayed and
you will have the option to abort the acquisition.
CyFlow Options
Click the button to open the software options (see chapter 12.10 CyFlow
Options on page 187).
The Home tab is the default tab and provides all the essential controls for
analysing files in one convenient place. Here, files can be selected, regions
created and plots created and gated.
Load group
The Load group contains controls for opening listmode files and
Workspaces.
Region group
The Region group contains controls for creating and editing regions. You can
create a maximum of 256 regions per Workspace. Once this number is
reached, the region creation buttons in the Region group become disabled.
Parameters group
The controls in the Parameters group are used to change the X and Y
parameters of the currently selected plots in the Workspace area. The
scaling of parameters can be changed.
Gate group
The Gate group options allow the selection of gating for the currently
selected plots.
The Analyze tab provides controls for analysing and modifying the plots in
the Plots area of the Workspace.
Region group
The Region group contains options for creating and editing regions. You can
create a maximum of 256 regions per Workspace. Once this number is
reached, the region creation buttons in the Region group become disabled.
Plots group
The Plots group contains options for adding a specific selection of plots to
the Plots area of the Workspace.
Upper Triangle: Click the button to add all the dual parameter plots that
are displayed within the upper right triangle of the Previews area. All the
added plots are colour-coded to illustrate the gating applied to the
Previews area.
Lower Triangle: Click the button to add all the dual parameter plots that
are displayed within the lower left triangle of the Previews area. All the
added plots are colour-coded to illustrate the gating applied to the
Previews area.
Backgated Plots: When you select the button, the software will assess
the gate equation of the currently selected plot and identify the regions
and parameters involved. The software then creates new plots with the
parameters used by the regions within the gate equation, and gates
these plots on the gate equation of the currently selected plot.
For example, if a plot gated on B is selected and its expanded gate
equation is A AND B, clicking the Backgated Plots button creates two
plots gated on B, one for events in region A and one for events in region
B.
Gate group
The Gate group contains options for creating and managing the gates in the
current Workspace.
Using the Precedence Order button, you can edit the colour precedence
order used when events are displayed on plots. You can also choose which
gates are active within the precedence system.
In the Precedence Order dialogue, a gates list displays all gates in the
current Workspace. The text colour corresponds to their gate colour.
Adjacent to each gate name is a check box. Select the check boxes to
include the corresponding gates in the colour precedence.
Gates positioned at the top of the list have higher precedence than the gates
positioned at the bottom of the list. The precedence defines the appearance
of the gates in the plots in the Workspace. The plots will display events in the
top gate of the list on top of all other events in the plot. If a new gate is
created, it will be added to the top of the preference list by default, and
events associated with it will be painted on top of events in any other gates.
To change the precedence, use the Precedence Order dialogue.
The Precedence Order dialogue contains the following options:
Move to top, Move up, Move down, Move to: Select a gate and use
these buttons to move the selected gate to the desired position within the
gates list.
Check all, Uncheck all: Use these buttons to select or unselect all gates
in the list.
Most Gated order: Click the button to place the selected gates in the
precedence order ranked by the number of unique regions in each gate,
using the expanded gate equations.
Ungated Event Color: To change the current colour for ungated events
on precedence plots. Click the arrow to display the colour control and
select the desired new colour.
When the gate order is modified, always check the selected precedence
order works as intended and no populations are masked by a colour of lower
priority.
Always ensure that the colours assigned to the populations in the
precedence system can be clearly distinguished from each other.
Using the Edit Gates button, you can create, edit and delete gates. In
addition, you can view the Parent Gate and Expanded Equation information.
The Edit Gates dialogue displays a Gates list containing all the currently
existing gates. In the Gates tab, you can rename and delete gates. In the
Derived Gates tab, you can rename, delete and change the gate equation of
derived gates. To edit a gate, first select it in the Gates list.
In the Gates tab, the Gates list contains the following columns:
The "Gate name" column displays the name of the gate. The colour of
the font is the colour of the gate.
The "Parent Gate" column displays the parent gate for the gate. If the
gate has no parent gate, this field displays "Ungated".
The "Expanded Equation" column displays the full expanded equation for
the gate. The parent gate equation is shown in full.
In the Derived Gates tab, the Gates list contains the following columns:
The "Gate name" column displays the name of the gate. The colour of
the font is the colour of the gate.
The "Equation" column displays the equation for the gate. The contents
of this field are added to the parent gate equation to create the expanded
equation.
The "Expanded Equation" column displays the full expanded equation for
the gate. The parent gate equation is shown in full.
The Edit Gates dialogue contains the following options:
New Gate: Click the button to add a new gate. A gate with a default
name is added to the bottom of the gate list.
Delete: Click the button to delete the currently selected gate. The
deletion of the gate will be aborted if you press the Cancel button on the
dialogue.
Gate Name: To change the gate name, type in the new name in the field.
You should use gate names that are significantly different.
Parent Gate: The Parent Gate drop-down list is populated with the
names of all available gates. To change the parent gate of the currently
selected gate, click the arrow to expand the drop-down list and select a
new parent gate from it.
When creating a new gate, the Parent Gate field can be used to simplify
gate equation creation. The field contains a list of all current gate names
and you can select one of these gate names rather than having to specify
the complete gate equation. If you wish to enter a full equation without
using a parent gate, you should select "Ungated" as the parent and then
enter the full equation into the Gate Equation field.
Gate Equation: In this field, you can edit the gate equation. To display a
larger Gate Equation dialogue, press the ... button at the right of the field.
The operators AND, OR, NOT, XOR can be used to help define a gate
equation. The order of processing of these operators is NOT, AND, XOR,
OR. Use parentheses () to change the order of processing. Region
names and these operators are used to define a gate.
Quotation marks ("") must be used around region names that include
spaces, e.g. "CD4 Count" and around region names that use any of the
shortcut symbols or words that are listed above, e.g. "A XOR B" and
"A!B". The gate equation can include a maximum of 28 regions and 6000
characters.
Gate Color: To change the gate colour, click the arrow to display the
colour control and select the desired new colour.
Always ensure that the colours assigned to the gates can be clearly
distinguished from each other. You should avoid using system colours as
they can be changed outside of the software.
View group
The View group contains options to modify the way in which plots are
displayed in the Plots area of the Workspace.
Edit group
The Edit group contains options for copying images of the currently selected
plots and statistics for pasting into other applications. These controls are
also used for copying, cutting and pasting items within reports. Additionally,
the fonts of text items in the current Workspace can be edited.
The buttons are only available if a Playlist item or a Worklist item is open in
the Workspace area.
When on the Report tab of the Workspace, click the Copy button to copy
the selected report objects for pasting into the report. Report items
cannot be pasted into other applications.
Delete: Click the button to delete the currently selected plots or region. If
the deleted plot has a region applied, deleting the plot also deletes the
region and removes the region from any gating logic. In this case, a
corresponding message box is displayed and you will have the option to
confirm or abort deleting the plot.
Select: Click the button to select groups of plots from a drop-down list:
Click the Select All option to select all the plots in the Plots area.
Click the Select Plots with Same Gate option to select all the plots that
have the same gate applied as the selected plot in the Plots area.
Click the Invert Selection option to select all the plots that are currently
not selected in the Plots area.
Click the Select Dual Parameter Plots or Select Histogram Plots
option to select all dual parameter plots or all histogram plots,
respectively.
Fonts: Click the button to open the Edit Fonts dialogue. In the pages of
this dialogue, you can change the font typeface and size for region
labels, plot titles, cell cycle and parameter names and scale labels in the
current Workspace. The pages are the same as in the software options
(see chapter Font pages on page 192).
The Preview tab provides controls for modifying the plots displayed in the
Previews area of the Workspace.
Preview group
The Preview group contains viewing options for the Previews area. The
buttons in this group are only available if a Worklist item or a Playlist item is
open in the Workspace. Selected buttons are highlighted in orange.
The buttons in the lower row of the Preview group contain filter options.
Filters affect which parameters, and therefore plots, are displayed in the
Previews area. The filters are used to selectively reduce the number of plots
displayed in the Previews area.
switches between hiding and showing the previews. The setting of this
button will be persisted between sessions.
Previews Topmost: By default, the Plots area is positioned above the
Previews area in the Workspace. Clicking the button switches between
displaying the Previews area above and below the Plots area.
Quadrants on Previews: Clicking the button switches between
displaying and hiding a quadrant region on all of the dual parameter
preview plots. Only one quadrant can be displayed on each plot.
Unfiltered: Click the button to show preview plots for all currently
selected parameters. The Previews area is unfiltered by default.
FL only: Click the button to only show preview plots of fluorescence
parameters. Scatter and other parameters will not be displayed. Click the
Unfiltered button to re-show all preview plots.
Gate Filter: When this filter is applied, any preview plots containing
parameters that are being used as a part of the gate equation for the
selected plot or region are excluded from the preview. This can be used
to reduce the number of preview plots. Click the Unfiltered button to
re-show all preview plots.
Show Lower Triangle: Click the button to show or hide the plots
displayed on the lower left triangle of the Previews area.
Show Upper Triangle: Click the button to show or hide the plots
displayed on the upper right triangle of the Previews area.
Scaling group
The Scaling group contains options to specify the scaling for parameters in
the Previews area. When no LMD file is open, or if a low-resolution file is
open, the controls in the Scaling group are disabled.
Display Zoomed: If zoom levels are set for individual parameters, click
the button to select or deselect displaying those parameter zoom settings
in the Previews area. The default is to display parameters in the
Previews area zoomed. For details on setting parameter zoom values,
see chapter Scales Properties dialogue on page 81.
View group
The View group contains options for selecting the preview plot type.
Parameter Properties
The Parameter Properties dialogue provides the custom naming and
parameter classification functionality of the software. To open the dialogue,
click the Parameter Properties button or double-click the parameter name
area of a plot in the Plots area of the Workspace.
The "On" column allows you to select whether the parameter belongs in
the Height (Peak), Width (Time of Flight), Area (Integral) or Other type.
Double-click in the cell or press F2 to open a drop-down list and select
the desired type for the parameter.
Click the Reset to default button to reset all parameters for the currently
loaded file to their default values.
View group
The View group contains options to select all parameters of a specific signal
type for display in the Previews area.
Parameters deselected here are hidden from other parts of the software.
You should be careful when hiding parameters which have compensation
values applied as these values will not be visible in the compensation
matrix.
Hovering the cursor over a check box will open a tooltip containing the
display name followed by the stain name for the parameter if a stain name is
available.
The Scatter group lists the scatter parameters, forward scatter (FSC) and
side scatter (SSC).
The Other group lists parameters that are not scatter or fluorescence
parameters. Examples of parameters that would belong to this group are
TIME and RATIO. The displayed parameter names are the parameter name,
stain name or custom as selected in the Customize tab of the Parameter
Properties dialogue (see Parameter Properties on page 76).
Scales group
The Scales group contains options for adjusting the scaling and zooming of
parameters. The Scales group is only enabled if a Worklist item or a Playlist
item is open in the Workspace.
If you change the zoom status on a plot with a region, the region position
does not change. You may need to reposition any regions set on zoomed
parameters.
The Zoom tool allows you to modify the zoom level for parameters of a
plot. To set or change a zoom level for parameters of the selected plot,
select the tool and then use it to define a zoom region. On a single
parameter plot, the tool draws a linear zoom region. On a dual parameter
plot, the tool draws a rectangular zoom region.
The button is not available when a low-resolution LMD file is currently
opened in the Workspace. The button is only enabled when at least one
plot is added to the Plots area of the Workspace.
Any change in scale via the Zoom tool will update the settings in the
Parameter Zoom tab of the Scales Properties dialogue. Any plots in the
Plots and Previews areas that are already zoomed will update
accordingly.
Display Zoomed: If zoom values are defined with the Zoom tool or in the
Parameter Zoom tab of the Scales Properties dialogue, clicking the
button toggles between the zoomed and un-zoomed view of the currently
selected plots.
Enter the desired value or use the arrows to increase or decrease the
value in the field. For example, when set at 100%, the number of
decades displayed on the negative section of the scale will be the same
as the number of decades displayed on the positive side of the scale.
When set at 0% the number of decades displayed on the negative
section of the scale will be 0.
OK: Click the button to apply the changes made in the dialogue to the
Workspace and to close the dialogue.
Apply: Click the button if you wish to apply the changes made without
closing the dialogue.
Cancel: Click the button to close the dialogue and cancel all changes.
Note that only changes made after the Apply button was clicked will be
cancelled.
The Parameter Zoom tab lists all the parameters in the current file and
allows you to edit the displayed scale values for each parameter in order to
optimise the way in which your data is displayed. The selected range is only
applied to the selected scale type (Lin, Log or V-Log). The selected zoom
values are only applied to plots that have been selected to display zoomed
parameters.
The Parameter Zoom tool is not available when a low-resolution LMD file is
currently opened in the Workspace.
If you change the zoom status on a plot with a region, the region position
does not change. You may need to reposition any regions set on zoomed
parameters.
Wizard group
The Compensation Wizard is only available in Playlist mode. The
Compensation Wizard simplifies the process of generating a full
fluorescence compensation matrix.
Before starting the Compensation Wizard, you need to load all of the single
stained samples and (if appropriate) the negative control sample into the
Playlist. For ease of use, you should order the files with the negative control
first, followed by the single stained samples in parameter order, e.g. FL1,
FL2, FL3, etc. You will be able to reallocate files later if required. If a single
LMD file contains more than one positive stain, you must load in the file once
for each stain present. The Wizard will allocate files based on the Playlist
starting from the first file. Additional files can be present in the Playlist but
will not be recognised by the Wizard.
Once the Playlist contains the required compensation setup files, click the
Compensation Wizard button to launch the Wizard.
Select the parameters for the gating plot: Select the parameters for
the primary bead / cell gating plot using the "X parameter" and "Y
parameter" boxes. They are populated with all the parameters shown in
the "Parameters" list.
Select background fluorescence mode: If no background fluorescence
control is present, select the "No background fluorescence" option. If a
separate background fluorescence control is being used, select the "Use
negative control file" option. If you wish to use negative events within a
positive sample to determine the background for each sample, select the
"Use negative regions" option.
Select the compensation plot type: Select whether histogram plots or
dual parameter density plots should be used for the definition of positive
and negative events for each parameter.
Allocate compensation parameters to listmode files: The list allows
you to allocate one of the parameters selected for compensation to each
LMD file. The listmode files (left-hand) side of the list shows the files from
the Playlist, in their current order, starting from the first file. The list
contains one LMD file for each selected compensation parameter. If the
"Use negative control file" option is selected, the list also contains a file to
be used as the negative control file. When the selection of parameters
changes, the list updates accordingly.
The allocated parameters (right-hand) side of the list shows the allocated
compensation parameters. Each row consists of a drop-down list that
contains all the fluorescence parameters from the "Parameters" list
selected for compensation. Selecting an item from the drop-down list
which is already selected for a different file clears the setting for that file.
The default allocation will be the negative control file first (if selected)
followed by the selected parameters in the order of the "Parameters" list.
If the listmode files list is updated (parameters selection or changing the
"Use negative control file" selection), the allocated parameters return to
their default allocations.
Next: Click the button to proceed to the next page of the Wizard. If the
"Use negative control file" option is selected, the next page is the
Background Fluorescence page, otherwise it is the first Compensation
page. If the selections made on the Configuration page are incorrect, you
will not be allowed to proceed to the next page, and an appropriate error
message will be displayed.
Back: Selecting the button returns you to the previous page of the
Compensation Wizard. The Back button on the first Compensation page
is disabled if the "Use negative control file" option was not selected.
Next: Selecting the button proceeds to the next Compensation page or to
the Review page when on the last Compensation page.
1 2
Comp %: The fields display the current compensation values for the pair
of parameters present on the currently selected plot. The top (X) field
shows the subtraction of the Y-parameter from the X-parameter. The
bottom (Y) field shows the subtraction of the X-parameter from the
Y-parameter. The fields allow the entry of compensation values. Up to six
characters can be entered into the fields in the range 0.00 to 100.00.
Entered values are rounded to 2 decimal places.
Compensation Arrows: The arrow buttons allow the fine adjustments of
compensation % values. Use the top row of arrows to increase/decrease
the X compensation value by 0.1/by 0.01. Use the bottom row of arrows
to increase/decrease the Y compensation value by 0.1/by 0.01.
Compensation values are limited to the range 0.00 to 100.00. The
direction of the arrow icons indicates the way the plot populations move
rather than the way the compensation values change.
Quadrant Region: Click the button and then click onto a dual parameter
plot to insert a quadrant on a dual parameter plot. For information on
quadrant regions, see chapter Creating regions on page 165.
Quadrant Statistics: Statistics are displayed when the current listmode
file is compensable, a dual parameter plot displaying compensable
parameters is selected, and the plot contains a quadrant region. If the
statistic cannot be calculated due to insufficient events, the edit field will
show "ERROR". If multiple quadrant regions are present on the plot, the
statistics are only displayed for the quadrant region set created first.
Compensation group
The Compensation group contains options for displaying the compensation
matrix, for clearing the current compensation matrix and for loading the
compensation settings from the current file header.
Click the Print button to print the compensation matrix. The default font
size for printing the matrix is 10 pt. If the matrix does not fit in the printing
area, the font size for the print out of the matrix will be reduced. If the
minimum font size is reached and the matrix still cannot fit in the printing
area, the printout switches layout (from portrait to landscape or vice
versa) and the fitting procedure is applied again. If the matrix still cannot
The Statistics tab provides controls for selecting which statistic is displayed
on each plot in the Plots area and which statistic is presented in the
associated results table in the Workspace.
The Statistics tab behaves differently depending on which tab in the
Workspace area is selected:
When in the Plots tab of the Workspace, only one statistic can be
selected at any time. The currently selected statistic is displayed adjacent
to the region for all regions on all plots in the Plots area. If you select a
new statistic, the previously selected one is automatically cleared. By
default, the %Gated statistic is displayed on plots. The controls in the
General group and the DNA Statistics group are disabled as these
statistics cannot be displayed on plots.
When in the Results tab of the Workspace, any number of statistics can
be selected and the statistical values for the selected statistics are
displayed in the results table. For details of the display of statistics in the
Results tab, see chapter 12.8.2 Results tab of the Workspace on
page 171.
When in the Reports tab of the Workspace, the Statistics tab is only
enabled when a Stats Box is selected. Statistical values for the selected
statistics are displayed in the Stats Box.
The Results Tables group provides options for working with tables on the
Results tab of the Workspace.
The Results Table group contains the following options:
Add Table: Click the button to create a new results table.
Tables: To show an existing results table, click the arrow to expand a
drop-down list and select the desired table.
Delete Current Table: Click the button to delete the current results table.
Send Table To...: Click the arrow to expand a drop-down list and select
a destination to send the current results table to.
Filter Table: Click the button to filter the current results table. The
Listmode Files dialogue is displayed.
To filter by listmode files, select the file names of the listmode file(s) to
filter the statistics.
To add a new filter, click the Add Filter button. The Add/Edit Filter
dialogue is displayed. Select the statistics to filter on, select the type of
filter and select or enter the desired filter value(s).
General group
The items selected in this group are displayed in the results table and in
selected Stats Boxes on the reports.
Region displays the name of the region or the DNA plot name.
Filename displays the LMD file name.
File Path displays the LMD full path and file name.
Plot Title displays the title of the plot.
FCS Key 1 and FCS Key 2 displays the respective FCS keywords. The
items are disabled in Worklist mode.
Events group
The items selected in this group are displayed on Plots, in the results table
and in selected Stats Boxes on the reports.
Intensity group
The items selected in this group are displayed on Plots, in the results table
and in selected Stats Boxes on the reports. The Intensity group displays
statistical options that express the intensity of the generated populations.
X Mean displays the mean average for the X-axis histogram of a region.
Y Mean displays the mean average for the Y-axis histogram of a region.
Where the region is only a single parameter region, the entry on the
results table is left blank.
Variation group
The items selected in this group are displayed on Plots, in the results table
and in selected Stats Boxes on the reports. The Variation group displays
options that express the variation of populations.
The Worklist tab provides controls for modification of all aspects of a Worklist
including Worklist items, panels, Workspace files and instrument settings.
The Worklist tab is only available in Worklist mode.
General group
The General group contains options to open, save and edit a Worklist.
Panel group
The Panel group contains options to edit a panel of the Worklist.
Workspace group
The Workspace group contains options to edit the Workspace.
Calculation group
The Calculation group contains options to switch between automatic
background calculation and manually triggered calculation.
The Playlist tab provides controls for modification of all aspects of a Playlist
including Playlist items, Playlist files, Workspace files and compensation
files.
The Playlist tab is only available in Playlist mode.
Listmode group
The Listmode group contains options to modify the listmode files in the
Playlist.
Workspace group
The Workspace group contains options to modify the Workspace file
associated with Playlist items.
Clear: The button is enabled when one or more Playlist items are
selected in the Playlist. Click the button to replace the Workspace files in
the selected items with the default blank Workspace. The listmode and
compensation files are not affected. Clearing the Workspace file of an
open Playlist item will clear the Plots area only.
Copy: The button is enabled when one or more Playlist items are
selected and all of them contain a Workspace. Click the button to copy
the Workspace files of the selected Playlist items to the clipboard. They
can only be pasted to other Playlist items.
Paste: The button becomes enabled when there is a Workspace file
copied to the clipboard.
If a single Workspace file is copied, clicking the Paste button will paste
the clipboard’s Workspace file into all selected items in the Playlist.
If multiple Workspace files are copied, clicking the Paste button will paste
the clipboard’s Workspace files into the selected items in the Playlist.
Pasted Workspace files will be pasted in the same order in which they
appeared in the Playlist when copied. If you attempt to paste more items
than are currently selected in the Playlist, as many items as possible will
be pasted, any excess items will be ignored. If the target selection
contains more Playlist items than the clipboard contains copied
Workspace files, the pasted Workspace files will be repeated until all
selected Playlist items are pasted a Workspace file.
After pasting Workspace files, make sure that the positions of regions are
correct for the individual listmode files.
Compensation group
The Compensation group contains options to modify compensation files in
the Playlist.
displayed and you will have the option to abort opening the listmode file
or to open the listmode file and remove the compensation file from the
Playlist item.
Save As: The button is enabled when a single compensable Playlist item
is selected in the Playlist. Click the button to save the current
compensation file with a new file name.
Copy: The button is enabled when at least one of the selected items
contains a compensable listmode file and/or compensation file. Click the
button to copy the compensation files of the selected item(s) to the
clipboard. They can then be pasted into the Playlist.
Paste: The button becomes enabled when there is a compensation file
from the Playlist copied into the clipboard and at least one of the selected
items is compensable.
If a single compensation file is copied, clicking the Paste button will paste
the clipboards’ compensation file into all selected items in the Playlist.
If multiple compensation files are copied, clicking the Paste button will
paste the clipboards’ compensation files into the relevant selected items
in the Playlist. Pasted compensation files will be pasted in the same
order in which they appeared in the Playlist when copied. If you attempt
to paste more items than are currently selected in the Playlist, as many
items as possible will be pasted, any excess items will be ignored. If the
target selection contains more Playlist items than the clipboard contains
copied compensation files, the pasted compensation files will be
repeated until all selected Playlist items are pasted a compensation file.
When pasting a single or multiple compensation files, the parameters in
the compensation files may not match those in the listmode file. In this
case, the copied compensation files will be applied to the compatible
items in the Playlist but not to the incompatible ones, and a
corresponding message is displayed.
If the parameters do not match and the item is not currently open, the
message will only be displayed when you try to open the item containing
the incompatible listmode and compensation files.
Use listmode: The button is enabled when at least one of the selected
Playlist items is compensable.
Click the button to replace the compensation files of all items containing
a high-resolution data file with the compensation settings stored in the
FCS file headers. Any selected items that don’t contain high-resolution
data will not be updated, and a corresponding message will be displayed.
Calculation group
The Calculation group contains options to switch between automatic
background calculation and manually triggered calculation.
Cleaning group
The Cleaning group contains options for starting priming and cleaning
procedures.
Sort group
Click the Create Comp Panel button and select a Workspace file (CyFlow
acquisition Workspace files only) to use as a source for the compensation
setup panel. From this Workspace file, the parameters and instrument
settings (voltages, trigger logic and threshold information) are derived.
The Create Compensation Panel dialogue is displayed.
The Overlay tab provides controls for creating single and dual parameter plot
overlays. Overlay plots can be used to compare plots. The overlay plots are
displayed in the Overlays tab of the Workspace (see chapter 12.8.3 Overlays
tab of the Workspace on page 174).
Wizard group
The Overlay Wizard is only available in Playlist mode. The Overlay Wizard
simplifies the process of generating overlay plots from a Playlist of samples.
Before starting the Overlay Wizard, make sure Workspaces in the Playlist
are the same for all files.
Click the Next button to proceed to the Plot Selection page of the Wizard.
Region group
The Region group contains options for creating and editing regions. You can
create a maximum of 256 regions per Workspace. Once this number is
reached, the region creation buttons in the Region group become disabled.
Plots group
The Plots group contains options to insert plots from the Plots area of the
Workspace into overlay plots.
Edit group
The Edit group contains options to copy, delete and select plots in the Plots
area and to edit the fonts of text items in the current Workspace.
The Report tab provides controls for creating page-based reports from a
Playlist or from a panel of a Worklist. The Report tab allows you to add and
set up report pages, insert objects and text into the report and edit and
organise the objects on the report. The reports are displayed in the Reports
tab of the Workspace (see chapter 12.8.4 Reports tab of the Workspace on
page 179).
Wizard group
The Report Wizard is only available in Playlist mode. The Report Wizard
simplifies the process of creating a report.
When creating a report via the Wizard, the current report page size and
orientation will be used, and any existing header and footer content will be
retained. Therefore, before starting the Report Wizard, set the report page
size and orientation using the Page Setup group of the Report tab and insert
the desired header and footer content using the Insert group of the Report
tab.
The Wizard retains settings until you open or create a new Playlist.
Click the Report Wizard button to launch the Wizard. The button is disabled
when there are no plots in the Workspace.
The Report Wizard is made up of five types of pages:
Welcome Page,
Plots Selection Page,
Statistics Layout Page,
Statistics Selection Page,
Report Layout Page.
Click the Next button to proceed to the Plots Selection page of the Wizard.
For each plot, the list displays the item number for the Workspace containing
the plot, the X and Y parameters and the gate.
To add a plot to the report, select the check box next to this plot. During a
session of using the same Playlist when rerunning the Wizard, previously
checked plots will be remembered. Changing the Playlist or closing the
software loses these settings.
The page contains the following options:
Plot Order: Plots appear in the report in the order they appear in the plot
list. To change the order, click the up/down arrows to move selected
plots up and down in the list. To reset the plot order, use the Reset
button.
Plot Selection: Click the Select All or Select None buttons to select or
deselect all plots. To display only the plots which you have selected for
the report, select the "Show only selected plots" check box.
Next: Click the button to proceed to the Statistics Layout page.
Edit group
The Edit group contains options to select and delete objects on the report.
Pages group
The Pages group contains options to add new pages to the report and to
organise the pages of the report.
The option selected here will take precedence over that selected in the
"Print Setup" dialogue.
Size: Click the button to display a drop-down list and select the desired
page size (A4 or letter). The page size for all pages in the report is
changed. All header, footer and body objects that lie outside the bounds
of the new page size are automatically resized to fit the new size. If the
size is then switched back, any resized objects are not restored to their
original size or position. In order to restore pages exactly as they were,
click the Undo button in the Quick Access Toolbar.
If there is a mismatch between the paper size set in the "Print Setup" and
the size selected here, the page will be automatically scaled to fit the
paper when printing.
Insert group
The Insert group contains options to insert objects into the report. The
controls are only enabled when you are on the Reports tab of the
Workspace. To insert an object into the report, first select it with the buttons
described below, then click on the report to insert the object in default size or
draw out a rectangle of the desired size. For more information on inserting,
resizing and moving objects in the report, see chapter 12.8.4 Reports tab of
the Workspace on page 179.
In the "Report Item" drop-down list, the page number, date and time, user
name, file names and/or file paths with file names of the currently open
files can be selected.
In the "Primary Keyword" and "Secondary Keyword" submenus, the
primary and secondary keywords from the currently open LMD file can be
selected.
Image: Click the button and navigate to the desired folder to select an
image file for insertion into the report. Only image files with the extension
".jpg", ".gif", ".bmp" and ".png" are supported. If required, use the "Save
as Type" drop-down list to display pictures of a viable file type.
Click the Open button or double-click on the image file to insert the
selected image file into the report. If the inserted image lies outside the
bounds of the page, it is automatically resized. Images are inserted into
the body section of a page by default. They can, however, be moved into
the header or footer.
Text box: Click the button to select a text box for insertion. Click on the
report page at the point where you wish to place the text box. Double
click on the text box to enter the desired text. You may need to resize the
text box.
Line: Click the button to select a line for insertion. Click on the report
page at the point where you wish to place the line.
Text group
The Text group contains controls for editing and organising of text.
Select a text box, statistics box, compensation matrix and/or field and use
the options in the Text group to edit the font typeface, font size, font style
(bold, italic, underlined) and colour of the selected object.
Select a text box and/or a field and use the alignment buttons (align left,
centre, align right) to align the text.
Format group
The Format group contains options to format items in the report.
Line Colour: The button is enabled when one or more line objects are
selected in the report. Click the button and select the desired colour for
the currently selected lines.
Sort Stats: The button is enabled when a statistics box is selected in
reports. It is also enabled when multiple statistics boxes are selected
provided the selected statistics boxes contain exactly the same statistics.
Click the button to display the "Sort Statistics" dialogue. Use the up/down
arrows to define the left to right column order. Select the statistic to sort
rows by and whether to sort rows in ascending or descending order as
required.
Dash Style: The box is enabled when one or more line objects are
selected in the report. Click the arrow to display a drop-down list and
select the desired dash style.
Line Width: The control is enabled when one or more line objects are
selected in the report. The default line width for inserted lines is 1.00 pt.
Type in the desired width or use the up/down arrows to adjust the width.
The line width must be between 0.25 pts and 50 pts.
Edit Text: The button is only enabled when a single text box is selected
in the report. Click the button and enter the desired text into the edit field.
The maximum number of characters is 8000.
Textbox Filled: The check box is only enabled when one or more text
boxes or fields are selected in the report. Select the check box to show
the selected text boxes filled.
Arrange group
The Arrange group contains options to move, align and resize report items.
Zoom
The Zoom group contains options to zoom in and out on the page using
predefined and custom percentages.
Click the Zoom button to display a dialogue and use the dialogue options to
zoom in and zoom out as required.
The Views tab provides controls to define the panes that are available.
The Plot Format tab is only available when at least one plot is selected in the
Plots area of the Workspace (see chapter 12.8.1 Plots tab of the Workspace
on page 160).
The Plot Format tab contains controls to adjust the settings of selected plots
in the Plots area.
Gate group
The Gate group contains an option to choose a gate to be applied to
selected plots.
Click the drop-down arrow positioned on the Gate group to display a list of all
the available gates. Click the desired gate from this list to apply the gate to
selected plots.
X-Axis group
The X-Axis group contains options to change the X-axis of the selected plots
to the linear, logarithmic or V-Log scale type.
If a low-resolution file is open, the axis parameters are set by the information
within the LMD file header and cannot be changed. The X-axis buttons are
disabled for low-resolution files and if cell-cycle plots have been selected.
For information on the available plot scaling types, see chapter Scaling on
page 168.
Y-Axis group
The Y-Axis group contains options to change the Y-axis of the selected plots
to the linear, logarithmic or V-Log scale type.
If a low-resolution file is open, the axis parameters are set by the information
within the LMD file header and cannot be changed. The Y-axis buttons are
disabled for low-resolution files and if single parameter histogram plots have
been selected.
For information on the available plot scaling types, see chapter Scaling on
page 168.
The Region Format tab is only available when a region is selected in the
Plots area.
You can use the options on the Region Format tab to modify the appearance
and type of a selected region. The region label can also be repositioned and
regions can be tracked to other regions.
Appearance group
The Appearance group contains options to change region colour, rename a
region and reselect the automatic positioning of region names.
Type group
The Type group contains options to change the type of a selected region.
The region type of the currently selected region is highlighted. To change the
region to another type (elliptical, rectangular or polygonal region), click the
respective button.
Position group
The positioning of created elliptical, rectangular, linear and quadrant regions
can be modified by selecting a region and clicking the Region Position
button. The button is disabled if a polygonal region is selected.
A dialogue is launched that allows for precise definition of position and size
of the region.
Depending on the type of the selected region, the corresponding dialogue is
displayed:
Ellipse: To position the centre of the elliptical region, use the "Center X"
and "Center Y" input fields. A lower value positions the centre to the left
or down, respectively. The values must be between -1500 and 1500.
To define the width of the X-axis of the ellipse, use the "Major Axis size"
input field. To define the width of the Y-axis of the ellipse, use the "Minor
Axis size" input field. The size values must fall between 0 and 1023.
To rotate the ellipse, enter the desired number of degrees into the
"Rotation(degrees)" input field. Rotation limits are -360° to 360°.
Rectangle: Use the input fields to define the positions of the left side
("Lower X"), the bottom side ("Lower Y"), the right side ("Upper X") and
the top side ("Upper Y") of the rectangle. A lower value positions the side
of the rectangle to the left or down, respectively. The values must be an
integer between 0 and 1023.
Linear: Use the input fields to define the positions of the left point
("Lower bound") and of the right point ("Upper bound") of the linear
region. A lower value positions the respective point to the left. The values
must be an integer between 0 and 1023.
Quadrant: To choose between straight and bendy quadrant region,
select the corresponding option (see chapter Creating regions on
page 165).
Use the "Center X" input field to position the quadrant intercept on the
X-axis. Increase the value to shift the intercept to the right. Decrease the
value to shift the intercept to the left.
Use the "Center Y" input field to position the quadrant intercept on the
Y-axis. Increase the value to shift the intercept upwards. Decrease the
value to shift the intercept downwards.
The "Bendy X" and "Bendy Y" input fields are disabled when the
"Straight" option is selected.
Use the "Bendy X" input field to position the ‘bent’ upper divider edge on
the X-axis. Increase the value to shift the divider edge to the right.
Decrease the value to shift the divider edge to the left. "Bendy X" values
must be greater than the "Center X" value.
Use the "Bendy Y" input field to position the ‘bent’ right divider edge on
the Y-axis. Increase the value to shift the divider edge upwards.
Decrease the value to shift the divider edge downwards. "Bendy Y"
values must be greater than the "Center Y" value.
All values must be an integer between 0 and 1023.
Tracking group
The Tracking group contains an option to link region positions on plots that
display the same parameters. If one of the linked regions is changed, all the
linked regions are adjusted simultaneously.
The Overlay Format tab is only available when at least one plot is selected in
the Overlays tab of the Workspace (see chapter 12.8.3 Overlays tab of the
Workspace on page 174).
The Overlay Format tab provides controls to edit overlay plots.
Format group
The Format group contains options to adjust line and fill styles of overlay and
gallery plots, also options for the display of plots, scaling and legend.
Use colour selection with caution as it is possible to choose the same colour
for data, background and filling, most importantly if white is used.
Show Plot: The button is available when one or more plots are selected
in the Galleries area. Select this option to display the selected plots in the
overlay plot. Deselect this option to remove selected plots from the
overlay plot. Any plots in the gallery which are not hidden will display a
"Not Displayed" icon in the Galleries area. This icon is not visible in
reports or copied and pasted images.
Overlays group
The Overlays group contains buttons to switch the available views for the
overlay plot from overlay mode to 3D mode. The buttons are available when
one or more plots are selected in the Overlays area. The highlighted button
indicates the current mode of the selected plot(s). When different modes are
present in the selected plots, no button will be highlighted.
Controls group
The options in this group are available for single parameter overlay plots
only. They allow one plot within a gallery to be displayed as control on all
other plots within the gallery of the current overlay plot.
Calculations group
The buttons in this group are available when one or more single parameter
plots are selected in either the Overlay or Galleries area and the current plot
has a control already set.
When a control is set, two calculation options are available to compare test
and control plots: Overton or K-S comparison statistics. The selected
calculation will be applied to all plots within the selected overlay plot.
3D group
12.5 Panes
In the panes of the software window, the functions for acquiring data are
provided, and informations concerning the currently open Worklist item or
Playlist item are displayed.
The panes that are available in the panes area can be selected and
deselected in the Views tab of the Ribbon (see chapter 12.4.13 Views tab on
page 123). To get back to the default view, click the Default Position button
in the Views tab of the Ribbon.
The panes can be positioned on the screen as required (see chapter 12.2
Views of the software window on page 52). To get back to the default view,
click the Default Position button in the Views tab of the Ribbon.
The Playlist pane is only displayed in Playlist mode and is described in a
separate chapter (see chapter 12.7 Playlist pane on page 154). The Playlist
pane is displayed in the panes area by default.
The Worklist pane is only displayed in Worklist mode and is described in a
separate chapter (see chapter 12.6 Worklist pane on page 146). The
Worklist pane is docked to the bottom of the Workspace area by default.
The other panes are described in this chapter and comprise:
FCS File Information pane,
Results Hierarchy pane,
Settings pane,
Acquire pane,
Setup pane.
This pane displays as a title the name of the currently active FCS file. In
Worklist mode, the title is only displayed if an FCS file is present.
Beneath the title, the pane displays information on the currently open FCS
file. The file information comprises file path, header, parameters,
compensation and other information.
In Worklist mode, the "compensation" section displays the compensation
matrix of the listmode file associated with the currently active Worklist item.
This pane displays as a title the name of the currently active FCS file. In
Worklist mode, the title is only displayed if an FCS file is present.
Beneath the title, the pane displays the count of ungated events and count
and percentage of gated events in a hierarchical view.
This pane displays a table of settings for the parameters. In Playlist mode,
the table is empty and the options are disabled. In Worklist mode, the table
entries can be edited for the samples to be measured. For samples already
measured, the table is read only.
value or use the up/down arrows. Threshold limits are between 1 and
2000. Threshold value can only be set when logic is not deactivated (off).
Voltage: The voltage of the individual optical parameters defines the
photomultiplier signal amplification and therefore the signal intensity to be
displayed. To edit, enter a value or use the up/down arrows. Voltage
limits are between 1 V and 1000 V.
The Acquire pane displays the acquisition controls which run the flow
cytometer and controls for priming and cleaning procedures.
The options within the Acquire pane are disabled in Playlist mode and when
the software is offline.
The Acquire pane contains the following buttons for acquiring data:
Play: Click the button to start measuring a sample.
The acquisition will start.
Pause: The button is only enabled if acquisition is in progress. Click the
button to interrupt the acquisition process. The sample flow is interrupted
while the sheath flow is continued. The data already acquired are held in
memory but not saved until acquisition is completed or stopped. When
clicked, the pause button is disabled.
To resume acquisition from the paused state and continue the collection
of data, click the Play button.
To restart the acquisition discarding any previously held data for the
sample, click the Restart button.
To stop the acquisition process for that sample and save the acquired
data, click the Stop button. Acquisition will move on to the next defined
Worklist item to be acquired. If the current sample is the last in the
acquisition sequence, acquisition will terminate.
Restart: The button is only enabled if acquisition is in progress. Click the
button to restart the acquisition process for that sample. The data
acquired up to this point are discarded.
Stop: The button is only enabled if acquisition is in progress. Click the
button to stop the acquisition process for that sample. The data acquired
up to this point are saved and acquisition will move on to the next defined
Worklist item to be acquired. If the current sample is the last in the
acquisition sequence, acquisition will terminate.
Previous: The button is disabled if acquisition is in progress. Click the
button to activate the previous Worklist item in the Worklist.
Next: The button is disabled if acquisition is in progress. Click the button
to activate the next Worklist item in the Worklist.
Abort: The button is only enabled if acquisition is in progress. Click the
button to stop acquisition and discard data from the current sample. You
will have the option to clear the acquired data and proceed to the next
Worklist item or to clear the acquired data and stop measuring.
The Acquire pane contains the following buttons for performing predefined
procedures:
Prime: Click the button to start a priming procedure. Once started, the
software guides you through the process.
De-bubble: Click the button to start a procedure to clear bubbles from
the flow cuvette. Once started, the software guides you through the
process.
Clean: Click the button to start a cleaning procedure. Once started, the
software guides you through the process.
The "Flow Rates" section of the Acquire pane contains the following controls:
Above the flow rate slider, the acquisition flow rate (events per second)
and the absolute event count are displayed during acquisition.
Flow Rate Slider: The slider allows to adjust the sample injection speed
into the flow cuvette. Low speed values result in a better precision and
accuracy. A higher speed can be used when the particle concentration is
measured and accuracy is of lower relevance. The scale ranges from
0.1 μl/s to 19.8 μl/s. The value (µl/s) is displayed at the right-hand side of
the slider.
The flow rate can be changed in the following ways:
Mouse drag and drop of the slider will increase/decrease the flow rate in
steps of 0.1 μl/s.
Using the PgUp and PgDn keys of the keyboard will increase/decrease
the flow rate in steps of 0.5 μl/s.
Using the up/down arrow keys of the keyboard will increase/decrease the
flow rate in steps of 0.1 μl/s.
Scrolling the mouse scroll wheel will increase/decrease the flow rate in
steps of 0.3 μl/s.
Low: Click the button to set a low flow rate (0.5 µl/s).
Medium: Click the button to set a medium flow rate (2 µl/s).
High: Click the button to set a high flow rate (5 µl/s).
The "Lasers" section of the Acquire pane can contain between 1 and 6
buttons that represent the number of lasers detected in the connected
device. The wavelengths of the lasers are displayed on top of the buttons.
Clicking a button toggles the on/off state which will switch the associated
laser on or off. The current on/off state of the lasers is displayed below the
buttons.
The Setup pane displays the setup options of the flow cytometer. You can
select the number of events and the parameters to be displayed in the
current Workspace.
The options within the Setup pane are disabled when the software is in
Playlist mode.
The "TVAC" check box is selected when the TVAC stop condition has
been set in the Stops pane. Using TVAC (True Volumetric Absolute
Counting), a fixed volume of 200 µl between the start and stop electrodes
in the sample is measured. This setting creates and enables the TVAC
parameter to be recorded during acquisition. The TVAC parameter is not
a parameter defined by the device configuration.
This pane provides options for setting stop conditions. In default mode, the
sample is run until its level reaches the stop electrode.
The sample analysis automatically stops when the sample is empty (the
stop electrode is reached) even if the selected stop condition is not yet
realised.
If the Worklist contains differing stop conditions, the Worklist conditions
will override the stop conditions set in the Stops pane.
The options within the Stops pane are disabled when the software is in
Playlist mode.
1
2
3
Worklist buttons
The Worklist buttons are disabled during acquisition except for the
Expand/Restore button.
The functionality of the New, Open, Save and Save as buttons is the same
as on the File tab of the Ribbon.
The columns are width adjustable. To adjust the width, drag the column
divider to the right of the column. If you double-click a column divider, the
column will resize to display its contents optimally.
The Worklist contains the following columns and associated context menus:
Active: A green arrow displayed in this column indicates the currently
active Worklist item.
Acquired: A check mark displayed in this column indicates that the
Worklist item has been acquired and has associated listmode data. No
more data can be acquired on this Worklist item.
Index: This column displays the sequential number representing the
Worklist order. The column is automatically filled and cannot be changed.
Run Number: The run number is an updating incremental cycle count
per system. The column is automatically filled when acquisition begins.
When acquisition is aborted by the user and a new acquisition has been
started for that Worklist item, the run number is incremented.
Location: This column specifies the location of a sample within the
source type (plate or tube rack) if an autoloader is used. In manual mode,
the column is blank.
Panel: To combine several Worklist items, they can be organised in a
panel. This is typically used for series of measurements of the same
sample with different settings.
The column displays the panel name for defined Worklist items. When a
Workspace is defined within the Worklist, a panel name is created. The
default names will ascend numerically ("Panel 1", "Panel 2", etc.) and are
unique to the Worklist.
In the context menu of the "Panel" column, options are provided to save
the panel, to insert or replace a panel, to add an item to the panel and to
clear the panel, i.e. to delete all Worklist items associated with this panel.
Workspace: The column displays the name of the Workspace file
associated with the Worklist item.
When a Workspace is defined within the Worklist, a Workspace name is
created. The default names will ascend numerically ("Workspace 1",
"Workspace 2", etc.) and are unique to the Worklist.
If a Workspace has been modified since its last save, an asterisk is
displayed in front of the Workspace name indicating that the
corresponding file contains unsaved changes.
In the context menu of the "Workspace" column, options are provided to
open a new Workspace file, to save the Workspace file, to replace the
Workspace file or to apply the Workspace file to a panel or to the
complete Worklist.
Lab #: This column is provided for entering the laboratory barcode
number or blood tube identification number. When data acquisition is
finished, the column is disabled.
The functionality of the New, Open, Save and Save as menu items is the
same as on the File tab of the Ribbon.
The general Worklist context menu contains the following options:
New: Click the menu item to create a new Worklist or a new Playlist.
Open: Click the menu item to open an existing Worklist or Playlist.
Save: Click the menu item to save the current Worklist with the same
name.
Save As: Click the menu item to save the current Worklist with a new
name.
Insert Panel: To insert a previously saved panel, click the menu item
and select a panel (XMLPA file) from the Windows Open dialogue. The
panel is added to the Worklist starting at the selected row. The option is
only available if the Worklist item is not yet assigned to a panel.
Replace Workspace: To replace the current Workspace file, click the
menu item and select a Workspace file (XMLWS file) from the Windows
Open dialogue. Only a single Workspace file can be opened. If multiple
Worklist items are selected, the Workspace files for all selected items are
replaced with the chosen Workspace file, and are automatically grouped
into a panel. A panel name is created by default
The option is disabled when a compensation setup panel is active.
Panel: In this submenu, options are provided to save the panel, to insert
or replace a panel, to add an item to the panel and to clear the panel, i.e.
to delete all Worklist items associated with this panel.
When saving a panel, the full path and file extension are stripped and the
Workspace name is used as an identifier. If there are multiple Workspace
files present within the panel with the same name, a unique identifier is
added to the Workspace file name to differentiate the Workspace files.
When replacing a panel, the selected panel in the Worklist will be
removed, and the chosen panel will be inserted into the Worklist, with the
first item of the panel at the same position the first item of the previous
panel was at.
The "Add Item" option will duplicate the last row in the panel. The option
is only enabled when at least one undefined item is directly below the
panel.
The "Clear Panel" option is disabled if LMD files are present in any of the
selected panels. The option will clear the selected panel(s) from the
Worklist and reset the Worklist items to an undefined state.
Workspace: In this submenu, options are provided to create a new
Workspace file, to save the Workspace file, to replace the Workspace file
or to apply the Workspace file to a panel or to the complete Worklist.
The "New Workspace" option will create a default Workspace file for the
selected Worklist item. The option is disabled when more than one
Worklist item is selected or when a compensation setup panel is active.
Instrument Settings: In this submenu, options are provided to save or
replace the instrument settings and to apply the instrument settings to the
panel.
When saving the instrument settings, the threshold, threshold logic,
voltages and compensation settings will be saved to the target file.
Stop conditions: In this submenu, the option to apply the selected stop
conditions to the panel is provided.
Clear LMD: Click the menu item to clear the listmode data from the
Worklist item. The check mark in the "Acquired" column is no longer
displayed indicating that new data can be acquired on this Worklist item.
This option is only available if data are acquired on this Worklist item.
Clear Item: The option is only enabled if a single Worklist item is
selected that is the first or last item of a panel. Click the menu item to
clear all settings from the Worklist item. This option is only available if no
data are acquired on this Worklist item.
Copy: The menu item is only available if the context menu is launched
from a manual entry field ("Lab #", "Sample ID" or "Stop Value" columns).
Click the menu item to copy the text from the column of the selected
Worklist items to the clipboard.
Paste: The menu item is only available if the context menu is launched
from a manual entry field ("Lab #", "Sample ID" or "Stop Value" columns).
Click the menu item to paste the previously copied text to the column of
the selected Worklist items. If only one text was copied, it will be pasted
to all selected Worklist items. If text from several Worklist items was
copied, select the same number of Worklist items before pasting.
1
2
3
Playlist toolbar
The options in the Playlist toolbar allow you to navigate through a Playlist, to
reorder or to delete items in the Playlist.
The Playlist toolbar contains the following buttons:
First File: Click the button to skip to the first file in the Playlist and open
the file in the Workspace.
Previous: Click the button to skip to the previous file in the Playlist and
open the file in the Workspace.
Next: Click the button to skip to the next file in the Playlist and open the
file in the Workspace.
Last File: Click the button to skip to the last file in the Playlist and open
the file in the Workspace.
Insert Item: The button is enabled when a single Playlist item is
selected. Click the button to insert a new blank Playlist item above the
currently selected item. The newly inserted line will become selected.
The button is disabled if the maximum number of 400 Playlist items in the
Playlist is reached.
Remove Item: The button is enabled when one or more Playlist items
are selected in the Playlist. Click the button to remove the selected
Playlist items from the Playlist. Removing an item removes the item’s
results from the results table and invalidates any report items for the
removed Playlist item. If the item is currently open, the Workspace will be
cleared.
Move Up: Click the button to move the currently selected items one
position up in the Playlist. If multiple Playlist items are selected, they will
be grouped together and then moved.
Move Down: Click the button to move the currently selected items one
position down in the Playlist. If multiple Playlist items are selected, they
will be grouped together and then moved.
Float/Dock: Clicking the Float button undocks the Playlist pane. The
Playlist pane can then be relocated as required (see chapter 12.2 Views
of the software window on page 52). The button changes its name to
Dock. Clicking the Dock button resets the Playlist pane to the previous
docked position.
Playlist columns
The rows of the Playlist represent the Playlist items. Each Playlist item
comprises a listmode file (FCS file) with associated Workspace and
compensation files.
The "Use Listmode" option is enabled if the listmode file is a CyFlow® file
with an embedded Workspace. Selecting this option restores the
embedded Workspace for the selected file.
Compensation: In this submenu, options are provided to replace, save,
copy and paste the compensation file or to use the listmode
compensation settings. The functionality of these submenu items is the
same as in the Compensation group in the Playlist tab of the Ribbon (see
chapter 12.4.9 Playlist tab on page 100).
New Playlist: Click the menu item to create a new Playlist. The
functionality is the same as in the File tab of the Ribbon.
Open Playlist: Click the menu item to open an existing Playlist. The
functionality is the same as in the File tab of the Ribbon.
Save Playlist As: Click the menu item to save the current Playlist with a
new name. The functionality is the same as in the File tab of the Ribbon.
12.8 Workspace
In the Workspace area of the software window, the Workspace of the
currently active Playlist item or Worklist item is displayed and can be edited.
A Workspace includes plots, regions, gates, colour precedence, selected
statistics and displayed parameters. A Workspace can be saved as a
Workspace file.
The Workspace contains four tabs:
The Plots tab contains two areas: Plots and Previews. The Previews area
automatically displays plots once a listmode file is opened. Plots can be
added to the Plots area as required for further analysis. The Plots tab is
open by default.
The Results tab displays the statistics selected in the Statistics tab of the
Ribbon.
The Overlays tab allows the creation of single and dual parameter
overlay plots.
The Reports tab allows you to create and modify reports.
Types of plots
The software can display four plot types:
Single Parameter Histogram Plots display the 1024 bin histogram for a
single parameter. The plot may be gated or ungated.
Dual Parameter Colour Density Plots are two dimensional 256 x 256
bin histograms which use colour to represent the level of events within
each bin. An algorithm is used to calculate the levels based on the
number of events. The levels have logarithmic intervals.
Six levels of colour are used for the Density Plots: Black for outlier
singles and, in order of increasing density: blue (lowest density), green,
yellow, orange and red (highest density).
Dual Parameter Colour Precedence Plots are two dimensional 256 x
256 bin dot plots which use colour to represent the gating events that fall
within specific gates. Where an event may be in multiple gates, the
precedence order determines which colour is chosen. Where events from
multiple gates fall within a single bin, the highest precedence gate colour
is chosen. Ungated events are displayed black. Precedence order can be
changed via the Precedence order dialogue (see chapter Gate group on
page 69).
Dual Parameter Precedence Density Plots are displayed as colour
precedence plots but include density information as well as colour
precedence.
Properties of individual plots, including changing of the plot type, can be
modified using the Plot Format tab of the Ribbon (see chapter 12.4.14 Plot
Format tab on page 124).
1 + button
Selecting plots
Selected plots are surrounded by a blue selection rectangle.
The following options are available:
To select a single plot within the Plots area, click on the plot.
To select or deselect multiple plots, hold Ctrl while clicking on plots.
Plots may also be selected by dragging out a selection rectangle around
the desired plots. The rectangle selects everything it touches. Ctrl
dragging a selection area around plots will toggle that selection of the
plots.
To select all plots, press the Ctrl + A keys.
Plot selection options are also available from the Edit group on the
Analyze tab of the Ribbon (see chapter Edit group on page 73).
On selecting a plot, the Plot Format tab becomes available on the Ribbon
providing options to edit type, gating and axis scales of plots and to set
histogram smoothing (see chapter 12.4.14 Plot Format tab on page 124).
Resizing plots
For resizing plots, select the Resize Plots or Resize Previews button from
the status bar and use the resize slider on the status bar to adjust the size of
the plots (see chapter Resize options on page 186).
If a mouse with a central wheel is used, plots can also be resized by
selecting plots and pressing the Ctrl key while scrolling the mouse wheel.
The following options for editing plots in the Plots area are provided:
Editing the Plot Title: To customise the title of a plot, double-click in the
top margin of the plot and enter a custom title into the edit field. The title
is added to the heading of the plot.
Moving Plots: Plots can be rearranged within the Plots area by dragging
and dropping. A vertical blue insert cursor highlights the new location of
the plots. When multiple plots are selected and dragged, they are
grouped together and moved as a group. After they are released, they
remain together. The plots displayed in the hierarchy view cannot be
moved.
Deleting Plots: Plots may be removed from the Plots area by selecting
them and pressing the Delete key. Selected plots can also be deleted
using the Delete button in the Edit group on the Analyze tab.
If the deleted plot has a region applied, deleting the plot also deletes the
region and removes the region from any gating logic. In this case, a
corresponding warning message is displayed and you will have the
option to cancel deleting the plot.
Creating regions
Regions can be defined on single or dual parameter plots. The maximum
number of regions that can be created in a Workspace is 256. Quadrant
regions are not included in this count.
Regions are created using the buttons in the Region group on the Home tab
(see chapter Region group on page 65) or on the Analyze tab (see chapter
Region group on page 68).
To create a region on a plot, click the required region type button. The button
is highlighted. Then either click on a plot to set the region at the default size,
or draw out the required region size on the desired plot.
To cancel the creation of a region, press the Esc key before or during the
dragging of that region.
Once the maximum number of 256 regions is reached, the buttons in the
Region group become disabled.
Only one region can be drawn per button selection for the Elliptical,
Rectangular and Polygonal region types. Linear regions can be applied to
multiple selected single parameter plots by pressing the Ctrl key while
clicking to add the region. Quadrant regions can be applied to multiple
selected dual parameter plots by pressing the Ctrl key while clicking to add
the region.
To create a region on a plot, first click the required region type button on the
Home tab or the Analyze tab. Five region types can be created:
Elliptical Region: Click the region type button. Then either click on a
dual parameter plot to set an ellipse of the default size, or draw out the
required ellipse on the desired plot.
Rectangular Region: Click the region type button. Then either click on a
dual parameter plot to set a rectangle of the default size, or draw out the
required rectangle on the desired plot.
Polygonal Region: Click the region type button. Click onto a dual
parameter plot to determine the first point of the region. Then click on the
plot to add additional points to the polygon. The polygon is then
completed by clicking on the start point. If there are at least three points,
the polygon is also completed by right-clicking (which will complete the
polygon by adding a line from the last to first point). Double-clicking on a
line inserts a new point which can then be moved to create a modified
region.
Linear Region: Click the region type button. Then either click on a single
parameter plot to set a default sized linear region, centred on the point
where the plot was clicked. Alternatively click onto a single parameter
plot and drag out a line to determine the region size. The same linear
region can be applied to multiple selected single parameter plots by
pressing the Ctrl key while clicking to add the region.
Quadrant Region: Quadrant regions are formed from two divider lines
(one vertical, one horizontal). Click the Quadrant Region button, and then
click onto a dual parameter plot at the point on the plot where you wish
the quadrant’s intercept to appear. By hovering the cursor over the
quadrant intercept, a statistic is displayed for each quadrant. The same
quadrant region can be applied to multiple selected dual parameter plots
by pressing the Ctrl key while clicking to add the region.
When a broad distribution of events is observed, you may need to create
non-linear quadrant dividers. The control point on the right and top can
be used to move the horizontal and vertical dividers respectively to a
higher channel than the intercept point, creating a "Bendy Quad" region.
If the "Bent" divider is moved to a lower value than the intercept point, the
divider returns to its straight form.
Editing regions
On selecting a region, the Region Format tab becomes available on the
Ribbon providing options to edit region name and colour, region type and
position and to link regions (see chapter 12.4.15 Region Format tab on
page 128).
Additionally, the region orientation, size and position can be edited by
selecting a region on a plot and dragging the handles displayed on the
selected region, as indicated by the cursor.
The region can be moved by selecting between the handles, as indicated by
the move cursor, then dragging the region to a new position.
If you change the region size or position unintentionally, click the Undo
button in the Quick Access Toolbar to restore the previous size or position.
The options for the different region types are:
Ellipse: Elliptical regions have four control points that will be displayed
when you click on a region to select it. You can use these control points
to resize, rotate and move the elliptical region. While an elliptical region is
being moved or resized, the coordinates of the centre, the axes length
and the rotation angle in degrees are displayed.
Rectangle: Rectangular regions have eight control points that will be
displayed when you click on a region to select it. You can use these
Deleting regions
To delete a region, select it and press the Delete key or the Delete button in
the Edit group on the Analyze tab. If deleting a region affects gating logic, a
warning message will be displayed and you will have the option to cancel
deleting the region.
Region names
Once a region has been created, a unique name for the region is
automatically generated. The region name and associated statistic are
displayed adjacent to the region on the plot. The size of the text is
auto-adjusted. The associated statistic is not displayed if there is not enough
space. If the name is too long to fit on the plot, it is not displayed. By
hovering the cursor over the region, a tooltip is displayed stating the name
and the statistic associated with that region.
If a statistical value cannot be calculated, "ERROR" will be displayed instead
of a numerical value.
To change the automatically assigned name, select the region and
double-click on the region name on the plot. An edit field appears. Enter a
name or select a name from the drop-down list. The drop-down list is
populated with the names provided on the Region page in the software
options (see chapter Region page on page 188).
The region name can also be changed from the Appearance group of the
Region Format tab (see chapter Appearance group on page 128).
The region name can be repositioned but cannot be dragged outside the
plot.
Region colour
When a region is created (except for quadrant regions), it is automatically
assigned a colour. There is a set of ten predefined region colours within the
software.
The region colour can be changed in the Region group of the Home tab (see
chapter Region group on page 65) or from the Region Format tab (see
chapter Appearance group on page 128).
Scaling
For high-resolution data files, a parameter can be displayed in three different
formats: linear, logarithmic and V-Log. This is selectable from the Home tab
(see chapter Parameters group on page 66) or from the Plot Format tab
(see chapter X-Axis group on page 125).
The scaling of parameters can be customised in a number of ways using the
scaling and zoom options available in the Scales group of the Parameters
tab (see chapter Scales group on page 80).
If you change the zoom status on a plot with a region, the region position
does not change. You may need to reposition any regions set on zoomed
parameters.
Plots added to the Plots area will display their scales on the X and Y axes.
Fluorescence parameters default to Log scaling. Scatter or other parameters
default to Lin scaling.
The scaling options are:
Linear Scales: Linear scaled parameters display linear tick marks and
numbering. The default values are determined from information in the
LMD file. Linear scaled data always starts at 0. The minimum and
maximum values are always displayed at the ends of the scale.
Log Scales: Logarithmic scaled parameters display logarithmic tick
marks and numbering. The default values are determined from
information in the LMD file. When no scaling information is available in
the opened LMD file nor in the Workspace, the scaling is determined by
the values found in the Scaling page of the software options (see chapter
Scaling page on page 189).
V-Log Scales: V-Log scaled parameters display a combination of linear
and logarithmic sections. Linear tick marks are displayed around the
origin and logarithmic tick marks are displayed towards the end of a
scale. When V-Log is selected, the full range of data is displayed.
To toggle between zoomed and unzoomed displays:
If one or more of the parameters associated with the plot have
non-default zoom settings, a Plot Zoom Toggle button is displayed on
the top left corner of the plot. Click the button to toggle between the
zoomed and unzoomed view of the plot.
Alternatively, use the Display zoomed button on the Parameters tab of
the Ribbon.
The three phases of the DNA cell cycle are coloured on the cell cycle plot as
follows:
Red: Denotes the G0/G1 phase,
Blue: Denotes the S phase,
Green: Denotes the G2/M phase.
Additional regions cannot be applied to the cell cycle plot.
The following markers are displayed on the plot:
Blue Markers are debris markers allowing to set noise thresholds and to
exclude cellular debris. Events that occur below or above these noise
markers will be presented on the plot, but not analysed by the software.
The Red Marker marks the estimated mean channel of the G0/G1 peak.
The Green Marker marks the estimated mean channel of the G2/M
peak.
If the calculated phases are not as expected, the G0/G1 and/or G2/M
estimates can be adjusted by clicking on the marker and dragging/dropping it
to the desired position to generate a successful fit for the DNA cycle. The
estimate markers cannot be crossed over. The markers can only be moved
to within 10 channels (based on a 1024 channel histogram) from each other.
Noise markers cannot be moved outside the limits of the histogram.
Moving any of the markers triggers recalculation on the DNA cell cycle plot.
When the noise markers are moved, the automatically estimated G1/G0 and
G2/M peak values will be used. When the G0/G1 and/or G2/M are moved,
the adjusted values of these markers will be used.
Following a manual adjustment of the estimates, you can return the
calculated estimates to their original calculated positions. Click the Reset
Cell Cycle button on the Plot Format tab of the Ribbon to reset the cell cycle
with the automatically calculated G0/G1 and G2/M position estimates.
In the Results tab of the Workspace, a results table is displayed. Here, you
can view statistics associated with the current Playlist or the current Worklist
pane. You can copy statistics for use in other applications, export statistics to
CSV and XML files and print statistics using the options on the File tab of the
Ribbon.
When you switch to the Results tab of the Workspace, the Ribbon
automatically switches to its Statistics tab providing the options to select the
statistics for the results table.
To select all rows from the currently selected one to the end of the table,
press Ctrl + Shift + End.
To select all rows from the currently selected one to the beginning of the
table, press Ctrl + Shift + Home.
In the Overlays tab of the Workspace, you can create overlay plots of single
or dual parameter plots. Overlay plots can be used to compare plots.
In Playlist mode, there is an overlay Workspace per Playlist. In Worklist
mode, there is an overlay Workspace per panel.
On selecting the Overlays tab in the Workspace, a blank area is displayed.
The Overlay tab of the Ribbon automatically becomes active providing
options to edit the overlay Workspace (see chapter 12.4.11 Overlay tab on
page 109).
Overlay plots are created by sending plots from the Plots tab of the
Workspace to the Overlays tab.
In Playlist mode, you can also use the Overlay Wizard on the Overlay tab of
the Ribbon to create overlay plots.
Each overlay consists of an overlay plot and an associated gallery of its
source plots. An overlay can contain a maximum of 400 source plots.
The Overlays tab of the Workspace consists of two areas:
The Overlays area displays a 2D or 3D view of available overlay plots.
The Galleries area displays the individual source plots that make up the
overlay plots. For each overlay plot, a gallery of individual plots is
displayed with the name of the overlay plot as a title.
Plot views
If zoom and scale settings exist in the plot from the Plots area, these will be
persisted in the overlay plots.
If any of the source plots are unavailable after the associated item has been
processed, an exclamation mark will be displayed on the overlay plot in front
of all other successfully calculated data sources within the overlay.
If background calculation is turned off, a warning icon will be displayed in the
bottom right-hand corner of any overlay plot that contains a source plot in an
unknown state. Hovering over it will display a tooltip indicating that
background calculation needs to be turned on.
Overlay plots can be displayed in 3D using the 3D Mode button on the
Overlay Format tab of the Ribbon (see chapter Overlays group on
page 133). In 3D mode, plots are displayed as three-dimensional at a
specified angle and will be equally distributed. The plot can be rotated using
the Angle (deg.) button on the Overlay Format tab of the Ribbon.
Selecting plots
Selected plots are surrounded by a blue selection rectangle.
If an overlay plot is selected in the Overlays area, the associated title in the
Galleries area is also highlighted.
In the Galleries area, plots from only one gallery can be selected at a time.
The following options are available:
To select a single plot within the Overlays area or Galleries area, click on
the plot.
To select or deselect multiple plots, hold Ctrl while clicking on plots.
Plots may also be selected by dragging out a selection rectangle around
the desired plots. The rectangle selects everything it touches. Ctrl
dragging a selection area around plots will toggle that selection of the
plots.
To select all plots, press the Ctrl + A keys.
On selecting an overlay plot, the Overlay Format tab becomes available on
the Ribbon providing options to change the format of all plots that are
available to that overlay plot (see chapter 12.4.16 Overlay Format tab on
page 131).
Reordering plots
Selected plots can be reordered within the Overlays area or the Galleries
area by drag and drop. Changing the order of the overlay plots will also
change the order of the associated galleries.
When changing the order of individual plots in the Galleries area, the plots
will be displayed on the overlay plot in that new order.
To define a control plot, select the plot from the Galleries area and right-click
to open the context menu.
The following options are available:
Set as Control Plot is available when a single gallery plot is selected.
Select the option to display the plot as a control on all gallery plots of the
current overlay plot. The gallery plot set as a control displays a dashed
border.
If a control plot is already set, selecting another plot as a control will
replace the currently set control with the new selection on all plots within
the gallery.
Remove Control Plot is available when a plot is set as a control for the
gallery. This option removes the control plot from all plots in the gallery.
Control in Front is available when a plot is set as a control for the
current gallery. Select this option to display the control plot in front of the
plot data. Deselect the option to display the control plot in the
background of the plot data.
Alternatively, the buttons in the Controls group of the Overlay Format tab of
the Ribbon can be used (see chapter Controls group on page 134).
Moving and copying plots from the Galleries area to an overlay plot
To add plots to an overlay plot from the Galleries area, select the plot(s) from
the Galleries area and right-click to open the context menu.
The following options are available:
Move selected Plot(s) to Overlay Plot moves the currently selected
plots to a new selected overlay plot. If all of the selected plots already
exist in an overlay plot, that overlay plot is greyed out in the list. If some
of the selected plots already exist in the target overlay plot, any new plots
will be added but all selected plots will be removed from the current plot.
Copy selected Plot(s) to Overlay Plot takes a copy of the selected
plots and adds them to a new selected overlay plot. If all of the selected
plots already exist in an overlay plot, that overlay plot is greyed out in the
list. If some of the selected plots already exist in the target overlay plot,
any new plots will be added but existing plots will not be added to the
target overlay plot.
In the Reports tab of the Workspace, you can create page-based reports
from a Playlist or from a panel of a Worklist. Reports can be used to create a
customised page-based summary of plots, statistics and other information. A
report can comprise up to 800 pages.
In Playlist mode, there is a single report per Playlist. In Worklist mode, there
is a single report per panel of the Worklist.
On selecting the Reports tab in the Workspace, a blank report page is
displayed. The Report tab of the Ribbon automatically becomes active
providing options to edit the report (see chapter 12.4.12 Report tab on
page 114).
Reports are created by inserting objects into the report page. Objects can be
inserted via the Insert group on the Report tab of the Ribbon or sent to the
report from the Plots tab of the Workspace.
In Playlist mode, you can also use the Report Wizard on the Report tab of
the Ribbon to create reports.
context menu and select whether to send the selected plot(s) and/or their
associated statistics to the report. If the last page of the report contains
any objects, sent objects start on a new blank page in the report. If the
last page is blank, sent objects start on this page.
Results tables from the Results tab of the Workspace can be inserted by
clicking the Send Table To button on the Statistics tab of the Ribbon.
FCS file information can be inserted from the FCS File Information pane
using the Send To Report... button.
Moving objects
Moving the cursor over an object on a report page will change the cursor to a
move icon. The object can then be dragged and dropped to new locations
within the pages of a report. If objects are selected within different sections
(header, footer, body) or different pages, the move cursor is not displayed
and objects cannot be moved.
Objects can be moved between the header, footer and body sections of a
page and are subject to bounds checks. If an object (or group of objects) is
too big to fit in the new section, a "no entry" sign is displayed. Trying to drop
the object will move the object back to its original position on the page.
Resizing objects
When an object is selected on a report page, it can be resized using the
resize handles. When resizing an object, it is bounds checked to its current
section on the page and cannot be resized outside of these bounds.
The options for resizing objects are:
Moving the cursor over one of the handles will change the cursor to a
double-headed arrow indicating which way the object will be resized.
The aspect ratio of a plot is fixed and is always square.
When moving corners of images, their aspect ratio is maintained.
When moving corners, the aspect ratio of the statistics box,
compensation matrix, text box and field is not fixed, i.e. it can be
stretched horizontally or vertically.
For all objects, holding Shift whilst resizing using a corner handle will
maintain the aspect ratio.
When moving the top or bottom centre of the statistics box,
compensation matrix, text box, field and image, its height can be resized.
When moving the right or left middle of the statistics box, compensation
matrix, text box, field and image, its width can be resized.
The options for resizing lines are:
Moving the cursor over either handle will change the cursor to a
crosshair, indicating the handle can be moved in any direction.
To resize or change orientation of the line, drag either of the handles.
The line can be dragged to any size and orientation around 360 degrees.
The line is limited to the current section on the page.
To fix the position of a line to horizontal and vertical positions, hold the
Shift key and drag the handle. To relocate the line to its new position,
first release the mouse and then let go of the Shift key.
Deleting objects
To delete an object from the report, select it and press the Delete key or the
Delete button in the Edit group of the Report tab of the Ribbon.
1 2 3 4 5 6 7 8
Calculation indicator
The Calculation indicator indicates if the processing of results has been
completed:
When all items are up to date, a green icon is displayed.
When background calculation is in progress, an orange icon is displayed.
When background calculation is off and some items have not been
calculated, a red icon is displayed. This icon acts as a button. Clicking it
is equivalent to clicking the Calculate Now button of the Playlist tab of
the Ribbon and will recalculate all results.
Miscellaneous messages
In this area of the status bar, the following messages are displayed:
Ribbon controls: For each Ribbon control, a status bar message is
displayed describing the function of the control.
Window controls: For the Quick Access Toolbar icons and the File menu
options, a status bar message is displayed describing the function of the
option.
Print preview: When the print preview is displayed, the status bar will
show the current displayed page or page range.
Region coordinates display: When a control point of a region on a plot is
moved, the coordinates of the region are displayed.
Cell cycle analysis: While a noise threshold estimate marker is being
repositioned, information regarding the noise threshold, G1 and G2
estimates and the upper noise threshold is displayed.
Device functions or fluid level errors: During a device function, a status
bar message stating the name of the function currently being performed
will be displayed. If a fluid level error occurs, the appropriate error
message is displayed.
Status of acquisition
During acquiring, the current status of the acquisition process is displayed:
Part displays the absolute number of particles recorded.
Part/S displays the rate of measurement in particles per second.
µL displays the absolute volume.
Sec displays the absolute time.
If a stop condition is in use, a progress bar under the relevant counter(s) will
be displayed.
On change of fluid level status, a warning balloon will be displayed above the
status bar icon. When the sheath fluid bottle is empty or the waste bottle is
full, a warning balloon pops up automatically, to signalise the critical fluid
level. If the device is measuring a sample when a fluid level error occurs, a
timer will start, and you will be allowed to continue acquiring the current
sample for up to 10 minutes. If the error condition is not corrected, the
warning balloon will be redisplayed at 5 minutes remaining, 3 minutes,
2 minutes and 1 minute remaining. After that, acquisition will automatically
be stopped and the appropriate fluid level error message displayed
If an instrument function is not taking place and a sheath or waste level error
is detected, the fluid level error message is displayed immediately. If any
other instrument function is taking place, that function will be allowed to
complete and the error displayed at completion.
Resize options
1 2 3 4
5
1 Resize Plots button 4 Resize Galleries button
2 Resize Previews button 5 Resize slider
3 Resize Overlays button
To resize plots displayed in the Workspace, first select the type of plots to
resize using the plot type buttons:
Resize Plots (enabled in the Plots tab of the Workspace),
Resize Previews (enabled in the Plots tab of the Workspace),
Resize Overlays (enabled in the Overlays tab of the Workspace),
Resize Galleries (enabled in the Overlays tab of the Workspace).
Then use the resize slider to adjust the size of items as required. Move the
slider to the desired position or click to the left or right of the slider to
decrease or increase the size of the selected plot type, respectively.
General page
The General page contains options to specify how statistics displayed on
plots are to be rounded and to set the default colours used for regions,
gates, overlay plot histograms and histogram plots.
Quadrant Color: The box displays the default colour for the quadrant
divider lines and is used when quadrant regions are created. This will not
affect the colour of quadrant gates. The default colour is Grey-40%. To
edit, click the arrow and select a colour. The colours of previously
created quadrant divider lines are not changed.
Click the Reset to Default button to return the quadrant region colour to
its default setting.
Histogram Color: The box displays the colour for histograms displayed
in the Plots area. The default colour is coloured Gray-25%. To edit, click
the arrow and select a colour.
Click the Reset to Default button to return the histogram colour to its
default setting.
Precedence Ungated Event Color: The box displays the colour for
ungated events on precedence plots. The default colour is black. To edit,
click the arrow and select a colour.
Click the Reset to Default button to return the ungated event colour to its
default setting.
Use small plot gate color indicator: This option is checked by default.
When checked, the gate colour indication present on the plot is reduced
to a 3D colour circle in the top right-hand corner of the plot. When
unchecked, the plot border will be a gradient fill based on the plot gate
colour.
Display Ungated Plot Stats: This option is unchecked by default.
Selecting the check box will display plot gate statistics in all results
tables.
Region page
The Region page contains options to specify the available default region
names.
Scaling page
The Scaling page contains options to specify the default options used for
Log and V-Log scaling. The setting here is only used if there is no
Workspace file or if the open Workspace file and the current listmode file do
not contain any defined scaling. As soon as a Workspace or listmode file
which contains scaling values is opened, those values are used instead of
the default values.
V-Log Linearity (%) and V-Log Negative Section (%): These options
allow you to select the default values for scaling of V-Log parameters.
The accepted range is between 0 and 100%. To edit, enter a value or
use the up/down arrows.
The values entered here will be the default values displayed in the
Default Scaling tab of the Scales Properties dialogue (see chapter
Scales Properties dialogue on page 81). The V-Log group is disabled for
low-resolution data (i.e. less than 12 bits).
Reset to Default: Click the button to return the scaling options to their
default settings.
Export page
The Export page contains options to specify how results are to be exported
to CSV files and to specify default options used when images are exported.
Font pages
There are six Font pages containing options to select the default font
typeface and size of text displayed in the Workspace. On the right of each
page, a preview plot is displayed.
Resources page
The Resources page contains options to access license and software
version information.
12.11
Index
G M
maintenance 44
gallery view 162
manual compensation, performing 35
gate 168
Edit Gates dialogue 71 measurement 27
stopping 34
H troubleshooting 41
hazard levels, warnings 7
O
hierarchy view 162
On switch 14
Home tab 65
Overlay Format tab 131
humidity 47
overlay plot 174
hypochlorite solution 21 3D view 175
creating 175
I selecting a control plot 178
indicator Overlay tab (Ribbon) 109
calculation 184
Overlay Wizard 109
compensation 184
fluid levels 184 Overlays tab of the Workspace 174
inline filter 19 overview 14
installation 23
P
instrument configuration 191
pane 50, 136
instrument settings Acquire 140
adapting during a measurement 33 displaying / hiding 52
presetting for new measurement 32 FCS File Information 137
saving 35 Playlist 154
positioning 54
intended use 9
Results Hierarchy 138
intermediate cleaning 28 Settings 139
Setup 143
L Stops 144
Worklist 146
laser 13
output 48 panes, visibility 123
liability 8
T user administrator 25
tab (Ribbon) user management 25, 63
Analyze 68
user roles 25
Compensation 84
Cytometer 105
File 58 V
Home 65 Views tab 123
Overlay 109
Overlay Format 131 W
Parameters 76
warnings
Playlist 100
hazard levels 7
Plot Format 124
signal words 7
Preview 74
Region Format 128 waste bottle 17, 19
Report 114 order no. 21
Statistics 92
waste level indicator 184
Views 123
Worklist 97 Wizard
Compensation 84
tab (Workspace)
Overlay 109
Overlays 174
Report 114
Plots 160
Reports 179 Worklist 146
Results 171 buttons 146
context menu 151
technical data 46
creating 31
temperature 47 defining for future measurements 36
preparing measurements 30
transport 22
rows and columns 147
troubleshooting saving 36
calibration bead measurement 41
Worklist mode 30, 50
count check bead measurement 41
data acquisition 41 Worklist pane 50, 146
de-bubble procedure 39
Worklist tab 97
de-clog procedure 39
noisy sound 41 Workspace 50, 160
sample flow too low / too high 40 defining 31
modifying 101
True Volumetric Absolute Counting 145
Overlays tab 174
TVAC 145 Plots tab 160
Reports tab 179
type plate 18
Results tab 171
saving 35
U
use
intended 9
prohibited 9