LyotMaskStep

This step should only be used on MIRI data!

This step will mask the Lyot coronagraph as ‘non-science’ data, so it won’t be included in the final mosaic.

N.B. only use one of either this step or LyotSeparateStep.

API

class pjpipe.LyotMaskStep(in_dir, out_dir, step_ext, procs, method='mask', overwrite=False)[source]

Mask the lyot coronagraph in MIRI observations

Parameters:

  • in_dir – Input directory

  • out_dir – Output directory

  • step_ext – .fits extension for the files going into the step

  • procs – Number of processes to run in parallel

  • method – Whether to just mask the coronagraph (mask), or only parts that overlap the main science chip in other observations (mask_overlap). Defaults to ‘mask’

  • overwrite – Whether to overwrite or not. Defaults to False

do_step()[source]

Run lyot masking

parallel_lyot_mask(file, mask_value=513)[source]

Parallelise lyot masking

Parameters:

  • file – File to mask lyot in

  • mask_value – DQ bit value for masked values. Defaults to 513 (DO_NOT_USE+NON_SCIENCE)

parallel_lyot_mask_overlap(file, all_files, mask_value=513)[source]

Parallelise lyot overlap masking

Parameters:

  • file – File to mask lyot in

  • all_files – Complete list of files

  • mask_value – DQ bit value for masked values. Defaults to 513 (DO_NOT_USE+NON_SCIENCE)

run_step(files, procs=1)[source]

Wrap paralellism around the lyot masking

Parameters:

  • files – List of files to mask lyot in

  • procs – Number of parallel processes to run. Defaults to 1