mangadap.survey.manga_dap module

Provides the main wrapper function for the MaNGA DAP.

License:

Copyright (c) 2015, SDSS-IV/MaNGA Pipeline Group

Licensed under BSD 3-clause license - see LICENSE.rst

Usage:

Add usage examples

Revision history:

21 Mar 2016: Original implementation by K. Westfall (KBW): started.

19 Jul 2016: (KBW) Always provide the NSA redshift to the modules!

05 May 2017: (KBW) Clean up documentation; use import to get __version__

mangadap.survey.manga_dap.manga_dap(obs, plan, dbg=False, log=None, verbose=0, drpver=None, redux_path=None, directory_path=None, dapver=None, dapsrc=None, analysis_path=None)

Main wrapper function for the MaNGA DAP.

This function is designed to be called once per PLATE-IFUDESIGN as set by the provided mangadap.par.obsinput.ObsInputPar instance. The mangadap.par.analysisplan.AnalysisPlanSet instance sets the types of analyses to perform on this observation. Each analysis plan results in a MAPS and model LOGCUBE file.

The procedure is as follows:

• Read the DRP fits file specified by obs

• For each plan in plan:

  • Determine basic assessments of the data, including the S/N and spaxel coordinates. See mangadap.proc.reductionassessments.ReductionAssessment.
  • Bin the spectra. See mangadap.proc.spatiallybinnedspectra.SpatiallyBinnedSpectra.
  • Fit the stellar continuum for stellar kinematics. See mangadap.proc.stellarcontinuummodel.StellarContinuumModel.
  • Measure the emission-line moments. See mangadap.proc.emissionlinemoments.EmissionLineMoments.
  • Fit parameterized line profiles to the emission lines. See mangadap.proc.emissionlinemodel.EmissionLineModel.
  • Subtract the fitted emission-line models and measure the spectral indices. See mangadap.proc.spectralindices.SpectralIndices.
  • Construct the primary output files based on the plan results. See mangadap.dapfits.construct_maps_file() and mangadap.dapfits.construct_cube_file().

Verbose levels (still under development):

0. Nothing but errors.
1. Basic status updates. E.g., start and end of each block, minor progress within blocks.
2. Block-level and sub-function updates.
3. Same as above, with figures.

Parameters:

• obs (dict, mangadap.par.obsinput.ObsInputPar) – Object with the input parameters.
• plan (mangadap.par.analysisplan.AnalysisPlanSet) – Object with the analysis plans to implement.
• dbg (bool) – (Optional) Flag to run the DAP in debug mode, see above; default is False. Limited use; still under development.
• log (str) – (Optional) File name for log output, see above; no log file is produced by default.
• verbose (int) – (Optional) Verbosity level, see above; default is 0.
• drpver (str) – (Optional) DRP version. Default determined by mangadap.config.defaults.default_drp_version().
• redux_path (str) – (Optional) Top-level directory with the DRP products; default is defined by mangadap.config.defaults.default_redux_path().
• directory_path (str) – (Optional) Direct path to directory containing the DRP output file; default is defined by mangadap.config.defaults.default_drp_directory_path()
• dapver (str) – (Optional) DAP version. Default determined by mangadap.config.defaults.default_dap_version().
• dapsrc (str) – (Optional) Source directory of the DAP. Default determined by mangadap.config.defaults.dap_source_dir().
• analysis_path (str) – (Optional) Top-level directory for the DAP output data; default is defined by mangadap.config.defaults.default_analysis_path().

Returns:

Status flag (under development; currently always 0)

Return type:

int