Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Pipeline (2026.1.1.34)
Pipeline (2026.1.1.34)

Basics

  • Pipeline Overview
  • Dependencies of Pipeline
  • Releases
  • PL2026 Timeline & Milestones
  • References

API Reference

  • Pipeline Tasks
    • pipeline.h.cli
      • h_init
      • h_resume
      • h_save
      • h_tsyscal
      • h_weblog
    • pipeline.hif.cli
      • hif_analyzealpha
      • hif_applycal
      • hif_checkproductsize
      • hif_correctedampflag
      • hif_editimlist
      • hif_findcont
      • hif_lowgainflag
      • hif_makecutoutimages
      • hif_makeimages
      • hif_makeimlist
      • hif_makermsimages
      • hif_mstransform
      • hif_rawflagchans
      • hif_refant
      • hif_selfcal
      • hif_setjy
      • hif_setmodels
      • hif_transformimagedata
      • hif_uvcontsub
    • pipeline.hifa.cli
      • hifa_antpos
      • hifa_bandpass
      • hifa_bandpassflag
      • hifa_bpsolint
      • hifa_diffgaincal
      • hifa_exportdata
      • hifa_flagdata
      • hifa_flagtargets
      • hifa_fluxcalflag
      • hifa_gaincalsnr
      • hifa_gfluxscale
      • hifa_gfluxscaleflag
      • hifa_imageprecheck
      • hifa_importdata
      • hifa_lock_refant
      • hifa_polcal
      • hifa_polcalflag
      • hifa_renorm
      • hifa_restoredata
      • hifa_session_refant
      • hifa_spwphaseup
      • hifa_targetflag
      • hifa_timegaincal
      • hifa_tsysflag
      • hifa_tsysflagcontamination
      • hifa_unlock_refant
      • hifa_wvrgcal
      • hifa_wvrgcalflag
    • pipeline.hifv.cli
      • hifv_analyzestokescubes
      • hifv_applycals
      • hifv_checkflag
      • hifv_circfeedpolcal
      • hifv_exportdata
      • hifv_exportvlassdata
      • hifv_finalcals
      • hifv_fixpointing
      • hifv_flagcal
      • hifv_flagdata
      • hifv_flagtargetsdata
      • hifv_fluxboot
      • hifv_hanning
      • hifv_importdata
      • hifv_mstransform
      • hifv_pbcor
      • hifv_plotsummary
      • hifv_priorcals
      • hifv_restoredata
      • hifv_restorepims
      • hifv_selfcal
      • hifv_semiFinalBPdcals
      • hifv_solint
      • hifv_statwt
      • hifv_syspower
      • hifv_testBPdcals
      • hifv_vlasetjy
      • hifv_vlassmasking
    • pipeline.hsd.cli
      • hsd_applycal
      • hsd_atmcor
      • hsd_baseline
      • hsd_blflag
      • hsd_exportdata
      • hsd_flagdata
      • hsd_imaging
      • hsd_importdata
      • hsd_k2jycal
      • hsd_restoredata
      • hsd_skycal
      • hsd_tsysflag
    • pipeline.hsdn.cli
      • hsdn_exportdata
      • hsdn_importdata
      • hsdn_restoredata
  • Interface
    • pipeline.runpipeline
    • pipeline.runvlapipeline
    • pipeline.infrastructure.executeppr
      • executeppr
      • export_on_exception
      • save_existing_context
    • pipeline.infrastructure.executevlappr
      • executeppr
    • pipeline.recipereducer
      • reduce
      • run_named_tasks
      • pipeline.recipereducer.TaskArgs
  • Internal API Reference
    • pipeline.domain
      • Antenna
      • AntennaArray
      • DataDescription
      • DataTable
      • DataType
      • Field
      • FluxMeasurement
      • MeasurementSet
      • ObservingRun
      • Polarization
      • Scan
      • Source
      • SpectralWindow
      • SpectralWindowWithChannelSelection
      • State
    • pipeline.infrastructure.vdp
      • InputsContainer
      • ModeInputs
      • StandardInputs
      • VisDependentProperty
    • pipeline.infrastructure.callibrary
      • ant_add
      • ant_sub
      • consolidate_calibrations
      • contiguous_sequences
      • copy_calapplication
      • create_data_reducer
      • create_interval_tree
      • create_interval_tree_for_ms
      • create_interval_tree_nd
      • data_selection_contains
      • defrag_interval_tree
      • expand_calstate
      • expand_calstate_to_calapps
      • expand_interval
      • expand_intervaltree
      • field_add
      • field_sub
      • fix_cycle0_data_selection
      • get_calstate_shape
      • get_calto_from_inputs
      • get_id_to_field_fn
      • get_id_to_intent_fn
      • get_intent_id_map
      • get_matching_calstate
      • get_min_max
      • intent_add
      • intent_sub
      • interval_to_set
      • merge_contiguous_intervals
      • merge_intervaltrees
      • merge_lists
      • ranges
      • safe_join
      • sequence_to_casa_range
      • sequence_to_range
      • set_calstate_marker
      • spw_add
      • spw_sub
      • trim
      • trim_nd
      • trim_to_valid_data_selection
      • unit
      • CalAppOrigin
      • CalApplication
      • CalFrom
      • CalLibrary
      • CalState
      • CalTo
      • CalToArgs
      • CalToIdAdapter
      • CalToIntervalAdapter
      • IntervalCalLibrary
      • IntervalCalState
      • TimestampedData
      • CYCLE_0_END_DATE
      • LOG
      • TYPE_CHECKING
      • annotations
      • tsd_accessor
    • pipeline.infrastructure.imagelibrary
      • ImageItem
      • ImageLibrary
      • ImageMetadata
      • LOG
    • pipeline.infrastructure.launcher
      • Context
      • Pipeline
      • DISCOURAGED_CASA_REVISION_RANGE
      • LOG
      • MAX_CASA_REVISION
      • MIN_CASA_REVISION
      • TYPE_CHECKING
      • annotations
      • current_task_name
    • pipeline.infrastructure.project
      • LoggingModificationListener
      • ModificationListener
      • ModificationPublisher
      • PerformanceParameters
      • ProjectStructure
      • ProjectSummary
    • pipeline.infrastructure.utils
      • absolute_path
      • ant_arg_to_id
      • antenna_names_from_caltable
      • approx_equal
      • are_equal
      • build_refantignore
      • calc_zd_pa
      • capture_output
      • chan_freq_from_caltable
      • chan_selection_to_frequencies
      • change_stream_for_all_streamhandlers
      • check_ppr
      • clear_time_cache
      • collect_properties
      • commafy
      • compute_zenith_distance
      • contains_single_dish
      • convert_paths_to_basenames
      • deduplicate
      • dequote
      • dict_merge
      • do_wide_field_pos_cor
      • enable_fd_logs
      • enable_memstats
      • ensure_products_dir_exists
      • equal_to_n_digits
      • exec_func
      • export_weblog_as_tar
      • field_arg_to_id
      • fieldname_clean
      • fieldname_for_casa
      • filter_intents_for_ms
      • find_ranges
      • flagged_intervals
      • flatten
      • flatten_dict
      • format_datetime
      • format_timedelta
      • freq_selection_to_channels
      • frequency_to_velocity
      • from_mjd_to_datetime
      • gen_hash
      • get_ant_ids_from_caltable
      • get_calfroms
      • get_casa_quantity
      • get_casa_session_details
      • get_directory_size
      • get_epoch_as_datetime
      • get_field_identifiers
      • get_file_md5
      • get_filename_info
      • get_intervals
      • get_iso_mtime
      • get_logrecords
      • get_num_caltable_polarizations
      • get_obj_size
      • get_object_info_string
      • get_origin_input_arg
      • get_products_dir
      • get_qascores
      • get_receiver_type_for_spws
      • get_row_count
      • get_si_prefix
      • get_solar_system_model_files
      • get_spectralspec_to_spwid_map
      • get_stats
      • get_stokes
      • get_task_result_count
      • get_taskhistory_fromimage
      • get_tracebacks
      • get_valid_url
      • get_vis_from_plots
      • get_vlass_image_type
      • glob_ordered
      • human_file_size
      • ignore_pointing
      • imstat_items
      • intersect_ranges
      • intersect_ranges_by_weight
      • invert_dict
      • is_top_level_task
      • list_to_str
      • merge_jobs
      • merge_ranges
      • merge_td_columns
      • merge_td_rows
      • mjd_seconds_to_datetime
      • mkdir_p
      • natural_sort
      • natural_sort_key
      • nchan_from_caltable
      • nested_dict
      • numeric_sort
      • numeric_sort_key
      • obs_long_lat
      • obs_midtime
      • open_with_lock
      • ous_parallactic_range
      • pickle_copy
      • pickle_load
      • place_repr_source_first
      • plotms_iterate
      • plots_to_html
      • predict_kernel
      • range_to_list
      • record_to_quantity
      • relative_path
      • remove_trailing_string
      • request_omp_threading
      • reset_logfiles
      • round_half_up
      • round_up
      • safe_split
      • scale_uv_range
      • set_nested_dict
      • shutdown_plotms
      • split_spw
      • spw_arg_to_id
      • spw_intersect
      • string_to_val
      • table_to_html
      • task_depth
      • to_CASA_intent
      • to_pipeline_intent
      • total_time_on_source
      • total_time_on_target_on_source
      • update_beams_dict
      • update_sens_dict
      • validate_url
      • velocity_to_frequency
      • work_directory
      • write_errorexit_file
      • DirectionDict
      • EpochDict
      • IERSInfo
      • LongLatDict
      • OrderedDefaultdict
      • PositionDict
      • QuantityDict
      • IERS_TABLES_PATH
      • SOLAR_SYSTEM_MODELS_PATH
    • pipeline.qa
  • Inheritance of Pipeline Tasks

