pwspy.dataTypes.AcqDir

class pwspy.dataTypes.AcqDir(directory)[source]

Bases: object

This class handles the file structure of a single acquisition. this can include a PWS acquisition as well as colocalized Dynamics and fluorescence.

Parameters

directory (str) – the file path the root directory of the acquisition

editNotes()[source]

Create a notes.txt file if it doesn’t already exists and open it in a text editor.

getNotes()[source]

Return the contents of notes.txt as a string.

Return type

str

getRois()[source]

Return information about the Rois found in the acquisition’s file path. See documentation for Roi.getValidRoisInPath()

Return type

List[Tuple[str, int, FileFormats]]

getThumbnail()[source]

Return a thumbnail from any of the available acquisitions. Should be an 8bit normalized image.

Return type

ndarray

hasNotes()[source]

Indicates whether or not a notes.txt file was found.

Return type

bool

loadRoi(name, num, fformat=None)[source]

Load a Roi that has been saved to file in the acquisition’s file path.

Return type

Roi

saveRoi(roi, overwrite=False)[source]

Save a Roi to file in the acquisition’s file path.

Return type

None

dynamics

Returns None if no dynamics acquisition was found.

Type

DynMetaData

pws

Returns None if no PWS acquisition was found.

Type

ICMetaData