%% Generated by Sphinx.
\def\sphinxdocclass{report}
\documentclass[letterpaper,10pt]{sphinxmanual}
\ifdefined\pdfpxdimen
   \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
\fi \sphinxpxdimen=.75bp\relax
\ifdefined\pdfimageresolution
    \pdfimageresolution= \numexpr \dimexpr1in\relax/\sphinxpxdimen\relax
\fi
%% let collapsible pdf bookmarks panel have high depth per default
\PassOptionsToPackage{bookmarksdepth=5}{hyperref}


\PassOptionsToPackage{warn}{textcomp}


\usepackage{cmap}

\usepackage{amsmath,amssymb,amstext}







\usepackage{sphinx}

\fvset{fontsize=auto}
\usepackage{geometry}


% Include hyperref last.
\usepackage{hyperref}
% Fix anchor placement for figures with captions.
\usepackage{hypcap}% it must be loaded after hyperref.
% Set up styles of URL: it should be placed after hyperref.
\urlstyle{same}


\usepackage{sphinxmessages}




\title{Akhdefo software documentation}
\date{Jan 13, 2023}
\release{2023}
\author{Mahmud Mustafa Muhammad}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
\makeindex
\begin{document}

\pagestyle{empty}
\cover
\pagestyle{plain}
\sphinxtableofcontents
\pagestyle{normal}
\phantomsection\label{\detokenize{index::doc}}


\sphinxstepscope


\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithnovlinesstyle
\centering
\begin{tabulary}{\linewidth}[t]{\X{1}{2}\X{1}{2}}
\sphinxtoprule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.unzip:akhdefo_functions.unzip}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.unzip}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.unzip:akhdefo_functions.unzip}})(zipdir, dst\_dir)
&
\sphinxAtStartPar
This program unzips all the zip products into one folder
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.copyImage_Data:akhdefo_functions.copyImage_Data}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.copyImage\_Data}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.copyImage_Data:akhdefo_functions.copyImage_Data}})({[}...{]})
&
\sphinxAtStartPar
This program copy all the raster images.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data:akhdefo_functions.copyUDM2_Mask_Data}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.copyUDM2\_Mask\_Data}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data:akhdefo_functions.copyUDM2_Mask_Data}})({[}...{]})
&
\sphinxAtStartPar
This program copy all  raster masks.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Filter_PreProcess:akhdefo_functions.Filter_PreProcess}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Filter\_PreProcess}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Filter_PreProcess:akhdefo_functions.Filter_PreProcess}})({[}...{]})
&
\sphinxAtStartPar
This program prepare and uses filters to balanace raster image brightness
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Crop_to_AOI:akhdefo_functions.Crop_to_AOI}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Crop\_to\_AOI}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Crop_to_AOI:akhdefo_functions.Crop_to_AOI}})({[}...{]})
&
\sphinxAtStartPar
This program used to clip multiple  raster files
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Mosaic:akhdefo_functions.Mosaic}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Mosaic}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Mosaic:akhdefo_functions.Mosaic}})({[}...{]})
&
\sphinxAtStartPar
This program mosiacs raster images in geotif format as well grab dates the satellite image taken for further processing.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Coregistration:akhdefo_functions.Coregistration}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Coregistration}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Coregistration:akhdefo_functions.Coregistration}})({[}...{]})
&
\sphinxAtStartPar
This program coregisteres multiple rasters using both structural similarity index and feature matching techniqws.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.DynamicChangeDetection:akhdefo_functions.DynamicChangeDetection}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.DynamicChangeDetection}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.DynamicChangeDetection:akhdefo_functions.DynamicChangeDetection}})({[}...{]})
&
\sphinxAtStartPar
This program calculates optical flow velocity from triplets of daily optical satellite images.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.plot_stackNetwork:akhdefo_functions.plot_stackNetwork}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.plot\_stackNetwork}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.plot_stackNetwork:akhdefo_functions.plot_stackNetwork}})({[}...{]})
&
\sphinxAtStartPar
This Program plots temporal network of triplets to be stacked for calculating  Annual Mean Velocity from stacked optical images.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.stackprep:akhdefo_functions.stackprep}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.stackprep}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.stackprep:akhdefo_functions.stackprep}})({[}...{]})
&
\sphinxAtStartPar
This program collects velocity candiate points for time\sphinxhyphen{}series analysis.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Time_Series:akhdefo_functions.Time_Series}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Time\_Series}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Time_Series:akhdefo_functions.Time_Series}})({[}...{]})
&
\sphinxAtStartPar
This program uses candiate velocity points from stackprep function and performs linear interpolation in time\sphinxhyphen{}domain to calibrate stacked velocity.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.akhdefo_ts_plot:akhdefo_functions.akhdefo_ts_plot}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.akhdefo\_ts\_plot}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.akhdefo_ts_plot:akhdefo_functions.akhdefo_ts_plot}})({[}...{]})
&
\sphinxAtStartPar
This program used for analysis time\sphinxhyphen{}series velocity profiles
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.rasterClip:akhdefo_functions.rasterClip}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.rasterClip}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.rasterClip:akhdefo_functions.rasterClip}})(rasterpath, ...)
&
\sphinxAtStartPar
This program used to clip single raster file.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.akhdefo_viewer:akhdefo_functions.akhdefo_viewer}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.akhdefo\_viewer}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.akhdefo_viewer:akhdefo_functions.akhdefo_viewer}})({[}...{]})
&
\sphinxAtStartPar
This program used for plotting raster products.
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Akhdefo_resample:akhdefo_functions.Akhdefo_resample}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Akhdefo\_resample}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Akhdefo_resample:akhdefo_functions.Akhdefo_resample}})({[}...{]})
&
\sphinxAtStartPar
This program performs raster resampling for  rasters
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Akhdefo_inversion:akhdefo_functions.Akhdefo_inversion}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Akhdefo\_inversion}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Akhdefo_inversion:akhdefo_functions.Akhdefo_inversion}})({[}...{]})
&
\sphinxAtStartPar
This program calculates 3D displacement velocity (East\sphinxhyphen{}West,North\sphinxhyphen{}South and vertical) using combined optical and InSAR products
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.utm_to_latlon:akhdefo_functions.utm_to_latlon}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.utm\_to\_latlon}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.utm_to_latlon:akhdefo_functions.utm_to_latlon}})(easting, ...)
&
\sphinxAtStartPar
This program converts geographic projection of shapefiles from UTM to LATLONG
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts:akhdefo_functions.MeanProducts_plot_ts}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.MeanProducts\_plot\_ts}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts:akhdefo_functions.MeanProducts_plot_ts}})({[}...{]})
&
\sphinxAtStartPar
This program used to plot shapefile data
\\
\sphinxhline
\sphinxAtStartPar
{\hyperref[\detokenize{generated/akhdefo_functions.Auto_Variogram:akhdefo_functions.Auto_Variogram}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{akhdefo\_functions.Auto\_Variogram}}}}} (\autopageref*{\detokenize{generated/akhdefo_functions.Auto_Variogram:akhdefo_functions.Auto_Variogram}})({[}...{]})
&
\sphinxAtStartPar
This program automatically selects best variogram model which later  can be used to interpolate datapoints.
\\
\sphinxbottomrule
\end{tabulary}
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