Developer Guide

  • Building & Setup
    • Pipeline with Monolithic CASA
    • Pixi and Running Pixi tasks
    • Pipeline with Conda
    • Documentation Infrastructure
  • Usage
    • Running Pipeline
    • Pipeline Recipes
  • Process & Workflow
    • Ticket Workflow
    • Git Development Workflow
    • Heuristics Development and Integration in the Pipeline
  • Code Style
    • Code Style and Docstring Guide
  • Testing
    • Unit tests
    • Automated tests
    • Pytest reference
    • Test environment setup
    • Diffing pipeline execution logs
    • DataType Testing
  • Developer Reference
    • Context and Domain Objects
    • CalLibrary Overview
    • Pipeline Versioning
    • Logging
    • Weblog Rendering
    • Task Types: Single-vis, Multi-vis, and Session-aware
    • Spectral Windows and Reference Antennas
    • QA Score Design
    • Function I/O Dumper
    • Parallelization
    • Field parameter
    • Pipeline Flagging Tasks
    • ALMA interferometry imaging workflow
    • VLA interferometry imaging workflow
    • VLASS Selfcal & Restore workflows
    • VLASS-SE-CONT imaging workflow
    • VLASS-SE-CUBE imaging workflow
    • VLASS FITS Header Keywords
  • Miscellaneous
    • Python 3 conversion notes
    • Pipeline Context and Domain Objects
    • “Tier0” Parallelization with Dask/Futures
Back to top
View this page

Code Style¶

  • Code Style and Docstring Guide
Next
Code Style and Docstring Guide
Previous
Heuristics Development and Integration in the Pipeline
Copyright © 2020–2026, Pipeline Dev. Team, build: 2026.1.1.34+104-gce4ea192f
Made with Sphinx and @pradyunsg's Furo