VIRCAM Pipeline  2.3.12
Functions

These are utility routines to support the jitter/microstep recipes. More...

Functions

void vircam_jmp_set_config_ipix (int ipix)
 
void vircam_jmp_set_config_icrowd (int icrowd)
 
void vircam_jmp_set_config_rcore (float rcore)
 
void vircam_jmp_set_config_threshold (float threshold)
 
void vircam_jmp_set_config_nbsize (int nbsize)
 
void vircam_jmp_set_config_savecat (int savecat)
 
void vircam_jmp_set_config_destripe (int destripe)
 
void vircam_jmp_set_config_skycor (int skycore)
 
void vircam_jmp_set_config_savesimple (int savesimple)
 
void vircam_jmp_set_config_extenum (int extenum)
 
void vircam_jmp_set_offsky (int inp_offsky)
 
void vircam_jmp_set_isfirst (int inp_isfirst)
 
int vircam_jmp_get_config_savecat ()
 
int vircam_jmp_get_config_destripe ()
 
int vircam_jmp_get_config_skycor ()
 
int vircam_jmp_get_config_savesimple ()
 
int vircam_jmp_get_config_extenum ()
 
void vircam_set_recipename (const char *recipename, int recipe_flag)
 
int vircam_jmp_save_simple (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist)
 
int vircam_jmp_save_simple_offsets (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist)
 
int vircam_jmp_save_offsky (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist)
 
int vircam_jmp_save_super (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist)
 
int vircam_jmp_save_stack (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist, cpl_propertylist *dummyqcprops)
 
int vircam_jmp_save_catalogue (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist, cpl_propertylist *dummyqcprops)
 
int vircam_jmp_save_illum (struct psStruct *ps, cpl_frameset *framelist, cpl_parameterlist *parlist, cpl_propertylist *dummyqcprops)
 
void vircam_jmp_ustep_seq (struct psStruct *ps)
 
void vircam_jmp_interleave (struct psStruct *ps)
 
void vircam_jmp_dither_offsets (struct psStruct *ps, int inter_lv)
 
void vircam_jmp_dither_images (struct psStruct *ps)
 
void vircam_jmp_catalogue (struct psStruct *ps, int inter_lv)
 
void vircam_jmp_matched_stds (struct psStruct *ps, char *cata, char *catapath)
 
void vircam_jmp_wcsfit (struct psStruct *ps)
 
void vircam_jmp_photcal (struct psStruct *ps)
 
void vircam_jmp_bpm2conf (struct psStruct *ps)
 
void vircam_jmp_skycor (struct psStruct *ps)
 
void vircam_jmp_get_readnoise_gain (struct psStruct *ps, int jext, float *readnoise, float *gain)
 
void vircam_jmp_illum (struct psStruct *ps, char *cat, char *catpath)
 
void vircam_jmp_init (struct psStruct *ps)
 
void vircam_jmp_tidy (struct psStruct *ps, int level)
 

Detailed Description

These are utility routines to support the jitter/microstep recipes.

Author
Jim Lewis, CASU

Function Documentation

◆ vircam_jmp_bpm2conf()

void vircam_jmp_bpm2conf ( struct psStruct *  ps)
Name:
vircam_jmp_bpm2conf
Purpose:
Turn a bad pixel mask into a dummy confidence map
Description:
Turn a bad pixel mask into a dummy confidence map. Any pixel which is flagged in the bpm gets a confidence of 0. Otherwise it has a value of 100.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2181 of file vircam_jmp_utils.c.

References casu_fits_get_image().

◆ vircam_jmp_catalogue()

void vircam_jmp_catalogue ( struct psStruct *  ps,
int  inter_lv 
)
Name:
vircam_jmp_catalogue
Purpose:
Extract a catalogue of objects on a the dithered stacked frame.
Description:
Extract a catalogue of objects on a the dithered stacked frame.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 1905 of file vircam_jmp_utils.c.

References casu_fits_get_ehu(), casu_fits_get_status(), casu_fits_set_error(), and casu_imcore().

◆ vircam_jmp_dither_images()

void vircam_jmp_dither_images ( struct psStruct *  ps)
Name:
vircam_jmp_dither_images
Purpose:
Dither input images into a stack frame.
Description:
Dither input images into a stack frame. The offsets will have been worked out beforehand in vircam_jmp_dither_offsets.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 1816 of file vircam_jmp_utils.c.

References casu_dummy_image(), casu_fits_get_phu(), casu_fits_get_status(), casu_fits_set_error(), casu_fits_wrap(), and casu_imdither().

◆ vircam_jmp_dither_offsets()

