Back to Top

Update Oriented Imagery Dataset Properties (Oriented Imagery)

In this topic

  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information

Summary

Updates or modifies oriented imagery dataset properties.

Usage

    Caution:

    This tool modifies the input data. See Tools that modify or update the input data for more information and strategies to avoid undesired data changes.

  • The dataset properties can be used to optimize the dataset. If any dataset property is present as a field in the attribute table with the same value for all the records, the field can be removed from the attribute table and the value can be set as a dataset property. If the field exists in the attribute table, the attribute table value will take precedence over the dataset property value.

  • If a string data type parameter must be removed using the tool in Python, provide a value of "None".

Parameters

DialogPython

LabelExplanationData Type
Oriented Imagery Dataset

The path and name of the oriented imagery dataset.

Oriented Imagery Layer
Maximum Distance
(Optional)

The maximum search distance that will be used when querying the dataset features. The maximum distance cannot be less than zero. The distance is measured in meters.

Double
Coverage Percentage
(Optional)

A percentage that modifies the extent of the image’s ground footprint. The ground footprint of each image is computed to search for images that contain the selected location, which is identified as a red cross on the map.

A negative percentage value reduces the size of the ground footprint and a positive percentage value increases it. This parameter can be used to exclude or include points on the edge of an image. For example, a value of -30 will reduce the size of the footprint by 30 percent and a value of 20 will increase it by 20 percent. Valid values range from -50 to 50.

Double
Footprint Item
(Optional)

The name of the footprint feature class. The feature class should be in the same geodatabase as the oriented imagery dataset.

String
Elevation Source
(Optional)

Specifies the elevation source that will be used.

  • DEM—The elevation source will be a digital elevation model that is a dynamic image service or a tile image service.
  • Constant Elevation—The elevation source will be a constant ground elevation value for the entire dataset.
  • None—The elevation source will be removed.
String
Constant Elevation
(Optional)

The constant ground elevation value for the entire dataset. The Vertical Measurement Unit parameter value will be used as the unit for constant elevation.

This parameter is active when the Elevation Source parameter value is specified as Constant Elevation.

Double
Digital Elevation Model
(Optional)

The URL that references the input digital elevation model. A dynamic image service or a tile image service can be used as the digital elevation model.

This parameter is active when the Elevation Source parameter value is specified as DEM.

Image Service
Level of Detail
(Optional)

The scale defined in a tiling schema. The scale represents the zoom level value. Each successive level improves resolution and map scale by double when compared to the previous level.

This parameter is enabled when the Digital Elevation Model parameter value is a tile image service.

String
Raster Function
(Optional)

The raster function processing template that will be applied to the image service.

This parameter is active when the Digital Elevation Model parameter value is a dynamic image service.

String
Vertical Measurement Unit
(Optional)

Specifies the unit that will be used for all vertical measurements.

  • Meter—Meters will be used as the unit of measurement.
  • Feet—Feet will be used as the unit of measurement.
String
Time Interval Unit
(Optional)

Specifies the time measurement unit that will be used to filter images.

  • Minutes— Images will be filtered by minutes.
  • Hours— Images will be filtered by hours.
  • Days— Images will be filtered by days.
  • Weeks— Images will be filtered by weeks.
  • Months— Images will be filtered by months.
  • Years— Images will be filtered by years.
String
Oriented Imagery Type
(Optional)

Specifies the type of images in the dataset.

  • Horizontal— Images in which the exposure is parallel to the ground and looking to the horizon are in the dataset.
  • Oblique—Images in which the exposure is at an angle to the ground, typically at about 45 degrees, so the sides of objects can be seen are in the dataset.
  • Nadir—Images in which the exposure is perpendicular to the ground and looking straight down are in the dataset. Only the top of objects can be seen.
  • 360—Images taken using cameras that provide 360-degree spherical surround views or have been stitched together as 360-degree views from multiple cameras are in the dataset.
  • Inspection— Close-up images of assets are in the dataset.
  • None—The oriented imagery type will be removed from the dataset.
String
Camera Heading
(Optional)

The camera orientation of the first rotation around the z-axis of the camera. The value is in degrees. The heading values are measured in the positive clockwise direction in which north is defined as 0 degrees. -999 is used when the orientation is unknown.

Double
Camera Pitch
(Optional)

