def __init__(self,simbolos_y,simbolos_x,simbolos_param,PA=0.95,projeto='Projeto',**kwargs):
u'''
Classe para executar a estimação de parâmetros de modelos MISO lineares nos parâmetros
======================
Bibliotecas requeridas
======================
* Numpy
* Scipy
* Matplotlib
* Math
* PSO - **Obtida no link http://github.com/ddss/PSO. Os códigos devem estar dentro de uma pasta de nome PSO**
=======================
Entradas (obrigatórias)
=======================
* ``simbolos_y`` (list) : lista com os simbolos das variáveis y (Não podem haver caracteres especiais)
* ``simbolos_x`` (list) : lista com os simbolos das variáveis x (Não podem haver caracteres especiais)
* ``simbolos_param`` (list) : lista com o simbolos dos parâmetros (Não podem haver caracteres especiais)
====================
Entradas (opcionais)
====================
* ``PA`` (float): probabilidade de abrangência da análise. Deve estar entre 0 e 1. Default: 0.95
* ``projeto`` (string): nome do projeto (Náo podem haver caracteres especiais)
**AVISO**:
* Para cálculo do coeficiente linear, basta que o número de parâmetros seja igual ao número de grandezas
independentes + 1.
==============================
Keywords (Entradas opcionais):
==============================
* ``nomes_x`` (list): lista com os nomes para x
* ``unidades_x`` (list): lista com as unidades para x (inclusive em formato LATEX)
* ``label_latex_x`` (list): lista com os símbolos das variáveis em formato LATEX
* ``nomes_y`` (list): lista com os nomes para y
* ``unidades_y`` (list): lista com as unidades para y (inclusive em formato LATEX)
* ``label_latex_y`` (list): lista com os símbolos das variáveis em formato LATEX
* ``nomes_param`` (list): lista com os nomes para os parâmetros (inclusive em formato LATEX)
* ``unidades_param`` (list): lista com as unidades para os parâmetros (inclusive em formato LATEX)
* ``label_latex_param`` (list): lista com os símbolos das variáveis em formato LATEX
* ``base_path`` (string): String que define o diretório pai que serão criados/salvos os arquivos gerados pelo motor de cálculo
=======
Métodos
=======
Para a realização da estimação de parâmetros de um certo modelo faz-se necessário executar \
alguns métodos, na ordem indicada:
**ESTIMAÇÂO DE PARÂMETROS**
* ``gerarEntradas`` : método para incluir dados obtidos de experimentos. Neste há a opção de determinar \
se estes dados serão utilizados como dados para estimar os parâmetros ou para validação. (Vide documentação do método)
* ``otimiza`` : método para realizar a otimização, com base nos dados fornecidos em gerarEntradas.
* ``incertezaParametros`` : método que avalia a incerteza dos parâmetros (Vide documentação do método)
* ``gerarEntradas`` : (é opcional para inclusão de dados de validação)
* ``Predicao`` : método que avalia a predição do modelo e sua incerteza ou utilizando os pontos experimentais ou de \
validação, se disponível (Vide documentação do método)
* ``analiseResiduos`` : método para executar a análise de resíduos (Vide documentação do método)
* ``graficos`` : método para criação dos gráficos (Vide documentação do método)
* ``_armazenarDicionario`` : método que returna as grandezas sob a forma de um dicionário (Vide documentação do método)
====================
Fluxo de trabalho
====================
Esta classe valida a correta ordem de execução dos métodos. É importante salientar que cada vez que o método ``gerarEntradas`` \
é utilizado, é criado um novo ``Fluxo de trabalho``, ou seja, o motor de cálculo valida de alguns métodos precisam ser reexecutados \
devido a entrada de novos dados.
**Observação 1**: Se forem adicionados diferentes dados de validação (execuções do método gerarEntradas para incluir tais dados), \
são iniciado novos fluxos, mas é mantido o histórico de toda execução.
**Observação 2**: Se forem adicionados novos dados experimentais, todo o histórico de fluxos é apagado e reniciado.
======
Saídas
======
As saídas deste motor de cálculo estão, principalmente, sob a forma de atributos e gráficos.
Os principais atributos de uma variável Estimacao, são:
* ``x`` : objeto Grandeza que contém todas as informações referentes às grandezas \
independentes sob a forma de atributos:
* ``experimental`` : referente aos dados experimentais. Principais atributos: ``matriz_estimativa``, ``matriz_covariancia``
* ``calculado`` : referente aos dados calculados pelo modelo. Principais atributos: ``matriz_estimativa``, ``matriz_covariancia``
* ``validacao`` : referente aos dados de validação. Principais atributos: ``matriz_estimativa``, ``matriz_covariancia``
* ``residuos`` : referente aos resíduos de regressão. Principais atributos: ``matriz_estimativa``, ``estatisticas``
* ``y`` : objeto Grandeza que contém todas as informações referentes às grandezas \
dependentes sob a forma de atributos. Os atributos são os mesmos de x.
* ``parametros`` : objeto Grandeza que contém todas as informações referentes aos parâmetros sob a forma de atributos.
* ``estimativa`` : estimativa para os parâmetros
* ``matriz_covariancia`` : matriz de covariância
* ``regiao_abrangencia`` : pontos contidos na região de abrangência
Obs.: Para informações mais detalhadas, consultar os Atributos da classe Grandeza.
'''
# ---------------------------------------------------------------------
# INICIANDO A CLASSE INIT
# ---------------------------------------------------------------------
EstimacaoNaoLinear.__init__(self,WLS,Modelo,simbolos_y,simbolos_x,simbolos_param,PA,projeto,**kwargs)
self._EstimacaoNaoLinear__flag.setCaracteristica(['calc_termo_independente'])
# ---------------------------------------------------------------------
# VALIDAÇÃO
# ---------------------------------------------------------------------
if self.y.NV != 1:
raise ValueError(u'Está apenas implementado estimação de parâmetros de modelos lineares MISO')
if (self.parametros.NV != self.x.NV) and (self.parametros.NV != self.x.NV+1):
raise ValueError(u'O número de parâmetros deve ser: igual ao de grandezas independentes (não é efetuado cálculo do coeficiente linear)'+\
'OU igual ao número de grandezas independentes + 1 (é calculado o coeficiente linear).')
# ---------------------------------------------------------------------
# Definindo se o b será calculado
# ---------------------------------------------------------------------
if (self.parametros.NV == self.x.NV+1):
self._EstimacaoNaoLinear__flag.ToggleActive('calc_termo_independente')
def __init__(self,symbols_y,symbols_x,symbols_param,PA=0.95,folder='Projeto',**kwargs):
u'''
Classe para executar a estimação de parâmetros de modelos MISO lineares nos parâmetros
======================
Bibliotecas requeridas
======================
* Numpy
* Scipy
* Matplotlib
* Math
* PSO - **Obtida no link http://github.com/ddss/PSO. Os códigos devem estar dentro de uma pasta de nome PSO**
=======================
Entradas (obrigatórias)
=======================
* ``symbols_y`` (list) : lista com os simbolos das variáveis y (Não podem haver caracteres especiais)
* ``symbols_x`` (list) : lista com os simbolos das variáveis x (Não podem haver caracteres especiais)
* ``symbols_param`` (list) : lista com o simbolos dos parâmetros (Não podem haver caracteres especiais)
====================
Entradas (opcionais)
====================
* ``PA`` (float): probabilidade de abrangência da análise. Deve estar entre 0 e 1. Default: 0.95
* ``folder`` (string): nome do projeto (Náo podem haver caracteres especiais)
**AVISO**:
* Para cálculo do coeficiente linear, basta que o número de parâmetros seja igual ao número de grandezas
independentes + 1.
==============================
Keywords (Entradas opcionais):
==============================
* ``names_x`` (list): lista com os nomes para x
* ``units_x`` (list): lista com as unidades para x (inclusive em formato LATEX)
* ``label_latex_x`` (list): lista com os símbolos das variáveis em formato LATEX
* ``names_y`` (list): lista com os nomes para y
* ``units_y`` (list): lista com as unidades para y (inclusive em formato LATEX)
* ``label_latex_y`` (list): lista com os símbolos das variáveis em formato LATEX
* ``names_param`` (list): lista com os nomes para os parâmetros (inclusive em formato LATEX)
* ``units_param`` (list): lista com as unidades para os parâmetros (inclusive em formato LATEX)
* ``label_latex_param`` (list): lista com os símbolos das variáveis em formato LATEX
* ``base_path`` (string): String que define o diretório pai que serão criados/salvos os arquivos gerados pelo motor de cálculo
=======
Métodos
=======
Para a realização da estimação de parâmetros de um certo modelo faz-se necessário executar \
alguns métodos, na ordem indicada:
**ESTIMAÇÂO DE PARÂMETROS**
* ``setConjunto`` : método para incluir dados obtidos de experimentos. Neste há a opção de determinar \
se estes dados serão utilizados como dados para estimar os parâmetros ou para validação. (Vide documentação do método)
* ``optimize`` : método para realizar a otimização, com base nos dados fornecidos em setConjunto.
* ``parametersUncertainty`` : método que avalia a incerteza dos parâmetros (Vide documentação do método)
* ``setConjunto`` : (é opcional para inclusão de dados de validação)
* ``Prediction`` : método que avalia a predição do modelo e sua incerteza ou utilizando os pontos experimentais ou de \
validação, se disponível (Vide documentação do método)
* ``residualAnalysis`` : método para executar a análise de resíduos (Vide documentação do método)
* ``plots`` : método para criação dos gráficos (Vide documentação do método)
* ``_armazenarDicionario`` : método que retorna as grandezas sob a forma de um dicionário (Vide documentação do método)
====================
Fluxo de trabalho
====================
Esta classe valida a correta ordem de execução dos métodos. É importante salientar que cada vez que o método ``setConjunto`` \
é utilizado, é criado um novo ``Fluxo de trabalho``, ou seja, o motor de cálculo valida de alguns métodos precisam ser reexecutados \
devido a entrada de novos dados.
**Observação 1**: Se forem adicionados diferentes dados de validação (execuções do método gerarEntradas para incluir tais dados), \
são iniciado novos fluxos, mas é mantido o histórico de toda execução.
**Observação 2**: Se forem adicionados novos dados experimentais, todo o histórico de fluxos é apagado e reniciado.
======
Saídas
======
As saídas deste motor de cálculo estão, principalmente, sob a forma de atributos e gráficos.
Os principais atributos de uma variável Estimacao, são:
* ``x`` : objeto Grandeza que contém todas as informações referentes às grandezas \
independentes sob a forma de atributos:
* ``estimação`` : referente aos dados experimentais. Principais atributos: ``matriz_estimativa``, ``matriz_covariancia``
* ``calculado`` : referente aos dados calculados pelo modelo. Principais atributos: ``matriz_estimativa``, ``matriz_covariancia``
* ``predição`` : referente aos dados de validação. Principais atributos: ``matriz_estimativa``, ``matriz_covariancia``
* ``residuos`` : referente aos resíduos de regressão. Principais atributos: ``matriz_estimativa``, ``estatisticas``
* ``y`` : objeto Grandeza que contém todas as informações referentes às grandezas \
dependentes sob a forma de atributos. Os atributos são os mesmos de x.
* ``parametros`` : objeto Grandeza que contém todas as informações referentes aos parâmetros sob a forma de atributos.
* ``estimativa`` : estimativa para os parâmetros
* ``matriz_covariancia`` : matriz de covariância
* ``regiao_abrangencia`` : pontos contidos na região de abrangência
Obs.: Para informações mais detalhadas, consultar os Atributos da classe Grandeza.
'''
# ---------------------------------------------------------------------
# INICIANDO A CLASSE INIT
# ---------------------------------------------------------------------
# For to start the class it's necessary to check wich is the most suitable model
if (len(symbols_param) == len(symbols_x) + 1):
# The the independent term will be calculated and Model_2 should be used
EstimacaoNaoLinear.__init__(self, Model_2, symbols_y, symbols_x, symbols_param, PA, folder, **kwargs)
else:
# The the independent term won't be calculated and Model_1 should be used
EstimacaoNaoLinear.__init__(self, Model_1, symbols_y, symbols_x, symbols_param, PA, folder, **kwargs)
self._EstimacaoNaoLinear__flag.ToggleActive('Linear') # Enable linear flag to correctly create 'self .__ values' when independent term calculation
self._EstimacaoNaoLinear__flag.setCaracteristica(['calc_termo_independente'])
# ---------------------------------------------------------------------
# VALIDAÇÃO
# ---------------------------------------------------------------------
if self.y.NV != 1:
raise ValueError(u'It is performing the parameter estimation of linear models only for the MISO case.')
if (self.parametros.NV != self.x.NV) and (self.parametros.NV != self.x.NV+1):
raise ValueError(u'The number of parameters must be equal to the number of independent quantities (the linear coefficient is not calculated).'+\
'OR equal to the number of independent quantities + 1 (the linear coefficient is calculated).')
self.__coluna_dumb = False # this variable indicates that a column of ones has been added to independent quantities
# ---------------------------------------------------------------------
# Definindo se o b será calculado
# ---------------------------------------------------------------------
if (self.parametros.NV == self.x.NV+1):
self._EstimacaoNaoLinear__flag.ToggleActive('calc_termo_independente')
self.__coluna_dumb = True