UltraScan III
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Private Member Functions
US_Convert Class Reference

#include "us_convert.h"

Classes

class  Excludes
 Class to contain a list of scans to exclude from a data set for a single c/c/w combination. More...
 
class  TripleInfo
 Class that contains information about relevant cell/channel/wavelength combinations. More...
 

Public Types

enum  ioError {
  OK, CANTOPEN, DUP_RUNID, NOPERSON,
  NODATA, NODB, NOAUC, NOXML,
  BADXML, BADGUID, PARTIAL_XML, NOT_WRITTEN
}
 Some status codes returned by the us_convert program. More...
 

Public Member Functions

 US_Convert (void)
 Generic constructor for the US_Convert class. This constructor establishes the dialog and its relationship to the parent dialog. More...
 

Static Public Member Functions

static void readLegacyData (QString, QList< US_DataIO::BeckmanRawScan > &, QString &)
 Reads the legacy raw data from disk into the program. More...
 
static void convertLegacyData (QList< US_DataIO::BeckmanRawScan > &, QVector< US_DataIO::RawData > &, QList< TripleInfo > &, QString, double)
 Converts legacy raw data into US3 data. This function will convert existing datapoints and cell/channel/wavelength combinations in the data. More...
 
static int saveToDisk (QVector< US_DataIO::RawData * > &, QList< TripleInfo > &, QVector< Excludes > &, QString, QString, QString, bool)
 Writes the converted US3 data to disk. More...
 
static int readUS3Disk (QString, QVector< US_DataIO::RawData > &, QList< TripleInfo > &, QString &)
 Reloads converted US3 data back into the program to sync up with the database. More...
 
static void splitRAData (QVector< US_DataIO::RawData > &, QList< TripleInfo > &, int, QList< double > &)
 Splits existing raw converted data into multiple datasets. Also rearranges triples in the data accordingly. More...
 

Static Private Member Functions

static void convert (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, US_DataIO::RawData &newRawData, QString triple, QString runType, double tolerance)
 
static void setTriples (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, QList< TripleInfo > &triples, QString runType, double tolerance)
 
static void setCcwTriples (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, QList< TripleInfo > &triples, double tolerance)
 
static void setCcrTriples (QList< US_DataIO::BeckmanRawScan > &rawLegacyData, QList< TripleInfo > &triples, double tolerance)
 
static void setInterpolated (unsigned char *, int)
 
static US_DataIO::Scan newScanSubset (US_DataIO::Scan &oldScan, QVector< double > &radii, double r_start, double r_end)
 

Detailed Description

This class provides the ability to convert raw data in the Beckman format to the file format used by US3.

Definition at line 12 of file us_convert.h.

Member Enumeration Documentation

Some status codes returned by the us_convert program.

Enumerator
OK 

Ok, no error.

CANTOPEN 

The file cannot be opened.

DUP_RUNID 

The given run ID already exists.

NOPERSON 

The person specified doesn't exist.

NODATA 

There is no data to read or write.

NODB 

Connection to database cannot be made.

NOAUC 

AUC File cannot be opened.

NOXML 

XML data has not been entered.

BADXML 

XML not formed correctly.

BADGUID 

GUID read in the XML was not found in the database.

PARTIAL_XML 

XML data has not been entered for all c/c/w combos.

NOT_WRITTEN 

Data was not written.

Definition at line 16 of file us_convert.h.

Constructor & Destructor Documentation

US_Convert::US_Convert ( void  )

Generic constructor for the US_Convert class. This constructor establishes the dialog and its relationship to the parent dialog.

Definition at line 14 of file us_convert.cpp.

Member Function Documentation

void US_Convert::convert ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
US_DataIO::RawData newRawData,
QString  triple,
QString  runType,
double  tolerance 
)
staticprivate

Definition at line 353 of file us_convert.cpp.

void US_Convert::convertLegacyData ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QVector< US_DataIO::RawData > &  rawConvertedData,
QList< TripleInfo > &  triples,
QString  runType,
double  tolerance 
)
static

Converts legacy raw data into US3 data. This function will convert existing datapoints and cell/channel/wavelength combinations in the data.

Parameters
rawLegacyDataA reference to a structure provided by the calling function that already contains the imported raw data.
rawConvertedDataA reference to a structure provided by the calling function that will be used to store the US3 raw converted data.
triplesA reference to a structure provided by the calling function that will be used to store all the different cell/channel/wavelength combinations found in the data.
runTypeA reference to a variable that already contains the type of data ( "RA", "IP", "RI", "FI", "WA", or "WI"). This information will affect how the data is converted.
toleranceHow far apart the wavelength readings can be and still be considered part of the same cell/channel/wavelength.

Definition at line 123 of file us_convert.cpp.

US_DataIO::Scan US_Convert::newScanSubset ( US_DataIO::Scan oldScan,
QVector< double > &  radii,
double  r_start,
double  r_end 
)
staticprivate

Definition at line 708 of file us_convert.cpp.

void US_Convert::readLegacyData ( QString  dir,
QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QString &  runType 
)
static

Reads the legacy raw data from disk into the program.

Parameters
dirThe directory in which the program will look for the raw data files.
rawLegacyDataA reference to a structure provided by the calling function that will be used to store the imported raw data.
runTypeA reference to a variable that will contain the type of data that is being read ( "RA", "IP", "RI", "FI", "WA", or "WI"). This determination already affects how some data is handled when read.

Definition at line 18 of file us_convert.cpp.

int US_Convert::readUS3Disk ( QString  dir,
QVector< US_DataIO::RawData > &  rawConvertedData,
QList< TripleInfo > &  triples,
QString &  runType 
)
static

Reloads converted US3 data back into the program to sync up with the database.

Parameters
dirThe directory that contains the auc files
rawConvertedDataA reference to a structure provided by the calling function that will be used to store the US3 raw converted data.
triplesA reference to a structure provided by the calling function that will be used to store all the different cell/channel/wavelength combinations found in the data.
runTypeA reference to a variable that already contains the type of data ( "RA", "IP", "RI", "FI", "WA", or "WI"). This information will affect how the data is converted.
Returns
An ioError status code

Definition at line 293 of file us_convert.cpp.

int US_Convert::saveToDisk ( QVector< US_DataIO::RawData * > &  rawConvertedData,
QList< TripleInfo > &  triples,
QVector< Excludes > &  allExcludes,
QString  runType,
QString  runID,
QString  dirname,
bool  saveGUIDs 
)
static

Writes the converted US3 data to disk.

Parameters
rawConvertedDataA reference to a structure provided by the calling function that already contains the US3 raw converted data.
triplesA reference to a structure provided by the calling function that already contains all the different cell/channel/wavelength combinations in the data.
allExcludesA reference to a QVector of excluded scans for each c/c/w combination
runTypeA reference to a variable that already contains the type of data ( "RA", "IP", "RI", "FI", "WA", or "WI"). This information will affect how the data is written.
runIDThe run ID of the experiment.
dirnameDirectory in which files are to be written.
saveGUIDsBoolean value that indicates whether data has been saved to disk before and doesn't require new GUIDs
Returns
One of the ioError status codes, above

Definition at line 161 of file us_convert.cpp.

void US_Convert::setCcrTriples ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QList< TripleInfo > &  triples,
double  tolerance 
)
staticprivate

Definition at line 860 of file us_convert.cpp.

void US_Convert::setCcwTriples ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QList< TripleInfo > &  triples,
double  tolerance 
)
staticprivate

Definition at line 773 of file us_convert.cpp.

void US_Convert::setInterpolated ( unsigned char *  bitmap,
int  location 
)
staticprivate

Definition at line 955 of file us_convert.cpp.

void US_Convert::setTriples ( QList< US_DataIO::BeckmanRawScan > &  rawLegacyData,
QList< TripleInfo > &  triples,
QString  runType,
double  tolerance 
)
staticprivate

Definition at line 759 of file us_convert.cpp.

void US_Convert::splitRAData ( QVector< US_DataIO::RawData > &  rawConvertedData,
QList< TripleInfo > &  triples,
int  currentTriple,
QList< double > &  subsets 
)
static

Splits existing raw converted data into multiple datasets. Also rearranges triples in the data accordingly.

Parameters
rawConvertedDataA reference to a structure that contains the US3 raw converted data.
triplesA reference to a structure that contains the different cell/channel/wavelength combinations in the data.
currentTripleThe triple that will be split.
subsetsA list of radius limits that define where a dataset begins and ends.

Definition at line 612 of file us_convert.cpp.


The documentation for this class was generated from the following files: