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

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

Loading...
Searching...
No Matches
hdrl_lacosmics.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_LACOSMICS_H_
21#define HDRL_LACOSMICS_H_
22
23/*-----------------------------------------------------------------------------
24 Includes
25 -----------------------------------------------------------------------------*/
26
27#include "hdrl_types.h"
28#include "hdrl_image.h"
29#include <cpl.h>
30
31CPL_BEGIN_DECLS
32
33/*-----------------------------------------------------------------------------
34 Functions prototypes
35 -----------------------------------------------------------------------------*/
36
37/*----------------------------------------------------------------------------
38 LaCosmic Parameters
39 ----------------------------------------------------------------------------*/
40 hdrl_parameter * hdrl_lacosmic_parameter_create(double, double, int);
41cpl_error_code hdrl_lacosmic_parameter_verify(const hdrl_parameter *) ;
42cpl_boolean hdrl_lacosmic_parameter_check(const hdrl_parameter *) ;
43
44/* Accessors */
45 double hdrl_lacosmic_parameter_get_sigma_lim(const hdrl_parameter *) ;
46 double hdrl_lacosmic_parameter_get_f_lim(const hdrl_parameter *) ;
47 int hdrl_lacosmic_parameter_get_max_iter(const hdrl_parameter *) ;
48
49/* Parameter Lists */
50cpl_parameterlist * hdrl_lacosmic_parameter_create_parlist(const char *,
51 const char *, const hdrl_parameter *);
52 hdrl_parameter * hdrl_lacosmic_parameter_parse_parlist(
53 const cpl_parameterlist *, const char *) ;
54
55/*----------------------------------------------------------------------------
56 LaCosmic Computation
57 ----------------------------------------------------------------------------*/
58
59cpl_mask * hdrl_lacosmic_edgedetect(
60 const hdrl_image * ima_in,
61 const hdrl_parameter * params) ;
62
63/*-----------------------------------------------------------------------------
64 Private declarations - must not be used outside of hdrl
65 -----------------------------------------------------------------------------*/
66
67#ifdef HDRL_USE_PRIVATE
68
69#endif
70
71CPL_END_DECLS
72
73#endif /* HDRL_LACOSMICS_H_ */
hdrl_types.h
hdrl_image.h
hdrl_parameter
struct _hdrl_parameter_ hdrl_parameter
Definition hdrl_parameter.h:27
hdrl_lacosmic_parameter_create_parlist
cpl_parameterlist * hdrl_lacosmic_parameter_create_parlist(const char *, const char *, const hdrl_parameter *)
Create parameter list for the LaCosmic computation.
Definition hdrl_lacosmics.c:222
hdrl_lacosmic_parameter_get_sigma_lim
double hdrl_lacosmic_parameter_get_sigma_lim(const hdrl_parameter *)
Access the sigma_lim in the LaCosmic parameter.
Definition hdrl_lacosmics.c:172
hdrl_lacosmic_edgedetect
cpl_mask * hdrl_lacosmic_edgedetect(const hdrl_image *ima_in, const hdrl_parameter *params)
Detect bad-pixels / cosmic-rays on a single image.
Definition hdrl_lacosmics.c:348
hdrl_lacosmic_parameter_get_max_iter
int hdrl_lacosmic_parameter_get_max_iter(const hdrl_parameter *)
Access the max_iter in the LaCosmic parameter.
Definition hdrl_lacosmics.c:200
hdrl_lacosmic_parameter_verify
cpl_error_code hdrl_lacosmic_parameter_verify(const hdrl_parameter *)
Verify basic correctness of the LaCosmic parameters.
Definition hdrl_lacosmics.c:132
hdrl_lacosmic_parameter_parse_parlist
hdrl_parameter * hdrl_lacosmic_parameter_parse_parlist(const cpl_parameterlist *, const char *)
Parse parameterlist to create input parameters for the LaCosmic.
Definition hdrl_lacosmics.c:276
hdrl_lacosmic_parameter_get_f_lim
double hdrl_lacosmic_parameter_get_f_lim(const hdrl_parameter *)
Access the f_lim in the LaCosmic parameter.
Definition hdrl_lacosmics.c:186
hdrl_lacosmic_parameter_check
cpl_boolean hdrl_lacosmic_parameter_check(const hdrl_parameter *)
Check that the parameter is an LaCosmic parameter.
Definition hdrl_lacosmics.c:160
hdrl_lacosmic_parameter_create
CPL_BEGIN_DECLS hdrl_parameter * hdrl_lacosmic_parameter_create(double, double, int)
Creates LaCosmic parameters object.
Definition hdrl_lacosmics.c:112
_hdrl_image_
Definition hdrl_image_defs.h:40