added output creation options to COREG, COREG_LOCAL and DESHIFTER (keyword 'out_crea_options'); edited some docstrings

components.CoReg.COREG:
- implemented new keyword 'out_crea_options' for specifying GDAL output creation options
- __init__(): edited docstring

components.CoReg_local.COREG_LOCAL:
- implemented new keyword 'out_crea_options' for specifying GDAL output creation options
- __init__(): edited docstring

components.DeShifter.DESHIFTER:
- implemented new keyword 'out_crea_options' for specifying GDAL output creation options

coreg_cmd:
- added parameter '-fmt_out' to global coregistration subparser as well as to COREG call

- updated __version__

components.CoReg.COREG:
- coreg_info: bugfix for recalculating spatial shifts although they are already there

components.CoReg_local.COREG_LOCAL:
- CoRegPoints_table(): added docstring
- show_image_footprints(): added docstring

components.DeShifter.DESHIFTER:
- bugfix for not properly setting nodata value
- correct_shifts(): bugfix for not passing nodata value when saving GeoArray

components.Geom_Quality_Grid.Geom_Quality_Grid:
- CoRegPoints_table: added docstring
- GCPList: added docstring
- _get_imXY__mapXY_points(): added print output
- get_CoRegPoints_table(): updated progress bar calls
- to_PointShapefile(): reordered keywords; added docstring

- updated __version__

components.CoReg:
- imParams:
    - removed attribute 'corner_coords' (not needed anymore)
    - imParams.poly is now directly derived from GeoArray
- COREG:
    - added keywords 'footprint_poly_ref' and 'footprint_poly_tgt'
    - refactored 'data_corners_im0' and 'data_corners_im1' to 'data_corners_ref' and 'data_corners_tgt'
    - _get_clip_window_properties(): bugfix for getting stuck within while loop

components.CoReg_local:
- COREG_LOCAL:
    - added keywords 'footprint_poly_ref' and 'footprint_poly_tgt'
    - refactored 'data_corners_im0' and 'data_corners_im1' to 'data_corners_ref' and 'data_corners_tgt'
    - added keyword 'ignore_errors' (not yet implemented completely)

components.Geom_Quality_Grid.Geom_Quality_Grid:
- get_CoRegPoints_table(): added empty GDF assertion; updated COREG kwargs

components.geometry:
- get_true_corner_mapXY(): added DeprecationWarning

coreg_cmd:
- updated calls for COREG and COREG_LOCAL
- added TODOs

components.CoReg:
- imParams:
    - quiet mode and progress keyword are now passed to GeoArray

components.CoReg_local:
- COREG_LOCAL:
    - quiet mode and progress keyword are now passed to GeoArray

components.Geom_Quality_Grid.Geom_Quality_Grid:
 - quiet mode and progress keyword are now passed to GeoArray

components.CoReg.COREG:
- added _validate_ssim_improvement() - not yet working
- _get_image_windows_to_match(): bugfix for using wrong bands

components.CoReg_local.COREG_LOCAL:
- view_CoRegPoints(): now used the correct band of the background image

components.DeShifter.DESHIFTER:
- revised __init__()
- correct_shifts(): revised condition for diciding if warping is needed

components.Geom_Quality_Grid.Geom_Quality_Grid:
- _get_spatial_shifts(): bugfix for returning match win size XY vice versa

components.DeShifter.DESHIFTER:
- _get_out_grid(): bugfix for negative ref_ygsd

coreg_cmd:
- edited some print outputs

components.CoReg.COREG:
- edited docstring

- renamed dsc__CoReg_Sat_FourierShiftTheorem.py to coreg_cmd.py
- updated __version__
- updated README and associated figures

components.CoReg.imParams:
- r_b4match' and 's_b4match' are now internally handled as band indices rather than band numbers

components.CoReg._local.COREG_LOCAL:
- removed attributes r_b4match and s_b4match (confusing duplicates of COREG_LOCAL.imref.r_b4match

components.Geom_Quality_Grid.Geom_Quality_Grid:
- r_b4match' and 's_b4match' are now internally handled as band indices rather than band numbers

components.geometry:
- get_true_corner_mapXY(): added docstring, refactored keyword 'bandNr' to 'band' -> now handled as index

components.CoReg:
- imParams: mask is now calculated from only one band -> avoids reading the whole datacube

components.CoReg_local:
- COREG_LOCAL:
    - __init__(): some docstring modifications
    - added attribute '_success'
    - property quality_grid: now shows calculated coreg points figure in verbose mode
    - view_CoRegPoints(): added outlier filtering for points in figure
    - correct_shifts(): bugfix for trying to corrects shifts without GCPs

components.Geom_Quality_Grid.Geom_Quality_Grid:
- GCPList: bugfix for running to_GCPList() twice
- get_CoRegPoints_table(): disabled verbose mode during grid calculation
- to_GCPList(): now returns an empty list if no valid matches are available

MAIN:
- major revision; added subparsers; added argparser for COREG_LOCAL
- added run_global_coreg()
- added run_local_coreg()

- updated __version__

components.CoReg:
- imParams: bugfix for outdated assertion
- COREG:
    - implemented keyword 'progress' for switching progress bars on or off
    - converted attribute 'coreg_info' to property

components.CoReg_local.COREG_LOCAL:
- implemented keyword 'progress' for switching progress bars on or off
- added property 'coreg_info'

components.DeShifter.DESHIFTER:
- implemented keyword 'progress' for switching progress bars on or off
- removed deprecated keywords 'warp_alg' and 'tempDir'
- correct_shifts(): outcommented algorithm for GDAL command line warping

components.Geom_Quality_Grid.Geom_Quality_Grid:
- implemented keyword 'progress' for switching progress bars on or off
- get_CoRegPoints_table():
    - duplicated IO is now avoided
    - added progressbars for single and multiprocessing modes

- updated __version__

implemented new module 'CoReg_local' for detection and correction of local shifts; revised some functions due to changes in external library 'py_tools_ds'

components.CoReg:
- imParamObj: updated derivation of nodata value and footprint polygo
- COREG: - added attribute 'deshift_results'

components.CoReg_local:
- added as new module for detection and correction of local shifts

components.DeShifter:
- moved DESHIFTER property '_dict_rspAlg_rsp_Int' to module top-level
- _get_out_extent(): updated algorithm

components. Geom_Quality_Grid.Geom_Quality_Grid:
- __init__():
    - changed most of the input args and kwargs
    - revised the whole function -> COREG_obj is not instanced within class COREG_LOCAL
    - added property 'CoRegPoints_table'
    - added property 'GCPList'
    - dump_CoRegPoints_table(): revision
    - quality_grid_to_PointShapefile(): refactored to 'to_PointShapefile'
    - _quality_grid_to_PointShapefile(): refactored to '_to_PointShapefile'
    - quality_grid_to_Raster_using_KrigingOLD(): revised getter for path_out
    - _Kriging_sp(): revised getter for path_out
    - view_results(): moved to class COREG_LOCAL
    - view_results_folium(): moved to class COREG_LOCAL
    - correct_shifts(): moved to class COREG_LOCAL

components.geometry:
- get_true_corner_mapXY(): adjusted some lines due to update of 'py_tools_ds'
- find_noDataVal(): moved to external library 'py_tools_ds'

__init__:
- updated __version__

resampling algorithms are now adjustable in COREG; bugfix for not respecting taking nodata value when de-shifting

 COREG:
 - added keywords 'resamp_alg_deshift' and 'resamp_alg_calc'
 - updated docstring
 - added warning when resampling algorithm 'average' is chosen
 - _calc_shifted_cross_power_spectrum(): bugfix for not using pyfftw even if available
 - refactored calc_subpixel_shifts() to _calc_subpixel_shifts()
 - added _dict_rspAlg_rsp_Int

 DESHIFTER:
 - refactored dict_rspAlg_rsp_Int to property _dict_rspAlg_rsp_Int
 - added 'nodata' keyword

 MAIN:
 - fixed some typos

COREG / DESHIFTER: output format is now adjustable via keyword argument; Bugfix for wrong output filename

 COREG:
 - added keyword 'fmt_out' that allows to set the output format for deshifted data
 - improved docstring
 - Bugfix for missing output filename in case COREG had been instanced with default argument for path_out

 DESHIFTER:
 - added keyword 'fmt_out' that allows to set the output format for deshifted data
 - Bugfix for missing GeoArray in deshift_results in case align_grids=False

 MAIN:
 - updated default argument of '-o' option

COREG:
- some modifications in order to ensure Python 2.7 compatibility
- pyfftw is now only imported if available

Geom_Quality_Grid:
- some modifications in order to ensure Python 2.7 compatibility

MAIN:
- CoReg_Sat root directory is automatically added to PATH
- py_tools_ds root directory is automatically added to PATH (expected to be in CoReg_Sat root directory)

implemented shifts vector length and angle directly into CoReg; calculation of geometric quality grid now 100% faster

COREG:
- __init__(): added new attributes 'vec_length_map' and 'vec_angle_deg'
- _get_image_windows_to_match(): bugfix for running warp_ndarray in multiprocessing if multiprocessing is disabled
- calculate_spatial_shifts(): moved calculation of X/Y shifts in map units here; implemented calculation of shifts vector length and angle

DESHIFTER:
- __init__(): added attribute 'GeoArray_shifted'
- deshift_results(): added keys 'updated geotransform' and 'GeoArray_shifted' to returned dict

Geom_Quality_Grid:
- _get_spatial_shifts(): now returns values for all columns of quality grid
- revised get_quality_grid(): now much simpler and 100% faster
- view_results() added functionality for saving the output figure to disk

added functions for visualizing results of geometric quality grid and polygons calculated by COREG class

COREG:
- added show_image_footprints(): a function to show a web map containing the calculated polygons within Jupyter Notebook

DESHIFTER:
- correct_shifts(): bugfix for showing warping progress bars in quiet mode

Geom_Quality_Grid:
- added view_results(): a function for showing a map of the calculated quality grid with the target image as background
- added view_results_folium(): a function for showing a web map of the calculated quality grid with the target image as background (for Jupyter Notebook)

COREG:
- calculate_spatial_shifts(): bugfix for printing None instead of calculated shifts within RuntimeError in case of too large shifts

DESHIFTER:
- updated documentation of keyword warp_alg
- implemented multiprocessing (keyword CPUs)
- implemented first prototype of local shift-correction based on a list of GCPs

Geom_Quality_Grid:
- replaced keyword 'multiproc' by 'CPUs'
- added method to_GCPList()
- added method correct_shifts()

README:
- added README for the whole package

Daniel Scheffler authored Oct 13, 2016 and Mathias Peters committed Oct 13, 2016

CoReg:
- revised assertion message in case of different projections

DeShifter:
- De-shifting now also works if updated map info is None
- get_out_grid(): converted to protected method
- grids_alignable(): converted to protected method
- get_out_extent(): converted to protected method; bugfix for returning wrong order of output extent coordinated in case clipextent is None

- imParamObj: simplified parameter settings and adjusted calls of GEO.find_noDataVal

Geom_Quality_Grid:
- get_quality_grid(): bugfix for processing the wrong input array shape during coregistration
- added quiet mode for some print outputs

GEO:
- added new version of find_noDataVal() that now also supports GeoArrays as input
- get_true_corner_mapXY(): added automatic reordering of corner coordinates in order to avoid shapely self intersection warnings

Geom_Quality_Grid:
- get_quality_grid(): bugfix for calling dump_quality_grid before setting self.quality_grid

bugfix for not properly detecting actual image corner coordinates (fix applied in external library 'py_tools_ds')

CoReg:
- imParamObj: added verbose and quiet mode to GEO.get_true_corner_mapXY

GEO:
- improved error handling during calculation of actual image corner coordinates

COREG:
- some functions are now imported directly from py_tools_ds instead of from geometry
- moved imParamObj and COREG to new module 'CoReg'

DESHIFTER:
- some functions are now imported directly from py_tools_ds instead of from geometry
- moved DESHIFTER to new module 'DeShifter'

Geom_Quality_Grid:
- some functions are now imported directly from py_tools_ds instead of from geometry
- moved Geom_Quality_Grid to new module Geom_Quality_Grid

MAIN:
- fixed a unicode string error within arg parser
- some code style changes
- bugfix for not properly parsing '-calc_cor'
- __version__ is now imported from package.__init__

package.__init__:
- added __version__

UTL:
- removed deprecated imports

IO:
- revised some imports

GEO:
- removed all imports of functions that are not directly needed within geometry

new modules:
- CoReg
- DeShifter
- Geom_Quality_Grid

fixed a lot of incompatibilities caused by only partial revisions; some bugfixes => version now fully operable again

imParamObj:
- bugfix for not recognizing nodata values if 0
- bugfix for not setting  imParamObj.nodata in case of inmem-GeoArray
- added automatic fix of invalid footprint polygon

COREG:
- implemented new keyword argument 'path_verbose_out'
- set_outpathes(): major revision
- added calc_integer_shifts()
- added validate_integer_shifts()
- calculate_spatial_shifts(): simiplified implementation of the algorithm
- added some comments to calculate_spatial_shifts()
- get_updated_map_info(): reordered print outputs
- revised correct_shifts()
- refactored shift_image_by_updating_map_info() to _shift_image_by_updating_map_info()
- refactored align_coordinate_grids() to _align_coordinate_grids()
- refactored resample_without_grid_aligning() to _resample_without_grid_aligning()

DESHIFTER:
- implemented new keyword 'path_out'
- added object attribute self.align_grids
- correct_shifts(): added some comments and the possibility to write results to disk

Geom_Quality_Grid:     fixed some incompatibilities caused by revision of COREG and DESHIFTER; much faster multiprocessing by avoiding duplicated disk IO
- __init__():
    - added docstring to __init__()
    - implemented possibility to pass a GeoArrays as arguments to __init__()
    - some code style changes
    - added nodata attribute
- _get_imXY__mapXY_points(): revised  calculation of outer map coordinates
- revised _get_spatial_shifts(): now self don't has to be pickled anymore if called in multiprocessing -> much faster multiprocessing
- revised get_quality_grid() and implemented new call of _get_spatial_shifts()

MAIN:
- added parameter -vo (path verbose out)

- moved parts of get_true_corner_lonlat() to external packacke 'py_tools_ds'
- added imports for some more functions from 'py_tools_ds'
- added get_GeoArrayPosition_from_boxImYX()

UTL:
- added import of subcall_with_output()

COREG:
- moved class imParamObj to top-level
- implemented functionality to calculate the entire coregistration based on an array (in addition to image paths)
- added attribute tracked_errors and implemented it into COREG
- updated warp_ndarray calls
- revised coreg_info property
- added a new version of correct_shifts()

DESHIFTER:
- major revision of the whole class (it is now not based on a GMS object anymore but on a GeoArray and coreg_results)
- added function get_out_grid()
- added property grids_alignable
- added get_out_extent()
- revised correct_shifts()
- converted set_deshift_results() to property deshift_results

GEO:
- moved nearly the whole body of geometry.py to py_tools_ds (functions are now imported from there)

UTL:
- moved find_nearest() to py_tools_ds

COREG:
- fixed wrong references to IO module
- calculate_spatial_shifts(): fixed wrong calls of get_updated_map_info() and set_coreg_info()

GEO:
- updated find_nearest() calls within move_shapelyPoly_to_image_grid() and get_true_corner_lonlat()
- improved docstring for corner_coord_to_minmax()
- updated warp_ndarray(): added keyword argument 'outExtent_within'
- added transform_utm_to_wgs84()
- updated geotransform2mapinfo()

UTL:
- find_nearest(): major revision - it now supports an automatic round algorithm

COREG:
- __init__(): added some attributes in order to make it more compatible with GMS version
- added get_updated_map_info()
- added set_coreg_info()