Exporting calibrations can be a complex task, since it reflects all aspects of a system setup: multiple clients, adaptions to content rendering applications, etc.
Export tasks are defined in a standard XML file. Tag and attribute names and values are case-sensitive!
Here is an example of such an export definition file:
<?xml version="1.0"?> <VIOSO> <File version="1.0.0" /> <CalibCommerceTask Typ="export" Format="vwf"> <CommonParam bSilent="1" bNoVC="0" bNoGeomCorr="0" bNoBlending="0" bNoMask="0" bSeparatedSplitDisp="0" bAllToMaster="1" bBlankUnusedSplitDispParts="1" bExactFileName="1" bUse3D="0" /> <Task Typ="convert" Format="pseudo 3D sphere" > <SpecialParam vParam1_X="1000.0"/> </Task> <TransferTask Format="vwf " Core="192.168.100.5" > <Destination Core="192.168.100.5" FileName="D:\Export\EXPORT_Slave.vwf" /> </TransferTask> </CalibCommerceTask> </VIOSO>
You may set xml to version 1.0. You may specify a file version, currently this is 1.0.0, we do not expect any changes in future.
Table of Contents
CalibCommerceTask
One and only root object
attribute | parameters | description | version |
---|---|---|---|
Typ | the type of task, set to export |
5.0 | |
Format |
vwf |
standard format, one file contains all data | 5.0 |
vwf separated |
separate file for every display, mapping file and blend-bitmap for each projector | 5.0 | |
x-file |
DirectX compatible mesh file. Uses a viewport of -8,8 horizontally. Vertically multiply by screen aspect. Example a 16:10 screen gets -5,5 vertical viewport. |
5.0 | |
openwarp |
Text file containing u-v coordinates; import to OpenWarp calibrator | 5.0 | |
mips |
xml and blend bitmap, use only for testing; use TransferTask instead | 5.0 | |
MPCDI |
exports a VESA MPCDI v2 conform warp file | 5.0 | |
SGC |
exports to Sciss’ Uniview warp mesh | 5.0 |
Grid based exports (x-file, openwarp, mips and MPCDI) use SpecialParam
:
SpecialParam | description | version |
---|---|---|
qGridDimX |
horizontal grid dimension | 5.0 |
qGridDimY |
vertical grid dimension | 5.0 |
In case CommonParam:bVirtualContentRect
is used:
SpecialParam | description | version |
---|---|---|
vParam0_X |
width of virtual content | 5.0 |
vParam0_Y |
height of virtual content | 5.0 |
Sub tags
- CommonParam
- SpecialParam
- Task
- TransferTask
CommonParam
Sets options in context of export and conversion operations. These are Boolean Attributes, set to nonzero to switch on and 0 to switch off. If an attribute is omitted, default is used.
Attribute | default value | description | version |
---|---|---|---|
bSilent |
1 | needs to be 1, as we are operating without GUI | 5.0 |
bNoVC |
0 | do not apply warping grid, this is like having a full-screened VC | 5.0 |
bNoGeomCorr |
0 | no geometric correction is applied | 5.0 |
bNoMask |
0 | no masks are applied | 5.0 |
bSeparatedSplitDisp |
0 | keep splits as separate mapping; if not set, spitted displays get stitched to a mapping in desktop monitor size | 5.0 |
bAllToMaster |
1 | if set and a Super Compound is exported, all mappings from participating clients are copied to the master and processed there | 5.0 |
bBlankUnusedSplitDispParts |
0 | if set: splitted parts are masked to black; if unset: parts are filled uniformly to appear unwarped not used if bSeparatedSplitDisp is set |
5.0 |
bExactFileName |
0 | if set, the export file name does not get decorated by the current Display Compound name Note: if set and there are more than one Display Compound exported, the latter will overwrite the former files! |
5.0 |
bUse3D |
0 | exports 3D mapping instead of a distortion map Note: this is only intended for dynamic eye warping and an already converted mapping (fisheye to pano/cylinder, flat screen or custom content space) is required |
5.0 |
bVirtualContentRect |
0 | scales mapping coordinates to a virtual content rect, based on the scan. It calculates an optimal content size and based on this rects, to fill one channel. Note: this applies only to grid-based exports (OpenWarp, X-file, MIPS, MPCDI) An extra .def file is written, containing the total virtual content size and all display channel’s rects |
5.0 |
bNiceFrustum |
0 | does a nice AutoFrustum, it widenes FoV by 1° and rounds up to next full degree | 5.0 |
bSymmetricFrustum |
0 | causes the AutoFrustum to be symmetric, that means upper and lower as well as right and left FoV are the same angle. This is useful, if the IG does not support asymmetric frustum and just provides FoVX and FoVY. | 5.0 |
blendFormat |
0 | applies to MPCDI and PULSE export. Set to number:
Use Grey formats for UnrealEngine nDisplay |
5.1 |
FileName |
needs to be set if bExactFileName is used. Specify the export file name in export folder or path |
SpecialParam
Set input parameter in context of an export or a conversion operation.
Attribute | default value | description | version |
---|---|---|---|
vParam0_X vParam0_Y vParam0_Z vParam0_W |
0 | IEEE float 4-Vector | 5.0 |
vParam1_X vParam1_Y vParam1_Z vParam1_W |
0 | IEEE float 4-Vector | 5.0 |
vEyePoint_X vEyePoint_Y vEyePoint_Z |
0 | an eye point (IEEE float) in 3D | 5.0 |
customCntSpaceName |
name of a frustum or model definition defining a view port or texture space | 5.0 | |
baseCntSpaceName |
name of a frustum defining a straight ahead view | 5.0 | |
templateFileName |
filename of a template to export a frustum with | 5.0 | |
qGridDimX |
0 | export grid dimension, horizontally | 5.0 |
qGridDimY |
0 | export grid dimension, vertically | 5.0 |
fGammaCorr |
0 | exponent each blend value is raised to. Defaults to 0 which does no change and is internally changed to 1. Required if the graphic pipeline of the client application has set gamma adjustment. Set to a value greater than 1, if blend regions are too bright or to a value less than 1, if blend regions appear too dark. If you know the set gamma value use same for correction. |
5.0 |
Task
Describes a computing operation on the current data
Attribute | value | description | version |
---|---|---|---|
Typ |
convert |
type of the task, converts a mapping | 5.0 |
Format |
custom content space conversion |
converts to a model’s texture coordinate space, creates 3D mapping
|
5.0 |
observer conversion |
converts a 3D mapping to a frustum
Other values for scale and offset are only used, if there is a splitted windows display used as a single export. Then x=1/number of horiziontal displays, z=1/number of vertical displays, y=hIndex*1/number of horizontal displays.
|
5.0 | |
pseudo 3D plane |
creates a 3D mapping from a normal camera scan
|
5.0 | |
pseudo 3D cylinder |
creates a 360° panorama from a fisheye camera scan, creates 3D mapping
|
5.0 | |
pseudo 3D sphere |
creates 3D mapping of fisheye camera scan
|
5.0 | |
pseudo 3D equirectangular |
creates 3D mapping of fisheye camera scan
|
5.0 | |
auto frustum |
creates a frustum from 3D data of each display, named after the display
|
5.0 | |
apply vc |
the VC is applied to the 2D mapping. Use before a conversion to effect positions, use after to warp and mask
|
5.0 | |
Device |
a device (display or camera) name. This task is only applied to mappings coming from a device with that name | 5.0 | |
Core |
a core IP address or (computer’s network) name. This task is only applied to mappings coming from a client with that IP or name | 5.0 |
Sub tags, see Format attribute for exact usage:
- CommonParam
- SpecialParam
TransferTask
Used to transfer a mapping or part of a mapping to a device or file.
Note:
- Always use
Format=”vwf”
in CalibCommerceTask to gather all data - You need the attribute
bUse3D
, if you do the conversion creating the 3D mapping in an export definition file
Attribute | default value | description | version |
---|---|---|---|
Format |
export format, see CalibCommerceTask:Format | 5.0 | |
Device |
a device (display) name. This task is only applied to mappings referring to a device with that name. |
5.0 | |
Core |
a core IP address or (computer’s network) name. This task is only applied to mappings referring to a client with that IP or name |
5.0 | |
bUse3D |
0 | use 3D mapping, if just created by a conversion | 5.0 |
vCntOffsetX |
0 | horizontal pixel offset of input content to virtual content. Make sure to specify virtual content size in <task><SpecialParam> | 5.0 |
vCntOffsetY |
0 | vertical pixel offset of input content to virtual content. Make sure to specify virtual content size in <task><SpecialParam> | 5.0 |
vCntSizeX |
0 | width of input content. Keep 0 to use projector width | 5.4 |
vCntSizeY |
0 | height of input content. Keep 0 to use projector height | 5.4 |
customCntSpaceName |
name of a frustum embedded in export file | 5.0 | |
baseCntSpaceName |
name of a frustum giving the straight ahead view for relative angles of the exported view | 5.0 |
Sub tags:
Destination
: describes a device or file to write the mapping to- Attributes:
Core
: a client/device IP address or computer name to send the data to. This is a PC running SPCalibrator/Anyblend or a warping deviceFileName
: a path, to write the mapping to, on the destination machine
- Attributes: