Help

Chart Automation

Summary

Runs selected chart finishing processes on a production database with the Nautical Chart schema. Processes include adding layers to the TOC, generating cartographic limits, creating grids and graticules, converting labels to annotation, and masking annotation.

A description of each process can be found in Chart automation finishing processes.

Usage

  • The selected chart finishing processes can be run on a chart product that was created by importing data into a database with the Nautical Chart schema. To use chart automation on a product that was created using the Product Library window, run the Product Library Chart Automation tool.

  • There are two options for choosing the map document on which Chart Automation will be run: a path to an existing map document stored on a local machine or on some other machine to which you have write access, or the current map document that is loaded into the ArcMap application.

  • Any new layers added to the map document will be added to the active data frame unless one is selected from the optional Data Frame parameter.

  • The group layer added by the Add Layers to TOC process is named Nautical.lyr and is installed with ArcGIS for Maritime: Charting in the following location:

    • For 64-bit Windows operating systems—<Install location>\Program Files\ArcGIS\MaritimeCharting\Desktop10.3\Charting\Cartography\Symbology
    • For 32-bit Windows operating systems—<Install location>\Program Files(x86)\ArcGIS\MaritimeCharting\Desktop10.3\Charting\Cartography\Symbology

  • The output grids are stored in the GRD_Grids feature dataset in the production database and the grid layers are added to the map document under a group layer named Grids.

  • The selected features in the Generate Cartographic Limits process are converted to polylines and erased where their boundary is coincident with a CoastlineL feature.

  • During the Convert Labels to Annotation process, if the labels are turned on in the layer’s properties, feature-linked annotation is generated for that layer at the reference scale of the data frame, and the labels for that layer are then turned off.

  • The output annotation feature classes are stored in the production database and the annotation layers are added to the map document under a group layer named Anno.

Syntax

ChartAutomation(Chart_Finishing_Processes, Area_Of_Interest, Chart_Scale, Chart_Database, Map_Document_Type, ArcMap_Document, {Data_Frame})
ParameterExplanationData Type
Chart_Finishing_Processes
[Chart_Finishing_Processes,...]

The finishing processes that can be run.

  • Add Layers to TOC —Adds a rendered and ordered group layer with all Nautical layers to the data frame associated with the chart panel. It updates the data sources in each layer to the workspace path of the production database of the chart panel.
  • Create Grids and Graticules —Creates a grids and graticules layer using the appropriate Nautical grids XML for the INT2 standard based on the map scale (or compilation scale) defined in the product AOI feature class. Adds the output grid layer to the map document. The data frame’s coordinate system, rotation, scale, size, and shape are updated based on the properties of the grids.
  • Generate Cartographic Limits —Runs the Generate Cartographic Limits tool on all applicable layers\subtypes and appends the results to the A_L feature classes located under the CartographicFeatures feature dataset in the production database. Adds the output feature classes as layers to the Table Of Contents window if they are not already loaded in the map document.
  • Generate Light Sectors —Creates light sector features based on a specified point feature class. Light sectors typically appear on nautical charts and depict the distance a light can be seen from its source. Light sectors are based on light features in the AidsToNavigationP feature class in the ArcGIS for Maritime: Charting.
  • Convert Labels to Annotation —Converts labels in all layers to feature-linked annotation and adds the resulting annotation layer to the map document. The process runs on all layers in the data frame associated with the chart panel.
  • Mask Annotation —Creates one-point mask polygons on all features in the DepthsLAnno layer or where they commonly intersect polyline features in the map. It also sets the masked and masking layers in the Advanced Drawing Options dialog box.
String
Area_Of_Interest

The polygon layer that contains the area of interest for the chart extent. The layer should contain exactly one feature, or exactly one feature should be selected. This is the feature that will be used as the Area Of Interest.

Layer
Chart_Scale

The scale of the chart product. For example, if the scale is 1:20000, you would enter 20000.

Double
Chart_Database

The geodatabase that contains the chart data in the Nautical Chart schema.

Workspace
Map_Document_Type

Specifies the map document where the chart finishing processes will run.

  • PATH_TO_MXD —The chart finishing processes will run on the ArcMap document located at the path provided in the Map Document parameter. This is the default.
  • CURRENT_MXD —The chart finishing processes will run on the map document that is currently loaded into the ArcMap application.
String
ArcMap_Document

Path to the ArcMap document where the chart finishing processes will run. If CURRENT_MXD is chosen for the Map_Document_Type parameter, this parameter will not be used.

ArcMap Document
Data_Frame
(Optional)

The name of the data frame in the selected ArcMap Document on which the Chart Finishing processes will run. If no value is specified, the active data frame will be used.

String

Code sample

ChartAutomation example

The following code sample demonstrates how to use the Chart Automation tool with a database using the Nautical Chart schema.

# Variables
finishing_processes="Add Layers to TOC;Create Grids and Graticules;Generate Cartographic Limits;Generate Light Sectors;Convert Labels to Annotation"
aoi = r"C:\Data\Charts\AOI.lyr"
scale = 52000
prod_db = r"C:\Data\Charts\GB4X0000.gdb"
mxd_type = "PATH_TO_MXD"
mxd_path = r"C:\Data\Charts\MyNauticalChart.mxd"
df_name = "MainPanel"

# Execute the tool
arcpy.ChartAutomation_nautical(finishing_processes, aoi, scale, prod_db, mxd_type, mxd_path, df_name)

Environments

Licensing information

  • ArcGIS Desktop Basic: No
  • ArcGIS Desktop Standard: No
  • ArcGIS Desktop Advanced: Requires Maritime Charting

Related topics