vircam_jmp_utils
[Groups of Support Routines]

Detailed Description

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

Author:
Jim Lewis, CASU


Functions

int vircam_jmp_save_simple (cpl_frameset *framelist, cpl_parameterlist *parlist)
int vircam_jmp_save_super (cpl_frameset *framelist, cpl_parameterlist *parlist)
int vircam_jmp_save_stack (cpl_frameset *framelist, cpl_parameterlist *parlist)
int vircam_jmp_save_catalogue (cpl_frameset *framelist, cpl_parameterlist *parlist)
int vircam_jmp_save_illum (cpl_frameset *framelist, cpl_parameterlist *parlist)
void vircam_jmp_ustep_seq (void)
void vircam_jmp_interleave (void)
void vircam_jmp_dither_offsets (void)
void vircam_jmp_dither_images (void)
void vircam_jmp_catalogue (void)
void vircam_jmp_matched_stds (void)
void vircam_jmp_wcsfit (void)
void vircam_jmp_photcal (void)
void vircam_jmp_bpm2conf (void)
void vircam_jmp_skycor (void)
void vircam_jmp_get_readnoise_gain (int jext, float *readnoise, float *gain)
void vircam_jmp_illum (void)
void vircam_jmp_init (void)
void vircam_jmp_tidy (int level)

Function Documentation

void vircam_jmp_bpm2conf ( void   ) 

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 1840 of file vircam_jmp_utils.c.

References vircam_fits_get_image().

void vircam_jmp_catalogue ( void   ) 

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 1603 of file vircam_jmp_utils.c.

References vircam_fits_get_status(), vircam_fits_set_error(), and vircam_imcore().

void vircam_jmp_dither_images ( void   ) 

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 1514 of file vircam_jmp_utils.c.

References vircam_dummy_image(), vircam_fits_get_status(), vircam_fits_set_error(), and vircam_fits_wrap().

void vircam_jmp_dither_offsets ( void   ) 

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 1302 of file vircam_jmp_utils.c.

References vircam_diffxywcs(), vircam_fits_get_ehu(), vircam_fits_get_phu(), vircam_fits_get_status(), vircam_fits_set_error(), vircam_imcore(), vircam_matchxy(), vircam_pfits_get_ustepnum(), and vircam_tfits_get_table().

