FreeBSD Manual Pages
GDALMDIMTRANSLATE(1) GDAL GDALMDIMTRANSLATE(1) NAME gdalmdimtranslate - Converts multidimensional data between different for- mats, and perform subsetting. SYNOPSIS Usage: gdalmdimtranslate [--help] [--long-usage] [--help-general] [-if <format>]... [-of <output_format>] [-co <NAME>=<VALUE>]... [[-array <array_spec>]...] [-arrayoption <NAME>=<VALUE>]... [[-group <group_spec>]...] [-subset <subset_spec>]... [-scaleaxes <scaleaxes_spec>] [-strict] [-oo <NAME>=<VALUE>]... [--quiet] <src_dataset> <dst_dataset> DESCRIPTION gdalmdimtranslate program converts multidimensional raster between differ- ent formats, and/or can perform selective conversion of specific arrays and groups, and/or subsetting operations. TIP: Equivalent in new "gdal" command line interface: See gdal mdim convert. The following command line parameters can appear in any order. --help Show this help message and exit --help-general Gives a brief usage message for the generic GDAL commandline options and exit. -q, --quiet Suppress progress messages and other non-error output. -if <format> Format/driver name to be attempted to open the input file(s). It is generally not necessary to specify it, but it can be used to skip automatic driver detection, when it fails to select the appropriate driver. This option can be repeated several times to specify sev- eral candidate drivers. Note that it does not force those drivers to open the dataset. In particular, some drivers have requirements on file extensions. Added in version 3.2. -of <format> Select the output format. This can be a format that supports multi- dimensional output (such as NetCDF: Network Common Data Form, Multidimensional VRT), or a "classic" 2D formats, if only one single 2D array results of the other specified conversion operations. When this option is not specified, the format is guessed when possible from the extension of the destination filename. -co <NAME>=<VALUE> Many formats have one or more optional creation options that can be used to control particulars about the file created. The creation options available vary by format driver, and some sim- ple formats have no creation options at all. A list of options sup- ported for a format can be listed with the --format command line op- tion but the documentation for the format is the definitive source of information on driver creation options. See Raster drivers for- mat specific documentation for legal creation options for each for- mat. Array-level creation options may be passed by prefixing them with ARRAY:. See GDALGroup::CopyFrom() for further details regarding such options. -array <array_spec> Instead of converting the whole dataset, select one array, and pos- sibly perform operations on it. This option can be specified several times to operate on different arrays. <array_spec> may be just an array name, potentially using a fully qualified syntax (/group/subgroup/array_name). Or it can be a combi- nation of options with the syntax: name={src_array_name}[,dst- name={dst_array_name}][,resample=yes][,trans- pose=[{axis1},{axis2},...][,view={view_expr}] The following options are processed in that order: * resample=yes asks for the array to run through GDALMDArray::GetResampled(). * [{axis1},{axis2},...] is the argument of GDALMDArray::Transpose(). For example, transpose=[1,0] switches the axis order of a 2D array. See Example 5. * {view_expr} is the value of the viewExpr argument of GDALMDArray::GetView(). See Example 4. When specifying a view_expr that performs a slicing or subsetting on a dimension, the equivalent operation will be applied to the corre- sponding indexing variable. -arrayoption <NAME>=<VALUE> Added in version 3.9. Option passed to GDALGroup::GetMDArrayNames() to filter reported ar- rays. Such option is format specific. Consult driver documentation. This option may be used several times. -group <group_spec> Instead of converting the whole dataset, select one group, and pos- sibly perform operations on it. This option can be specified several times to operate on different groups. If only one group is speci- fied, its content will be copied directly to the target root group. If several ones are specified, they are copied under the target root group <group_spec> may be just a group name, potentially using a fully qualified syntax (/group/subgroup/subsubgroup_name). Or it can be a combination of options with the syntax: name={src_group_name}[,dst- name={dst_group_name}][,recursive=no] -subset <subset_spec> Performs a subsetting (trimming or slicing) operation along a dimen- sion, provided that it is indexed by a 1D variable of numeric or string data type, and whose values are monotonically sorted. <sub- set_spec> follows exactly the OGC WCS 2.0 KVP encoding for subset- ting. That is dim_name(min_val,max_val) or dim_name(sliced_val) The first syntax will subset the dimension dim_name to values in the [min_val,max_val] range. The second syntax will slice the dimension dim_name to value sliced_val (and this dimension will be removed from the arrays that reference to it) Using -subset is incompatible with specifying a view option in -ar- ray. See Example 2. -scaleaxes <scaleaxes_spec> Applies a integral scale factor to one or several dimensions, that is extract 1 value every N values (without resampling). <scaleaxes_spec> follows exactly the syntax of the KVP encoding of the SCALEAXES parameter of OGC WCS 2.0 Scaling Extension, but lim- ited to integer scale factors. That is <dim1_name>(<scale_factor>)[,<dim2_name>(<scale_factor>)]... Using -scaleaxes is incompatible with specifying a view option in -array. See Example 3. -strict By default, some failures during the translation are tolerated, such as not being able to write group attributes. When setting this op- tion, such failures will cause the process to fail. -oo <NAME>=<VALUE> Added in version 3.4. Source dataset open option (format specific) <src_dataset> The source dataset name. <dst_dataset> The destination file name. RETURN STATUS CODE The program returns status code 0 in case of success, and non-zero in case of error (non-blocking errors emitted as warnings are considered as a suc- cessful execution). C API This utility is also callable from C with GDALMultiDimTranslate(). EXAMPLES Example 1: Convert a netCDF file to a multidimensional VRT file gdalmdimtranslate in.nc out.vrt Example 2: Extract a 2D slice of a time,Y,X array gdalmdimtranslate in.nc out.tif -subset 'time("2010-01-01")' -array temperature Example 3: Subsample along X and Y axis gdalmdimtranslate in.nc out.nc -scaleaxes "X(2),Y(2)" Example 4: Reorder the values of an array Reorder the values of the time,Y,X array along the Y axis from top-to-bot- tom to bottom-to-top (or the reverse) gdalmdimtranslate in.nc out.nc -array "name=temperature,view=[:,::-1,:]" Example 5: Transpose an array that has X,Y,time dimension order to time,Y,X gdalmdimtranslate in.nc out.nc -array "name=temperature,transpose=[2,1,0]" AUTHOR Even Rouault <even.rouault@spatialys.com> COPYRIGHT 1998-2026 Jun 05, 2026 GDALMDIMTRANSLATE(1)
NAME | SYNOPSIS | DESCRIPTION | RETURN STATUS CODE | C API | EXAMPLES | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gdalmdimtranslate&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>