sakura.h

Go to the documentation of this file.

/*
 * @SAKURA_LICENSE_HEADER_START@
 * Copyright (C) 2013-2022
 * Inter-University Research Institute Corporation, National Institutes of Natural Sciences
 * 2-21-1, Osawa, Mitaka, Tokyo, 181-8588, Japan.
 * 
 * This file is part of Sakura.
 * 
 * Sakura is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * Sakura is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Sakura.  If not, see <http://www.gnu.org/licenses/>.
 * @SAKURA_LICENSE_HEADER_END@
 */
#ifndef LIBSAKURA_LIBSAKURA_SAKURA_H_
#define LIBSAKURA_LIBSAKURA_SAKURA_H_
 
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
 
#include <libsakura/config.h>
 
#if defined(__GNUC__) || defined(__GNUG__)
#       define LIBSAKURA_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#else
#       define LIBSAKURA_WARN_UNUSED_RESULT /* Don't ignore result value */
#endif
 
#define LIBSAKURA_NOEXCEPT /* noexcept */
 
#ifdef __cplusplus
extern "C" {
 
#if __cplusplus >= 201103L
# undef LIBSAKURA_NOEXCEPT
# define LIBSAKURA_NOEXCEPT noexcept
#endif
 
#endif
 
typedef enum {
}LIBSAKURA_SYMBOL (Status);
 
typedef void *(*LIBSAKURA_SYMBOL(UserAllocator))(size_t size);
 
typedef void (*LIBSAKURA_SYMBOL(UserDeallocator))(void *pointer);
 
LIBSAKURA_SYMBOL(UserAllocator) allocator,
LIBSAKURA_SYMBOL(UserDeallocator) deallocator)
                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
void LIBSAKURA_SYMBOL(CleanUp)() LIBSAKURA_NOEXCEPT;
 
/*
 * memory alignment(for SIMD)
 */
bool LIBSAKURA_SYMBOL(IsAligned)(void const *ptr) LIBSAKURA_NOEXCEPT;
 
size_t LIBSAKURA_SYMBOL (GetAlignment)() LIBSAKURA_NOEXCEPT;
 
void *LIBSAKURA_SYMBOL(AlignAny)(size_t size_of_arena, void *arena,
                size_t size_required) LIBSAKURA_NOEXCEPT;
float *LIBSAKURA_SYMBOL(AlignFloat)(size_t elements_in_arena, float *arena,
                size_t elements_required) LIBSAKURA_NOEXCEPT;
 
double *LIBSAKURA_SYMBOL(AlignDouble)(size_t elements_in_arena, double *arena,
                size_t elements_required) LIBSAKURA_NOEXCEPT;
 
typedef struct {
        size_t count;
        double sum;
        double square_sum;
        float min;
        float max;
        ssize_t index_of_min;
        ssize_t index_of_max;
}LIBSAKURA_SYMBOL(StatisticsResultFloat);
 
                size_t num_data, float const data[], bool const is_valid[],
                LIBSAKURA_SYMBOL(StatisticsResultFloat) *result) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[], bool const is_valid[],
                LIBSAKURA_SYMBOL(StatisticsResultFloat) *result) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, bool const is_valid[], float data[],
                size_t *new_num_data) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(ComputeMedianAbsoluteDeviationFloat)(
                size_t num_data, float const data[], float new_data[])
                                LIBSAKURA_NOEXCEPT;
 
                size_t num_spectra, size_t start_spectrum, size_t end_spectrum,
                bool const spectrum_mask[/*num_spectra*/],
                double const x[/*num_spectra*/], double const y[/*num_spectra*/],
                size_t support, size_t sampling, size_t num_polarizations,
                uint32_t const polarization_map[/*num_polarizations*/],
                size_t num_channels, uint32_t const channel_map[/*num_channels*/],
                bool const mask/*[num_spectra][num_polarizations]*/[/*num_channels*/],
                float const value/*[num_spectra][num_polarizations]*/[/*num_channels*/],
                float const weight/*[num_spectra]*/[/*num_channels*/], bool weight_only,
                size_t num_convolution_table/*= ceil(sqrt(2.)*(support+1)*sampling)*/,
                float const convolution_table[/*num_convolution_table*/],
                size_t num_polarizations_for_grid, size_t num_channels_for_grid,
                size_t width, size_t height,
                double weight_sum/*[num_polarizations_for_grid]*/[/*num_channels_for_grid*/],
                float weight_of_grid/*[height][width][num_polarizations_for_grid]*/[/*num_channels_for_grid*/],
                float grid/*[height][width][num_polarizations_for_grid]*/[/*num_channels_for_grid*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                size_t num_data, float const data[/*num_data*/], size_t num_condition,
                float const lower_bounds[/*num_condition*/],
                float const upper_bounds[/*num_condition*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                size_t num_data, int const data[/*num_data*/], size_t num_condition,
                int const lower_bounds[/*num_condition*/],
                int const upper_bounds[/*num_condition*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[/*num_data*/], size_t num_condition,
                float const lower_bounds[/*num_condition*/],
                float const upper_bounds[/*num_condition*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                size_t num_data, int const data[/*num_data*/], size_t num_condition,
                int const lower_bounds[/*num_condition*/],
                int const upper_bounds[/*num_condition*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[/*num_data*/], float threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, int const data[/*num_data*/], int threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[/*num_data*/], float threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, int const data[/*num_data*/], int threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[/*num_data*/], float threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, int const data[/*num_data*/], int threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[/*num_data*/], float threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, int const data[/*num_data*/], int threshold,
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                size_t num_data, float const data[/*num_data*/],
                bool result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
                uint8_t const data[/*num_data*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                uint32_t const data[/*num_data*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                bool const data[/*num_data*/], bool result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                uint8_t bit_mask, size_t num_data, uint8_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint8_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
                uint32_t bit_mask, size_t num_data, uint32_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint32_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                uint8_t bit_mask, size_t num_data, uint8_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint8_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
                uint32_t bit_mask, size_t num_data, uint32_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint32_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                uint8_t bit_mask, size_t num_data, uint8_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint8_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
                uint32_t bit_mask, size_t num_data, uint32_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint32_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                size_t num_data, uint8_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint8_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
                size_t num_data, uint32_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint32_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                uint8_t bit_mask, size_t num_data, uint8_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint8_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
                uint32_t bit_mask, size_t num_data, uint32_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint32_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
                uint8_t bit_mask, size_t num_data, uint8_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint8_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
                uint32_t bit_mask, size_t num_data, uint32_t const data[/*num_data*/],
                bool const edit_mask[/*num_data*/], uint32_t result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
