These are methods for manipulating the vircam_mask bad pixel mask objects.
More...
These are methods for manipulating the vircam_mask bad pixel mask objects.
- Author
- Jim Lewis, CASU
void vircam_mask_clear |
( |
vir_mask * |
m | ) |
|
- Name:
- vircam_mask_clear
- Purpose:
- Delete internal workspace associated with a mask object, but keep the object itself intact.
- Description:
- All of the internal workspace in a mask object is freed. The the memory holding the mask object itself is left alone.
- Language:
- C
- Parameters
-
m | The input vir_mask object |
- Returns
- Nothing
- Author
- Jim Lewis, CASU
Definition at line 349 of file vircam_mask.c.
Referenced by vircam_mask_delete().
vir_mask* vircam_mask_define |
( |
cpl_frameset * |
framelist, |
|
|
cpl_size * |
labels, |
|
|
cpl_size |
nlab |
|
) |
| |
- Name:
- vircam_mask_define
- Purpose:
- Define a mask type from a given input frameset
- Description
- An input frameset is searched for either a master bad pixel mask or a master confidence map. (BPM is searched for first). If one of them is found then the frame is returned along with a flag defining the mask type.
- Language:
- C
- Parameters
-
framelist | The input frame list |
labels | The input frame list labels |
nlab | The number of labels |
- Returns
- The mask structure
- Author
- Jim Lewis, CASU
Definition at line 86 of file vircam_mask.c.
References vircam_frameset_subgroup_1().
void vircam_mask_delete |
( |
vir_mask * |
m | ) |
|
- Name:
- vircam_mask_delete
- Purpose:
- Delete internal workspace associated with a mask object, then delete the object itself.
- Description:
- All of the internal workspace in a mask object is freed. The the memory holding the mask object itself is freed.
- Language:
- C
- Parameters
-
m | The input vir_mask object |
- Returns
- Nothing
- Author
- Jim Lewis, CASU
Definition at line 268 of file vircam_mask.c.
References vircam_mask_clear().
void vircam_mask_force |
( |
vir_mask * |
m, |
|
|
int |
nx, |
|
|
int |
ny |
|
) |
| |
- Name:
- vircam_mask_force
- Purpose:
- Forces a predefined mask out of the structure to be replaced by a MASK_NONE type.
- Description:
- This routine is used as a catch-all in case there is a problem in loading an extension of a mask with vircam_mask_load. In that case calling this routine will force out the old mask definition and replace it with a safe MASK_NONE option.
- Language:
- C
- Parameters
-
m | The input vir_mask object |
nx | The X size of the mask array |
ny | The Y size of the mask array |
- Returns
- Nothing
- Author
- Jim Lewis, CASU
Definition at line 385 of file vircam_mask.c.
unsigned char* vircam_mask_get_data |
( |
vir_mask * |
m | ) |
|
const char* vircam_mask_get_filename |
( |
vir_mask * |
m | ) |
|
- Name:
- vircam_mask_get_filename
- Purpose:
- Get the filename from a vir_mask structure
- Description:
- Get the filename from a vir_mask structure
- Language:
- C
- Parameters
-
m | The input vir_mask object |
- Returns
- The char pointer to the file name
- Author
- Jim Lewis, CASU
Definition at line 438 of file vircam_mask.c.
vir_fits* vircam_mask_get_fits |
( |
vir_mask * |
m | ) |
|
- Name:
- vircam_mask_get_fits
- Purpose:
- Get the vir_fits structure from a mask object
- Description:
- Get the vir_fits structure from a mask object
- Language:
- C
- Parameters
-
m | The input vir_mask object |
- Returns
- The vir_fits structure from the mask object
- Author
- Jim Lewis, CASU
Definition at line 415 of file vircam_mask.c.
Referenced by vircam_mask_get_data(), and vircam_mkconf().
int vircam_mask_get_size_x |
( |
vir_mask * |
m | ) |
|
int vircam_mask_get_size_y |
( |
vir_mask * |
m | ) |
|
int vircam_mask_get_type |
( |
vir_mask * |
m | ) |
|
- Name:
- vircam_mask_get_type
- Purpose:
- Get the mask type
- Description:
- Get the mask type
- Language:
- C
- Parameters
-
m | The input vir_mask object |
- Returns
- The mask type. See vircam_mask.h for more details
- Author
- Jim Lewis, CASU
Definition at line 512 of file vircam_mask.c.
Referenced by vircam_mkconf().
int vircam_mask_load |
( |
vir_mask * |
m, |
|
|
int |
nexten, |
|
|
int |
nx, |
|
|
int |
ny |
|
) |
| |
- Name:
- vircam_mask_load
- Purpose:
- Load the image from an input mask object
- Description:
- The image from an input vir_mask object is loaded
- Language:
- C
- Parameters
-
m | The input mask object |
nexten | The image extension that you want to load. |
nx | The X dimension of the data array (in case the image is undefined) |
ny | The Y dimension of the data array (in case the image is undefined) |
- Returns
- The usual vircam status variable
- Author
- Jim Lewis, CASU
Definition at line 210 of file vircam_mask.c.
References vircam_fits_delete(), vircam_fits_get_image(), and vircam_fits_load().
vir_mask* vircam_mask_wrap_bpm |
( |
unsigned char * |
inbpm, |
|
|
int |
nx, |
|
|
int |
ny |
|
) |
| |
- Name:
- vircam_mask_wrap_bpm
- Purpose:
- Wrap a bpm data array in a vir_mask structure
- Description:
- A skeletal vir_mask structure is created and a given bad pixel mask is copied to the data array
- Language:
- C
- Parameters
-
inbpm | The input bad pixel map |
nx | The X dimension of the map |
ny | The Y dimension of the map |
- Returns
- The input bad pixel mask wrapped as vir_mask structure
- Author
- Jim Lewis, CASU
Definition at line 301 of file vircam_mask.c.
References vircam_fits_wrap().
vir_mask* vircam_objmask_define |
( |
cpl_frame * |
frame | ) |
|
- Name:
- vircam_objmask_define
- Purpose:
- Define a mask structure from an object mask frame
- Description
- A mask structure is defined from an input object mask frame. These behave just like a bad pixel mask.
- Language:
- C
- Parameters
-
- Returns
- The mask structure
- Author
- Jim Lewis, CASU
Definition at line 159 of file vircam_mask.c.