\sphinxstepscope


\chapter{akhdefo\_functions.unzip}
\label{\detokenize{generated/akhdefo_functions.unzip:akhdefo-functions-unzip}}\label{\detokenize{generated/akhdefo_functions.unzip::doc}}\label{\detokenize{generated/akhdefo_functions.unzip::doc}}\index{unzip() (in module akhdefo\_functions)@\spxentry{unzip()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.unzip:akhdefo_functions.unzip}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{unzip}}}{\emph{\DUrole{n}{zipdir}}, \emph{\DUrole{n}{dst\_dir}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program unzips all the zip products into one folder


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.unzip:parameters}}\begin{description}
\sphinxlineitem{zipdir}{[}str{]}
\sphinxAtStartPar
path to directory contains all the zipfiles

\sphinxlineitem{dst\_dir}{[}str{]}
\sphinxAtStartPar
path to destination folder to copy all unzipped products.

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.unzip:returns}}
\sphinxAtStartPar
unzip folder

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.copyImage\_Data}
\label{\detokenize{generated/akhdefo_functions.copyImage_Data:akhdefo-functions-copyimage-data}}\label{\detokenize{generated/akhdefo_functions.copyImage_Data::doc}}\index{copyImage\_Data() (in module akhdefo\_functions)@\spxentry{copyImage\_Data()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.copyImage_Data:akhdefo_functions.copyImage_Data}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{copyImage\_Data}}}{\emph{\DUrole{n}{path\_to\_unzipped\_folders}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Path\_to\_raster\_tifs}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program copy all the raster images.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.copyImage_Data:parameters}}
\sphinxAtStartPar
path\_to\_unzipped\_folders : str

\sphinxAtStartPar
Path\_to\_raster\_tifs : str


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.copyImage_Data:returns}}
\sphinxAtStartPar
rasters

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.copyUDM2\_Mask\_Data}
\label{\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data:akhdefo-functions-copyudm2-mask-data}}\label{\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data::doc}}\index{copyUDM2\_Mask\_Data() (in module akhdefo\_functions)@\spxentry{copyUDM2\_Mask\_Data()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data:akhdefo_functions.copyUDM2_Mask_Data}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{copyUDM2\_Mask\_Data}}}{\emph{\DUrole{n}{path\_to\_unzipped\_folders}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Path\_to\_UDM2raster\_tifs}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program copy all  raster masks.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data:parameters}}\begin{description}
\sphinxlineitem{path\_to\_unzipped\_folders}{[}str{]}
\sphinxAtStartPar
file extension must end with udm2\_clip.tif

\end{description}

\sphinxAtStartPar
Path\_to\_UDM2raster\_tifs : str


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.copyUDM2_Mask_Data:returns}}
\sphinxAtStartPar
rasters

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Filter\_PreProcess}
\label{\detokenize{generated/akhdefo_functions.Filter_PreProcess:akhdefo-functions-filter-preprocess}}\label{\detokenize{generated/akhdefo_functions.Filter_PreProcess::doc}}\index{Filter\_PreProcess() (in module akhdefo\_functions)@\spxentry{Filter\_PreProcess()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Filter_PreProcess:akhdefo_functions.Filter_PreProcess}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Filter\_PreProcess}}}{\emph{\DUrole{n}{unfiltered\_folderPath}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{UDM2\_maskfolderPath}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{outpath\_dir}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Udm\_Mask\_Option}\DUrole{o}{=}\DUrole{default_value}{False}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program prepare and uses filters to balanace raster image brightness


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Filter_PreProcess:parameters}}
\sphinxAtStartPar
unfiltered\_folderPath : str

