Abstract base filter class. More...

#include <filter.h>

Inheritance diagram for Filter:

[legend]

Collaboration diagram for Filter:

[legend]

Public Member Functions
	Filter ()

virtual	~Filter ()

virtual Filter *	cloneUncached () const =0
	Duplicate filter contents, excluding cache. More...

virtual unsigned int	refresh (const std::vector< const FilterStreamData > &dataIn, std::vector< const FilterStreamData > &dataOut, ProgressData &progress)=0
	Apply filter to new data, updating cache as needed. Vector of returned pointers must be deleted manually, first checking ->cached. More...

virtual void	clearCache ()
	Erase cache. More...

virtual void	clearDevices ()
	Erase any active devices. More...

virtual size_t	numBytesForCache (size_t nObjects) const =0
	Get (approx) number of bytes required for cache. More...

virtual unsigned int	getType () const =0
	return type ID More...

virtual std::string	typeString () const =0
	Return filter type as std::string. More...

virtual void	getProperties (FilterPropGroup &propertyList) const =0
	Get the properties of the filter, in key-value form. First vector is for each output. More...

virtual bool	setProperty (unsigned int key, const std::string &value, bool &needUpdate)=0

std::string	getErrString (unsigned int code) const
	Get the human readable error string associated with a particular error code during refresh(...). Do not override this for specific filter errors. Override getSpecificErrString. More...

virtual bool	writeState (std::ostream &f, unsigned int format, unsigned int depth=0) const =0
	Dump state to output stream, using specified format. More...

virtual bool	readState (xmlNodePtr &n, const std::string &packDir="")=0
	Read state from XML stream, using xml format. More...

virtual unsigned int	getRefreshBlockMask () const =0
	Get the bitmask encoded list of filterStreams that this filter blocks from propagation. More...

virtual unsigned int	getRefreshEmitMask () const =0
	Get the bitmask encoded list of filterstreams that this filter emits from ::refresh. More...

virtual unsigned int	getRefreshUseMask () const =0
	Mask of filter streams that will be examined by the filter in its computation. More...

std::string	trueName () const
	Return the unique name for a given filter – DO NOT TRANSLATE. More...

virtual void	initFilter (const std::vector< const FilterStreamData > &dataIn, std::vector< const FilterStreamData > &dataOut)
	Initialise the filter's internal state using limited filter stream data propagation. More...

virtual void	getStateOverrides (std::vector< std::string > &overrides) const
	Return the XML elements that refer to external entities (i.e. files) which do not move with the XML files. At this time, only files are supported. These will be looked for on the filesystem and moved as needed. More...

void	setCaching (bool enableCache)
	Enable/disable caching for this filter. More...

bool	haveCache () const
	Have cached output data? More...

virtual std::string	getUserString () const
	Return a user-specified string, or just the typestring if user set string not active. More...

virtual void	setUserString (const std::string &str)
	Set a user-specified string return value is. More...

virtual bool	writePackageState (std::ostream &f, unsigned int format, const std::vector< std::string > &valueOverrides, unsigned int depth=0) const
	Modified version of writeState for packaging. By default simply calls writeState. More...

void	getSelectionDevices (std::vector< SelectionDevice *> &devices) const
	Get the selection devices for this filter. MUST be called after refresh() More...

void	updateOutputInfo (const std::vector< const FilterStreamData *> &dataOut)
	Update the output statistics for this filter (num items of streams of each type output) More...

virtual void	setPropFromBinding (const SelectionBinding &b)=0
	Set the binding value for a float. More...

virtual void	setPropFromRegion (unsigned int method, unsigned int regionID, float newPos)
	Set a region update. More...

virtual bool	canBeHazardous () const
	Can this filter perform actions that are potentially a security concern? More...

unsigned int	getNumOutput (unsigned int streamType) const
	Get the number of outputs for the specified type during the filter's last refresh. More...

void	getConsoleStrings (std::vector< std::string > &v) const
	Get the filter messages from the console. To erase strings, either call erase, or erase cahche. More...

void	clearConsole ()

virtual bool	monitorNeedsRefresh () const

virtual bool	isPureDataSource () const

virtual bool	isUsefulAsAppend () const

template<>
bool	applyPropertyNow (bool &prop, const std::string &val, bool &needUp)

