QGIS/python/plugins/processing/algs/qgis/VectorLayerHistogram.py
2025-06-05 11:48:44 +10:00

120 lines
4.1 KiB
Python

"""
***************************************************************************
VectorLayerHistogram.py
---------------------
Date : January 2013
Copyright : (C) 2013 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. *
* *
***************************************************************************
"""
__author__ = "Victor Olaya"
__date__ = "January 2013"
__copyright__ = "(C) 2013, Victor Olaya"
import warnings
from qgis.core import (
QgsProcessingException,
QgsProcessingParameterFeatureSource,
QgsProcessingParameterField,
QgsProcessingParameterNumber,
QgsProcessingParameterFileDestination,
)
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
from processing.tools import vector
from qgis.PyQt.QtCore import QCoreApplication
class VectorLayerHistogram(QgisAlgorithm):
INPUT = "INPUT"
OUTPUT = "OUTPUT"
FIELD = "FIELD"
BINS = "BINS"
def group(self):
return self.tr("Plots")
def groupId(self):
return "plots"
def __init__(self):
super().__init__()
def initAlgorithm(self, config=None):
self.addParameter(
QgsProcessingParameterFeatureSource(self.INPUT, self.tr("Input layer"))
)
self.addParameter(
QgsProcessingParameterField(
self.FIELD,
self.tr("Attribute"),
parentLayerParameterName=self.INPUT,
type=QgsProcessingParameterField.DataType.Numeric,
)
)
self.addParameter(
QgsProcessingParameterNumber(
self.BINS, self.tr("number of bins"), minValue=2, defaultValue=10
)
)
self.addParameter(
QgsProcessingParameterFileDestination(
self.OUTPUT, self.tr("Histogram"), self.tr("HTML files (*.html)")
)
)
def name(self):
return "vectorlayerhistogram"
def displayName(self):
return self.tr("Vector layer histogram")
def shortDescription(self):
return self.tr(
"Generates a histogram with the values of the attribute of a vector layer."
)
def processAlgorithm(self, parameters, context, feedback):
try:
# importing plotly throws Python warnings from within the library - filter these out
with warnings.catch_warnings():
warnings.filterwarnings("ignore", category=ResourceWarning)
warnings.filterwarnings("ignore", category=ImportWarning)
import plotly as plt
import plotly.graph_objs as go
except ImportError:
raise QgsProcessingException(
QCoreApplication.translate(
"VectorLayerHistogram",
"This algorithm requires the Python “plotly” library. Please install this library and try again.",
)
)
source = self.parameterAsSource(parameters, self.INPUT, context)
if source is None:
raise QgsProcessingException(
self.invalidSourceError(parameters, self.INPUT)
)
fieldname = self.parameterAsString(parameters, self.FIELD, context)
bins = self.parameterAsInt(parameters, self.BINS, context)
output = self.parameterAsFileOutput(parameters, self.OUTPUT, context)
values = vector.values(source, fieldname)
data = [go.Histogram(x=values[fieldname], nbinsx=bins)]
plt.offline.plot(data, filename=output, auto_open=False)
return {self.OUTPUT: output}