Skip to content

Commit 4638c8f

Browse files
committed
Add example gdal_mdm_doc
1 parent c4a2e0b commit 4638c8f

4 files changed

Lines changed: 36 additions & 1 deletion

File tree

gcore/gdalmultidim.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ std::shared_ptr<GDALDimension> GDALGroup::CreateDimension(
722722
* @param papszOptions Driver specific options determining how the array
723723
* should be created.
724724
*
725-
* @return the new array, or nullptr if case of error
725+
* @return the new array, or nullptr in case of error
726726
*/
727727
std::shared_ptr<GDALMDArray> GDALGroup::CreateMDArray(
728728
CPL_UNUSED const std::string &osName,
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
%feature("docstring") CreateMDArray "
2+
3+
Create a multidimensional array within a group.
4+
5+
See :cpp:func:`GDALGroup::CreateMDArray`.
6+
7+
Parameters
8+
----------
9+
osName : str
10+
name
11+
aoDimensions : list
12+
List of dimensions, ordered from the slowest varying
13+
dimension first to the fastest varying dimension last.
14+
Might be empty for a scalar array (if supported by driver)
15+
oDataType: GDALExtendedDataType
16+
papszOptions : CSLConstList
17+
18+
Returns
19+
-------
20+
21+
GDALMDArray - the new array
22+
23+
Examples
24+
--------
25+
>>> from osgeo import gdal
26+
>>> drv = gdal.GetDriverByName('MEM')
27+
>>> mem_ds = drv.CreateMultiDimensional('myds')
28+
>>> rg = mem_ds.GetRootGroup()
29+
>>> dimX = rg.CreateDimension('X', None, None, 3)
30+
>>> ar = rg.CreateMDArray('ar', [dimX], gdal.ExtendedDataType.Create(gdal.GDT_Byte))
31+
32+
";
33+

swig/include/python/gdal_python.i

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
%include "gdal_band_docs.i"
1111
%include "gdal_dataset_docs.i"
1212
%include "gdal_driver_docs.i"
13+
%include "gdal_mdm_docs.i"
1314
%include "gdal_operations_docs.i"
1415

1516
%init %{

swig/python/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ set(GDAL_PYTHON_CSOURCES
2626
${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_band_docs.i
2727
${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_dataset_docs.i
2828
${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_driver_docs.i
29+
${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_mdm_docs.i
2930
${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_operations_docs.i
3031
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_docs.i
3132
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_featuredef_docs.i

0 commit comments

Comments
 (0)