OEPROJSUM

Description

With OEPROJSUM, you specify a CATALYST Professional OrthoEngine project file as the input to create an output file of various attributes of your project and, with vector-based output files, an image footprint. The output file contains summary information about each image in the project file, including:

Image ID
Photo state
Overall root-mean-square (RMS) error representing the combined values from ground control points (GCP) and tie points (TP) for each image in the project
Number of GCPs, TPs, and check points (CP) collected
RMS error for GCPs, TPs, and CPs measured (separately) in pixels and meters for x and y, and measured in meters for z (elevation)
Number of potential overlapping images for each image in the project
Number of overlaps for an image ID served by TPs
Percentage of overlapping images served by TPs

Note: The output file type can be vector-based or text.

Parameters

oeprojsum(oeproji, filo, ftype, foption)

Name	Type	Caption	Length	Value range
OEPROJI *	str	Input OrthoEngine project file	1 -
FILO *	str	Output file name	1 -
FTYPE *	str	Output file type	3 - 4	TXT, PIX, SHP, JSON Default: PIX
FOPTION	str	File creation options	0 - 191

* Required parameter

Parameter descriptions

OEPROJI

The name of the OrthoEngine project file that contains the project imagery, GCPs, TPs, and CPs.

This parameter is mandatory.

FILO

The name of the vector or text file that OEPROJSUM creates on output. This file contains the image footprints (vector-supported only) and attributes for each image and associated GCPs, TPs, CPs, residuals, and overlap-coverage information based on the OrthoEngine project file you specify.

If the input file is a:

Vector-supported format (.pix, .shp), OEPROJSUM creates footprints and associated attributes for each image in the project.
Text file (.txt), OEPROJSUM creates a text file containing only the attributes for each image in the project.

This parameter is mandatory.

FTYPE

The format, or file name extension, of the output file. The format must be GDB-recognized type for vector formats, text, or json.

The supported formats are:

.shp: Arcview shapefile
.pix: PCIDSK file; this is the default setting
.txt: text file
.json: JSON file

FOPTION

The options to apply on creation of the output files. Each format has options specific to it. You need not specify any options for the format; no options is the default.

For FTYPE "JSON", setting this parameter to "COMPACT" will produce compact JSON output, "PRETTY" (the default value) will produce pretty JSON output.

Return Value

Returns: Program execution status

Type: PCI_INT

The return value is 0. This function returns a result only if it runs successfully; otherwise, an exception message is produced.

Details

On successful completion of the run, OEPROJSUM creates an information summary of each image in the OrthoEngine project file you specify as input.

For each image, the summary includes:

Shape ID: unique shape ID of the polygon
Image ID: name of the image in the OrthoEngine project file
numGCP: number of GCPs collected for the image
numTP: number of TPs collected for the image
numCP: number of CPs collected for the image
RMS: overall root-mean-square error for the image
GCPRMS: GCP root-mean-square error for the image
TPRMS: TP root-mean-square error for the image
CPRMS: CP root-mean-square error for the image
MEASOVRLP: total number of overlapping pairs for the image that are served, connected, or both by TPs or stereo GCPs
NUMOVRLP: total number of potential or candidate overlapping pairs for the image
OVRLPCOV: percentage representing the number of overlapping pairs served by TPs or GCPs over all possible overlapping pairs for the image. This is calculated as follows:
```
(MEASOVRLP / NUMOVRLP) * 100
```

For each image in the OrthoEngine project file, OEPROJSUM computes a math model based on the information in the project, and is used to create the footprints and root-mean-square (RMS) errors for each image.

The output file type can be vector-based or text based.

When the specified output file is a:

Vector file, the function reads this math model and the file gmted2010.pix to create an image footprint for each image in the input OrthoEngine project, and creates them as polygons in the output file. The function also creates an attribute table of various fields. For each polygon created, associated attributes are extracted from the input file or derived from information in the project, and used to populate the attribute table.
Text file, OEPROJSUM computes a math model, but does not create vector output (footprints). Instead, the function creates a tab-delimited text file of the same attribute information as the vector output, except footprints. The first line of text contains the attribute field names.

Note: All images in the specified OrthoEngine project file are processed, regardless of whether they are active or inactive.

Example

Create a summary file of an input OrthoEngine project file.

from pci.oeprojsum import oeprojsum

oeproji =   "airphoto_model.prj"    # input OrthoEngine project file
filo    =   "out.txt"               # output file
ftype   =   "txt"                   # output file type
foption =   ""                      # output file options

oeprojsum(oeproji, filo, ftype, foption)

OEPROJSUM creates a text file of various attributes in the OrthoEngine project file specified as input, such as numGCPs, numTPs, numCP, and more.

Environments	PYTHON :: EASI
Quick links	Description :: Parameters :: Parameter descriptions :: Return Value :: Details :: Example