pmMaskBadPixels.h File Reference

---

Detailed Description

Given an input image, a bad pixel mask, a corresponding value in the bad pixel mask to mask, a saturation level, and a growing radius, mask in the input image those pixels in the bad pixel mask that match the value to mask.

Given an input image, in, a bad pixel mask, a corresponding value in the bad pixel mask to mask in the input image, maskVal, a saturation level, and a growing radius, pmMaskBadPixels shall mask in the input image those pixels in the bad pixel mask that match the value to mask. Note that the input image, in, is modified in-place. All pixels in the mask which satisfy the maskVal shall have their corresponding pixels masked in the input image, in. All pixels which satisfy the growVal shall have their corresponding pixels, along with all pixels within the grow radius masked. Pixels which have flux greater than sat shall also be masked, but not grown. Note that the input image, in, and the mask need not be the same size, since the input image may already have been trimmed (following overscan subtraction), but the function shall use the offsets in the image (in->x0 and in->y0) to determine the appropriate offsets to obtain the correct pixel on the mask. In the event that the mask image is too small (i.e., pixels on the input image refer to pixels outside the range of the mask image), the function shall generate an error.

Author:

Ross Harman, MHPCC

Version:

Revision

1.1

Name

rel5_1

Date:

Date

2004/09/17 00:49:04

Copyright 2004 Maui High Performance Computing Center, University of Hawaii

Definition in file pmMaskBadPixels.h.

#include "pslib.h"

Include dependency graph for pmMaskBadPixels.h:

Go to the source code of this file.

Defines
#define	MAX(A, B)   ((A)>=(B)?(A):(B))
	Macro to find maximum of two numbers.
#define	MIN(A, B)   ((A)<=(B)?(A):(B))
	Macro to find minimum of two numbers.
Enumerations
enum	pmMaskValue { PM_MASK_TRAP = 0x0001, PM_MASK_BADCOL = 0x0002, PM_MASK_SAT = 0x0004, PM_MASK_FLAT = 0x0008 }
	Mask values. More...
Functions
bool	pmMaskBadPixels (psReadout *in, const psImage *mask, unsigned int maskVal, float sat, unsigned int growVal, int grow)
	Execute bad pixels module.

---

Define Documentation

#define MAX (  A, B   )     ((A)>=(B)?(A):(B))

Macro to find maximum of two numbers. Definition at line 38 of file pmMaskBadPixels.h.

#define MIN (  A, B   )     ((A)<=(B)?(A):(B))

Macro to find minimum of two numbers. Definition at line 41 of file pmMaskBadPixels.h.

---

Enumeration Type Documentation

enum pmMaskValue

Mask values. Enumeration values: PM_MASK_TRAP  The pixel is a charge trap. PM_MASK_BADCOL  The pixel is a bad column. PM_MASK_SAT  The pixel is saturated. PM_MASK_FLAT  The pixel is non-positive in the flat-field. Definition at line 30 of file pmMaskBadPixels.h.

---

Function Documentation

bool pmMaskBadPixels (  psReadout *  in, const psImage *  mask, unsigned int  maskVal, float  sat, unsigned int  growVal, int  grow )

Execute bad pixels module. Given an input image, a bad pixel mask, a corresponding value in the bad pixel mask to mask, a saturation level, and a growing radius, mask in the input image those pixels in the bad pixel mask that match the value to mask. Returns: bool: True or false for success or failure Parameters: in  Readout containing input image data. mask  Mask data to be added to readout mask data. maskVal  Mask value to determine what to add to input mask. sat  Saturation limit to mask bad pixels. growVal  Mask data to determine if a circurlar area should be masked. grow  Radius of mask to apply around pixel.

---