typedef enum {
 
 
 
 
}LIBSAKURA_SYMBOL(InterpolationMethod);
 
LIBSAKURA_SYMBOL(InterpolationMethod) interpolation_method,
                uint8_t polynomial_order, size_t num_base,
                double const base_position[/*num_base*/], size_t num_array,
                float const base_data[/*num_base*num_array*/],
                bool const base_mask[/*num_base*num_array*/], size_t num_interpolated,
                double const interpolated_position[/*num_interpolated*/],
                float interpolated_data[/*num_interpolated*num_array*/],
                bool interpolated_mask[/*num_interpolated*num_array*/])
                                LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(InterpolationMethod) interpolation_method,
                uint8_t polynomial_order, size_t num_base,
                double const base_position[/*num_base*/], size_t num_array,
                float const base_data[/*num_base*num_array*/],
                bool const base_mask[/*num_base*num_array*/], size_t num_interpolated,
                double const interpolated_position[/*num_interpolated*/],
                float interpolated_data[/*num_interpolated*num_array*/],
                bool interpolated_mask[/*num_interpolated*num_array*/])
                                LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(CalibrateDataWithArrayScalingFloat)(
                size_t num_data, float const scaling_factor[/*num_data*/],
                float const data[/*num_data*/], float const reference[/*num_data*/],
                float result[/*num_data*/]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(CalibrateDataWithConstScalingFloat)(
                float scaling_factor, size_t num_data, float const data[/*num_data*/],
                float const reference[/*num_data*/], float result[/*num_data*/])
                                LIBSAKURA_NOEXCEPT;
 
struct LIBSAKURA_SYMBOL(Convolve1DContextFloat);
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(CreateGaussianKernelFloat)(
                float peak_location, float kernel_width, size_t num_kernel, float kernel[])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(CreateConvolve1DContextFFTFloat)(
                size_t num_kernel, float const kernel[/*num_kernel*/],
                struct LIBSAKURA_SYMBOL(Convolve1DContextFloat) **context)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                float const kernel[/*num_kernel*/], size_t num_data,
                float const input_data[/*num_data*/],
                bool const input_mask[/*num_data*/], float output_data[/*num_data*/],
                float output_weight[/*num_data*/]) LIBSAKURA_NOEXCEPT;
                struct LIBSAKURA_SYMBOL(Convolve1DContextFloat) const *context,
                size_t num_data, float const input_data[/*num_data*/],
                float output_data[/*num_data*/]) LIBSAKURA_NOEXCEPT;
                struct LIBSAKURA_SYMBOL(Convolve1DContextFloat) *context)
                                LIBSAKURA_NOEXCEPT;
 
                size_t const num_data, float const data[/*num_data*/],
                bool const mask[/*num_data*/], size_t const num_model_bases,
                double const basis_data[/*num_model_bases*num_data*/],
                size_t const num_lsq_bases,
                size_t const use_bases_idx[/*num_lsq_bases*/],
                double lsq_matrix[/*num_lsq_bases*num_lsq_bases*/],
                double lsq_vector[/*num_lsq_bases*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                size_t const num_data, float const data[/*num_data*/],
                bool const mask[/*num_data*/], size_t const num_exclude_indices,
                size_t const exclude_indices[/*num_data*/],
                size_t const num_model_bases,
                double const basis_data[/*num_model_bases*num_data*/],
                size_t const num_lsq_bases,
                size_t const use_bases_idx[/*num_lsq_bases*/],
                double lsq_matrix[/*num_lsq_bases*num_lsq_bases*/],
                double lsq_vector[/*num_lsq_bases*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                size_t num_equations,
                double const in_matrix[/*num_equations*num_equations*/],
                double const in_vector[/*num_equations*/],
                double out[/*num_equations*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
//LM part----------------------------------------------------------------
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(LMFitGaussianFloat)(
                size_t const num_data, float const data[/*num_data*/],
                bool const mask[/*num_data*/], size_t const num_peaks,
                double height[/*num_peaks*/], double err_height[/*num_peaks*/],
                double center[/*num_peaks*/], double err_center[/*num_peaks*/],
                double sigma[/*num_peaks*/], double err_sigma[/*num_peaks*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
typedef enum {
 
 
 
}LIBSAKURA_SYMBOL(LSQFitStatus);
 
typedef enum {
 
 
}LIBSAKURA_SYMBOL(LSQFitType);
 
struct LIBSAKURA_SYMBOL(LSQFitContextFloat);
 
LIBSAKURA_SYMBOL(LSQFitType) const lsqfit_type, uint16_t order, size_t num_data,
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) **context)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                uint16_t npiece, size_t num_data,
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) **context)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                uint16_t nwave, size_t num_data,
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) **context)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) *context)
                                LIBSAKURA_NOEXCEPT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                uint16_t order, size_t num_data, float const data[/*num_data*/],
                bool const mask[/*num_data*/], float clip_threshold_sigma,
                uint16_t num_fitting_max, size_t num_coeff, double coeff[/*num_coeff*/],
                float best_fit[/*num_data*/], float residual[/*num_data*/],
                bool final_mask[/*num_data*/], float *rms,
                LIBSAKURA_SYMBOL(LSQFitStatus) *lsqfit_status)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                size_t num_pieces, size_t num_data, float const data[/*num_data*/],
                bool const mask[/*num_data*/], float clip_threshold_sigma,
                uint16_t num_fitting_max, double coeff[/*num_pieces*/][4],
                float best_fit[/*num_data*/], float residual[/*num_data*/],
                bool final_mask[/*num_data*/], float *rms,
                size_t boundary[/*num_pieces+1*/],
                LIBSAKURA_SYMBOL(LSQFitStatus) *lsqfit_status)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                size_t num_nwave, size_t const nwave[/*num_nwave*/], size_t num_data,
                float const data[/*num_data*/], bool const mask[/*num_data*/],
                float clip_threshold_sigma, uint16_t num_fitting_max, size_t num_coeff,
                double coeff[/*num_coeff*/], float best_fit[/*num_data*/],
                float residual[/*num_data*/], bool final_mask[/*num_data*/], float *rms,
                LIBSAKURA_SYMBOL(LSQFitStatus) *lsqfit_status)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                size_t num_data, float const data[/*num_data*/], size_t num_coeff,
                double const coeff[/*num_coeff*/], float out[/*num_data*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                size_t num_data, float const data[/*num_data*/], size_t num_pieces,
                double const coeff[/*num_pieces*/][4],
                size_t const boundary[/*num_pieces+1*/], float out[/*num_data*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                size_t num_data, float const data[/*num_data*/], size_t num_nwave,
                size_t const nwave[/*num_nwave*/], size_t num_coeff,
                double const coeff[/*num_coeff*/], float out[/*num_data*/])
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
                struct LIBSAKURA_SYMBOL(LSQFitContextFloat) const *context,
                uint16_t order, size_t *num_coeff)
                                LIBSAKURA_NOEXCEPT LIBSAKURA_WARN_UNUSED_RESULT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(FlipArrayFloat)(
                bool inner_most_untouched, size_t dims, size_t const elements[],
                float const src[], float dst[]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(UnflipArrayFloat)(
                bool inner_most_untouched, size_t dims, size_t const elements[],
                float const src[], float dst[]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(FlipArrayDouble)(
                bool inner_most_untouched, size_t dims, size_t const elements[],
                double const src[], double dst[]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(UnflipArrayDouble)(
                bool inner_most_untouched, size_t dims, size_t const elements[],
                double const src[], double dst[]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(FlipArrayDouble2)(
                bool inner_most_untouched, size_t dims, size_t const elements[],
                double const src[][2], double dst[][2]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(UnflipArrayDouble2)(
                bool inner_most_untouched, size_t dims, size_t const elements[],
                double const src[][2], double dst[][2]) LIBSAKURA_NOEXCEPT;
 
LIBSAKURA_SYMBOL(Status) LIBSAKURA_SYMBOL(CreateMaskNearEdgeDouble)(
                float fraction, double pixel_size, size_t num_data, double const x[],
                double const y[], double const *blc_x, double const *blc_y,
                double const *trc_x, double const *trc_y, bool mask[]);
 
#ifdef __cplusplus
}
/* extern "C" */
#endif
 
#endif /* LIBSAKURA_LIBSAKURA_SAKURA_H_ */