The camera orientation of the second rotation around the x-axis of the camera in the positive counterclockwise direction. The value is in degrees. The pitch is 0 degrees when the camera is facing straight down to the ground. The valid range of pitch is from 0 to 180 degrees, with 180 degrees for a camera facing straight up and 90 degrees for a camera facing the horizon.

Double
Camera Roll
(Optional)

The camera orientation of the final rotation around the z-axis of the camera in the positive clockwise direction. The value is in degrees. Valid values range from -90 to 90.

Double
Camera Height
(Optional)

The height of the camera above the ground when the imagery was captured. The unit is meters. Camera height is used to determine the visible extent of the image. Large values will result in a greater view extent. Values should not be less than 0.

Double
Horizontal Field of View
(Optional)

The camera's scope in the horizontal direction. The value is in degrees. Valid values range from 0 to 360.

Double
Vertical Field of View
(Optional)

The camera's scope in the vertical direction. The value is in degrees. Valid values range from 0 to 180.

Double
Near Distance
(Optional)

The nearest usable distance of the imagery from the camera position. The unit is meters.

Double
Far Distance
(Optional)

The farthest usable distance of the imagery from the camera position. The unit is meters. Far distances should be greater than 0.

Double
Image Rotation
(Optional)

The orientation of the camera in degrees relative to the scene when the image was captured. The rotation is added in addition to the camera roll. Valid values range from-360 to 360.

Double
Orientation Accuracy
(Optional)

The orientation accuracy values. They are represented as a string of eight semicolon-delimited values that define the standard deviation of each value in the following order:

  • Camera location in XY direction
  • Camera Z
  • Camera Heading
  • Camera Pitch
  • Camera Roll
  • Near distance
  • Far distance
  • Elevation of the terrain

All distances are defined in meters unless the coordinate system's units are in feet in which case the units used for distance should be feet. All angles are defined in degrees. If a value is unknown, that value can be excluded. However, this may result in the computed accuracy being higher than the actual value.

For example, if a GPS has a +/- 10 meters root mean square (RMS) error in x,y-coordinates and +/- 20 meters in height, the orientation accuracy value is 10;20.

A typical value for a vehicle-mounted consumer camera is 5;10;5;5;5;0;0;1.

A typical value for oblique imagery following aerial triangulation is 0.01;0.02;0.001;0.001;0.001;0;0;1.

String
Image Path Prefix
(Optional)

The prefix that will be used to build the image path in conjunction with the Image attribute.

String
Image Path Suffix
(Optional)

The suffix that will be used to build the image path in conjunction with the Image attribute.

String
Depth Image Path Prefix
(Optional)

The prefix that will be used to build the depth image path in conjunction with the Depth Image attribute.

String
Depth Image Path Suffix
(Optional)

The suffix that will be used to build the depth image path in conjunction with the Depth Image attribute.

String
DEM Path Prefix
(Optional)

The prefix that will be used to build the digital elevation model path in conjunction with the Elevation Source URL in the attribute.

String
DEM Path Suffix
(Optional)

The suffix that will be used to build the digital elevation model path in conjunction with the Elevation Source URL in the attribute.

String
Image Geometry Field
(Optional)

The field for a feature layer that will be overlayed on the image in the oriented imagery viewer. This field will store the image space geometry of the feature to be overlayed.

String
Image Reference Field
(Optional)

The field for a feature layer that will be overlayed on the image in the oriented imagery viewer. The field will store the unique reference ID of the image in which the feature to be overlayed was created.

String

Derived Output

LabelExplanationData Type
Output Oriented Imagery Dataset

The updated oriented imagery dataset.

Oriented Imagery Dataset

arcpy.oi.UpdateOrientedImageryDatasetProperties(in_oriented_imagery_dataset, {maximum_distance}, {coverage_percent}, {footprint_item}, {elevation_source}, {constant_elevation}, {dem}, {lod}, {raster_function}, {vertical_measurement_unit}, {time_interval_unit}, {oriented_imagery_type}, {camera_heading}, {camera_pitch}, {camera_roll}, {camera_height}, {hfov}, {vfov}, {near_distance}, {far_distance}, {image_rotation}, {orientation_accuracy}, {image_path_prefix}, {image_path_suffix}, {depth_image_path_prefix}, {depth_image_path_suffix}, {dem_path_prefix}, {dem_path_suffix}, {image_geometry_field}, {image_reference_field})
NameExplanationData Type
in_oriented_imagery_dataset

