cytoflow package#
cytoflow#
cytoflow is a package for quantitative, reproducible analysis of flow
cytometry data.
Written by Brian Teague, bpteague@gmail.com
Copyright Massachusetts Institute of Technology 2015-2018
Copyright Brian Teague 2018-2025
Subpackages#
- cytoflow.operations package
- cytoflow.operations
- Submodules
- cytoflow.operations.autofluorescence
AutofluorescenceOpAutofluorescenceDiagnosticView- cytoflow.operations.base_op_views
OpViewOp1DViewOp2DViewByViewBy1DViewBy2DViewNullViewAnnotatingView- cytoflow.operations.bead_calibration
BeadCalibrationOpBeadCalibrationOp.unitsBeadCalibrationOp.beads_fileBeadCalibrationOp.beadsBeadCalibrationOp.bead_peak_quantileBeadCalibrationOp.bead_brightness_thresholdBeadCalibrationOp.bead_brightness_cutoffBeadCalibrationOp.bead_histogram_binsBeadCalibrationOp.force_linearBeadCalibrationOp.estimate()BeadCalibrationOp.apply()BeadCalibrationOp.default_view()BeadCalibrationOp.BEADS
BeadCalibrationDiagnostic- cytoflow.operations.binning
BinningOpBinningView- cytoflow.operations.bleedthrough_linear
BleedthroughLinearOpBleedthroughLinearDiagnostic- cytoflow.operations.category
CategoryOp- cytoflow.operations.centroid
- cytoflow.operations.channel_stat
ChannelStatisticOp- cytoflow.operations.color_translation
ColorTranslationOpColorTranslationDiagnostic- cytoflow.operations.density
DensityGateOpDensityGateOp.nameDensityGateOp.xchannelDensityGateOp.ychannelDensityGateOp.xscaleDensityGateOp.yscaleDensityGateOp.keepDensityGateOp.binsDensityGateOp.min_quantileDensityGateOp.max_quantileDensityGateOp.sigmaDensityGateOp.byDensityGateOp.estimate()DensityGateOp.apply()DensityGateOp.default_view()
DensityGateView- cytoflow.operations.flowclean
FlowCleanOpFlowCleanOp.nameFlowCleanOp.time_channelFlowCleanOp.channelsFlowCleanOp.scaleFlowCleanOp.segment_sizeFlowCleanOp.density_cutoffFlowCleanOp.max_discontinuityFlowCleanOp.max_driftFlowCleanOp.max_mean_driftFlowCleanOp.segment_cutoffFlowCleanOp.detect_worst_channels_rangeFlowCleanOp.detect_worst_channels_sdFlowCleanOp.measuresFlowCleanOp.dont_cleanFlowCleanOp.force_cleanFlowCleanOp.tube_statusFlowCleanOp.tube_statisticsFlowCleanOp.estimate()FlowCleanOp.apply()FlowCleanOp.default_view()
FlowCleanDiagnostic- cytoflow.operations.flowpeaks
FlowPeaksOpFlowPeaks1DViewFlowPeaks2DViewFlowPeaks2DView.facetsFlowPeaks2DView.byFlowPeaks2DView.xchannelFlowPeaks2DView.ychannelFlowPeaks2DView.xscaleFlowPeaks2DView.yscaleFlowPeaks2DView.opFlowPeaks2DView.huechannelFlowPeaks2DView.subsetFlowPeaks2DView.xfacetFlowPeaks2DView.yfacetFlowPeaks2DView.huefacetFlowPeaks2DView.huescaleFlowPeaks2DView.plot()
FlowPeaks2DDensityViewFlowPeaks2DDensityView.facetsFlowPeaks2DDensityView.byFlowPeaks2DDensityView.xchannelFlowPeaks2DDensityView.ychannelFlowPeaks2DDensityView.xscaleFlowPeaks2DDensityView.yscaleFlowPeaks2DDensityView.opFlowPeaks2DDensityView.subsetFlowPeaks2DDensityView.xfacetFlowPeaks2DDensityView.yfacetFlowPeaks2DDensityView.huefacetFlowPeaks2DDensityView.huescaleFlowPeaks2DDensityView.plot()
- cytoflow.operations.frame_stat
FrameStatisticOp- cytoflow.operations.gaussian
GaussianMixtureOpGaussianMixture1DViewGaussianMixture1DView.facetsGaussianMixture1DView.byGaussianMixture1DView.channelGaussianMixture1DView.scaleGaussianMixture1DView.opGaussianMixture1DView.subsetGaussianMixture1DView.xfacetGaussianMixture1DView.yfacetGaussianMixture1DView.huefacetGaussianMixture1DView.huescaleGaussianMixture1DView.plot()
poly_area()GaussianMixture2DViewGaussianMixture2DView.facetsGaussianMixture2DView.byGaussianMixture2DView.xchannelGaussianMixture2DView.ychannelGaussianMixture2DView.xscaleGaussianMixture2DView.yscaleGaussianMixture2DView.opGaussianMixture2DView.huechannelGaussianMixture2DView.subsetGaussianMixture2DView.xfacetGaussianMixture2DView.yfacetGaussianMixture2DView.huefacetGaussianMixture2DView.huescaleGaussianMixture2DView.plot()
- cytoflow.operations.hierarchy
HierarchyOp- cytoflow.operations.i_operation
IOperation- cytoflow.operations.import_op
TubeImportOpcheck_tube()autodetect_name_metadata()parse_tube()- cytoflow.operations.kmeans
KMeansOpKMeans1DViewKMeans2DView- cytoflow.operations.mst
ConditionSelectionOpMSTOpMSTSelectionViewMSTSelectionView.opMSTSelectionView.statisticMSTSelectionView.locationsMSTSelectionView.locations_levelMSTSelectionView.locations_featuresMSTSelectionView.variableMSTSelectionView.featureMSTSelectionView.styleMSTSelectionView.scaleMSTSelectionView.size_functionMSTSelectionView.metricMSTSelectionView.subsetMSTSelectionView.plot()
- cytoflow.operations.pca
PCAOp- cytoflow.operations.polygon
PolygonOpScatterplotPolygonSelectionViewScatterplotPolygonSelectionView.interactiveScatterplotPolygonSelectionView.xchannelScatterplotPolygonSelectionView.ychannelScatterplotPolygonSelectionView.xscaleScatterplotPolygonSelectionView.yscaleScatterplotPolygonSelectionView.opScatterplotPolygonSelectionView.huechannelScatterplotPolygonSelectionView.subsetScatterplotPolygonSelectionView.xfacetScatterplotPolygonSelectionView.yfacetScatterplotPolygonSelectionView.huefacetScatterplotPolygonSelectionView.huescaleScatterplotPolygonSelectionView.plot()
DensityPolygonSelectionViewDensityPolygonSelectionView.interactiveDensityPolygonSelectionView.xchannelDensityPolygonSelectionView.ychannelDensityPolygonSelectionView.xscaleDensityPolygonSelectionView.yscaleDensityPolygonSelectionView.opDensityPolygonSelectionView.huefacetDensityPolygonSelectionView.subsetDensityPolygonSelectionView.xfacetDensityPolygonSelectionView.yfacetDensityPolygonSelectionView.huescaleDensityPolygonSelectionView.plot()
- cytoflow.operations.quad
QuadOpScatterplotQuadSelectionViewScatterplotQuadSelectionView.interactiveScatterplotQuadSelectionView.xchannelScatterplotQuadSelectionView.ychannelScatterplotQuadSelectionView.xscaleScatterplotQuadSelectionView.yscaleScatterplotQuadSelectionView.opScatterplotQuadSelectionView.huechannelScatterplotQuadSelectionView.subsetScatterplotQuadSelectionView.xfacetScatterplotQuadSelectionView.yfacetScatterplotQuadSelectionView.huefacetScatterplotQuadSelectionView.huescaleScatterplotQuadSelectionView.plot()
DensityQuadSelectionViewDensityQuadSelectionView.interactiveDensityQuadSelectionView.xchannelDensityQuadSelectionView.ychannelDensityQuadSelectionView.xscaleDensityQuadSelectionView.yscaleDensityQuadSelectionView.opDensityQuadSelectionView.huefacetDensityQuadSelectionView.subsetDensityQuadSelectionView.xfacetDensityQuadSelectionView.yfacetDensityQuadSelectionView.huescaleDensityQuadSelectionView.plot()
- cytoflow.operations.range
RangeOpRangeSelection- cytoflow.operations.range2d
Range2DOpScatterplotRangeSelection2DViewScatterplotRangeSelection2DView.interactiveScatterplotRangeSelection2DView.xchannelScatterplotRangeSelection2DView.ychannelScatterplotRangeSelection2DView.xscaleScatterplotRangeSelection2DView.yscaleScatterplotRangeSelection2DView.opScatterplotRangeSelection2DView.huechannelScatterplotRangeSelection2DView.subsetScatterplotRangeSelection2DView.xfacetScatterplotRangeSelection2DView.yfacetScatterplotRangeSelection2DView.huefacetScatterplotRangeSelection2DView.huescale
DensityRangeSelection2DViewDensityRangeSelection2DView.interactiveDensityRangeSelection2DView.xchannelDensityRangeSelection2DView.ychannelDensityRangeSelection2DView.xscaleDensityRangeSelection2DView.yscaleDensityRangeSelection2DView.opDensityRangeSelection2DView.huefacetDensityRangeSelection2DView.subsetDensityRangeSelection2DView.xfacetDensityRangeSelection2DView.yfacetDensityRangeSelection2DView.huescale
- cytoflow.operations.ratio
RatioOp- cytoflow.operations.register
RegistrationOpRegistrationDiagnosticView- cytoflow.operations.som
SOMOpSOMOp.nameSOMOp.channelsSOMOp.scaleSOMOp.consensus_clusterSOMOp.num_iterationsSOMOp.bySOMOp.sampleSOMOp.widthSOMOp.heightSOMOp.distanceSOMOp.learning_rateSOMOp.sigmaSOMOp.min_clustersSOMOp.max_clustersSOMOp.n_resamplesSOMOp.resample_fracSOMOp.StatisticsSOMOp.estimate()SOMOp.update_consensus_clusters()SOMOp.apply()SOMOp.default_view()
SOMDiagnosticView- cytoflow.operations.threshold
ThresholdOpThresholdSelection- cytoflow.operations.tsne
tSNEOp- cytoflow.operations.xform_stat
TransformStatisticOp
- cytoflow.scripts package
- cytoflow.utility package
- cytoflow.utility
IterByWrapper- Submodules
- cytoflow.utility.algorithms
ci()percentiles()bootstrap()is_inside_sm()polygon_contains()resample()compute_connectivity_matrix()compute_identity_matrix()compute_consensus_matrix()valid_clustering_obj()cluster()ConsensusClusteringConsensusClustering.cluster_range_ConsensusClustering.consensus_k()ConsensusClustering.fit()ConsensusClustering.hist()ConsensusClustering.cdf()ConsensusClustering.area_under_cdf()ConsensusClustering.change_in_area_under_cdf()ConsensusClustering.best_k()ConsensusClustering.plot_auc_cdf()ConsensusClustering.plot_clustermap()ConsensusClustering.plot_hist()ConsensusClustering.plot_cdf()ConsensusClustering.plot_change_area_under_cdf()
ConsensusCluster- cytoflow.utility.custom_traits
PositiveIntPositiveCIntPositiveFloatPositiveCFloatFloatOrNoneCFloatOrNoneUnitFloatIntOrNoneCIntOrNoneScaleEnumRemovedDeprecatedChangedStr- cytoflow.utility.cytoflow_errors
CytoflowErrorCytoflowOpErrorCytoflowViewErrorCytoflowWarningCytoflowOpWarningCytoflowViewWarning- cytoflow.utility.docstring
expand_class_attributes()expand_method_parameters()find_section()get_class_attributes()get_method_parameters()- cytoflow.utility.fcswrite
write_fcs()- cytoflow.utility.hlog_scale
HlogScaleMatplotlibHlogScaleHlogMajorLocatorHlogMinorLocatorhlog_inv()hlog()KneeLocatorKneeLocator.transform_y()KneeLocator.find_knee()KneeLocator.plot_knee_normalized()KneeLocator.plot_knee()KneeLocator.elbowKneeLocator.norm_elbowKneeLocator.elbow_yKneeLocator.norm_elbow_yKneeLocator.all_elbowsKneeLocator.all_norm_elbowsKneeLocator.all_elbows_yKneeLocator.all_norm_elbows_y
- cytoflow.utility.linear_scale
LinearScale- cytoflow.utility.log_scale
LogScale- cytoflow.utility.logging_ext
MplFilter- cytoflow.utility.logicle_scale
LogicleScaleMatplotlibLogicleScaleLogicleMajorLocatorLogicleMinorLocator- cytoflow.utility.minisom
fast_norm()MiniSomMiniSom.Y_HEX_CONV_FACTORMiniSom.get_weights()MiniSom.get_euclidean_coordinates()MiniSom.convert_map_to_euclidean()MiniSom.activate()MiniSom.winner()MiniSom.update()MiniSom.quantization()MiniSom.random_weights_init()MiniSom.pca_weights_init()MiniSom.train()MiniSom.train_random()MiniSom.train_batch()MiniSom.distance_map()MiniSom.activation_response()MiniSom.quantization_error()MiniSom.quantization_history()MiniSom.distortion_measure()MiniSom.topographic_error()MiniSom.win_map()MiniSom.labels_map()
TestMinisomTestMinisom.setUp()TestMinisom.test_inverse_decay_to_zero_function()TestMinisom.test_linear_decay_to_zero_function()TestMinisom.test_inverse_decay_to_one_function()TestMinisom.test_linear_decay_to_one_function()TestMinisom.test_asymptotic_decay_function()TestMinisom.test_fast_norm()TestMinisom.test_euclidean_distance()TestMinisom.test_cosine_distance()TestMinisom.test_manhattan_distance()TestMinisom.test_chebyshev_distance()TestMinisom.test_check_input_len()TestMinisom.test_unavailable_neigh_function()TestMinisom.test_unavailable_distance_function()TestMinisom.test_gaussian()TestMinisom.test_mexican_hat()TestMinisom.test_bubble()TestMinisom.test_triangle()TestMinisom.test_win_map()TestMinisom.test_win_map_indices()TestMinisom.test_labels_map()TestMinisom.test_activation_reponse()TestMinisom.test_activate()TestMinisom.test_distance_from_weights()TestMinisom.test_quantization_error()TestMinisom.test_topographic_error()TestMinisom.test_hexagonal_topographic_error()TestMinisom.test_quantization()TestMinisom.test_distortion_measure()TestMinisom.test_random_seed()TestMinisom.test_train_batch()TestMinisom.test_train_random()TestMinisom.test_train_use_epochs()TestMinisom.test_train_fixed_points()TestMinisom.test_use_epochs_variables()TestMinisom.test_random_weights_init()TestMinisom.test_pca_weights_init()TestMinisom.test_distance_map()TestMinisom.test_pickling()TestMinisom.test_callable_activation_distance()TestMinisom.test_decay_function_value()TestMinisom.test_sigma_decay_function_value()
- cytoflow.utility.scale
IScaleScaleMixinscale_factory()register_scale()set_default_scale()get_default_scale()- cytoflow.utility.util_functions
iqr()num_hist_bins()geom_mean()geom_sd()geom_sd_range()geom_sem()geom_sem_range()cartesian()sanitize_identifier()random_string()is_numeric()cov2corr()
- cytoflow.views package
- cytoflow.views
- Submodules
- cytoflow.views.bar_chart
BarChartView- cytoflow.views.base_views
BaseViewBaseDataViewBase1DViewBase2DViewBaseNDViewBaseStatisticsViewBase1DStatisticsViewBase2DStatisticsViewBase2DStatisticsView.variableBase2DStatisticsView.xfeatureBase2DStatisticsView.xerror_lowBase2DStatisticsView.xerror_highBase2DStatisticsView.yfeatureBase2DStatisticsView.yerror_lowBase2DStatisticsView.yerror_highBase2DStatisticsView.xscaleBase2DStatisticsView.yscaleBase2DStatisticsView.plot()
- cytoflow.views.densityplot
DensityView- cytoflow.views.export_fcs
ExportFCS- cytoflow.views.histogram
HistogramView- cytoflow.views.histogram_2d
Histogram2DViewAlphaColormap- cytoflow.views.i_selectionview
ISelectionView- cytoflow.views.i_view
IView- cytoflow.views.kde_1d
Kde1DView- cytoflow.views.kde_2d
Kde2DView- cytoflow.views.long_table
LongTableView- cytoflow.views.matrix
MatrixView- cytoflow.views.mst
MSTView- cytoflow.views.parallel_coords
ParallelCoordinatesView- cytoflow.views.radviz
RadvizView- cytoflow.views.scatterplot
ScatterplotView- cytoflow.views.stats_1d
Stats1DView- cytoflow.views.stats_2d
Stats2DViewStats2DView.variableStats2DView.xfeatureStats2DView.xerror_lowStats2DView.xerror_highStats2DView.yfeatureStats2DView.yerror_lowStats2DView.yerror_highStats2DView.xscaleStats2DView.yscaleStats2DView.statisticStats2DView.xfacetStats2DView.yfacetStats2DView.huefacetStats2DView.subsetStats2DView.huescaleStats2DView.plot()
- cytoflow.views.table
TableView- cytoflow.views.violin
ViolinPlotView