void vircam_jmp_dither_offsets ( struct psStruct *  ps,
int  inter_lv 
)
Name:
vircam_jmp_dither_offsets
Purpose:
Work out the dither offsets for a group of files that will eventually be jittered into a stack frame.
Description:
The dither offsets will be calculated for a group of files that will eventually be jittered into a stack frame. The WCS is used to get an initial estimate. Then objects are located on the frames and the offset estimates are refined by looking at the positions of the objects.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 1585 of file vircam_jmp_utils.c.

References casu_diffxywcs(), casu_fits_get_ehu(), casu_fits_get_phu(), casu_fits_get_status(), casu_fits_set_error(), casu_imcore(), casu_matchxy(), casu_tfits_get_table(), and vircam_pfits_get_ustepnum().

◆ vircam_jmp_get_readnoise_gain()

void vircam_jmp_get_readnoise_gain ( struct psStruct *  ps,
int  jext,
float *  readnoise,
float *  gain 
)
Name:
vircam_jmp_get_readnoise_gain
Purpose:
Get a readnoise and gain estimate
Description:
Get a readnoise and gain estimate. If one doesn't exist, then fill one in.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2363 of file vircam_jmp_utils.c.

◆ vircam_jmp_illum()

void vircam_jmp_illum ( struct psStruct *  ps,
char *  cat,
char *  catpath 
)
Name:
vircam_jmp_illum
Purpose:
Do the illumination correction calculation
Description:
Work out the illumination corrections for a series of images
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2425 of file vircam_jmp_utils.c.

References casu_fits_get_ehu(), casu_fits_get_phu(), casu_fits_get_status(), casu_getstds(), casu_imcore(), casu_matchstds(), casu_tfits_get_ehu(), casu_tfits_get_table(), casu_tfits_wrap(), vircam_illum(), and vircam_pfits_get_filter().

◆ vircam_jmp_init()

void vircam_jmp_init ( struct psStruct *  ps)
Name:
vircam_jmp_init
Purpose:
Initialise pointers in the global memory structure.
Description:
Initialise pointers in the global memory structure.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2631 of file vircam_jmp_utils.c.

◆ vircam_jmp_interleave()

void vircam_jmp_interleave ( struct psStruct *  ps)
Name:
vircam_jmp_interleave
Purpose:
Group input files by microstep sequence and interleave them
Description:
Group input files by microstep sequence and interleave them into superframes.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 1413 of file vircam_jmp_utils.c.

References casu_dummy_image(), casu_fits_get_ehu(), casu_fits_get_fullname(), casu_fits_get_image(), casu_fits_get_nexten(), casu_fits_get_status(), casu_fits_set_error(), casu_fits_wrap(), casu_getnpts(), casu_med(), casu_radectoxy(), casu_xytoradec(), vircam_interleave(), and vircam_jmp_ustep_seq().

◆ vircam_jmp_matched_stds()

void vircam_jmp_matched_stds ( struct psStruct *  ps,
char *  cata,
char *  catapath 
)
Name:
vircam_jmp_matched_stds
Purpose:
Match the extracted objects catalogue with a table of 2mass standards
Description:
The catalogue of extracted objects from the stacked image is matched to a table of 2mass standards to form a matched standards table.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 1964 of file vircam_jmp_utils.c.

References casu_fits_get_ehu(), casu_getstds(), casu_matchstds(), and casu_tfits_get_table().

◆ vircam_jmp_photcal()

void vircam_jmp_photcal ( struct psStruct *  ps)
Name:
vircam_jmp_photcal
Purpose:
Work out the photometric zeropoint
Description:
The matched standards table is used to calculate a photometric zeropoint.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2124 of file vircam_jmp_utils.c.

References casu_fits_get_phu(), casu_photcal_extinct(), casu_tfits_delete(), casu_tfits_wrap(), and vircam_pfits_get_filter().

◆ vircam_jmp_save_catalogue()

int vircam_jmp_save_catalogue ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist,
cpl_propertylist *  dummyqcprops 
)
Name:
vircam_jmp_save_catalogue
Purpose:
Save the cataloge products
Description:
The catalogue products are saved here.
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 885 of file vircam_jmp_utils.c.

References casu_dummy_catalogue(), casu_fits_get_ehu(), casu_fits_get_phu(), casu_tfits_get_ehu(), casu_tfits_get_phu(), and casu_tfits_get_table().

◆ vircam_jmp_save_illum()

int vircam_jmp_save_illum ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist,
cpl_propertylist *  dummyqcprops 
)
Name:
vircam_jmp_save_illum
Purpose:
Save the illumination correction table product
Description:
The illumination correction table is saved here
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 1100 of file vircam_jmp_utils.c.