\sphinxAtStartPar
UDM2\_maskfolderPath : str

\sphinxAtStartPar
outpath\_dir : str
\begin{description}
\sphinxlineitem{Udm\_Mask\_Option}{[}bool{]}
\sphinxAtStartPar
False if True the program uses planetlabs imagery unusable pixel mask to ignore and mask bad image pixels

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Filter_PreProcess:returns}}\begin{description}
\sphinxlineitem{geotif rasters}
\sphinxAtStartPar
Filtered geotif rasters

\sphinxlineitem{Figures}
\sphinxAtStartPar
plotted filtered rasters and mask for bad pixels

\end{description}

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Crop\_to\_AOI}
\label{\detokenize{generated/akhdefo_functions.Crop_to_AOI:akhdefo-functions-crop-to-aoi}}\label{\detokenize{generated/akhdefo_functions.Crop_to_AOI::doc}}\index{Crop\_to\_AOI() (in module akhdefo\_functions)@\spxentry{Crop\_to\_AOI()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Crop_to_AOI:akhdefo_functions.Crop_to_AOI}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Crop\_to\_AOI}}}{\emph{\DUrole{n}{Path\_to\_WorkingDir}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Path\_to\_AOI\_shapefile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_CroppedDir}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program used to clip multiple  raster files


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Crop_to_AOI:parameters}}\begin{description}
\sphinxlineitem{Path\_to\_WorkingDir}{[}str{]}
\sphinxAtStartPar
path to raster working directory

\sphinxlineitem{Path\_to\_AOI\_shapefile}{[}str{]}
\sphinxAtStartPar
path to Area of interest in shapefile format

\sphinxlineitem{output\_CroppedDir}{[}str {]}
\sphinxAtStartPar
path to save cropped raster files

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Crop_to_AOI:returns}}
\sphinxAtStartPar
cropped raster files

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Mosaic}
\label{\detokenize{generated/akhdefo_functions.Mosaic:akhdefo-functions-mosaic}}\label{\detokenize{generated/akhdefo_functions.Mosaic::doc}}\index{Mosaic() (in module akhdefo\_functions)@\spxentry{Mosaic()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Mosaic:akhdefo_functions.Mosaic}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Mosaic}}}{\emph{\DUrole{n}{Path\_to\_WorkingDir}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_MosaicDir}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{img\_mode}\DUrole{o}{=}\DUrole{default_value}{0}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program mosiacs raster images in geotif format as well grab dates the satellite image taken for further processing. 
The current version only supports Planet Labs SurfaceReflectance products.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Mosaic:parameters}}
\sphinxAtStartPar
Path\_to\_WorkingDir : str

\sphinxAtStartPar
output\_MosaicDir : str
\begin{description}
\sphinxlineitem{img\_mode}{[}int{]}
\sphinxAtStartPar
if img\_mode=0 the the programs mosaics only the raster images. 
if img\_mode=1 the program mosiacs only mask rasters

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Mosaic:returns}}
\sphinxAtStartPar
Mosaiced raster images

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Coregistration}
\label{\detokenize{generated/akhdefo_functions.Coregistration:akhdefo-functions-coregistration}}\label{\detokenize{generated/akhdefo_functions.Coregistration::doc}}\index{Coregistration() (in module akhdefo\_functions)@\spxentry{Coregistration()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Coregistration:akhdefo_functions.Coregistration}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Coregistration}}}{\emph{\DUrole{n}{input\_Folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{grid\_res}\DUrole{o}{=}\DUrole{default_value}{20}}, \emph{\DUrole{n}{min\_reliability}\DUrole{o}{=}\DUrole{default_value}{60}}, \emph{\DUrole{n}{window\_size}\DUrole{o}{=}\DUrole{default_value}{(64, 64)}}, \emph{\DUrole{n}{path\_figures}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{showFig}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{no\_data}\DUrole{o}{=}\DUrole{default_value}{{[}0, 0{]}}}, \emph{\DUrole{n}{single\_ref\_path}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program coregisteres multiple rasters using both structural similarity index and feature matching techniqws.
This program is written based on arosics python library.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Coregistration:parameters}}\begin{description}
\sphinxlineitem{input\_Folder: str}
\sphinxAtStartPar
Path to input raster folders

\end{description}

\sphinxAtStartPar
grid\_res: int
\begin{description}
\sphinxlineitem{min\_reliability: int}
\sphinxAtStartPar
structural simialrity index threshold to differentaite deformation from raster shift (min=20, max=100)

\sphinxlineitem{window\_size: tuple}
\sphinxAtStartPar
window size for pixel search

\sphinxlineitem{showFig: bool}
\sphinxAtStartPar
True to display results or False to not displat results

\sphinxlineitem{no\_data: list}
\sphinxAtStartPar
No data values to be ignored for both reference and target image

\sphinxlineitem{single\_ref\_path: str}
\sphinxAtStartPar
provide path to raster if interested to coregister all rasters to a single reference, ignore this option the program uses subsequent rasters as refernce.

\sphinxlineitem{output\_folder: str}
\sphinxAtStartPar
returns coregistred and georeferenced raster in geotif format

\sphinxlineitem{path\_figures: str}
\sphinxAtStartPar
returns figure with plotted displaced pixels in raster coordinate system units

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Coregistration:returns}}
\sphinxAtStartPar
coregistred rasters

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.DynamicChangeDetection}
\label{\detokenize{generated/akhdefo_functions.DynamicChangeDetection:akhdefo-functions-dynamicchangedetection}}\label{\detokenize{generated/akhdefo_functions.DynamicChangeDetection::doc}}\index{DynamicChangeDetection() (in module akhdefo\_functions)@\spxentry{DynamicChangeDetection()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.DynamicChangeDetection:akhdefo_functions.DynamicChangeDetection}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{DynamicChangeDetection}}}{\emph{\DUrole{n}{Path\_working\_Directory}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Path\_UDM2\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Path\_to\_DEMFile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Coh\_Thresh}\DUrole{o}{=}\DUrole{default_value}{0.75}}, \emph{\DUrole{n}{vel\_thresh}\DUrole{o}{=}\DUrole{default_value}{0.063}}, \emph{\DUrole{n}{udm\_mask\_option}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{cmap}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}jet\textquotesingle{}}}, \emph{\DUrole{n}{Median\_Filter}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{Set\_fig\_MinMax}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{show\_figure}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{plot\_option}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}origional\textquotesingle{}}}, \emph{\DUrole{n}{xres}\DUrole{o}{=}\DUrole{default_value}{10}}, \emph{\DUrole{n}{yres}\DUrole{o}{=}\DUrole{default_value}{10}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program calculates optical flow velocity from triplets of daily optical satellite images.
Final Timeseris products will be a shapefile format using Time\_Series function after stackprep step.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.DynamicChangeDetection:parameters}}
\sphinxAtStartPar
Path\_working\_Directory : str

