Skip to main content

Beta Release Notes

Current version: 0.2.0

The changes on this page are relative to 0.1.0 (and earlier).

This page tracks API and naming changes since the GeoBrix project started. After the project is approved, formal release notes will take over; until then, use this as the single place to look up what changed and why.

Conventions:

  • baseline — Name or behavior before the change (what to search for in old code or docs).
  • Notes — Short reason (e.g. standardize across languages, underscore standardization, _geometry → _geom).

General

BaselineCurrentNotes
Python import geobrix.*databricks.labs.gbx.*Match Scala package and published artifact; avoid namespace clashes.
Extra underscores in function names (multi-word parts spelled with _)Single underscore between prefix and compound (e.g. rst_pixelwidth, gbx_bng_cellarea)Underscore standardization: one leading prefix, then one compound word; no _ inside the operation name.

All specific function renames from that standardization are listed in the component tables below.


RasterX

BaselineCurrentNotes
(GDAL reader output column) pathsourceDocs/tests aligned to GDAL reader output column name.
rst_band_metadata / gbx_rst_band_metadatarst_bandmetadata / gbx_rst_bandmetadataUnderscore standardization.
rst_bounding_box / gbx_rst_bounding_boxrst_boundingbox / gbx_rst_boundingboxUnderscore standardization.
rst_pixel_width / gbx_rst_pixel_widthrst_pixelwidth / gbx_rst_pixelwidthUnderscore standardization.
rst_pixel_height / gbx_rst_pixel_heightrst_pixelheight / gbx_rst_pixelheightUnderscore standardization.
rst_num_bands / gbx_rst_num_bandsrst_numbands / gbx_rst_numbandsUnderscore standardization.
rst_pixel_count / gbx_rst_pixel_countrst_pixelcount / gbx_rst_pixelcountUnderscore standardization.
rst_scale_x / gbx_rst_scale_xrst_scalex / gbx_rst_scalexUnderscore standardization.
rst_scale_y / gbx_rst_scale_yrst_scaley / gbx_rst_scaleyUnderscore standardization.
rst_upper_left_x / gbx_rst_upper_left_xrst_upperleftx / gbx_rst_upperleftxUnderscore standardization.
rst_upper_left_y / gbx_rst_upper_left_yrst_upperlefty / gbx_rst_upperleftyUnderscore standardization.
rst_geo_reference / gbx_rst_geo_referencerst_georeference / gbx_rst_georeferenceUnderscore standardization.
rst_get_nodata / gbx_rst_get_nodatarst_getnodata / gbx_rst_getnodataUnderscore standardization.
rst_get_subdataset / gbx_rst_get_subdatasetrst_getsubdataset / gbx_rst_getsubdatasetUnderscore standardization.
rst_mem_size / gbx_rst_mem_sizerst_memsize / gbx_rst_memsizeUnderscore standardization.
rst_sub_datasets / gbx_rst_sub_datasetsrst_subdatasets / gbx_rst_subdatasetsUnderscore standardization.
rst_combine_avg_agg / gbx_rst_combine_avg_aggrst_combineavg_agg / gbx_rst_combineavg_aggUnderscore standardization.
rst_derived_band_agg / gbx_rst_derived_band_aggrst_derivedband_agg / gbx_rst_derivedband_aggUnderscore standardization.
rst_from_content / gbx_rst_from_contentrst_fromcontent / gbx_rst_fromcontentUnderscore standardization.
rst_from_file / gbx_rst_from_filerst_fromfile / gbx_rst_fromfileUnderscore standardization.
rst_from_bands / gbx_rst_from_bandsrst_frombands / gbx_rst_frombandsUnderscore standardization.
rst_make_tiles / gbx_rst_make_tilesrst_maketiles / gbx_rst_maketilesUnderscore standardization.
rst_re_tile / gbx_rst_re_tilerst_retile / gbx_rst_retileUnderscore standardization.
rst_separate_bands / gbx_rst_separate_bandsrst_separatebands / gbx_rst_separatebandsUnderscore standardization.
rst_to_overlapping_tiles / gbx_rst_to_overlapping_tilesrst_tooverlappingtiles / gbx_rst_tooverlappingtilesUnderscore standardization.
rst_init_nodata / gbx_rst_init_nodatarst_initnodata / gbx_rst_initnodataUnderscore standardization.
rst_is_empty / gbx_rst_is_emptyrst_isempty / gbx_rst_isemptyUnderscore standardization.
rst_map_algebra / gbx_rst_map_algebrarst_mapalgebra / gbx_rst_mapalgebraUnderscore standardization.
rst_raster_to_world_coord / gbx_rst_raster_to_world_coord (and X/Y variants)rst_rastertoworldcoord / gbx_rst_rastertoworldcoord (and X/Y)Underscore standardization.
rst_world_to_raster_coord / gbx_rst_world_to_raster_coord (and X/Y variants)rst_worldtorastercoord / gbx_rst_worldtorastercoord (and X/Y)Underscore standardization.
rst_as_format / gbx_rst_as_formatrst_asformat / gbx_rst_asformatUnderscore standardization.
rst_combine_avg / gbx_rst_combine_avgrst_combineavg / gbx_rst_combineavgUnderscore standardization.
rst_h3_raster_to_grid_avg (and Count/Max/Min/Median)rst_h3_rastertogridavg (and Count/Max/Min/Median)Underscore standardization.
rst_bandmetadata(tile) (single arg)rst_bandmetadata(tile, band)Required band parameter added; use e.g. rst_bandmetadata("tile", f.lit(1)).

