VtkCompositeThresholdFilter Class Reference

Detailed Description

Visualises only parts of meshes that are above/below/within given thresholds. In init() the threshold is first set to double min / max values. Set the threshold later on via SetUserVectorProperty() to the actual data range.

Definition at line 22 of file VtkCompositeThresholdFilter.h.

#include <VtkCompositeThresholdFilter.h>

Inheritance diagram for VtkCompositeThresholdFilter:

Collaboration diagram for VtkCompositeThresholdFilter:

Public Member Functions
	VtkCompositeThresholdFilter (vtkAlgorithm *inputAlgorithm)
	~VtkCompositeThresholdFilter () override
void	init () override
void	SetUserProperty (QString name, QVariant value) override
	Sets a user property. This should be implemented by subclasses.
void	SetUserVectorProperty (QString name, QList< QVariant > values) override
	Sets a vector user property. This should be implemented by subclasses.
Public Member Functions inherited from VtkCompositeFilter
	VtkCompositeFilter (vtkAlgorithm *inputAlgorithm)
	Constructor.
	~VtkCompositeFilter () override
	Destructor.
int	GetInputDataObjectType () const
int	GetOutputDataObjectType () const
vtkAlgorithm *	GetOutputAlgorithm () const
Public Member Functions inherited from VtkAlgorithmProperties
	VtkAlgorithmProperties (QObject *parent=nullptr)
	Constructor (sets default values)
	~VtkAlgorithmProperties () override
vtkProperty *	GetProperties () const
	Returns the vtk properties.
vtkTexture *	GetTexture ()
	Returns a texture (if one has been assigned).
void	SetTexture (vtkTexture *t)
	Sets a texture for the VtkVisPipelineItem.
vtkLookupTable *	GetLookupTable (const QString &array_name)
	Returns the colour lookup table (if one has been assigned).
void	RemoveLookupTable (const QString &array_name)
	Removes the lookup table for the given scalar.
void	SetLookUpTable (const QString &array_name, vtkLookupTable *lut)
	Sets a colour lookup table for the given scalar array of the VtkVisPipelineItem.
void	SetLookUpTable (const QString &array_name, const QString &filename)
	Loads a predefined color lookup table from a file for the specified scalar array.
bool	GetScalarVisibility () const
	Returns the scalar visibility.
void	SetScalarVisibility (bool on)
	Sets the scalar visibility.
QString	GetName () const
	Returns the name. This is set to the file path if it is a source algorithm.
void	SetName (QString name)
	Sets the name.
bool	IsRemovable () const
	Is this algorithm removable from the pipeline (view).
QMap< QString, QVariant > *	GetAlgorithmUserProperties () const
	Returns a map of user properties.
QMap< QString, QList< QVariant > > *	GetAlgorithmUserVectorProperties () const
	Returns a map of vector user properties.
QVariant	GetUserProperty (QString name) const
	Returns the value of a user property.
QList< QVariant >	GetUserVectorProperty (QString name) const
	Returns a list of values of a vector user property.
void	SetActiveAttribute (QString name)
	Set the active attribute.
QString	GetActiveAttribute () const
	Returns the desired active attribute.

Additional Inherited Members
Signals inherited from VtkAlgorithmProperties
void	ScalarVisibilityChanged (bool on)
Protected Member Functions inherited from VtkCompositeFilter
double	GetInitialRadius () const
	Calculates a 1/200th of the largest extension of the bounding box (this is used as default radius for various filters)
Protected Attributes inherited from VtkCompositeFilter
int	_inputDataObjectType
int	_outputDataObjectType
vtkAlgorithm *	_inputAlgorithm
vtkAlgorithm *	_outputAlgorithm
Protected Attributes inherited from VtkAlgorithmProperties
vtkProperty *	_property
vtkTexture *	_texture
bool	_scalarVisibility
std::map< QString, vtkLookupTable * >	_lut
QString	_name
QString	_activeAttributeName
bool	_removable
QMap< QString, QVariant > *	_algorithmUserProperties
QMap< QString, QList< QVariant > > *	_algorithmUserVectorProperties

Constructor & Destructor Documentation

VtkCompositeThresholdFilter()

VtkCompositeThresholdFilter::VtkCompositeThresholdFilter ( vtkAlgorithm * inputAlgorithm )

explicit

Definition at line 24 of file VtkCompositeThresholdFilter.cpp.

    : VtkCompositeFilter(inputAlgorithm)
{
    this->init();
}

References init().

~VtkCompositeThresholdFilter()

VtkCompositeThresholdFilter::~VtkCompositeThresholdFilter ( )

overridedefault

Member Function Documentation

init()

void VtkCompositeThresholdFilter::init ( )

overridevirtual

Implements VtkCompositeFilter.

Definition at line 33 of file VtkCompositeThresholdFilter.cpp.

