OMEGA Pipeline Reference Manual  1.0.5
Functions
Bad Pixel Mask related functions

Functions

cpl_image * clean_deadpix_median (cpl_image *dirty, cpl_mask *dead, int boxsize)
 Create an image of its dead pixels.
cpl_mask * create_saturated_map (const cpl_frame *frame, int oc, int ext, cpl_parameterlist *spars)
 Create a map of the satured pixels of an image.
cpl_image * create_weightframe (cpl_image *flat, cpl_image *bpmsatu, cpl_mask *cosmic, cpl_mask *satellite)
 Create a Weight Image Map for a science image.
cpl_mask * makebpm (const cpl_frame *hot, const cpl_frame *cold, int cxn)
 Create a bad pixels map.
cpl_mask * omega_bpm_create (cpl_image *img, cpl_parameterlist *pars)
cpl_mask * omega_saturated_map (cpl_image *trim, int oc, cpl_parameterlist *spars)
 Create a map of the saturated pixels of an image.

Detailed Description

This module provides functions to deal with bad pixel masks

Synopsis:
Functions to deal with bad pixel masks
#include "omega_dfs.h"
#include "omega_stats.h"
#include "omega_utils.h"
#include "omega_bpm.h"
#include "omega_trim.h"

Function Documentation

cpl_image* clean_deadpix_median ( cpl_image *  dirty,
cpl_mask *  dead,
int  boxsize 
)

Create an image of its dead pixels.

    Replace dead pixels by the median of the correct neighbors in a
  [-boxsize/2, boxsize/2] neighborhood around each pixel. If no
  correct pixel can be found in the 8 neighbors, the pixel is set to
  zero.
Parameters:
dirtyimage Image to clean
deadmap Dead pixel map
boxsizeSize of clean box
Returns:
Newly allocated, clean image Converted from OMEGA Eclipse image_clean_deadpix_median (dead_pixels.c)
Deprecated:
Unstable API, may change or disappear. Do not use in new code!

Definition at line 84 of file omega_bpm.c.

cpl_mask* create_saturated_map ( const cpl_frame *  frame,
int  oc,
int  ext,
cpl_parameterlist *  spars 
)

Create a map of the satured pixels of an image.

Parameters:
frameFrame where to create map from
ocInteger giving the overscan method to apply
extInteger of FITS extension
sparsParameters list
Returns:
mask Returns a cpl_mask of the saturated pixels in the image or NULL in case of error.
Deprecated:
Unstable API, may change or disappear. Do not use in new code!

Definition at line 244 of file omega_bpm.c.

References TrimOscanCorrect().

cpl_image* create_weightframe ( cpl_image *  flat,
cpl_image *  bpmsatu,
cpl_mask *  cosmic,
cpl_mask *  satellite 
)

Create a Weight Image Map for a science image.

      This function will perform logical AND in all maps
      created (BPM, Saturated map, cosmic map and satellite map)
      to create a final Weight Map
Parameters:
flatflatfield image
bpmsatucombined BPM and saturated mask
cosmiccosmic rays mask
satellitesatellite tracks mask
Returns:
weight weight map image

Definition at line 370 of file omega_bpm.c.

Referenced by omega_jitter_process(), and omega_std_process().

cpl_mask* makebpm ( const cpl_frame *  hot,
const cpl_frame *  cold,
int  cxn 
)

Create a bad pixels map.

    It takes a hot and/or a cold pixels map
  and creates a AND combination of them to
  make a Bad pixels Map.
Parameters:
hotHot pixels frame
coldCold pixels frame
cxnExtension number of FITS file to load from
Returns:
bpm A cpl_mask

Definition at line 191 of file omega_bpm.c.

Referenced by omega_mdome_combine(), and omega_mflat_combine().

cpl_mask* omega_bpm_create ( cpl_image *  img,
cpl_parameterlist *  pars 
)
Deprecated:
Unstable API, may change or disappear. Do not use in new code!

Definition at line 430 of file omega_bpm.c.

References omega_create_background().

cpl_mask* omega_saturated_map ( cpl_image *  trim,
int  oc,
cpl_parameterlist *  spars 
)

Create a map of the saturated pixels of an image.

Parameters:
trimTrimmed science image
ocInteger giving the overscan method to apply
sparsParameters list
Returns:
mask Returns a cpl_mask of the saturated pixels in the image or NULL in case of error.

Definition at line 304 of file omega_bpm.c.

Referenced by omega_jitter_process(), and omega_std_process().