CsvImportData Class Reference

Inheritance diagram for CsvImportData:

Collaboration diagram for CsvImportData:

Public Types
enum	DATA_TYPE { Intensity , Coordinate }

Public Member Functions
	CsvImportData (QObject *parent=nullptr)
QList< QString >	availableCoordinateUnits () const
std::set< std::pair< int, int > >	checkData ()
int	column (DATA_TYPE type) const
QString	columnLabel (DATA_TYPE type) const
const csv::DataArray &	data () const
size_t	firstRow ()
size_t	lastRow ()
csv::DataColumn	multipliedValues (DATA_TYPE type) const
double	multiplier (DATA_TYPE type) const
size_t	nCols () const
size_t	nRows () const
void	resetSelection ()
bool	rowExcluded (int row)
std::set< int >	rowsToDiscard () const
int	setColumnAs (int col, csv::ColumnType type)
	sets type to a column col. More...
void	setData (csv::DataArray data)
void	setFirstRow (size_t row)
void	setLastRow (size_t row)
void	setMultiplier (DATA_TYPE type, double value)
void	toggleDiscardRows (std::set< int > rows)
csv::DataColumn	values (int col) const

Static Public Member Functions
static std::vector< DATA_TYPE >	availableTypes ()

Private Member Functions
std::set< int >	checkFormat (const csv::DataColumn &values, bool check_ordering)
	Checks if selected data is suitable for import. More...

Private Attributes
std::unique_ptr< const csv::DataArray >	m_data
std::set< int >	m_discarded_rows
size_t	m_n_footer
	number of footer rows More...
size_t	m_n_header
	number of header rows More...
std::map< DATA_TYPE, CsvCoordinateColumn >	m_selected_cols

Detailed Description

Definition at line 22 of file CsvImportTable.h.

Member Enumeration Documentation

DATA_TYPE

enum CsvImportData::DATA_TYPE

Enumerator
Intensity
Coordinate

Definition at line 25 of file CsvImportTable.h.

{ Intensity, Coordinate };

Constructor & Destructor Documentation

CsvImportData()

CsvImportData::CsvImportData

(

QObject *

parent = nullptr

)

Definition at line 30 of file CsvImportTable.cpp.

    : QObject(parent), m_data(new csv::DataArray), m_n_header(0), m_n_footer(0)
{
}

Member Function Documentation

availableCoordinateUnits()

QList< QString > CsvImportData::availableCoordinateUnits

(

)

const

Definition at line 167 of file CsvImportTable.cpp.

{
    if (column(Coordinate) < 0)
        return {axisUnitLabel.at(Axes::Units::NBINS)};
 
    auto coordinate_type = m_selected_cols.at(Coordinate).name();
    if (coordinate_type == csv::_q_)
        return {axisUnitLabel.at(Axes::Units::QSPACE)};
    else if (coordinate_type == csv::_theta_)
        return {{axisUnitLabel.at(Axes::Units::DEGREES)}, {axisUnitLabel.at(Axes::Units::RADIANS)}};
    return {axisUnitLabel.at(Axes::Units::NBINS)};
}

References csv::_q_, csv::_theta_, axisUnitLabel, column(), Coordinate, and m_selected_cols.

Referenced by CsvImportTable::availableCoordinateUnits().

Here is the call graph for this function:

availableTypes()

std::vector< CsvImportData::DATA_TYPE > CsvImportData::availableTypes ( )

static

Definition at line 103 of file CsvImportTable.cpp.

{
    return {Intensity, Coordinate};
}

References Coordinate, and Intensity.

Referenced by checkData(), CsvImportTable::setHeaders(), CsvImportTable::setMultiplierFields(), and CsvImportTable::updateSelectedCols().

checkData()

std::set< std::pair< int, int > > CsvImportData::checkData

(

)

Definition at line 201 of file CsvImportTable.cpp.

{
    std::set<std::pair<int, int>> result;
    for (auto type : availableTypes()) {
        auto col_result = checkFormat(multipliedValues(type), type == Coordinate);
        std::for_each(col_result.begin(), col_result.end(), [col = column(type), &result](int row) {
            result.insert({row, col});
        });
    }
    return result;
}

