Lua schema endpoint

.gitignore

@@ -54,4 +54,6 @@ report.pdf
 report.xml
 # infracost
 .infracost/
-__pycache__/
+__pycache__/
+tmp_schema_test/
+tmp_schema_test.zip

datasets/bathy/package/BathyDataFrame.cpp

@@ -106,41 +106,41 @@ int BathyDataFrame::luaCreate (lua_State* L)
 BathyDataFrame::BathyDataFrame (lua_State* L, const char* beam_str, BathyFields* _parms, H5Object* _hdf03, H5Object* _hdf09, const char* rqstq_name, BathyMask* _mask):
     GeoDataFrame(L, LUA_META_NAME, LUA_META_TABLE,
     {
-        {"time_ns",             &time_ns},
-        {"index_ph",            &index_ph},
-        {"index_seg",           &index_seg},
-        {"lat_ph",              &lat_ph},
-        {"lon_ph",              &lon_ph},
-        {"x_ph",                &x_ph},
-        {"y_ph",                &y_ph},
-        {"x_atc",               &x_atc},
-        {"y_atc",               &y_atc},
-        {"surface_h",           &surface_h},
-        {"ortho_h",             &ortho_h},
-        {"ellipse_h",           &ellipse_h},
-        {"sigma_thu",           &sigma_thu},
-        {"sigma_tvu",           &sigma_tvu},
-        {"processing_flags",    &processing_flags},
-        {"max_signal_conf",     &max_signal_conf},
-        {"quality_ph",          &quality_ph},
-        {"class_ph",            &class_ph},
-        {"geoid_corr_h",        &geoid_corr_h},
+        {"time_ns",             &time_ns,               "GPS nanoseconds"},
+        {"index_ph",            &index_ph,              "photon index"},
+        {"index_seg",           &index_seg,             "segment index"},
+        {"lat_ph",              &lat_ph,                "photon latitude"},
+        {"lon_ph",              &lon_ph,                "photon longitude"},
+        {"x_ph",                &x_ph,                  "photon UTM easting (m)"},
+        {"y_ph",                &y_ph,                  "photon UTM northing (m)"},
+        {"x_atc",               &x_atc,                 "along-track distance (m)"},
+        {"y_atc",               &y_atc,                 "across-track distance (m)"},
+        {"surface_h",           &surface_h,             "sea surface height (m)"},
+        {"ortho_h",             &ortho_h,               "orthometric height (m)"},
+        {"ellipse_h",           &ellipse_h,             "ellipsoidal height (m)"},
+        {"sigma_thu",           &sigma_thu,             "total horizontal uncertainty (m)"},
+        {"sigma_tvu",           &sigma_tvu,             "total vertical uncertainty (m)"},
+        {"processing_flags",    &processing_flags,      "processing flags"},
+        {"max_signal_conf",     &max_signal_conf,       "maximum signal confidence"},
+        {"quality_ph",          &quality_ph,            "photon quality flag"},
+        {"class_ph",            &class_ph,              "photon classification"},
+        {"geoid_corr_h",        &geoid_corr_h,          "geoid correction (m)"},
         // temporary columns for python code
-        {"refracted_dZ",        &refracted_dZ},
-        {"refracted_lat",       &refracted_lat},
-        {"refracted_lon",       &refracted_lon},
-        {"subaqueous_sigma_thu", &subaqueous_sigma_thu},
-        {"subaqueous_sigma_tvu", &subaqueous_sigma_tvu}
+        {"refracted_dZ",        &refracted_dZ,          "refraction depth correction (m)"},
+        {"refracted_lat",       &refracted_lat,         "refraction-corrected latitude"},
+        {"refracted_lon",       &refracted_lon,         "refraction-corrected longitude"},
+        {"subaqueous_sigma_thu", &subaqueous_sigma_thu, "subaqueous horizontal uncertainty (m)"},
+        {"subaqueous_sigma_tvu", &subaqueous_sigma_tvu, "subaqueous vertical uncertainty (m)"}
     },
     {
-        {"spot",                &spot},
-        {"beam",                &beam},
-        {"track",               &track},
-        {"pair",                &pair},
-        {"utm_zone",            &utm_zone},
-        {"utm_is_north",        &utm_is_north},
-        {"bounding_polygon_lat",&bounding_polygon_lat},
-        {"bounding_polygon_lon",&bounding_polygon_lon}
+        {"spot",                &spot,                  "spot number (1-6)"},
+        {"beam",                &beam,                  "beam name"},
+        {"track",               &track,                 "track number"},
+        {"pair",                &pair,                  "beam pair"},
+        {"utm_zone",            &utm_zone,              "UTM zone number"},
+        {"utm_is_north",        &utm_is_north,          "UTM hemisphere (1=north, 0=south)"},
+        {"bounding_polygon_lat",&bounding_polygon_lat,  "bounding polygon latitudes"},
+        {"bounding_polygon_lon",&bounding_polygon_lon,  "bounding polygon longitudes"}
     },
     Icesat2Fields::defaultEGM(_parms->granuleFields.version.value)),
     beam(beam_str),

