Changes between Version 2 and Version 3 of programmersguide/architecture/services/analysis/python/operadorPCD

Timestamp:

06/02/16 11:28:38 (10 years ago)

Author:

paulo.morais

Comment:

--

programmersguide/architecture/services/analysis/python/operadorPCD

@@ +1 @@
+
 = Operadores de PCDs =
+
+Conjunto de operadores para série de dados do tipo '''PCD'''
+
+== Contagem ==
+
+Retorna o número de PCDs que influenciam o objeto monitorado.
+
+==== Assinatura ====
+
+{{{
+terrama2.dcp.count("dataSeriesName", buffer, "dateFilter", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.count("Serra do Mar", buffer, "1d")
+}}}
+
+----
+
+
+== 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", buffer, "dateFilter", "attribute", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.min("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----
+
+== 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", buffer, "dateFilter", "attribute",  [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.max("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----
+
+==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", buffer, "dateFilter", "attribute", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.mean("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----
+
+== 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", buffer, "dateFilter", "attribute", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.median("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----
+
+== 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", buffer, "dateFilter", "attribute", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.sum("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----
+
+
+== 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", buffer, "dateFilter", "attribute", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.median("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----
+
+== Desvio Padrão == 
+
+Retorna o desvio padrão 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.standard_deviation("dataSeriesName", buffer, "dateFilter", "attribute", [datasetIds])
+}}}
+
+
+==== Parâmetros ====
+
+- ''dataSeriesName'': String com o nome da série de dados de PCD.
+- ''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 a série de dados. Ex. "10h" para os dados das últimas 10 horas ou "2d" para os dados dos últimos dois dias.
+- ''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).
+- ''datasetIds'': Parâmetro opcional com o conjunto de identificadores dos DataSets que influenciam esta PCD. Se este parâmetro não for informado ou estiver vazio as PCDs utilizadas serão determinadas de acordo com a configuração da regra de influência da análise.
+
+
+==== Exemplo de uso ====
+
+{{{
+moBuffer = Buffer(BufferType.object_plus_buffer, 2., "km")
+x = dcp.standard_deviation("Serra do Mar", moBuffer, "1d", "Pluvio")
+}}}
+
+
+----