High-Level Data Reduction Library: hdrl_bpm_utils.h Source File

High-Level Data Reduction Library 1.6.0 High-Level data reduction routines for ESO pipelines

Loading...
Searching...
No Matches
hdrl_bpm_utils.h
Go to the documentation of this file.
1/*
2 * This file is part of the HDRL
3 * Copyright (C) 2013 European Southern Observatory
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20#ifndef HDRL_BPM_UTILS_H
21#define HDRL_BPM_UTILS_H
22
23/*-----------------------------------------------------------------------------
24 Includes
25 -----------------------------------------------------------------------------*/
26
27#include <cpl.h>
28#include <stdint.h>
29#include "hdrl_image.h"
30#include "hdrl_imagelist.h"
31
32CPL_BEGIN_DECLS
33
34/*-----------------------------------------------------------------------------
35 Functions prototypes
36 -----------------------------------------------------------------------------*/
37
38cpl_mask * hdrl_bpm_filter(const cpl_mask *, cpl_size, cpl_size, cpl_filter_mode) ;
39cpl_imagelist * hdrl_bpm_filter_list(const cpl_imagelist *, cpl_size, cpl_size,
40 cpl_filter_mode) ;
41
42/*-----------------------------------------------------------------------------
43 Private declarations - must not be used outside of hdrl
44 -----------------------------------------------------------------------------*/
45
46#ifdef HDRL_USE_PRIVATE
47cpl_mask * hdrl_bpm_to_mask(const cpl_image *, uint64_t) ;
48cpl_image * hdrl_mask_to_bpm(const cpl_mask *, uint64_t) ;
49cpl_error_code hdrl_set_masks_on_imagelist(cpl_imagelist *, cpl_mask **) ;
50cpl_error_code hdrl_join_mask_on_imagelist(cpl_imagelist *, cpl_mask *,
51 cpl_mask ***);
52#endif
53
54CPL_END_DECLS
55
56#endif
hdrl_image.h
hdrl_imagelist.h
hdrl_mask_to_bpm
cpl_image * hdrl_mask_to_bpm(const cpl_mask *mask, uint64_t flag)
convert cpl_mask to bad pixel information mask
Definition hdrl_bpm_utils.c:221
hdrl_bpm_to_mask
cpl_mask * hdrl_bpm_to_mask(const cpl_image *bpm, uint64_t selection)
convert bad pixel information mask to a cpl_mask
Definition hdrl_bpm_utils.c:192
hdrl_bpm_filter
CPL_BEGIN_DECLS cpl_mask * hdrl_bpm_filter(const cpl_mask *, cpl_size, cpl_size, cpl_filter_mode)
Allows the growing and shrinking of bad pixel masks. It can be used to e.g. set pixels to bad if the ...
Definition hdrl_bpm_utils.c:121
hdrl_bpm_filter_list
cpl_imagelist * hdrl_bpm_filter_list(const cpl_imagelist *, cpl_size, cpl_size, cpl_filter_mode)
Wrapper around hdrl_bpm_filter() to filter list of images.
Definition hdrl_bpm_utils.c:63
hdrl_join_mask_on_imagelist
cpl_error_code hdrl_join_mask_on_imagelist(cpl_imagelist *list, cpl_mask *new_mask, cpl_mask ***pold_mask)
join mask with existing masks in an imagelist
Definition hdrl_bpm_utils.c:292
hdrl_set_masks_on_imagelist
cpl_error_code hdrl_set_masks_on_imagelist(cpl_imagelist *list, cpl_mask **masks)
apply array of masks to an image list
Definition hdrl_bpm_utils.c:263