\sphinxAtStartPar
Path\_UDM2\_folder : str

\sphinxAtStartPar
Path\_to\_DEMFile : str

\sphinxAtStartPar
Coh\_Thresh : float

\sphinxAtStartPar
vel\_thresh : float

\sphinxAtStartPar
udm\_mask\_option : bool

\sphinxAtStartPar
cmap : str

\sphinxAtStartPar
Median\_Filter : bool

\sphinxAtStartPar
Set\_fig\_MinMax : bool

\sphinxAtStartPar
show\_figure : bool
\begin{description}
\sphinxlineitem{plot\_option}{[}str{]}
\sphinxAtStartPar
“origional”,  “resampled”

\end{description}

\sphinxAtStartPar
xres : int

\sphinxAtStartPar
yres : int


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.DynamicChangeDetection:returns}}\begin{description}
\sphinxlineitem{Rasters}
\sphinxAtStartPar
velocity in X direction(EW)
Velocity in Y direction(NS)

\sphinxlineitem{Figures  }
\sphinxAtStartPar
Initial Timesereis Figures (those figures are only intermediate products needs calibration)

\end{description}

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.plot\_stackNetwork}
\label{\detokenize{generated/akhdefo_functions.plot_stackNetwork:akhdefo-functions-plot-stacknetwork}}\label{\detokenize{generated/akhdefo_functions.plot_stackNetwork::doc}}\index{plot\_stackNetwork() (in module akhdefo\_functions)@\spxentry{plot\_stackNetwork()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.plot_stackNetwork:akhdefo_functions.plot_stackNetwork}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{plot\_stackNetwork}}}{\emph{\DUrole{n}{src\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{cmap}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}tab20\textquotesingle{}}}, \emph{\DUrole{n}{date\_plot\_interval}\DUrole{o}{=}\DUrole{default_value}{(5, 30)}}, \emph{\DUrole{n}{marker\_size}\DUrole{o}{=}\DUrole{default_value}{15}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This Program plots temporal network of triplets to be stacked for calculating 
Annual Mean Velocity from stacked optical images.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.plot_stackNetwork:parameters}}\begin{description}
\sphinxlineitem{src\_folder}{[}str{]}
\sphinxAtStartPar
path to georeferenced\_folder

\sphinxlineitem{output\_folder}{[}str{]}
\sphinxAtStartPar
path to output folder to save output Figure plot

\sphinxlineitem{cmap}{[}str{]}
\sphinxAtStartPar
colormap for the plot default is “tab20”

\sphinxlineitem{date\_plot\_interval}{[}list{]}
\sphinxAtStartPar
minumum and maximum plot x axis interval dates for the plot

\sphinxlineitem{marker\_size}{[}float{]}
\sphinxAtStartPar
size of plotted points default is 15

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.plot_stackNetwork:returns}}
\sphinxAtStartPar
Figure

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.stackprep}
\label{\detokenize{generated/akhdefo_functions.stackprep:akhdefo-functions-stackprep}}\label{\detokenize{generated/akhdefo_functions.stackprep::doc}}\index{stackprep() (in module akhdefo\_functions)@\spxentry{stackprep()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.stackprep:akhdefo_functions.stackprep}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{stackprep}}}{\emph{\DUrole{n}{path\_to\_flowxnFolder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{path\_toFlowynFolder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{dem}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{print\_list}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{start\_date}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}YYYYMMDD\textquotesingle{}}}, \emph{\DUrole{n}{end\_date}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}YYYYMMDD\textquotesingle{}}}, \emph{\DUrole{n}{output\_stackedFolder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{VEL\_scale}\DUrole{o}{=}\DUrole{default_value}{(\textquotesingle{}month\textquotesingle{}, \textquotesingle{}year\textquotesingle{})}}, \emph{\DUrole{n}{xres}\DUrole{o}{=}\DUrole{default_value}{3.125}}, \emph{\DUrole{n}{yres}\DUrole{o}{=}\DUrole{default_value}{3.125}}, \emph{\DUrole{n}{Velocity\_shapeFile}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{Resampling}\DUrole{o}{=}\DUrole{default_value}{True}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program collects velocity candiate points for time\sphinxhyphen{}series analysis.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.stackprep:parameters}}\begin{description}
\sphinxlineitem{path\_to\_flowxnFolder}{[}str{]}
\sphinxAtStartPar
path to folder include east\sphinxhyphen{}west velocity files

