DataFilter array providing some convenience functions. More...
#include <OpenMS/FILTERING/DATAREDUCTION/DataFilters.h>
| Classes | |
| struct | DataFilter | 
| Representation of a peak/feature filter combining FilterType, FilterOperation and a value.  More... | |
| Public Types | |
| enum | FilterType { INTENSITY, QUALITY, CHARGE, SIZE, META_DATA } | 
| Information to filter.  More... | |
| enum | FilterOperation { GREATER_EQUAL, EQUAL, LESS_EQUAL, EXISTS } | 
| Filter operation.  More... | |
| Public Member Functions | |
| DataFilters () | |
| Size | size () const | 
| Filter count.  More... | |
| const DataFilter & | operator[] (Size index) const | 
| Filter accessor.  More... | |
| void | add (const DataFilter &filter) | 
| Adds a filter.  More... | |
| void | remove (Size index) | 
| Removes the filter corresponding to index.  More... | |
| void | replace (Size index, const DataFilter &filter) | 
| Replaces the filter corresponding to index.  More... | |
| void | clear () | 
| Removes all filters.  More... | |
| void | setActive (bool is_active) | 
| Enables/disables the all the filters.  More... | |
| bool | isActive () const | 
| Returns if the filters are enabled.  More... | |
| bool | passes (const Feature &feature) const | 
| Returns if the featurefulfills the current filter criteria.  More... | |
| bool | passes (const ConsensusFeature &consensus_feature) const | 
| Returns if the consensus_featurefulfills the current filter criteria.  More... | |
| template<class PeakType > | |
| bool | passes (const MSSpectrum< PeakType > &spectrum, Size peak_index) const | 
| Returns if the peakfulfills the current filter criteria.  More... | |
| Protected Member Functions | |
| bool | metaPasses_ (const MetaInfoInterface &meta_interface, const DataFilters::DataFilter &filter, Size index) const | 
| Returns if the meta value at indexofmeta_interface(a peak or feature) passes thefilter.  More... | |
| Protected Attributes | |
| std::vector< DataFilter > | filters_ | 
| Array of DataFilters.  More... | |
| std::vector< Size > | meta_indices_ | 
| Vector of meta indices acting as index cache.  More... | |
| bool | is_active_ | 
| Determines if the filters are activated.  More... | |
DataFilter array providing some convenience functions.
| enum FilterOperation | 
| enum FilterType | 
| 
 | inline | 
| void add | ( | const DataFilter & | filter | ) | 
Adds a filter.
Referenced by TOPPViewBase::addData(), and TOPPViewBase::filterContextMenu().
| void clear | ( | ) | 
Removes all filters.
| 
 | inline | 
Returns if the filters are enabled.
They are automatically enabled when a filter is added and automatically disabled when the last filter is removed
Referenced by TOPPViewBase::updateFilterBar().
| 
 | inlineprotected | 
Returns if the meta value at index of meta_interface (a peak or feature) passes the filter. 
References DataValue::EMPTY_VALUE, MetaInfoInterface::getMetaValue(), MetaInfoInterface::metaValueExists(), DataFilters::DataFilter::op, DataValue::STRING_VALUE, DataValue::toString(), DataFilters::DataFilter::value, DataFilters::DataFilter::value_is_numerical, DataFilters::DataFilter::value_string, and DataValue::valueType().
| const DataFilter& operator[] | ( | Size | index | ) | const | 
Filter accessor.
| Exception::IndexOverflow | is thrown for invalid indices | 
| bool passes | ( | const Feature & | feature | ) | const | 
Returns if the feature fulfills the current filter criteria. 
| bool passes | ( | const ConsensusFeature & | consensus_feature | ) | const | 
Returns if the consensus_feature fulfills the current filter criteria. 
| 
 | inline | 
Returns if the peak fulfills the current filter criteria. 
References DataFilters::DataFilter::field, MSSpectrum< PeakT >::getFloatDataArrays(), MSSpectrum< PeakT >::getIntegerDataArrays(), DataFilters::DataFilter::meta_name, DataFilters::DataFilter::op, and DataFilters::DataFilter::value.
| void remove | ( | Size | index | ) | 
Removes the filter corresponding to index. 
| Exception::IndexOverflow | is thrown for invalid indices | 
Referenced by TOPPViewBase::filterContextMenu().
| void replace | ( | Size | index, | 
| const DataFilter & | filter | ||
| ) | 
Replaces the filter corresponding to index. 
| Exception::IndexOverflow | is thrown for invalid indices | 
Referenced by TOPPViewBase::filterEdit().
| void setActive | ( | bool | is_active | ) | 
Enables/disables the all the filters.
| Size size | ( | ) | const | 
Filter count.
Referenced by TOPPViewBase::updateFilterBar().
| 
 | protected | 
Array of DataFilters.
| 
 | protected | 
Determines if the filters are activated.
| 
 | protected | 
Vector of meta indices acting as index cache.
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:29 using doxygen 1.8.5 |