pwspy.dataTypes

Custom datatypes that are commonly used in the analysis of PWS related data.

Metadata Classes

These classes provide handling of information about an acquisition without requiring that the full data be loaded into RAM. These can be used to get information about the equipment used, the date the acquisition was taken, the location of the files, the presence of ROIs or analyses, etc.

PwsMetaData	A class that represents the metadata of a PWS acquisition.
DynMetaData	A class that represents the metadata of a Dynamics acquisition.
ERMetaData	A class representing the extra information related to an ExtraReflectanceCube file.
FluorMetaData	Metadata for a fluorescence image.

Data Classes

These classes are used to actuallly load and manipulate acquisition data. The all have a corresponding metadata class.

PwsCube	A class representing a single PWS acquisition.
DynCube	A class representing a single acquisition of PWS Dynamics.
KCube	A class representing an PwsCube after being transformed from being described in terms of wavelength to wavenumber (k-space).
ExtraReflectanceCube	This class represents a 3D data cube of the extra reflectance in a PWS system.
ExtraReflectionCube	This class is meant to be constructed from an ExtraReflectanceCube along with additional reference measurement information.
ICBase	A class to handle the data operations common to PWS related image cubes.
ICRawBase	This class represents data cubes which are not derived from other data cubes.

Other Classes

Roi	This class represents a single Roi used to select a specific region of an image.
RoiFile	This class represents a single Roi File used to save and load an ROI.
CameraCorrection	This class represents all the information needed to correct camera related hardware defects in our data.
Acquisition	This class handles the file structure of a single acquisition.
FluorescenceImage	Represents a fluorescence image taken by the PWS acquisition software.

Inheritance

Abstract base classes define common behavior between the implementations of the various data types making it easy to write software using PWSpy that will work for all available data type implementations.