\sphinxlineitem{path\_toFlowynFolder}{[}str{]}
\sphinxAtStartPar
path to folder include north\sphinxhyphen{}south velocity files

\sphinxlineitem{dem}{[}str{]}
\sphinxAtStartPar
path to digital elevation model file will be used to geocode the products

\sphinxlineitem{print\_list}{[}bool{]}
\sphinxAtStartPar
print list of temporal proceesed dates default is False

\sphinxlineitem{start\_date}{[}str{]}
\sphinxAtStartPar
“YYYYMMDD”

\sphinxlineitem{end\_date}{[}str{]}
\sphinxAtStartPar
“YYYYMMDD”

\end{description}

\sphinxAtStartPar
output\_stackedFolder : str
\begin{description}
\sphinxlineitem{VEL\_scale}{[}str{]}
\sphinxAtStartPar
“month” or “year”) at this stage you can ignore this option; will be removed from future versions

\end{description}

\sphinxAtStartPar
xres : float

\sphinxAtStartPar
yres : float

\sphinxAtStartPar
Velocity\_shapeFile: bool
\begin{quote}

\sphinxAtStartPar
set to True if need to generate points for temporal deformation analysis
\end{quote}

\sphinxAtStartPar
Resampling : bool
\begin{quote}

\sphinxAtStartPar
if True reduce number of measurement points but faster processing
\end{quote}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.stackprep:returns}}\begin{description}
\sphinxlineitem{ESRI Shapefile}
\sphinxAtStartPar
This file include candiate velocity points for timeseries analysis

\end{description}

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Time\_Series}
\label{\detokenize{generated/akhdefo_functions.Time_Series:akhdefo-functions-time-series}}\label{\detokenize{generated/akhdefo_functions.Time_Series::doc}}\index{Time\_Series() (in module akhdefo\_functions)@\spxentry{Time\_Series()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Time_Series:akhdefo_functions.Time_Series}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Time\_Series}}}{\emph{\DUrole{n}{stacked\_raster\_EW}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{stacked\_raster\_NS}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{velocity\_points}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{dates\_name}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{outputFilename}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{rasteriz\_mean\_products}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{std}\DUrole{o}{=}\DUrole{default_value}{1}}, \emph{\DUrole{n}{VEL\_Scale}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}year\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program uses candiate velocity points from stackprep function and performs linear interpolation in time\sphinxhyphen{}domain to calibrate
stacked velocity. Additionally produces corrected timeseries velocity(daily) in a shapefile.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Time_Series:parameters}}
\sphinxAtStartPar
stacked\_raster\_EW : str

\sphinxAtStartPar
stacked\_raster\_NS : str
\begin{description}
\sphinxlineitem{velocity\_points}{[}str {]}
\sphinxAtStartPar
Velcity Candidate points

\sphinxlineitem{dates\_name}{[}str{]}
\sphinxAtStartPar
text file include name of each date in format YYYYMMDD

\end{description}

\sphinxAtStartPar
output\_folder : str

\sphinxAtStartPar
outputFilename : str


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Time_Series:returns}}
\sphinxAtStartPar
Time\sphinxhyphen{}series shape file of velocity and direction EW, NS, and 2D(resultant Velocity and direction)

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.akhdefo\_ts\_plot}
\label{\detokenize{generated/akhdefo_functions.akhdefo_ts_plot:akhdefo-functions-akhdefo-ts-plot}}\label{\detokenize{generated/akhdefo_functions.akhdefo_ts_plot::doc}}\index{akhdefo\_ts\_plot() (in module akhdefo\_functions)@\spxentry{akhdefo\_ts\_plot()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.akhdefo_ts_plot:akhdefo_functions.akhdefo_ts_plot}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{akhdefo\_ts\_plot}}}{\emph{\DUrole{n}{path\_to\_shapefile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{dem\_path}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{point\_size}\DUrole{o}{=}\DUrole{default_value}{1.0}}, \emph{\DUrole{n}{opacity}\DUrole{o}{=}\DUrole{default_value}{0.75}}, \emph{\DUrole{n}{cmap}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}turbo\textquotesingle{}}}, \emph{\DUrole{n}{Set\_fig\_MinMax}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{MinMaxRange}\DUrole{o}{=}\DUrole{default_value}{{[}\sphinxhyphen{}50, 50{]}}}, \emph{\DUrole{n}{color\_field}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}VEL\textquotesingle{}}}, \emph{\DUrole{n}{user\_data\_points}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{path\_saveData\_points}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{save\_plot}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{Fig\_outputDir}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{VEL\_Scale}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}year\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program used for analysis time\sphinxhyphen{}series velocity profiles


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.akhdefo_ts_plot:parameters}}\begin{description}
\sphinxlineitem{user\_data\_points}{[}str{]}
\sphinxAtStartPar
provide path to csv. file contains x and y coordinate for points of interest
you can generate this file by providing path to path\_saveData\_points (POI.csv).
This is useful to save mouse click positions to repeat the plots for different datasets for example if you plot several TS profiles for
EW velocity product, you can recreate TS for the same exact position by saving POI.csv with path\_saveData\_points and then use that as input for the another
plot such as NS velocity product via setting user\_datapoints=”POI.csv”

