GDBMETA

Description

GDBMETA creates an XML file of metadata extracted from a GDB file.

Parameters

gdbmeta(mfile, filo, tfile, cps, sltype, dbic, dbsl, foptions)

Name	Type	Caption	Length	Value range
MFILE	str	Input file, folder, or text file	0 -
FILO	str	Name of output file	0 -
TFILE	str	Name of transformation file	0 -
CPS	str	Complementary projection string	0 -
SLTYPE	str	Type of input segment	0 -
DBIC	List[int]	Input channel numbers	0 - 48	1 -
DBSL	List[int]	Input segment numbers	0 - 48	1 -
FOPTIONS	str	Options for output file	0 -

Parameter descriptions

MFILE

The name of a file, or a folder or text file that contains the data to process. If necessary, you can use a wildcard–the asterisk (*)–in the string.

You can specify the value of the parameter by using any of the following:

A file; for example, "irvine.pix" or "C:\data\irvine.pix".
A file-name pattern or all of the files in a folder; for example, "C:\data\*.pix" or "C:\data".
An existing text file that contains references to multiple files with, optionally, different parameter settings per file; for example, "C:\list.txt". The paths in the file can be absolute or relative to the folder location of the text file. With the text file, each line must have the following format:
- File;<parameter_1>;<parameter_n>

With a text file, the following general rules apply:

The file containing multiple files and different parameter values must have a .txt file name extension.
List each set of parameters on its own line in the same order as occurs in the algorithm.
Specify string parameters in quotation marks.
Do not specify numeric parameters in quotation marks.
A quotation mark preceded by a backslash is read as part of the string. For example, ab\"c is used as: ab"c.
Precede comments in the file with an exclamation mark (!).
Use semicolons to delimit the parameters.
When you do not want to specify a value, leave the position between the semicolons empty (";;"). Alternatively, if there are no remaining parameters to specify at the end of a line, you can leave it blank.
Parameters in a text file may or may not be specified in the algorithm; that is:
- If a parameter is specified in the algorithm and in the text file, the value in the text file is used.
- If a parameter is not specified in the text file, you can specify the parameter in the algorithm.

FILO

The name of the XML file to which to write the generated metadata.

If you do not specify a value for this parameter, the name of the output XML file is based on that of the input file, but with an .xml extension.

TFILE

The name of the transformation file.

You can specify the value of the parameter by using any of the following:

GDBMETA1_0_0: Produces GBD XML metadata (default); that is, no transformation occurs. You can find the XML Schema in $PCIHOME/etc/gdbmetadata1_0_0.xsd..
<name_of_XSLT_file>: Name of XSLT file to run to transform from the GDBMETA1_0_0 form to another format.

CPS

Generates entries in the output in the requested projections, or map units, which can be useful for reprojecting the bounding boxes to the list of projections.

Use a semicolon (;) as a delimiter between each projection string.

To generate a complementary projection that is the best UTM zone for the image, enter a value of UTM. The best UTM zone is the one that produces the least amount of distortion.

SLTYPE

The GDB-supported data types used for any specified segments (DBSL).

Bitmap and vector bounding boxes will be reprojected when you specify a value for CPS. Other types of segment-held metadata will be copied directly to the output file.

SLTYPE and DBIC are mutually exclusive. SLTYPE and DBSL are mutually exclusive.

You can specify the value as any one of the following segment types:

VEC: Extracts metadata from vector segments
LUT: Extracts metadata from lookup-table segments
PCT: Extracts metadata from pseudocolor-table segments
GCP: Extracts metadata from ground control point segments
ORB: Extracts metadata from orbit segments
SIG: Extracts metadata from signature segments
TEX: Extracts metadata from text segments
GEO: Extracts metadata from georeferencing segments
BIT: Extracts metadata from bitmap segments (1 bit-per-pixel raster)
CHANS: Extracts metadata from all channels
FILE: Produces only file-level metadata
ALL: Extracts metadata from all segments and channels

DBIC

The list of channels for which to produce metadata.

If you do not specify a value, all channels are processed. Channels that do not exist will be ignored.

DBIC and SLTYPE are mutually exclusive.

DBSL

The list of segments for which to produce metadata.

If you do not specify a value, all segments are processed. Segments that do not exist will be ignored.

DBSL and SLTYPE are mutually exclusive.

FOPTIONS

The options to apply when creating the output file.

You can specify the value as any one of the following:

RELATIVE: Write relative paths to the referenced files (default).
ABSOLUTE: Write absolute paths to the referenced files.

RELATIVE and ABSOLUTE are mutually exclusive. When you specify both, the last one is used.

NOFOOTPRINT: No footprint information is written. Determining valid footprint information can require extensive system resources; therefore, NOFOOTPRINT is the default.
CONVEXHULL: Write the convex hull of all valid data in the image.

CONVEXHULL and NOFOOTPRINT are mutually exclusive. When you specify both, the last one is used.

WKT: Writes a Well-known text (WKT) subsection to each projection section (default).
NOWKT: No WKT subsections are written to the projection sections.

WKT and NOWKT are mutually exclusive. When you specify both, the last one is used.

TIME: Writes date-and-time information (default).
NOTIME: No date-and-time information is written.

TIME and NOTIME are mutually exclusive. When you specify both, the last one is used.

HISTORY: Writes history data (default).
NOHISTORY: No history data is written.

HISTORY and NOHISTORY are mutually exclusive. When you specify both, the last one is used.

KVP: Writes key/value pair (KVP) metadata tags (default).
NOKVP: No KVP metadata data is written.

KVP and NOKVP are mutually exclusive. When you specify both, the last one is used.

FILENAMES: Writes file names (default).
NOFILENAMES: No file names are written, except file names in KVP sections.

FILENAMES and NOFILENAMES are mutually exclusive. When you specify both, the last one is used.

COMPACT: Writes the XML in compact format (default).
PRETTYPRINT: Writes the XML in pretty-print format.

COMPACT and PRETTYPRINT are mutually exclusive. When you specify both, the last one is used.

Note: When you specify an XSLT file for TFILE, COMPACT and PRETTYPRINT are ignored.

Details

GDBMETA extracts GDB metadata from the file or files specified.

If necessary, you can specify a complimentary projection string, such as UTM, for CPS. That is, when you want to know, for example, the inherent projection and the longitude and latitude, you can use a complimentary projection string to generate extra bounding boxes for each.

Example

The following example transfers all metadata from irvine.pix to an XML file in GDBMETA1_0_0 format.

from pci.gdbmeta import gdbmeta
mfile="irvine.pix"           # input file from which to extract metadata
filo="meta_irvine.xml"       # output XML file to which to write metadata
tfile=''                     # GDB XML data as output (default)
cps=''                       # no extra bounding boxes
sltype='ALL'                 # extract metadata from all channels and segments
dbic=[]                      # process all channels (default)
dbsl=[]                      # process all segments (default)
foptions=''
gdbmeta(mfile, filo, tfile, cps, sltype, dbic, dbsl, foptions)

Environments	PYTHON :: EASI :: MODELER
Quick links	Description :: Parameters :: Parameter descriptions :: Details :: Example :: Related