The ExportChartToTIFF process exports a chart to a TIFF file.
Input
HPD URI chart (identified by chart version ID) or stand-alone PCC chart (identified by a path).
Output
Folder and file name of the exported TIFF file.
Syntax
carisbatch --run ExportChartToTIFF [options] <input> <output>
Options
Long | Short | Description | Can Repeat | Notes |
|---|---|---|---|---|
--dpi | -D | The pixels per square inch (DPI) in the output image. A greater resolution means a sharper image. Default value is 300. | FALSE | Optional |
--extent-type | -e | The export extents are determined as: • EXPORT_AREA • SHEET • INKED_AREA Default setting is SHEET. | FALSE | Optional |
--colour-depth | -d | The colour depth is the number of bits used to represent the colour of a single pixel. 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 and alpha value in the following formal: Alpha value can only be set when colour depth = 32 otherwise it is preset at 100% Default value is RGB(255,255,255,100). | FALSE | Optional |
--compression | -c | LZW compression algorithm reduces the file size of an image. To retain the image size, select NONE. Available options: • NONE • PACKBIT • LZW Default setting is LZW. | FALSE | Optional |
--antialiasing | -L | If set to | FALSE | Optional |
--output-template | -o | Output templates control which data layers get sent to the output. New templates are created in HPD Paper Chart Editor. | FALSE | Optional |
--boundary-colour | -C | Set the colour of the boundary of the exported area in the output. Default setting is | FALSE | Optional |
--boundary-thickness | -t | Set the line thickness (mm) of the boundary of the exported area in the output. Default value is 0. | FALSE | Optional |
--annotation-style | -s | Set the style (font and size) of the annotation. A text styles file can be selected otherwise the default of Courier 10 point is applied. | FALSE | Optional |
--annotation-text | -x | The annotation text that will be added to the output. | FALSE | Optional |
--annotation-username | -u | If set to If both user name and time stamp are chosen, a colon (:) is inserted between them. | FALSE | Optional |
--annotation-timestamp | -i | If set, to If both user name and time stamp are chosen, a colon separator (:) is inserted between them. | FALSE | Optional |
--annotation-justification | -j | Set the justification of the annotation.to one of: • LEFT • RIGHT • CENTRE Default is LEFT. | FALSE | Optional |
--annotation-position | -P | Set the position of the annotation with respect to the image. • TOP • BOTTOM • RIGHT • LEFT Default setting is BOTTOM. | FALSE | Optional |
--annotation-offset | -O | Set the offset distance (mm) of the annotation from the image edge. A negative value will place the text inside the image. Values must be in whole numbers Default setting is 2 mm. | FALSE | Optional |
--annotation-indent | -I | Set the distance (mm) for the annotation indent from the origin. Only used when justification is LEFT or RIGHT. Default is 0. | FALSE | Optional |
The following options are available if the --extent-type option is set to SHEET.
Long | Short | Description | Can Repeat | Notes |
|---|---|---|---|---|
--sheet-with-panel | -S | Export the sheet several times, each time with a different geo-referenced panel. | FALSE | Optional |
--geospatial | -g | Geo-referencing information that is added to the export TIFF files. This option is not available for non-GeoTIFF files. The | FALSE | Optional |
The following options are available if the --extent-type option is set to EXPORT_AREA.
Long | Short | Description | Can Repeat | Notes |
|---|---|---|---|---|
--panel-number | -p | The panel number of the chart to export. | FALSE | Required |
--area-coordinates | -A | The minimum and maximum latitude and longitude used to create a two-point bounding rectangle. Points values are entered in decimal degrees and must be in the datum of the panel. For example, | FALSE | Optional |
--geospatial | -g | Geo-referencing information that is added to the exported TIFF files. This option is not available for non-GeoTIFF files. The | FALSE | Optional |
Examples
To use this process, refer to the following examples
.
Database | ||
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. | --out-resolution 300 | |
Export the sheet area of chart 3218 to the image file. | --export-extents 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 “RGB(255,255,255,100)” | |
The database chart for export to TIFF. | hpd://username:password@DB/db?chartversionid=3218 | |
The file path and name of the TIFF image. | C:\ExportedTIFF\chart_3218.tif | |
Command Line | carisbatch -r ExportChartToTIFF --out-resolution 300 --export-extents SHEET --colour-depth 24 --background “RGB(255,255,255,100)” hpd://username:password@DB/db?chartversionid=3218 C:\ExportedTIFF\chart_3218.tif | |
Stand-Alone Chart | ||
Objective | Export the chart_3128.pcc stand-alone chart to a TIFF image (chart_3218.tif) | |
Description | Command Line Syntax | |
Set the DPI of the TIFF image to 300. | --out-resolution 300 | |
Export the sheet area of chart 3218 to the image file. | --export-extents 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 “RGB(255,255,255,100)” | |
The stand-alone chart for export to TIFF. | C:\MyCharts\chart_3128.pcc | |
The file path and name of the TIFF image. | C:\ExportedTIFF\chart_3218.tif | |
Command Line | carisbatch -r ExportChartToTIFF --out-resolution 300 --export-extents SHEET --colour-depth 24 --background “RGB(255,255,255,100)” C:\ExportedTIFF\chart_3218.tif | |
Result | chart_3218.tif is created from stand-alone chart_3218.pcc | |