StepImgMap

class sofia_redux.instruments.hawc.steps.stepimgmap.StepImgMap[source]

Bases: StepParent

Generate a map image.

This pipeline step calls sofia_redux.visualization.quicklook.make_image to generate a PNG image for quick-look purposes from imaging data in the input. This step should be run after calibration, as a final step in the pipeline.

The output from this step is identical to the input. As a side effect, a PNG file is saved to disk to the same base name as the input file, with a ‘.png’ extension.

Methods Summary

run()

Run the data reduction algorithm.

setup()

Set parameters and metadata for the pipeline step.

Methods Documentation

run()[source]

Run the data reduction algorithm.

Because this step is single-in, single-out (SISO), self.datain must be a DataFits object. The output is also a DataFits object, stored in self.dataout.

The process is:

  1. Read image data.

  2. Generate a plot with contours overlaid on a flux image.

setup()[source]

Set parameters and metadata for the pipeline step.

Output files have PRODTYPE = ‘imgmap’, and are named with the step abbreviation ‘IMP’.

Parameters defined for this step are:

maphdustr

Extension name to use as the image.

lowhighscalelist of float

Specify a low and high percentile value for the image scale, e.g. [0,99].

colorcontourstr

Contour color.

colormapstr

Image colormap.

ncontoursint

Number of contour levels.

fillcontoursbool

If set, the contours will be filled, rather than just overlaid on the image.

gridbool

If set, a grid will be overlaid on the image.

titlestr

A title string. If set to ‘info’, a title will be automatically generated.

centercropbool

If set, the image will be cropped, using the values in the ‘centercropparams’ parameter.

centercropparamslist of float

Cropping area to use if centercrop = True. Should be a 4-element list of [RA center (deg), Dec center (deg, box width (deg), box height (deg)].

watermarkstr

Text to add to the plot as a watermark.