admin.py
This module contains the admin classes that are registered with the Django Admin site.
Association
¶
Bases: Model
model association between sources and measurements based on some parameters
Source code in vast_pipeline/models.py
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 |
|
Band
¶
Bases: Model
A band on the frequency spectrum used for imaging. Each image is associated with one band.
Source code in vast_pipeline/models.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
|
Comment
¶
Bases: Model
The model object for a comment.
Source code in vast_pipeline/models.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
|
get_avatar_url()
¶
Get the URL for the user's avatar from GitHub. If the user has no associated GitHub account (e.g. a Django superuser), return the URL to the default user avatar.
Returns:
Type | Description |
---|---|
str | The avatar URL. |
Source code in vast_pipeline/models.py
41 42 43 44 45 46 47 48 49 50 51 52 53 |
|
CommentableModel
¶
Bases: Model
A class to provide a commentable model.
Source code in vast_pipeline/models.py
56 57 58 59 60 61 62 63 64 65 66 67 68 |
|
Image
¶
Bases: CommentableModel
An image is a 2D radio image from a cube
Source code in vast_pipeline/models.py
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 |
|
ImageAdmin
¶
Bases: ModelAdmin
The ImageAdmin class.
Source code in vast_pipeline/admin.py
29 30 31 32 33 34 35 |
|
Measurement
¶
Bases: CommentableModel
A Measurement is an object in the sky that has been detected at least once. Essentially a source single measurement in time.
Source code in vast_pipeline/models.py
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 567 568 569 570 571 572 573 574 |
|
MeasurementAdmin
¶
Bases: ModelAdmin
The MeasurementAdmin class.
Source code in vast_pipeline/admin.py
63 64 65 66 67 68 69 |
|
MeasurementQuerySet
¶
Bases: QuerySet
Source code in vast_pipeline/models.py
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 |
|
cone_search(ra, dec, radius_deg)
¶
Return all the Sources withing radius_deg of (ra,dec). Returns a QuerySet of Sources, ordered by distance from (ra,dec) ascending.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ra | float | The right ascension value of the cone search central coordinate. | required |
dec | float | The declination value of the cone search central coordinate. | required |
radius_deg | float | The radius over which to perform the cone search. | required |
Returns:
Type | Description |
---|---|
QuerySet | Measurements found withing the cone search area. |
Source code in vast_pipeline/models.py
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 |
|
PipelineConfig
¶
Pipeline run configuration.
Attributes:
Name | Type | Description |
---|---|---|
SCHEMA | class attribute containing the YAML schema for the run config. | |
TEMPLATE_PATH | str | class attribute containing the path to the default Jinja2 run config template file. |
epoch_based | bool | boolean indicating if the original run config inputs were provided with user-defined epochs. |
Raises:
Type | Description |
---|---|
PipelineConfigError | the input YAML config violates the schema. |
Source code in vast_pipeline/pipeline/config.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 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 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 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
|
__getitem__(name)
¶
Retrieves the requested YAML chunk as a native Python object.
Source code in vast_pipeline/pipeline/config.py
216 217 218 |
|
__init__(config_yaml, validate_inputs=True)
¶
Initialises PipelineConfig with parsed (but not necessarily validated) YAML.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config_yaml | YAML | Input YAML, usually the output of | required |
validate_inputs | bool | Validate the config input files. Ensures that the inputs match (e.g. each image has a catalogue), and that each path exists. Set to False to skip these checks. Defaults to True. | True |
Raises:
Type | Description |
---|---|
PipelineConfigError | The input YAML config violates the schema. |
Source code in vast_pipeline/pipeline/config.py
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 |
|
check_prev_config_diff()
¶
Checks if the previous config file differs from the current config file. Used in add mode. Only returns true if the images are different and the other general settings are the same (the requirement for add mode). Otherwise False is returned.
Returns:
Type | Description |
---|---|
bool |
|
Source code in vast_pipeline/pipeline/config.py
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 |
|
from_file(yaml_path, label='run config', validate=True, validate_inputs=True, add_defaults=True)
classmethod
¶
Create a PipelineConfig object from a run configuration YAML file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
yaml_path | str | Path to the run config YAML file. | required |
label | str | A label for the config object that will be used in error messages. Default is "run config". | 'run config' |
validate | bool | Perform config schema validation immediately after loading the config file. If set to False, the full schema validation will not be performed until PipelineConfig.validate() is explicitly called. The inputs are always validated regardless. Defaults to True. | True |
validate_inputs | bool | Validate the config input files. Ensures that the inputs match (e.g. each image has a catalogue), and that each path exists. Set to False to skip these checks. Defaults to True. | True |
add_defaults | bool | Add missing configuration parameters using configured defaults. The defaults are read from the Django settings file. Defaults to True. | True |
Raises:
Type | Description |
---|---|
PipelineConfigError | The run config YAML file fails schema validation. |
Source code in vast_pipeline/pipeline/config.py
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 |
|
image_opts()
¶
Get the config options required for image ingestion only. Namely: - selavy_local_rms_fill_value - condon_errors - ra_uncertainty - dec_uncertainty
Returns:
Type | Description |
---|---|
Dict[str, Any] | The relevant key value pairs |
Source code in vast_pipeline/pipeline/config.py
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
|
validate(user=None)
¶
Perform extra validation steps not covered by the default schema validation. The following checks are performed in order. If a check fails, an exception is raised and no further checks are performed.
- All input files have the same number of epochs and the same number of files per epoch.
- The number of input files does not exceed the configured pipeline maximum. This is only enforced if a regular user (not staff/admin) created the run.
- There are at least two input images.
- Background input images are required if source monitoring is turned on.
- All input files exist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user | User | Optional. The User of the request if made through the UI. Defaults to None. | None |
Raises:
Type | Description |
---|---|
PipelineConfigError | a validation check failed. |
Source code in vast_pipeline/pipeline/config.py
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 |
|
RelatedSource
¶
Bases: Model
Association table for the many to many Source relationship with itself Django doc https://docs.djangoproject.com/en/3.1/ref/models/fields/#django.db.models.ManyToManyField.through
Source code in vast_pipeline/models.py
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 |
|
Run
¶
Bases: CommentableModel
A Run is essentially a pipeline run/processing istance over a set of images
Source code in vast_pipeline/models.py
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 |
|
get_config(validate=True, validate_inputs=True, prev=False)
¶
Read, parse, and optionally validate the run configuration file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
validate | bool | Validate the run configuration. Defaults to False. | True |
validate_inputs | bool | Validate the config input files. Ensures that the inputs match (e.g. each image has a catalogue), and that each path exists. Set to False to skip these checks. Defaults to True. | True |
prev | bool | Get the previous config file instead of the current config. The previous config is the one used for the last successfully completed run. The current config may have been modified since the run was executed. | False |
Returns:
Name | Type | Description |
---|---|---|
PipelineConfig | PipelineConfig | The run configuration object. |
Source code in vast_pipeline/models.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 |
|
RunAdmin
¶
Bases: ModelAdmin
The RunAdmin class.
Source code in vast_pipeline/admin.py
18 19 20 21 22 23 24 |
|
RunQuerySet
¶
Bases: QuerySet
Source code in vast_pipeline/models.py
71 72 73 74 75 76 77 78 79 80 81 82 83 |
|
check_max_runs(max_runs=5)
¶
Check if number of running pipeline runs is above threshold.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_runs | int | The maximum number of processing runs allowed. | 5 |
Returns:
Type | Description |
---|---|
int | The count of the current pipeline runs with a status of |
Source code in vast_pipeline/models.py
73 74 75 76 77 78 79 80 81 82 83 |
|
SkyRegionAdmin
¶
Bases: ModelAdmin
The SkyRegionAdmin class.
Source code in vast_pipeline/admin.py
43 44 45 46 47 |
|
Source
¶
Bases: CommentableModel
Source code in vast_pipeline/models.py
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 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 |
|
get_measurement_pairs()
¶
Calculate the measurement pair metrics for the source. If the run config set variability.pair_metrics to false, then no pairs are calculated and an empty list is returned.
Returns:
Type | Description |
---|---|
List[MeasurementPair] | List[MeasurementPair]: The list of measurement pairs and their metrics. |
Source code in vast_pipeline/models.py
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 |
|
SourceAdmin
¶
Bases: ModelAdmin
The SourceAdmin class.
Source code in vast_pipeline/admin.py
52 53 54 55 56 57 58 |
|
SourceFavAdmin
¶
Bases: ModelAdmin
The SourceFavAdmin class.
Source code in vast_pipeline/admin.py
74 75 76 77 78 79 80 |
|
SourceQuerySet
¶
Bases: QuerySet
Source code in vast_pipeline/models.py
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 |
|
cone_search(ra, dec, radius_deg)
¶
Return all the Sources withing radius_deg of (ra,dec). Returns a QuerySet of Sources, ordered by distance from (ra,dec) ascending.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ra | float | The right ascension value of the cone search central coordinate. | required |
dec | float | The declination value of the cone search central coordinate. | required |
radius_deg | float | The radius over which to perform the cone search. | required |
Returns:
Type | Description |
---|---|
QuerySet | Sources found withing the cone search area. |
Source code in vast_pipeline/models.py
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 |
|
calculate_m_metric(flux_a, flux_b)
¶
Calculate the m variability metric which is the modulation index between two fluxes. This is proportional to the fractional variability. See Section 5 of Mooley et al. (2016) for details, DOI: 10.3847/0004-637X/818/2/105.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
flux_a | float | flux value "A". | required |
flux_b | float | flux value "B". | required |
Returns:
Name | Type | Description |
---|---|---|
float | float | the m metric for flux values "A" and "B". |
Source code in vast_pipeline/pipeline/pairs.py
33 34 35 36 37 38 39 40 41 42 43 44 45 |
|
calculate_vs_metric(flux_a, flux_b, flux_err_a, flux_err_b)
¶
Calculate the Vs variability metric which is the t-statistic that the provided fluxes are variable. See Section 5 of Mooley et al. (2016) for details, DOI: 10.3847/0004-637X/818/2/105.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
flux_a | float | flux value "A". | required |
flux_b | float | flux value "B". | required |
flux_err_a | float | error of | required |
flux_err_b | float | error of | required |
Returns:
Name | Type | Description |
---|---|---|
float | float | the Vs metric for flux values "A" and "B". |
Source code in vast_pipeline/pipeline/pairs.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|