SetDataDouble

Description

SetDataDouble gives the data to the plugin.

Syntax

int SetDataDouble(const wchar_t* iwszParameterName, const unsigned int iunTableSize, const double* ipTable);

Parameters

Input

  • iwszParameterName: Data name the "ipTable" contains. See the list of possibles values below.
  • iunTableSize: Size of the table"ipTable".
  • ipTable: A table that contains the data.

Return

(int): returns the identification number of the error if an error occurs or 0 if no error occurs.

Example

To get a full example of the API use, download the .Plugin

#define OPT_PLUGIN_NO_ERROR 0
#define OPT_PLUGIN_ERROR_INVALID_DATA 4
struct DataDouble
{
     unsigned int Size;
     double* Table;
};
std::map<std::wstring, DataDouble> gmDatas;
int SetDataDouble(const wchar_t* iwszParameterName, const unsigned int iunTableSize, const double* ipTable)
{
     if (iunTableSize != 0 && ipTable != NULL)
     {
DataDouble theData;
theData.Size = iunTableSize;
theData.Table = ipTable;
std::wstring parameterName(iwszParameterName);
gmDatas[parameterName] = theData;
     }
     else
     {
return OPT_PLUGIN_ERROR_INVALID_DATA;
     }
     return OPT_PLUGIN_NO_ERROR;
}

List of the possible values of "iwszParameterName"

Only the parameters that HOA can compute are sent to the plugin.

For example in "Uniform" eyebox mode, the parameters relative to the adaptive eyebox are not sent. If you do not specify an "Outer Surface" in the "Windshield/Combiner" tab, the parameters relative to the ghost are not sent.

Legend:

  • iEB: represents the coordinate of the point on the horizontal axis of the Eyebox.
  • jEB: represents the coordinate of the point on the vertical axis of the Eyebox.
  • kMEB: indicates the Eyebox to consider in case of a multieyebox mode.
  • iPGU: represents the coordinate of the point on the horizontal axis of the Virtual Image.
  • jPGU: represents the coordinate of the point on the vertical axis of the Virtual Image.
  • iTI: represents the coordinate of the point on the horizontal axis of the Target Image.
  • jTI: represents the coordinate of the point on the vertical axis of the Target Image.
  • iW: represents the coordinate of the point on the horizontal axis of the Warping grid.
  • jW: represents the coordinate of the point on the vertical axis of the Warping grid.
  • LREye: indicates the Eyebox (Left or Right Eyebox) to consider in case of a monocular eyebox.
  • kCFG: indicates the configuration to consider in case of a multiconfiguration analysis.

In case of "Validation" parameters:

  • 0 means the parameter is valid
  • 1 means the parameter is extrapolated (not valid)
  • 2 means the parameter is not valid.

Parameter name

Unit

Description

Organization

Eyebox

EyeBoxCenterX mm User defined X coordinate of the eyebox origin point. kCFG
EyeBoxCenterY mm User defined Y coordinate of the eyebox origin point. kCFG
EyeBoxCenterZ mm User defined Z coordinate of the eyebox origin point. kCFG
EyeBoxInterpupillaryDistance mm "Interpupillary Distance" entered in the "Eyebox" tab. kCFG
EyeBoxNumberOfSharedSamples "Number of Shared Sample" displayed in the "Eyebox" tab. kCFG
EyeBoxBinocularHorizontalSize mm "Binocular Horizontal Size" entered in the "Eyebox" tab. kCFG
EyeBoxMonocularHorizontalSize mm "Monocular Horizontal Size" displayed in the "Eyebox" tab. kCFG
EyeBoxVerticalSize mm "Vertical Size" entered in the "Eyebox" tab. kCFG
EyeBoxMonocularHorizontalSampling "Monocular Horizontal Sampling" entered in the "Eyebox" tab. kCFG
EyeBoxBinocularHorizontalSampling "Binocular Horizontal Sampling" displayed in the "Eyebox" tab. kCFG
EyeBoxVerticalSampling "Vertical Sampling" entered in the "Eyebox" tab. kCFG
EyeBoxHorizontalSpacing mm Horizontal spacing between two samples of the eyebox. kCFG
EyeBoxVerticalSpacing mm Horizontal spacing between two samples of the eyebox. kCFG
EyeBoxBinocular2DX mm Sample along X direction of the eyebox for both eyes in the 2D space of the current EB. iEB, jEB, kMEB, kCFG
EyeBoxBinocular2DY mm Sample along Y direction of the eyebox for both eyes in the 2D space of the current EB. iEB, jEB, kMEB, kCFG
EyeBoxBinocular3DX mm Sample along X direction of the eyebox for both eyes in the 3D global space. iEB, jEB, kMEB, kCFG
EyeBoxBinocular3DY mm Sample along Y direction of the eyebox for both eyes in the 3D global space. iEB, jEB, kMEB, kCFG
EyeBoxBinocular3DZ mm Sample along Z direction of the eyebox for both eyes in the 3D global space. iEB, jEB, kMEB, kCFG
EyeBoxMonocular2DX mm Sample along X direction of the eyebox for one eye in the 2D space of the current EB. iEB, jEB, kMEB, LREye, kCFG
EyeBoxMonocular2DY mm Sample along Y direction of the eyebox for one eye in the 2D space of the current EB. iEB, jEB, kMEB, LREye
EyeBoxMonocular3DX mm Sample along X direction of the eyebox for one eye in the 3D global space. iEB, jEB, kMEB, LREye, kCFG
EyeBoxMonocular3DY mm Sample along Y direction of the eyebox for one eye in the 3D global space. iEB, jEB, kMEB, LREye, kCFG
EyeBoxMonocular3DZ mm Sample along Z direction of the eyebox for one eye in the 3D global space. iEB, jEB, kMEB, LREye, kCFG
EyeBoxNumberOfConfigurations Number of configurations entered in the "Eyebox" tab. kCFG
EyeBoxOffsetOfConfigurations mm Offset of configurations entered in the "Eyebox" tab. kMEB, kCFG
EyeBoxSamplingMode "Sampling Mode" entered in the "Eyebox" tab.

kCFG

0 = Uniform, 1 = Adaptive

EyeBoxAdaptiveSampling Number of samples the adaptive eyebox contains. kCFG
EyeBoxAdaptive2DX mm Sample along the X direction of the adaptive eyebox in the 2D space of the current EB. iEB, kMEB, kCFG
EyeBoxAdaptive2DY mm Sample along the Y direction of the adaptive eyebox in the 2D space of the current EB. iEB, kMEB, kCFG
EyeBoxAdaptive3DX mm Sample along the X direction of the adaptive eyebox in the 3D global space. iEB, kMEB, kCFG
EyeBoxAdaptive3DY mm Sample along the Y direction of the adaptive eyebox in the 3D global space. iEB, kMEB, kCFG
EyeBoxAdaptive3DZ mm Sample along the Z direction of the adaptive eyebox in the 3D global space. iEB, kMEB, kCFG

Target Image

TargetLookOverAngle radians User defined look over angle of the target. kCFG
TargetLookDownAngle radians User defined look down angle of the target. kCFG
TargetHorizontalFieldOfView radians User defined horizontal field of view of the target. kCFG
TargetVerticalFieldOfView radians User defined vertical field of view of the target. kCFG
TargetImage2DX mm Sample along the X direction of the target image in the 2D space of the target image. iTI, jTI, kMEB, kCFG
TargetImage2DY mm Sample along the Y direction of the target image in the 2D space of the target image. iTI, jTI, kMEB, kCFG
TargetImage3DX mm Sample along the X direction of the target image in the 3D global space. iTI, jTI, kMEB, kCFG
TargetImage3DY mm Sample along the Y direction of the target image in the 3D global space. iTI, jTI, kMEB, kCFG
TargetImage3DZ mm Sample along the Z direction of the target image in the 3D global space. iTI, jTI, kMEB, kCFG

Virtual Image

VirtualImageDistance mm Distance between the eyebox center and the target image center. kCFG
VirtualImageMonocular3DX mm Sample along the X direction of the virtual image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
VirtualImageMonocular3DY mm Sample along the Y direction of the virtual image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
VirtualImageMonocular3DZ mm Sample along the Z direction of the virtual image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
VirtualImageValidationMonocular Sample validation of the virtual image for one eye. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
VirtualImageBinocular3DX mm Sample along the X direction of the virtual image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
VirtualImageBinocular3DY mm Sample along the Y direction of the virtual image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
VirtualImageValidationBinocular Sample validation of the virtual image for both eyes. iEB, jEB, iPGU, jPGU, kMEB, kCFG
VirtualImageBinocular3DZ mm Sample along the Z direction of the virtual image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
VirtualImageAdaptive3DX mm Sample along the X direction of the virtual image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
VirtualImageAdaptive3DY mm Sample along the Y direction of the virtual image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
VirtualImageAdaptive3DZ mm Sample along the Z direction of the virtual image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
VirtualImageValidationAdaptive Sample validation of the virtual image for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, kCFG

Sagittal Image

