Giraffe Images
Functions | |
| GiImage * | giraffe_image_new (cpl_type type) |
| Creates an empty image container. | |
| GiImage * | giraffe_image_create (cpl_type type, cxint nx, cxint ny) |
| Creates an image container of a given type. | |
| GiImage * | giraffe_image_duplicate (const GiImage *self) |
| Creates a copy of an image. | |
| void | giraffe_image_delete (GiImage *self) |
| Destroys an image. | |
| cpl_image * | giraffe_image_get (const GiImage *self) |
| Gets the image data. | |
| cxint | giraffe_image_set (GiImage *self, cpl_image *image) |
| Sets the image data. | |
| cpl_propertylist * | giraffe_image_get_properties (const GiImage *self) |
| Get the properties of an image. | |
| cxint | giraffe_image_set_properties (GiImage *self, cpl_propertylist *properties) |
| Attaches a property list to an image. | |
| cxint | giraffe_image_copy_matrix (GiImage *self, cpl_matrix *matrix) |
| Copies matrix elements into an image. | |
| cxint | giraffe_image_load_pixels (GiImage *self, const cxchar *filename, cxint position, cxint plane) |
| Gets image data from a file. | |
| cxint | giraffe_image_load_properties (GiImage *self, const cxchar *filename, cxint position) |
| Gets image properties from a file. | |
| cxint | giraffe_image_load (GiImage *self, const cxchar *filename, cxint position) |
| Gets image data and properties from a file. | |
| cxint | giraffe_image_save (GiImage *self, const cxchar *filename) |
| Write a Giraffe image to a file. | |
| cxint | giraffe_image_paste (GiImage *self, const GiImage *image, cxint x, cxint y, cxbool clip) |
| Paste an image into another at a given position. | |
| void | giraffe_image_print (GiImage *self) |
| Prints status information about a Giraffe image. | |
| cxint | giraffe_image_add_info (GiImage *image, const GiRecipeInfo *info, const cpl_frameset *set) |
| Add additional frame information to an image. | |
Detailed Description
The 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 775 of file giimage.c. References giraffe_add_frameset_info(), giraffe_add_recipe_info(), giraffe_image_get_properties(), and GiRecipeInfo::sequence. |
|
||||||||||||
|
Copies matrix elements into an image.
Definition at line 354 of file giimage.c. Referenced by giraffe_compute_fiber_profiles(), and giraffe_localize_spectra(). |
|
||||||||||||||||
|
Creates an image container of a given type.
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.
Definition at line 189 of file giimage.c. Referenced by giraffe_extract_spectra(), giraffe_image_create(), giraffe_rebinning_destroy(), giraffe_reconstruction_build(), giraffe_reconstruction_destroy(), and giraffe_wavelength_calibration(). |
|
|
Creates a copy of an image.
Definition at line 147 of file giimage.c. References giraffe_image_new(). Referenced by giraffe_reconstruction_build(). |
|
|
Gets the image data.
Definition at line 227 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_calibrate_wavelength(), giraffe_compute_fiber_profiles(), giraffe_extract_spectra(), giraffe_frame_create_image(), giraffe_image_paste(), giraffe_integrate_flux(), giraffe_localize_spectra(), giraffe_reconstruction_build(), giraffe_stacking_average(), giraffe_stacking_ksigma(), giraffe_stacking_median(), giraffe_stacking_minmax(), giraffe_subtract_dark(), giraffe_transmission_apply(), giraffe_transmission_compute(), giraffe_trim_raw_areas(), giraffe_wavelength_calibration(), and giraffe_wlsolution_create(). |
|
|
Get the properties of an image.
Definition at line 291 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_calibrate_wavelength(), giraffe_compute_fiber_profiles(), giraffe_extract_spectra(), giraffe_frame_create_image(), giraffe_get_raw_areas(), giraffe_grating_create(), giraffe_grating_setup(), giraffe_image_add_info(), giraffe_integrate_flux(), giraffe_localize_spectra(), giraffe_rebin_spectra(), giraffe_reconstruction_build(), giraffe_subtract_dark(), giraffe_transmission_compute(), giraffe_trim_raw_areas(), giraffe_wavelength_calibration(), and giraffe_wlsolution_create(). |
|
||||||||||||||||
|
Gets image data and properties from a file.
In case the file contains a data cube at position position the plane number 0 is loaded.
Definition at line 540 of file giimage.c. References giraffe_image_load_pixels(), and giraffe_image_load_properties(). |
|
||||||||||||||||||||
|
Gets image data from a file.
Definition at line 460 of file giimage.c. Referenced by giraffe_image_load(). |
|
||||||||||||||||
|
Gets image properties from a file.
If there are already properties associated to an image they will be replaced by calling this function. Definition at line 497 of file giimage.c. Referenced by giraffe_image_load(). |
|
|
Creates an empty image container.
Definition at line 73 of file giimage.c. Referenced by giraffe_image_create(), giraffe_image_duplicate(), and giraffe_wavelength_calibration(). |
|
||||||||||||||||||||||||
|
Paste an image into another at a given position.
true, the image image is properly clipped, if parts of image would fall outside of the destination image because of the given coordinates x and y. If clip is false and the source image does not fit entirely into the destination image the function fails and the error code CPL_ERROR_ACCESS_OUT_RANGE is set.
Definition at line 657 of file giimage.c. References giraffe_image_get(). |
|
|
Prints status information about a Giraffe image.
|
|
||||||||||||
|
Write a Giraffe image to a file.
Definition at line 574 of file giimage.c. Referenced by giraffe_frame_create_image(). |
|
||||||||||||
|
Sets the image data.
Definition at line 253 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), and giraffe_trim_raw_areas(). |
|
||||||||||||
|
Attaches a property list to an image.
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 321 of file giimage.c. Referenced by giraffe_adjust_scattered_light(), giraffe_bias_remove(), giraffe_compute_fiber_profiles(), and giraffe_localize_spectra(). |
