Kwave::Curve Class Reference

#include <Curve.h>

Inheritance diagram for Kwave::Curve:

Collaboration diagram for Kwave::Curve:

Public Types
typedef QListIterator< QPointF >	ConstIterator
typedef QMutableListIterator< QPointF >	Iterator
typedef QPointF	Point

Public Member Functions
	Curve ()
	Curve (const QString &command)
virtual	~Curve ()
void	firstHalf ()
void	secondHalf ()
void	deletePoint (Point p, bool check)
void	deleteSecondPoint ()
void	HFlip ()
void	VFlip ()
void	scaleFit (unsigned int range=1024)
void	insert (double x, double y)
Point	findPoint (double x, double y, double tol=.05)
void	fromCommand (const QString &command)
QString	getCommand ()
Kwave::interpolation_t	interpolationType ()
void	setInterpolationType (Kwave::interpolation_t type)
Kwave::Interpolation &	interpolation ()
QVector< double >	interpolation (unsigned int points)

Static Public Attributes
static QPointF	NoPoint

Protected Member Functions
void	sort ()

Private Attributes
Kwave::Interpolation	m_interpolation

Detailed Description

Definition at line 37 of file Curve.h.

Member Typedef Documentation

ConstIterator

typedef QListIterator<QPointF> Kwave::Curve::ConstIterator

Iterator

Definition at line 42 of file Curve.h.

Iterator

typedef QMutableListIterator<QPointF> Kwave::Curve::Iterator

Iterator

Definition at line 45 of file Curve.h.

Point

typedef QPointF Kwave::Curve::Point

class used for the points

Definition at line 48 of file Curve.h.

Constructor & Destructor Documentation

Curve() [1/2]

Kwave::Curve::Curve

(

)

Default constructor, creates an empty curve.

Definition at line 36 of file Curve.cpp.

    :m_interpolation(Kwave::INTPOL_LINEAR)
{
}

Curve() [2/2]

Kwave::Curve::Curve ( const QString &  command )

explicit

Constructor, creates a curve from a command string.

Parameters

command

string with parameters

Definition at line 42 of file Curve.cpp.

References fromCommand().

    :m_interpolation(Kwave::INTPOL_LINEAR)
{
    fromCommand(command);
}

Here is the call graph for this function:

~Curve()

Kwave::Curve::~Curve ( )

virtual

Destructor

Definition at line 49 of file Curve.cpp.

{
    clear();
}

Member Function Documentation

deletePoint()

void Kwave::Curve::deletePoint	(	Point	p,
		bool	check
	)

Removes and deletes a point from the curve. Note that after this call the passed point is no longer valid!

Parameters

p	point to be deleted
check	if true, the last or first point will not be deleted

Definition at line 112 of file Curve.cpp.

Referenced by Kwave::CurveWidget::deleteLast(), and Kwave::CurveWidget::mouseMoveEvent().

{
    Iterator it(*this);
    if (!it.findNext(p)) return;
    if ((!check) || (it.hasPrevious() && it.hasNext()))
        it.remove();
}

Here is the caller graph for this function:

deleteSecondPoint()

void Kwave::Curve::deleteSecondPoint

(

)

Deletes every second point.

Definition at line 135 of file Curve.cpp.

Referenced by Kwave::CurveWidget::deleteSecond().

{
    if (isEmpty()) return;

    Iterator it(*this);
    while (it.hasNext()) {
        it.next();
        it.remove();
    }
}

Here is the caller graph for this function:

findPoint()

Kwave::Curve::Point Kwave::Curve::findPoint	(	double	x,
		double	y,
		double	tol = .05
	)

Searches for a point at given coordinates with a definable tolerance.

Parameters

x	coordinate on the x axis
y	coordinate on the y axis
tol	tolerance for x and y direction, absolute value

Returns

pointer to the found point or "NoPoint" if nothing found.

Definition at line 226 of file Curve.cpp.

References NoPoint.

Referenced by Kwave::CurveWidget::findPoint(), and Kwave::CurveWidget::mouseMoveEvent().

{
    Point best = NoPoint;
    double min_dist = tol;

    QMutableListIterator<Point> it(*this);
    while (it.hasNext()) {
        Point &p = it.next();
        // use the length of the difference vector as criterium
        double dist = hypot(px - p.x(), py - p.y());
        if (dist < min_dist) {
            min_dist = dist;
            best = p;
        }
    }
    return best;
}

Here is the caller graph for this function:

firstHalf()

void Kwave::Curve::firstHalf

(

)

Moves all current points into the left half

Definition at line 159 of file Curve.cpp.

Referenced by Kwave::CurveWidget::firstHalf().

{
    if (isEmpty()) return;

    QMutableListIterator<Point> it(*this);
    while (it.hasNext()) {
        Point &p = it.next();
        p.setX(p.x() / 2.0);
    }
    append(Point(1.0, first().y()));
}

Here is the caller graph for this function:

fromCommand()

void Kwave::Curve::fromCommand

(

const QString &

command

)

Sets a curve from a command string. Opposite of getCommand().

Parameters

command

a string that contains the interpolation type and pairs of x/y coordinates.

Definition at line 55 of file Curve.cpp.

References Kwave::Interpolation::find(), Kwave::Parser::firstParam(), Kwave::Parser::isDone(), m_interpolation, setInterpolationType(), and Kwave::Parser::toDouble().

Referenced by Curve(), Kwave::CurveWidget::CurveWidget(), Kwave::AmplifyFreePlugin::interpreteParameters(), Kwave::CurveWidget::loadPreset(), and Kwave::CurveWidget::setCurve().

{
    clear();

    Kwave::Parser parse(command);
    QString t = parse.firstParam();
    setInterpolationType(m_interpolation.find(t));

    while (!parse.isDone()) {
        double x = parse.toDouble();
        if (parse.isDone()) break; // half point ?
        double y = parse.toDouble();
        append(Point(x, y));
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

getCommand()

QString Kwave::Curve::getCommand

(

)

Returns a command string out of the curve points and interpolation type.

Definition at line 72 of file Curve.cpp.

References _, m_interpolation, Kwave::Interpolation::name(), and Kwave::Interpolation::type().

Referenced by Kwave::CurveWidget::getCommand(), and Kwave::CurveWidget::savePreset().

{
    QString cmd = _("curve(");
    cmd += m_interpolation.name(m_interpolation.type());

    foreach (const Point &p, *this) {
        QString par = _(",%1,%2");
        cmd += par.arg(p.x()).arg(p.y());
    }
    cmd += _(")");
    return cmd;
}

Here is the call graph for this function:

Here is the caller graph for this function:

HFlip()

void Kwave::Curve::HFlip

(

)

Flips/mirrors the curve horizontally (x-axis).

Definition at line 184 of file Curve.cpp.

References sort().

Referenced by Kwave::CurveWidget::HFlip().

{
    if (isEmpty()) return;

    // flip all x coordinates
    QMutableListIterator<Point> it(*this);
    while (it.hasNext()) {
        Point &p = it.next();
        p.setX(1.0 - p.x());
    }

    // reverse the order it the list
    sort();
}

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

void Kwave::Curve::insert	(	double	x,
		double	y
	)

Creates a new point and inserts it into the curve. The new point will be sorted in by it's x coordinate.

Parameters

x	coordinate on the x axis, should be [0...+1.0]
y	coordinate on the y axis, should be [0...+1.0]

Definition at line 147 of file Curve.cpp.

References sort().

Referenced by Kwave::CurveWidget::addPoint(), Kwave::CurveWidget::mouseMoveEvent(), Kwave::PlayBackPlugin::run(), and secondHalf().

{
    if ((x < 0.0) || (x > 1.0)) {
        qWarning("Curve::insert(%0.2f,%0.2f): out of range !",x,y);
        return;
    }

    append(Point(x, y));
    sort();
}

Here is the call graph for this function:

Here is the caller graph for this function:

interpolation() [1/2]

Kwave::Interpolation & Kwave::Curve::interpolation

(

)

Returns a reference to the Interpolation object itself

Definition at line 86 of file Curve.cpp.

References m_interpolation, and Kwave::Interpolation::prepareInterpolation().

Referenced by Kwave::CurveWidget::paintEvent(), and scaleFit().

{
    m_interpolation.prepareInterpolation(*this);
    return m_interpolation;
}

Here is the call graph for this function:

Here is the caller graph for this function:

interpolation() [2/2]

QVector< double > Kwave::Curve::interpolation

(

unsigned int

points

)

Returns an array of points, calculated out of the current interpolation parameters.

Parameters

points

number of points

Returns

Array of interpolated values or null if the number of points was zero or the curve was empty.

Definition at line 93 of file Curve.cpp.

References Kwave::Interpolation::interpolation(), m_interpolation, and Kwave::Interpolation::prepareInterpolation().

{
    m_interpolation.prepareInterpolation(*this);
    return m_interpolation.interpolation(*this, points);
}

Here is the call graph for this function:

interpolationType()

Kwave::interpolation_t Kwave::Curve::interpolationType

(

)

Returns the interpolation type.

Definition at line 106 of file Curve.cpp.

References m_interpolation, and Kwave::Interpolation::type().

{
    return m_interpolation.type();
}

Here is the call graph for this function:

scaleFit()

void Kwave::Curve::scaleFit

(

unsigned int

range = 1024

)

Scales the curve vertically to fit into a range of (+/- range/2) on the y-axis.

Parameters

range

the size range to use for scaling

Definition at line 200 of file Curve.cpp.

References Kwave::Interpolation::interpolation(), interpolation(), m_interpolation, and Kwave::Interpolation::type().

Referenced by Kwave::CurveWidget::scaleFit().

{
    double min = std::numeric_limits<double>::max();
    double max = std::numeric_limits<double>::min();

    Kwave::Interpolation interpolation(m_interpolation.type());

    QVector<double> y = interpolation.interpolation(*this, range);
    foreach (double yi, y) {
        if (yi > max) max = yi;
        if (yi < min) min = yi;
    }

    QMutableListIterator<Point> it(*this);
    while (it.hasNext()) {
        Point &p = it.next();
        p.ry() -= min;
        if (!qFuzzyCompare(max, min))
            p.ry() /= (max - min);
        else
            p.ry() = min;
    }

}

Here is the call graph for this function:

Here is the caller graph for this function:

secondHalf()

void Kwave::Curve::secondHalf

(

)

Moves all current points into the right half

Definition at line 121 of file Curve.cpp.

References insert().

Referenced by Kwave::CurveWidget::secondHalf().

{
    if (isEmpty()) return;

    QMutableListIterator<Point> it(*this);
    while (it.hasNext()) {
        Point &p = it.next();
        p.setX(0.5 + p.x() / 2.0);
    }

    insert(0.0, first().y());
}

Here is the call graph for this function:

Here is the caller graph for this function:

setInterpolationType()

void Kwave::Curve::setInterpolationType

(

Kwave::interpolation_t

type

)

Sets a new interpolation type.

Parameters

type	the new interpolation type

Definition at line 100 of file Curve.cpp.

References m_interpolation, and Kwave::Interpolation::setType().

Referenced by fromCommand(), and Kwave::CurveWidget::selectInterpolationType().

{
    m_interpolation.setType(type);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sort()

void Kwave::Curve::sort ( )

protected

sorts the list by ascending x coordinate

Definition at line 251 of file Curve.cpp.

References cmp().

Referenced by HFlip(), and insert().

{
    if (!isEmpty())
        std::sort(begin(), end(), cmp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

VFlip()

void Kwave::Curve::VFlip

(

)

Flips/mirrors the curve vertically (y-axis).

Definition at line 172 of file Curve.cpp.

Referenced by Kwave::CurveWidget::VFlip().

{
    if (isEmpty()) return;

    QMutableListIterator<Point> it(*this);
    while (it.hasNext()) {
        Point &p = it.next();
        p.setY(1.0 - p.y());
    }
}

Here is the caller graph for this function:

Member Data Documentation

m_interpolation

Kwave::Interpolation Kwave::Curve::m_interpolation

private

interpolation object

Definition at line 165 of file Curve.h.

Referenced by fromCommand(), getCommand(), interpolation(), interpolationType(), scaleFit(), and setInterpolationType().

NoPoint

QPointF Kwave::Curve::NoPoint

static

used for the "invalid" point

Definition at line 51 of file Curve.h.

Referenced by Kwave::CurveWidget::addPoint(), Kwave::CurveWidget::deleteLast(), Kwave::CurveWidget::deleteSecond(), Kwave::CurveWidget::findPoint(), findPoint(), Kwave::CurveWidget::firstHalf(), Kwave::CurveWidget::loadPreset(), Kwave::CurveWidget::mouseMoveEvent(), Kwave::CurveWidget::mousePressEvent(), Kwave::CurveWidget::mouseReleaseEvent(), and Kwave::CurveWidget::secondHalf().

---

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

• libkwave/Curve.h
• libkwave/Curve.cpp