GENAPMODEL

Description

GENAPMODEL uses camera information, exterior-orientation data, and map units to generate APMODEL segments for multiple files.

Parameters

genapmodel(mfile, xmli, camparam, tfile, mapunits, eotype, eovdatum, angunits, rotkappa)

Name	Type	Caption	Length	Value range
MFILE	str	Input file or folder	0 -
XMLI	str	Input camera-calibration file name	0 -
CAMPARAM	List[float]	Input camera-calibration parameters	0 -
TFILE *	str	Exterior orientation file name	1 -
MAPUNITS *	str	EO map units	1 - 16
EOTYPE *	str	EO format	1 -
EOVDATUM *	str	EO vertical datum	3 -	ELLIPS \| MSL Default: MSL
ANGUNITS *	str	EO angle unit	1 - 8	DEGREES \| GRADIANS \| RADIANS \| DMS
ROTKAPPA *	List[float]	Angle of rotation	1 - 1	Default: 0.0

* Required parameter

Parameter descriptions

MFILE

The name of a folder, image file, or text file in which APMODEL segments are to be generated.

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

A specific data file name or folder path and file name; for example: "irvine.pix" or "C:\data\irvine.pix".
A specific 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 (for example: "C:\list.txt"). The text file must have only one image file name per line.

XMLI

This parameter is mutually exclusive with CAMPARAM.

The name of the XML file that contains the camera-calibration information.

The following formats are supported:

PCI (.xml) camera-calibration file.
Pix4D (.cam) camera-calibration file - the file name must contain the substring "pix4d_calibrated_internal_camera" for it to be detected as a Pix4D file.

For more information about the camera-calibration file, follow the link to CAMIMPORT under Related functions at the end of this topic.

CAMPARAM

This parameter is mutually exclusive with XMLI.

It contains a list of camera calibration values, all floating point (double) values.

If set, it must be given values for the first 3 entries: FOCAL LENGTH, CHIP SIZE WIDTH, and CHIP SIZE HEIGHT. The remaining entries can be omitted, and their default values will be used. If you need to set a specific entry, and don't have some of the previous entries, then you need to set all previous missing entries to their defaults. For example: if you have a YSCALE different than the default, then you need to set all previous CAMPARAM entries, either to their default or to the new value.

CAMPARAM[0]: FOCAL LENGTH - it corresponds to <FL> element value, in millimeters.
CAMPARAM[1]: CHIP SIZE WIDTH - it corresponds to <CHIP_SIZE WIDTH=""> attribute value, in millimeters.
CAMPARAM[2]: CHIP SIZE HEIGHT - it corresponds to <CHIP_SIZE HEIGHT=""> attribute value, in millimeters.
CAMPARAM[3]: PPX - it corresponds to <SYMETRY PPX=""> attribute value, default is 0.0.
CAMPARAM[4]: PPY - it corresponds to <SYMETRY PPY=""> attribute value, default is 0.0.
CAMPARAM[5]: R0 - it corresponds to <RLDC name="R0"> element value, default is 0.0.
CAMPARAM[6]: R1 - it corresponds to <RLDC name="R1"> element value, default is 0.0.
CAMPARAM[7]: R2 - it corresponds to <RLDC name="R2"> element value, default is 0.0.
CAMPARAM[8]: R3 - it corresponds to <RLDC name="R3"> element value, default is 0.0.
CAMPARAM[9]: R4 - it corresponds to <RLDC name="R4"> element value, default is 0.0.
CAMPARAM[10]: R5 - it corresponds to <RLDC name="R5"> element value, default is 0.0.
CAMPARAM[11]: R6 - it corresponds to <RLDC name="R6"> element value, default is 0.0.
CAMPARAM[12]: R7 - it corresponds to <RLDC name="R7"> element value, default is 0.0.
CAMPARAM[13]: P1 - it corresponds to <DDC name="P1"> element value, default is 0.0.
CAMPARAM[14]: P2 - it corresponds to <DDC name="P2"> element value, default is 0.0.
CAMPARAM[15]: P3 - it corresponds to <DDC name="P3"> element value, default is 0.0.
CAMPARAM[16]: P4 - it corresponds to <DDC name="P4"> element value, default is 0.0.
CAMPARAM[17]: YSCALE - it corresponds to <YSCALE> element value, default is 1.0

Note: The return value of the algorithm IIQCOMBINE can be directly passed into the CAMPARAM parameter.

TFILE

The name of the exterior orientation (EO) file. You specify the content of this file (how it is structured) with the EOTYPE parameter.

MAPUNITS

The projection or map units of the EO values in the input EO file.

The standard definitions are:

PIXEL: pixel and line
UTM: Universal Transverse Mercator
SPCS: State Plane Coordinate System
LONG/LAT: longitude and latitude
METER: image along-row and along-column meters
FOOT: image along-row and along-column feet

For a complete list of supported projections and Earth models, see Understanding map projections. For a description of the format of the map units string, see Output units.

EOTYPE

The EOTYPE defines the format of the input EO file.

Supported values are:

BINGO: is a well known EO format.
PATB: is a well known EO format.
IDxxxxxxx: where xxxxxx is a combination of the characters from the following list:

