4.1.1.3.1.2. lib.simulation.psf_models#

Module that provides PSF models for the microscope.

4.1.1.3.1.2.1. Module Contents#

4.1.1.3.1.2.1.1. Classes#

PSFmodel

Base class for all PSF models

PSFgenerator

standingWave

Background

Detection

4.1.1.3.1.2.1.2. API#

class lib.simulation.psf_models.PSFmodel(config)#

Base class for all PSF models

Initialization

_sanity_check()#

Method that performs a sanity check of the provided parameters.

getPSF(X, pattern, **kwargs)#
class lib.simulation.psf_models.PSFgenerator#

Initialization

class lib.simulation.psf_models.standingWave(config)#

Bases: lib.simulation.psf_models.PSFmodel

getPSF(X, pattern, **kwargs)#

Method to create a standing evanescent wave pattern via TIR to illuminate the sample :return: incident intensity at z=0 for M molecules (no decay…)

class lib.simulation.psf_models.Background(config)#

Bases: lib.simulation.psf_models.PSFmodel

getPSF(pattern, **kwargs)#

Method to create a standing evanescent wave pattern via TIR to illuminate the sample :return: average background counts

class lib.simulation.psf_models.Detection(config)#

Bases: lib.simulation.psf_models.PSFmodel

getPSF(pattern, **kwargs)#

Method to calculate the detection PSF to weight measurement results. :param pattern: pattern object :return: array of detPSF values, shape=(K, M)