ReleaseStep

This step will flatten down the reprocessing and remove extraneous files for release. It also has the option to remove generally unnecessary extensions from the various .fits files, which can significantly decrease the size of files (particularly mosaics with large numbers of input tiles).

API

class pjpipe.ReleaseStep(in_dir, out_dir, target, bands, file_exts=None, remove_bloat=False, move_tweakback=False, move_backgrounds=False, move_individual_fields=False, move_psf_matched=False, move_diagnostic_plots=False, compress_diagnostic_plots=True, lv3_dir='lv3', tweakback_dir='lv3', tweakback_ext='tweakback', background_dir='lv2', background_ext='combinedbackground', individual_fields_dir='mosaic_individual_fields', psf_matched_dir='psf_matching', diagnostic_plot_dir='plots', overwrite=False)[source]

Tidies up files, moves to a single directory for release

This step will move the final useful files, plus optionally any tweakback’d crf files and background files, into a neat directory structure for release

Parameters:

  • in_dir – Input directory

  • out_dir – Output directory

  • target – Target to consider

  • bands – Bands to consider

  • file_exts – List of filetypes to move. Defaults to moving fits files, plus any generated catalogues and segmentation maps

  • remove_bloat – Will remove generally un-needed extensions from fits files. Defaults to False

  • move_tweakback – Whether to move tweakback’d crf files or not. Defaults to False

  • move_backgrounds – Whether to move combined background files or not. Defaults to False

  • move_individual_fields – Whether to move individual field mosaics or not. Defaults to False

  • move_psf_matched – Whether to move PSF matched images or not. Defaults to False

  • move_diagnostic_plots – Whether to move various diagnostic plots or not. Defaults to False

  • compress_diagnostic_plots – Whether to compress the diagnostic plot folder to limit file number. Defaults to True

  • lv3_dir – Where level 3 files are located, relative to the target directory structure. Defaults to “lv3”

  • background_dir – Where tweakback files are located, relative to the target directory structure. Defaults to “lv3”

  • tweakback_ext – Filename extension for tweakback files. Defaults to “tweakback”

  • background_dir – Where combined background files are located, relative to the target directory structure. Defaults to “lv2”

  • background_ext – Filename extension for combined background files. Defaults to “combinedbackground”

  • individual_fields_dir – Where individual field mosaics are located, relative to the target directory structure. Defaults to “mosaic_individual_fields”

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

do_compress_diagnostic_plots()[source]

Compress diagnostic plot directories

do_move_backgrounds(band)[source]

Move combined background files

Parameters:

band – Band to consider

do_move_diagnostic_plots(band)[source]

Move various diagnostic plots

Parameters:

band – Band to consider

do_move_individual_fields(band)[source]

Move individual field mosaics

Parameters:

band – Band to consider

do_move_psf_matched(band)[source]

Move PSF matched images

Parameters:

band – Band to consider

do_move_tweakback(band)[source]

Move tweakback crf files

Parameters:

band – Band to consider

do_step()[source]

Run the release step

move_files(band, file_ext)[source]

Move files

Parameters:

  • band – Band to consider

  • file_ext – File extension to move