photon_mosaic.core.selectplanes#
Functions
|
Return a lazy proxy imaging object exposing only selected planes. |
Classes
|
Lazy proxy imaging exposing only a selected subset of source plane IDs. |
- class photon_mosaic.core.selectplanes.SelectPlanesImaging(imaging, plane_ids)[source]#
Lazy proxy imaging exposing only a selected subset of source plane IDs.
- Attributes:
plane_idsGet the plane IDs associated with the imaging data.
Methods
Get the number of planes in the imaging data.
get_series([start_frame, end_frame, ...])Get a series of frames from the imaging data.
- property plane_ids#
Get the plane IDs associated with the imaging data.
- Returns:
A list of plane IDs.
- Return type:
list
- get_num_planes()[source]#
Get the number of planes in the imaging data.
- Returns:
The number of planes.
- Return type:
int
- get_series(start_frame=None, end_frame=None, plane_ids=None, epoch_index=None)[source]#
Get a series of frames from the imaging data.
- Parameters:
start_frame (
int|None) – The starting frame index (inclusive).end_frame (
int|None) – The ending frame index (exclusive).plane_ids (
list|ndarray|None) – The list of plane IDs to include. If None, all planes are included.epoch_index (
int|None) – The index of the imaging segment. If None and there is only one segment, it defaults to 0.
- Returns:
The requested series of frames as a NumPy array.
- Return type:
ndarray