void vircam_jmp_get_readnoise_gain ( 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 1960 of file vircam_jmp_utils.c.

void vircam_jmp_illum ( void   ) 

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 2022 of file vircam_jmp_utils.c.

References vircam_fits_get_ehu(), vircam_fits_get_phu(), vircam_fits_get_status(), vircam_getstds(), vircam_illum(), vircam_imcore(), vircam_matchstds(), vircam_pfits_get_filter(), vircam_tfits_get_ehu(), vircam_tfits_get_table(), and vircam_tfits_wrap().

void vircam_jmp_init ( void   ) 

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 2224 of file vircam_jmp_utils.c.

void vircam_jmp_interleave ( void   ) 

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 1132 of file vircam_jmp_utils.c.

References vircam_dummy_image(), vircam_fits_get_ehu(), vircam_fits_get_fullname(), vircam_fits_get_image(), vircam_fits_get_status(), vircam_fits_set_error(), vircam_fits_wrap(), vircam_getnpts(), vircam_jmp_ustep_seq(), vircam_med(), vircam_radectoxy(), and vircam_xytoradec().

void vircam_jmp_matched_stds ( void   ) 

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 1661 of file vircam_jmp_utils.c.

References vircam_fits_get_ehu(), vircam_getstds(), vircam_matchstds(), and vircam_tfits_get_table().

void vircam_jmp_photcal ( void   ) 

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 1786 of file vircam_jmp_utils.c.

References vircam_fits_get_phu(), vircam_pfits_get_filter(), vircam_photcal(), and vircam_tfits_get_ehu().

int vircam_jmp_save_catalogue ( cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)

Name:
vircam_jmp_save_catalogue
Purpose:
Save the cataloge products
Description:
The catalogue products are saved here.
Language:
C
Parameters:
framelist The input recipe frameset
parlist The input recipe parameter list
Returns:
0 if everything is ok
Author:
Jim Lewis, CASU

Definition at line 610 of file vircam_jmp_utils.c.

References vircam_dummy_catalogue(), vircam_fits_get_ehu(), vircam_tfits_get_ehu(), vircam_tfits_get_phu(), and vircam_tfits_get_table().

int vircam_jmp_save_illum ( cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)

Name:
vircam_jmp_save_illum
Purpose:
Save the illumination correction table product
Description:
The illumination correction table is saved here
Language:
C
Parameters:
framelist The input recipe frameset
parlist The input recipe parameter list
Returns:
0 if everything is ok
Author:
Jim Lewis, CASU

Definition at line 823 of file vircam_jmp_utils.c.

References vircam_fits_get_ehu(), vircam_illcor_newtab(), vircam_tfits_get_ehu(), vircam_tfits_get_phu(), and vircam_tfits_get_table().

int vircam_jmp_save_simple ( 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:
framelist The input recipe frameset
parlist The input recipe parameter list
Returns:
0 if everything is ok
Author:
Jim Lewis, CASU

Definition at line 86 of file vircam_jmp_utils.c.

References vircam_dfs_set_product_exten_header(), vircam_dfs_set_product_primary_header(), vircam_dummy_property(), vircam_fits_get_ehu(), vircam_fits_get_image(), vircam_fits_get_phu(), and vircam_fits_get_status().

int vircam_jmp_save_stack ( cpl_frameset *  framelist,
cpl_parameterlist *  parlist 
)

Name:
vircam_jmp_save_stack
Purpose:
Save the stack frame image products
Description:
The stack frame image products are saved here.
Language:
C
Parameters:
framelist The input recipe frameset
parlist The input recipe parameter list
Returns:
0 if everything is ok
Author:
Jim Lewis, CASU

Definition at line 402 of file vircam_jmp_utils.c.

References vircam_dfs_set_product_exten_header(), vircam_dfs_set_product_primary_header(), vircam_dummy_property(), vircam_fits_get_ehu(), vircam_fits_get_image(), vircam_fits_get_phu(), vircam_fits_get_status(), and vircam_merge_propertylists().

int vircam_jmp_save_super ( 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:
framelist The input recipe frameset
parlist The input recipe parameter list
Returns:
0 if everything is ok
Author:
Jim Lewis, CASU

Definition at line 204 of file vircam_jmp_utils.c.

References vircam_dfs_set_product_exten_header(), vircam_dfs_set_product_primary_header(), vircam_dummy_property(), vircam_fits_get_ehu(), vircam_fits_get_image(), vircam_fits_get_phu(), and vircam_fits_get_status().

void vircam_jmp_skycor ( void   ) 

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 1876 of file vircam_jmp_utils.c.

References vircam_fits_get_ehu(), vircam_fits_get_image(), vircam_fits_get_status(), vircam_imcombine(), and vircam_qmedsig().

void vircam_jmp_tidy ( 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:
level The 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 2295 of file vircam_jmp_utils.c.

void vircam_jmp_ustep_seq ( void   ) 

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 1023 of file vircam_jmp_utils.c.

References vircam_fits_get_filename(), vircam_fits_get_phu(), vircam_fits_get_status(), vircam_fits_set_error(), vircam_pfits_get_nusteps(), and vircam_pfits_get_ustepnum().

Referenced by vircam_jmp_interleave().

void vircam_jmp_wcsfit ( void   ) 

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 1718 of file vircam_jmp_utils.c.

References vircam_fits_get_ehu(), vircam_platesol(), vircam_tfits_get_ehu(), vircam_tfits_get_table(), and vircam_xytoradec().

Generated on Wed Apr 10 04:01:58 2013 for VIRCAM Pipeline by  doxygen 1.5.1