\sphinxlineitem{path\_to\_shapefile}{[}str {]}
\sphinxAtStartPar
type path to timeseries shapefile in stack\_data/TS folder

\sphinxlineitem{dem\_path}{[}str{]}
\sphinxAtStartPar
path to dem raster in geotif fromat

\sphinxlineitem{point\_size}{[}float{]}
\sphinxAtStartPar
size of the sactter plot points

\sphinxlineitem{opacity}{[}float {]}
\sphinxAtStartPar
transparency of the scater overlay

\sphinxlineitem{cmap}{[}str{]}
\sphinxAtStartPar
Matplotlib colormap options example “RdYlBu\_r, jet, turbo, hsv, etc…”

\sphinxlineitem{Set\_fig\_MinMax}{[}bool{]}
\sphinxAtStartPar
True or False

\sphinxlineitem{MinMaxRange}{[}list{]}
\sphinxAtStartPar
{[}\sphinxhyphen{}50,50{]}  Normalize plot colormap range if Set\_fig\_MinMax=True

\sphinxlineitem{color\_field}{[}str {]}
\sphinxAtStartPar
‘VEL’ ,”VEL\_2D”, ‘VEL\_N’, ‘VEL\_E’, ‘VELDir\_MEA’

\sphinxlineitem{path\_saveData\_points}{[}str{]}
\sphinxAtStartPar
optional, provide directory path if you want to save profile data.
the data will be saved under POI.csv file

\sphinxlineitem{save\_plot: bool}
\sphinxAtStartPar
True or False

\sphinxlineitem{Fig\_outputDir}{[}str{]}\begin{quote}

\sphinxAtStartPar
if save\_plot=True then
you save your profile plots in interactive html file and jpg image
\end{quote}
\begin{description}
\sphinxlineitem{VEL\_Scale}{[}str{]}
\sphinxAtStartPar
‘year’ or ‘month’ projects the velocity into provided time\sphinxhyphen{}scale

\end{description}

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.akhdefo_ts_plot:returns}}
\sphinxAtStartPar
Interactive Figures

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.rasterClip}
\label{\detokenize{generated/akhdefo_functions.rasterClip:akhdefo-functions-rasterclip}}\label{\detokenize{generated/akhdefo_functions.rasterClip::doc}}\index{rasterClip() (in module akhdefo\_functions)@\spxentry{rasterClip()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.rasterClip:akhdefo_functions.rasterClip}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{rasterClip}}}{\emph{\DUrole{n}{rasterpath}}, \emph{\DUrole{n}{aoi}}, \emph{\DUrole{n}{outfilename}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program used to clip single raster file.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.rasterClip:parameters}}\begin{description}
\sphinxlineitem{rasterpath}{[}str{]}
\sphinxAtStartPar
path to raster file in geotif format

\sphinxlineitem{aoi}{[}str{]}
\sphinxAtStartPar
path to Area of interest in shapefile format

\sphinxlineitem{outfilename}{[}str{]}
\sphinxAtStartPar
path to output raster file in geotif format “.tif”

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.rasterClip:returns}}
\sphinxAtStartPar
clipped raster

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.akhdefo\_viewer}
\label{\detokenize{generated/akhdefo_functions.akhdefo_viewer:akhdefo-functions-akhdefo-viewer}}\label{\detokenize{generated/akhdefo_functions.akhdefo_viewer::doc}}\index{akhdefo\_viewer() (in module akhdefo\_functions)@\spxentry{akhdefo\_viewer()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.akhdefo_viewer:akhdefo_functions.akhdefo_viewer}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{akhdefo\_viewer}}}{\emph{\DUrole{n}{Path\_to\_DEMFile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{rasterfile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{cbar\_label}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}Velocity(mm/year)\textquotesingle{}}}, \emph{\DUrole{n}{title}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}Akhdefo\sphinxhyphen{}Viewer\textquotesingle{}}}, \emph{\DUrole{n}{pixel\_resolution\_meter}\DUrole{o}{=}\DUrole{default_value}{3.125}}, \emph{\DUrole{n}{outputfolder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{alpha}\DUrole{o}{=}\DUrole{default_value}{0.8}}, \emph{\DUrole{n}{unit}\DUrole{o}{=}\DUrole{default_value}{1}}, \emph{\DUrole{n}{cmap}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}jet\textquotesingle{}}}, \emph{\DUrole{n}{noDATA\_Mask}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{Normalize}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{SetDates\_Filename}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{Set\_fig\_MinMax}\DUrole{o}{=}\DUrole{default_value}{False}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program used for plotting raster products.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.akhdefo_viewer:parameters}}\begin{description}
\sphinxlineitem{Path\_to\_DEMFile}{[}str {]}
\sphinxAtStartPar
provide path to digital elevation raster file to be used as shaded base Map