SagittalImageMonocular3DX mm Sample along the X direction of the sagittal image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
SagittalImageMonocular3DY mm Sample along the Y direction of the sagittal image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
SagittalImageMonocular3DZ mm Sample along the Z direction of the sagittal image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
SagittalImageBinocular3DX mm Sample along the X direction of the sagittal image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
SagittalImageBinocular3DY mm Sample along the Y direction of the sagittal image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
SagittalImageBinocular3DZ mm Sample along the Z direction of the sagittal image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
SagittalImageAdaptive3DX mm Sample along the X direction of the sagittal image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
SagittalImageAdaptive3DY mm Sample along the Y direction of the sagittal image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
SagittalImageAdaptive3DZ mm Sample along the Z direction of the sagittal image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
SagittalImageValidationMonocular Sample validation of the sagittal image for the monocular eyebox. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
SagittalImageValidationBinocular Sample validation of the sagittal image for the binocular eyebox. iEB, jEB, iPGU, jPGU, kMEB, kCFG
SagittalImageValidationAdaptive Sample validation of the sagittal image for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, kCFG

Tangential Image

TangentialImageMonocular3DX mm Sample along the X direction of the tangential image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
TangentialImageMonocular3DY mm Sample along the Y direction of the tangential image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
TangentialImageMonocular3DZ mm Sample along the Z direction of the tangential image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
TangentialImageBinocular3DX mm Sample along the X direction of the tangential image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
TangentialImageBinocular3DY mm Sample along the Y direction of the tangential image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
TangentialImageBinocular3DZ mm Sample along the Z direction of the tangential image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
TangentialImageAdaptive3DX mm Sample along the X direction of the tangential image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
TangentialImageAdaptive3DY mm Sample along the Y direction of the tangential image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
TangentialImageAdaptive3DZ mm Sample along the Z direction of the tangential image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
TangentialImageValidationMonocular Sample validation of the tangential image for the monocular eyebox. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
TangentialImageValidationBinocular Sample validation of the sagittal image for the monocular eyebox. iEB, jEB, iPGU, jPGU, kMEB, kCFG
TangentialImageValidationAdaptive Sample validation of the sagittal image for the monocular eyebox. iEB, iPGU, jPGU, kMEB, kCFG

Ghost

GhostMonocular3DX mm Sample along the X direction of the ghost image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
GhostMonocular3DY mm Sample along the Y direction of the ghost image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
GhostMonocular3DZ mm Sample along the Z direction of the ghost image for one eye in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
GhostValidationMonocular Sample validation of the ghost image for one eye. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
GhostBinocular3DX mm Sample along the X direction of the ghost image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
GhostBinocular3DY mm Sample along the Y direction of the ghost image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
GhostBinocular3DZ mm Sample along the Z direction of the ghost image for both eyes in the 3D global space. iEB, jEB, iPGU, jPGU, kMEB, kCFG
GhostValidationBinocular Sample validation of the ghost image for both eyes. iEB, jEB, iPGU, jPGU, kMEB, kCFG
GhostAdaptive3DX mm Sample along the X direction of the ghost image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
GhostAdaptive3DY mm Sample along the Y direction of the ghost image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
GhostAdaptive3DZ mm Sample along the Z direction of the ghost image for the adaptive eyebox in the 3D global space. iEB, iPGU, jPGU, kMEB, kCFG
GhostValidationAdaptive Sample validation of the ghost image for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, kCFG

PGU

PGUHorizontalSize mm "Horizontal Size" displayed or entered in the "PGU" tab. kCFG
PGUVerticalSize mm "Vertical Size" displayed or entered in the "PGU" tab. kCFG
PGUHorizontalResolution "Horizontal Resolution" displayed or entered in the "PGU" tab. kCFG
PGUVerticalResolution "Vertical Resolution" displayed or entered in the "PGU" tab. kCFG
PGUHorizontalSampling "Horizontal Sampling" entered in the "PGU" tab. kCFG
PGUVerticalSampling "Vertical Sampling" entered in the "PGU" tab. kCFG
PGU2DX mm Warping sampling coordinates, along the X direction in the PGU 2D space, used in simulation. iPGU, jPGU, kCFG
PGU2DY mm Warping sampling coordinates, along the Y direction in the PGU 2D space, used in simulation. iPGU, jPGU, kCFG
PGU3DX mm Warping sampling coordinates, along the X direction in the 3D global space, used in simulation. iPGU, jPGU, kCFG
PGU3DY mm Warping sampling coordinates, along the Y direction in the 3D global space, used in simulation. iPGU, jPGU, kCFG
PGU3DZ mm Warping sampling coordinates, along the Z direction in the 3D global space, used in simulation. iPGU, jPGU, kCFG

Mirror

MirrorTiltAngle rad Tilt angle of the configuration entered in the "Mirrors" tab. kMEB, kCFG

Warping

WarpingMode "Mode" entered in the "Warping" tab. kCFG 1 = Disable 2 = Import 3 = Build & Export 4 = Build
WarpingHorizontalSampling "Horizontal Sampling" entered in the "Warping" tab. kCFG
WarpingVerticalSampling "Vertical Sampling" entered in the "Warping" tab. kCFG
WarpingHorizontalPixel mm Horizontal size of a pixel on the PGU. kCFG
WarpingVerticalPixel mm Vertical size of a pixel on the PGU. kCFG
Warping2DX mm Warping sampling coordinates, along the X direction in the PGU 2D space, used to generate the .OPTWarping file (fit to pixels). iW, jW, kMEB, kCFG
Warping2DY mm Warping sampling coordinates, along the Y direction in the PGU 2D space, used to generate the .OPTWarping file (fit to pixels). iW, jW, kMEB, kCFG
Warping3DX mm Warping sampling coordinates, along the X direction in the 3D global space, used to generate the .OPTWarping file (fit to pixels). iW, jW, kMEB, kCFG
Warping3DY mm Warping sampling coordinates, along the Y direction in the 3D global space, used to generate the .OPTWarping file (fit to pixels). iW, jW, kMEB, kCFG
Warping3DZ mm Warping sampling coordinates, along the Z direction in the 3D global space, used to generate the .OPTWarping file (fit to pixels). iW, jW, kMEB, kCFG
RawWarping2DX mm Warping sampling coordinates along the X direction in the PGU 2D space before the fitting of samples to the nearest pixels. iW, jW, kMEB, kCFG
RawWarping2DY mm Warping sampling coordinates along the Y direction in the PGU 2D space before the fitting of samples to the nearest pixels. iW, jW, kMEB, kCFG
RawWarping3DX mm Warping sampling coordinates along the X direction in the 3D global space before the fitting of samples to the nearest pixels. iW, jW, kMEB, kCFG
RawWarping3DY mm Warping sampling coordinates along the Y direction in the 3D global space before the fitting of samples to the nearest pixels. iW, jW, kMEB, kCFG
RawWarping3DZ mm Warping sampling coordinates along the Z direction in the 3D global space before the fitting of samples to the nearest pixels. iW, jW, kMEB, kCFG
WarpingPixelX Pixel Sample along the X direction of the warping in the 2D space of the PGU (fit to pixels). iW, jW, kMEB, kCFG
WarpingPixelY Pixel Sample along the Y direction of the warping in the 2D space of the PGU (fit to pixels). iW, jW, kMEB, kCFG
WarpingPixelByMirrorX Pixel Sample along the X direction of the warping in the 2D space of the mirror (fit to pixels). iW, jW, kMEB, kCFG
WarpingPixelByMirrorY Pixel Sample along the Y direction of the warping in the 2D space of the mirror (fit to pixels). iW, jW, kMEB, kCFG

Reference

TopDirection mm X ,Y,Z of the "Top Direction" entered in the "Axis System" tab. i, kCFG
VehicleDirection mm X ,Y,Z of the "Vehicle Direction" entered in the "Axis System" tab. i, kCFG

Pixel Size

PixelSizeMonocular3DX Size of the pixel of the virtual image for one eye. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG, n n=0,1,2,3 for the corners (according to the PGU axes): 0: up left 1: up right 2: bottom right 3: bottm left
PixelSizeMonocular3DY Size of the pixel of the virtual image for one eye. iEB, jEB, iPGU, jPGU, kMEB, LREye, n, kCFG
PixelSizeMonocular3DZ Size of the pixel of the virtual image for one eye. iEB, jEB, iPGU, jPGU, kMEB, LREye, n, kCFG
PixelSizeBinocular3DX Size of the pixel of the virtual image for both eyes. iEB, jEB, iPGU, jPGU, kMEB, n, kCFG
PixelSizeBinocular3DY Size of the pixel of the virtual image for both eyes. iEB, jEB, iPGU, jPGU, kMEB, n, kCFG
PixelSizeBinocular3DZ Size of the pixel of the virtual image for both eyes. iEB, jEB, iPGU, jPGU, kMEB, n, kCFG
PixelSizeAdaptive3DX Size of the pixel of the virtual image for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, n, kCFG
PixelSizeAdaptive3DY Size of the pixel of the virtual image for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, n, kCFG
PixelSizeAdaptive3DZ Size of the pixel of the virtual image for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, n, kCFG

Sharpness

SpotDiameterMonocular mm Diameter of the best focus spot for one eye. iEB, jEB, iPGU, jPGU, kMEB, LREye, kCFG
SpotDiameterBinocular mm Diameter of the best focus spot for both eyes. iEB, jEB, iPGU, jPGU, kMEB, kCFG
SpotDiameterAdaptive mm Diameter of the best focus spot for the adaptive eyebox. iEB, iPGU, jPGU, kMEB, kCFG

Configuration

ConfigurationValidation Validation of each configuration of the analysis. kCFG
NumberOfConfigurations Number of configurations of the analysis. kCFG