You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/getting_started/api/pan_sharp.rst
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
-
Pansharpening
1
+
Pan-sharpening
2
2
==============
3
3
4
-
The :class:`~orthority.pan_sharp.PanSharpen` class implements Gram-Schmidt pansharpening. Panchromatic and multispectral images are required to instantiate. The :meth:`~orthority.pan_sharp.PanSharpen.process` method pansharpens:
4
+
The :class:`~orthority.pan_sharp.PanSharpen` class implements Gram-Schmidt pan-sharpening. Panchromatic and multispectral images are required to instantiate. The :meth:`~orthority.pan_sharp.PanSharpen.process` method pan-sharpens:
Copy file name to clipboardexpand all lines: docs/getting_started/cli/ortho_config.rst
+27-5
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,14 @@
4
4
Ortho image configuration
5
5
=========================
6
6
7
-
Ortho images are created as GeoTIFFs. Image resolution and format (data type, compression, nodata / internal mask and overviews) can be configured. Configuration options are common to all |oty|_ orthorectification sub-commands and default to sensible values when not supplied.
7
+
Ortho image resolution and format can be configured. Configuration options are common to all |oty|_ orthorectification sub-commands and default to sensible values when not supplied.
8
+
9
+
Resolution, data type and compression
10
+
-------------------------------------
8
11
9
12
Ortho resolution defaults to an estimate of the `ground sampling distance <https://en.wikipedia.org/wiki/Ground_sample_distance>`__. This can be changed with ``--res``. The ortho data type defaults to the source image data type, and can be changed with ``--dtype``.
10
13
11
-
Compression can be configured with ``--compress`` as either ``deflate`` (with any ortho data type) or ``jpeg`` (with the ``uint8`` or ``uint16`` ortho data types). If ``--compress`` is not specified, compression defaults to ``jpeg`` when the ortho data type is ``uint8``, otherwise it defaults to ``deflate``. When ``jpeg`` compression is used with the ``uint16`` data type, the ortho is 12 bit ``jpeg`` compressed.
14
+
Compression can be configured with ``--compress`` as either ``deflate`` or ``lzw`` (with any ortho data type), or ``jpeg`` (with the ``uint8`` or ``uint16`` ortho data types). If ``--compress`` is not specified, compression defaults to ``jpeg`` when the ortho data type is ``uint8``, and to ``deflate`` otherwise. When ``jpeg`` compression is used with the ``uint16`` data type, the ortho is 12 bit ``jpeg`` compressed.
12
15
13
16
.. note::
14
17
@@ -20,11 +23,30 @@ The next example orthorectifies using EXIF / XMP tags, and configures the ortho
Valid ortho pixels are masked with either an internal mask band or a nodata value. By default, an internal mask is used when the ortho image is ``jpeg`` compressed. This avoids ``jpeg`` artefacts in invalid areas. When the ortho is ``deflate`` compressed, the default is use to a nodata value based on the data type. Masking behaviour can be changed with ``--write-mask`` to write an internal mask, or ``--no-write-mask`` to use a nodata value.
26
+
Masking and overviews
27
+
---------------------
28
+
29
+
Valid ortho pixels are masked with either an internal mask band or a nodata value. By default, an internal mask is used when the ortho image is ``jpeg`` compressed. This avoids ``jpeg`` artefacts in invalid areas. When the ortho is ``deflate`` or ``lzw`` compressed, the default is use to a nodata value based on the data type. Masking behaviour can be changed with ``--write-mask`` to write an internal mask, or ``--no-write-mask`` to use a nodata value.
24
30
25
-
Internal overviews are added by default. This can be changed with ``--no-build-ovw``. In this example, we create an ortho image with ``deflate`` compression, nodata rather than internal masking, and no internal overviews:
31
+
Internal overviews are added by default. This can be changed with ``--no-build-ovw``. In this example, we create an ortho image with ``deflate`` compression, internal masks, and no internal overviews:
For ortho image configurations not possible with the above options, custom creation options can be specified with ``--creation-option``. The ``--compress`` option is ignored, and no other creation options are set by Orthority when this is supplied.
41
+
42
+
The ortho can be formatted as a ``gtiff`` (GeoTIFF - the default) or ``cog`` (Cloud Optimised GeoTIFF) with ``--driver``.
43
+
44
+
This example formats the ortho as a GeoTIFF with internal masks, and specifies custom creation options for tiled YCbCr JPEG compression with a quality of 90:
Each driver has its own creation options. See the GDAL `GeoTIFF <https://gdal.org/en/latest/drivers/raster/gtiff.html#creation-options>`__ and `COG <https://gdal.org/en/latest/drivers/raster/cog.html#creation-options>`__ docs for details.
Copy file name to clipboardexpand all lines: docs/getting_started/cli/sharp_config.rst
+29-5
Original file line number
Diff line number
Diff line change
@@ -4,24 +4,48 @@
4
4
Output image configuration
5
5
==========================
6
6
7
-
Pan sharpened images are created as GeoTIFFs. Image format (data type, compression, nodata / internal mask and overviews) can be configured. Configuration options are shared with the |oty|_ orthorectification sub-commands, and default to sensible values when not supplied.
7
+
The pan-sharpened image format can be configured. Configuration options are shared with the |oty|_ orthorectification sub-commands, and default to sensible values when not supplied.
8
8
9
-
The image data type defaults to the multispectral image data type, and can be changed with ``--dtype``. Compression can be configured with ``--compress`` as either ``deflate`` (with any image data type) or ``jpeg`` (with the ``uint8`` or ``uint16`` image data types). If ``--compress`` is not specified, compression defaults to ``jpeg`` when the image data type is ``uint8``, otherwise it defaults to ``deflate``. When ``jpeg`` compression is used with the ``uint16`` data type, the image is 12 bit ``jpeg`` compressed.
9
+
Data type and compression
10
+
-------------------------
11
+
12
+
The image data type defaults to the multispectral image data type, and can be changed with ``--dtype``. Compression can be configured with ``--compress`` as either ``deflate`` or ``lzw`` (with any image data type), or ``jpeg`` (with the ``uint8`` or ``uint16`` image data types). If ``--compress`` is not specified, compression defaults to ``jpeg`` when the image data type is ``uint8``, and to ``deflate`` otherwise. When ``jpeg`` compression is used with the ``uint16`` data type, the image is 12 bit ``jpeg`` compressed.
10
13
11
14
.. note::
12
15
13
16
Support for 12 bit JPEG compression is Rasterio_ build / package dependent.
14
17
15
-
The next example creates a pansharpened image with the ``int16`` data type, and ``deflate`` compression:
18
+
The next example creates a pan-sharpened image with the ``int16`` data type, and ``deflate`` compression:
Valid image pixels are masked with either an internal mask band or a nodata value. By default, an internal mask is used when the image image is ``jpeg`` compressed. This avoids ``jpeg`` artefacts in invalid areas. When the image is ``deflate`` compressed, the default is use to a nodata value based on the data type. Masking behaviour can be changed with ``--write-mask`` to write an internal mask, or ``--no-write-mask`` to use a nodata value.
24
+
Masking and overviews
25
+
---------------------
26
+
27
+
Valid image pixels are masked with either an internal mask band or a nodata value. By default, an internal mask is used when the image is ``jpeg`` compressed. This avoids ``jpeg`` artefacts in invalid areas. When the image is ``deflate`` or ``lzw`` compressed, the default is use to a nodata value based on the data type. Masking behaviour can be changed with ``--write-mask`` to write an internal mask, or ``--no-write-mask`` to use a nodata value.
22
28
23
-
Internal overviews are added by default. This can be changed with ``--no-build-ovw``. In this example, we create an pansharpened image with ``deflate`` compression, internal masking rather than nodata, and no internal overviews:
29
+
Internal overviews are added by default. This can be changed with ``--no-build-ovw``. In this example, we create an pan-sharpened image with ``deflate`` compression, internal masking rather than nodata, and no internal overviews:
For pan-sharpened image configurations not possible with the above options, custom creation options can be specified with ``--creation-option``. The ``--compress`` option is ignored, and no other creation options are set by Orthority when this is supplied.
39
+
40
+
The image can be formatted as a ``gtiff`` (GeoTIFF - the default) or ``cog`` (Cloud Optimised GeoTIFF) with ``--driver``.
41
+
42
+
This example formats the pan-sharpened image as a COG with internal masks, and specifies custom creation options for JPEG compression with a quality of 90:
Each driver has its own creation options. See the GDAL `GeoTIFF <https://gdal.org/en/latest/drivers/raster/gtiff.html#creation-options>`__ and `COG <https://gdal.org/en/latest/drivers/raster/cog.html#creation-options>`__ docs for details.
Copy file name to clipboardexpand all lines: docs/getting_started/cli/sharpen.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
``oty sharpen``
4
4
===============
5
5
6
-
|oty sharpen|_ implements the Gram-Schmidt pansharpening method. This example pansharpens a multispectral (RGB) drone image with its matching panchromatic image:
6
+
|oty sharpen|_ implements the Gram-Schmidt pan-sharpening method. This example pan-sharpens a multispectral (RGB) drone image with its matching panchromatic image:
0 commit comments