Python Scripting Interface (API)

ADMIT offers an extensive collection of pre-defined modules for creating data processing scripts in Python. The programming interface is divided into several importable packages, whose contents are detailed in the following sections. Names in boldface indicate the name of the class as imported into the top-level admit module (e.g., admit.Ingest_AT); these are the names users will see in scripts. Otherwise, class names reside within the corresponding module only (e.g., admit.xmlio.Parser). The detailed documentation for each item contains the full, low-level Python class name (e.g., admit.at.Ingest_AT.Ingest_AT), which indicates where the class’s Python code can be found within the ADMIT source tree.

Module admit

• ADMIT Package
• Task — ADMIT task (AT) base.
• Project — ADMIT project.
• Flow — Project task flow manager.
• Manager — Multiflow project manager.
• Summary — Project summary metadata.

Module admit.at

• AT Package
• BDPIngest_AT — Ingests an arbitrary BDP disk file.
• ContinuumSub_AT — Subtracts continuum emission from a cube.
• CubeSpectrum_AT — Cuts one or more spectra through a cube.
• CubeStats_AT — Calculates cube statistics.
• CubeSum_AT — Sums the emission in a cube.
• Export_AT — Exports an Image_BDP to FITS.
• File_AT — Test task representing an arbitrary disk file.
• Flow11_AT — Test task copying a File_BDP to the output.
• Flow1N_AT — Test task consuming one File_BDP and creating N.
• FlowMN_AT — Test task consuming M File_BDPs and creating N.
• FlowN1_AT — Test task consuming N File_BDPs and creating one.
• GenerateSpectrum_AT — Generates synthetic test spectra.
• Ingest_AT — Ingests a (FITS) data cube.
• LineCube_AT — Cuts a cube into one or more line-oriented cubes.
• LineID_AT — Identifies molecular lines in spectra.
• LineSegment_AT — Finds segments of line emission in spectra.
• Moment_AT — Generates various moment maps of a cube.
• OverlapIntegral_AT — Computes the overlap integral between images.
• PVCorr_AT — Determines position-velocity correlations in a map.
• PVSlice_AT — Creates a position-velocity slice through a cube.
• PrincipalComponent_AT — Calculates principal components of maps.
• Regrid_AT — Regrids multiple cubes to a common resolution.
• SFind2D_AT — Finds sources in a 2D map.
• Smooth_AT — Creates a smoothed version of a cube.
• Template_AT — Cube manipulation template.

Module admit.bdp

• BDP Package
• BDP — Basic data product base.
• CubeSpectrum_BDP — Data cube spectra.
• CubeStats_BDP — Plane-based cube statistics.
• File_BDP — Test data product representing a disk file.
• Image_BDP — Image data base.
• LineCube_BDP — LineCube_AT data (cube and line information).
• LineList_BDP — LineID_AT data (line information and spectra).
• LineSegment_BDP — LineSegment_AT data (line segment information).
• Line_BDP — Line data base.
• Moment_BDP — Moment_AT data (images and line information).
• PVCorr_BDP — PVCorr_AT data (image and table).
• PVSlice_BDP — PVSlice_AT data (image).
• SourceList_BDP — SFind2D_AT data (image and table).
• SpwCube_BDP — Spectral window cube.
• Table_BDP — Tabular data base.

Module admit.recipes

• Recipes Package
• Archive_Pipeline — Produces standard JAO ADMIT pipeline products for spectral line plus continuum images.
• Archive_SpecLine — Produces standard JAO ADMIT pipeline products for spectral line images.
• Line_Moment — Image cube to line moment map analysis.
• Source_Find — Finds sources in a 2-D image.
• Source_Spectra — Generates spectra for a series of map locations.
• recipe — Executes a pre-defined ADMIT recipe (script).

Module admit.util

• Utilities Package
• APlot — Standardized plot generator.
• AbstractPlot — Plotting base class.
• AdmitHTTP — Data browser services module.
• logging — Message logging functionality.
• ImPlot — Simple image plotter.
• Image — Image data base.
• Line — Spectral line metadata.
• LineData — Extended spectral line metadata.
• LinePlot — Interactive/non-interactive line plotting utility.
• MultiImage — Multiple image container base.
• PlotControl — Defines plot mode, type and orientation.
• Segments — Manages groups of line segments.
• Source — Astronomical source metadata.
• SpectralLineSearch — Interface to spectral line searching.
• Spectrum — Spectral line data container.
• SpectrumIngest — Converts non-ADMIT spectral data to ADMIT format.
• Splatalogue — Module for performing splatalogue queries.
• Table — Raw tabular data base.
• Tier1DB — Tier 1 molecular line database services.
• UtilBase — Base for all ADMIT utilities.
• VLSR — Simple VLSR catalog and calculator.
• casautil — CASA-dependent utilities module.
• specutil — Module for low-level manipulation of spectral line data.
• stats — Statistics functions module.
• utils — Generic (CASA-independent) utilities module.

Module admit.util.continuumsubtraction

• Continuum Subtraction Package
• ContinuumSubtraction — Subtracts the continuum from a spectrum.
• PolyFit — Continuum subtraction using a polynomial fit.
• SplineFit — Continuum subtraction using a spline fit.

Module admit.util.filter

• Filter Package
• Filter1D — 1-dimensional spectral filtering.
• Filter2D — 2-dimensional spectral filtering.

Module admit.util.peakfinder

• Peak Finder Package
• FindPeaksCWT — Peak finding with continuous wavelet transforms.
• PeakDetect — Peak detection of peaks and valleys.
• PeakFinder — Peak finding with derivatives.
• PeakUtils — A peak finding algorithm.

Module admit.util.segmentfinder

• Segment Finder Package
• ADMITSegmentFinder — Finds segments of emission within a spectrum.
• ASAPSegmentFinder — Finds segments of emission within a spectrum.
• SegmentFinder — Top-level spectral emission segment finder.

Module admit.xmlio

• XML I/O Package
• AdmitParser — Specialized parser for ADMIT XML files.
• BDPReader — Converts BDP in XML format to in-memory BDP object.
• DTDParser — Parses DTD information within an XML file.
• DtdReader — Reads a DTD file.
• ErrorHandler — Handles errors from the XML parser.
• Parser — Converts an ADMIT project on disk to in-memory objects.
• XmlWriter — Converts in-memory ADMIT objects to XML format.
• dtdGenerator — Generates the ADMIT DTD files.