/usr/include/gpiv/gpiv-post.h is in libgpiv3-dev 0.6.1-4.3build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */
/*
libgpiv - library for Particle Image Velocimetry
Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Gerber van der Graaf
This file is part of libgpiv.
Libgpiv is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-----------------------------------------------------------------------
FILENAME: post.h
LIBRARY: libgpiv
SOURCE: post.c
EXTERNAL FUNCTIONS:
gpiv_post_manipiv
gpiv_post_savg
gpiv_post_uvhisto
gpiv_post_subtract_dxdy
gpiv_post_scale
gpiv_post_inverse_scale
gpiv_post_vorstra
------------------------------------------------------------------- */
/*!
\file gpiv-post.h
\brief module for post-processing of PIV data
SOURCES: lib/postc
LAST MODIFICATION DATE: $Id: gpiv-post.h,v 1.1 2007-11-23 16:12:18 gerber Exp $
*/
#ifndef __LIBGPIV_POST_H__
#define __LIBGPIV_POST_H__
#include <gpiv/gpiv-post_par.h>
/**
* Velocity component
*/
enum GpivVelComponent {
GPIV_U, /**< Horizontal (x, column-wise */
GPIV_V /**< Vertical (y, row-wise */
};
/**
* Piv post processing function to manipulate data; flipping rotating, etc.
*
* @param[in] piv_data PIV data to be manipulated in-place
* @param[in] post_par post-processing parameters
* @return NULL on success or error message on failure
*/
gchar *
gpiv_post_manipiv (GpivPivData *piv_data,
const GpivPostPar *post_par
);
/**
* Piv post processing function to calculate spatial mean, variances.
*
* @param[in] piv_data PIV data of which spatial average is calculated
* in-place
* @param[in] post_par post-processing parameters
* @return NULL on success or error message on failure
*/
gchar *
gpiv_post_savg (GpivPivData *piv_data,
const GpivPostPar *post_par
);
/**
* Calculating histogram of U (horizontal) or V (vertical) particle
* displacements.
*
* @param[in] piv_data PIV data
* @param[in] nbins number of bins that klass will contain
* @param[in] velcomp velocity component from which histogram is calculated
* @return GpivBinData on success or NULL on failure
*
*/
GpivBinData *
gpiv_post_uvhisto (const GpivPivData *piv_data,
const guint nbins,
const enum GpivVelComponent velcomp
);
/**
* Subtracts a specified quantity from the PIV displacements.
*
* @param[in] piv_data PIV data to be reduced in-place
* @param[in] z_off_dx value in horizontal direction to be subtracted
* @param[in] z_off_dy value in vertical direction to be subtracted
* @return NULL on success or error message on failure
*/
gchar *
gpiv_post_subtract_dxdy (GpivPivData *piv_data,
const gfloat z_off_dx,
const gfloat z_off_dy
);
/**
* Piv post processing function to adjust for time and spatial scales.
*
* @param[in] piv_data PIV data to be scaled in-place
* @param[in] image_par image parameter structure
* @return NULL on success or error message on failure
*/
gchar *
gpiv_post_scale (GpivPivData *piv_data,
const GpivImagePar *image_par
);
/**
* Piv post processing function to adjust for inversed time and spatial scales
*
* @param[in] piv_data PIV data to be scaled in-place
* @param[in] image_par image parameter structure
* @return NULL on success or error message on failure
*/
gchar *
gpiv_post_inverse_scale (GpivPivData *piv_data,
const GpivImagePar *image_par
);
/**
* Piv post processing function to calculate vorticity and strain.
*
* @param[in] piv_data PIV data from which derivatives are calculated
* @param[in] post_par post-processing parameters
* @return GpivScalarData containing vorticity or strain
*/
GpivScalarData *
gpiv_post_vorstra (const GpivPivData *piv_data,
const GpivPostPar *post_par
);
#endif /* __LIBGPIV_POST_H__ */
|