VtkStationSource Class Reference

Detailed Description

VTK source object for the visualisation of station data (including boreholes)

Definition at line 27 of file VtkStationSource.h.

#include <VtkStationSource.h>

Inheritance diagram for VtkStationSource:

Collaboration diagram for VtkStationSource:

Public Member Functions
	vtkTypeMacro (VtkStationSource, vtkPolyDataAlgorithm)
const std::map< std::string, DataHolderLib::Color > &	getColorLookupTable () const
void	setStations (const std::vector< GeoLib::Point * > *stations)
	Sets a predefined color lookup table for the colouring of borehole stratigraphies.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Prints its data on a stream.
void	SetUserProperty (QString name, QVariant value) override
	Sets a user property. This should be implemented by subclasses.
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.
virtual void	SetUserVectorProperty (QString name, QList< QVariant > values)
	Sets a vector user property. This should be implemented by subclasses.
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.

Static Public Member Functions
static VtkStationSource *	New ()
	Create new objects with New() because of VTKs object reference counting.

Protected Member Functions
	VtkStationSource ()
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	Computes the polygonal data object.
int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override

Protected Attributes
const std::vector< GeoLib::Point * > *	_stations {nullptr}
	The stations to visualize.
std::map< std::string, DataHolderLib::Color >	_colorLookupTable
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

Private Member Functions
std::size_t	GetIndexByName (std::string const &name)

Private Attributes
std::map< std::string, vtkIdType >	_id_map

Additional Inherited Members
Signals inherited from VtkAlgorithmProperties
void	ScalarVisibilityChanged (bool on)

Constructor & Destructor Documentation

VtkStationSource()

VtkStationSource::VtkStationSource ( )

protected

Definition at line 37 of file VtkStationSource.cpp.

{
    _removable = false;  // From VtkAlgorithmProperties
    this->SetNumberOfInputPorts(0);
 
    const DataHolderLib::Color c = DataHolderLib::getRandomColor();
    GetProperties()->SetColor(c[0] / 255.0, c[1] / 255.0, c[2] / 255.0);
}

References VtkAlgorithmProperties::_removable, VtkAlgorithmProperties::GetProperties(), and DataHolderLib::getRandomColor().

Member Function Documentation

getColorLookupTable()

const std::map< std::string, DataHolderLib::Color > & VtkStationSource::getColorLookupTable ( ) const

inline

Returns the colour lookup table generated for boreholes. This method should only be called after the colour lookup table has actually been build (via RequestData() or setColorLookupTable()).

Definition at line 37 of file VtkStationSource.h.

        { return _colorLookupTable; }

References _colorLookupTable.

Referenced by StationTreeView::displayStratigraphy(), and StationTreeView::writeStratigraphiesAsImages().

GetIndexByName()

std::size_t VtkStationSource::GetIndexByName ( std::string const & name )

private

Definition at line 226 of file VtkStationSource.cpp.

{
    vtkIdType max_key(0);
    for (auto& it : _id_map)
    {
        if (name == it.first)
        {
            return it.second;
        }
        if (it.second > max_key)
        {
            max_key = it.second;
        }
    }
 
    vtkIdType new_index = (_id_map.empty()) ? 0 : (max_key + 1);
    INFO("Key '{:s}' has been assigned index {:d}.", name, new_index);
    _id_map.insert(std::pair<std::string, vtkIdType>(name, new_index));
    return new_index;
}

References _id_map, and INFO().

Referenced by RequestData().

New()

static VtkStationSource * VtkStationSource::New ( )

static

Create new objects with New() because of VTKs object reference counting.

PrintSelf()

void VtkStationSource::PrintSelf ( ostream & os, vtkIndent indent )

override

Prints its data on a stream.

Definition at line 46 of file VtkStationSource.cpp.

{
    this->Superclass::PrintSelf(os, indent);
 
    if (_stations->empty())
    {
        return;
    }
 
    os << indent << "== VtkStationSource =="
       << "\n";
 
    int i = 0;
    for (auto station : *_stations)
    {
        os << indent << "Station " << i << " (" << (*station)[0] << ", "
           << (*station)[1] << ", " << (*station)[2] << ")\n";
        i++;
    }
}

References _stations.

RequestData()

int VtkStationSource::RequestData ( vtkInformation * request, vtkInformationVector ** inputVector, vtkInformationVector * outputVector )

overrideprotected

Computes the polygonal data object.

Create 3d Station objects.

Definition at line 68 of file VtkStationSource.cpp.

{
    (void)request;
    (void)inputVector;
 
    if (!_stations)
    {
        return 0;
    }
    std::size_t nStations = _stations->size();
    if (nStations == 0)
    {
        return 0;
    }
 
    bool useStationValues(false);
    double sValue =
        static_cast<GeoLib::Station*>((*_stations)[0])->getStationValue();
    for (std::size_t i = 1; i < nStations; i++)
    {
        if (static_cast<GeoLib::Station*>((*_stations)[i])->getStationValue() !=
            sValue)
        {
            useStationValues = true;
            break;
        }
    }
 
    bool isBorehole = dynamic_cast<GeoLib::StationBorehole*>((*_stations)[0]);
 
    vtkSmartPointer<vtkInformation> outInfo =
        outputVector->GetInformationObject(0);
    vtkSmartPointer<vtkPolyData> output =
        vtkPolyData::SafeDownCast(outInfo->Get(vtkDataObject::DATA_OBJECT()));
 
    vtkSmartPointer<vtkPoints> newStations = vtkSmartPointer<vtkPoints>::New();
    vtkSmartPointer<vtkCellArray> newVerts =
        vtkSmartPointer<vtkCellArray>::New();
    newVerts->Allocate(nStations);
 
    vtkSmartPointer<vtkCellArray> newLines;
 
    if (isBorehole)
    {
        newLines = vtkSmartPointer<vtkCellArray>::New();
    }
 
    if (outInfo->Get(vtkStreamingDemandDrivenPipeline::UPDATE_PIECE_NUMBER()) >
        0)
    {
        return 1;
    }
 
    vtkSmartPointer<vtkIntArray> station_ids =
        vtkSmartPointer<vtkIntArray>::New();
    station_ids->SetNumberOfComponents(1);
    station_ids->SetName("SiteIDs");
 
    vtkSmartPointer<vtkDoubleArray> station_values =
        vtkSmartPointer<vtkDoubleArray>::New();
    station_values->SetNumberOfComponents(1);
    station_values->SetName("StationValue");
 
    vtkSmartPointer<vtkIntArray> strat_ids =
        vtkSmartPointer<vtkIntArray>::New();
    strat_ids->SetNumberOfComponents(1);
    strat_ids->SetName("Stratigraphies");
 
    std::size_t lastMaxIndex(0);
    std::size_t site_count(0);
 
    // Generate graphic objects
    for (auto station : *_stations)
    {
        vtkIdType sid = newStations->InsertNextPoint(station->data());
        station_ids->InsertNextValue(site_count);
        if (useStationValues)
        {
            station_values->InsertNextValue(
                static_cast<GeoLib::Station*>(station)->getStationValue());
        }
 
        if (!isBorehole)
        {
            newVerts->InsertNextCell(1, &sid);
        }
        else
        {
            std::vector<GeoLib::Point*> profile =
                static_cast<GeoLib::StationBorehole*>(station)->getProfile();
            std::vector<std::string> soilNames =
                static_cast<GeoLib::StationBorehole*>(station)->getSoilNames();
            const std::size_t nLayers = profile.size();
 
            for (std::size_t i = 1; i < nLayers; i++)
            {
                newStations->InsertNextPoint(profile[i]->data());
                station_ids->InsertNextValue(site_count);
                newLines->InsertNextCell(2);
                newLines->InsertCellPoint(
                    lastMaxIndex);  // start of borehole-layer
                newLines->InsertCellPoint(
                    ++lastMaxIndex);  // end of boreholelayer
                strat_ids->InsertNextValue(this->GetIndexByName(soilNames[i]));
                if (useStationValues)
                {
                    station_values->InsertNextValue(
                        static_cast<GeoLib::Station*>(station)
                            ->getStationValue());
                }
            }
            lastMaxIndex++;
        }
        site_count++;
    }
 
    output->SetPoints(newStations);
 
    if (!isBorehole)
    {
        output->SetVerts(newVerts);
        output->GetCellData()->AddArray(station_ids);
        output->GetCellData()->SetActiveAttribute(
            "SiteIDs", vtkDataSetAttributes::SCALARS);
    }
    else
    {
        output->SetLines(newLines);
        // output->GetCellData()->AddArray(station_ids);
        output->GetCellData()->AddArray(strat_ids);
        output->GetCellData()->SetActiveAttribute(
            "Stratigraphies", vtkDataSetAttributes::SCALARS);
    }
    if (useStationValues)
    {
        output->GetPointData()->AddArray(station_values);
    }
 
    output->Squeeze();
 
    return 1;
}

References _stations, GetIndexByName(), and GeoLib::Station::getStationValue().

RequestInformation()

int VtkStationSource::RequestInformation ( vtkInformation * request, vtkInformationVector ** inputVector, vtkInformationVector * outputVector )

overrideprotected

Definition at line 213 of file VtkStationSource.cpp.

{
    return 1;
}

setStations()

void VtkStationSource::setStations ( const std::vector< GeoLib::Point * > * stations )

inline

Sets a predefined color lookup table for the colouring of borehole stratigraphies.

Sets the stations as a vector

Definition at line 45 of file VtkStationSource.h.

{ _stations = stations; }

References _stations.

SetUserProperty()

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

overridevirtual

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

Reimplemented from VtkAlgorithmProperties.

Definition at line 220 of file VtkStationSource.cpp.

{
    Q_UNUSED(name);
    Q_UNUSED(value);
}

vtkTypeMacro()

VtkStationSource::vtkTypeMacro	(	VtkStationSource	,
		vtkPolyDataAlgorithm	)

Member Data Documentation

_colorLookupTable

std::map<std::string, DataHolderLib::Color> VtkStationSource::_colorLookupTable

protected

The colour table for stratigraphic data. This table is either set using the setColorLookupTable() method or is generated automatically with random colours while creating the VtkStationSource-object.

Definition at line 69 of file VtkStationSource.h.

Referenced by getColorLookupTable().

_id_map

std::map<std::string, vtkIdType> VtkStationSource::_id_map

private

Definition at line 74 of file VtkStationSource.h.

Referenced by GetIndexByName().

_stations

const std::vector<GeoLib::Point*>* VtkStationSource::_stations {nullptr}

protected

The stations to visualize.

Definition at line 65 of file VtkStationSource.h.

{nullptr};

Referenced by PrintSelf(), RequestData(), and setStations().

---

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

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