/usr/include/openturns/WelchFactory.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief Top-level class for all spectral model factories
*
* Copyright 2005-2017 Airbus-EDF-IMACS-Phimeca
*
* This library 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.
*
* This library 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
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef OPENTURNS_WELCHFACTORY_HXX
#define OPENTURNS_WELCHFACTORY_HXX
#include "openturns/SpectralModelFactoryImplementation.hxx"
#include "openturns/UserDefinedSpectralModel.hxx"
#include "openturns/FilteringWindows.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class WelchFactory
*/
class OT_API WelchFactory
: public SpectralModelFactoryImplementation
{
CLASSNAME;
public:
/** Default constructor */
WelchFactory();
/** Standard constructor using a filtering windows and a frequency limit*/
WelchFactory(const FilteringWindows & window,
const UnsignedInteger blockNumber,
const Scalar overlap = 0.5);
/** Virtual constructor */
virtual WelchFactory * clone() const;
/** String converter */
String __repr__() const;
/** String converter */
String __str__(const String & offset = "") const;
/** FilteringWindows accessor */
FilteringWindows getFilteringWindows() const;
void setFilteringWindows(const FilteringWindows & window);
/** Number of block accessor */
UnsignedInteger getBlockNumber() const;
void setBlockNumber(const UnsignedInteger blockNumber);
/** Overlap accessor */
Scalar getOverlap() const;
void setOverlap(const Scalar overlap);
/** Build a spectral model based on a sample */
Implementation build(const ProcessSample & sample) const;
/** Build a spectral model based on a Field */
Implementation build(const Field & timeSerie) const;
/** Build a spectral model based on a sample */
UserDefinedSpectralModel buildAsUserDefinedSpectralModel(const ProcessSample & sample) const;
/** Build a spectral model based on a sample */
UserDefinedSpectralModel buildAsUserDefinedSpectralModel(const Field & timeSeries) const;
/** Method save() stores the object through the StorageManager */
void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(Advocate & adv);
private:
/** FilteringWindows */
FilteringWindows window_;
/** Size of a block */
UnsignedInteger blockNumber_;
/** Overlap percentage for Welch method */
Scalar overlap_;
}; /* class WelchFactory */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_WELCHFACTORY_HXX */
|