The path and name of the oriented imagery dataset.

Oriented Imagery Layer
maximum_distance
(Optional)

The maximum search distance that will be used when querying the dataset features. The maximum distance cannot be less than zero. The distance is measured in meters.

Double
coverage_percent
(Optional)

A percentage that modifies the extent of the image’s ground footprint. The ground footprint of each image is computed to search for images that contain the selected location, which is identified as a red cross on the map.

A negative percentage value reduces the size of the ground footprint and a positive percentage value increases it. This parameter can be used to exclude or include points on the edge of an image. For example, a value of -30 will reduce the size of the footprint by 30 percent and a value of 20 will increase it by 20 percent. Valid values range from -50 to 50.

Double
footprint_item
(Optional)

The name of the footprint feature class. The feature class should be in the same geodatabase as the oriented imagery dataset.

String
elevation_source
(Optional)

Specifies the elevation source that will be used.

  • DEM—The elevation source will be a digital elevation model that is a dynamic image service or a tile image service.
  • CONSTANT_ELEVATION—The elevation source will be a constant ground elevation value for the entire dataset.
  • NONE—The elevation source will be removed.
String
constant_elevation
(Optional)

The constant ground elevation value for the entire dataset. The vertical_measurement_unit parameter value will be used as the unit for constant elevation.

This parameter is enabled when the elevation_source parameter value is specified as CONSTANT_ELEVATION.

Double
dem
(Optional)

The URL that references the input digital elevation model. A dynamic image service or a tile image service can be used as the digital elevation model.

This parameter is enabled when the elevation_source parameter value is specified as DEM.

Image Service
lod
(Optional)

The scale defined in a tiling schema. The scale represents the zoom level value. Each successive level improves resolution and map scale by double when compared to the previous level.

This parameter is enabled when the dem parameter value is a tile image service.

String
raster_function
(Optional)

The raster function processing template that will be applied to the image service.

This parameter is enabled when the dem parameter value is a dynamic image service.

String
vertical_measurement_unit
(Optional)

Specifies the unit that will be used for all vertical measurements.

  • METER—Meters will be used as the unit of measurement.
  • FEET—Feet will be used as the unit of measurement.
String
time_interval_unit
(Optional)

Specifies the time measurement unit that will be used to filter images.

  • MINUTES— Images will be filtered by minutes.
  • HOURS— Images will be filtered by hours.
  • DAYS— Images will be filtered by days.
  • WEEKS— Images will be filtered by weeks.
  • MONTHS— Images will be filtered by months.
  • YEARS— Images will be filtered by years.
String
oriented_imagery_type
(Optional)

Specifies the type of images in the dataset.

  • HORIZONTAL— Images in which the exposure is parallel to the ground and looking to the horizon are in the dataset.
  • OBLIQUE—Images in which the exposure is at an angle to the ground, typically at about 45 degrees, so the sides of objects can be seen are in the dataset.
  • NADIR—Images in which the exposure is perpendicular to the ground and looking straight down are in the dataset. Only the top of objects can be seen.
  • 360—Images taken using cameras that provide 360-degree spherical surround views or have been stitched together as 360-degree views from multiple cameras are in the dataset.
  • INSPECTION— Close-up images of assets are in the dataset.
  • NONE—The oriented imagery type will be removed from the dataset.
String
camera_heading
(Optional)

The camera orientation of the first rotation around the z-axis of the camera. The value is in degrees. The heading values are measured in the positive clockwise direction in which north is defined as 0 degrees. -999 is used when the orientation is unknown.

Double
camera_pitch
(Optional)

The camera orientation of the second rotation around the x-axis of the camera in the positive counterclockwise direction. The value is in degrees. The pitch is 0 degrees when the camera is facing straight down to the ground. The valid range of pitch is from 0 to 180 degrees, with 180 degrees for a camera facing straight up and 90 degrees for a camera facing the horizon.

Double
camera_roll
(Optional)

The camera orientation of the final rotation around the z-axis of the camera in the positive clockwise direction. The value is in degrees. Valid values range from -90 to 90.

Double
camera_height
(Optional)

The height of the camera above the ground when the imagery was captured. The unit is meters. Camera height is used to determine the visible extent of the image. Large values will result in a greater view extent. Values should not be less than 0.

Double
hfov
(Optional)

The camera's scope in the horizontal direction. The value is in degrees. Valid values range from 0 to 360.

Double
vfov
(Optional)

The camera's scope in the vertical direction. The value is in degrees. Valid values range from 0 to 180.

Double
near_distance
(Optional)

The nearest usable distance of the imagery from the camera position. The unit is meters.

Double
far_distance
(Optional)

The farthest usable distance of the imagery from the camera position. The unit is meters. Far distances should be greater than 0.

Double
image_rotation
(Optional)

The orientation of the camera in degrees relative to the scene when the image was captured. The rotation is added in addition to the camera roll. Valid values range from-360 to 360.

Double
orientation_accuracy
(Optional)

The orientation accuracy values. They are represented as a string of eight semicolon-delimited values that define the standard deviation of each value in the following order:

  • Camera location in XY direction
  • Camera Z
  • Camera Heading
  • Camera Pitch
  • Camera Roll
  • Near distance
  • Far distance
  • Elevation of the terrain

All distances are defined in meters unless the coordinate system's units are in feet in which case the units used for distance should be feet. All angles are defined in degrees. If a value is unknown, that value can be excluded. However, this may result in the computed accuracy being higher than the actual value.

For example, if a GPS has a +/- 10 meters root mean square (RMS) error in x,y-coordinates and +/- 20 meters in height, the orientation accuracy value is 10;20.

A typical value for a vehicle-mounted consumer camera is 5;10;5;5;5;0;0;1.

A typical value for oblique imagery following aerial triangulation is 0.01;0.02;0.001;0.001;0.001;0;0;1.

String
image_path_prefix
(Optional)

The prefix that will be used to build the image path in conjunction with the Image attribute.

String
image_path_suffix
(Optional)

The suffix that will be used to build the image path in conjunction with the Image attribute.

String
depth_image_path_prefix
(Optional)

The prefix that will be used to build the depth image path in conjunction with the Depth Image attribute.

String
depth_image_path_suffix
(Optional)

The suffix that will be used to build the depth image path in conjunction with the Depth Image attribute.

String
dem_path_prefix
(Optional)

The prefix that will be used to build the digital elevation model path in conjunction with the Elevation Source URL in the attribute.

String
dem_path_suffix
(Optional)

The suffix that will be used to build the digital elevation model path in conjunction with the Elevation Source URL in the attribute.

String
image_geometry_field
(Optional)

The field for a feature layer that will be overlayed on the image in the oriented imagery viewer. This field will store the image space geometry of the feature to be overlayed.

String
image_reference_field
(Optional)

The field for a feature layer that will be overlayed on the image in the oriented imagery viewer. The field will store the unique reference ID of the image in which the feature to be overlayed was created.

String

Derived Output

NameExplanationData Type
out_oriented_imagery_dataset

The updated oriented imagery dataset.

Oriented Imagery Dataset

Code sample

UpdateOrientedImageryDatasetProperties example 1 (Python window)

The following Python window script demonstrates how to use the UpdateOrientedImageryDatasetProperties function in immediate mode.

import arcpy
arcpy.env.workspace = "C:/data"
arcpy.oi.UpdateOrientedImageryDatasetProperties(
    "C:/OrientedImageryExample/MyOI.gdb/MyOrientedImageryDataset",
    maximum_distance=550,
    footprint_item='MyOrientedImageryDataset_footprint',
    image_path_prefix='None')
UpdateOrientedImageryDatasetProperties example 2 (stand-alone script)

The following Python script demonstrates how to use the UpdateOrientedImageryDatasetProperites function in a stand-alone script.

# Import system modules
import arcpy

# Set local variables
in_oi = "C:/OrientedImageryExample/MyOI.gdb/MyOrientedImageryDataset"
new_maximum_distance = 550
footprint = "MyOrientedImageryDataset_footprint"
new_time_unit = "HOURS"
new_camera_height = 2.5

# Run Update Oriented Imagery Dataset Properties
arcpy.oi.UpdateOrientedImageryDatasetProperties(
    in_oriented_imagery_dataset=in_oi,
    maximum_distance=new_maximum_distance,
    footprint_item=footprint,
    time_interval_unit=new_time_unit,
    camera_height=new_camera_height
)

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Yes
  • Advanced: Yes

Related topics

  • An overview of the Manage toolset
  • Find a geoprocessing tool

Feedback on this topic?

In this topic
  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information