Import Indoor Images (Indoors)

Available with the ArcGIS Indoors Pro or ArcGIS Indoors Maps extension.

Summary

Imports 360-degree and panoramic images from an .e57 file to an Indoors workspace. The output of this tool can be added to floor-aware maps and scenes in ArcGIS Pro.

Usage

  • This tool supports 360-degree and panoramic JPEG images contained in .e57 files. The images must use an equirectangular (spherical) representation.

  • Use this tool with input Levels features with a selection or definition query to import images to specific floors.

  • The Target Oriented Imagery Layer parameter must be a z-enabled oriented imagery layer. Create oriented imagery using the Create Oriented Imagery Dataset tool.

  • Use the Input Coordinate System parameter to specify the horizontal and vertical coordinate systems of the input data.

    • If no coordinate system is specified or defined in the input .e57 file, the input data is assumed to be in the same coordinate system as the input Levels features.
    • If the input data and input level features have different coordinate systems, the tool will reproject the imported image locations.
  • To support floor awareness, this tool adds a LEVEL_ID field to the target oriented imagery dataset if it is not already present.

  • The tool assigns Level IDs to images based on a comparison of the z-values of the images and Levels features as follows:

    • An image is assigned the Level ID of the Levels feature that is vertically positioned at or immediately below the image.
    • When an image has a z-value that places it below the lowest level or more than 15 meters above the highest level, the image is assigned a Level ID value of Null.
    • Images that fall outside any Levels feature (based on x,y-coordinates) are assigned a Level ID value of Null.
  • If the input data and input Levels layer features have different z-origins, use the Elevation Adjustment parameter to compensate for the difference. Elevation adjustment is applied after any needed reprojection of image locations by the tool.

    For example, if the input data has z-values relative to sea level, and the input Levels features have z-values relative to ground level, use a negative Elevation Adjustment parameter value to compensate for the difference (example in below diagram.)

    Diagram of the effect of the Elevation Adjustment parameter
    A negative elevation adjustment of -400m is applied to vertically align images with Levels features.
  • The tool populates oriented imagery feature attributes as follows:

    • Shape—x-, y-, and z-coordinate values are based on the input data file's location information for the image.
    • Name—The name of the image from the input data file's metadata. If no metadata is available, the input data file name is used with incrementing numeral values appended.
      Note:

      This value may differ from the image file name in the ImagePath field.

    • LEVEL_ID—The level ID of the associated levels feature. If no associated level is determined, a value of Null is assigned.
    • ImagePath—The path of the image file that is associated with the feature.
    • AcquisitionDate—The acquisition date and time from the input file's metadata. If no metadata is available, the input data file's last modified date and time value is used.
    • CameraHeading—The camera heading based on the input data file's rotation information for the image. Values are in degrees.
      • Heading values are measured in a positive clockwise direction where north is defined as 0 degrees.
      • This tool does not populate the oriented imagery's CameraPitch or CameraRoll attributes.
        Note:

        Camera heading information may be stored differently depending on the software used. Review the tool output to verify that the CameraHeading values are correct, and use the Calculate Field tool to adjust the CameraHeading values if needed.

    • HorizontalFieldOfView—The camera's scope in the horizontal direction, in degrees.
      • Valid values range from 0 to 360.
      • By default, this tool assigns a value of 360. Adjust this value using the Horizontal Field of View parameter.
    • VerticalFieldOfView—The camera's scope in the vertical direction, in degrees.
      • Valid values range from 0 to 180.
      • By default, this tool assigns a value of 180. Adjust this value using the Vertical Field of View parameter.
    • OrientedImageryType—The type of oriented imagery. This tool assigns a value of 360, which indicates the images provide spherical or panoramic surrounding views.
  • The oriented imagery output by this tool can be configured with floor-aware maps for use with the floor filter.

  • Imported images are stored as local files. Use the Generate Service From Oriented Imagery Dataset tool to publish a hosted feature service with the imported imagery.

  • Existing features in the target oriented imagery dataset are preserved during import.

Parameters

LabelExplanationData Type
Input Data

The .e57 file containing the target oriented imagery file that will be imported.

File
Input Level Features

The associated Levels layer from the ArcGIS Indoors Information Model that resides in the same workspace as the target images layer.

Feature Layer
Target Image Folder

The existing folder where the imagery files will be written.

Folder
Target Oriented Imagery

The target oriented imagery dataset in the Indoors workspace that will be updated by the imported images.

Oriented Imagery Layer
Input Coordinate System
(Optional)

The spatial reference of the input image file. A coordinate system can be selected if none are specified in the input data file.

Spatial Reference
Elevation Adjustment
(Optional)

The value by which the z-values of imported images will be adjusted. If the imported images are reprojected, the adjustment will be applied after projection. The default value is 0 meters.

  • A value of -300 feet reduces the z-value of imported images by 300 feet.
  • A value of 250 meters increases the z-value of imported images by 250 meters.
