![]() |
GIRAFFE Pipeline Reference Manual |
|||
|
|
Giraffe Images
Detailed DescriptionThe module implements an Giraffe image type which inherits the cpl_image type and extends it by a property list to allow for storing image meta data together with its associated image. A pointer to a Giraffe image can be cast into a pointer to a cpl_image. Function Documentation
Add additional frame information to an image. TBD Definition at line 776 of file giimage.c. References giraffe_add_frameset_info(), giraffe_add_recipe_info(), and giraffe_image_get_properties().
Copies matrix elements into an image.
The function copies the matrix elements of the source matrix matrix into the pixel buffer of the image image. Definition at line 353 of file giimage.c. Referenced by giraffe_compute_fiber_profiles(), and giraffe_localize_spectra().
Creates an image container of a given type.
The function creates a new image container and an allocates memory for an image of the given dimensions nx, ny. The allocated image is suitable for pixels of type type. The created property list is empty. Definition at line 103 of file giimage.c. References giraffe_image_delete(), and giraffe_image_new(). Referenced by giraffe_compute_fiber_profiles(), giraffe_extract_spectra(), giraffe_localize_spectra(), giraffe_stacking_average(), giraffe_stacking_ksigma(), giraffe_stacking_median(), and giraffe_stacking_minmax().
Destroys an image.
The function deallocates the memory used for the image data and all image properties. Definition at line 189 of file giimage.c. Referenced by giraffe_extract_spectra(), giraffe_fov_build(), giraffe_fov_clear(), giraffe_image_create(), and giraffe_rebinning_destroy().
Creates a copy of an image.
The function creates a deep copy of the source image image, i.e. the image data and all properties are copied. Definition at line 147 of file giimage.c. References giraffe_image_new(). Referenced by giraffe_fov_build().
Gets the image data.
The function returns a reference pointer to the actual image stored in the image container self. Definition at line 226 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_calibrate_flux(), giraffe_calibrate_wavelength(), giraffe_compute_fiber_profiles(), giraffe_extract_spectra(), giraffe_fov_build(), giraffe_frame_create_image(), giraffe_image_paste(), giraffe_localize_spectra(), giraffe_stacking_average(), giraffe_stacking_ksigma(), giraffe_stacking_median(), giraffe_stacking_minmax(), giraffe_subtract_dark(), giraffe_trim_raw_areas(), and giraffe_wlsolution_create().
Get the properties of an image.
The function returns a reference pointer to the properties, i.e. the keyword list stored in the image container self. Definition at line 290 of file giimage.c. Referenced by giraffe_add_rvcorrection(), giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_calibrate_flux(), giraffe_calibrate_wavelength(), giraffe_compute_fiber_profiles(), giraffe_extract_spectra(), giraffe_fov_build(), giraffe_frame_create_image(), giraffe_get_raw_areas(), giraffe_grating_create(), giraffe_grating_setup(), giraffe_image_add_info(), giraffe_localize_spectra(), giraffe_rebin_spectra(), giraffe_subtract_dark(), giraffe_trim_raw_areas(), and giraffe_wlsolution_create().
Gets image data and properties from a file.
The function reads the pixel data and the properties for image number position from the file filename into the target image self. In case the file contains a data cube at position position the plane number 0 is loaded. Definition at line 539 of file giimage.c. References giraffe_image_load_pixels(), and giraffe_image_load_properties().
Gets image data from a file.
The function reads the pixel data for image number index from the file filename into the target image self. The pixel data type is converted to the target type if necessary. If the pixel data at position index in the file form a data cube, the function loads the plane with the index plane, otherwise plane is ignored. Definition at line 459 of file giimage.c. Referenced by giraffe_image_load().
Gets image properties from a file.
The function reads the image properties for the image at position position within the file filename and stores them in self. If there are already properties associated to an image they will be replaced by calling this function. Definition at line 496 of file giimage.c. Referenced by giraffe_image_load().
Creates an empty image container.
The function allocates memory for an empty image container. Definition at line 73 of file giimage.c. Referenced by giraffe_calibrate_flux(), giraffe_fov_build(), giraffe_image_create(), and giraffe_image_duplicate().
Paste an image into another at a given position.
The function pastes the image image into the destination image self at the pixel position given by the coordinates x and y. The coordinates x and y indicate the position of the lower left pixel of image, starting from (0, 0). If clip is set to Definition at line 656 of file giimage.c. References giraffe_image_get().
Write a Giraffe image to a file.
The Giraffe image self is written to the file filename. Currently a Giraffe image can only be written as a FITS file with the image data in the primary data unit. The image properties are written/converted to the primary FITS header. Definition at line 573 of file giimage.c. Referenced by giraffe_frame_create_image().
Sets the image data.
The function copies the pixel data of image into self. The pixel type of the source and the target image must match. If the type do not match the function returns an error. Definition at line 252 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_calibrate_flux(), giraffe_fov_build(), and giraffe_trim_raw_areas().
Attaches a property list to an image.
The function stores a copy of the property list properties in the image container self. If there is already a property list stored in the container self, it is replaced with the reference properties. If the properties cannot be copied, the function returns an error. Definition at line 320 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_calibrate_flux(), giraffe_compute_fiber_profiles(), giraffe_extract_spectra(), giraffe_fov_build(), and giraffe_localize_spectra(). |