References casu_dummy_property(), casu_fits_get_ehu(), casu_fits_get_phu(), casu_merge_propertylists(), casu_removewcs(), casu_tfits_get_ehu(), casu_tfits_get_phu(), casu_tfits_get_table(), vircam_dfs_set_product_exten_header(), vircam_dfs_set_product_primary_header(), and vircam_illcor_newtab().

◆ vircam_jmp_save_offsky()

int vircam_jmp_save_offsky ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)
Name:
vircam_jmp_save_offsky
Purpose:
Save the mean offset sky image products
Description:
The offsky frame image products are saved here.
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 344 of file vircam_jmp_utils.c.

References casu_fits_get_image(), and casu_fits_get_status().

◆ vircam_jmp_save_simple()

int vircam_jmp_save_simple ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)
Name:
vircam_jmp_save_simple
Purpose:
Save the simple image products
Description:
The simple image products are saved here.
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 119 of file vircam_jmp_utils.c.

◆ vircam_jmp_save_simple_offsets()

int vircam_jmp_save_simple_offsets ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)
Name:
vircam_jmp_save_simple_offsets
Purpose:
Save the simple image offsky sky products
Description:
The simple image products of offset skies are saved here.
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 236 of file vircam_jmp_utils.c.

◆ vircam_jmp_save_stack()

int vircam_jmp_save_stack ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist,
cpl_propertylist *  dummyqcprops 
)
Name:
vircam_jmp_save_stack
Purpose:
Save the stack frame image products
Description:
The stack frame image products are saved here.
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 666 of file vircam_jmp_utils.c.

References casu_fits_get_image(), and casu_fits_get_status().

◆ vircam_jmp_save_super()

int vircam_jmp_save_super ( struct psStruct *  ps,
cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)
Name:
vircam_jmp_save_super
Purpose:
Save the super frame image products
Description:
The super frame image products are saved here.
Language:
C
Parameters
framelistThe input recipe frameset
parlistThe input recipe parameter list
Returns
0 if everything is ok
Author
Jim Lewis, CASU

Definition at line 452 of file vircam_jmp_utils.c.

References casu_fits_get_image(), and casu_fits_get_status().

◆ vircam_jmp_skycor()

void vircam_jmp_skycor ( struct psStruct *  ps)
Name:
vircam_jmp_skycor
Purpose:
Correct for sky background in the science images
Description:
All good images are combined with rejection to form a sky background image. The combined image is normalised to zero median and then subtracted off of the input images.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2217 of file vircam_jmp_utils.c.

References casu_fits_get_ehu(), casu_fits_get_fullname(), casu_fits_get_image(), casu_fits_get_status(), casu_fits_wrap(), casu_imcombine(), casu_merge_propertylists(), and casu_qmedsig().

◆ vircam_jmp_tidy()

void vircam_jmp_tidy ( struct psStruct *  ps,
int  level 
)
Name:
vircam_jmp_tidy
Purpose:
Free allocated workspace in the global memory structure
Description:
Free allocated workspace in the global memory structure. The tidy works on two levels. Level 1 is for items that are usually cleared up after each extension is processed. Level 2 is for cleaning up the whole recipe
Language:
C
Parameters
levelThe level of the tidy to be done. 1: Tidy up after finishing an extension, 2: Tidy up after finishing the recipe.
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2711 of file vircam_jmp_utils.c.

◆ vircam_jmp_ustep_seq()

void vircam_jmp_ustep_seq ( struct psStruct *  ps)
Name:
vircam_jmp_ustep_seq
Purpose:
Group input files into microstep sequences
Description:
An input list of files are grouped by the microstep number in the header.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 1303 of file vircam_jmp_utils.c.

References casu_fits_get_filename(), casu_fits_get_phu(), casu_fits_get_status(), casu_fits_set_error(), vircam_pfits_get_nusteps(), and vircam_pfits_get_ustepnum().

Referenced by vircam_jmp_interleave().

◆ vircam_jmp_wcsfit()

void vircam_jmp_wcsfit ( struct psStruct *  ps)
Name:
vircam_jmp_wcsfit
Purpose:
Fit a world-coordinate system
Description:
The matched standards table is used to fit a world coordinate system. The resulting WCS parameters are written to the header of the stacked image using the usual FITS conventions.
Language:
C
Returns
Nothing
Author
Jim Lewis, CASU

Definition at line 2056 of file vircam_jmp_utils.c.

References casu_fits_get_ehu(), casu_platesol(), casu_tfits_get_ehu(), casu_tfits_get_table(), and casu_xytoradec().