Double
Horizontal Field of View
(Optional)

The effective width of the field of view of imported images, in degrees. Valid values range from 0 to 360. The default value is 360.

Double
Vertical Field of View
(Optional)

The effective height of the field of view of imported images, in degrees. Valid values range from 0 to 180. The default value is 180.

Double

Derived Output

LabelExplanationData Type
Updated Target Oriented Imagery

The updated oriented imagery dataset in the Indoors workspace. Existing oriented imagery data is retained during the import. A new point feature is appended for each image in the input data, with the associated image added as an attachment. Attributes are set on newly added point features based on attributes of the input image file.

Oriented imagery Layer

arcpy.indoors.ImportIndoorImages(in_data, in_level_features, target_image_folder, target_oriented_imagery, {in_coordinate_system}, {elevation_adjustment}, {horizontal_field_of_view}, {vertical_field_of_view})
NameExplanationData Type
in_data

The .e57 file containing the target oriented imagery file that will be imported.

File
in_level_features

The associated Levels layer from the ArcGIS Indoors Information Model that resides in the same workspace as the target images layer.

Feature Layer
target_image_folder

The existing folder where the imagery files will be written.

Folder
target_oriented_imagery

The target oriented imagery dataset in the Indoors workspace that will be updated by the imported images.

Oriented Imagery Layer
in_coordinate_system
(Optional)

The spatial reference of the input image file. A coordinate system can be selected if none are specified in the input data file.

Spatial Reference
elevation_adjustment
(Optional)

The value by which the z-values of imported images will be adjusted. If the imported images are reprojected, the adjustment will be applied after projection. The default value is 0 meters.

  • A value of -300 feet reduces the z-value of imported images by 300 feet.
  • A value of 250 meters increases the z-value of imported images by 250 meters.
Double
horizontal_field_of_view
(Optional)

The effective width of the field of view of imported images, in degrees. Valid values range from 0 to 360. The default value is 360.

Double
vertical_field_of_view
(Optional)

The effective height of the field of view of imported images, in degrees. Valid values range from 0 to 180. The default value is 180.

Double

Derived Output

NameExplanationData Type
updated_target_oriented_imagery

The updated oriented imagery dataset in the Indoors workspace. Existing oriented imagery data is retained during the import. A new point feature is appended for each image in the input data, with the associated image added as an attachment. Attributes are set on newly added point features based on attributes of the input image file.

Oriented imagery Layer

Code sample

ImportIndoorImages example 1 (Python window)

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

arcpy.indoors.ImportIndoorImages(r"C:\BuildingScans\BuildingA.e57",
                                 r"C:\IndoorsModel.gdb\Indoors\Levels",
                                 r"C:\indoorsphotos\photos",
                                 r"C:\IndoorsModel.gdb\OIDataset",
                                 '', '', '')
ImportIndoorImages example 2 (Python window)

The following stand-alone script demonstrates how to use the ImportIndoorImages function.

# Import system modules 
import arcpy

#Set parameter values
    in_data=r"C:\BuildingScans\BuildingA.e57"
    in_level_features=r"C:\IndoorsModel.gdb\Indoors\Levels"
    target_image_folder=r"C:\indoorsphotos\photos"
    target_oriented_imagery=r"C:\IndoorsModel.gdb\Indoors\OIDataset"
    in_coordinate_system='PROJCS["NAD_1983_2011_StatePlane_California_VI_FIPS_0406",GEOGCS["GCS_NAD_1983_2011",' \
                           'DATUM["D_NAD_1983_2011",SPHEROID["GRS_1980",6378137.0,298.257222101]],' \
                           'PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],' \
                           'PROJECTION["Lambert_Conformal_Conic"],PARAMETER["False_Easting",2000000.0],' \
                           'PARAMETER["False_Northing",500000.0],PARAMETER["Central_Meridian",-116.25],' \
                           'PARAMETER["Standard_Parallel_1",32.78333333333333],' \
                           'PARAMETER["Standard_Parallel_2",33.88333333333333],' \
                           'PARAMETER["Latitude_Of_Origin",32.16666666666666],' \
                           'UNIT["Meter",1.0],AUTHORITY["EPSG",6425]]'
    elevation_adjustment="-396 Meters"
    horizontal_field_of_view=360
    vertical_field_of_view=180
    
#Run the tool
ImportIndoorImages_Indoors(in_level_features, target_image_folder, target_oriented_imagery, in_coordinate_system,
                           elevation_adjustment, horizontal_field_of_view, vertical_field_of_view)

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Requires ArcGIS Indoors Pro or ArcGIS Indoors Maps
  • Advanced: Requires ArcGIS Indoors Pro or ArcGIS Indoors Maps

Related topics