#include <qsenormalizer.h>

Inheritance diagram for QseNormalizer:

Public Member Functions
	QseNormalizer (QseDataSet inData, QseDataSet outData, const QString &name, QObject *parent=0)

void	exec ()

bool	matchesScanPattern (int n)

bool	matchesScan (int n)

double	energyScalingRatio ()

void	normalizeScan (int n, QseScan *out)

void	setScanException (int s, QseScanRole role)

void	setColumnException (int s, int c, QseColumnRole role)

bool	matchesScanException (int s)

bool	matchesColumnException (int s, int c)

QseColumnRole	exceptionalColumnRole (int s, int c)

QseColumnRole	patternColumnRole (int s, int c)

QseColumnRole	columnRole (int s, int c)

Public Member Functions inherited from QseEXAFSOperator
	QseEXAFSOperator (QseDataSet inData, QseDataSet outData, const QString &name, QObject *parent=0)

QseDataSet *	inputData ()

QseDataSet *	outputData ()

bool	matchesEnergyPattern (const QseColumn *col, int colnum)

bool	matchesEnergyColumn (const QseColumn *col, int colnum)

bool	matchesDetectorPattern (const QseColumn *col, int colnum)

bool	matchesDetectorColumn (const QseColumn *col, int colnum)

bool	matchesNormalizationPattern (const QseColumn *col, int colnum)

bool	matchesNormalizationColumn (const QseColumn *col, int colnum)

bool	matchesSecondsPattern (const QseColumn *col, int colnum)

bool	matchesSecondsColumn (const QseColumn *col, int colnum)

bool	matchesCopyPattern (const QseColumn *col, int colnum)

bool	matchesCopyColumn (const QseColumn *col, int colnum)

bool	matchesCopyNormalizedPattern (const QseColumn *col, int colnum)

bool	matchesCopyNormalizedColumn (const QseColumn *col, int colnum)

bool	matchesCopyRatePattern (const QseColumn *col, int colnum)

bool	matchesCopyRateColumn (const QseColumn *col, int colnum)

bool	matchesCopyTotalCountsPattern (const QseColumn *col, int colnum)

bool	matchesCopyTotalCountsColumn (const QseColumn *col, int colnum)

Public Member Functions inherited from QseOperator
	QseOperator (const QString &name, QObject *parent=0)

QString	name () const

void	setName (const QString &name)

void	addParameter (QseParameter *parameter)

Protected Attributes
QseRegExpParameter	m_ScanPattern

QseStringParameter	m_MinScanRowCount

QseStringParameter	m_MaxScanRowCount

QseStringParameter	m_MinScanColumnCount

QseStringParameter	m_MaxScanColumnCount

QseEnumParameter	m_InputEnergyUnits

QseEnumParameter	m_OutputEnergyUnits

Protected Attributes inherited from QseEXAFSOperator
QseDataSet *	m_InputData

QseDataSet *	m_OutputData

QseRegExpParameter	m_EnergyPattern

QseRegExpParameter	m_DetectorPattern

QseRegExpParameter	m_NormalizationPattern

QseRegExpParameter	m_SecondsPattern

QseRegExpParameter	m_CopyPattern

QseRegExpParameter	m_CopyNormalizedPattern

QseRegExpParameter	m_CopyRatePattern

QseRegExpParameter	m_CopyTotalCountsPattern

QHash< const QseScan *, QseScanRole >	m_ScanExceptions

QHash< const QseColumn *, QseColumnRole >	m_Exceptions

Friends
class	QseNormalizerUI

Additional Inherited Members
Public Types inherited from QseEXAFSOperator
enum	QseScanRole { UnspecifiedScanRole = -1, ScanNotUsedRole, ScanUsedRole }

enum	QseColumnRole { UnspecifiedRole = -1, NotUsedRole, DetectorRole, NormalizationRole, EnergyRole, SecondsRole, CopyRole, CopyNormalizedRole, CopyRateRole, CopyTotalCountsRole }

Signals inherited from QseOperator
void	message (const QString &msg)

Static Public Member Functions inherited from QseEXAFSOperator
static QColor	colorForRole (QseColumnRole r)

static QColor	backgroundColorForRole (QseColumnRole r)

Detailed Description

Definition at line 14 of file qsenormalizer.h.

Constructor & Destructor Documentation

QseNormalizer::QseNormalizer	(	QseDataSet *	inData,
		QseDataSet *	outData,
		const QString &	name,
		QObject *	parent = `0`
	)

Definition at line 8 of file qsenormalizer.cpp.

   : QseEXAFSOperator(inData, outData, name, parent),
     m_ScanPattern(this, "scanpattern",NULL),
     m_MinScanRowCount(this, "minscanrowcount", NULL),
     m_MaxScanRowCount(this, "maxscanrowcount", NULL),
     m_MinScanColumnCount(this, "minscancolumncount", NULL),
     m_MaxScanColumnCount(this, "maxscancolumncount", NULL),
     m_InputEnergyUnits(this, QStringList()<<"eV"<<"keV",
                        "inputenergyunits", NULL),
     m_OutputEnergyUnits(this, QStringList()<<"eV"<<"keV",
                         "outputenergyunits", NULL)
 {
   m_InputEnergyUnits.setValue(1);
   m_OutputEnergyUnits.setValue(1);
 }

Member Function Documentation

QseNormalizer::QseColumnRole QseNormalizer::columnRole	(	int	s,
		int	c
	)

Definition at line 347 of file qsenormalizer.cpp.

References exceptionalColumnRole(), patternColumnRole(), and QseEXAFSOperator::UnspecifiedRole.

 {
   QseColumnRole role = exceptionalColumnRole(s, c);
 
   if (role != UnspecifiedRole) {
     return role;
   } else {
     return patternColumnRole(s, c);
   }
 }

double QseNormalizer::energyScalingRatio ( )

Definition at line 237 of file qsenormalizer.cpp.

References m_InputEnergyUnits, m_OutputEnergyUnits, and QseParameter::value().

Referenced by normalizeScan().

 {
   int inp = m_InputEnergyUnits.value().toInt();
   int otp = m_OutputEnergyUnits.value().toInt();
 
   if (inp == otp) {
     return 1.0;
   } else if (inp == 0 && otp == 1) {
     return 0.001;
   } else if (inp == 1 && otp == 0) {
     return 1000.0;
   } else {
     return 1;
   }
 }

QseNormalizer::QseColumnRole QseNormalizer::exceptionalColumnRole	(	int	s,
		int	c
	)

Definition at line 303 of file qsenormalizer.cpp.

References QseEXAFSOperator::m_Exceptions, QseEXAFSOperator::m_InputData, and QseEXAFSOperator::UnspecifiedRole.

Referenced by columnRole(), and QseNormalizerModel::data().

 {
   QseScan* scan = m_InputData -> scan(s);
 
   if (scan) {
     QseColumn* col = scan -> column(c);
 
     if (m_Exceptions.contains(col)) {
       return m_Exceptions[col];
     }
   }
 
   return UnspecifiedRole;
 }

void QseNormalizer::exec ( )

virtual

Implements QseOperator.

Definition at line 24 of file qsenormalizer.cpp.

References QseEXAFSOperator::m_InputData, QseEXAFSOperator::m_OutputData, matchesScan(), and normalizeScan().

Referenced by QseController::runNormalizer().

 {
 //   printf("QseNormalizer::exec()\n");
   QString fnam = m_InputData -> fileName();
 
   m_OutputData -> clear();
   m_OutputData -> setFileName(fnam+"_norm");
   m_OutputData -> setHeader(m_InputData -> header());
 
   int ns = m_InputData -> scanCount();
 
 //   printf("%d scans\n", ns);
 
   for (int s = 0; s < ns; s++) {
     if (matchesScan(s)) {
 //       printf("scan %d matches\n", s);
 
       QseScan *osc = m_OutputData -> appendScan();
 
       normalizeScan(s, osc);
     }
   }
 
 //   printf("%d output scans\n", m_OutputData -> scanCount());
 
   m_OutputData -> emitOperationCompleted();
 }

bool QseNormalizer::matchesColumnException	(	int	s,
		int	c
	)

Definition at line 290 of file qsenormalizer.cpp.

References QseEXAFSOperator::m_Exceptions, and QseEXAFSOperator::m_InputData.

 {
   QseScan* scan = m_InputData -> scan(s);
   
   if (scan) {
     QseColumn* col = scan -> column(c);
 
     return m_Exceptions.contains(col);
   } else {
     return false;
   }
 }

bool QseNormalizer::matchesScan ( int n )

Definition at line 95 of file qsenormalizer.cpp.

References QseScan::columnCount(), QseEXAFSOperator::m_InputData, m_MaxScanColumnCount, m_MaxScanRowCount, m_MinScanColumnCount, m_MinScanRowCount, QseEXAFSOperator::m_ScanExceptions, m_ScanPattern, QseScan::maxRowCount(), QseDataSet::scan(), QseScan::scanCommand(), QseEXAFSOperator::ScanUsedRole, QseEXAFSOperator::UnspecifiedScanRole, and QseParameter::value().

Referenced by exec().

 {
   QseScan* s = m_InputData->scan(n);
 
   if (s) {
     QseScanRole r = UnspecifiedScanRole;
 
     if (m_ScanExceptions.contains(s)) {
       r = m_ScanExceptions[s];
     }
 
     bool ok1, ok2;
 
     double minVal = m_MinScanRowCount.value().toDouble(&ok1);
     double maxVal = m_MaxScanRowCount.value().toDouble(&ok2);
         
     if (ok1 || ok2) {
       int nrows = s->maxRowCount();
 
       if (ok1 && (nrows < minVal)) {
         return false;
       }
 
       if (ok2 && (nrows > maxVal)) {
         return false;
       }
     }
 
     minVal = m_MinScanColumnCount.value().toDouble(&ok1);
     maxVal = m_MaxScanColumnCount.value().toDouble(&ok2);
         
     if (ok1 || ok2) {
       int ncols = s->columnCount();
 
       if (ok1 && (ncols < minVal)) {
         return false;
       }
 
       if (ok2 && (ncols > maxVal)) {
         return false;
       }
     }
 
     if (r == UnspecifiedScanRole) {
       return m_ScanPattern.value().toRegExp().exactMatch(s->scanCommand());
     } else {
       return r == ScanUsedRole;
     }
   } else {
     return false;
   }
 }

bool QseNormalizer::matchesScanException ( int s )

Definition at line 283 of file qsenormalizer.cpp.

References QseEXAFSOperator::m_InputData, and QseEXAFSOperator::m_ScanExceptions.

 {
   QseScan* scan = m_InputData -> scan(n);
 
   return m_ScanExceptions.contains(scan);
 }

bool QseNormalizer::matchesScanPattern ( int n )

Definition at line 52 of file qsenormalizer.cpp.

References QseScan::columnCount(), QseEXAFSOperator::m_InputData, m_MaxScanColumnCount, m_MaxScanRowCount, m_MinScanColumnCount, m_MinScanRowCount, m_ScanPattern, QseScan::maxRowCount(), QseDataSet::scan(), QseScan::scanCommand(), and QseParameter::value().

 {
   QseScan* s = m_InputData->scan(n);
 
   if (s) {
     bool ok1, ok2;
 
     double minVal = m_MinScanRowCount.value().toDouble(&ok1);
     double maxVal = m_MaxScanRowCount.value().toDouble(&ok2);
         
     if (ok1 || ok2) {
       int nrows = s->maxRowCount();
 
       if (ok1 && (nrows < minVal)) {
         return false;
       }
 
       if (ok2 && (nrows > maxVal)) {
         return false;
       }
     }
 
     minVal = m_MinScanColumnCount.value().toDouble(&ok1);
     maxVal = m_MaxScanColumnCount.value().toDouble(&ok2);
         
     if (ok1 || ok2) {
       int ncols = s->columnCount();
 
       if (ok1 && (ncols < minVal)) {
         return false;
       }
 
       if (ok2 && (ncols > maxVal)) {
         return false;
       }
     }
     
     return m_ScanPattern.value().toRegExp().exactMatch(s->scanCommand());
   } else {
     return false;
   }
 }

void QseNormalizer::normalizeScan	(	int	n,
		QseScan *	out
	)

Definition at line 148 of file qsenormalizer.cpp.

Referenced by exec().

 {
   QseScan *sc = m_InputData->scan(n);
 
   if (sc) {
     int nc = sc -> columnCount();
     int energycol = -1;
 
     for (int c = 0; c < nc; c++) {
       QseColumn *col = sc -> column(c);
 
       if (matchesEnergyColumn(col,c)) {
         energycol = c;
       }
     }
 
     if (energycol < 0) {
       emit message(QString("No energy column found for scan %1").arg(n));
     } else {
       osc -> mergeHeaders(sc->header());
       osc -> setScanNumber(sc->scanNumber());
       osc -> setName(sc->name()+"_norm");
       osc -> setScanCommand(sc->scanCommand()+"_norm");
       osc -> setScanDateTime(QDateTime::currentDateTime());
 
       QseColumn *energy = osc -> appendColumn("Energy", sc -> column(energycol));
       QseColumn *normal = osc -> appendColumn("Norm");
       QseColumn *detect = osc -> appendColumn("Detector");
       QseColumn *seconds = osc -> appendColumn("Seconds");
 
       energy -> multiplication(energyScalingRatio());
 
       int nnorm = 0, ndet = 0, nsecs = 0;
       
       for (int c = 0; c < nc; c++) {
         QseColumn *col = sc -> column(c);
 
         if (matchesNormalizationColumn(col,c)) {
           nnorm += 1;
           normal -> addition(col);
         } else if (matchesDetectorColumn(col,c)) {
           ndet += 1;
           detect -> addition(col);
         } else if (matchesSecondsColumn(col,c)) {
           nsecs += 1;
           seconds -> addition(col);
         }
       }
 
       if (nnorm > 0) {
         QseColumn *ratio = osc -> appendColumn("Ratio", detect);
         
         ratio -> division(normal);
         
         emit message(QString("Scan %1 had %2 detector columns, was normalized by %3 ion chambers").arg(n).arg(ndet).arg(nnorm));
       } else if (nsecs > 0) {
         QseColumn *ratio = osc -> appendColumn("Ratio", detect);
         
         ratio -> division(seconds);
         emit message(QString("Scan %1 had %2 detector columns, was normalized by counting time").arg(n).arg(ndet));
       } else {
         QseColumn *ratio = osc -> appendColumn("Ratio", detect);
         
         emit message(QString("Scan %1 had %2 detector columns, no normalization performed").arg(n).arg(ndet));
       }
 
       for (int c=0; c<nc; c++) {
         QseColumn *col = sc->column(c);
 
         if (matchesCopyNormalizedColumn(col, c)) {
           QseColumn *copy = osc->appendColumn(col->name(), col);
 
           copy->division(normal);
         } else if (matchesCopyRateColumn(col, c)) {
           QseColumn *copy = osc->appendColumn(col->name(), col);
 
           copy->division(seconds);
         } else if (matchesCopyTotalCountsColumn(col, c)) {
           QseColumn *copy = osc->appendColumn(col->name(), col);
 
           copy->multiplication(seconds);
         } else if (matchesCopyColumn(col, c)) {
           QseColumn *copy = osc->appendColumn(col->name(), col);
         }
       }
     }
   }
 }

QseNormalizer::QseColumnRole QseNormalizer::patternColumnRole	(	int	s,
		int	c
	)

Definition at line 318 of file qsenormalizer.cpp.

Referenced by columnRole(), and QseNormalizerModel::data().

 {
   QseScan* scan = m_InputData -> scan(s);
 
   if (scan) {
     QseColumn* col = scan -> column(c);
 
     if (matchesEnergyPattern(col, c)) {
       return EnergyRole;
     } else if (matchesDetectorPattern(col, c)) {
       return DetectorRole;
     } else if (matchesNormalizationPattern(col, c)) {
       return NormalizationRole;
     } else if (matchesSecondsPattern(col, c)) {
       return SecondsRole;
     } else if (matchesCopyNormalizedPattern(col, c)) {
       return CopyNormalizedRole;
     } else if (matchesCopyRatePattern(col, c)) {
       return CopyRateRole;
     } else if (matchesCopyTotalCountsPattern(col, c)) {
       return CopyTotalCountsRole;
     } else if (matchesCopyPattern(col, c)) {
       return CopyRole;
     }
   }
 
   return UnspecifiedRole;
 }

void QseNormalizer::setColumnException	(	int	s,
		int	c,
		QseColumnRole	role
	)

Definition at line 266 of file qsenormalizer.cpp.

References QseEXAFSOperator::m_Exceptions, QseEXAFSOperator::m_InputData, and QseEXAFSOperator::UnspecifiedRole.

 {
   QseScan* scan = m_InputData -> scan(s);
   
   if (scan) {
     QseColumn* col = scan -> column(c);
 
     if (col) {
       if (role == UnspecifiedRole) {
         m_Exceptions.remove(col);
       } else {
         m_Exceptions.insert(col,role);
       }
     }
   }
 }

void QseNormalizer::setScanException	(	int	s,
		QseScanRole	role
	)

Definition at line 253 of file qsenormalizer.cpp.

References QseEXAFSOperator::m_InputData, QseEXAFSOperator::m_ScanExceptions, and QseEXAFSOperator::UnspecifiedScanRole.

 {
   QseScan* scan = m_InputData -> scan(s);
 
   if (scan) {
     if (role == UnspecifiedScanRole) {
       m_ScanExceptions.remove(scan);
     } else {
       m_ScanExceptions.insert(scan,role);
     }
   }
 }