Changes between Version 1 and Version 2 of programmersguide/architecture/services/analysis/python/operadorHistoricoPCD

Timestamp:

06/09/16 14:44:20 (10 years ago)

Author:

paulo.morais

Comment:

--

programmersguide/architecture/services/analysis/python/operadorHistoricoPCD

@@ -1 +1 @@
 = Operadores de histórico de PCDs =
+
+Conjunto de operadores para série de dados do tipo '''PCD'''
+
+== Mínimo ==
+
+Retorna o menor valor do atributo das PCDs que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.dcp.min("dataSeriesName", "attribute", datasetId, moBuffer, "dateFilter")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''attribute'': String com o nome do atributo da PCD que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''datasetId'': Identificador do dataset da PCD.
+- ''moBuffer'': Objeto Buffer para ser aplicado ao objeto monitorado. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''dateFilter'': String com o intervalo de tempo para filtrar a série de dados. (Ver [wiki:programmersguide/architecture/services/analysis/python/timeUnit Unidades de tempo]  )  
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.history.min("Serra do Mar", "Pluvio", 1, moBuffer, "1d")
+}}}
+
+
+----
+
+== Máximo==
+
+Retorna o maior valor do atributo das PCDs que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.dcp.max("dataSeriesName", "attribute", datasetId, moBuffer, "dateFilter")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''attribute'': String com o nome do atributo da PCD que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''datasetId'': Identificador do dataset da PCD.
+- ''moBuffer'': Objeto Buffer para ser aplicado ao objeto monitorado. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''dateFilter'': String com o intervalo de tempo para filtrar a série de dados. (Ver [wiki:programmersguide/architecture/services/analysis/python/timeUnit Unidades de tempo]  )  
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.history.max("Serra do Mar", "Pluvio", 1, moBuffer, "1d")
+}}}
+
+----
+
+==Média==
+
+Retorna a média dos valores do atributo das PCDs que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.dcp.mean("dataSeriesName", "attribute", datasetId, moBuffer, "dateFilter")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''attribute'': String com o nome do atributo da PCD que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''datasetId'': Identificador do dataset da PCD.
+- ''moBuffer'': Objeto Buffer para ser aplicado ao objeto monitorado. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''dateFilter'': String com o intervalo de tempo para filtrar a série de dados. (Ver [wiki:programmersguide/architecture/services/analysis/python/timeUnit Unidades de tempo]  )  
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.history.mean("Serra do Mar", "Pluvio", 1, moBuffer, "1d")
+}}}
+
+----
+
+== Soma == 
+
+Retorna a soma dos valores do atributo das PCDs que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.dcp.sum("dataSeriesName", "attribute", datasetId, moBuffer, "dateFilter")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''attribute'': String com o nome do atributo da PCD que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''datasetId'': Identificador do dataset da PCD.
+- ''moBuffer'': Objeto Buffer para ser aplicado ao objeto monitorado. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''dateFilter'': String com o intervalo de tempo para filtrar a série de dados. (Ver [wiki:programmersguide/architecture/services/analysis/python/timeUnit Unidades de tempo]  )  
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.history.sum("Serra do Mar", "Pluvio", 1, moBuffer, "1d")
+}}}
+
+----
+
+
+== Mediana == 
+
+Retorna  a mediana dos valores do atributo das PCDs que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+
+==== Assinatura ====
+
+{{{
+terrama2.dcp.median("dataSeriesName", "attribute", datasetId, moBuffer, "dateFilter")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''attribute'': String com o nome do atributo da PCD que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''datasetId'': Identificador do dataset da PCD.
+- ''moBuffer'': Objeto Buffer para ser aplicado ao objeto monitorado. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''dateFilter'': String com o intervalo de tempo para filtrar a série de dados. (Ver [wiki:programmersguide/architecture/services/analysis/python/timeUnit Unidades de tempo]  )  
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.history.median("Serra do Mar", "Pluvio", 1, moBuffer, "1d")
+}}}
+
+----
+
+== Desvio Padrão == 
+
+{{{
+terrama2.dcp.standard_deviation("dataSeriesName", "attribute", datasetId, moBuffer, "dateFilter")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''attribute'': String com o nome do atributo da PCD que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''datasetId'': Identificador do dataset da PCD.
+- ''moBuffer'': Objeto Buffer para ser aplicado ao objeto monitorado. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''dateFilter'': String com o intervalo de tempo para filtrar a série de dados. (Ver [wiki:programmersguide/architecture/services/analysis/python/timeUnit Unidades de tempo]  )  
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.history.standard_deviation("Serra do Mar", "Pluvio", 1, moBuffer, "1d")
+}}}
+
+
+----