References availableTypes(), checkFormat(), column(), Coordinate, and multipliedValues().

Referenced by CsvImportTable::checkData().

Here is the call graph for this function:

checkFormat()

std::set< int > CsvImportData::checkFormat ( const csv::DataColumn &  values, bool  check_ordering  )

private

Checks if selected data is suitable for import.

All values must be convertible to doubles, positive and sorted in ascending order if check_ordering is set to true. Returns a set of rows where the check failed.

Definition at line 221 of file CsvImportTable.cpp.

{
    std::set<int> result;
    if (values.empty())
        return result;
 
    bool has_prev_value = false;
    double prev_value = 0.0;
    for (size_t i = m_n_header; i + m_n_footer < nRows(); ++i) {
        if (m_discarded_rows.find(static_cast<int>(i)) != m_discarded_rows.end())
            continue;
 
        auto cellText = QString::fromStdString(values[i]);
        bool is_double;
        double number = cellText.toDouble(&is_double);
        if (!is_double || number <= 0.0) {
            result.insert(static_cast<int>(i));
            continue;
        }
 
        if (!check_ordering)
            continue;
 
        if (has_prev_value && prev_value >= number) {
            result.insert(static_cast<int>(i));
            continue;
        }
        prev_value = number;
        has_prev_value = true;
    }
    return result;
}

References m_discarded_rows, m_n_footer, m_n_header, nRows(), and values().

Referenced by checkData().

Here is the call graph for this function:

column()

int CsvImportData::column

(

DATA_TYPE

type

)

const

Definition at line 113 of file CsvImportTable.cpp.

{
    auto iter = m_selected_cols.find(type);
    return iter == m_selected_cols.end() ? -1 : iter->second.columnNumber();
}

References m_selected_cols.

Referenced by availableCoordinateUnits(), checkData(), CsvImportTable::coordinateColumn(), CsvImportTable::intensityColumn(), multipliedValues(), setColumnAs(), CsvImportTable::setHeaders(), CsvImportTable::setMultiplierFields(), and CsvImportTable::updateSelectedCols().

columnLabel()

QString CsvImportData::columnLabel

(

CsvImportData::DATA_TYPE

type

)

const

Definition at line 160 of file CsvImportTable.cpp.

{
    if (m_selected_cols.find(type) == m_selected_cols.end())
        return "";
    return csv::HeaderLabels[m_selected_cols.at(type).name()];
}

References csv::HeaderLabels, and m_selected_cols.

Referenced by CsvImportTable::setHeaders().

data()

const csv::DataArray & CsvImportData::data

(

)

const

Definition at line 108 of file CsvImportTable.cpp.

{
    return *m_data.get();
}

References m_data.

Referenced by setData().

firstRow()

size_t CsvImportData::firstRow ( )

inline

Definition at line 53 of file CsvImportTable.h.

{ return m_n_header; }

References m_n_header.

Referenced by CsvImportTable::setFirstRow().

lastRow()

size_t CsvImportData::lastRow ( )

inline

Definition at line 54 of file CsvImportTable.h.

{ return m_n_footer + 1 >= nRows() ? 0 : nRows() - m_n_footer - 1; }

References m_n_footer, and nRows().

Referenced by CsvImportTable::setLastRow().

Here is the call graph for this function:

multipliedValues()

csv::DataColumn CsvImportData::multipliedValues

(

DATA_TYPE

type

)

const

Definition at line 131 of file CsvImportTable.cpp.

{
    csv::DataColumn result;
    const int col = column(type);
    if (col < 0 || col >= static_cast<int>(nCols()))
        return result;
 
    double mult_value = multiplier(type);
    csv::DataColumn col_values = values(col);
    result.resize(col_values.size());
    // FIXME: seems that csv::DataColumn and related
    // classes can be based on QString
    for (size_t i = 0; i < col_values.size(); i++) {
        auto currentText = QString::fromStdString(col_values[i]);
        double number = mult_value * currentText.toDouble();
        // FIXME: find more elegant way to distinguish non-numerics
        QString textToWrite = 0.0 == number ? currentText : QString::number(number);
        result[i] = textToWrite.toStdString();
    }
    return result;
}

References column(), multiplier(), nCols(), and values().

Referenced by checkData(), and CsvImportTable::updateSelectedCols().

Here is the call graph for this function:

multiplier()

double CsvImportData::multiplier

(

CsvImportData::DATA_TYPE

type

)

const

Definition at line 153 of file CsvImportTable.cpp.

{
    if (m_selected_cols.find(type) == m_selected_cols.end())
        return 1.0;
    return m_selected_cols.at(type).multiplier();
}

References m_selected_cols.

Referenced by CsvImportTable::coordinateMultiplier(), CsvImportTable::intensityMultiplier(), multipliedValues(), and CsvImportTable::setMultiplierFields().

nCols()

size_t CsvImportData::nCols

(

)

const

Definition at line 180 of file CsvImportTable.cpp.

{
    if (nRows() == 0)
        return 0;
    return (*m_data)[0].size();
}

References m_data, and nRows().

Referenced by multipliedValues(), CsvImportTable::setMultiplierFields(), and values().

Here is the call graph for this function:

nRows()

size_t CsvImportData::nRows

(

)

const

Definition at line 187 of file CsvImportTable.cpp.

{
    return (*m_data).size();
}

Referenced by checkFormat(), lastRow(), nCols(), rowExcluded(), setFirstRow(), and setLastRow().

resetSelection()

void CsvImportData::resetSelection

(

)

Definition at line 213 of file CsvImportTable.cpp.

{
    m_n_header = 0;
    m_n_footer = 0;
    m_selected_cols.clear();
    m_discarded_rows.clear();
}

References m_discarded_rows, m_n_footer, m_n_header, and m_selected_cols.

Referenced by CsvImportTable::resetSelection().

rowExcluded()

bool CsvImportData::rowExcluded

(

int

row

)

Definition at line 192 of file CsvImportTable.cpp.

{
    if (static_cast<size_t>(row) < m_n_header || static_cast<size_t>(row) + m_n_footer >= nRows())
        return true;
    if (m_discarded_rows.find(row) != m_discarded_rows.end())
        return true;
    return false;
}

References m_discarded_rows, m_n_footer, m_n_header, and nRows().

Referenced by CsvImportTable::greyoutDiscardedRows().

Here is the call graph for this function:

rowsToDiscard()

std::set<int> CsvImportData::rowsToDiscard ( ) const

inline

Definition at line 49 of file CsvImportTable.h.

{ return m_discarded_rows; }

References m_discarded_rows.

Referenced by CsvImportTable::rowsToDiscard().

setColumnAs()

int CsvImportData::setColumnAs	(	int	col,
		csv::ColumnType	type
	)

sets type to a column col.

Returns the column number previously set to the type

Definition at line 44 of file CsvImportTable.cpp.

{
    DATA_TYPE role = type == csv::_intensity_ ? Intensity : Coordinate;
 
    CsvCoordinateColumn& column = m_selected_cols[role];
    const int prev_assigned = column.columnNumber();
    if (prev_assigned == col && type == column.name())
        return prev_assigned;
 
    for (auto iter = m_selected_cols.begin(); iter != m_selected_cols.end();)
        if (iter->second.columnNumber() == col && iter->first != role)
            iter = m_selected_cols.erase(iter);
        else
            ++iter;
 
    column.setColNum(col);
    column.setMultiplier(1.0); // resetting multiplier value
    column.setValues(values(col));
    column.setName(type);
    return prev_assigned;
}

References csv::_intensity_, column(), Coordinate, Intensity, m_selected_cols, and values().

Referenced by CsvImportTable::setColumnAs().

Here is the call graph for this function:

setData()

void CsvImportData::setData

(

csv::DataArray

data

)

Definition at line 35 of file CsvImportTable.cpp.

{
    m_data.reset(new csv::DataArray(std::move(data)));
    m_selected_cols.clear();
    m_n_header = 0;
    m_n_footer = 0;
    m_discarded_rows.clear();
}

References data(), m_data, m_discarded_rows, m_n_footer, m_n_header, and m_selected_cols.

Referenced by CsvImportTable::setData().

Here is the call graph for this function:

setFirstRow()

void CsvImportData::setFirstRow

(

size_t

row

)

Definition at line 74 of file CsvImportTable.cpp.

{
    if (row >= nRows())
        return;
    m_n_header = row;
}

References m_n_header, and nRows().

Referenced by CsvImportTable::setFirstRow().

Here is the call graph for this function:

setLastRow()

void CsvImportData::setLastRow

(

size_t

row

)

Definition at line 81 of file CsvImportTable.cpp.

{
    if (row + 1 >= nRows())
        return;
    m_n_footer = nRows() - row - 1;
}

References m_n_footer, and nRows().

Referenced by CsvImportTable::setLastRow().

Here is the call graph for this function:

setMultiplier()

void CsvImportData::setMultiplier	(	CsvImportData::DATA_TYPE	type,
		double	value
	)

Definition at line 66 of file CsvImportTable.cpp.

{
    if (m_selected_cols.find(type) == m_selected_cols.end())
        return;
 
    m_selected_cols[type].setMultiplier(value);
}

References m_selected_cols.

Referenced by CsvImportTable::setMultiplierFields().

toggleDiscardRows()

void CsvImportData::toggleDiscardRows

(

std::set< int >

rows

)

Definition at line 88 of file CsvImportTable.cpp.

{
    if (rows.empty()) {
        m_discarded_rows.clear();
        return;
    }
    for (auto row : rows) {
        if (m_discarded_rows.find(row) != m_discarded_rows.end()) {
            m_discarded_rows.erase(row);
        } else {
            m_discarded_rows.insert(row);
        }
    }
}

References m_discarded_rows.

Referenced by CsvImportTable::discardRows().

values()

csv::DataColumn CsvImportData::values

(

int

col

)

const

Definition at line 119 of file CsvImportTable.cpp.

{
    if (col < 0 || col >= static_cast<int>(nCols()))
        return {};
 
    const size_t size = m_data->size();
    csv::DataColumn result(size);
    for (size_t i = 0; i < size; ++i)
        result[i] = (*m_data)[i][static_cast<size_t>(col)];
    return result;
}

References m_data, and nCols().

Referenced by checkFormat(), multipliedValues(), CsvImportTable::resetColumn(), and setColumnAs().

Here is the call graph for this function:

Member Data Documentation

m_data

std::unique_ptr<const csv::DataArray> CsvImportData::m_data

private

Definition at line 66 of file CsvImportTable.h.

Referenced by data(), nCols(), setData(), and values().

m_discarded_rows

std::set<int> CsvImportData::m_discarded_rows

private

Definition at line 70 of file CsvImportTable.h.

Referenced by checkFormat(), resetSelection(), rowExcluded(), rowsToDiscard(), setData(), and toggleDiscardRows().

m_n_footer

size_t CsvImportData::m_n_footer

private

number of footer rows

Definition at line 69 of file CsvImportTable.h.

Referenced by checkFormat(), lastRow(), resetSelection(), rowExcluded(), setData(), and setLastRow().

m_n_header

size_t CsvImportData::m_n_header

private

number of header rows

Definition at line 68 of file CsvImportTable.h.

Referenced by checkFormat(), firstRow(), resetSelection(), rowExcluded(), setData(), and setFirstRow().

m_selected_cols

std::map<DATA_TYPE, CsvCoordinateColumn> CsvImportData::m_selected_cols

private

Definition at line 67 of file CsvImportTable.h.

Referenced by availableCoordinateUnits(), column(), columnLabel(), multiplier(), resetSelection(), setColumnAs(), setData(), and setMultiplier().

---

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

• /home/www/ba/GUI/coregui/Views/ImportDataWidgets/CsvImportAssistant/CsvImportTable.h
• /home/www/ba/GUI/coregui/Views/ImportDataWidgets/CsvImportAssistant/CsvImportTable.cpp