--dpi

-D

Pixels per square inch (DPI) in the output image. A higher resolution means a sharper image. The value must be a whole number.

Default value is 300.

FALSE

Optional

--extent-type

-e

The export extents are determined as:

• EXPORT_AREA

• SHEET

• INKED_AREA

Default value is SHEET.

FALSE

Optional

--colour-depth

-d

Number of bits used to represent the colour of a single pixel in the image. A higher colour depth gives a broader range of distinct colours.

Available bit options are 8, 24 and 32.

Default value is 24.

FALSE

Optional

--background-colour

-a

Background colour in the image, and the alpha value, in the following format: RGB(255,255,255,100).

The alpha value can only be set when colour depth = 32. Otherwise, it is preset to 100%.

Default value is RGB(255,255,255,100).

FALSE

Optional

--compression

-c

Compression algorithm used to reduce the file size of an image.

Available options are:

• NONE

• PACKBITS

• LZW

To keep the file size, select NONE.

Default value is LZW.

FALSE

Optional

--anti-aliasing

-L

If set, anti-aliasing removes or reduces the jagged distortions in curves and diagonal lines so that lines appear smooth or smoother.

This option is only valid when colour depth = 24 or 32.

FALSE

Optional

--output-template

-o

Name of the output template that controls which data layers are sent to the output.

New templates are created in HPD Paper Chart Editor, using the File > Export > TIFF command. In the dialog box under Options, select Output Template and then select Create and Manage from the drop-down menu.

FALSE

Optional

--boundary-colour

-C

Colour of the boundary of the exported area in the output.

Default value if a boundary thickness is set, is RGB(0,0,0).

FALSE

Optional

--boundary-thickness

-t

Line thickness (mm) of the boundary of the exported area in the output. The value must be a whole number.

Default value is 0.

FALSE

Optional

--annotation-style

-s

Style (font and size) of the annotation. If a text style file is not selected, the default of Courier 10 point is applied.

The required syntax is font-point size-variation (e.g., Courier-10-Upright), shown in the file textStyleFile.xml.

The default location for this file is C:\Users\<username>\AppData\Roaming\CARIS\HPD\<version>.

FALSE

Optional

--annotation-text

-x

Annotation text that will be added to the output.

If more than one of the annotation text, username and timestamp options are set, a colon is used as the separator. For example, text : username : 2023:08-09:14:22:00.

FALSE

Optional

--annotation-username

-u

If set, the Windows login user name is appended to the annotation text.

If more than one of the annotation text, username and timestamp options are set, a colon is used as the separator. For example, text : username : 2023:08-09:14:22:00.

FALSE

Optional

--annotation-timestamp

-i

If set, a timestamp showing the date and time of the export is appended to the annotation text.

If more than one of the annotation text, username and timestamp options are set, a colon is used as the separator. For example, text : username : 2023:08-09:14:22:00.

FALSE

Optional

--annotation-justification

-j

Justification of the annotation:

• LEFT

• RIGHT

• CENTRE

Default is LEFT.

FALSE

Optional

--annotation-position

-P

Position of the annotation with respect to the image:

• TOP

• BOTTOM

• RIGHT

• LEFT

Default is BOTTOM.

FALSE

Optional

--annotation-offset

-O

Offset distance (mm) of the annotation from the image edge. A negative value places the text inside the image. The value must be a whole number.

Default setting is 2 mm.

FALSE

Optional

--annotation-indent

-I

Distance (mm) that the annotation will be indented from the origin. The indent is only valid when the justification is LEFT or RIGHT. The indent must be zero or a whole number.

Default value is 0.

FALSE

Optional

--panel-number

-P

Panel number of the chart to export, that is, the PANNUM attribute.

FALSE

Required

--area-coordinates

-A

Minimum and maximum latitude and longitude points that are used to define the export area. If only two points are specified, they are used to create a two-point bounding rectangle.

The order of coordinates is latitude, longitude, SW corner, NE corner.

Point values are entered in decimal degrees and must be in the datum of the panel specified for --panel-number, for example, 50.35,-4.3,50.4,-4.22.

FALSE

Optional

--geospatial

-g

Georeferencing information is added to the exported TIFF files. This option is not available for non-GeoTIFF files.

FALSE

Optional

--sheet-with-panel

-S

Export the sheet several times, each time with a different georeferenced panel.

FALSE

Optional

--geospatial

-g

Georeferencing information that is added to the exported TIFF files. This option is not available for non-GeoTIFF files.

The --sheet-with-panel option must be set to use this option.

FALSE

Optional

Database Chart

Objective

Export database chart 3218 to a TIFF image (chart_3218.tif).

Description

Command Line Syntax

Set the DPI of the TIFF image to 300.

-dpi 300

Export the sheet area of chart 3218 to the image file.

--extent-type SHEET

Set the colour depth for the TIFF image to 24 bits.

--colour-depth 24

Set the background colour of the TIFF image to RGB values of 255,255,255 and an alpha value of 100.

--background-colour “RGB(255,255,255,100)”

Database chart for export to TIFF.

hpd://username:password@database?chartversionid=3218

File path and name of the TIFF image.

C:\ExportedTIFF\chart_3218.tif

Command Line

carisbatch -r ExportChartToTIFF --dpi 300 --extent-type SHEET --colour-depth 24 --background-colour “RGB(255,255,255,100)” hpd://username:password@database?chartversionid=3218 C:\ExportedTIFF\chart_3218.tif

Standalone Chart

Objective

Export the TestFile.pcc standalone chart to a TIFF image (PCC_Chart.tif).

Description

Command Line Syntax

Set the DPI of the TIFF image to 600.

--dpi 600

Export the sheet area of TestFile.pcc to the image file.

--extent-type SHEET

Retain the original image size.

--compression NONE

Standalone chart for export to TIFF.

file:///D:\temp\TestFile.pcc?ChartVersionId=1

File path and name of the TIFF image.

C:\ExportedTIFF\PCC_Chart.tif

Command Line

carisbatch -r ExportChartToTIFF --dpi 600 --extent-type SHEET --compression NONE file:///D:\temp\TestFile.pcc?ChartVersionId=1 C:\ExportedTIFF\PCC_Chart.tif