\sphinxlineitem{rasterfile}{[}str{]}
\sphinxAtStartPar
provide path to raster file to be plotted

\sphinxlineitem{title}{[}str{]}
\sphinxAtStartPar
provide your desired title for the plot

\sphinxlineitem{pixel\_resolution\_meter}{[}float{]}
\sphinxAtStartPar
provide pixel resolution of the digital elevation raster to draw proper figure scalebar

\sphinxlineitem{outputfolder}{[}str{]}
\sphinxAtStartPar
provide path to ouput folder to save the plot

\sphinxlineitem{outputfileName}{[}str {]}
\sphinxAtStartPar
provide name for the output plot including the desired extension such as .jpg, .pmg, .pdf, etc..

\sphinxlineitem{alpha}{[}float{]}
\sphinxAtStartPar
transparency level for the plotted raster relative to hillshaded basemap

\sphinxlineitem{unit}{[}int{]}
\sphinxAtStartPar
conversion unit default is 1 (no conversion) if your data is in meter such as velocity in meter/year set unit to 2 to convert to mm/year

\sphinxlineitem{noDATA\_MAsk}{[}bool {]}
\sphinxAtStartPar
set to True if you do not want to plot zero values of your dataset

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.akhdefo_viewer:returns}}
\sphinxAtStartPar
Figure

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Akhdefo\_resample}
\label{\detokenize{generated/akhdefo_functions.Akhdefo_resample:akhdefo-functions-akhdefo-resample}}\label{\detokenize{generated/akhdefo_functions.Akhdefo_resample::doc}}\index{Akhdefo\_resample() (in module akhdefo\_functions)@\spxentry{Akhdefo\_resample()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Akhdefo_resample:akhdefo_functions.Akhdefo_resample}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Akhdefo\_resample}}}{\emph{\DUrole{n}{input\_raster}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_raster}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{xres}\DUrole{o}{=}\DUrole{default_value}{3.125}}, \emph{\DUrole{n}{yres}\DUrole{o}{=}\DUrole{default_value}{3.125}}, \emph{\DUrole{n}{SavFig}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{convert\_units}\DUrole{o}{=}\DUrole{default_value}{False}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program performs raster resampling for  rasters


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Akhdefo_resample:parameters}}\begin{description}
\sphinxlineitem{input\_raster}{[}str{]}
\sphinxAtStartPar
path to input raster

\sphinxlineitem{output\_raster}{[}str{]}
\sphinxAtStartPar
path to output raster

\sphinxlineitem{xres}{[}float{]}
\sphinxAtStartPar
horizontal resolution

\sphinxlineitem{yres}{[}float {]}
\sphinxAtStartPar
vertical resolution

\sphinxlineitem{SavFig}{[}bool{]}
\sphinxAtStartPar
True to save output plot False to ignore exporting plot

\sphinxlineitem{convert\_units}{[}bool {]}
\sphinxAtStartPar
if True converts raster value units from m to mm

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Akhdefo_resample:returns}}
\sphinxAtStartPar
Raster geotif

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Akhdefo\_inversion}
\label{\detokenize{generated/akhdefo_functions.Akhdefo_inversion:akhdefo-functions-akhdefo-inversion}}\label{\detokenize{generated/akhdefo_functions.Akhdefo_inversion::doc}}\index{Akhdefo\_inversion() (in module akhdefo\_functions)@\spxentry{Akhdefo\_inversion()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Akhdefo_inversion:akhdefo_functions.Akhdefo_inversion}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Akhdefo\_inversion}}}{\emph{\DUrole{n}{horizontal\_InSAR}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Vertical\_InSAR}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{EW\_Akhdefo}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{NS\_Akhdefo}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{demFile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{output\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program calculates 3D displacement velocity (East\sphinxhyphen{}West,North\sphinxhyphen{}South and vertical) using combined optical and InSAR products


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Akhdefo_inversion:parameters}}\begin{description}
\sphinxlineitem{horizontal\_InSAR}{[}str{]}
\sphinxAtStartPar
path to East Velocity InSAR product in geotif format

\sphinxlineitem{Vertical\_InSAR}{[}str{]}
\sphinxAtStartPar
path to Vertical Velocity InSAR product in geotif format

\sphinxlineitem{EW\_Akhdefo}{[}str {]}
\sphinxAtStartPar
path to east\sphinxhyphen{}west velocity  akhdefo(optical) product in geotif format

\sphinxlineitem{NS\_Akhdefo}{[}str{]}
\sphinxAtStartPar
path to north\sphinxhyphen{}south velocity  akhdefo(optical) product in geotif format

\sphinxlineitem{demFile}{[}str{]}
\sphinxAtStartPar
path to DEM raster in geotif format

\sphinxlineitem{output\_folder}{[}str{]}
\sphinxAtStartPar
path to save raster products

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Akhdefo_inversion:returns}}\begin{description}
\sphinxlineitem{Three geotif rasters}
\sphinxAtStartPar
3D\sphinxhyphen{}Velocity (D3D in mm/year) raster
Plunge raster in degrees
Trend raster in degress

