peano4.visualisation.filters.Filter.Filter Class Reference

An abstract filter class. More...

Inheritance diagram for peano4.visualisation.filters.Filter.Filter:

Collaboration diagram for peano4.visualisation.filters.Filter.Filter:

Public Member Functions
	__init__ (self, run_on_individual_pieces_of_data, run_on_concatenated_data, verbose)
	exploit_idempotent: boolean Exploit the fact that the filter is idempotent, i.e.
	__str__ (self)
	render (self, cell_data, dof, dimension, unknowns, is_data_associated_to_cell, description, mapping)
	Overwrite this one for the particular filter.

Data Fields
	run_on_individual_pieces_of_data
	run_on_concatenated_data
	verbose

Detailed Description

An abstract filter class.

Implement render to filter out patches from the data that are not to be displayed.

Definition at line 5 of file Filter.py.

Constructor & Destructor Documentation

__init__()

peano4.visualisation.filters.Filter.Filter.__init__	(		self,
			run_on_individual_pieces_of_data,
			run_on_concatenated_data,
			verbose )

exploit_idempotent: boolean Exploit the fact that the filter is idempotent, i.e.

that we can apply it to fragments of the dataset and then to the whole result again.

Reimplemented in peano4.visualisation.filters.ExtractMeshResolution.ExtractMeshResolution, peano4.visualisation.filters.Calculator.Calculator, peano4.visualisation.filters.ExtractFineGrid.ExtractFineGrid, peano4.visualisation.filters.ShrinkPatches.ShrinkPatches, and peano4.visualisation.filters.AverageOverCell.AverageOverCell.

Definition at line 11 of file Filter.py.

Member Function Documentation

__str__()

peano4.visualisation.filters.Filter.Filter.__str__

(

self

)

Definition at line 25 of file Filter.py.

References peano4.output.ActionSet.ActionSet.__class__, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.__class__, peano4.output.Observer.Observer.__class__, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.__class__, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.__class__, peano4.visualisation.filters.Filter.Filter.run_on_concatenated_data, peano4.visualisation.filters.Filter.Filter.run_on_individual_pieces_of_data, TP::Parameters.verbose, peano4.visualisation.filters.Filter.Filter.verbose, and peano4.visualisation.output.Visualiser.Visualiser.verbose.

Referenced by peano4.toolbox.particles.postprocessing.ParticleVTUReader.VTUParticleSet.__repr__().

Here is the caller graph for this function:

render()

peano4.visualisation.filters.Filter.Filter.render	(		self,
			cell_data,
			dof,
			dimension,
			unknowns,
			is_data_associated_to_cell,
			description,
			mapping )

Overwrite this one for the particular filter.

cell_data: [Patch]

Reimplemented in peano4.visualisation.filters.AverageOverCell.AverageOverCell, peano4.visualisation.filters.ExtractMeshResolution.ExtractMeshResolution, peano4.visualisation.filters.Calculator.Calculator, peano4.visualisation.filters.ExtractFineGrid.ExtractFineGrid, and peano4.visualisation.filters.ShrinkPatches.ShrinkPatches.

Definition at line 37 of file Filter.py.

Field Documentation

run_on_concatenated_data

peano4.visualisation.filters.Filter.Filter.run_on_concatenated_data

Definition at line 21 of file Filter.py.

Referenced by peano4.visualisation.filters.Filter.Filter.__str__().

run_on_individual_pieces_of_data

peano4.visualisation.filters.Filter.Filter.run_on_individual_pieces_of_data

Definition at line 20 of file Filter.py.

Referenced by peano4.visualisation.filters.Filter.Filter.__str__().

verbose

peano4.visualisation.filters.Filter.Filter.verbose

Definition at line 22 of file Filter.py.

Referenced by peano4.visualisation.filters.Filter.Filter.__str__(), peano4.visualisation.output.Visualiser.Visualiser.parse_snapshot(), peano4.visualisation.output.VTUUnstructuredGrid.VTUUnstructuredGrid.process_snapshot(), peano4.visualisation.filters.AverageOverCell.AverageOverCell.render(), peano4.visualisation.filters.Calculator.Calculator.render(), peano4.visualisation.filters.ExtractFineGrid.ExtractFineGrid.render(), and peano4.visualisation.output.VTUUnstructuredGrid.VTUUnstructuredGrid.write_vtu().

---

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

• python/peano4/visualisation/filters/Filter.py