VtkVisImageItem Class Reference

Detailed Description

An item in the VtkVisPipeline containing an image to be visualized.

Any vtkImageAlgorithm object is represented by a VtkVisImageItem to be assigned a mapper, an actor and its visualization properties.

See also

VtkVisPipelineItem

Definition at line 36 of file VtkVisImageItem.h.

#include <VtkVisImageItem.h>

Inheritance diagram for VtkVisImageItem:

Collaboration diagram for VtkVisImageItem:

Public Member Functions
	VtkVisImageItem (vtkAlgorithm *algorithm, TreeItem *parentItem, const QList< QVariant > data=QList< QVariant >())
	Constructor for a source/filter object.
	VtkVisImageItem (VtkCompositeFilter *compositeFilter, TreeItem *parentItem, const QList< QVariant > data=QList< QVariant >())
	Constructor for composite filter.
	~VtkVisImageItem () override
void	Initialize (vtkRenderer *renderer) override
	Initializes vtkMapper and vtkActor necessary for visualization of the item and sets the item's properties.
void	setTranslation (double x, double y, double z) const override
	Translates the item in visualisation-space. This function is empty and needs to be implemented by derived classes.
vtkAlgorithm *	transformFilter () const override
bool	writeAsRaster ()
	Allows writing this item's source object as an ASCII raster file.
Public Member Functions inherited from VtkVisPipelineItem
	VtkVisPipelineItem (vtkAlgorithm *algorithm, TreeItem *parentItem, const QList< QVariant > data=QList< QVariant >())
	Constructor for a source/filter object.
	VtkVisPipelineItem (VtkCompositeFilter *compositeFilter, TreeItem *parentItem, const QList< QVariant > data=QList< QVariant >())
	Constructor for composite filter.
	~VtkVisPipelineItem () override
VtkVisPipelineItem *	child (int row) const
	Returns a VtkVisPipelineItem.
QVariant	data (int column) const override
bool	setData (int column, const QVariant &value) override
vtkAlgorithm *	algorithm () const
	Returns the algorithm object.
vtkProp3D *	actor () const
	Returns the actor as vtkProp3D.
virtual QString	GetActiveAttribute () const
virtual void	SetActiveAttribute (const QString &str)
VtkCompositeFilter *	compositeFilter () const
	Returns the composite filter.
bool	isVisible () const
	Returns if the VTK object is visible in the visualization.
void	setVisible (bool visible)
	Sets the visibility of the VTK object in the visualization.
int	writeToFile (const std::string &filename) const
	Writes this algorithm's vtkDataSet (i.e. vtkPolyData or vtkUnstructuredGrid) to a vtk-file.
virtual void	setScale (double x, double y, double z) const
	Scales the data in visualisation-space. This function is empty and needs to be implemented by derived classes.
void	setScaleOnChildren (double x, double y, double z) const
	Sets the geometry and date scaling recursively on all children of this item.
virtual void	setBackfaceCulling (bool enable) const
	Enables / disables backface culling.
void	setBackfaceCullingOnChildren (bool enable) const
	Enables / disables backface culling on all children.
QStringList	getScalarArrayNames () const
	Returns a list of array names prefixed with P- or C- for point and cell data.
VtkAlgorithmProperties *	getVtkProperties () const
	Returns the VtkAlgorithmProperties.
Public Member Functions inherited from TreeItem
	TreeItem (QList< QVariant > data, TreeItem *parent)
virtual	~TreeItem ()
void	appendChild (TreeItem *item)
TreeItem *	child (int row) const
virtual int	childCount () const
virtual int	columnCount () const
int	row () const
TreeItem *	parentItem () const
bool	removeChildren (int position, int count)

Protected Member Functions
int	callVTKWriter (vtkAlgorithm *algorithm, const std::string &filename) const override
	Selects the appropriate VTK-Writer object and writes the object to a file with the given name.
void	setVtkProperties (VtkAlgorithmProperties *vtkProps)

Private Attributes
vtkImageChangeInformation *	_transformFilter

Additional Inherited Members
Protected Attributes inherited from VtkVisPipelineItem
vtkProp3D *	_actor
vtkAlgorithm *	_algorithm
vtkRenderer *	_renderer
VtkCompositeFilter *	_compositeFilter
VtkAlgorithmProperties *	_vtkProps
	The active VtkAlgorithmProperties. From algorithm, compositeFilter, or copied from parent.

Constructor & Destructor Documentation