IDxxxxxxx dictates the order of the values of each line in the input EO file. Each line in the input EO file must contain seven or eight values: [ID] [C] [C] [C] [O] [O] [O] {T}

where:

[ID]: is the unique ID of the image where the ID is the name of the file, without the extension and folder parts.
[C] [C] [C]: is the ground coordinates of the image center, where [C] is one of X, Y, or Z. The values of X and Y must be expressed in the units defined by the MAPUNITS parameter. The Z must be expressed in meters relative to the elevation datum specified in EOVDATUM. X, Y, and Z can be in any order, for example: XYZ, YXZ, ZXY
[O] [O] [O]: is the orientation angles, where [O] is one of W, P, or K. W is Omega, P is Phi, and K is Kappa. The values for omega, phi and kappa must be expressed in the angular units specified in ANGUNITS. They can be in any order, for example: WPK, PWK
[O] [O] [O]: is the orientation angles, where [O] is one of R, P, or Y. R is Roll, P is Pitch, and Y is Yaw/heading. The values for roll, pitch and yaw angles must be expressed in the angular units specified in ANGUNITS. The values for roll, pitch and yaw angles, can be in any order, for example: RPY, PRY
{T}: is an optional acquisition date time expressed using the ISO 8601 timestamp format, with or without trailing time zone 'Z' character: YYYY-MM-DDThh:mm:ss.ssss or YYYY-MM-DDThh:mm:ss.ssssZ. No other timezones are allowed. When used, T must be the last character specified in IDxxxxxxx type values for EOTYPE.
Note: If the corresponding image already has a value for the metadata tag Acquisition_DateTime, then it is overwritten with the value from the EO file.

Note: Adding the acquisition date time to the EO data is another way to supply the acquisition date time to ingested airphoto data. For example, if you plan on running the SPECLASS algorithm after this algorithm, then you must provide an acquisition date time, either here, or via another mechanism.

Examples:

EOTYPE = IDXYZWPK
```
image1  123456.12  2345678.9  1000.0  0.1  0.2  50.0
```
- ID=image1
- X=123456.12
- Y=2345678.9
- Z=1000.0
- W=0.1
- P=0.2
- K=50.0
EOTYPE = IDZXYKPWT
```
image1  1000.0  123456.12  2345678.9  50.0  0.2  0.1  2023-01-15T10:31:17.749Z
```
- Same as example 1, but with addition of T=2023-01-15T10:31:17.749Z

The basenames of each input file from the input file or folder are matched against consecutive IDs. Only files with an exact (case-insensitive) match between the file basename and an image ID are accepted for further processing.

Note: The items on a line, in the TFILE can be separated by any combination of the following characters: {tab}, {space}, {semi-colon}, or {comma}. Consecutive separaters are merged to be considered as a single separator.

Note: Lines that do not match the requested structure are ignored.

EOVDATUM

The elevation/vertical datum of all elevation values in the exterior orientation file.

Supported values are:

MSL: Mean Sea Level (default)
ELLIPS: ellipsoid

If the vertical datum of the DEM and the flying height of the camera differ, the EGM2008 geoid model is used for the conversions during orthorectification.

ANGUNITS

The unit of angle of the EO file.

Supported values are:

DEGREES
GRADIANS
RADIANS
DMS

You need only specify a value for this parameter when the value of the EOTYPE parameter is IDxxxxxxx.

Note: When you specify DMS as a value, use the format xdx'x. For example: 100d5'29 represents 100 degrees, 5 minutes and 29 seconds.

ROTKAPPA

The angle of rotation to add to the input kappa values in the ANGUNITS parameter.

In some cases, the kappa values in the EO file must be rotated (such as 90, -90 or 180). Apply the correction by specifying the angle of rotation.

Return Value

Returns: execution status

Type: PCI_INT

The return value is 0. This function returns a result only if it runs successfully; otherwise, processing stops, and an error message is displayed.

Details

GENAPMODEL creates APMODEL segments for multiple PIX files. The input is a camera-calibration file in XML format and a text file that contains the EO value for each PIX file. This function supports BINGO, PAT-B, and user-defined EO formats. In some cases, the kappa values in the exterior orientation file are rotated at a constant value, such as 90, -90, or 180. It is possible to correct the kappa values by specifying a value for the ROTKAPPA parameter.

Example

Read EO data into the PIX file.

You have multiple files in PIX format and want to create an APMODEL segment for each file. The camera-calibration file is stored in the file camera.xml, and the EO values are stored in the file named eo.dat (input EO file). The format of the file is in the form of IDXYZWPK. A rotation of 100 grad is also applied to the kappa values stored in eo.dat.

from pci.genapmodel import genapmodel

mfile = "*.pix"
xmli = "camera.xml"
camparam = []
tfile = "eo.dat"
mapunits = "UTM 17 d0"
eotype = "IDXYZWPK"
eovdatum = "MSL"
angunits = "GRAD"
rotkappa = [100]

genapmodel( mfile, xmli, camparam, tfile, mapunits, eotype, eovdatum, angunits, rotkappa )

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

GENAPMODEL

Generate airphoto model

Description

Parameters

Parameter descriptions

Return Value

Details

Example