API Completa
Aqui nós temos todas as docstrings de todos os métodos e classes que o usuário da biblioteca encontrará, somente classes e métodos internos não estão aqui documentados.
Eu só recomendo dar uma olhada nisso aquelas pessoas que estão já muito acostumados com a biblioteca e querem encontrar algum detalhe que não está tão bem explicado na documentação, caso contrário, por favor leia a seção introdução
Medida
Source code in LabIFSC2/_medida.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | |
__init__(nominal, unidade, incerteza)
Inicializa uma instância da classe com valores nominais, unidade e incerteza.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
nominal
|
Real | list
|
Valor nominal ou uma lista de valores nominais. |
required |
unidade
|
str
|
Unidade de medida. |
required |
incerteza
|
Real
|
Incerteza associada ao valor nominal. |
required |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se a incerteza for negativa. |
ValueError
|
Se a lista de medidas tiver menos de 2 elementos. |
Source code in LabIFSC2/_medida.py
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | |
incerteza(unidade)
Retorna a incerteza da medida na unidade especificada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
unidade
|
str
|
A unidade na qual a incerteza deve ser retornado. Se 'si', retorna o valor em unidades do Sistema Internacional (SI). |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
O valor da incerteza da medida na unidade especificada. |
Source code in LabIFSC2/_medida.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | |
intervalo_de_confiança(p, unidade)
Calcula o intervalo de confiança para a medida.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
p
|
Real
|
Probabilidade associada ao intervalo de confiança. Deve estar entre 0 e 1. |
required |
unidade
|
str
|
Unidade de medida para o intervalo de confiança. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
list |
list
|
Lista contendo os limites inferior e superior do intervalo de confiança. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se |
Source code in LabIFSC2/_medida.py
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | |
nominal(unidade)
Retorna o valor nominal da medida na unidade especificada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
unidade
|
str
|
A unidade na qual o valor nominal deve ser retornado. Se 'si', retorna o valor em unidades do Sistema Internacional (SI). |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
O valor nominal da medida na unidade especificada. |
Source code in LabIFSC2/_medida.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | |
probabilidade_de_estar_entre(a, b, unidade)
Calcula a probabilidade de uma medida estar entre dois valores especificados.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
a
|
Real
|
O valor inferior do intervalo. |
required |
b
|
Real
|
O valor superior do intervalo. |
required |
unidade
|
str
|
A unidade de medida dos valores a e b. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
A probabilidade de a medida estar entre os valores a e b. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se o valor de |
ValueError
|
Se a unidade fornecida não for compatível com a unidade da medida. |
Source code in LabIFSC2/_medida.py
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 | |
comparar_medidas(medida1, medida2, sigma_inferior=2, sigma_superior=3)
Compara duas medidas considerando suas incertezas e retorna o resultado da comparação.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
medida1
|
Medida
|
A primeira medida a ser comparada. |
required |
medida2
|
Medida
|
A segunda medida a ser comparada. |
required |
sigma_inferior
|
(float, opcional)
|
O fator sigma inferior para considerar as medidas equivalentes. Default é 2. |
2
|
sigma_superior
|
(float, opcional)
|
O fator sigma superior para considerar as medidas diferentes. Default é 3. |
3
|
Returns:
| Name | Type | Description |
|---|---|---|
Comparacao |
Comparacao
|
O resultado da comparação, que pode ser EQUIVALENTES, DIFERENTES ou INCONCLUSIVO. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se o sigma_inferior for maior que o sigma_superior. |
Source code in LabIFSC2/_medida.py
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | |
arrayM(nominais, unidade, incerteza)
Cria um array de objetos Medida a partir de valores nominais, unidade e incerteza.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
nominais
|
ndarray | Sequence
|
Uma sequência de valores nominais. |
required |
unidade
|
str
|
A unidade de medida. |
required |
incerteza
|
Real
|
A incerteza associada aos valores nominais. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
np.ndarray: Um array de objetos Medida. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se os valores do array não forem números reais. |
Source code in LabIFSC2/_arrays.py
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | |
curva_max(arrayMedidas, unidade_y, sigmas=2)
Calcula a curva máxima de uma série de medidas.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrayMedidas
|
ndarray | Regressao
|
Array de objetos Medida ou objeto Regressao. |
required |
unidade_y
|
str
|
Unidade da variável dependente. |
required |
sigmas
|
float | int
|
Número de sigmas para a curva máxima. |
2
|
Returns:
| Type | Description |
|---|---|
ndarray
|
np.ndarray: Array de valores da curva máxima. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se algum dos valores no array não for um objeto Medida. |
Source code in LabIFSC2/_arrays.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | |
curva_min(arrayMedidas, unidade_y, sigmas=2)
Calcula a curva mínima de uma série de medidas.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrayMedidas
|
ndarray | Regressao
|
Array de objetos Medida ou objeto Regressao. |
required |
unidade_y
|
str
|
Unidade da variável dependente. |
required |
sigmas
|
float | int
|
Número de sigmas para a curva mínima. |
2
|
Returns:
| Type | Description |
|---|---|
ndarray
|
np.ndarray: Array de valores da curva mínima. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se algum dos valores no array não for um objeto Medida. |
Source code in LabIFSC2/_arrays.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | |
incertezas(arrayMedidas, unidade)
Converte um array de objetos Medida para um array de incertezas em uma unidade especificada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrayMedidas
|
ndarray
|
Array de objetos Medida. |
required |
unidade
|
str
|
Unidade para a conversão das incertezas. Use 'si' para unidades do Sistema Internacional. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
np.ndarray: Array de incertezas convertidas para a unidade especificada. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se algum dos valores no array não for um objeto Medida. |
Source code in LabIFSC2/_arrays.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | |
linspaceM(a, b, n, unidade, incertezas)
Gera um array de Medidas com valores igualmente espaçados.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
a
|
Real
|
O valor inicial do intervalo. |
required |
b
|
Real
|
O valor final do intervalo. |
required |
n
|
int
|
O número de elementos no array. |
required |
unidade
|
str
|
A unidade das medidas. |
required |
incertezas
|
Real
|
A incerteza associada a cada medida. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
np.ndarray: Um array de objetos Medida com valores igualmente espaçados. |
Source code in LabIFSC2/_arrays.py
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | |
nominais(arrayMedidas, unidade)
Converte um array de objetos Medida para um array de valores nominais em uma unidade especificada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrayMedidas
|
ndarray
|
Array de objetos Medida. |
required |
unidade
|
str
|
Unidade para a conversão dos valores nominais. Use 'si' para unidades do Sistema Internacional. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
np.ndarray: Array de valores nominais convertidos para a unidade especificada. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se algum dos valores no array não for um objeto Medida. |
Source code in LabIFSC2/_arrays.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | |
MExponencial
Bases: Regressao
Classe para modelar uma função exponencial y = a * base^(kx)
Source code in LabIFSC2/_regressoes.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | |
amostrar(x, unidade_y)
Gera uma amostra de valores exponenciais com base nos parâmetros fornecidos.
Args:
x (np.ndarray): Um array de valores de entrada.
unidade_y (str): A unidade dos valores de saída.
Returns:
np.ndarray: Um array de valores calculados com base na função exponencial.
Raises:
TypeError: Se o tipo de x não for np.ndarray.
Source code in LabIFSC2/_regressoes.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | |
MLeiDePotencia
Bases: Regressao
Source code in LabIFSC2/_regressoes.py
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | |
amostrar(x, unidade_y)
Amostra valores baseados na lei de potência. Args: x (np.ndarray): Array de valores de entrada. unidade_y (str): Unidade da variável dependente y. Returns: np.ndarray: Array de valores amostrados com a unidade especificada. Raises: ValueError: Se a unidade de x não for compatível com a unidade esperada.
Source code in LabIFSC2/_regressoes.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | |
MPolinomio
Bases: Regressao
Source code in LabIFSC2/_regressoes.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
amostrar(x, unidade_y)
Calcula os valores de um polinômio para um conjunto de entradas x.
Args:
x (np.ndarray): Um array de valores nos quais o polinômio será avaliado.
unidade_y (str): A unidade de medida para os valores calculados do polinômio.
Returns:
np.ndarray: Um array contendo os valores calculados do polinômio nas unidades especificadas.
Raises:
TypeError: Se o tipo de x não for np.ndarray.
Source code in LabIFSC2/_regressoes.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | |
regressao_exponencial(x_medidas, y_medidas, base=np.exp(1))
y=ae^{kx} Realiza uma regressão exponencial nos dados fornecidos.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
ndarray
|
Array de medidas da variável independente. |
required |
y_medidas
|
ndarray
|
Array de medidas da variável dependente. |
required |
base
|
(Real, opcional)
|
Base da exponencial usada, o padrão é o número de Euler (e). |
exp(1)
|
Raises:
| Type | Description |
|---|---|
ValueError
|
Se a base for menor que 1. |
ValueError
|
Se y_medidas contiver valores negativos ou zero. |
ValueError
|
Se |
Returns:
| Name | Type | Description |
|---|---|---|
MExponencial |
MExponencial
|
Objeto contendo os parâmetros |
Source code in LabIFSC2/_regressoes.py
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | |
regressao_linear(x_medidas, y_medidas)
Calcula a regressão linear para um conjunto de medidas.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
ndarray
|
Array contendo as medidas da variável independente. |
required |
y_medidas
|
ndarray
|
Array contendo as medidas da variável dependente. |
required |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se |
Returns:
| Name | Type | Description |
|---|---|---|
MPolinomio |
MPolinomio
|
Objeto representando a reta de regressão linear ajustada aos dados. |
Source code in LabIFSC2/_regressoes.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | |
regressao_polinomial(x_medidas, y_medidas, grau)
Realiza uma regressão polinomial nos dados fornecidos.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
ndarray
|
Array de medidas para a variável independente. |
required |
y_medidas
|
ndarray
|
Array de medidas para a variável dependente. |
required |
grau
|
int
|
Grau do polinômio a ser ajustado. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
MPolinomio |
MPolinomio
|
Um objeto representando o polinômio ajustado com coeficientes como medidas. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se |
TypeError
|
Se |
Source code in LabIFSC2/_regressoes.py
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | |
regressao_potencia(x_medidas, y_medidas)
y=a*x^n
Realiza uma regressão de potência nos dados fornecidos. Esta função aplica uma transformação logarítmica aos dados de entrada, realiza uma regressão linear nos dados transformados, e então converte os coeficientes da regressão linear de volta para a forma original, resultando em uma lei de potência.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
ndarray
|
Array de medidas da variável independente. |
required |
y_medidas
|
ndarray
|
Array de medidas da variável dependente. |
required |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se x_medidas contiver valores negativos ou zero. |
ValueError
|
Se y_medidas contiver valores negativos ou zero. |
ValueError
|
Se |
Returns:
| Name | Type | Description |
|---|---|---|
MLeiDePotencia |
MLeiDePotencia
|
Objeto contendo os coeficientes da lei de potência ajustada. |
Source code in LabIFSC2/_regressoes.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | |