sec_code_reference.rst

Code reference

Module-level methods

dclab.new_dataset

Global definitions

These definitionas are used throughout the dclab/Shape-In/Shape-Out ecosystem.

Metadata

Valid configuration sections and keys are described in: sec_analysis_meta and sec_experiment_meta. You should use the following methods instead of accessing the static metadata constants.

dclab.definitions.config_key_exists

dclab.definitions.get_config_value_descr

dclab.definitions.get_config_value_func

dclab.definitions.get_config_value_type

These constants are also available in the dclab.definitions module.

dclab.definitions.meta_const.CFG_ANALYSIS

dclab.definitions.meta_const.CFG_METADATA

dclab.definitions.meta_const.config_keys

Metadata parsers

dclab.definitions.meta_parse

Features

Features are discussed in more detail in sec_features.

dclab.definitions.check_feature_shape

dclab.definitions.feature_exists

dclab.definitions.get_feature_label

dclab.definitions.scalar_feature_exists

These constants are also available in the dclab.definitions module.

dclab.definitions.feat_const.FEATURES_NON_SCALAR

dclab.definitions.feat_const.feature_names

dclab.definitions.feat_const.feature_labels

dclab.definitions.feat_const.feature_name2label

dclab.definitions.feat_const.scalar_feature_names

RT-DC dataset manipulation

Base class

dclab.rtdc_dataset.RTDCBase

DCOR (online) format

dclab.rtdc_dataset.RTDC_DCOR

dclab.rtdc_dataset.fmt_dcor.APIHandler

Dictionary format

dclab.rtdc_dataset.RTDC_Dict

HDF5 (.rtdc) format

dclab.rtdc_dataset.RTDC_HDF5

dclab.rtdc_dataset.fmt_hdf5.MIN_DCLAB_EXPORT_VERSION

Hierarchy format

dclab.rtdc_dataset.RTDC_Hierarchy

TDMS format

dclab.rtdc_dataset.RTDC_TDMS

dclab.rtdc_dataset.fmt_tdms.get_project_name_from_path

dclab.rtdc_dataset.fmt_tdms.get_tdms_files

Ancillaries

dclab.rtdc_dataset.feat_anc_core.ancillary_feature

Plugin features

dclab.rtdc_dataset.feat_anc_plugin.plugin_feature

Temporary features

dclab.rtdc_dataset.feat_temp

Config

dclab.rtdc_dataset.config.Configuration

dclab.rtdc_dataset.config.load_from_file

Export

dclab.rtdc_dataset.export.LimitingExportSizeWarning

dclab.rtdc_dataset.export.Export

Filter

dclab.rtdc_dataset.filter.Filter

Low-level functionalities

downsampling

dclab.downsampling

downsample_grid

features

image-based

dclab.features.contour.get_contour

dclab.features.bright.get_bright

dclab.features.inert_ratio.get_inert_ratio_cvx

dclab.features.inert_ratio.get_inert_ratio_raw

dclab.features.volume.get_volume

dclab.features.volume.counter_clockwise

dclab.features.volume.vol_revolve

emodulus

dclab.features.emodulus

dclab.features.emodulus.load

dclab.features.emodulus.pxcorr

dclab.features.emodulus.scale_linear

dclab.features.emodulus.viscosity

fluorescence

dclab.features.fl_crosstalk.correct_crosstalk

dclab.features.fl_crosstalk.get_compensation_matrix

isoelastics

dclab.isoelastics

kde_contours

dclab.kde_contours

kde_methods

dclab.kde_methods

polygon_filter

dclab.polygon_filter

statistics

dclab.statistics

Writing RT-DC files

dclab.rtdc_dataset.writer

Command-line interface methods

dclab.cli

R and lme4

dclab.lme4.rlibs

dclab.lme4.rsetup

dclab.lme4.wrapr

Machine learning

dclab.rtdc_dataset.feat_anc_ml.ml_feature

dclab.rtdc_dataset.feat_anc_ml.ml_libs

dclab.rtdc_dataset.feat_anc_ml.modc

dclab.rtdc_dataset.feat_anc_ml.ml_model

dclab.rtdc_dataset.feat_anc_ml.hook_tensorflow.tf_dataset

dclab.rtdc_dataset.feat_anc_ml.hook_tensorflow.tf_model