Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 234 / 357

234 PICam™ 5.x Programmer’s Manual Issue 11
7.4.5.5 PicamAdvanced_GetStarDefectMaps()
Description
PicamAdvanced_GetStarDefectMaps()
returns an allocated array of arrays/maps in
which star defect information for a specific camera is stored. All star defect maps for the
camera are returned. If there is more than one map, only one map applies based on the
current camera parameters. The value of the
PicamParameter
_ApplicableStarDefectMapID will specify which one. Alternatively,
PicamAdvanced_GetStarDefectMaps()
can be called to get the applicable map.
Syntax
The syntax for
PicamAdvanced_GetStarDefectMaps()
is:
PICAM_API PicamAdvanced_GetStarDefectMaps(
PicamHandle camera
const PicamStarDefectMap** star_defect_map_array
piint* star_defect_map_count);
Input Parameters
Input parameters for
PicamAdvanced_GetStarDefectMaps()
are:
Output Parameters
Output parameters for
PicamAdvanced_GetStarDefectMaps()
are:
Related APIs
For additional information, refer to the following related APIs:
• PicamAdvanced_DestroyStarDefectMaps()
• PicamAdvanced_GetStarDefectMaps()
Related Structures
For additional information, refer to the following related structures:
• PicamStarDefectMap
camera:
Handle for the camera for which
PicamPixelDefectMap
is to be
returned.
Valid values are:
•
device
handle;
• model handle.
NOTE:
device
and
model
share the same
PicamStarDefectMap .
star_defect_map
_array:
Pointer to the array of
PicamStarDefectMap
arrays in which star
defect information is stored.
When no information is available for the specified camera, this is an
array containing one array describing zero defects.
NOTE:
This memory is allocated by PICam and must be released
by calling
PicamAdvanced_DestroyStarDefectMaps()
star_defect_map
_count:
Pointer to the memory location in which the number of star defect
maps is stored.