|
HAWKI Pipeline Reference Manual 1.8.6
|
Functions | |
| int | hawki_apply_harmonization (cpl_imagelist *in, double h1, double h2, double h3, double h4) |
| Apply the harmonization. | |
| cpl_image * | hawki_compute_darkbpm (const cpl_image *in, double sigma) |
| Compute the bpm from the dark (hot pixels) | |
| cpl_image * | hawki_compute_flatbpm (const cpl_image *in, double sigma, double lowval, double highval) |
| Compute the bpm from the flat (aka cold pixels mask) | |
| int | hawki_compute_harmonization (const cpl_imagelist *in, double *h1, double *h2, double *h3, double *h4, double *h) |
| Compute the harmonization. | |
| cpl_image * | hawki_compute_lsbg (const cpl_image *in) |
| Compute the large scale background. | |
| int * | hawki_detectors_labelise (const cpl_frameset *in) |
| Get the frames in which the star is for a given chip. | |
| int | hawki_detectors_locate_star (const cpl_frameset *in, double star_ra, double star_dec, int *labels) |
| Get the frames in which the star is for a given chip. | |
| const char * | hawki_extract_first_filename (const cpl_frameset *in, const char *tag) |
| Extract the filename ffor the first frame of the given tag. | |
| hawki_band | hawki_get_band (const char *f) |
| Get the band. | |
| cpl_bivector * | hawki_get_header_tel_offsets (const cpl_frameset *fset) |
| Get the nominal header offsets from a set of frames. | |
| const char * | hawki_get_license (void) |
| Get the pipeline copyright and license. | |
| double | hawki_get_mean_airmass (cpl_frameset *set) |
| Get the mean airmass for a set of frames. | |
| const char * | hawki_get_version (void) |
| Returns the version of the pipeline. | |
| cpl_error_code | hawki_image_inverse_threshold (cpl_image *image_in, double lo_valid, double hi_valid, double assign_in_range, double assign_out_range) |
| Create an image with a given value for pixels within a range and another value for pixels outside that range. | |
| cpl_image * | hawki_images_stitch (cpl_image **ima, double *x, double *y) |
| Apply the stitching. | |
| void | hawki_print_banner (void) |
| Issue a banner with the pipeline version. | |
| const char * | hawki_std_band_name (hawki_band band) |
| Return a band name. | |
| int | hawki_utils_check_equal_double_keys (cpl_frameset *frames, double(*func)(const cpl_propertylist *)) |
| Check that all the frames share the same value of a given keyword. | |
| int | hawki_utils_check_equal_int_keys (cpl_frameset *frames, int(*func)(const cpl_propertylist *)) |
| Check that all the frames share the same value of a given keyword. | |
| void | hawki_utils_dec2str (char *str, int length_str, double dec) |
| This functions formats a declination in degrees to a string of the form DD:MM:SS. It is based on dec2str from file libwcs/ang2str.c in wcstools library (http://tdc-www.harvard.edu/wcstools/) | |
| void | hawki_utils_ra2str (char *str, int length_str, double ra) |
| This functions formats a right ascension in degrees to a string of the form HH:MM:SS. It is based on ra2str from file libwcs/ang2str.c in wcstools library (http://tdc-www.harvard.edu/wcstools/) | |
| double | hawki_vector_get_max_select (const cpl_vector *self, const cpl_vector *valid) |
| Gets the maximum value of a vector according to an array of flags. | |
| double | hawki_vector_get_min_select (const cpl_vector *self, const cpl_vector *valid) |
| Gets the minimum value of a vector according to an array of flags. | |
| double | hawki_vector_get_mode (cpl_vector *vec) |
| Compute the histogram mode. | |
| int hawki_apply_harmonization | ( | cpl_imagelist * | in, |
| double | h1, | ||
| double | h2, | ||
| double | h3, | ||
| double | h4 | ||
| ) |
Apply the harmonization.
| in | the input images |
| h1 | the factor to apply to chip 1 |
| h2 | the factor to apply to chip 2 |
| h3 | the factor to apply to chip 3 |
| h4 | the factor to apply to chip 4 |
Definition at line 384 of file hawki_utils.c.
| cpl_image* hawki_compute_darkbpm | ( | const cpl_image * | in, |
| double | sigma | ||
| ) |
Compute the bpm from the dark (hot pixels)
| in | the input image |
| sigma | the sigma for the threshold |
Definition at line 119 of file hawki_utils.c.
| cpl_image* hawki_compute_flatbpm | ( | const cpl_image * | in, |
| double | sigma, | ||
| double | lowval, | ||
| double | highval | ||
| ) |
Compute the bpm from the flat (aka cold pixels mask)
| in | the input image |
| sigma | the sigma for the threshold |
| lowval | the lower value for the threshold |
| highval | the upper value for the threshold |
This function creates a mask of pixels below and above a certain limit (lowval, highval) and pixels a certain number of sigmas (sigma) above the background (which is obtained smoothing with a 3x3 kernel the input image).
Definition at line 164 of file hawki_utils.c.
References hawki_image_inverse_threshold().
| int hawki_compute_harmonization | ( | const cpl_imagelist * | in, |
| double * | h1, | ||
| double * | h2, | ||
| double * | h3, | ||
| double * | h4, | ||
| double * | h | ||
| ) |
Compute the harmonization.
| in | the input images |
| h1 | the factor to apply to chip 1 |
| h2 | the factor to apply to chip 2 |
| h3 | the factor to apply to chip 3 |
| h4 | the factor to apply to chip 4 |
| h | the general factor |
chip3 | | chip4 ------ ------ ------ ------ chip1 | |chip2
the edges averages avgi of all chips i are computed -> h=avg(avgi) hi = h/avgi
Definition at line 422 of file hawki_utils.c.
| cpl_image* hawki_compute_lsbg | ( | const cpl_image * | in | ) |
Compute the large scale background.
| the | input image |
Definition at line 531 of file hawki_utils.c.
| int* hawki_detectors_labelise | ( | const cpl_frameset * | in | ) |
Get the frames in which the star is for a given chip.
| in | the input frameset |
The signs of the header offsets in x and y are used:
Definition at line 782 of file hawki_utils.c.
References hawki_get_header_tel_offsets().
| int hawki_detectors_locate_star | ( | const cpl_frameset * | in, |
| double | star_ra, | ||
| double | star_dec, | ||
| int * | labels | ||
| ) |
Get the frames in which the star is for a given chip.
| in | the input frameset |
Definition at line 837 of file hawki_utils.c.
References hawki_get_ext_from_detector(), hawki_pfits_get_naxis1(), and hawki_pfits_get_naxis2().
| const char* hawki_extract_first_filename | ( | const cpl_frameset * | in, |
| const char * | tag | ||
| ) |
Extract the filename ffor the first frame of the given tag.
| in | A non-empty frameset |
| tag | The tag of the requested file |
Definition at line 639 of file hawki_utils.c.
| hawki_band hawki_get_band | ( | const char * | f | ) |
Get the band.
| f | the filter name from the header |
Definition at line 657 of file hawki_utils.c.
| cpl_bivector* hawki_get_header_tel_offsets | ( | const cpl_frameset * | fset | ) |
Get the nominal header offsets from a set of frames.
| fset | the set of frames |
The offsets returned are the telescope offsets, a mirror transformation must be performed to use them in as the image offsets, which is the cpl convention.
Definition at line 695 of file hawki_utils.c.
References hawki_pfits_get_cumoffsetx(), and hawki_pfits_get_cumoffsety().
Referenced by hawki_detectors_labelise().
| const char* hawki_get_license | ( | void | ) |
Get the pipeline copyright and license.
The function returns a pointer to the statically allocated license string. This string should not be modified using the returned pointer.
Definition at line 65 of file hawki_utils.c.
| double hawki_get_mean_airmass | ( | cpl_frameset * | set | ) |
Get the mean airmass for a set of frames.
| set | the input frame set |
Definition at line 740 of file hawki_utils.c.
References hawki_pfits_get_airmass_end(), and hawki_pfits_get_airmass_start().
| const char* hawki_get_version | ( | void | ) |
Returns the version of the pipeline.
Definition at line 106 of file hawki_utils.c.
Referenced by hawki_print_banner().
| cpl_error_code hawki_image_inverse_threshold | ( | cpl_image * | image_in, |
| double | lo_valid, | ||
| double | hi_valid, | ||
| double | assign_in_range, | ||
| double | assign_out_range | ||
| ) |
Create an image with a given value for pixels within a range and another value for pixels outside that range.
| image_in | Image to threshold. |
| lo_valid | Lower bound of the valid range |
| hi_valid | Higher bound of the valid range |
| assign_in_range | Value to assign to pixels within valid range |
| assign_out_range | Value to assign to pixels outside valid range |
Images can be CPL_TYPE_INT, CPL_TYPE_FLOAT or CPL_TYPE_DOUBLE. lo_cut must be smaller than or equal to hi_cut.
Possible #_cpl_error_code_ set in this function:
Definition at line 241 of file hawki_utils.c.
Referenced by hawki_compute_flatbpm().
| cpl_image* hawki_images_stitch | ( | cpl_image ** | ima, |
| double * | x, | ||
| double * | y | ||
| ) |
Apply the stitching.
| ima | The HAWKI_NB_DETECTORS input images |
| x | The HAWKI_NB_DETECTORS x positions |
| y | The HAWKI_NB_DETECTORS y positions |
Definition at line 305 of file hawki_utils.c.
| void hawki_print_banner | ( | void | ) |
Issue a banner with the pipeline version.
Definition at line 93 of file hawki_utils.c.
References hawki_get_version().
| const char* hawki_std_band_name | ( | hawki_band | band | ) |
Return a band name.
| band | a BB |
Definition at line 674 of file hawki_utils.c.
| int hawki_utils_check_equal_double_keys | ( | cpl_frameset * | frames, |
| double(*)(const cpl_propertylist *) | func | ||
| ) |
Check that all the frames share the same value of a given keyword.
| frames | the framset |
| func | the function which returns the value of the kwd, given the propertylist |
Definition at line 1052 of file hawki_utils.c.
| int hawki_utils_check_equal_int_keys | ( | cpl_frameset * | frames, |
| int(*)(const cpl_propertylist *) | func | ||
| ) |
Check that all the frames share the same value of a given keyword.
| frames | the framset |
| func | the function which returns the value of the kwd, given the propertylist |
Definition at line 1086 of file hawki_utils.c.
| void hawki_utils_dec2str | ( | char * | str, |
| int | length_str, | ||
| double | dec | ||
| ) |
This functions formats a declination in degrees to a string of the form DD:MM:SS. It is based on dec2str from file libwcs/ang2str.c in wcstools library (http://tdc-www.harvard.edu/wcstools/)
| str | The string to write to |
| length_str | The maximum lenght to write |
| dec | The declination in degrees |
Definition at line 1192 of file hawki_utils.c.
| void hawki_utils_ra2str | ( | char * | str, |
| int | length_str, | ||
| double | ra | ||
| ) |
This functions formats a right ascension in degrees to a string of the form HH:MM:SS. It is based on ra2str from file libwcs/ang2str.c in wcstools library (http://tdc-www.harvard.edu/wcstools/)
| str | The string to write to |
| length_str | The maximum lenght to write |
| ra | The right ascension in degrees |
Definition at line 1121 of file hawki_utils.c.
| double hawki_vector_get_max_select | ( | const cpl_vector * | self, |
| const cpl_vector * | valid | ||
| ) |
Gets the maximum value of a vector according to an array of flags.
| self | The input vector with the values |
| valid | Vector of flags (>=-0.5: valid, <-0.5: invalid) |
Definition at line 918 of file hawki_utils.c.
| double hawki_vector_get_min_select | ( | const cpl_vector * | self, |
| const cpl_vector * | valid | ||
| ) |
Gets the minimum value of a vector according to an array of flags.
| self | The input vector with the values |
| valid | Vector of flags (>=-0.5: valid, <-0.5: invalid) |
Definition at line 952 of file hawki_utils.c.
| double hawki_vector_get_mode | ( | cpl_vector * | vec | ) |
Compute the histogram mode.
| vec | the vector |
Definition at line 983 of file hawki_utils.c.
1.7.4