SonicVisualiser: EditableDenseThreeDimensionalModel Class Reference

Definition at line 21 of file EditableDenseThreeDimensionalModel.h.


Public Types
typedef std::vector< float >	Column
Public Slots
void	aboutToDelete ()
void	sourceModelAboutToBeDeleted ()
Signals
void	modelChanged ()
	Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).
void	modelChanged (size_t startFrame, size_t endFrame)
	Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).
void	completionChanged ()
	Emitted when some internal processing has advanced a stage, but the model has not changed externally.
void	alignmentCompletionChanged ()
	Emitted when the completion percentage changes for the calculation of this model's alignment model.
void	aboutToBeDeleted ()
	Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.
Public Member Functions
	EditableDenseThreeDimensionalModel (size_t sampleRate, size_t resolution, size_t yBinCount, bool notifyOnAdd=true)
virtual bool	isOK () const
	Return true if the model was constructed successfully.
virtual size_t	getSampleRate () const
	Return the frame rate in frames per second.
virtual size_t	getStartFrame () const
	Return the first audio frame spanned by the model.
virtual size_t	getEndFrame () const
	Return the last audio frame spanned by the model.
virtual Model *	clone () const
	Return a copy of this model.
virtual size_t	getResolution () const
	Return the number of sample frames covered by each set of bins.
virtual void	setResolution (size_t sz)
	Set the number of sample frames covered by each set of bins.
virtual size_t	getWidth () const
	Return the number of columns.
virtual size_t	getHeight () const
	Return the number of bins in each set of bins.
virtual void	setHeight (size_t sz)
	Set the number of bins in each set of bins.
virtual float	getMinimumLevel () const
	Return the minimum value of the value in each bin.
virtual void	setMinimumLevel (float sz)
	Set the minimum value of the value in a bin.
virtual float	getMaximumLevel () const
	Return the maximum value of the value in each bin.
virtual void	setMaximumLevel (float sz)
	Set the maximum value of the value in a bin.
virtual bool	isColumnAvailable (size_t x) const
	Return true if there are data available for the given column.
virtual void	getColumn (size_t x, Column &) const
	Get the set of bin values at the given column.
virtual float	getValueAt (size_t x, size_t n) const
	Get a single value, from the n'th bin of the given column.
virtual void	setColumn (size_t x, const Column &values)
	Set the entire set of bin values at the given column.
virtual QString	getBinName (size_t n) const
	Get the name of a given bin (i.e.
virtual void	setBinName (size_t n, QString)
virtual void	setBinNames (std::vector< QString > names)
virtual void	setCompletion (int completion, bool update=true)
virtual int	getCompletion () const
QString	getTypeName () const
	Return the type of the model.
virtual QString	toDelimitedDataString (QString delimiter) const
virtual void	toXml (QTextStream &out, QString indent="", QString extraAttributes="") const
	Stream this exportable object out to XML on a text stream.
virtual void	getColumn (size_t column, Column &result) const =0
	Get data from the given column of bin values.
bool	isLocalPeak (size_t x, size_t y)
	Utility function to query whether a given bin is greater than its (vertical) neighbours.
bool	isOverThreshold (size_t x, size_t y, float threshold)
	Utility function to query whether a given bin is greater than a certain threshold.
virtual size_t	getNativeRate () const
	Return the frame rate of the underlying material, if the model itself has already been resampled.
virtual QString	getTitle () const
	Return the "work title" of the model, if known.
virtual QString	getMaker () const
	Return the "artist" or "maker" of the model, if known.
virtual QString	getLocation () const
	Return the location of the data in this model (e.g.
virtual bool	isReady (int *completion=0) const
	Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread.
virtual const ZoomConstraint *	getZoomConstraint () const
	If this model imposes a zoom constraint, i.e.
virtual Model *	getSourceModel () const
	If this model was derived from another, return the model it was derived from.
virtual void	setSourceModel (Model *model)
	Set the source model for this model.
virtual void	setAlignment (AlignmentModel *alignment)
	Specify an aligment between this model's timeline and that of a reference model.
virtual const Model *	getAlignmentReference () const
	Return the reference model for the current alignment timeline, if any.
virtual size_t	alignToReference (size_t frame) const
	Return the frame number of the reference model that corresponds to the given frame number in this model.
virtual size_t	alignFromReference (size_t referenceFrame) const
	Return the frame number in this model that corresponds to the given frame number of the reference model.
virtual int	getAlignmentCompletion () const
	Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated.
virtual QString	toXmlString (QString indent="", QString extraAttributes="") const
	Convert this exportable object to XML in a string.
Static Public Member Functions
static QString	encodeEntities (QString)
static QString	encodeColour (QColor)
static int	getObjectExportId (const void *)
Static Public Attributes
static const int	COMPLETION_UNKNOWN
Protected Types
typedef std::vector< Column >	ValueMatrix
Protected Attributes
ValueMatrix	m_data
std::vector< QString >	m_binNames
size_t	m_sampleRate
size_t	m_resolution
size_t	m_yBinCount
float	m_minimum
float	m_maximum
bool	m_haveExtents
bool	m_notifyOnAdd
long	m_sinceLastNotifyMin
long	m_sinceLastNotifyMax
int	m_completion
QMutex	m_mutex
Model *	m_sourceModel
AlignmentModel *	m_alignment
bool	m_aboutToDelete

Member Typedef Documentation

typedef std::vector<Column> EditableDenseThreeDimensionalModel::ValueMatrix [protected]

Definition at line 121 of file EditableDenseThreeDimensionalModel.h.

typedef std::vector<float> DenseThreeDimensionalModel::Column [inherited]

Definition at line 64 of file DenseThreeDimensionalModel.h.

Constructor & Destructor Documentation

EditableDenseThreeDimensionalModel::EditableDenseThreeDimensionalModel	(	size_t	sampleRate,
		size_t	resolution,
		size_t	yBinCount,
		bool	notifyOnAdd = `true`
	)

Definition at line 24 of file EditableDenseThreeDimensionalModel.cpp.

Referenced by clone().

Member Function Documentation

bool EditableDenseThreeDimensionalModel::isOK ( ) const [virtual]

Return true if the model was constructed successfully.

Classes that refer to the model should always test this before use.

Implements Model.

Definition at line 42 of file EditableDenseThreeDimensionalModel.cpp.

size_t EditableDenseThreeDimensionalModel::getSampleRate ( ) const [virtual]

Return the frame rate in frames per second.

Implements Model.

Definition at line 48 of file EditableDenseThreeDimensionalModel.cpp.

References m_sampleRate.

size_t EditableDenseThreeDimensionalModel::getStartFrame ( ) const [virtual]

Return the first audio frame spanned by the model.

Implements Model.

Definition at line 54 of file EditableDenseThreeDimensionalModel.cpp.

size_t EditableDenseThreeDimensionalModel::getEndFrame ( ) const [virtual]

Return the last audio frame spanned by the model.

Implements Model.

Definition at line 60 of file EditableDenseThreeDimensionalModel.cpp.

References m_data, and m_resolution.

Model * EditableDenseThreeDimensionalModel::clone ( ) const [virtual]

Return a copy of this model.

If the model is not editable, this may be effectively a shallow copy. If the model is editable, however, this operation must properly copy all of the model's editable data.

In general this operation is not useful for non-editable dense models such as waveforms, because there may be no efficient copy operation implemented -- for such models it is better not to copy at all.

Caller owns the returned value.

Implements Model.

Definition at line 66 of file EditableDenseThreeDimensionalModel.cpp.

References EditableDenseThreeDimensionalModel(), m_data, m_haveExtents, m_maximum, m_minimum, m_resolution, m_sampleRate, m_yBinCount, and setColumn().

size_t EditableDenseThreeDimensionalModel::getResolution ( ) const [virtual]

Return the number of sample frames covered by each set of bins.

Implements DenseThreeDimensionalModel.

Definition at line 84 of file EditableDenseThreeDimensionalModel.cpp.

References m_resolution.

Referenced by FeatureExtractionModelTransformer::addFeature(), and CSVFileReader::load().

void EditableDenseThreeDimensionalModel::setResolution ( size_t sz ) [virtual]

Set the number of sample frames covered by each set of bins.

Definition at line 90 of file EditableDenseThreeDimensionalModel.cpp.

References m_resolution.

size_t EditableDenseThreeDimensionalModel::getWidth ( ) const [virtual]

Return the number of columns.

Implements DenseThreeDimensionalModel.

Definition at line 96 of file EditableDenseThreeDimensionalModel.cpp.

References m_data.

Referenced by isColumnAvailable().

size_t EditableDenseThreeDimensionalModel::getHeight ( ) const [virtual]

Return the number of bins in each set of bins.

Implements DenseThreeDimensionalModel.

Definition at line 102 of file EditableDenseThreeDimensionalModel.cpp.

References m_yBinCount.

Referenced by SVFileReader::readRowData().

void EditableDenseThreeDimensionalModel::setHeight ( size_t sz ) [virtual]

Set the number of bins in each set of bins.

Definition at line 108 of file EditableDenseThreeDimensionalModel.cpp.

References m_yBinCount.

float EditableDenseThreeDimensionalModel::getMinimumLevel ( ) const [virtual]

Return the minimum value of the value in each bin.

Implements DenseThreeDimensionalModel.

Definition at line 114 of file EditableDenseThreeDimensionalModel.cpp.

References m_minimum.

void EditableDenseThreeDimensionalModel::setMinimumLevel ( float sz ) [virtual]

Set the minimum value of the value in a bin.

Definition at line 120 of file EditableDenseThreeDimensionalModel.cpp.

References m_minimum.

Referenced by CSVFileReader::load(), and SVFileReader::readModel().

float EditableDenseThreeDimensionalModel::getMaximumLevel ( ) const [virtual]

Return the maximum value of the value in each bin.

Implements DenseThreeDimensionalModel.

Definition at line 126 of file EditableDenseThreeDimensionalModel.cpp.

References m_maximum.

void EditableDenseThreeDimensionalModel::setMaximumLevel ( float sz ) [virtual]

Set the maximum value of the value in a bin.

Definition at line 132 of file EditableDenseThreeDimensionalModel.cpp.

References m_maximum.

Referenced by CSVFileReader::load(), and SVFileReader::readModel().

virtual bool EditableDenseThreeDimensionalModel::isColumnAvailable ( size_t x ) const [inline, virtual]

Return true if there are data available for the given column.

Implements DenseThreeDimensionalModel.

Definition at line 88 of file EditableDenseThreeDimensionalModel.h.

References getWidth().

void EditableDenseThreeDimensionalModel::getColumn	(	size_t	x,
		Column &
	)			const `[virtual]`

Get the set of bin values at the given column.

Definition at line 138 of file EditableDenseThreeDimensionalModel.cpp.

References m_data, m_minimum, m_mutex, and m_yBinCount.

float EditableDenseThreeDimensionalModel::getValueAt	(	size_t	x,
		size_t	n
	)			const `[virtual]`

Get a single value, from the n'th bin of the given column.

Implements DenseThreeDimensionalModel.

Definition at line 153 of file EditableDenseThreeDimensionalModel.cpp.

References m_data, m_minimum, and m_mutex.

void EditableDenseThreeDimensionalModel::setColumn	(	size_t	x,
		const Column &	values
	)			`[virtual]`

Set the entire set of bin values at the given column.

Definition at line 168 of file EditableDenseThreeDimensionalModel.cpp.

References m_data, m_haveExtents, m_maximum, m_minimum, m_mutex, m_notifyOnAdd, m_resolution, m_sinceLastNotifyMax, m_sinceLastNotifyMin, and Model::modelChanged().

Referenced by FeatureExtractionModelTransformer::addFeature(), clone(), CSVFileReader::load(), and SVFileReader::readRowData().

QString EditableDenseThreeDimensionalModel::getBinName ( size_t n ) const [virtual]

Get the name of a given bin (i.e.

a label to associate with that bin across all columns).

Implements DenseThreeDimensionalModel.

Definition at line 225 of file EditableDenseThreeDimensionalModel.cpp.

References m_binNames.

void EditableDenseThreeDimensionalModel::setBinName	(	size_t	n,
		QString
	)			`[virtual]`

Definition at line 232 of file EditableDenseThreeDimensionalModel.cpp.

References m_binNames, and Model::modelChanged().

Referenced by SVFileReader::addBinToDataset().

void EditableDenseThreeDimensionalModel::setBinNames ( std::vector< QString > names ) [virtual]

Definition at line 240 of file EditableDenseThreeDimensionalModel.cpp.

References m_binNames, and Model::modelChanged().

Referenced by FeatureExtractionModelTransformer::FeatureExtractionModelTransformer().

void EditableDenseThreeDimensionalModel::setCompletion	(	int	completion,
		bool	update = `true`
	)			`[virtual]`

Definition at line 247 of file EditableDenseThreeDimensionalModel.cpp.

References Model::completionChanged(), m_completion, m_notifyOnAdd, m_resolution, m_sinceLastNotifyMax, m_sinceLastNotifyMin, and Model::modelChanged().

Referenced by FeatureExtractionModelTransformer::setCompletion().

virtual int EditableDenseThreeDimensionalModel::getCompletion ( ) const [inline, virtual]

Implements DenseThreeDimensionalModel.

Definition at line 110 of file EditableDenseThreeDimensionalModel.h.

References m_completion.

QString EditableDenseThreeDimensionalModel::getTypeName ( ) const [inline, virtual]

Return the type of the model.

For display purposes only.

Reimplemented from DenseThreeDimensionalModel.

Definition at line 112 of file EditableDenseThreeDimensionalModel.h.

QString EditableDenseThreeDimensionalModel::toDelimitedDataString ( QString delimiter ) const [virtual]

Reimplemented from Model.

Definition at line 275 of file EditableDenseThreeDimensionalModel.cpp.

References m_data.

void EditableDenseThreeDimensionalModel::toXml	(	QTextStream &	out,
		QString	indent = `""`,
		QString	extraAttributes = `""`
	)			const `[virtual]`

Stream this exportable object out to XML on a text stream.

Reimplemented from Model.

Definition at line 289 of file EditableDenseThreeDimensionalModel.cpp.

References XmlExportable::getObjectExportId(), m_binNames, m_data, m_maximum, m_minimum, m_resolution, m_yBinCount, and Model::toXml().

virtual void DenseThreeDimensionalModel::getColumn	(	size_t	column,
		Column &	result
	)			const `[pure virtual, inherited]`

Get data from the given column of bin values.

Referenced by Colour3DPlotLayer::getColumn().

bool DenseThreeDimensionalModel::isLocalPeak	(	size_t	x,
		size_t	y
	)			`[inline, inherited]`

Utility function to query whether a given bin is greater than its (vertical) neighbours.

Definition at line 86 of file DenseThreeDimensionalModel.h.

References DenseThreeDimensionalModel::getHeight(), and DenseThreeDimensionalModel::getValueAt().

Referenced by SpectrogramLayer::getAdjustedYBinSourceRange(), and SpectrogramLayer::paint().

bool DenseThreeDimensionalModel::isOverThreshold	(	size_t	x,
		size_t	y,
		float	threshold
	)			`[inline, inherited]`

Utility function to query whether a given bin is greater than a certain threshold.

Definition at line 97 of file DenseThreeDimensionalModel.h.

References DenseThreeDimensionalModel::getValueAt().

Referenced by SpectrogramLayer::getAdjustedYBinSourceRange(), SpectrumLayer::paint(), and SpectrogramLayer::paint().

virtual size_t Model::getNativeRate ( ) const [inline, virtual, inherited]

Return the frame rate of the underlying material, if the model itself has already been resampled.

Reimplemented in WaveFileModel.

Definition at line 67 of file Model.h.

References Model::getSampleRate().

Referenced by Pane::drawDurationAndRate().

QString Model::getTitle ( ) const [virtual, inherited]

Return the "work title" of the model, if known.

Reimplemented in WaveFileModel.

Definition at line 150 of file Model.cpp.

References Model::getTitle(), and Model::m_sourceModel.

Referenced by Pane::drawWorkTitle(), and Model::getTitle().

QString Model::getMaker ( ) const [virtual, inherited]

Return the "artist" or "maker" of the model, if known.

Reimplemented in WaveFileModel.

Definition at line 157 of file Model.cpp.

References Model::getMaker(), and Model::m_sourceModel.

Referenced by ModelDataModel::data(), Pane::drawWorkTitle(), and Model::getMaker().

QString Model::getLocation ( ) const [virtual, inherited]

Return the location of the data in this model (e.g.

source URL). This should not normally be returned for editable models that have been edited.

Reimplemented in WaveFileModel.

Definition at line 164 of file Model.cpp.

References Model::getLocation(), and Model::m_sourceModel.

Referenced by ModelDataModel::data(), and Model::getLocation().

virtual bool Model::isReady ( int * completion = 0 ) const [inline, virtual, inherited]

Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread.

The default implementation is appropriate for a thread that does not background any work but carries out all its calculation from the constructor or accessors.

If "completion" is non-NULL, this function should return through it an estimated percentage value showing how far through the background operation it thinks it is (for progress reporting). If it has no way to calculate progress, it may return the special value COMPLETION_UNKNOWN.

Reimplemented in AggregateWaveModel, AlignmentModel, SparseModel< PointType >, WaveFileModel, WritableWaveFileModel, SparseModel< Note >, SparseModel< TextPoint >, SparseModel< ImagePoint >, SparseModel< TimeValuePoint >, SparseModel< OneDimensionalPoint >, and SparseModel< AlignmentModel::PathPoint >.

Definition at line 120 of file Model.h.

References Model::isOK().

Referenced by FFTDataServer::fillColumn(), SpectrogramLayer::getAdjustedYBinSourceRange(), WaveformLayer::getCompletion(), SpectrogramLayer::getXYBinSourceRange(), WaveformLayer::paint(), SpectrumLayer::paint(), SpectrogramLayer::paint(), SliceLayer::paint(), Colour3DPlotLayer::paint(), RealTimeEffectModelTransformer::run(), FFTDataServer::FillThread::run(), and FeatureExtractionModelTransformer::run().

virtual const ZoomConstraint* Model::getZoomConstraint ( ) const [inline, virtual, inherited]

If this model imposes a zoom constraint, i.e.

some limit to the set of resolutions at which its data can meaningfully be displayed, then return it.

Reimplemented in AggregateWaveModel, AlignmentModel, WaveFileModel, and WritableWaveFileModel.

Definition at line 132 of file Model.h.

Referenced by WaveformLayer::getZoomConstraint(), and Colour3DPlotLayer::getZoomConstraint().

virtual Model* Model::getSourceModel ( ) const [inline, virtual, inherited]

If this model was derived from another, return the model it was derived from.

The assumption is that the source model's alignment will also apply to this model, unless some other property (such as a specific alignment model set on this model) indicates otherwise.

Definition at line 143 of file Model.h.

References Model::m_sourceModel.

Referenced by View::checkProgress(), and Pane::paintEvent().

void Model::setSourceModel ( Model * model ) [virtual, inherited]

Set the source model for this model.

Definition at line 49 of file Model.cpp.

References Model::aboutToBeDeleted(), Model::alignmentCompletionChanged(), Model::m_sourceModel, and Model::sourceModelAboutToBeDeleted().

Referenced by Document::addDerivedModel(), FeatureExtractionModelTransformer::FeatureExtractionModelTransformer(), and FFTModel::FFTModel().

void Model::setAlignment ( AlignmentModel * alignment ) [virtual, inherited]

Specify an aligment between this model's timeline and that of a reference model.

The alignment model records both the reference and the alignment. This model takes ownership of the alignment model.

Definition at line 89 of file Model.cpp.

References Model::aboutToDelete(), Model::alignmentCompletionChanged(), Model::completionChanged(), and Model::m_alignment.

Referenced by Document::alignModel().

const Model * Model::getAlignmentReference ( ) const [virtual, inherited]

Return the reference model for the current alignment timeline, if any.

Definition at line 101 of file Model.cpp.

References Model::getAlignmentReference(), AlignmentModel::getReferenceModel(), Model::m_alignment, and Model::m_sourceModel.

Referenced by Layer::alignFromReference(), Document::alignModel(), Layer::alignToReference(), Pane::drawAlignmentStatus(), View::getAligningModel(), and Model::getAlignmentReference().

size_t Model::alignToReference ( size_t frame ) const [virtual, inherited]

Return the frame number of the reference model that corresponds to the given frame number in this model.

Definition at line 111 of file Model.cpp.

References Model::getEndFrame(), AlignmentModel::getReferenceModel(), Model::m_alignment, Model::m_sourceModel, and AlignmentModel::toReference().

Referenced by ViewManager::alignPlaybackFrameToReference(), View::alignToReference(), and Layer::alignToReference().

size_t Model::alignFromReference ( size_t referenceFrame ) const [virtual, inherited]

Return the frame number in this model that corresponds to the given frame number of the reference model.

Definition at line 124 of file Model.cpp.

References AlignmentModel::fromReference(), Model::getEndFrame(), Model::m_alignment, and Model::m_sourceModel.

Referenced by View::alignFromReference(), Layer::alignFromReference(), ViewManager::alignReferenceToPlaybackFrame(), and View::getAlignedPlaybackFrame().

int Model::getAlignmentCompletion ( ) const [virtual, inherited]

Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated.

Definition at line 136 of file Model.cpp.

References AlignmentModel::isReady(), Model::m_alignment, and Model::m_sourceModel.

Referenced by View::checkProgress(), and Pane::drawAlignmentStatus().

void Model::aboutToDelete ( ) [slot, inherited]

Definition at line 67 of file Model.cpp.

References Model::aboutToBeDeleted(), and Model::m_aboutToDelete.

Referenced by Document::releaseModel(), Model::setAlignment(), Document::setMainModel(), SpectrumLayer::setModel(), SpectrumLayer::setupFFT(), Document::~Document(), Model::~Model(), and SpectrumLayer::~SpectrumLayer().

void Model::sourceModelAboutToBeDeleted ( ) [slot, inherited]

Reimplemented in FFTModel.

Definition at line 83 of file Model.cpp.

References Model::m_sourceModel.

Referenced by Model::setSourceModel().

void Model::modelChanged ( ) [signal, inherited]

Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

Referenced by SparseValueModel< TimeValuePoint >::addPoint(), SparseModel< PointType >::addPoint(), SparseModel< PointType >::clear(), SparseValueModel< TimeValuePoint >::deletePoint(), SparseModel< PointType >::deletePoint(), setBinName(), setBinNames(), setColumn(), SparseModel< PointType >::setCompletion(), setCompletion(), SparseModel< PointType >::setResolution(), and WritableWaveFileModel::WritableWaveFileModel().

void Model::modelChanged	(	size_t	startFrame,
		size_t	endFrame
	)			`[signal, inherited]`

Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

void Model::completionChanged ( ) [signal, inherited]

Emitted when some internal processing has advanced a stage, but the model has not changed externally.

Views should respond by updating any progress meters or other monitoring, but not refreshing the actual view.

Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.

Referenced by Model::setAlignment(), SparseModel< PointType >::setCompletion(), and setCompletion().

void Model::alignmentCompletionChanged ( ) [signal, inherited]

Emitted when the completion percentage changes for the calculation of this model's alignment model.

Referenced by Model::setAlignment(), and Model::setSourceModel().

void Model::aboutToBeDeleted ( ) [signal, inherited]

Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.

Note that this depends on an external agent such as a Document object or owning model telling the model that it is about to delete it; there is nothing in the model to guarantee that this signal will be emitted before the actual deletion.

Referenced by Model::aboutToDelete(), and Model::setSourceModel().