Missing dictionary entries

[mwilensky768]

There are certain default settings in pipeline_scripts/FHD_IDL_wrappers/eor_wrapper_defaults.pro that do not have dictionary entries. I think that if FHD is doing something (or disabling something) by default, there should be dictionary entries with a helpful explanation if possible. Many of these keywords are in the dictionary, but they appear in such a form as

cleanup=0

which is also how it appears in eor_wrapper_defaults.pro. Perhaps someone meant to close the loop on this earlier and hasn't gotten around to it, although some of these unexplained keywords do not have the same default listed as in the wrapper. In any case, I don't know what the following (default) keywords do and they do not have entries [this is how they appear in eor_wrapper_defaults.pro]:

cleanup=0
combine_healpix=0
vis_baseline_hist=1
calibration_visibilities_subtract=0
combine_obs=0
no_restrict_cal_sources=1
calibration_flag_iterate=0
interpolate_kernel=1
calibration_catalog_file_path=filepath('GLEAM_v2_plus_rlb2019.sav',root=rootdir('FHD'),subdir='catalog_data')

I'm very confident that calibration_catalog_file_path just sets the source catalog that is used in the calibration model. The rest are not obvious to me.

[isullivan]

A few quick descriptions of these

cleanup - deletes intermediate data products that can easily be reproduced, to save disk space.
combine_healpix - an older version for integrating all observations from one FHD run to a single Healpix-gridded image.
vis_baseline_hist - ? (not one of mine)
calibration_visibilities_subtract - should probably be deprecated. This subtracts the model visibilities from the calibrated dirty visibilities at the end of calibration, leaving only residual visibilities.
combine_obs - another option for integrating observations from a single FHD run. This one does not use Healpix, but just picks one of the observations' ortho-slant projection and warps the others to match.
no_restrict_cal_sources - ignores beam threshold values and and edge distance when selecting sources to include in the calibration catalog.
calibration_flag_iterate - number of times to repeat calibration in order to better identify and flag bad tiles, and exclude them from contributing to the result.
interpolate_kernel - use interpolation of the gridding kernel while gridding and degridding, rather than selecting the closest super-resolution kernel.

[mwilensky768]

Thanks @isullivan I'll put these in the dictionary on the documentation branch.

[mwilensky768]

I have added what I could from @isullivan's descriptions. Things that are still missing include:

• vis_baseline_hist

@rlbyrne and I also noticed that

• debug_dim

is missing. It seems to interact with

• psf_dim

and we do not know if that itself is a keyword.

[rlbyrne]

Also:

• model_delay_filter

[rlbyrne]

More keywords that need to be added:

• beam_residual_threshold
• beam_dim_fit (this is both a keyword and a function, which isn't great)
• sim_over_calibrate
• beam_threshold

[rlbyrne]

And another deconvolution keyword:

• deconvolution_add_threshold (defaults to 0.8)

[rlbyrne]

Also (see #225):

• max_cal_iter

[bhazelton]

Also:

• save_visibilities
• model_uv_transfer

[rlbyrne]

Another missing dictionary entry:

• nside

[rlbyrne]

More missing dictionary entries:

• no_frequency_flagging (also should be changed to avoid double negative)
• precess
• beam_diff_image
• output_residual_histogram
• show_beam_contour