'\" -*- coding: UTF-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH rl2tool 1 "09 March 2024" "" ""
.SH NAME
rl2tool \- CLI tool for RasterLite2
.SH SYNOPSIS
'nh
.fi
.ad l
\*(T<\fBrl2tool\fR\*(T> \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
\fImode\fR [\fIARGLIST\fR]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBrl2tool\fR is a CLI tool for RasterLite2.
.SH OPTIONS
Mode: CREATE
.PP
will create a new RasterLite2 Raster Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-smp\fR\*(T> \fIkeyword\fR, \*(T<\fB\-\-sample\-type\fR\*(T> \fIkeyword\fR
Sample Type keyword (see list)
.TP 
\*(T<\fB\-pxl\fR\*(T> \fIkeyword\fR, \*(T<\fB\-\-pixel\-type\fR\*(T> \fIkeyword\fR
Pixel Type keyword (see list)
.TP 
\*(T<\fB\-bds\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-num\-bands\fR\*(T> \fIinteger\fR
Number of Bands
.TP 
\*(T<\fB\-cpr\fR\*(T> \fIkeyword\fR, \*(T<\fB\-\-compression\fR\*(T> \fIkeyword\fR
Compression keyword (see list)
.TP 
\*(T<\fB\-qty\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-quality\fR\*(T> \fIinteger\fR
Compression Quality [0-100]
.TP 
\*(T<\fB\-tlw\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-tile\-width\fR\*(T> \fIinteger\fR
Tile Width [pixels]
.TP 
\*(T<\fB\-tlh\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-tile\-height\fR\*(T> \fIinteger\fR
Tile Height [pixels]
.TP 
\*(T<\fB\-srid\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-srid\fR\*(T> \fIinteger\fR
SRID value
.TP 
\*(T<\fB\-nosrid\fR\*(T>, \*(T<\fB\-\-no\-srid\fR\*(T>
No SRID
.TP 
\*(T<\fB\-res\fR\*(T> \fInumber\fR, \*(T<\fB\-\-resolution\fR\*(T> \fInumber\fR
pixel resolution(X and Y)
.TP 
\*(T<\fB\-xres\fR\*(T> \fInumber\fR, \*(T<\fB\-\-x\-resol\fR\*(T> \fInumber\fR
pixel resolution(X specific)
.TP 
\*(T<\fB\-yres\fR\*(T> \fInumber\fR, \*(T<\fB\-\-y\-resol\fR\*(T> \fInumber\fR
pixel resolution(Y specific)
.TP 
\*(T<\fB\-nd\fR\*(T> \fIpixel\fR, \*(T<\fB\-\-no\-data\fR\*(T> \fIpixel\fR
NO-DATA pixel value
.PP
SampleType Keywords:
.PP
1-BIT 2-BIT 4-BIT INT8 UINT8 INT16 UINT16
INT32 UINT32 FLOAT DOUBLE
.PP
PixelType Keywords:
.PP
MONOCHROME PALETTE GRAYSCALE RGB MULTIBAND DATAGRID
.PP
Compression Keywords:
.PP
NONE DEFLATE LZMA GIF PNG JPEG WEBP LL_WEBP FAX3 FAX4
.PP
Mode: DROP
.PP
will drop an existing RasterLite2 Raster Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.PP
Mode: IMPORT
.PP
will create a new Raster Section by importing an external
image or raster file
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-src\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-src\-path\fR\*(T> \fIpathname\fR
input Image/Raster path
.TP 
\*(T<\fB\-dir\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-dir\-path\fR\*(T> \fIpathname\fR
input directory path
.TP 
\*(T<\fB\-ext\fR\*(T> \fIstring\fR, \*(T<\fB\-\-file\-ext\fR\*(T> \fIstring\fR
extension file extension (e.g. .tif)
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-srid\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-srid\fR\*(T> \fIinteger\fR
optional: force SRID value
.TP 
\*(T<\fB\-wf\fR\*(T>>, \*(T<\fB\-\-worldfile\fR\*(T>
requires a Worldfile
.TP 
\*(T<\fB\-pyr\fR\*(T>, \*(T<\fB\-\-pyramidize\fR\*(T>
immediately build Pyramid levels
.PP
Mode: EXPORT
.PP
will export an external image from a Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-dst\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-dst\-path\fR\*(T> \fIpathname\fR
output Image/Raster path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-res\fR\*(T> \fInumber\fR, \*(T<\fB\-\-resolution\fR\*(T> \fInumber\fR
pixel resolution (X and Y)
.TP 
\*(T<\fB\-xres\fR\*(T> \fInumber\fR, \*(T<\fB\-\-x\-resol\fR\*(T> \fInumber\fR
pixel resolution (X specific)
.TP 
\*(T<\fB\-yres\fR\*(T> \fInumber\fR, \*(T<\fB\-\-y\-resol\fR\*(T> \fInumber\fR
pixel resolution (Y specific)
.TP 
\*(T<\fB\-minx\fR\*(T> \fInumber\fR, \*(T<\fB\-\-min\-x\fR\*(T> \fInumber\fR
X coordinate (lower-left corner)
.TP 
\*(T<\fB\-miny\fR\*(T> \fInumber\fR, \*(T<\fB\-\-min\-y\fR\*(T> \fInumber\fR
Y coordinate (lower-left corner)
.TP 
\*(T<\fB\-maxx\fR\*(T> \fInumber\fR, \*(T<\fB\-\-max\-x\fR\*(T> \fInumber\fR
X coordinate (upper-right corner)
.TP 
\*(T<\fB\-maxy\fR\*(T> \fInumber\fR, \*(T<\fB\-\-max\-y\fR\*(T> \fInumber\fR
Y coordinate (upper-left corner)
.TP 
\*(T<\fB\-cx\fR\*(T> \fInumber\fR, \*(T<\fB\-\-center\-x\fR\*(T> \fInumber\fR
X coordinate (center)
.TP 
\*(T<\fB\-cy\fR\*(T> \fInumber\fR, \*(T<\fB\-\-center\-y\fR\*(T> \fInumber\fR
Y coordinate (center)
.TP 
\*(T<\fB\-outw\fR\*(T> \fInumber\fR, \*(T<\fB\-\-out\-width\fR\*(T> \fInumber\fR
image width (in pixels)
.TP 
\*(T<\fB\-outh\fR\*(T> \fInumber\fR, \*(T<\fB\-\-out\-height\fR\*(T> \fInumber\fR
image height (in pixels)
.PP
In order to export a raster you are expected to specify:
.TP 
- the intended resolution (\*(T<\fB\-res\fR\*(T> OR \*(T<\fB\-xres\fR\*(T> AND \*(T<\fB\-yres\fR\*(T>)
.TP 
- the output image size (\*(T<\fB\-outw\fR\*(T> AND \*(T<\fB\-outh\fR\*(T>)
.TP 
- a single tie-point, defined as one of:
.RS 
.TP 
- Output Image Center point: \*(T<\fB\-cx\fR\*(T> AND \*(T<\fB\-cy\fR\*(T>
.TP 
- Output Image LowerLeft corner: \*(T<\fB\-minx\fR\*(T> AND \*(T<\fB\-miny\fR\*(T>
.TP 
- Output Image LowerRight corner: \*(T<\fB\-maxx\fR\*(T> AND \*(T<\fB\-miny\fR\*(T>
.TP 
- Output Image UpperLeft corner: \*(T<\fB\-minx\fR\*(T> AND \*(T<\fB\-maxy\fR\*(T>
.TP 
- Output Image UpperRight corner: \*(T<\fB\-maxx\fR\*(T> AND \*(T<\fB\-maxy\fR\*(T>
.RE
.PP
Mode: DELETE
.PP
will delete a Raster Section
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-sec\fR\*(T> \fIstring\fR, \*(T<\fB\-\-section\fR\*(T> \fIstring\fR
Section's name
.PP
Mode: PYRAMIDIZE
.PP
will (re)build all Pyramid levels supporting a Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-sec\fR\*(T> \fIstring\fR, \*(T<\fB\-\-section\fR\*(T> \fIstring\fR
optional: Section's name

default is "All Sections"
.TP 
\*(T<\fB\-f\fR\*(T>, \*(T<\fB\-\-force\fR\*(T>
optional: rebuilds from scratch
.PP
Mode: PYRAMIDIZE-MONOLITHIC
.PP
will (re)build all Pyramid levels (Monolithic) supporting a Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-lev\fR\*(T> \fInumber\fR, \*(T<\fB\-\-virt\-levels\fR\*(T> \fInumber\fR
number of virt-levels

could be one of: 1, 2 or 3
.PP
Mode: DE-PYRAMIDIZE
.PP
will delete Pyramid levels
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-sec\fR\*(T> \fIstring\fR, \*(T<\fB\-\-section\fR\*(T> \fIstring\fR
optional: Section's name

default is "All Sections"
.PP
Mode: LIST
.PP
will list Raster Sections within a Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-sec\fR\*(T> \fIstring\fR, \*(T<\fB\-\-section\fR\*(T> \fIstring\fR
optional: Section's name

default is "All Sections"
.PP
Mode: MAP
.PP
will output a PNG Map representing all Raster Sections within a Coverage
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-dst\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-dst\-path\fR\*(T> \fIpathname\fR
output Image/Raster path
.TP 
\*(T<\fB\-outw\fR\*(T> \fInumber\fR, \*(T<\fB\-\-out\-width\fR\*(T> \fInumber\fR
image width (in pixels)
.TP 
\*(T<\fB\-outh\fR\*(T> \fInumber\fR, \*(T<\fB\-\-out\-height\fR\*(T> \fInumber\fR
image height (in pixels)
.PP
Mode: CATALOG
.PP
will list all Coverages from within a RasterLite2 DB
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.PP
Mode: HISTOGRAM
.PP
will create a PNG showing a band Histogram
.TP 
\*(T<\fB\-db\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-db\-path\fR\*(T> \fIpathname\fR
RasterLite2 DB path
.TP 
\*(T<\fB\-cov\fR\*(T> \fIstring\fR, \*(T<\fB\-\-coverage\fR\*(T> \fIstring\fR
Coverage's name
.TP 
\*(T<\fB\-sec\fR\*(T> \fIstring\fR, \*(T<\fB\-\-section\fR\*(T> \fIstring\fR
optional: Section's name

default is "All Sections"
.TP 
\*(T<\fB\-bnd\fR\*(T> \fIinteger\fR, \*(T<\fB\-\-band\-index\fR\*(T> \fIinteger\fR
a valid band index

default is band index 0
.TP 
\*(T<\fB\-dst\fR\*(T> \fIpathname\fR, \*(T<\fB\-\-dst\-path\fR\*(T> \fIpathname\fR
output PNG path

default is \*(T<\fI./hist_cov_sec_idx.png\fR\*(T>
.PP
optional DB specific settings:
.TP 
\*(T<\fB\-cs\fR\*(T> \fInum\fR, \*(T<\fB\-\-cache\-size\fR\*(T> \fInum\fR
DB cache size (how many pages)
.TP 
\*(T<\fB\-m\fR\*(T>, \*(T<\fB\-\-in\-memory\fR\*(T>
using IN-MEMORY database
.TP 
\*(T<\fB\-jo\fR\*(T>, \*(T<\fB\-\-journal\-off\fR\*(T>
unsafe [but faster] mode