This class encapsulates a single real or complex moment image among with meta-data.
More...
|
def | __init__ |
| Initializes with the given attributes. More...
|
|
def | GetLinearImage |
| Computes an estimate of an image with the given exposure time (in seconds) using the information in this image and returns it. More...
|
|
def | GetWidth (self) |
| Returns the width of this image in pixels. More...
|
|
def | GetHeight (self) |
| Returns the height of this image in pixels. More...
|
|
def | GetColor (self) |
| For plots it can be useful to visualize different taps with different colors. More...
|
|
|
| Image = None; |
| A 2D array containing the data of the measurement. More...
|
|
float | ExposureTime = 0.0 |
| The exposure time of the moment image in seconds. More...
|
|
float | Frequency = 0.0 |
| The frequency used for modulation in Hz. More...
|
|
float | PhaseShift = 0.0 |
| The phase shift of the two modulation signals. More...
|
|
float | TimeStamp = 0.0 |
| The time stamp of the image. More...
|
|
int | Tap = 0 |
| The index of the tap that lead to this moment image. More...
|
|
int | Take = 0 |
| The take in which this moment image was recorded. More...
|
|
This class encapsulates a single real or complex moment image among with meta-data.
def __init__ |
( |
|
self, |
|
|
|
Image, |
|
|
|
ExposureTime, |
|
|
|
Frequency, |
|
|
|
PhaseShift, |
|
|
|
TimeStamp = 0.0 , |
|
|
|
Tap = 0 , |
|
|
|
Take = 0 |
|
) |
| |
Initializes with the given attributes.
def GetLinearImage |
( |
|
self, |
|
|
|
ReferenceExposureTime = 1.92e-3 |
|
) |
| |
Computes an estimate of an image with the given exposure time (in seconds) using the information in this image and returns it.
Returns the width of this image in pixels.
Returns the height of this image in pixels.
For plots it can be useful to visualize different taps with different colors.
Therefore, this function returns a color that identifies the tap index of this moment image.
A 2D array containing the data of the measurement.
The exposure time of the moment image in seconds.
The frequency used for modulation in Hz.
The phase shift of the two modulation signals.
The time stamp of the image.
This is a floating point quantity in seconds with respect to some absolute time that is only fixed per measurement. If unavailable, it is zero.
The index of the tap that lead to this moment image.
Typically, four moment images with pi/2 phase shifts are captured in a row and this index provides the index within this series of measurements. Note that the phase shift already includes the offset due to the tap index. If multiple moment images were combined to construct this moment image, this index is the minimum of the involved indices.
The take in which this moment image was recorded.
Multiple takes are either used to average out noise or to record videos. In the latter case this is the index of the frame.
The documentation for this class was generated from the following file: