Skip to content

ArcGIS Oriented Imagery Dataset from 360 Imagery 0.1.0.dev3 Documentation

This is the documentation for ArcGIS Oriented Imagery Dataset from 360 Imagery. All the Markdown (md) files in ./docsrc/mkdocs become the documentation pages.

Streamline the process of ingesting Oriented Imagery from a 360 degree camera.

Requirements

Getting Started

Clone this Repo

git clone https://github.com/knu2xs/arcgis-oriented-imagery-dataset-from-360

Optionally, if you do not have Git installed, you can download and unpack the ZIP file. This works just as well.

Create Python Environment

Create a Python environment with all needed requirements, notably the AWS SDK for Python, Boto3.

This project includes a quick command streamlining much of this.

make env

However, if this does not work, the following commands will accomplish much of the same thing.

conda create -p ./env --clone "C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3"
conda activate -p ./env
conda install -c conda-forge boto3

Set Configuration

Set the values in the configuration file located at ./scripts/config.ini.

Run Make Data

Run the command to scan for new .csv files in S3, and create an Oriented Imagery Dataset in the working directory for each new file discovered in S3.

Note

This command activates the Python environment created above, and runs the ./src/make_data.py script. If you need to customize the workflow, you can edit the script directly.

Python API

This project also includes a Python API for programmatic access to its functionality.

The primary function is process_camera_info_table, but the API documentation details all available functions.

arcgis_oriented_imagery.data.process_camera_info_table(camera_info_table, working_directory, camera_info_field_map=None, output_dataset=None)

Process data defined in a camera info table CSV file. This includes renaming columns based on a provided mapping, and creating an output oriented imagery dataset.

Parameters:

Name Type Description Default
camera_info_table Union[str, Path]

The path to the CSV table containing camera information.

required
working_directory Union[str, Path]

The directory where intermediate and output files will be stored.

required
camera_info_field_map Optional[dict[str, str]]

A dictionary mapping the expected field names to the actual field names in the camera info table.

None
output_dataset Optional[Union[str, Path]]

Optional full path to the output Oriented Imagery Dataset. If not provided, a default path will be created in the working directory based on the input camera info table name.

None

Returns:

Type Description
Path

The full path to the created Oriented Imagery Dataset.