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
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 445 446 447 448 449 450 451 452 453 454 455 456 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 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
__init__(nominal, unidade, incerteza=0)
__init__(nominal: float, unidade: str, incerteza: float = 0)
__init__(nominal: Iterable[float], unidade: str, incerteza: float = 0)
Inicializa uma instância da classe com valores nominais, unidade e incerteza.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
nominal
|
float | Iterable[float]
|
Valor nominal ou uma coleção de |
required |
unidade
|
str
|
Unidade de medida. |
required |
incerteza
|
float
|
Incerteza associada ao valor nominal. |
0
|
Raises:
| Type | Description |
|---|---|
ValueError
|
Se a incerteza for negativa. |
ValueError
|
Se a sequência de medidas tiver menos de 2 elementos. |
Source code in LabIFSC2/_medida.py
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 | |
fmt(unidade=None, expoente=None, latex=False, separador_decimal=',')
Formata a medida para uma string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
unidade
|
str | None
|
Unidade usada no resultado. Por padrão, mantém a unidade da
medida. O valor |
None
|
expoente
|
int | None
|
Expoente da potência usada para escalar o valor. Quando omitido, valores maiores ou iguais a 10 são normalizados. |
None
|
separador_decimal
|
Literal['.', ',']
|
Caractere usado como separador decimal. |
','
|
latex
|
bool
|
Indica se o resultado deve usar sintaxe LaTeX. |
False
|
Returns:
| Type | Description |
|---|---|
str
|
Medida formatada para exibição. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se o separador decimal for inválido. |
Source code in LabIFSC2/_medida.py
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 | |
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. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
O valor da incerteza da medida na unidade especificada. |
Source code in LabIFSC2/_medida.py
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | |
intervalo_de_confiança(p, unidade)
Calcula o intervalo de confiança para a medida.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
p
|
float
|
Probabilidade associada ao intervalo de confiança (0,1) |
required |
unidade
|
str
|
Unidade de medida para o intervalo de confiança. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
tuple |
tuple[float, float]
|
Tupla [limite-inferior, limite-superior]. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se |
Source code in LabIFSC2/_medida.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
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. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
float |
float
|
O valor nominal da medida na unidade especificada. |
Source code in LabIFSC2/_medida.py
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | |
probabilidade_de_estar_entre(a, b, unidade)
Calcula a probabilidade de uma medida estar entre dois valores especificados.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
a
|
float
|
O valor inferior do intervalo. |
required |
b
|
float
|
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 |
Source code in LabIFSC2/_medida.py
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 | |
alterar_monte_carlo_rng(novo_gerador)
Altera o gerador aleatório usado nas simulações de Monte Carlo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
novo_gerador
|
Generator
|
Gerador aleatório usado nas próximas simulações. |
required |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se o valor não for um |
Source code in LabIFSC2/_medida.py
28 29 30 31 32 33 34 35 36 37 38 39 40 | |
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 |
2
|
sigma_superior
|
(float, opcional)
|
O fator sigma superior para |
3
|
Returns:
| Name | Type | Description |
|---|---|---|
Comparacao |
Comparacao
|
O resultado da comparação, que pode ser |
Comparacao
|
EQUIVALENTES, DIFERENTES ou INCONCLUSIVO. |
Raises:
| Type | Description |
|---|---|
ValueError
|
Se o sigma_inferior for maior que o sigma_superior. |
Source code in LabIFSC2/_medida.py
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 | |
arrayM(valores, unidade, incerteza)
Cria um array de objetos Medida a partir de valores nominais, unidade e incerteza.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
valores
|
Iterable[float]
|
Um iterável de valores nominais. |
required |
unidade
|
str
|
A unidade de medida. |
required |
incerteza
|
float
|
A incerteza associada aos valores nominais. |
required |
Returns:
| Type | Description |
|---|---|
NDArray[object_]
|
NDArray[np.object_]: Um array de objetos Medida. |
Source code in LabIFSC2/_arrays.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | |
curva_max(medidas, unidade_y, sigmas=2)
Calcula a curva máxima de uma série de medidas.
Para usar com um ajuste, passe o resultado de ajuste(x_array) como argumento.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
medidas
|
Iterable[Medida]
|
Iterável de objetos Medida. |
required |
unidade_y
|
str
|
Unidade da variável dependente. |
required |
sigmas
|
float
|
Número de sigmas para a curva máxima. |
2
|
Returns:
| Type | Description |
|---|---|
NDArray[float64]
|
NDArray[np.float64]: Array de valores da curva máxima. |
Source code in LabIFSC2/_arrays.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | |
curva_min(medidas, unidade_y, sigmas=2)
Calcula a curva mínima de uma série de medidas.
Para usar com um ajuste, passe o resultado de ajuste(x_array) como argumento.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
medidas
|
Iterable[Medida]
|
Iterável de objetos Medida. |
required |
unidade_y
|
str
|
Unidade da variável dependente. |
required |
sigmas
|
float
|
Número de sigmas para a curva mínima. |
2
|
Returns:
| Type | Description |
|---|---|
NDArray[float64]
|
NDArray[np.float64]: Array de valores da curva mínima. |
Source code in LabIFSC2/_arrays.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | |
incertezas(medidas, unidade)
Converte um iterável de objetos Medida para um array de incertezas em uma unidade especificada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
medidas
|
Iterable[Medida]
|
Iterável de objetos Medida. |
required |
unidade
|
str
|
Unidade para a conversão das incertezas. Use 'si' |
required |
Returns:
| Type | Description |
|---|---|
NDArray[float64]
|
NDArray[np.float64]: Array de incertezas convertidas para a unidade escolhida. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se algum dos valores 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 58 | |
linspaceM(a, b, n, unidade, incertezas)
Gera um array de Medidas com valores igualmente espaçados, seguindo as convenções da função np.linpsace do NumPy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
a
|
float
|
O valor inicial do intervalo. |
required |
b
|
float
|
O valor final do intervalo. |
required |
n
|
int
|
O número de elementos no array. |
required |
unidade
|
str
|
A unidade das medidas. |
required |
incertezas
|
float
|
A incerteza associada a cada medida. |
required |
Returns:
| Type | Description |
|---|---|
NDArray[object_]
|
NDArray[np.object_]: Um array de objetos Medida com valores igualmente espaçados |
Source code in LabIFSC2/_arrays.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | |
nominais(medidas, unidade)
Converte um iterável de objetos Medida para um array de valores nominais em uma unidade especificada.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
medidas
|
Iterable[Medida]
|
Iterável de objetos Medida. |
required |
unidade
|
str
|
Unidade para a conversão dos valores nominais. Use 'si' |
required |
Returns:
| Type | Description |
|---|---|
NDArray[float64]
|
NDArray[np.float64]: Array de valores nominais convertidos |
NDArray[float64]
|
para a unidade especificada. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se algum dos valores não for um objeto Medida. |
Source code in LabIFSC2/_arrays.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | |
AjustePolinomial
Resultado de um ajuste polinomial genérico da forma: y = coef[0] + coef[1]x + coef[2]x^2 + ... + coef[n]*x^n
Source code in LabIFSC2/_regressoes.py
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 | |
regressao_exponencial(x_medidas, y_medidas, base=np.e)
Realiza uma regressão exponencial nos dados fornecidos.
Ajusta uma curva da forma y = amplitude * base^(expoente * x). A linearização é feita via log_base(y) = log_base(amplitude) + expoente * x.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
Iterable[Medida]
|
Coleção de medidas da variável independente. |
required |
y_medidas
|
Iterable[Medida]
|
Coleção de medidas da variável |
required |
base
|
(float, opcional)
|
Base da exponencial usada, o padrão é |
e
|
Returns:
| Name | Type | Description |
|---|---|---|
AjusteExponencial |
AjusteExponencial
|
Objeto contendo amplitude e |
AjusteExponencial
|
expoente da regressão exponencial. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se x_medidas ou y_medidas não forem coleções de Medida. |
ValueError
|
Se base < 1. |
ValueError
|
Se y_medidas contiver valores não-positivos. |
ValueError
|
Se x_medidas e y_medidas não tiverem o mesmo tamanho. |
Source code in LabIFSC2/_regressoes.py
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 | |
regressao_linear(x_medidas, y_medidas)
Calcula a regressão linear para um conjunto de medidas.
Ajusta uma reta da forma y = a*x + b.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
Iterable[Medida]
|
Coleção contendo as medidas da |
required |
y_medidas
|
Iterable[Medida]
|
Coleção contendo as medidas da |
required |
Returns:
| Name | Type | Description |
|---|---|---|
AjustePolinomial |
AjustePolinomial
|
Objeto representando a reta de regressão linear |
AjustePolinomial
|
ajustada aos dados. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se x_medidas ou y_medidas não forem coleções de Medida. |
ValueError
|
Se x_medidas e y_medidas não tiverem o mesmo tamanho. |
Source code in LabIFSC2/_regressoes.py
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 | |
regressao_polinomial(x_medidas, y_medidas, grau)
Realiza uma regressão polinomial nos dados fornecidos.
A regressão ajusta um polinômio de grau grau da forma:
y = coef[0] + coef[1]x + ... + coef[grau]x^grau
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
Iterable[Medida]
|
Coleção de medidas para a variável independente. |
required |
y_medidas
|
Iterable[Medida]
|
Coleção de medidas para a variável dependente. |
required |
grau
|
int
|
Grau do polinômio a ser ajustado. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
AjustePolinomial |
AjustePolinomial
|
Objeto representando o polinômio |
AjustePolinomial
|
ajustado com coeficientes como Medidas. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se x_medidas ou y_medidas não forem coleções de Medida. |
ValueError
|
Se x_medidas e y_medidas não tiverem o mesmo tamanho. |
ValueError
|
Se não houver dados suficientes (overfitting). |
Source code in LabIFSC2/_regressoes.py
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 | |
regressao_potencia(x_medidas, y_medidas, x0=None)
Realiza uma regressão de lei de potência nos dados fornecidos.
Ajusta uma curva da forma y = amplitude * (x / x0)^potencia. A linearização é feita via log(y) = log(amplitude) + potencia * log(x/x0).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_medidas
|
Iterable[Medida]
|
Coleção de medidas da variável |
required |
y_medidas
|
Iterable[Medida]
|
Coleção de medidas da variável |
required |
x0
|
(Medida, opcional)
|
Escala de referência para x. Se None, |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
AjusteLeiDePotencia |
AjusteLeiDePotencia
|
Objeto contendo amplitude, potência |
AjusteLeiDePotencia
|
e a escala x0 da regressão. |
Raises:
| Type | Description |
|---|---|
TypeError
|
Se x_medidas ou y_medidas não forem coleções de Medida. |
ValueError
|
Se x_medidas ou y_medidas contiverem valores não-positivos. |
ValueError
|
Se x_medidas e y_medidas não tiverem o mesmo tamanho. |
Source code in LabIFSC2/_regressoes.py
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 | |