This is the interface control document for the BackgroundSky plugin HDF database file.
This document is for version 1 of the document.
/Info
Contains the standard datasets described in DIRSIG HDF Standard Info Section.
/LobeAnims
Type |
Group |
Contains sub-groups describing the lobe animations in the file.
/LobeAnims/:name
Type |
Group |
Contains datasets describing the lobe animation with name :name.
/LobeAnims/:name/Lobes
Type |
Dataset |
Data Type |
LOBE |
Dataspace Type |
Simple |
Dimensions |
M |
This is an array of lobe descriptions that define how the lobe animates over time. The data type LOBE is a compound data type with the following members:
| Member Name | Member Type | Description |
|---|---|---|
Type |
NATIVE_UINT |
The type. Must be 1 (HG), 2 (VNDF-GGX), or 3 (VNDF-Beckmann). |
Param0 |
NATIVE_FLOAT |
If Type is 1 (HG), the HG parameter. Else, the VNDF roughness in X. |
Param1 |
NATIVE_FLOAT |
If Type is 1 (HG), unused. Else, the VNDF roughness in Y. |
Coeff |
NATIVE_FLOAT |
The leading coefficient. |
LocalTransform |
NATIVE_FLOAT[4] |
The transform as a unit-length quaternion (real part, imaginary vector part). |
CurveIndex |
NATIVE_UINT |
The associated curve index in /SpectralCurves. |
RelativeTime |
NATIVE_FLOAT |
The relative time in fractional days from /ReferenceTime. |
/LobeAnims/:name/ReferenceTime
Type |
Dataset |
Data Type |
TIME_POINT |
Dataspace Type |
Simple |
Dimensions |
1 |
This defines the reference time by which the /Lobes time series is interpreted. The data type TIME_POINT is a compound data type with the following members:
| Member Name | Member Type | Description |
|---|---|---|
Type |
NATIVE_UINT |
The type. Must be 1 (absolute), 2 (diurnal), or 3 (hedomadal). |
TimePoint |
NATIVE_ULONG |
If Type is 1 (absolute), the absolute time in seconds since 1970 Epoch. Otherwise, unused. |
/SpectralCurves
Type |
Dataset |
Data Type |
NATIVE_FLOAT |
Dataspace Type |
Simple |
Dimensions |
M x N |
Contains M spectral curves, each with N ordinate samples corresponding to the wavelength samples in /SpectralSamples.
/SpectralSamples
Type |
Dataset |
Data Type |
NATIVE_FLOAT |
Dataspace Type |
Simple |
Dimensions |
1 x N |
Contains the wavelengths values in microns for all spectral curves found in the file.