{
    // Set meta information about input and output data types
    this->_inputDataObjectType = VTK_DATA_SET;
    this->_outputDataObjectType = VTK_UNSTRUCTURED_GRID;
 
    // Because this is the only filter here we cannot use vtkSmartPointer
    vtkThreshold* threshold = vtkThreshold::New();
    threshold->SetInputConnection(_inputAlgorithm->GetOutputPort());
 
    // Use first array of parent as input array
    _inputAlgorithm->Update();
    vtkDataSet* dataSet =
        vtkDataSet::SafeDownCast(_inputAlgorithm->GetOutputDataObject(0));
    vtkDataSetAttributes* pointAttributes =
        dataSet->GetAttributes(vtkDataObject::AttributeTypes::POINT);
    vtkDataSetAttributes* cellAttributes =
        dataSet->GetAttributes(vtkDataObject::AttributeTypes::CELL);
    if (pointAttributes->GetNumberOfArrays() > 0)
    {
        threshold->SetInputArrayToProcess(
            0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS,
            pointAttributes->GetArray(0)->GetName());
    }
    else if (cellAttributes->GetNumberOfArrays() > 0)
    {
        threshold->SetInputArrayToProcess(
            0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_CELLS,
            cellAttributes->GetArray(0)->GetName());
    }
    else
    {
        WARN("Threshold filter could not find an array on its input object!");
        return;
    }
 
    // Sets a filter property which will be user editable
    threshold->SetSelectedComponent(0);
 
    // Setting the threshold to min / max values to ensure that the whole data
    // is first processed. This is needed for correct lookup table generation.
    const double dMin = std::numeric_limits<double>::lowest();
    const double dMax = std::numeric_limits<double>::max();
    threshold->SetThresholdFunction(
        vtkThreshold::ThresholdType::THRESHOLD_BETWEEN);
    threshold->SetLowerThreshold(dMin);
    threshold->SetUpperThreshold(dMax);
 
    // Create a list for the ThresholdBetween (vector) property.
    QList<QVariant> thresholdRangeList;
    // Insert the values (same values as above)
    thresholdRangeList.push_back(dMin);
    thresholdRangeList.push_back(dMax);
    // Put that list in the property map
    (*_algorithmUserVectorProperties)["Range"] = thresholdRangeList;
 
    // Make a new entry in the property map for the SelectedComponent property
    (*_algorithmUserProperties)["Selected Component"] = 0;
 
    // Must all scalars match the criterium
    threshold->SetAllScalars(1);
    (*_algorithmUserProperties)["Evaluate all points"] = true;
 
    // The threshold filter is last one and so it is also the _outputAlgorithm
    _outputAlgorithm = threshold;
}

References VtkCompositeFilter::_inputAlgorithm, VtkCompositeFilter::_inputDataObjectType, VtkCompositeFilter::_outputAlgorithm, VtkCompositeFilter::_outputDataObjectType, and WARN().

Referenced by VtkCompositeThresholdFilter().

SetUserProperty()

void VtkCompositeThresholdFilter::SetUserProperty ( QString name, QVariant value )

overridevirtual

Sets a user property. This should be implemented by subclasses.

Reimplemented from VtkAlgorithmProperties.

Definition at line 100 of file VtkCompositeThresholdFilter.cpp.

{
    VtkAlgorithmProperties::SetUserProperty(name, value);
 
    // Use the same name as in init()
    if (name.compare("Selected Component") == 0)
    {
        // Set the property on the algorithm
        static_cast<vtkThreshold*>(_outputAlgorithm)
            ->SetSelectedComponent(value.toInt());
    }
    else if (name.compare("Evaluate all points") == 0)
    {
        static_cast<vtkThreshold*>(_outputAlgorithm)
            ->SetAllScalars(value.toBool());
    }
}

References VtkCompositeFilter::_outputAlgorithm, and VtkAlgorithmProperties::SetUserProperty().

SetUserVectorProperty()

void VtkCompositeThresholdFilter::SetUserVectorProperty ( QString name, QList< QVariant > values )

overridevirtual

Sets a vector user property. This should be implemented by subclasses.

Reimplemented from VtkAlgorithmProperties.

Definition at line 118 of file VtkCompositeThresholdFilter.cpp.

{
    VtkAlgorithmProperties::SetUserVectorProperty(name, values);
 
    // Use the same name as in init()
    if (name.compare("Range") == 0)
    {
        // Set the vector property on the algorithm
        static_cast<vtkThreshold*>(_outputAlgorithm)
            ->SetThresholdFunction(
                vtkThreshold::ThresholdType::THRESHOLD_BETWEEN);
        static_cast<vtkThreshold*>(_outputAlgorithm)
            ->SetLowerThreshold(values[0].toDouble());
        static_cast<vtkThreshold*>(_outputAlgorithm)
            ->SetUpperThreshold(values[1].toDouble());
    }
}

References VtkCompositeFilter::_outputAlgorithm, and VtkAlgorithmProperties::SetUserVectorProperty().

---

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

• Applications/DataExplorer/VtkVis/VtkCompositeThresholdFilter.h
• Applications/DataExplorer/VtkVis/VtkCompositeThresholdFilter.cpp