Commit 10d9c448 authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

Fixed documentation on output data format. Updated version info.

parent 60385ce8
Pipeline #2934 passed with stages
in 3 minutes and 28 seconds
......@@ -133,7 +133,7 @@ class COREG(object):
- if None (default), the method correct_shifts() does not write to disk
- if 'auto': /dir/of/im1/<im1>__shifted_to__<im0>.bsq
:param fmt_out(str): raster file format for output file. ignored if path_out is None. can be any GDAL
compatible raster file format (e.g. 'ENVI', 'GeoTIFF'; default: ENVI). Refer to
compatible raster file format (e.g. 'ENVI', 'GTIFF'; default: ENVI). Refer to
http://www.gdal.org/formats_list.html to get a full list of supported formats.
:param out_crea_options(list): GDAL creation options for the output image,
e.g. ["QUALITY=80", "REVERSIBLE=YES", "WRITE_METADATA=YES"]
......
......@@ -59,7 +59,7 @@ class COREG_LOCAL(object):
- if None (default), no output is written to disk
- if 'auto': /dir/of/im1/<im1>__shifted_to__<im0>.bsq
:param fmt_out(str): raster file format for output file. ignored if path_out is None. Can be any GDAL
compatible raster file format (e.g. 'ENVI', 'GeoTIFF'; default: ENVI). Refer to
compatible raster file format (e.g. 'ENVI', 'GTIFF'; default: ENVI). Refer to
http://www.gdal.org/formats_list.html to get a full list of supported formats.
:param out_crea_options(list): GDAL creation options for the output image,
e.g. ["QUALITY=80", "REVERSIBLE=YES", "WRITE_METADATA=YES"]
......
......@@ -34,7 +34,7 @@ class DESHIFTER(object):
:Keyword Arguments:
- path_out(str): /output/directory/filename for coregistered results
- fmt_out (str): raster file format for output file. ignored if path_out is None. can be any GDAL
compatible raster file format (e.g. 'ENVI', 'GeoTIFF'; default: ENVI)
compatible raster file format (e.g. 'ENVI', 'GTIFF'; default: ENVI)
- out_crea_options(list): GDAL creation options for the output image,
e.g. ["QUALITY=20", "REVERSIBLE=YES", "WRITE_METADATA=YES"]
- band2process (int): The index of the band to be processed within the given array (starts with 1),
......@@ -382,7 +382,7 @@ def deshift_image_using_coreg_info(im2shift, coreg_results, path_out=None, fmt_o
:param path_out: /output/directory/filename for coregistered results. If None, no output is written - only
the shift corrected results are returned.
:param fmt_out: raster file format for output file. ignored if path_out is None. can be any GDAL
compatible raster file format (e.g. 'ENVI', 'GeoTIFF'; default: ENVI)
compatible raster file format (e.g. 'ENVI', 'GTIFF'; default: ENVI)
:param q: quiet mode (default: False)
:return:
"""
......
......@@ -12,8 +12,8 @@ from arosics.Tie_Point_Grid import Tie_Point_Grid
__author__ = """Daniel Scheffler"""
__email__ = 'daniel.scheffler@gfz-potsdam.de'
__version__ = '0.8.4'
__versionalias__ = '2018-03-08_01'
__version__ = '0.8.5'
__versionalias__ = '2018-04-25_01'
__all__ = ['COREG',
'COREG_LOCAL',
'DESHIFTER',
......
......@@ -147,7 +147,7 @@ def get_arosics_argparser():
gop_p('-fmt_out', nargs='?', type=str, default='ENVI',
help="raster file format for output file. ignored if path_out is None. can "
"be any GDAL compatible raster file format (e.g. 'ENVI', 'GeoTIFF'; default: ENVI)")
"be any GDAL compatible raster file format (e.g. 'ENVI', 'GTIFF'; default: ENVI)")
gop_p('-br', nargs='?', type=int, default=1,
help='band of reference image to be used for matching (starts with 1; default: 1)')
......@@ -195,7 +195,7 @@ def get_arosics_argparser():
gop_p('-mask_ref', nargs='?', type=str, metavar='file path', default=None,
help="path to a 2D boolean mask file for the reference image where all bad data pixels (e.g. clouds) are "
"marked with True or 1 and the remaining pixels with False or 0. Must have the same geographic extent "
"and projection like the refernce image. The mask is used to check if the chosen matching window "
"and projection like the reference image. The mask is used to check if the chosen matching window "
"position is valid in the sense of useful data. Otherwise this window position is rejected.")
gop_p('-mask_tgt', nargs='?', type=str, metavar='file path', default=None,
......
......@@ -28,7 +28,7 @@ test_requirements = requirements + ['coverage', 'nose', 'nose-htmloutput', 'redn
setup(
name='arosics',
version='0.8.4',
version='0.8.5',
description="An Automated and Robust Open-Source Image Co-Registration Software for Multi-Sensor Satellite Data",
long_description=readme + '\n\n' + history,
author="Daniel Scheffler",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment