Wind3D.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2006, Copyright University Corporation for Atmospheric Research
 **
 ** This program 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 of the License, 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.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/

#ifndef NIDAS_DNYLD_ISFF_WIND3D_H
#define NIDAS_DNYLD_ISFF_WIND3D_H

#include <nidas/core/SerialSensor.h>
#include <nidas/core/AdaptiveDespiker.h>
#include <nidas/Config.h>
#include "WindOrienter.h"
#include "WindTilter.h"
#include "WindRotator.h"

#ifdef HAVE_LIBGSL
#include <gsl/gsl_linalg.h>
#endif

namespace nidas {

namespace dynld { namespace isff {

class Wind3D: public nidas::core::SerialSensor
{
public:

    Wind3D();

    ~Wind3D();

    bool process(const nidas::core::Sample* samp, 
        std::list<const nidas::core::Sample*>& results) throw();

    void setBias(int i, double val);

    double getBias(int i) const
    {
        return _bias[i];
    }

    double getVazimuth() const
    {
    return _rotator.getAngleDegrees();
    }

    void setVazimuth(double val)
    {
    _rotator.setAngleDegrees(val);
    }

    double getLeanDegrees() const
    {
    return _tilter.getLeanDegrees();
    }
    void setLeanDegrees(double val)
    {
    _tilter.setLeanDegrees(val);
    }

    double getLeanAzimuthDegrees() const
    {
    return _tilter.getLeanAzimuthDegrees();
    }
    void setLeanAzimuthDegrees(double val)
    {
    _tilter.setLeanAzimuthDegrees(val);
    }

    void setDespike(bool val)
    {
        _despike = val;
    }

    bool getDespike() const
    {
        return _despike;
    }

    void setMetek(int ismetek) {
        _metek = (ismetek == 1);
    }

    void setOutlierProbability(double val)
    {
    for (int i = 0; i < 4; i++)
        _despiker[i].setOutlierProbability(val);
    }

    double getOutlierProbability() const
    {
        return _despiker[0].getOutlierProbability();
    }

    void setDiscLevelMultiplier(double val)
    {
    for (int i = 0; i < 4; i++)
        _despiker[i].setDiscLevelMultiplier(val);
    }

    double getDiscLevelMultiplier() const
    {
        return _despiker[0].getDiscLevelMultiplier();
    }

    double getDiscLevel() const
    {
        return _despiker[0].getDiscLevel();
    }

    void setTcOffset(double val) 
    {
        _tcOffset = val;
    }

    double getTcOffset() const
    {
        return _tcOffset;
    }

    void setTcSlope(double val) 
    {
        _tcSlope = val;
    }

    double getTcSlope() const
    {
        return _tcSlope;
    }

    void setDoHorizontalRotation(bool val)
    {
        _horizontalRotation = val;
    }
        
    void setDoTiltCorrection(bool val)
    {
        _tiltCorrection = val;
    }

    void despike(nidas::core::dsm_time_t tt,float* uvwt,int n, bool* spikeOrMissing)
        throw();

    void offsetsTiltAndRotate(nidas::core::dsm_time_t tt, float* uvwt) throw();

    void applyOrientation(nidas::core::dsm_time_t tt, float* uvwt) throw();

    void readOffsetsAnglesCalFile(nidas::core::dsm_time_t tt) throw();

    void validate()
    throw(nidas::util::InvalidParameterException);

    void validateSscanfs() throw(nidas::util::InvalidParameterException);

    virtual void parseParameters() throw(nidas::util::InvalidParameterException);

    virtual void checkSampleTags() throw(nidas::util::InvalidParameterException);

#ifdef HAVE_LIBGSL

    virtual void getTransducerRotation(nidas::core::dsm_time_t tt) throw();

    virtual void transducerShadowCorrection(nidas::core::dsm_time_t, float *) throw();
#endif

protected:

    typedef nidas::dynld::isff::WindOrienter WindOrienter;
    typedef nidas::dynld::isff::WindRotator WindRotator;
    typedef nidas::dynld::isff::WindTilter WindTilter;

    static const int DATA_GAP_USEC = 60000000;

    nidas::core::dsm_time_t _ttlast[4];

    double _bias[3];

    bool _allBiasesNaN;

    bool _despike;
    
    bool _metek;

    nidas::core::AdaptiveDespiker _despiker[4];
 
    WindRotator _rotator;

    WindTilter _tilter;

    WindOrienter _orienter;

    double _tcOffset;

    double _tcSlope;

    bool _horizontalRotation;

    bool _tiltCorrection;

    nidas::core::dsm_sample_id_t _sampleId;

    int _diagIndex;

    int _ldiagIndex;

    int _spdIndex;

    int _dirIndex;

    unsigned int _noutVals;

    unsigned int _numParsed;

    nidas::core::CalFile* _oaCalFile;

#ifdef HAVE_LIBGSL

    nidas::core::CalFile* _atCalFile;

    double _atMatrix[3][3];

#define COMPUTE_ABC2UVW_INVERSE
#ifdef COMPUTE_ABC2UVW_INVERSE
    double _atInverse[3][3];
#else
    gsl_vector* _atVectorGSL1;
    gsl_vector* _atVectorGSL2;
#endif

    gsl_matrix* _atMatrixGSL;

    gsl_permutation* _atPermutationGSL;
#endif

    double _shadowFactor;

private:

    // no copying
    Wind3D(const Wind3D& x);

    // no assignment
    Wind3D& operator=(const Wind3D& x);
    
};

}}} // namespace nidas namespace dynld namespace isff

#endif