template<>
bool	applyPropertyNow (Point3D &prop, const std::string &val, bool &needUp)

template<>
bool	applyPropertyNow (std::string &prop, const std::string &val, bool &needUp)

Static Public Member Functions
static void	setStrongRandom (bool strongRand)
	Should filters use strong randomisation (where applicable) or not? More...

template<typename T >
static void	getStreamsOfType (const std::vector< const FilterStreamData > &vec, std::vector< const T > &dataOut)

Static Public Attributes
static ATOMIC_BOOL *	wantAbort = 0

Protected Member Functions
void	convertFileStringToAbsolute (const string &basePath, std::string &s) const

void	propagateCache (std::vector< const FilterStreamData *> &dataOut) const
	Propagate the cache into output. More...

template<class T >
bool	applyPropertyNow (T &oldProp, const std::string &newVal, bool &needUp)

void	cacheAsNeeded (FilterStreamData *s)

virtual std::string	getSpecificErrString (unsigned int errCode) const =0
	Get the per-filter error codes. More...

Static Protected Member Functions
static unsigned int	collateIons (const std::vector< const FilterStreamData *> &dataIn, std::vector< IonHit > &outVector, ProgressData &prog, size_t totalDataSize=(size_t) -1)

static unsigned int	collateIons (const std::vector< const FilterStreamData *> &dataIn, std::vector< Point3D > &outVector, ProgressData &prog, size_t totalDataSize=(size_t) -1)

static void	propagateStreams (const std::vector< const FilterStreamData > &dataIn, std::vector< const FilterStreamData > &dataOut, size_t mask=STREAMTYPE_MASK_ALL, bool invertMask=false)
	Propagate the given input data to an output vector. More...

static std::string	getBaseErrString (unsigned int errCode)
	Get the generic (applies to any filter) error codes. More...

template<class T >
static unsigned int	extendDataVector (std::vector< T > &dest, const std::vector< IonHit > &vIonData, unsigned int &progress, size_t offset)
	Extend a point data vector using some ion data. More...

template<class T >
static size_t	buildSplitPoints (const vector< const FilterStreamData > &dataIn, ProgressData &progress, size_t totalDataSize, const RangeFile rngF, const vector< bool > &pSourceEnabled, const vector< bool > &pTargetEnabled, vector< T > &pSource, vector< T > &pTarget)

static unsigned int	getIonstreamIonID (const IonStreamData d, const RangeFile r)

static void	demuxKey (unsigned int key, unsigned int &keyType, unsigned int &ionOffset)
	Hack to merge/extract two bits of information into a single property key. More...

static unsigned int	muxKey (unsigned int keyType, unsigned int ionOffset)

Protected Attributes
bool	cache

bool	cacheOK

unsigned int	numStreamsLastRefresh [NUM_STREAM_TYPES]
	Array of the number of streams propagated on last refresh. More...

std::vector< std::string >	consoleOutput
	Temporary console output. Should be only nonzero size if messages are present. More...

std::string	userString
	User settable labelling string (human readable ID, etc etc) More...

std::vector< FilterStreamData * >	filterOutputs

std::vector< SelectionDevice * >	devices
	User interaction "Devices" associated with this filter. More...

Static Protected Attributes
static bool	strongRandom = false

Detailed Description

Abstract base filter class.

Constructor & Destructor Documentation

◆ Filter()

Filter::Filter ( )

References COMPILE_ASSERT, NUM_STREAM_TYPES, numStreamsLastRefresh, STREAM_NAMES, and THREEDEP_ARRAYSIZE.

◆ ~Filter()

Filter::~Filter ( )

virtual

References cacheOK, clearCache(), and clearDevices().

Member Function Documentation

◆ applyPropertyNow() [1/4]

bool Filter::applyPropertyNow	(	bool &	prop,
		const std::string &	val,
		bool &	needUp
	)

References boolStrDec(), and clearCache().

◆ applyPropertyNow() [2/4]

bool Filter::applyPropertyNow	(	Point3D &	prop,
		const std::string &	val,
		bool &	needUp
	)

References clearCache(), and Point3D::parse().

◆ applyPropertyNow() [3/4]

bool Filter::applyPropertyNow	(	std::string &	prop,
		const std::string &	val,
		bool &	needUp
	)

References clearCache().

◆ applyPropertyNow() [4/4]

template<class T >

bool Filter::applyPropertyNow	(	T &	oldProp,
		const std::string &	newVal,
		bool &	needUp
	)

protected

References stream_cast(), and stripWhite().

Here is the caller graph for this function:

◆ buildSplitPoints()

template<class T >

static size_t Filter::buildSplitPoints	(	const vector< const FilterStreamData *> &	dataIn,
		ProgressData &	progress,
		size_t	totalDataSize,
		const RangeFile *	rngF,
		const vector< bool > &	pSourceEnabled,
		const vector< bool > &	pTargetEnabled,
		vector< T > &	pSource,
		vector< T > &	pTarget
	)

inlinestaticprotected

References ASSERT, assignIonData(), IonStreamData::data, FILTER_ERR_ABORT, RangeFile::getIonID(), getIonstreamIonID(), RangeFile::getNumIons(), FilterStreamData::getStreamType(), and STREAM_TYPE_IONS.

Referenced by SpatialAnalysisFilter::setPropFromBinding().

Here is the caller graph for this function:

◆ cacheAsNeeded()

void Filter::cacheAsNeeded ( FilterStreamData * s )

protected

References cache, FilterStreamData::cached, cacheOK, and filterOutputs.

Referenced by IonClipFilter::refresh(), IonColourFilter::refresh(), TransformFilter::refresh(), SpectrumPlotFilter::refresh(), IonDownsampleFilter::refresh(), RangeFileFilter::refresh(), ProfileFilter::refresh(), DataLoadFilter::refresh(), ClusterAnalysisFilter::refresh(), SpatialAnalysisFilter::refresh(), and SpatialAnalysisFilter::setPropFromBinding().

Here is the caller graph for this function:

◆ canBeHazardous()

virtual bool Filter::canBeHazardous ( ) const

inlinevirtual

Can this filter perform actions that are potentially a security concern?

Reimplemented in ExternalProgramFilter.

References FilterStreamData::streamType.

Referenced by PrefDialog::OnResetFilterAllButton(), and ConfigFile::read().

Here is the caller graph for this function:

◆ clearCache()

void Filter::clearCache ( )

virtual

Erase cache.

Reimplemented in VoxeliseFilter.

References ASSERT, cacheOK, and filterOutputs.

Here is the caller graph for this function:

◆ clearConsole()

void Filter::clearConsole ( )

inline

Referenced by FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ clearDevices()

void Filter::clearDevices ( )

virtual

Erase any active devices.

References devices.

Referenced by IonClipFilter::refresh(), AnnotateFilter::refresh(), ProfileFilter::refresh(), FilterTree::refreshFilterTree(), and ~Filter().

Here is the caller graph for this function:

◆ cloneUncached()

virtual Filter* Filter::cloneUncached ( ) const

pure virtual

Duplicate filter contents, excluding cache.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, RangeFileFilter, BoundingBoxFilter, SpectrumPlotFilter, ExternalProgramFilter, IonDownsampleFilter, TransformFilter, IonColourFilter, and IonClipFilter.

Referenced by filterCloneTests().

Here is the caller graph for this function:

◆ collateIons() [1/2]

unsigned int Filter::collateIons	(	const std::vector< const FilterStreamData *> &	dataIn,
		std::vector< IonHit > &	outVector,
		ProgressData &	prog,
		size_t	totalDataSize = `(size_t)-1`
	)

staticprotected

References ASSERT, IonStreamData::data, FILTER_ERR_ABORT, numElements(), STREAM_TYPE_IONS, and wantAbort.

Referenced by SpatialAnalysisFilter::refresh(), and SpatialAnalysisFilter::setPropFromBinding().

Here is the caller graph for this function:

◆ collateIons() [2/2]

unsigned int Filter::collateIons	(	const std::vector< const FilterStreamData *> &	dataIn,
		std::vector< Point3D > &	outVector,
		ProgressData &	prog,
		size_t	totalDataSize = `(size_t)-1`
	)

staticprotected

References IonStreamData::data, extendDataVector(), FILTER_ERR_ABORT, ProgressData::filterProgress, STREAM_TYPE_IONS, and wantAbort.

◆ convertFileStringToAbsolute()

void Filter::convertFileStringToAbsolute	(	const string &	basePath,
		std::string &	s
	)		const

protected

Referenced by RangeFileFilter::readState(), DataLoadFilter::readState(), and SpatialAnalysisFilter::readState().

Here is the caller graph for this function:

◆ demuxKey()

void Filter::demuxKey	(	unsigned int	key,
		unsigned int &	keyType,
		unsigned int &	ionOffset
	)

staticprotected

Hack to merge/extract two bits of information into a single property key.

Referenced by VoxeliseFilter::setProperty(), and SpatialAnalysisFilter::setProperty().

Here is the caller graph for this function:

◆ extendDataVector()

template<class T >

static unsigned int Filter::extendDataVector	(	std::vector< T > &	dest,
		const std::vector< IonHit > &	vIonData,
		unsigned int &	progress,
		size_t	offset
	)

inlinestaticprotected

Extend a point data vector using some ion data.

References assignIonData(), NUM_CALLBACK, and wantAbort.

Referenced by collateIons().

Here is the caller graph for this function:

◆ getBaseErrString()

std::string Filter::getBaseErrString ( unsigned int errCode )

staticprotected

Get the generic (applies to any filter) error codes.

References ASSERT, FilterProperty::checkSelfConsistent(), FILTER_ERR_ABORT, Point3D::parse(), ColourRGBA::parse(), PROPERTY_TYPE_BOOL, PROPERTY_TYPE_CHOICE, PROPERTY_TYPE_COLOUR, PROPERTY_TYPE_ENUM_END, PROPERTY_TYPE_INTEGER, PROPERTY_TYPE_POINT3D, PROPERTY_TYPE_REAL, stream_cast(), TRANS, and WARN.

Referenced by getErrString().

Here is the caller graph for this function:

◆ getConsoleStrings()

void Filter::getConsoleStrings ( std::vector< std::string > & v ) const

inline

Get the filter messages from the console. To erase strings, either call erase, or erase cahche.

Referenced by IonInfoFilter::needsUnrangedData(), and FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ getErrString()

std::string Filter::getErrString ( unsigned int code ) const

Get the human readable error string associated with a particular error code during refresh(...). Do not override this for specific filter errors. Override getSpecificErrString.

References getBaseErrString(), and getSpecificErrString().

Referenced by MainWindowFrame::OnComboFilter().

Here is the caller graph for this function:

◆ getIonstreamIonID()

static unsigned int Filter::getIonstreamIonID	(	const IonStreamData *	d,
		const RangeFile *	r
	)

inlinestaticprotected

References IonStreamData::data, and RangeFile::getIonID().

Referenced by VoxeliseFilter::refresh(), and SpatialAnalysisFilter::setPropFromBinding().

Here is the caller graph for this function:

◆ getNumOutput()

unsigned int Filter::getNumOutput ( unsigned int streamType ) const

Get the number of outputs for the specified type during the filter's last refresh.

References ASSERT, NUM_STREAM_TYPES, and numStreamsLastRefresh.

◆ getProperties()

virtual void Filter::getProperties ( FilterPropGroup & propertyList ) const

pure virtual

Get the properties of the filter, in key-value form. First vector is for each output.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, RangeFileFilter, IonInfoFilter, AnnotateFilter, IonDownsampleFilter, BoundingBoxFilter, SpectrumPlotFilter, TransformFilter, ExternalProgramFilter, IonColourFilter, and IonClipFilter.

Referenced by affectedBySampling(), filterAffectedByComposition(), filterAltersComposition(), filterIsSampling(), ExportAnimationDialog::OnFilterGridCellSelected(), ProgressData::operator=(), ExportAnimationDialog::prepare(), and updateFilterPropertyGrid().

Here is the caller graph for this function:

◆ getRefreshBlockMask()

virtual unsigned int Filter::getRefreshBlockMask ( ) const

pure virtual

Get the bitmask encoded list of filterStreams that this filter blocks from propagation.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, IonDownsampleFilter, RangeFileFilter, SpectrumPlotFilter, BoundingBoxFilter, TransformFilter, ExternalProgramFilter, IonColourFilter, and IonClipFilter.

Referenced by FilterTreeAnalyse::analyse().

Here is the caller graph for this function:

◆ getRefreshEmitMask()

virtual unsigned int Filter::getRefreshEmitMask ( ) const

pure virtual

Get the bitmask encoded list of filterstreams that this filter emits from ::refresh.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, IonDownsampleFilter, RangeFileFilter, SpectrumPlotFilter, BoundingBoxFilter, TransformFilter, ExternalProgramFilter, IonColourFilter, and IonClipFilter.

Referenced by FilterTree::contains().

Here is the caller graph for this function:

◆ getRefreshUseMask()

virtual unsigned int Filter::getRefreshUseMask ( ) const

pure virtual

Mask of filter streams that will be examined by the filter in its computation.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, IonDownsampleFilter, RangeFileFilter, SpectrumPlotFilter, BoundingBoxFilter, TransformFilter, ExternalProgramFilter, IonColourFilter, and IonClipFilter.

Referenced by FilterTreeAnalyse::analyse().

Here is the caller graph for this function:

◆ getSelectionDevices()

void Filter::getSelectionDevices ( std::vector< SelectionDevice *> & devices ) const

Get the selection devices for this filter. MUST be called after refresh()

References ASSERT, and devices.

Referenced by FilterTree::contains(), and FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ getSpecificErrString()

virtual std::string Filter::getSpecificErrString ( unsigned int errCode ) const

protectedpure virtual

Get the per-filter error codes.

Implemented in SpatialAnalysisFilter, DataLoadFilter, ClusterAnalysisFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, RangeFileFilter, AnnotateFilter, IonDownsampleFilter, BoundingBoxFilter, SpectrumPlotFilter, TransformFilter, ExternalProgramFilter, IonClipFilter, and IonColourFilter.

Referenced by getErrString().

Here is the caller graph for this function:

◆ getStateOverrides()

virtual void Filter::getStateOverrides ( std::vector< std::string > & overrides ) const

inlinevirtual

Return the XML elements that refer to external entities (i.e. files) which do not move with the XML files. At this time, only files are supported. These will be looked for on the filesystem and moved as needed.

Reimplemented in SpatialAnalysisFilter, DataLoadFilter, and RangeFileFilter.

◆ getStreamsOfType()

template<typename T >

void Filter::getStreamsOfType	(	const std::vector< const FilterStreamData *> &	vec,
		std::vector< const T *> &	dataOut
	)

static

References applyPropertyNow(), and FilterStreamData::getStreamType().

Referenced by doFitBackground().

Here is the caller graph for this function:

◆ getType()

virtual unsigned int Filter::getType ( ) const

pure virtual

return type ID

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, RangeFileFilter, BoundingBoxFilter, SpectrumPlotFilter, TransformFilter, ExternalProgramFilter, IonDownsampleFilter, IonColourFilter, and IonClipFilter.

Referenced by affectedBySampling(), FilterTreeAnalyse::analyse(), filterAffectedByComposition(), filterAltersComposition(), filterIsSampling(), needsRangeParent(), needsUnrangedData(), RangeEditorDialog::setPlotWrapper(), and PlotWrapper::switchOutRegionParent().

Here is the caller graph for this function:

◆ getUserString()

std::string Filter::getUserString ( ) const

virtual

Return a user-specified string, or just the typestring if user set string not active.

References typeString(), and userString.

Referenced by ExportRngDialog::addRangeData(), FilterTree::contains(), filterCloneTests(), ExportAnimationDialog::prepare(), ExternalProgramFilter::refresh(), SpectrumPlotFilter::refresh(), ProfileFilter::refresh(), FilterTree::refreshFilterTree(), and SpatialAnalysisFilter::setPropFromBinding().

Here is the caller graph for this function:

◆ haveCache()

bool Filter::haveCache ( ) const

Have cached output data?

References cacheOK.

Referenced by FilterTree::contains(), and FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ initFilter()

void Filter::initFilter	(	const std::vector< const FilterStreamData *> &	dataIn,
		std::vector< const FilterStreamData *> &	dataOut
	)

virtual

Initialise the filter's internal state using limited filter stream data propagation.

Reimplemented in SpatialAnalysisFilter, ClusterAnalysisFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, RangeFileFilter, and IonDownsampleFilter.

◆ isPureDataSource()

virtual bool Filter::isPureDataSource ( ) const

inlinevirtual

Reimplemented in DataLoadFilter.

Referenced by MainWindowFrame::OnTreeEndDrag().

Here is the caller graph for this function:

◆ isUsefulAsAppend()

virtual bool Filter::isUsefulAsAppend ( ) const

inlinevirtual

Reimplemented in DataLoadFilter, and AnnotateFilter.

Referenced by FilterTreeAnalyse::analyse().

Here is the caller graph for this function:

◆ monitorNeedsRefresh()

virtual bool Filter::monitorNeedsRefresh ( ) const

inlinevirtual

Reimplemented in DataLoadFilter.

◆ muxKey()

unsigned int Filter::muxKey	(	unsigned int	keyType,
		unsigned int	ionOffset
	)

staticprotected

Referenced by VoxeliseFilter::getProperties(), SpatialAnalysisFilter::getProperties(), and SpatialAnalysisFilter::setPropFromBinding().

Here is the caller graph for this function:

◆ numBytesForCache()

virtual size_t Filter::numBytesForCache ( size_t nObjects ) const

pure virtual

Get (approx) number of bytes required for cache.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, RangeFileFilter, IonDownsampleFilter, SpectrumPlotFilter, BoundingBoxFilter, ExternalProgramFilter, TransformFilter, IonColourFilter, and IonClipFilter.

Referenced by FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ propagateCache()

void Filter::propagateCache ( std::vector< const FilterStreamData *> & dataOut ) const

protected

Propagate the cache into output.

References ASSERT, filterOutputs, and propagateStreams().

Referenced by IonColourFilter::refresh(), ExternalProgramFilter::refresh(), TransformFilter::refresh(), SpectrumPlotFilter::refresh(), IonDownsampleFilter::refresh(), RangeFileFilter::refresh(), ProfileFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), ClusterAnalysisFilter::refresh(), and SpatialAnalysisFilter::refresh().

Here is the caller graph for this function:

◆ propagateStreams()

void Filter::propagateStreams	(	const std::vector< const FilterStreamData *> &	dataIn,
		std::vector< const FilterStreamData *> &	dataOut,
		size_t	mask = `STREAMTYPE_MASK_ALL`,
		bool	invertMask = `false`
	)

staticprotected

Propagate the given input data to an output vector.

Referenced by propagateCache(), IonColourFilter::refresh(), TransformFilter::refresh(), BoundingBoxFilter::refresh(), IonDownsampleFilter::refresh(), AnnotateFilter::refresh(), RangeFileFilter::refresh(), ProfileFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), and SpatialAnalysisFilter::refresh().

Here is the caller graph for this function:

◆ readState()

virtual bool Filter::readState	(	xmlNodePtr &	n,
		const std::string &	packDir = `""`
	)

pure virtual

Read state from XML stream, using xml format.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, RangeFileFilter, IonInfoFilter, AnnotateFilter, IonDownsampleFilter, SpectrumPlotFilter, BoundingBoxFilter, TransformFilter, ExternalProgramFilter, IonColourFilter, and IonClipFilter.

Referenced by filterCloneTests(), FilterTree::loadXML(), and ConfigFile::read().

Here is the caller graph for this function:

◆ refresh()

virtual unsigned int Filter::refresh	(	const std::vector< const FilterStreamData *> &	dataIn,
		std::vector< const FilterStreamData *> &	dataOut,
		ProgressData &	progress
	)

pure virtual

Apply filter to new data, updating cache as needed. Vector of returned pointers must be deleted manually, first checking ->cached.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, RangeFileFilter, IonDownsampleFilter, SpectrumPlotFilter, BoundingBoxFilter, TransformFilter, ExternalProgramFilter, IonClipFilter, and IonColourFilter.

Referenced by FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ setCaching()

void Filter::setCaching ( bool enableCache )

inline

Enable/disable caching for this filter.

Referenced by computeMatrixEntries(), IonColourFilter::getRefreshUseMask(), ExternalProgramFilter::getRefreshUseMask(), BoundingBoxFilter::getRefreshUseMask(), IonDownsampleFilter::getRefreshUseMask(), VoxeliseFilter::getRefreshUseMask(), DataLoadFilter::monitorNeedsRefresh(), SpectrumPlotFilter::needsUnrangedData(), IonInfoFilter::needsUnrangedData(), FilterTree::refreshFilterTree(), IonClipFilter::setPropFromBinding(), TransformFilter::setPropFromBinding(), AnnotateFilter::setPropFromBinding(), ProfileFilter::setPropFromBinding(), SpatialAnalysisFilter::setPropFromBinding(), and RangeFileFilter::writePackageState().

Here is the caller graph for this function:

◆ setProperty()

virtual bool Filter::setProperty	(	unsigned int	key,
		const std::string &	value,
		bool &	needUpdate
	)

pure virtual

Set the properties for the nth filter, needUpdate tells us if filter output changes due to property set

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, RangeFileFilter, IonInfoFilter, AnnotateFilter, IonDownsampleFilter, BoundingBoxFilter, SpectrumPlotFilter, TransformFilter, ExternalProgramFilter, IonColourFilter, and IonClipFilter.

Referenced by filterRefreshNoOut(), PrefDialog::OnFilterCellChange(), ProgressData::operator=(), and FilterTree::setFilterProperty().

Here is the caller graph for this function:

◆ setPropFromBinding()

virtual void Filter::setPropFromBinding ( const SelectionBinding & b )

pure virtual

Set the binding value for a float.

Implemented in SpatialAnalysisFilter, DataLoadFilter, ClusterAnalysisFilter, VoxeliseFilter, ProfileFilter, RangeFileFilter, IonInfoFilter, AnnotateFilter, SpectrumPlotFilter, BoundingBoxFilter, IonDownsampleFilter, TransformFilter, ExternalProgramFilter, IonClipFilter, and IonColourFilter.

◆ setPropFromRegion()

void Filter::setPropFromRegion	(	unsigned int	method,
		unsigned int	regionID,
		float	newPos
	)

virtual

Set a region update.

Reimplemented in RangeFileFilter.

References ASSERT.

Referenced by PlotRegion::updateParent().

Here is the caller graph for this function:

◆ setStrongRandom()

static void Filter::setStrongRandom ( bool strongRand )

inlinestatic

Should filters use strong randomisation (where applicable) or not?

Referenced by MainWindowFrame::OnCheckWeakRandom().

Here is the caller graph for this function:

◆ setUserString()

virtual void Filter::setUserString ( const std::string & str )

inlinevirtual

Set a user-specified string return value is.

Reimplemented in SpatialAnalysisFilter, ProfileFilter, and SpectrumPlotFilter.

Referenced by filterTreeTests(), and TreeState::setFilterString().

Here is the caller graph for this function:

◆ trueName()

std::string Filter::trueName ( ) const

inline

Return the unique name for a given filter – DO NOT TRANSLATE.

References FILTER_NAMES.

Here is the caller graph for this function:

◆ typeString()

virtual std::string Filter::typeString ( ) const

pure virtual

Return filter type as std::string.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, AnnotateFilter, RangeFileFilter, IonDownsampleFilter, BoundingBoxFilter, SpectrumPlotFilter, TransformFilter, ExternalProgramFilter, IonClipFilter, and IonColourFilter.

Referenced by FilterTreeAnalyse::analyse(), getUserString(), makeFilterFromDefUserString(), MainWindowFrame::OnUpdateTimer(), and PrefDialog::~PrefDialog().

Here is the caller graph for this function:

◆ updateOutputInfo()

void Filter::updateOutputInfo ( const std::vector< const FilterStreamData *> & dataOut )

Update the output statistics for this filter (num items of streams of each type output)

References ASSERT, getBitNum(), NUM_STREAM_TYPES, and numStreamsLastRefresh.

Referenced by FilterTree::refreshFilterTree().

Here is the caller graph for this function:

◆ writePackageState()

virtual bool Filter::writePackageState	(	std::ostream &	f,
		unsigned int	format,
		const std::vector< std::string > &	valueOverrides,
		unsigned int	depth = `0`
	)		const

inlinevirtual

Modified version of writeState for packaging. By default simply calls writeState.

Reimplemented in SpatialAnalysisFilter, DataLoadFilter, and RangeFileFilter.

◆ writeState()

virtual bool Filter::writeState	(	std::ostream &	f,
		unsigned int	format,
		unsigned int	depth = `0`
	)		const

pure virtual

Dump state to output stream, using specified format.

Implemented in SpatialAnalysisFilter, ClusterAnalysisFilter, DataLoadFilter, VoxeliseFilter, ProfileFilter, IonInfoFilter, RangeFileFilter, AnnotateFilter, IonDownsampleFilter, SpectrumPlotFilter, BoundingBoxFilter, TransformFilter, ExternalProgramFilter, IonClipFilter, and IonColourFilter.

Referenced by filterCloneTests().

Here is the caller graph for this function:

Member Data Documentation

◆ cache

bool Filter::cache

protected

◆ cacheOK

bool Filter::cacheOK

protected

◆ consoleOutput

std::vector<std::string> Filter::consoleOutput

protected

Temporary console output. Should be only nonzero size if messages are present.

Referenced by SpectrumPlotFilter::refresh(), IonInfoFilter::refresh(), ProfileFilter::refresh(), VoxeliseFilter::refresh(), DataLoadFilter::refresh(), ClusterAnalysisFilter::refresh(), ClusterAnalysisFilter::setPropFromBinding(), and SpatialAnalysisFilter::setPropFromBinding().

◆ devices

std::vector<SelectionDevice *> Filter::devices

protected

User interaction "Devices" associated with this filter.

Referenced by clearDevices(), getSelectionDevices(), IonClipFilter::refresh(), TransformFilter::refresh(), AnnotateFilter::refresh(), ProfileFilter::refresh(), and VoxeliseFilter::refresh().

◆ filterOutputs

std::vector<FilterStreamData *> Filter::filterOutputs

protected

Referenced by cacheAsNeeded(), clearCache(), propagateCache(), IonClipFilter::refresh(), IonColourFilter::refresh(), ExternalProgramFilter::refresh(), ProfileFilter::refresh(), VoxeliseFilter::refresh(), ClusterAnalysisFilter::refresh(), SpectrumPlotFilter::setProperty(), RangeFileFilter::setProperty(), VoxeliseFilter::setProperty(), DataLoadFilter::setProperty(), ClusterAnalysisFilter::setProperty(), SpatialAnalysisFilter::setProperty(), and SpatialAnalysisFilter::setPropFromBinding().

◆ numStreamsLastRefresh

unsigned int Filter::numStreamsLastRefresh[NUM_STREAM_TYPES]

protected

Array of the number of streams propagated on last refresh.

Referenced by Filter(), getNumOutput(), and updateOutputInfo().

◆ strongRandom

bool Filter::strongRandom = false

staticprotected

Referenced by IonDownsampleFilter::refresh(), and DataLoadFilter::refresh().

◆ userString

std::string Filter::userString

protected

User settable labelling string (human readable ID, etc etc)

◆ wantAbort

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Filter()

◆ ~Filter()

Member Function Documentation

◆ applyPropertyNow() [1/4]

◆ applyPropertyNow() [2/4]

◆ applyPropertyNow() [3/4]

◆ applyPropertyNow() [4/4]

◆ buildSplitPoints()

◆ cacheAsNeeded()

◆ canBeHazardous()

◆ clearCache()

◆ clearConsole()

◆ clearDevices()

◆ cloneUncached()

◆ collateIons() [1/2]

◆ collateIons() [2/2]

◆ convertFileStringToAbsolute()

◆ demuxKey()

◆ extendDataVector()

◆ getBaseErrString()

◆ getConsoleStrings()

◆ getErrString()

◆ getIonstreamIonID()

◆ getNumOutput()

◆ getProperties()

◆ getRefreshBlockMask()

◆ getRefreshEmitMask()

◆ getRefreshUseMask()

◆ getSelectionDevices()

◆ getSpecificErrString()

◆ getStateOverrides()

◆ getStreamsOfType()

◆ getType()

◆ getUserString()

◆ haveCache()

◆ initFilter()

◆ isPureDataSource()

◆ isUsefulAsAppend()

◆ monitorNeedsRefresh()

◆ muxKey()

◆ numBytesForCache()

◆ propagateCache()

◆ propagateStreams()

◆ readState()

◆ refresh()

◆ setCaching()

◆ setProperty()

◆ setPropFromBinding()

◆ setPropFromRegion()

◆ setStrongRandom()

◆ setUserString()

◆ trueName()

◆ typeString()

◆ updateOutputInfo()

◆ writePackageState()

◆ writeState()

Member Data Documentation

◆ cache

◆ cacheOK

◆ consoleOutput

◆ devices

◆ filterOutputs

◆ numStreamsLastRefresh

◆ strongRandom

◆ userString

◆ wantAbort