Field of View Reconstruction
Functions | |
cxint | giraffe_fov_build (GiFieldOfView *result, GiRebinning *rebinning, GiTable *fibers, GiTable *wsolution, GiTable *grating, GiTable *slitgeometry, GiFieldOfViewConfig *config) |
Create and image and a data cube from extracted and rebinned spectra. | |
GiFieldOfView * | giraffe_fov_new (void) |
Create an empty container for the results of the field of view reconstruction. | |
void | giraffe_fov_clear (GiFieldOfView *self) |
Delete the contents of a field of view object. | |
void | giraffe_fov_delete (GiFieldOfView *self) |
Deallocate a field of view object and its contents. | |
cxint | giraffe_fov_save_cubes (const GiFieldOfView *self, cpl_propertylist *properties, const cxchar *filename, cxptr data) |
Write the cube components of a field-of-view object to a file. | |
cxint | giraffe_fov_save_cubes_eso3d (const GiFieldOfView *self, cpl_propertylist *properties, const cxchar *filename, cxptr data) |
Write the cube components of a field-of-view object to a file. | |
GiFieldOfViewConfig * | giraffe_fov_config_create (cpl_parameterlist *list) |
Creates a setup structure for the field of view reconstruction. | |
void | giraffe_fov_config_destroy (GiFieldOfViewConfig *config) |
Destroys a field of view setup structure. | |
void | giraffe_fov_config_add (cpl_parameterlist *list) |
Adds parameters for the image and data cube construction. |
Detailed Description
The module provides the functions to create data cubes and field of view images, which are constructed from the resampled spectra images.Function Documentation
cxint giraffe_fov_build | ( | GiFieldOfView * | result, | |
GiRebinning * | rebinning, | |||
GiTable * | fibers, | |||
GiTable * | wsolution, | |||
GiTable * | grating, | |||
GiTable * | slitgeometry, | |||
GiFieldOfViewConfig * | config | |||
) |
Create and image and a data cube from extracted and rebinned spectra.
- Parameters:
-
result The results of the image and data cube creation. rebinning The extracted and rebinned spectra. fibers The fiber setup wsolution The dispersion solution grating The grating table slitgeometry The slit geometry config Setup parameters for reconstruction task.
- Returns:
- The function returns 0 on success and a non-zero value otherwise.
Definition at line 435 of file gifov.c.
References GiFieldOfViewConfig::cube, GiFieldOfView::cubes, GiRebinning::errors, GiFieldOfView::errors, GiFieldOfView::fov, giraffe_cube_delete(), giraffe_cube_get_height(), giraffe_cube_get_width(), giraffe_cube_get_zaxis(), giraffe_cube_set_wcs(), giraffe_cube_sqrt(), giraffe_fiberlist_get_subslits(), giraffe_fov_clear(), giraffe_get_mode(), giraffe_image_delete(), giraffe_image_duplicate(), giraffe_image_get(), giraffe_image_get_properties(), giraffe_image_new(), giraffe_image_set(), giraffe_image_set_properties(), giraffe_range_delete(), giraffe_range_get_max(), giraffe_range_get_min(), giraffe_range_set_max(), giraffe_range_set_min(), giraffe_rebin_get_wavelength_range(), giraffe_table_get(), GiFieldOfView::images, GiFieldOfViewConfig::maximum, GiFieldOfViewConfig::minimum, GiFieldOfView::mode, GiRebinning::spectra, GiFieldOfView::spectra, and GiFieldOfView::ssn.
void giraffe_fov_clear | ( | GiFieldOfView * | self | ) |
Delete the contents of a field of view object.
- Parameters:
-
self The field of view object to be emptied.
- Returns:
- Nothing.
Definition at line 1385 of file gifov.c.
References GiFieldOfView::cubes, GiFieldOfView::errors, GiFieldOfView::fov, giraffe_cube_delete(), giraffe_image_delete(), GiFieldOfView::images, GiFieldOfView::spectra, and GiFieldOfView::ssn.
Referenced by giraffe_fov_build(), and giraffe_fov_delete().
void giraffe_fov_config_add | ( | cpl_parameterlist * | list | ) |
GiFieldOfViewConfig* giraffe_fov_config_create | ( | cpl_parameterlist * | list | ) |
void giraffe_fov_config_destroy | ( | GiFieldOfViewConfig * | config | ) |
void giraffe_fov_delete | ( | GiFieldOfView * | self | ) |
Deallocate a field of view object and its contents.
- Parameters:
-
self The field of view object to destroy.
- Returns:
- Nothing.
Definition at line 1452 of file gifov.c.
References giraffe_fov_clear().
GiFieldOfView* giraffe_fov_new | ( | void | ) |
Create an empty container for the results of the field of view reconstruction.
- Returns:
- A newly allocated and empty field of view container.
cxint giraffe_fov_save_cubes | ( | const GiFieldOfView * | self, | |
cpl_propertylist * | properties, | |||
const cxchar * | filename, | |||
cxptr | data | |||
) |
Write the cube components of a field-of-view object to a file.
- Parameters:
-
self A field-of-view object properties The property list to save with the object filename The name of the output file data Pointer to an integer which specifies which cube component will be saved.
- Returns:
- The function returns
0
on success, or a non-zero number in case an error occurred.
0
the spectrum cube will be saved, and the error cube is saved in case of a non-zero value.
Definition at line 1488 of file gifov.c.
References giraffe_cube_save(), GiFieldOfView::mode, and GiFieldOfView::ssn.
cxint giraffe_fov_save_cubes_eso3d | ( | const GiFieldOfView * | self, | |
cpl_propertylist * | properties, | |||
const cxchar * | filename, | |||
cxptr | data | |||
) |
Write the cube components of a field-of-view object to a file.
- Parameters:
-
self A field-of-view object properties The property list to save with the object filename The name of the output file data Unused.
- Returns:
- The function returns
0
on success, or a non-zero number in case an error occurred.
Definition at line 1631 of file gifov.c.
References GiFieldOfView::cubes, GiFieldOfView::errors, giraffe_cube_save(), GiFieldOfView::mode, GiFieldOfView::spectra, and GiFieldOfView::ssn.