 | Database fields documentation |
This topic contains the following sections:
- CalibrationProcessing table
- MeasurementConfig table
- ObjectiveInfo table
- SampleInfo table
- UserProcessing table
This page documents the fields of the database that are of interest for a user of the SDK.
Note that some fields migth be different as seen from the database itself as from the SDK. This documentation represents the fields and table as seen from the SDK.
CalibrationProcessing tableThe calibration processing table represents the factory-defined calibrated measurement settings
Field name | Unit | Description |
|---|---|---|
Id | (no unit) | The ID of the configuration in the CalibrationProcessing table. |
UseReferenceHologram | boolean | Indicates if a configuration uses a reference hologram or not |
UseAutomaticFourierFilter | boolean | Indicates if the reference hologram is filtered with a circular filter circle centered on the central frequency of radius RadiusFourierFilter or with the current Fourier filtering. |
RadiusFourierFilter | pixel | Radius of the circular Fourier filter for the reference hologram, centered around the central frequency |
UseAmplitudeDivision | boolean | Indicates if the reference hologram uses the normalization for each pixel of the reconstructed intensity images with the intensity of each corresponding pixel of the reference hologram. |
ReferenceHoloNbrAvg | (no unit) | The number of holograms used to compute the reference hologram. |
MeasurementConfig tableThe measurement config table represents the set of parameters to define a measurement
Field name | Unit | Description |
|---|---|---|
MeasurementId | (no unit) | The ID of the configuration in the MeasurementConfig table. |
CalibrationProcessingId | (no unit) | The ID of the corresponding configuration in the CalibrationProcessing table. |
UserProcessingId | (no unit) | The ID of the corresponding configuration in the UserProcessing table. |
CameraConfigId | (no unit) | The ID of the corresponding configuration in the CameraConfig table. |
ObjectiveId | (no unit) | The ID of the corresponding configuration in the ObjectiveInfo table. |
ObjectiveInfo tableThe objective info table represents the factory-defined parameters of an objective
Field name | Unit | Description |
|---|---|---|
ObjectiveId | (no unit) | The ID of the configuration in the ObjectiveInfo table. |
Magnification | (no unit) | The magnification of the objective |
PixelXSize_um | [um] | The calibrated value of the length corresponding to a pixel in the image in the X direction. |
PixelYSize_um | [um] | The calibrated value of the length corresponding to a pixel in the image in the Y direction. |
SampleInfo tableThe sample table represents the set of parameters to define a measurement correction according to physical parameters of the sample and its environment
Field name | Unit | Description |
|---|---|---|
SampleId | (no unit) | The ID of the configuration in the SampleInfo table. |
MediumRefractionIndex | (no unit) | The refraction index of the medium in which the sample is. (Usually air, but it could be oil, etc...). |
SampleRefractionIndex | (no unit) | The refraction index of the sample itself. |
UserProcessing tableThe user processing table represents user-defined measurement settings
Field name | Unit | Description |
|---|---|---|
Id | (no unit) | The ID of the configuration in the UserProcessing table. |
RoiX | pixel | The X coordinate of the top left point of the phase ROI (as defined in the camera ROI) |
RoiY | pixel | The Y coordinate of the top left point of the phase ROI (as defined in the camera ROI) |
RoiWidth | pixel | The width of the phase ROI |
RoiHeight | pixel | The height of the phase ROI |
ReconstructionDistance_cm | cm | The reconstruction distance. Corresponds to the slider in the Reconstruction Settings window, in Koala |
Offset | [°] (degree) | The phase value considered as the 0. Corresponds to the slider in the Reconstruction Settings window, in Koala |