====== Orbit Mapping Resources - Structure and Configs ======

This page describes basic technical configurations of Orbit Mapping\UAS Runs and Oblique Projects. 

It is strongly recommended to read first 
  * [[201:technology:3d_mapping:about_resources|]] 
  * [[201:technology:3d_mapping:about_resources_oblique|]]

===== Concepts =====

=== Import Templates ===

All advanced technical configurations related to the used resources and mobile mapping system are managed via the import template and applied on import, so-called "Import configurations". \\
Some additional configurations can be added or updated after import, so-called "Optional configurations".

=== Backwards compatibility and New Features ===

Orbit is constantly improving tools and software which may result in an update of the files and structure of a Mapping Run. \\
Backward compatibility is guaranteed. A newer Orbit release supports mobile mapping runs created by a previous Orbit version. However, to take advantage of new features it is required to use the latest file and run structures.

An Orbit Run version 3 uses the "orbit_mm_run.omr" file as a reference resource file. \\
An Orbit Oblique Project version 3 uses the "orbit_oblique.oop" file as a reference resource file. \\
This updated structure has been developed to optimize performance and to use new tools of the  [[201:products:3dm_content_manager|]] and 3D Mapping Cloud.

For previous version or to convert existing runs\projects into the updated structure, see [[110:mobile_mapping:desktop:mobile_mapping:manage:runs_version|]].

=====  Mapping Run Configurations =====

Configurations to be added into the .omr Mapping Resource root file. \\
Edit and save the configuration files using a standard text editor (e.g. Notepad), respect file formatting and structure. 

==== Parameters editable at Create Run ====

To allow the user to enter any parameter through the user interface following structures are used in *.omr and *.oop:
  * **template.parameters**: general parameter applicable for the whole Run, currently only **PARAM_CRS** and **PARAM_CRS2** (see Source and Target CRS below) can be entered in general parameters
  * **template.parameters.name_of_the_resource**: parameters applicable only for a specific resource in the Run

<code>
Example:
template.parameters.planar1=SensorSizePIXX;SensorSizePIXY;SensorSizeXMM;SensorSizeYMM;PrincipalPointX;PrincipalPointY;FocalLenghtMM;Dist_CV_K1;Dist_CV_K2;Dist_CV_K3;Dist_CV_K4;Dist_CV_K5;Dist_CV_K6;Dist_CV_P1;Dist_CV_P2;Dist_CV_CX;Dist_CV_CY;Dist_CV_FX
template.parameters.planar2=SensorSizePIXX;SensorSizePIXY;SensorSizeXMM;SensorSizeYMM;PrincipalPointX;PrincipalPointY;FocalLenghtMM;Dist_CV_K1;Dist_CV_K2;Dist_CV_K3;Dist_CV_K4;Dist_CV_K5;Dist_CV_K6;Dist_CV_P1;Dist_CV_P2;Dist_CV_CX;Dist_CV_CY;Dist_CV_FX
</code>
Parameters will be read into corresponding {name_of_the_parameter} variable.

==== Source and Target CRS ====

To allow re-projecting of the data from one projection system to another 2 parameters, entered through GUI, are available
  * Source projection system -  **PARAM_CRS**: projection system (CRS) of the source files. We assume that all source files (trajectory, photo positions, point cloud, etc are provided in the same CRS)
  * Target projection system -  **PARAM_CRS2**: final CRS of the Run
<note important>There is only one case when Orbit requires re-projecting of the data: in case if the input files are provided in feet-based CRS, we strongly recommend re-project into the corresponding meter based CRS. In all other cases, we advise keeping data as is as any conversion introduces in-accuracy.</note>

==== Images file extension ====

The used image storage format of original images (panorama or planar).

  * File : <Orbit Run>/orbit_mm_run.omr; <Orbit Run>/orbit_oblique.oop
  * Parameter : ''photo.file.extension''
  * Values : Any supported image resource can be used, see [[201:technology:supported_formats:index|]].\\
  * Default Value : jpg

=== Example ===

<code>
version 3
project.type generic
project.file orbit_mm_run.omr
photo.camera.height 2.20
photo.sequence.key OrbithPhotoId
photo.file.extension tif
template.parameters=PARAM_CRS
</code>

==== Redirect image file directory ====

To avoid file copy into the appropriated Orbit run folder a single line ascii text file can be used to specify the image file path prefix. The file path prefix combined with the OrbitFileName attribute value will be used as file pointer. 

  * File : \\ ''./panorama<x>/original/link.ini'' \\ ''./panorama<x>/processed/link.ini'' \\ ''./planar<x>/original/link.ini'' \\ ''./planar<x>/processed/link.ini'' \\
  * Parameter : not applicable
  * Values : directory path
  * Default Value : 
  * Example <code>
\\192.168.0.1\images\
</code>

==== Camera Height ====

Height of the camera above ground expressed in meters, use dot as decimal separator. This height is used to [[201:desktop_ext:mapping:use:overlay_vector|display 2D vector data]] in the 3D mobile mapping views and for the [[201:technology:3d_mapping:measurements|point drop measure function]]. 

  * File : <Orbit Run>/orbit_mm_run.omr; <Orbit Run>/orbit_oblique.oop
  * Parameter : ''photo.camera.height''
  * Default Value : 2.2
  * Unit : meters

==== 2D Vector Visualization Parameters ====

The possible range of the offset of 2D vector data to the height of the photo position (presented as a slider in the vector overlay parameters pop-up of the photo viewer).

  * File : <Orbit Run>/orbit_mm_run.omr; <Orbit Run>/orbit_oblique.oop
  * Parameters : \\ ''data2d.overlay.min.offset'' \\ ''data2d.overlay.max.offset''\\
  * Default value : 5
  * Unit : meters

Mostly need to be changed for UAS Runs depending on the flying height.

==== Simplified Trajectory ====

At import of photo positions or trajectory the trajectory simplified (coverage) will be created automatically if does not yet exist. The below settings can be used to adjust the defaults, as used in the example below. The creation of the Simplified Trajectory required the OrbitPhotoID to be unique for every image.

Coordinate will be added if its perpendicular drop distance to the segment between the previous and next coordinate is larger than maximum.distance.
  * File : <Orbit Run>/orbit_mm_run.omr 
  * Parameter : ''simplified.trajectory.maximum.distance'' 
  * Values : Integer value
  * Units: meter
  * Default Value : 1

Two consecutive original coordinates won't be connected if segment length is larger than part.separation.
  * File : <Orbit Run>/orbit_mm_run.omr 
  * Parameter : ''simplified.trajectory.part.separation'' 
  * Values : Integer value
  * Units: meter
  * Default Value : 10

The initial sort of coordinates before connecting to lines is based on the string value of the photo.sequence.key attribute(s). Add prefix zero characters to obtain expected sort when using integer value as sort reference.
  * File : <Orbit Run>/orbit_mm_run.omr 
  * Parameter : ''photo.sequence.key''
  * Values : Any photo position attribute, a combination of attributes can be used, e.g. OrbitTimeStamp+ObjectId.
  * Default Value : OrbitPhotoId

Generalization of the trajectory visualization for different viewing scales. It is only recommended to change it in case if trajectory recorded with less than 1 point per meter.
  * File : <Orbit Run>/orbit_mm_run.omr 
  * Parameter : ''simplified.overlay.size.pixels'' 
  * Values : Integer value
  * Units: meter
  * Default Value : 10

=== Example ===

<code>
version 3
project.type generic
project.file orbit_mm_run.omr
photo.camera.height 2.20
simplified.trajectory.maximum.distance 1
simplified.trajectory.part.separation 10
photo.sequence.key OrbithPhotoId
template.parameters=PARAM_CRS
</code>

If any of the parameters are changed after a Run was already imported the simplified trajectory needs to be recalculated. In order that to happen:\\
 - Delete trajectory_simplified.ovt\\
 - Open the Run --> Edit Run --> Re-Import Panorama. When you import panorama's photo positions the simplified trajectory will be recalculated

==== Reference Height ====

Mean terrain height. The value is used as a fall back value for the areas with missing DEM
  * File : <Orbit Run>/orbit_oblique.oop
  * Parameter : ''reference.z''
  * Unit : meter
  * Default value : 0

==== Reference Direction ====

''reference.pan''
Photo orientation offset (heading) between the reference north direction and the actual north flying axis.
  * File : <Orbit Run>/orbit_oblique.oop
  * Parameter : ''reference.pan''
  * Unit : degrees
  * default value : 0°
  * Positive rotation : clockwise

Photo orientation maximal deviation (heading) from the reference directions. All oblique images are assigned to one of the four flying axes based on their heading. The total angle which defines one flying axe class is defined as the reference direction of that flying axe plus twice the near margin value (once on each side of the axe).
  * File : <Orbit Run>/orbit_oblique.oop
  * Parameter : ''near.margin''
  * Unit : degrees
  * Default value : 10°
  * Positive rotation : not applicable as this is an absolute value

==== OrbitPhotoId Unique Image ID====

The OrbitPhotoId must be a unique image id for the entire Mapping Run. \\
Attention required if one run has multiple planar cameras having images with the same filename. Ensure the OrbitPhotoId value to be unique for all images of the entire Mapping Run. \\
If needed use the "concat" function to add a the camera name as prefix to create a unique image id.

==== Timestamp Offset====

Convert timestamp values from GPS Week Seconds to Absolute GPS Time and vice versa for Trajectory, Photo Positions and Point Cloud data. \\
The offset between GPS Week Seconds to Absolute GPS Time. The value can be negative or positive. \\
At "Create Run" the offset value can be entered by the user. The entered value will be used to replace the template place holder Tag  {PARAM_TIMESTAMP_OFFSET}.

=== Trigger user to enter time offset at Create Run ===

  * File: <Orbit Run>/orbit_mapping_run.omr (or orbit_mm_run.omr) \\ <code>template.parameters=PARAM_TIMESTAMP_OFFSET</code>

=== Template Tag to be replaced by user-entered offset value ===

Photo Positions
  * File: <Orbit Run>/<camera>/import/import_locations.ord \\ <code>   AddAttribute=
    AttributeName=OrbitTimestamp
    AttributeType=FLOAT8
    AttributeExpression=Add({PARAM_TIMESTAMP_OFFSET},[Imported Value])</code> 

Trajectory
  * File: <Orbit Run>/trajectyory/import/import_trajectory.ord \\ <code>   AddAttribute=
    AttributeName=OrbitTimestamp
    AttributeType=FLOAT8
    AttributeExpression=Add({PARAM_TIMESTAMP_OFFSET},[Imported Value])</code> 
    
Point Cloud
  * File: <Orbit Run>/pointcloud/import/import.ini \\ <code>TimeOffset {PARAM_TIMESTAMP_OFFSET}</code>

==== Heading and Tilt====

When no orientation heading and tilt are available, it can be calculated based on previous and next photo positions.

  * File : <Orbit Run>/orbit_mm_run.omr 
  * Parameter : ''template.pan_tilt.calculate'' 
  * Values : image folder

=== Example ===

<code>
version 3
project.type generic
project.file orbit_mm_run.omr
photo.camera.height 2.20
template.pan_tilt.calculate panorama1
template.parameters=PARAM_CRS
</code>