Loading...
Searching...
No Matches
LatticeStatsDataProviderBase.h
Go to the documentation of this file.
//# Copyright (C) 2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef LATTICES_LATTICESTATSDATAPROVIDERBASE_H
#define LATTICES_LATTICESTATSDATAPROVIDERBASE_H
#include <casacore/scimath/StatsFramework/StatsDataProvider.h>
#include <casacore/scimath/Mathematics/NumericTraits.h>
#include <casacore/lattices/Lattices/LatticeIterator.h>
#include <casacore/lattices/LatticeMath/LattStatsProgress.h>
#include <casacore/casa/aips.h>
namespace casacore {
class LatticeProgress;
// Abstract base class of data providers which allows stats framework to iterate through a lattice.
template <class T> class LatticeStatsDataProviderBase
: public StatsDataProvider<typename NumericTraits<T>::PrecisionType, const T*, const Bool*> {
public:
virtual ~LatticeStatsDataProviderBase();
// estimated number of steps to iterate through the the lattice
virtual uInt estimatedSteps() const = 0;
virtual void finalize();
// Get the stride for the current mask (only called if hasMask() returns True).
uInt getMaskStride();
// Get the associated range(s) of the current dataset. Only called if hasRanges() returns True;
std::vector<std::pair<typename NumericTraits<T>::PrecisionType, typename NumericTraits<T>::PrecisionType> > getRanges();
// Get the stride for the current data set.
uInt getStride();
// Returns NULL; lattices do not have associated weights.
const T* getWeights();
// Does the current data set have associated range(s)?
Bool hasRanges() const;
// returns False; lattices do not have associated weights.
Bool hasWeights() const;
// If the associated data set has ranges, are these include (return True) or
// exclude (return False) ranges?
Bool isInclude() const;
// get the positions of the min and max
void minMaxPos(IPosition& minpos, IPosition& maxpos) const;
virtual void reset();
void setProgressMeter(std::shared_ptr<LattStatsProgress> pm);
// set the data ranges
void setRanges(
const std::vector<std::pair<typename NumericTraits<T>::PrecisionType, typename NumericTraits<T>::PrecisionType> >& ranges,
Bool isInclude
);
protected:
LatticeStatsDataProviderBase();
void _updateMaxPos(const IPosition& maxPos) { _maxPos = maxPos; }
void _updateMinPos(const IPosition& minPos) { _minPos = minPos; }
void _updateProgress();
private:
Bool _hasRanges, _isInclude;
std::vector<std::pair<typename NumericTraits<T>::PrecisionType, typename NumericTraits<T>::PrecisionType> > _ranges;
std::shared_ptr<LattStatsProgress> _progressMeter;
IPosition _minPos, _maxPos;
};
}
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LatticeMath/LatticeStatsDataProviderBase.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
casacore::IPosition
Definition IPosition.h:117
casacore::LatticeProgress
Definition LatticeProgress.h:83
casacore::LatticeStatsDataProviderBase::isInclude
Bool isInclude() const
If the associated data set has ranges, are these include (return True) or exclude (return False) rang...
casacore::LatticeStatsDataProviderBase::finalize
virtual void finalize()
Take any actions necessary to finalize the provider.
casacore::LatticeStatsDataProviderBase::_isInclude
Bool _isInclude
Definition LatticeStatsDataProviderBase.h:99
casacore::LatticeStatsDataProviderBase::setRanges
void setRanges(const std::vector< std::pair< typename NumericTraits< T >::PrecisionType, typename NumericTraits< T >::PrecisionType > > &ranges, Bool isInclude)
set the data ranges
casacore::LatticeStatsDataProviderBase::getRanges
std::vector< std::pair< typename NumericTraits< T >::PrecisionType, typename NumericTraits< T >::PrecisionType > > getRanges()
Get the associated range(s) of the current dataset.
casacore::LatticeStatsDataProviderBase::~LatticeStatsDataProviderBase
virtual ~LatticeStatsDataProviderBase()
casacore::LatticeStatsDataProviderBase::_ranges
std::vector< std::pair< typename NumericTraits< T >::PrecisionType, typename NumericTraits< T >::PrecisionType > > _ranges
Definition LatticeStatsDataProviderBase.h:100
casacore::LatticeStatsDataProviderBase::_minPos
IPosition _minPos
Definition LatticeStatsDataProviderBase.h:102
casacore::LatticeStatsDataProviderBase::_hasRanges
Bool _hasRanges
Definition LatticeStatsDataProviderBase.h:99
casacore::LatticeStatsDataProviderBase::getMaskStride
uInt getMaskStride()
Get the stride for the current mask (only called if hasMask() returns True).
casacore::LatticeStatsDataProviderBase::minMaxPos
void minMaxPos(IPosition &minpos, IPosition &maxpos) const
get the positions of the min and max
casacore::LatticeStatsDataProviderBase::_updateMaxPos
void _updateMaxPos(const IPosition &maxPos)
Definition LatticeStatsDataProviderBase.h:92
casacore::LatticeStatsDataProviderBase::reset
virtual void reset()
reset the provider to point to the beginning of the first data set it manages.
casacore::LatticeStatsDataProviderBase::setProgressMeter
void setProgressMeter(std::shared_ptr< LattStatsProgress > pm)
casacore::LatticeStatsDataProviderBase::hasRanges
Bool hasRanges() const
Does the current data set have associated range(s)?
casacore::LatticeStatsDataProviderBase::_updateProgress
void _updateProgress()
casacore::LatticeStatsDataProviderBase::getStride
uInt getStride()
Get the stride for the current data set.
casacore::LatticeStatsDataProviderBase::_maxPos
IPosition _maxPos
Definition LatticeStatsDataProviderBase.h:102
casacore::LatticeStatsDataProviderBase::LatticeStatsDataProviderBase
LatticeStatsDataProviderBase()
casacore::LatticeStatsDataProviderBase::_updateMinPos
void _updateMinPos(const IPosition &minPos)
Definition LatticeStatsDataProviderBase.h:94
casacore::LatticeStatsDataProviderBase::estimatedSteps
virtual uInt estimatedSteps() const =0
estimated number of steps to iterate through the the lattice
casacore::LatticeStatsDataProviderBase::getWeights
const T * getWeights()
Returns NULL; lattices do not have associated weights.
casacore::LatticeStatsDataProviderBase::hasWeights
Bool hasWeights() const
returns False; lattices do not have associated weights.
casacore::LatticeStatsDataProviderBase::_progressMeter
std::shared_ptr< LattStatsProgress > _progressMeter
Definition LatticeStatsDataProviderBase.h:101
casacore::NumericTraits::PrecisionType
Char PrecisionType
Higher precision type (Float->Double).
Definition NumericTraits.h:230
casacore::StatsDataProvider< NumericTraits< T >::PrecisionType, const T *, const Bool * >::StatsDataProvider
StatsDataProvider()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40