ISCE_INSAR/applications/stitcher.py

#!/usr/bin/env python3 

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Copyright 2012 California Institute of Technology. ALL RIGHTS RESERVED.
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
# http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# 
# United States Government Sponsorship acknowledged. This software is subject to
# U.S. export control laws and regulations and has been classified as 'EAR99 NLR'
# (No [Export] License Required except when exporting to an embargoed country,
# end user, or in support of a prohibited end use). By downloading this software,
# the user agrees to comply with all applicable U.S. export laws and regulations.
# The user has the responsibility to obtain export licenses, or other export
# authority as may be required before exporting this software to any 'EAR99'
# embargoed foreign country or citizen of those countries.
#
# Author: Giangi Sacco
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~




import isce
import logging
import logging.config
from iscesys.Component.Application import Application
from iscesys.Component.Component import Component
import os
STITCHER = Component.Parameter('_stitcher',
    public_name='stitcher',
    default = 'version3',
    type = str,
    mandatory =  False,
    doc = "Use as argument for the stitcher factory. Supported  old version 2 or new version 3 SRTM") 
class Stitcher(Application):
    def main(self):
        # prevent from deleting local files
        if(self.demStitcher._useLocalDirectory):
            self.demStitcher._keepAfterFailed = True
            self.demStitcher._keepDems = True
        # is a metadata file is created set the right type
        if(self.demStitcher._meta == 'xml'):
            self.demStitcher.setCreateXmlMetadata(True)
        elif(self.demStitcher._meta == 'rsc'):
            self.demStitcher.setCreateRscMetadata(True)
        # check for the action to be performed
        if(self.demStitcher._action == 'stitch'):
            if(self.demStitcher._bbox):
                lat = self.demStitcher._bbox[0:2]
                lon = self.demStitcher._bbox[2:4]
                if (self.demStitcher._outputFile is None):
                    self.demStitcher._outputFile = self.demStitcher.defaultName(self.demStitcher._bbox)
    
                if not(self.demStitcher.stitchDems(lat,lon,self.demStitcher._source,self.demStitcher._outputFile,self.demStitcher._downloadDir, \
                        keep=self.demStitcher._keepDems)):
                    print('Could not create a stitched DEM. Some tiles are missing')
                else:
                    if(self.demStitcher._correct):
                        width = self.demStitcher.getDemWidth(lon,self.demStitcher._source)
                        self.demStitcher.correct()
                        #self.demStitcher.correct(self.demStitcher._output,self.demStitcher._source,width,min(lat[0],lat[1]),min(lon[0],lon[1]))
            else:
                print('Error. The --bbox (or -b) option must be specified when --action stitch is used')
                raise ValueError
        elif(self.demStitcher._action == 'download'):
            if(self.demStitcher._bbox):
                lat = self.demStitcher._bbox[0:2]
                lon = self.demStitcher._bbox[2:4]
                self.demStitcher.getDemsInBox(lat,lon,self.demStitcher._source,self.demStitcher._downloadDir)
            #can make the bbox and pairs mutually esclusive if replace the if below with elif
            if(self.demStitcher._pairs):
                self.demStitcher.downloadFilesFromList(self.demStitcher._pairs[::2],self.demStitcher._pairs[1::2],self.demStitcher._source,self.demStitcher._downloadDir) 
            if(not (self.demStitcher._bbox or self.demStitcher._pairs)):
                print('Error. Either the --bbox (-b) or the --pairs (-p) options must be specified when --action download is used')
                raise ValueError
        
        else:
            print('Unrecognized action -a or --action',self.demStitcher._action)
            return
    
        if(self.demStitcher._report):
            for k,v in list(self.demStitcher._downloadReport.items()):
                print(k,'=',v)
    
    def _facilities(self):
        """
        Define the user configurable facilities for this application.
        """
        self.demStitcher = self.facility(
            'demStitcher',
            public_name='demStitcher',
            module='contrib.demUtils',
            factory='createDemStitcher',
            args=(self.stitcher,'iscestitcher',),
            mandatory=False,
            doc=(
                "Object that based on the frame bounding boxes creates a DEM"
                )
            )
    def Usage(self):
        print("\nUsage: stitcher.py input.xml\n")
        print("NOTE: if you don't want to store your password in a file you can run it as\n" +\
              "'stitcher.py input.xml sticher.demStitcher.username=yourUsername\n" +\
              "sticher.demStitcher.password=yourPassword'\n\n" )
    
    family = 'stitcher'            
    
    parameter_list = (STITCHER,)
    
    @property
    def stitcher(self):
        return self._stitcher
    @stitcher.setter
    def stitcher(self,stitcher):
        self._stitcher = stitcher
                                      
    def __init__(self,family = '', name = ''):
        super(Stitcher, self).__init__(family if family else  self.__class__.family, name=name)


if __name__ == "__main__":
    import sys
    ds = Stitcher()
    ds.configure()
    ds.run()