Microscope#

class deeptrack.optics.Microscope(sample: Feature, objective: Feature, **kwargs)#

Bases: StructuralFeature

Image a sample using an optical system.

Wraps a feature-set defining a sample and a feature-set defining the optics.

Parameters#

sampleFeature

A feature-set resolving a list of images describing the sample to be imaged

objectiveFeature

A feature-set defining the optical device that images the sample

Methods Summary

get(image, **kwargs)

Transform an image [abstract method].

Methods Documentation

get(image, **kwargs)#

Transform an image [abstract method].

Abstract method that defines how the feature transforms the input. The current value of all properties will be passed as keyword arguments.

Parameters#

image‘Image’ or List[‘Image’]

The Image or list of images to transform.

**kwargsDict[str, Any]

The current value of all properties in properties as well as any global arguments.

Returns#

‘Image’ or List[‘Image’]

The transformed image or list of images.

Raises#

NotImplementedError

Must be overridden by subclasses.