Vis Flag Map Product

$SetSchemaPath vis/euc-vis-FlagMap.xsd

Data product name

$PrintDataProductName

Data product custodian

$PrintDataProductCustodian

Name of the Schema file

$PrintSchemaFilename

Last Edited for DPDD Version

1.1

Data product elements

$PrintDataProductElements

Processing Element(s) creating/using the data product

Flag Map

Processing function using the data product

VIS

Proposed for inclusion in EAS/SAS

Yes

Detailed description of the data product

Flag map is useful for selecting suitable objects in the image and removing invalid pixels.

The Flagmap data format is defined in the data model.

Table

Bit

Bit Mask

Flag Value

Flag Name

0

0x00000001

1

INVALID

1

0x00000002

2

HOT

2

0x00000004

4

COLD

3

0x00000008

8

SAT

4

0x00000010

16

COSMIC

5

0x00000020

32

GHOST

6

0x00000040

64

QUADEDGE

7

0x00000080

128

BAD_COLUMN

8

0x00000100

256

BAD_CLUSTER

9

0x00000200

512

CR_REGION

12

0x00001000

4,096

OVRCOL

13

0x00002000

8,192

EXTOBJ

14

0x00004000

16,384

SCATLIGHT

15

0x00008000

32,768

CHARINJ

17

0x00020000

131,072

SATXTALKGHOST

18

0x00040000

262,144

STARSIGNAL

19

0x00080000

524,288

SATURATEDSTAR

20

0x00100000

1,048,576

CTICORRECTION

21

0x00200000

2,097,152

ADCMAX

22

0x00400000

4,194,304

NO_DATA

23

0x00800000

8,388,608

STITCHBLOCK

24

0x01000000

16,777,216

OBJECTS

Flags description :

Bit 0 - INVALID

Convenience flag, combination of several vis flags identifying pixels with an arbitrary value which shall not be used for anything.

Bit 1 - HOT

Hot pixel: defective always bright pixel.

Bit 2 - COLD

Cold pixel: defective unresponsive pixel.

Bit 3 - SAT

Saturated pixel: pixel near or above blooming threshold.

Bit 4 - COSMIC

Cosmic ray: pixel affected by a cosmic ray.

Bit 5 - GHOST

Optical ghost: pixel affected by an optical ghost.

Bit 6 - QUADEDGE

Quadrant edge: pixel near a quadrant edge, which causes pixel-size and nonlinear response variations.

Bit 7 - BAD_COLUMN

Part of a column of bad pixels which have an abnormal behaviour, e.g. hot, cold, low noise, high noise.

Bit 8 - BAD_CLUSTER

Secondary bad pixel which is part of a cluster of immediate neighbours of hot or cold pixels.

Bit 9 - CR_REGION

Pixel belonging to a region in which detected cosmic rays per pixel ratio is too high for correct processing.

Bit 12 - OVRCOL

Overflow column: pixel affected by a neighbouring saturated pixel.

Bit 13 - EXTOBJ

Extended object: pixel part of an extended astronomical object.

Bit 14 - SCATLIGHT

Scattered light: pixel affected by non diffuse scattered light.

Bit 15 - CHARINJ

Charge injection: pixel part of charge injection line, not exposed.

Bit 17 - SATXTALKGHOST

Saturated crosstalk ghost: pixel affected by electronic crosstalk caused by a saturated pixel.

Bit 18 - STARSIGNAL

Star signal: pixel affected by a star psf.

Bit 19 - SATURATEDSTAR

Saturated star: pixel affected by a saturated star psf.

Bit 20 - CTICORRECTION

Charge transfer inefficiency correction: pixel affected by cti correction by more than 1 (tbd) adu.

Bit 21 - ADCMAX

Analog-to-digital-converter maximum: pixel at maximum adc value (65,535) before vis processing.

Bit 22 - NO_DATA

No data available for this pixel (being 0 adu in vis input raw frame), due to transmission error, truncated/incomplete raw file, failing quadrant, ccd or roe, or anything else.

Bit 23 - STITCHBLOCK

Photolithographic stitch-block boundary: pixel may have a non-nominal size.

Bit 24 - OBJECTS

Detected objects in science image, currently non-zero pixels in objects sextractor check-image.