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

Timestamp:

06/02/16 10:51:59 (10 years ago)

Author:

paulo.morais

Comment:

--

programmersguide/architecture/services/analysis/python/operadorAgregacaoOcorrencia

@@ -1 +1 @@
 
-=== Operadores de agregação de ocorrências ===
-
+= Operadores de agregação de ocorrências =
+
+Conjunto de operadores para série de dados do tipo '''Ocorrência''' com agregação de ocorrências na mesma área
+
+== Contagem ==
+
+Retorna a quantidade de ocorrências num intervalo de tempo dentre aquelas que interceptam o objeto monitorado ou sua área de influência, se houver sobreposição dos buffers de agregação, as ocorrências serão agrupadas e contadas como uma única ocorrência.
+
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.count("dataSeriesName", buffer, "dateFilter", aggregationBuffer, "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.count("ocorrencias", buffer, "1d", aggregationBuffer, "UF = 'AM'")
+}}}
+
+----
+
+
+== Mínimo ==
+
+Retorna o menor valor do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.min("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer, "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.min("ocorrencias", buffer, "1d", "Intensidade", Statistic.min, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----
+
+== Máximo==
+
+Retorna o maior valor do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.max("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer, "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.max("ocorrencias", buffer, "1d", "Intensidade", Statistic.max, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----
+
+==Média==
+
+Retorna a média dos valores do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.mean("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer,  "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.mean("ocorrencias", buffer, "1d", "Intensidade", Statistic.mean, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----
+
+== Mediana == 
+
+Retorna  a mediana dos valores do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.median("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer,  "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.median("ocorrencias", buffer, "1d", "Intensidade", Statistic.median, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----
+
+== Soma == 
+
+Retorna a soma dos valores do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.sum("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer,  "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.sum("ocorrencias", buffer, "1d", "Intensidade", Statistic.max, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----
+
+
+== Mediana == 
+
+Retorna  a mediana dos valores do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.median("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer,  "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.median("ocorrencias", buffer, "1d", "Intensidade", Statistic.median, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----
+
+== Desvio Padrão == 
+
+Retorna o desvio padrão dos valores do atributo das ocorrências que interceptam o objeto monitorado ou sua área de influência no intervalo de tempo informado.
+
+
+==== Assinatura ====
+
+{{{
+terrama2.occurrence.aggregation.standard_deviation("dataSeriesName", buffer, "dateFilter", "attribute", aggregationStatistic, aggregationBuffer,  "restriction")
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de ocorrências.
+- ''buffer'': 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 as ocorrências. Ex. "10h" para as ocorrências das últimas 10 horas ou "2d" para as ocorrências dos últimos dois dias.
+- ''attribute'': String com o nome do atributo da ocorrência que deve ser utilizado para recuperar os valores, o atributo deve ser do tipo numérico (Ex. Integer, Float, Double, Long).
+- ''aggregationStatistic'': Tipo de operador estatístico a ser utilizado para selecionar o valor do atributo para as ocorrências agregadas.
+- ''aggregationBuffer'': Objeto Buffer para agregação. (Ver [wiki:programmersguide/architecture/services/analysis/python/buffer Buffer]  )  
+- ''restriction'': String com a restrição SQL a ser aplicada.
+
+
+==== Exemplo de uso ====
+
+{{{
+buffer = Buffer()
+aggregationBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = occurrence.aggregation.standard_deviation("ocorrencias", buffer, "1d", "Intensidade", Statistic.standard_deviation, aggregationBuffer, "UF = 'AM'")
+}}}
+
+
+----