\end{description}

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.utm\_to\_latlon}
\label{\detokenize{generated/akhdefo_functions.utm_to_latlon:akhdefo-functions-utm-to-latlon}}\label{\detokenize{generated/akhdefo_functions.utm_to_latlon::doc}}\index{utm\_to\_latlon() (in module akhdefo\_functions)@\spxentry{utm\_to\_latlon()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.utm_to_latlon:akhdefo_functions.utm_to_latlon}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{utm\_to\_latlon}}}{\emph{\DUrole{n}{easting}}, \emph{\DUrole{n}{northing}}, \emph{\DUrole{n}{zone\_number}}, \emph{\DUrole{n}{zone\_letter}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program converts geographic projection of shapefiles from UTM to LATLONG


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.utm_to_latlon:parameters}}
\sphinxAtStartPar
easting: Geopandas column with Easting

\sphinxAtStartPar
northing: Geopandas column with Northing

\sphinxAtStartPar
zone\_number: int

\sphinxAtStartPar
zone\_letter: “N” or “S”


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.utm_to_latlon:returns}}
\sphinxAtStartPar
{[}lon , lat {]}: List

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.MeanProducts\_plot\_ts}
\label{\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts:akhdefo-functions-meanproducts-plot-ts}}\label{\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts::doc}}\index{MeanProducts\_plot\_ts() (in module akhdefo\_functions)@\spxentry{MeanProducts\_plot\_ts()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts:akhdefo_functions.MeanProducts_plot_ts}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{MeanProducts\_plot\_ts}}}{\emph{\DUrole{n}{path\_to\_shapefile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{dem\_path}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{out\_folder}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}Figs\_analysis\textquotesingle{}}}, \emph{\DUrole{n}{color\_field}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{Set\_fig\_MinMax}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{MinMaxRange}\DUrole{o}{=}\DUrole{default_value}{{[}\sphinxhyphen{}100, 100{]}}}, \emph{\DUrole{n}{opacity}\DUrole{o}{=}\DUrole{default_value}{0.5}}, \emph{\DUrole{n}{cmap}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}jet\textquotesingle{}}}, \emph{\DUrole{n}{point\_size}\DUrole{o}{=}\DUrole{default_value}{1}}, \emph{\DUrole{n}{cbar\_label}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}mm/year\textquotesingle{}}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program used to plot shapefile data


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts:parameters}}
\sphinxAtStartPar
path\_to\_shapefile : str

\sphinxAtStartPar
dem\_path : str

\sphinxAtStartPar
out\_folder : str
\begin{description}
\sphinxlineitem{color\_field}{[}str{]}
\sphinxAtStartPar
geopandas column name

\end{description}

\sphinxAtStartPar
Set\_fig\_MinMax : bool

\sphinxAtStartPar
MinMaxRange : list

\sphinxAtStartPar
opacity : float

\sphinxAtStartPar
cmap : str

\sphinxAtStartPar
point\_size : str
\begin{description}
\sphinxlineitem{cbar\_label}{[}str{]}
\sphinxAtStartPar
“mm/year” or “degrees”, etc.. based on unit of the data column name in the color\_field

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.MeanProducts_plot_ts:returns}}
\sphinxAtStartPar
Figure

\end{fulllineitems}


\sphinxstepscope


\chapter{akhdefo\_functions.Auto\_Variogram}
\label{\detokenize{generated/akhdefo_functions.Auto_Variogram:akhdefo-functions-auto-variogram}}\label{\detokenize{generated/akhdefo_functions.Auto_Variogram::doc}}\index{Auto\_Variogram() (in module akhdefo\_functions)@\spxentry{Auto\_Variogram()}\spxextra{in module akhdefo\_functions}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{generated/akhdefo_functions.Auto_Variogram:akhdefo_functions.Auto_Variogram}}
\pysigstartsignatures
\pysiglinewithargsret{\sphinxcode{\sphinxupquote{akhdefo\_functions.}}\sphinxbfcode{\sphinxupquote{Auto\_Variogram}}}{\emph{\DUrole{n}{path\_to\_shapefile}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{column\_attribute}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}\textquotesingle{}}}, \emph{\DUrole{n}{latlon}\DUrole{o}{=}\DUrole{default_value}{False}}}{}
\pysigstopsignatures
\sphinxAtStartPar
This program automatically selects best variogram model which later 
can be used to interpolate datapoints.


\section{Parameters}
\label{\detokenize{generated/akhdefo_functions.Auto_Variogram:parameters}}
\sphinxAtStartPar
path\_to\_shapefile : str 
type path to shapefile to include data (point data)
the shapefile attribute must have x, y or lat, lon columns
\begin{description}
\sphinxlineitem{column\_attribute}{[}str{]}
\sphinxAtStartPar
Name of shapefile field attribute include data

\end{description}


\section{Returns}
\label{\detokenize{generated/akhdefo_functions.Auto_Variogram:returns}}\begin{description}
\sphinxlineitem{str}
\sphinxAtStartPar
name of best variogram model
also figure for plotted variogram models

\end{description}

\end{fulllineitems}



\chapter{Indices and tables}
\label{\detokenize{index:indices-and-tables}}\begin{itemize}
\item {} 
\sphinxAtStartPar
\DUrole{xref,std,std-ref}{genindex}

\item {} 
\sphinxAtStartPar
\DUrole{xref,std,std-ref}{modindex}

\item {} 
\sphinxAtStartPar
\DUrole{xref,std,std-ref}{search}

\end{itemize}



\renewcommand{\indexname}{Index}

\end{document}