datasets/casals/package/Casals1bDataFrame.cpp

@@ -61,6 +61,9 @@ const struct luaL_Reg Casals1bDataFrame::LUA_META_TABLE[] = {
  *----------------------------------------------------------------------------*/
 int Casals1bDataFrame::luaCreate (lua_State* L)
 {
+    if(lua_gettop(L) == 0)
+        return createLuaObject(L, new Casals1bDataFrame(L, NULL, NULL, NULL));
+
     CasalsFields* _parms = NULL;
     H5Object* _hdf1b = NULL;
 
@@ -89,33 +92,33 @@ int Casals1bDataFrame::luaCreate (lua_State* L)
 Casals1bDataFrame::Casals1bDataFrame (lua_State* L, CasalsFields* _parms, H5Object* _hdf1b, const char* outq_name):
     GeoDataFrame(L, LUA_META_NAME, LUA_META_TABLE,
     {
-        {"time_ns",         &time_ns},
-        {"latitude",        &latitude},
-        {"longitude",       &longitude},
-        {"refh",            &refh},
+        {"time_ns",         &time_ns,       "GPS nanoseconds"},
+        {"latitude",        &latitude,      "latitude"},
+        {"longitude",       &longitude,     "longitude"},
+        {"refh",            &refh,          "reference height (m)"},
     },
     {
-        {"granule",         &granule}
+        {"granule",         &granule,       "source granule name"}
     },
-    CasalsFields::crsITRF2020()),
-    granule(_hdf1b->name, META_SOURCE_ID),
+    _parms ? CasalsFields::crsITRF2020() : NULL),
+    granule(_hdf1b ? _hdf1b->name : "", META_SOURCE_ID),
     active(false),
     readerPid(NULL),
-    readTimeoutMs(_parms->readTimeout.value * 1000),
+    readTimeoutMs(_parms ? _parms->readTimeout.value * 1000 : 0),
     outQ(NULL),
     parms(_parms),
     hdf1b(_hdf1b),
-    dfKey(1)
+    dfKey(_parms ? 1 : 0)
 {
-    assert(_parms);
-    assert(_hdf1b);
+    /* Call Parent Class Initialization of GeoColumns */
+    populateGeoColumns();
+
+    /* Schema-only: skip all runtime initialization */
+    if(!_parms) return;
 
     /* Setup Output Queue (for messages) */
     if(outq_name) outQ = new Publisher(outq_name);
 
-    /* Call Parent Class Initialization of GeoColumns */
-    populateGeoColumns();
-
     /* Set Thread Specific Trace ID for H5Coro */
     EventLib::stashId (traceId);
 
@@ -132,8 +135,8 @@ Casals1bDataFrame::~Casals1bDataFrame (void)
     active.store(false);
     delete readerPid;
     delete outQ;
-    parms->releaseLuaObject();
-    hdf1b->releaseLuaObject();
+    if(parms) parms->releaseLuaObject();
+    if(hdf1b) hdf1b->releaseLuaObject();
 }
 
 /*----------------------------------------------------------------------------

datasets/gedi/package/Gedi01bDataFrame.cpp

@@ -57,6 +57,9 @@ const struct luaL_Reg Gedi01bDataFrame::LUA_META_TABLE[] = {
  *----------------------------------------------------------------------------*/
 int Gedi01bDataFrame::luaCreate (lua_State* L)
 {
+    if(lua_gettop(L) == 0)
+        return createLuaObject(L, new Gedi01bDataFrame(L, NULL, NULL, NULL, NULL));
+
     GediFields* _parms = NULL;
     H5Object* _hdf01b = NULL;
 
@@ -86,18 +89,18 @@ int Gedi01bDataFrame::luaCreate (lua_State* L)
 Gedi01bDataFrame::Gedi01bDataFrame (lua_State* L, const char* beam_str, GediFields* _parms, H5Object* _hdf01b, const char* outq_name):
     GediDataFrame(L, LUA_META_NAME, LUA_META_TABLE,
     {
-        {"shot_number",         &shot_number},
-        {"time_ns",             &time_ns},
-        {"latitude",            &latitude},
-        {"longitude",           &longitude},
-        {"elevation_start",     &elevation_start},
-        {"elevation_stop",      &elevation_stop},
-        {"solar_elevation",     &solar_elevation},
-        {"tx_size",             &tx_size},
-        {"rx_size",             &rx_size},
-        {"flags",               &flags},
-        {"tx_waveform",         &tx_waveform},
-        {"rx_waveform",         &rx_waveform}
+        {"shot_number",         &shot_number,       "unique shot identifier"},
+        {"time_ns",             &time_ns,           "GPS nanoseconds"},
+        {"latitude",            &latitude,          "latitude"},
+        {"longitude",           &longitude,         "longitude"},
+        {"elevation_start",     &elevation_start,   "waveform start elevation (m)"},
+        {"elevation_stop",      &elevation_stop,    "waveform stop elevation (m)"},
+        {"solar_elevation",     &solar_elevation,   "solar elevation angle (deg)"},
+        {"tx_size",             &tx_size,           "transmit waveform sample count"},
+        {"rx_size",             &rx_size,           "receive waveform sample count"},
+        {"flags",               &flags,             "quality flags"},
+        {"tx_waveform",         &tx_waveform,       "transmit waveform"},
+        {"rx_waveform",         &rx_waveform,       "receive waveform"}
     },
     _parms,
     _hdf01b,
@@ -107,6 +110,9 @@ Gedi01bDataFrame::Gedi01bDataFrame (lua_State* L, const char* beam_str, GediFiel
     /* Call Parent Class Initialization of GeoColumns */
     populateGeoColumns();
 
+    /* Schema-only: skip all runtime initialization */
+    if(!_parms) return;
+
     /* Set Thread Specific Trace ID for H5Coro */
     EventLib::stashId (traceId);
 

datasets/gedi/package/Gedi02aDataFrame.cpp

@@ -53,6 +53,9 @@ const struct luaL_Reg Gedi02aDataFrame::LUA_META_TABLE[] = {
  *----------------------------------------------------------------------------*/
 int Gedi02aDataFrame::luaCreate (lua_State* L)
 {
+    if(lua_gettop(L) == 0)
+        return createLuaObject(L, new Gedi02aDataFrame(L, NULL, NULL, NULL, NULL));
+
     GediFields* _parms = NULL;
     H5Object* _hdf02a = NULL;
 
@@ -82,15 +85,15 @@ int Gedi02aDataFrame::luaCreate (lua_State* L)
 Gedi02aDataFrame::Gedi02aDataFrame (lua_State* L, const char* beam_str, GediFields* _parms, H5Object* _hdf02a, const char* outq_name):
     GediDataFrame(L, LUA_META_NAME, LUA_META_TABLE,
     {
-        {"shot_number",         &shot_number},
-        {"time_ns",             &time_ns},
-        {"latitude",            &latitude},
-        {"longitude",           &longitude},
-        {"elevation_lm",        &elevation_lm},
-        {"elevation_hr",        &elevation_hr},
-        {"solar_elevation",     &solar_elevation},
-        {"sensitivity",         &sensitivity},
-        {"flags",               &flags}
+        {"shot_number",         &shot_number,       "unique shot identifier"},
+        {"time_ns",             &time_ns,           "GPS nanoseconds"},
+        {"latitude",            &latitude,          "latitude"},
+        {"longitude",           &longitude,         "longitude"},
+        {"elevation_lm",        &elevation_lm,      "elevation lowest mode (m)"},
+        {"elevation_hr",        &elevation_hr,      "elevation highest return (m)"},
+        {"solar_elevation",     &solar_elevation,   "solar elevation angle (deg)"},
+        {"sensitivity",         &sensitivity,       "beam sensitivity"},
+        {"flags",               &flags,             "quality flags"}
     },
     _parms,
     _hdf02a,
@@ -100,6 +103,9 @@ Gedi02aDataFrame::Gedi02aDataFrame (lua_State* L, const char* beam_str, GediFiel
     /* Call Parent Class Initialization of GeoColumns */
     populateGeoColumns();
 
+    /* Schema-only: skip all runtime initialization */
+    if(!_parms) return;
+
     /* Set Thread Specific Trace ID for H5Coro */
     EventLib::stashId (traceId);
 

datasets/gedi/package/Gedi04aDataFrame.cpp

@@ -53,6 +53,9 @@ const struct luaL_Reg Gedi04aDataFrame::LUA_META_TABLE[] = {
  *----------------------------------------------------------------------------*/
 int Gedi04aDataFrame::luaCreate (lua_State* L)
 {
+    if(lua_gettop(L) == 0)
+        return createLuaObject(L, new Gedi04aDataFrame(L, NULL, NULL, NULL, NULL));
+
     GediFields* _parms = NULL;
     H5Object* _hdf04a = NULL;
 
@@ -82,15 +85,15 @@ int Gedi04aDataFrame::luaCreate (lua_State* L)
 Gedi04aDataFrame::Gedi04aDataFrame (lua_State* L, const char* beam_str, GediFields* _parms, H5Object* _hdf04a, const char* outq_name):
     GediDataFrame(L, LUA_META_NAME, LUA_META_TABLE,
     {
-        {"shot_number",         &shot_number},
-        {"time_ns",             &time_ns},
-        {"latitude",            &latitude},
-        {"longitude",           &longitude},
-        {"agbd",                &agbd},
-        {"elevation",           &elevation},
-        {"solar_elevation",     &solar_elevation},
-        {"sensitivity",         &sensitivity},
-        {"flags",               &flags}
+        {"shot_number",         &shot_number,       "unique shot identifier"},
+        {"time_ns",             &time_ns,           "GPS nanoseconds"},
+        {"latitude",            &latitude,          "latitude"},
+        {"longitude",           &longitude,         "longitude"},
+        {"agbd",                &agbd,              "above ground biomass density (Mg/ha)"},
+        {"elevation",           &elevation,         "elevation (m)"},
+        {"solar_elevation",     &solar_elevation,   "solar elevation angle (deg)"},
+        {"sensitivity",         &sensitivity,       "beam sensitivity"},
+        {"flags",               &flags,             "quality flags"}
     },
     _parms,
     _hdf04a,
@@ -100,6 +103,9 @@ Gedi04aDataFrame::Gedi04aDataFrame (lua_State* L, const char* beam_str, GediFiel
     /* Call Parent Class Initialization of GeoColumns */
     populateGeoColumns();
 
+    /* Schema-only: skip all runtime initialization */
+    if(!_parms) return;
+
     /* Set Thread Specific Trace ID for H5Coro */
     EventLib::stashId (traceId);
 

datasets/gedi/package/GediDataFrame.cpp

@@ -51,28 +51,28 @@
                              GediFields* _parms, H5Object* _hdf, const char* beam_str, const char* outq_name):
     GeoDataFrame(L, meta_name, meta_table, column_list,
     {
-        {"beam",    &beam},
-        {"orbit",   &orbit},
-        {"track",   &track},
-        {"granule", &granule}
+        {"beam",    &beam,    "beam number"},
+        {"orbit",   &orbit,   "orbit number"},
+        {"track",   &track,   "track number"},
+        {"granule", &granule, "source granule name"}
     },
     getCRS()),
     beam(0, META_COLUMN),
-    orbit(static_cast<uint32_t>(_parms->granule_fields.orbit.value), META_COLUMN),
-    track(static_cast<uint16_t>(_parms->granule_fields.track.value), META_COLUMN),
-    granule(_hdf->name, META_SOURCE_ID),
+    orbit(_parms ? static_cast<uint32_t>(_parms->granule_fields.orbit.value) : 0, META_COLUMN),
+    track(_parms ? static_cast<uint16_t>(_parms->granule_fields.track.value) : 0, META_COLUMN),
+    granule(_hdf ? _hdf->name : "", META_SOURCE_ID),
     active(false),
     readerPid(NULL),
-    readTimeoutMs(_parms->readTimeout.value * 1000),
+    readTimeoutMs(_parms ? _parms->readTimeout.value * 1000 : 0),
     outQ(NULL),
     parms(_parms),
     hdf(_hdf),
     dfKey(0),
-    beamStr(StringLib::duplicate(beam_str)),
+    beamStr(beam_str ? StringLib::duplicate(beam_str) : NULL),
     group{0}
 {
-    assert(_parms);
-    assert(_hdf);
+    /* Schema-only: skip all runtime initialization */
+    if(!_parms) return;
 
     /* Resolve Beam */
     const int beam_index = beamIndexFromString(beam_str);