Extract Floor Plan Features From PDF (Indoors Tools)

Summary

Extracts polyline features from a PDF floor plan. Optionally, extracts text features as points from the PDF.

The output from this tool can be used as input to the Import Features To Indoor Dataset tool to populate an Indoors workspace.

Usage

This tool accepts a .pdf file as input and creates polylines based on the PDF linework in the following ways:
- For vector PDFs, the tool extracts the vector information directly.
- For raster PDFs, the tool extracts polylines based on line pixel width. For lines with a width less than 10 pixels, the centerlines of the pixels are used. For lines with a width greater than 10 pixels, the outlines of the pixels are used. Use this tool as part of a larger workflow to extract floor plans from PDF files.
Note:

For PDFs that contain both vector and raster data, the tool will only read the vector elements.
You can use the optional Output Text Point Features parameter to extract text from the PDF. Extracted text is written to point features that contain the text in the attribute table. Points are placed at the center of detected text. This tool extracts text in the following ways:
- PDF text or PDF comment—Text stored as text objects in the PDF that the tool can read directly.
- OCR text—For text not stored as text objects in the PDF, the tool uses Optical Character Recognition (OCR) to detect and recognize text for extraction.
Note:

Optical Character Recognition (OCR) is a technology that detects text in images and outputs the detected text as character strings. This tool uses OCR, which leverages machine learning models to improve text detection and recognition. This tool supports using OCR for English and horizontal text only. Report any security or privacy concerns regarding Optical Character Recognition technology to the ArcGIS Trust Center.
If the input .pdf file is georeferenced, georeferencing information will be honored. If the input .pdf file is not georeferenced, the resulting features will be created in WGS 1984 Web Mercator at the coordinates 0,0. When georeferencing, ensure the PDF is added to the map with the default resolution in DPI setting in the PDF Options dialog box.
For PDFs with multiple pages, use the Page Number parameter to specify the page to import.
The Output Line Features parameter value supports creating a new feature class or adding new polyline features to an existing layer. When adding to an existing layer containing polyline features with PDF_NAME and PDF_PAGE values that match the input PDF, those polyline features will be deleted and new polyline features will be added. The tool stores attribute information in the output.
Output features are created with a z-value of 0. Set the z-value of the level when running the Import Features To Indoor Dataset tool.
The Output Text Point Features parameter supports creating a new feature class or adding new point features to an existing layer. If an existing layer is provided that contains features with PDF_NAME and PDF_PAGE field values that match the input PDF, those point features will be deleted and new point features will be added. The tool stores attribute information, such as text color and size, for the detected text in the point features output.
Output text point features are centrally located within the detected text's bounding box.
Use the Extent parameter to limit the processing extent and to exclude PDF elements such as legends, text boxes, and leader lines.
You can use the output of this tool as input to the Import Features To Indoor Dataset tool as part of the Extract floor plan features from PDFs workflow**.

Label	Explanation	Data type
Input PDF	The input `.pdf` file from which features will be extracted.	File
Output Line Features	The output polyline feature layer that extracted polylines will be written to.	Feature Layer
Page Number (Optional)	The page number of the input `.pdf` file from which features will be extracted. The default is 1.	String
Extent (Optional)	The extent of the data that will be evaluated. Current Display Extent —The extent will be based on the active map or scene. Draw Extent —The extent will be based on a rectangle drawn on the map or scene. Extent of a Layer —The extent will be based on an active map layer. Choose an available layer or use the Extent of data in all layers option. Each map layer has the following options: All Features —The extent of all features. Selected Features —The extent of the selected features. Visible Features —The extent of visible features. Browse —The extent will be based on a dataset. Intersection of Inputs —The extent will be the intersecting extent of all inputs. Union of Inputs —The extent will be the combined extent of all inputs. Clipboard —The extent can be copied to and from the clipboard. Copy Extent —Copies the extent and coordinate system to the clipboard. Paste Extent —Pastes the extent and coordinate system from the clipboard. If the clipboard does not include a coordinate system, the extent will use the map's coordinate system. Reset Extent —The extent will be reset to the default value. When coordinates are manually provided, the coordinates must be numeric values and in the active map's coordinate system. The map may use different display units than the provided coordinates. Use a negative value sign for south and west coordinates.	Extent
Output Text Point Features (Optional)	The output point feature layer that extracted text will be written to.	Feature Layer

arcpy.indoors.ExtractFloorPlanFeaturesFromPDF(in_pdf, out_line_features, {page_number}, {extent}, {out_text_point_features})

Name	Explanation	Data type
in_pdf	The input `.pdf` file from which features will be extracted.	File
out_line_features	The output polyline feature layer that extracted polylines will be written to.	Feature Layer
page_number (Optional)	The page number of the input `.pdf` file from which features will be extracted. The default is 1.	String
extent (Optional)	The extent of the data that will be evaluated. `MAXOF`—The maximum extent of all inputs will be used. `MINOF`—The minimum area common to all inputs will be used. `DISPLAY`—The extent is equal to the visible display. Layer name—The extent of the specified layer will be used. `Extent` object—The extent of the specified object will be used. Space delimited string of coordinates—The extent of the specified string will be used. Coordinates are expressed in the order of x-min, y-min, x-max, y-max.	Extent
out_text_point_features (Optional)	The output point feature layer that extracted text will be written to.	Feature Layer

Code sample

ExtractFloorPlanFeaturesFromPDF example 1 (Python window)

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

import arcpy
arcpy.indoors.ExtractFloorPlanFeaturesFromPDF(r"C:\Indoors\PDFs\Floor1-Blueprint.PDF",
                                       r"C:\Output\FloorPlanData.gdb\Floor1_ExtractedLines",
                                       "1",
                                       "-107.0 38.0 -104.0 40.0",
                                       r"C:\Output\FloorPlanData.gdb\Floor1_ExtractedTextPoints")

ExtractFloorPlanFeaturesFromPDF example 2 (stand-alone script)

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

#Name: Indoors_ExtractFloorPlanFeaturesFromPDF_example2.py
#Description: Extracts polyline floor plan features from an input PDF

import arcpy

# Set Local Variables
in_pdf = r"C:\Indoors\PDFs\Floor1-Blueprint.PDF"
out_line_features = r"C:\Output\FloorPlanData.gdb\Floor1_ExtractedLines"
page_number = "1"
extent = "-107.0 38.0 -104.0 40.0"
out_text_point_features = r"C:\Output\FloorPlanData.gdb\Floor1_ExtractedTextPoints" 

# Call the function
arcpy.indoors.ExtractFloorPlanFeaturesFromPDF(
    in_pdf,
    out_line_features,
    page_number,
    extent,
    out_text_point_features
)

Environments

Extent

Licensing information

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