VtkVisImageItem() [1/2]

VtkVisImageItem::VtkVisImageItem	(	vtkAlgorithm *	algorithm,
		TreeItem *	parentItem,
		const QList< QVariant >	data = QList<QVariant>() )

Constructor for a source/filter object.

Definition at line 44 of file VtkVisImageItem.cpp.

    : VtkVisPipelineItem(algorithm, parentItem, data), _transformFilter(nullptr)
{
}

VtkVisImageItem() [2/2]

VtkVisImageItem::VtkVisImageItem	(	VtkCompositeFilter *	compositeFilter,
		TreeItem *	parentItem,
		const QList< QVariant >	data = QList<QVariant>() )

Constructor for composite filter.

Definition at line 51 of file VtkVisImageItem.cpp.

    : VtkVisPipelineItem(compositeFilter, parentItem, data),
      _transformFilter(nullptr)
{
}

~VtkVisImageItem()

VtkVisImageItem::~VtkVisImageItem ( )

override

Definition at line 59 of file VtkVisImageItem.cpp.

{
    _transformFilter->Delete();
}

References _transformFilter.

Member Function Documentation

callVTKWriter()

int VtkVisImageItem::callVTKWriter ( vtkAlgorithm * algorithm, const std::string & filename ) const

overrideprotectedvirtual

Selects the appropriate VTK-Writer object and writes the object to a file with the given name.

Reimplemented from VtkVisPipelineItem.

Definition at line 175 of file VtkVisImageItem.cpp.

{
    std::string file_name_cpy(filename);
    auto* algID = dynamic_cast<vtkImageAlgorithm*>(algorithm);
    if (algID)
    {
        vtkSmartPointer<vtkXMLImageDataWriter> iWriter =
            vtkSmartPointer<vtkXMLImageDataWriter>::New();
        iWriter->SetInputData(algID->GetOutputDataObject(0));
        if (BaseLib::getFileExtension(filename) != ".vti")
        {
            file_name_cpy.append(".vti");
        }
        iWriter->SetFileName(file_name_cpy.c_str());
        return iWriter->Write();
    }
    ERR("VtkVisPipelineItem::writeToFile() - Unknown data type.");
    return 0;
}

References VtkVisPipelineItem::algorithm(), ERR(), and BaseLib::getFileExtension().

Initialize()

void VtkVisImageItem::Initialize ( vtkRenderer * renderer )

overridevirtual

Initializes vtkMapper and vtkActor necessary for visualization of the item and sets the item's properties.

Implements VtkVisPipelineItem.

Definition at line 64 of file VtkVisImageItem.cpp.

{
    auto* image = dynamic_cast<vtkImageAlgorithm*>(_algorithm);
    if (!image)
    {
        OGSError::box("Cast to image failed.");
        return;
    }
    image->Update();
 
    double origin[3];
    double spacing[3];
    double range[2];
    vtkImageData* image_data = image->GetOutput();
    if (!image_data)
    {
        OGSError::box("GetOutput() - Image could not be initialized.");
        return;
    }
    image_data->GetOrigin(origin);
    image_data->GetSpacing(spacing);
    vtkPointData* point_data = image_data->GetPointData();
    if (point_data)
    {
        auto* scalars = point_data->GetScalars();
        if (scalars)
        {
            scalars->GetRange(range);
        }
    }
    vtkImageShiftScale* scale = vtkImageShiftScale::New();
    scale->SetOutputScalarTypeToUnsignedChar();
    scale->SetInputConnection(image->GetOutputPort());
    scale->SetShift(-range[0]);
    scale->SetScale(255.0 / (range[1] - range[0]));
 
    _transformFilter = vtkImageChangeInformation::New();
    _transformFilter->SetInputConnection(scale->GetOutputPort());
    // double origin[3];
    // img->getOrigin(origin);
    // double spacing = img->getSpacing();
    //_transformFilter->SetOutputOrigin(origin2);
    //_transformFilter->SetOutputSpacing(spacing2);
    _transformFilter->Update();
 
    _renderer = renderer;
 
    // Use a special vtkImageActor instead of vtkActor
    vtkImageActor* imageActor = vtkImageActor::New();
    imageActor->SetInputData(_transformFilter->GetOutput());
    _actor = imageActor;
    _renderer->AddActor(_actor);
 
    // Set pre-set properties
    auto* vtkProps = dynamic_cast<VtkAlgorithmProperties*>(_algorithm);
    if (vtkProps)
    {
        setVtkProperties(vtkProps);
    }
 
    auto* parentItem = dynamic_cast<VtkVisPipelineItem*>(this->parentItem());
    while (parentItem)
    {
        auto* parentProps =
            dynamic_cast<VtkAlgorithmProperties*>(parentItem->algorithm());
        if (parentProps)
        {
            auto* newProps = new VtkAlgorithmProperties();
            newProps->SetScalarVisibility(parentProps->GetScalarVisibility());
            newProps->SetTexture(parentProps->GetTexture());
            setVtkProperties(newProps);
            vtkProps = newProps;
            parentItem = nullptr;
        }
        else
        {
            parentItem =
                dynamic_cast<VtkVisPipelineItem*>(parentItem->parentItem());
        }
    }
 
    // Set active scalar to the desired one from VtkAlgorithmProperties
    // or to match those of the parent.
    if (vtkProps)
    {
        if (vtkProps->GetActiveAttribute().length() > 0)
        {
            this->SetActiveAttribute(vtkProps->GetActiveAttribute());
        }
        else
        {
            auto* visParentItem =
                dynamic_cast<VtkVisPipelineItem*>(this->parentItem());
            if (visParentItem)
            {
                this->SetActiveAttribute(visParentItem->GetActiveAttribute());
            }
            if (vtkProps->GetTexture() != nullptr)
            {
                this->SetActiveAttribute("Solid Color");
            }
        }
    }
}

References VtkVisPipelineItem::_actor, VtkVisPipelineItem::_algorithm, VtkVisPipelineItem::_renderer, _transformFilter, OGSError::box(), TreeItem::parentItem(), VtkVisPipelineItem::SetActiveAttribute(), and setVtkProperties().

setTranslation()

void VtkVisImageItem::setTranslation ( double x, double y, double z ) const

overridevirtual

Translates the item in visualisation-space. This function is empty and needs to be implemented by derived classes.

Reimplemented from VtkVisPipelineItem.

Definition at line 196 of file VtkVisImageItem.cpp.

{
    _transformFilter->SetOriginTranslation(x, y, z);
}

References _transformFilter.

setVtkProperties()

void VtkVisImageItem::setVtkProperties ( VtkAlgorithmProperties * vtkProps )

protected

Definition at line 169 of file VtkVisImageItem.cpp.

{
    // todo implementation
    (void)vtkProps;
}

Referenced by Initialize().

transformFilter()

vtkAlgorithm * VtkVisImageItem::transformFilter ( ) const

overridevirtual

Returns the transform filter for the object. This function needs to be implemented by derived classes.

Implements VtkVisPipelineItem.

Definition at line 201 of file VtkVisImageItem.cpp.

{
    return _transformFilter;
}

References _transformFilter.

Referenced by VtkVisTabWidget::setActiveItem().

writeAsRaster()

bool VtkVisImageItem::writeAsRaster

(

)

Allows writing this item's source object as an ASCII raster file.

Definition at line 206 of file VtkVisImageItem.cpp.

{
    vtkSmartPointer<VtkGeoImageSource> imageSource =
        VtkGeoImageSource::SafeDownCast(_algorithm);
 
    auto const raster = VtkGeoImageSource::convertToRaster(imageSource);
 
    if (!raster)
    {
        OGSError::box("Image could not be converted to a raster.");
        return false;
    }
 
    QFileInfo const info(this->data(0).toString());
    QString const rastername = info.completeBaseName() + ".asc";
    QString const filetype("ESRI ASCII raster file (*.asc)");
    QString const filename = QFileDialog::getSaveFileName(
        nullptr, "Save raster as",
        LastSavedFileDirectory::getDir() + rastername, filetype);
    LastSavedFileDirectory::setDir(filename);
    FileIO::AsciiRasterInterface::writeRasterAsASC(*raster,
                                                   filename.toStdString());
    return true;
}

References VtkVisPipelineItem::_algorithm, OGSError::box(), VtkGeoImageSource::convertToRaster(), VtkVisPipelineItem::data(), LastSavedFileDirectory::getDir(), LastSavedFileDirectory::setDir(), and FileIO::AsciiRasterInterface::writeRasterAsASC().

Member Data Documentation

_transformFilter

vtkImageChangeInformation* VtkVisImageItem::_transformFilter

private

Definition at line 68 of file VtkVisImageItem.h.

Referenced by ~VtkVisImageItem(), Initialize(), setTranslation(), and transformFilter().

---

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

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