GridX (BNG)

BaselineCurrentNotes
bng_eastnortasbng (Python) / gbx_bng_eastnortasbng (SQL)bng_eastnorthasbng / gbx_bng_eastnorthasbngStandardize across languages (Python had typo; Scala already eastnorth).
bng_cell_area / gbx_bng_cell_areabng_cellarea / gbx_bng_cellareaUnderscore standardization.
bng_cell_intersection / gbx_bng_cell_intersectionbng_cellintersection / gbx_bng_cellintersectionUnderscore standardization.
bng_cell_union / gbx_bng_cell_unionbng_cellunion / gbx_bng_cellunionUnderscore standardization.
bng_euclidean_distance / gbx_bng_euclidean_distancebng_euclideandistance / gbx_bng_euclideandistanceUnderscore standardization.
bng_point_as_bng / gbx_bng_point_as_bngbng_pointascell / gbx_bng_pointascellUnderscore standardization; Renamed for clarity: point → cell (not "point as BNG").
bng_cell_intersection_agg / gbx_bng_cell_intersection_aggbng_cellintersection_agg / gbx_bng_cellintersection_aggUnderscore standardization.
bng_cell_union_agg / gbx_bng_cell_union_aggbng_cellunion_agg / gbx_bng_cellunion_aggUnderscore standardization.
bng_geometry_kring / gbx_bng_geometry_kringbng_geomkring / gbx_bng_geomkring_geometry → _geom in name.
bng_geometry_kloop / gbx_bng_geometry_kloopbng_geomkloop / gbx_bng_geomkloop_geometry → _geom in name.
bng_geometry_kring_explode / gbx_bng_geometry_kring_explodebng_geomkringexplode / gbx_bng_geomkringexplode_geometry → _geom + underscore standardization.
bng_geometry_kloop_explode / gbx_bng_geometry_kloop_explodebng_geomkloopexplode / gbx_bng_geomkloopexplode_geometry → _geom + underscore standardization.
bng_k_ring / gbx_bng_k_ringbng_kring / gbx_bng_kringUnderscore standardization.
bng_k_loop / gbx_bng_k_loopbng_kloop / gbx_bng_kloopUnderscore standardization.
bng_k_ring_explode / gbx_bng_k_ring_explodebng_kringexplode / gbx_bng_kringexplodeUnderscore standardization.
bng_k_loop_explode / gbx_bng_k_loop_explodebng_kloopexplode / gbx_bng_kloopexplodeUnderscore standardization.
bng_tessellate_explode / gbx_bng_tessellate_explodebng_tessellateexplode / gbx_bng_tessellateexplodeUnderscore standardization.

VectorX

BaselineCurrentNotes
(Schema/column) _geometry_geomStandardize geometry column suffix across readers and examples.
st_legacy_as_wkb / gbx_st_legacy_as_wkbst_legacyaswkb / gbx_st_legacyaswkbUnderscore standardization.

Readers

BaselineCurrentNotes
shapefileshapefile_ogrReader namespace: format + engine to avoid conflicts with other Spark extensions.
geojsongeojson_ogrSame.
ogr_gpkggpkg_ogrSame; consistent format_engine order.
file_gdbfile_gdb_ogrSame.
(none)gtiff_gdalNew reader: named GDAL reader for GeoTIFF; use instead of gdal with option("driver", "GTiff").
info

Reader renames above are planned for 0.2.0. Beta (0.1.x) may still expose the baseline names in some contexts.


How to use this page

  • Migrating code: Search for the baseline name in your code or config; replace with Current and apply any behavior notes.
  • Docs or tests: After a change, add one row here so future readers know what changed and why.
  • After approval: Move content into formal release notes (e.g. per-version sections) and keep this page for historical beta-only changes, or retire it.

Notable improvements and fixes

  • Python package rename: Imports changed from geobrix.* to databricks.labs.gbx.* to align with Scala and the published artifact; update all import statements and environment references.
  • Init script / NumPy: Init script updated to install NumPy 2.x so GDAL Python array operations execute correctly; fixes runtime failures in gbx_rst_mapalgebra and gbx_rst_ndvi when used with array-based paths.
  • Error handling: Functions that previously threw exceptions during execution now surface errors more clearly (e.g. return null or a controlled default with error messages captured) instead of failing with opaque stack traces.
  • RasterX rst_bandmetadata: A required band argument was added; call as rst_bandmetadata(tile, band) (e.g. rst_bandmetadata("tile", f.lit(1))) in Python/SQL/Scala.
  • GDAL reader column: Raster DataFrames from the GDAL reader use the column name source (not path) for the file path; update any code or docs that assumed path.
  • BNG aggregators (bng_cellunion_agg, bng_cellintersection_agg): Fixed a bug where aggregation buffers were shared across partitions (and across tests in the same JVM), causing incorrect core flags when running full test suites or with multiple partitions. Each partition now gets a fresh buffer. Chip fields are resolved by type/name in the union aggregator for robustness to struct field order. Test expectation corrected for “all core chips” intersection: result is now correctly documented as core=true (whole cell).