QGIS/python/plugins/processing/parameters/ParameterRaster.py
2013-08-20 09:22:03 +02:00

94 lines
3.9 KiB
Python

# -*- coding: utf-8 -*-
"""
***************************************************************************
ParameterRaster.py
---------------------
Date : August 2012
Copyright : (C) 2012 by Victor Olaya
Email : volayaf at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
import os
__author__ = 'Victor Olaya'
__date__ = 'August 2012'
__copyright__ = '(C) 2012, Victor Olaya'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
from processing.parameters.ParameterDataObject import ParameterDataObject
from processing.core.QGisLayers import QGisLayers
from qgis.core import *
from processing.core.LayerExporter import LayerExporter
class ParameterRaster(ParameterDataObject):
def __init__(self, name="", description="", optional=False):
ParameterDataObject.__init__(self, name, description)
self.optional = optional
self.value = None
self.exported = None
def getSafeExportedLayer(self):
'''Returns not the value entered by the user, but a string with a filename which
contains the data of this layer, but saved in a standard format (currently always
a geotiff file) so that it can be opened by most external applications.
Works only if the layer represented by the parameter value is currently loaded in QGIS.
Otherwise, it will not perform any export and return the current value string.
If the current value represents a layer in a suitable format, it does not export at all
and returns that value.
The layer is exported just the first time the method is called. The method can be called
several times and it will always return the same file, performing the export only the first time.'''
if self.exported:
return self.exported
layer = QGisLayers.getObjectFromUri(self.value, False)
if layer:
self.exported = LayerExporter.exportRasterLayer(layer)
else:
self.exported = self.value
return self.exported
def setValue(self, obj):
self.exported = None
if obj == None:
if self.optional:
self.value = None
return True
else:
return False
if isinstance(obj, QgsRasterLayer):
self.value = unicode(obj.dataProvider().dataSourceUri())
return True
else:
self.value = unicode(obj)
layers = QGisLayers.getRasterLayers()
for layer in layers:
if layer.name() == self.value:
self.value = unicode(layer.dataProvider().dataSourceUri())
return True
return os.path.exists(self.value)
def getFileFilter(self):
exts = QGisLayers.getSupportedOutputRasterLayerExtensions()
for i in range(len(exts)):
exts[i] = exts[i].upper() + " files(*." + exts[i].lower() + ")"
return ";;".join(exts)
def serialize(self):
return self.__module__.split(".")[-1] + "|" + self.name + "|" + self.description +\
"|" + str(self.optional)
def deserialize(self, s):
tokens = s.split("|")
return ParameterRaster(tokens[1], tokens[2], str(True) == tokens[3])
def getAsScriptCode(self):
return "##" + self.name + "=raster"