vtkWordCloud Class Reference

generate a word cloud visualization of a text document More...

#include <vtkWordCloud.h>

Inheritance diagram for vtkWordCloud:

Collaboration diagram for vtkWordCloud:

Public Types
typedef vtkImageAlgorithm	Superclass
using	ColorDistributionContainer = std::array< double, 2 >
using	OffsetDistributionContainer = std::array< int, 2 >
using	OrientationDistributionContainer = std::array< double, 2 >
using	OrientationsContainer = std::vector< double >
using	PairType = std::tuple< std::string, std::string >
using	ReplacementPairsContainer = std::vector< PairType >
using	SizesContainer = std::array< int, 2 >
using	StopWordsContainer = std::set< std::string >
using	StringContainer = std::vector< std::string >
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkWordCloud *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual SizesContainer	GetAdjustedSizes ()
	Return the AdjustedSizes of the resized mask file.
virtual void	SetBackgroundColorName (std::string arg)
	Set/Get the vtkNamedColors name for the background(MidNightBlue).
virtual std::string	GetBackgroundColorName ()
virtual void	SetBWMask (bool arg)
	Set/Get boolean that indicates the mask image is a single channel(false).
virtual bool	GetBWMask ()
virtual void	SetColorSchemeName (std::string arg)
	Set/Get ColorSchemeName, the name of a color scheme from vtkColorScheme to be used to select colors for the words (), if WordColorName is empty.
virtual std::string	GetColorSchemeName ()
virtual void	SetDPI (int)
	Set/GetDPI - Dots per inch(200) of the rendered text.
virtual int	GetDPI ()
virtual void	SetFileName (VTK_FILEPATH std::string arg)
	Set/Get FileName, the name of the file that contains the text to be processed.
virtual std::string	GetFileName () VTK_FUTURE_CONST
virtual void	SetFontFileName (VTK_FILEPATH VTK_FUTURE_CONST std::string arg)
	Set/Get FontFileName, If empty, the built-in Arial font is used().
virtual std::string	GetFontFileName () VTK_FUTURE_CONST
virtual void	SetGap (int)
	Set/Get Gap, the space gap of words (2).
virtual int	GetGap ()
virtual void	SetMaskColorName (std::string arg)
	Set/Get MaskColorName, the name of the color for the mask (black).
virtual std::string	GetMaskColorName ()
virtual void	SetMaskFileName (VTK_FILEPATH VTK_FUTURE_CONST std::string arg)
	Set/Get MaskFileName, the mask file name().
virtual std::string	GetMaskFileName () VTK_FUTURE_CONST
virtual void	SetMaxFontSize (int)
	Set/Get MaxFontSize, the maximum font size(48).
virtual int	GetMaxFontSize ()
virtual void	SetMinFontSize (int)
	Set/Get MinFontSize, the minimum font size(8).
virtual int	GetMinFontSize ()
virtual void	SetMinFrequency (int)
	Set/Get MinFrequency, the minimum word frequency accepted(2).
virtual int	GetMinFrequency ()
virtual void	SetFontMultiplier (int)
	Set/Get FontMultiplier, the font multiplier(6).
virtual int	GetFontMultiplier ()
	SetStdContainerMacro (ColorDistribution, ColorDistributionContainer)
	Set/Get ColorDistribution, the distribution of random colors(.6 1.0), if WordColorName is empty.
virtual ColorDistributionContainer	GetColorDistribution ()
	SetStdContainerMacro (OffsetDistribution, OffsetDistributionContainer)
	Set/Get OffsetDistribution, the range of uniform random offsets(-size[0]/100.0 -size{1]/100.0)(-20 20).
virtual OffsetDistributionContainer	GetOffsetDistribution ()
	SetStdContainerMacro (OrientationDistribution, OrientationDistributionContainer)
	Set/Get OrientationDistribution, ranges of random orientations(-20 20).
virtual OrientationDistributionContainer	GetOrientationDistribution ()
	SetStdContainerMacro (Orientations, OrientationsContainer)
	Set/Add/Get Orientations, a vector of discrete orientations ().
void	AddOrientation (double arg)
virtual OrientationsContainer	GetOrientations ()
	SetStdContainerMacro (ReplacementPairs, ReplacementPairsContainer)
	Set/Add/Get ReplacementPairs, a vector of words that replace the first word with another second word ().
void	AddReplacementPair (PairType arg)
virtual ReplacementPairsContainer	GetReplacementPairs ()
	SetStdContainerMacro (Sizes, SizesContainer)
	Set/Get Sizes, the size of the output image(640 480).
virtual SizesContainer	GetSizes ()
	SetStdContainerMacro (StopWords, StopWordsContainer)
	Set/Add/Get StopWords, a set of user provided stop words().
void	AddStopWord (std::string word)
void	ClearStopWords ()
virtual StopWordsContainer	GetStopWords ()
virtual void	SetStopListFileName (VTK_FILEPATH VTK_FUTURE_CONST std::string arg)
	Set/Get StopListFileName, the name of the file that contains the stop words, one per line.
virtual std::string	GetStopListFileName () VTK_FUTURE_CONST
virtual void	SetTitle (std::string arg)
	Set/Get Title, add this word to the document's words and set a high frequency, so that is will be rendered first.
virtual std::string	GetTitle ()
virtual void	SetWordColorName (std::string arg)
	Set/Get WordColorName, the name of the color for the words().
virtual std::string	GetWordColorName ()
virtual std::vector< std::string > &	GetKeptWords ()
	Get a vector of words that are kept in the final image.
virtual std::vector< std::string > &	GetSkippedWords ()
	Get a vector of words that are skipped.
virtual std::vector< std::string > &	GetStoppedWords ()
	Get a vector of words that were stopped in the final image.
Public Member Functions inherited from vtkImageAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImageAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Process a request from the executive.
vtkImageData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkImageData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
vtkDataObject *	GetInput (int port)
	Get a data object for one of the input port connections.
vtkDataObject *	GetInput ()
	Get a data object for one of the input port connections.
vtkImageData *	GetImageDataInput (int port)
	Get a data object for one of the input port connections.
virtual void	AddInputData (vtkDataObject *)
	Assign a data object as input.
virtual void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkWordCloud *	SafeDownCast (vtkObjectBase *o)
static vtkWordCloud *	New ()
	Construct object with vertex cell generation turned off.
Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkWordCloud ()
	~vtkWordCloud () override=default
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called in response to a REQUEST_DATA request from the executive.
Protected Member Functions inherited from vtkImageAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageAlgorithm ()
	~vtkImageAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.
virtual int	RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Convenience method to copy the scalar type and number of components from the input data to the output data.
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called in response to a REQUEST_DATA request from the executive.
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
	This is a convenience method that is implemented in many subclasses instead of RequestData.
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
	Copy the other point and cell data.
virtual void	ExecuteData (vtkDataObject *output)
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
virtual void	Execute ()
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
	Allocate the output data.
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
	Allocate the output data.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
int	FillInputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkImageData >	ImageData
int	WholeExtent [6]
SizesContainer	AdjustedSizes
std::string	BackgroundColorName
bool	BWMask
ColorDistributionContainer	ColorDistribution
std::string	ColorSchemeName
int	DPI
std::string	FileName
std::string	FontFileName
int	FontMultiplier
int	Gap
std::string	MaskColorName
std::string	MaskFileName
int	MaxFontSize
int	MinFontSize
int	MinFrequency
OffsetDistributionContainer	OffsetDistribution
OrientationDistributionContainer	OrientationDistribution
OrientationsContainer	Orientations
ReplacementPairsContainer	ReplacementPairs
SizesContainer	Sizes
StopWordsContainer	StopWords
std::string	StopListFileName
std::string	Title
std::string	WordColorName
std::vector< std::string >	KeptWords
std::vector< std::string >	SkippedWords
std::vector< std::string >	StoppedWords
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

generate a word cloud visualization of a text document

Word Clouds, AKA Tag Clouds (https://en.wikipedia.org/wiki/Tag_cloud), are a text visualization technique that displays individual words with properties that depend on the frequency of a word in a document. vtkWordCloud varies the font size based on word frequency. Word Clouds are useful for quickly perceiving the most prominent terms in a document. Also, Word Clouds can identify trends and patterns that would otherwise be unclear or difficult to see in a tabular format. Frequently used keywords stand out better in a word cloud. Common words that might be overlooked in tabular form are highlighted in the larger text, making them pop out when displayed in a word cloud.

There is some controversy about the usefulness of word clouds. Their best use may be for presentations, see https://tinyurl.com/y59hy7oa

The generation of the word cloud proceeds as follows:

1. Read the text file
2. Split text into words to be processed Extract words from the text Drop the case of each word for filtering Filter the words Replace words from the ReplacementPairs list Skip the word if it is in the stop list or contains a digit Skip single character words Raise the case of the first letter in each word Sort the word list by frequency
3. Create a rectangular mask image or read a mask image
4. For each word Render the word into an image Try to add the word to the word cloud image. For each orientation, see if the word "fits" If no fit, move along a path to try another location

NOTE: A word fits if all of the non-zero word cloud pixels in the extent of the text image are background pixels.

NOTE: The path is an Archimedean Spiral (https://en.wikipedia.org/wiki/Archimedean_spiral)

NOTE: vtkWordCloud has a built-in list of stop word. Stop words are words that are filtered out before processing of the text, such as the, is, at, which, and so on.

NOTE: Color names are defined in vtkNamedColors. A visual representation of color names is here: https://tinyurl.com/y3yxcxj6

NOTE: vtkWordCloud offers Several methods to customize the resulting visualization. The class provides defaults that provide a reasonable result.

BackgroundColorName - The vtkNamedColors name for the background (MidNightBlue). See https://tinyurl.com/y3yxcxj6 for a visual representation of the named colors.

ColorDistribution - Distribution of random colors(.6 1.0), if WordColorName is empty.

ColorSchemeName - Name of a color scheme from vtkColorSeries to be used to select colors for the words (), if WordColorName is empty. See https://tinyurl.com/y3j6c27o for a visual representation of the color schemes.

DPI - Dots per inch(200) of the rendered text. DPI is used as a scaling mechanism for the words. As DPI increases, the word size increases. If there are too, few skipped words, increase this value, too many, decrease it.

FontFileName - If empty, the built-in Arial font is used(). The FontFileName is the name of a file that contains a TrueType font. https://www.1001freefonts.com/ is a good source for free TrueType fonts.

FontMultiplier - Font multiplier(6). The final FontSize is this value times the word frequency.

Gap - Space gap of words (2). The gap is the number of spaces added to the beginning and end of each word.

MaskColorName - Name of the color for the mask (black). This is the name of the vtknamedColors that defines the foreground of the mask. Usually black or white. See https://tinyurl.com/y3yxcxj6 for a visual representation of the named colors.

MaskFileName - Mask file name(). If a mask file is specified, it will be used as the mask. Otherwise, a black square is used as the mask. The mask file should contain three channels of unsigned char values. If the mask file is just a single unsigned char, specify turn the boolean BWMask on. If BWmask is on, the class will create a three channel image using vtkImageAppendComponents.

BWMask - Mask image has a single channel(false). Mask images typically have three channels (r,g,b).

MaxFontSize - Maximum font size(48).

MinFontSize - Minimum font size(8).

MinFrequency - Minimum word frequency accepted(2). Word with frequencies less than this will be ignored.

OffsetDistribution - Range of uniform random offsets(-size[0]/100.0 -size{1]/100.0)(-20 20). These offsets are offsets from the generated path for word layout.

OrientationDistribution - Ranges of random orientations(-20 20). If discrete orientations are not defined, these orientations will be generated.

Orientations - Vector of discrete orientations(). If non-empty, these will be used instead of the orientations distribution"); ReplacementPairs - Replace the first word with another second word (). The each word will also added to the StopList. The second argument can contain multiple words. For example you could replace "bill" with "Bill Lorensen" or, "vtk" with "VTK . Remember that words are always stored internally with lower case, even though the first letter is capitalized in the Word Cloud.

Sizes - Size of image(640 480).

StopWords - User provided stop words(). Stop words are words that are filtered out before processing of the text, such as the, is, at, which, and so on. vtkWordClass has built-in stop words. The user-provided stop words are added to the built-in list. See https://en.wikipedia.org/wiki/Stop_words for a description. The built-in stop words were derived from the english stop words at https://www.ranks.nl/stopwords. Stop words for other languages are also available.

StopListFileName - the name of a file that contains stop words, one word per line (). If present, the stop words in the file replace the built-in stop list.

Title - Add this word to the document's words and set a high frequency, so that is will be rendered first.

WordColorName - Name of the color for the words(). The name is selected from vtkNamedColors. If the name is empty, the ColorDistribution will generate random colors. See https://tinyurl.com/y3yxcxj6 for a visual representation of the named colors.

The class also provided Get methods that return vectors StopWords, SkippedWords and KeptWords.

Online Examples:

WordCloudDemo

Tests:

vtkWordCloud (Tests)

Definition at line 192 of file vtkWordCloud.h.

Member Typedef Documentation

Superclass

typedef vtkImageAlgorithm vtkWordCloud::Superclass

Definition at line 195 of file vtkWordCloud.h.

ColorDistributionContainer

using vtkWordCloud::ColorDistributionContainer = std::array<double, 2>

Definition at line 204 of file vtkWordCloud.h.

OffsetDistributionContainer

using vtkWordCloud::OffsetDistributionContainer = std::array<int, 2>

Definition at line 205 of file vtkWordCloud.h.

OrientationDistributionContainer

using vtkWordCloud::OrientationDistributionContainer = std::array<double, 2>

Definition at line 206 of file vtkWordCloud.h.

OrientationsContainer

using vtkWordCloud::OrientationsContainer = std::vector<double>

Definition at line 207 of file vtkWordCloud.h.

PairType

using vtkWordCloud::PairType = std::tuple<std::string, std::string>

Definition at line 208 of file vtkWordCloud.h.

ReplacementPairsContainer

using vtkWordCloud::ReplacementPairsContainer = std::vector<PairType>

Definition at line 209 of file vtkWordCloud.h.

SizesContainer

using vtkWordCloud::SizesContainer = std::array<int, 2>

Definition at line 210 of file vtkWordCloud.h.

StopWordsContainer

using vtkWordCloud::StopWordsContainer = std::set<std::string>

Definition at line 211 of file vtkWordCloud.h.

StringContainer

using vtkWordCloud::StringContainer = std::vector<std::string>

Definition at line 212 of file vtkWordCloud.h.

Constructor & Destructor Documentation

vtkWordCloud()

vtkWordCloud::vtkWordCloud ( )

protected

~vtkWordCloud()

vtkWordCloud::~vtkWordCloud ( )

overrideprotecteddefault

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkWordCloud::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkWordCloud::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

SafeDownCast()

static vtkWordCloud * vtkWordCloud::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkWordCloud::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageAlgorithm.

NewInstance()

vtkWordCloud * vtkWordCloud::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

New()

static vtkWordCloud * vtkWordCloud::New ( )

static

Construct object with vertex cell generation turned off.

GetAdjustedSizes()

virtual SizesContainer vtkWordCloud::GetAdjustedSizes ( )

inlinevirtual

Return the AdjustedSizes of the resized mask file.

Definition at line 219 of file vtkWordCloud.h.

SetBackgroundColorName()

virtual void vtkWordCloud::SetBackgroundColorName ( std::string  arg )

inlinevirtual

Set/Get the vtkNamedColors name for the background(MidNightBlue).

Definition at line 253 of file vtkWordCloud.h.

GetBackgroundColorName()

virtual std::string vtkWordCloud::GetBackgroundColorName ( )

inlinevirtual

Definition at line 261 of file vtkWordCloud.h.

SetBWMask()

virtual void vtkWordCloud::SetBWMask ( bool  arg )

inlinevirtual

Set/Get boolean that indicates the mask image is a single channel(false).

Definition at line 269 of file vtkWordCloud.h.

GetBWMask()

virtual bool vtkWordCloud::GetBWMask ( )

inlinevirtual

Definition at line 277 of file vtkWordCloud.h.

SetColorSchemeName()

virtual void vtkWordCloud::SetColorSchemeName ( std::string  arg )

inlinevirtual

Set/Get ColorSchemeName, the name of a color scheme from vtkColorScheme to be used to select colors for the words (), if WordColorName is empty.

See https://tinyurl.com/y3j6c27o for a visual representation of the color schemes.

Definition at line 287 of file vtkWordCloud.h.

GetColorSchemeName()

virtual std::string vtkWordCloud::GetColorSchemeName ( )

inlinevirtual

Definition at line 295 of file vtkWordCloud.h.

SetDPI()

virtual void vtkWordCloud::SetDPI ( int  )

virtual

Set/GetDPI - Dots per inch(200) of the rendered text.

DPI is used as a scaling mechanism for the words. As DPI increases, the word size increases. If there are too, few skipped words, increase this value, too many, decrease it.

GetDPI()

virtual int vtkWordCloud::GetDPI ( )

virtual

SetFileName()

virtual void vtkWordCloud::SetFileName ( VTK_FILEPATH std::string  arg )

inlinevirtual

Set/Get FileName, the name of the file that contains the text to be processed.

Definition at line 314 of file vtkWordCloud.h.

GetFileName()

virtual std::string vtkWordCloud::GetFileName ( )

inlinevirtual

Definition at line 322 of file vtkWordCloud.h.

SetFontFileName()

virtual void vtkWordCloud::SetFontFileName ( VTK_FILEPATH VTK_FUTURE_CONST std::string  arg )

inlinevirtual

Set/Get FontFileName, If empty, the built-in Arial font is used().

The FontFileName is the name of a file that contains a TrueType font.

Definition at line 331 of file vtkWordCloud.h.

GetFontFileName()

virtual std::string vtkWordCloud::GetFontFileName ( )

inlinevirtual

Definition at line 339 of file vtkWordCloud.h.

SetGap()

virtual void vtkWordCloud::SetGap ( int  )

virtual

Set/Get Gap, the space gap of words (2).

The gap is the number of spaces added to the beginning and end of each word.

GetGap()

virtual int vtkWordCloud::GetGap ( )

virtual

SetMaskColorName()

virtual void vtkWordCloud::SetMaskColorName ( std::string  arg )

inlinevirtual

Set/Get MaskColorName, the name of the color for the mask (black).

This is the name of the vtkNamedColors that defines the foreground of the mask. Usually black or white.

Definition at line 357 of file vtkWordCloud.h.

GetMaskColorName()

virtual std::string vtkWordCloud::GetMaskColorName ( )

inlinevirtual

Definition at line 365 of file vtkWordCloud.h.

SetMaskFileName()

virtual void vtkWordCloud::SetMaskFileName ( VTK_FILEPATH VTK_FUTURE_CONST std::string  arg )

inlinevirtual

Set/Get MaskFileName, the mask file name().

If a mask file is specified, it will be used as the mask. Otherwise, a black square is used as the mask. The mask file should contain three channels of unsigned char values. If the mask file is just a single unsigned char, specify turn the boolean BWMask on. If BWmask is on, the class will create a three channel image using vtkImageAppendComponents.

Definition at line 378 of file vtkWordCloud.h.

GetMaskFileName()

virtual std::string vtkWordCloud::GetMaskFileName ( )

inlinevirtual

Definition at line 386 of file vtkWordCloud.h.

SetMaxFontSize()

virtual void vtkWordCloud::SetMaxFontSize ( int  )

virtual

Set/Get MaxFontSize, the maximum font size(48).

GetMaxFontSize()

virtual int vtkWordCloud::GetMaxFontSize ( )

virtual

SetMinFontSize()

virtual void vtkWordCloud::SetMinFontSize ( int  )

virtual

Set/Get MinFontSize, the minimum font size(8).

GetMinFontSize()

virtual int vtkWordCloud::GetMinFontSize ( )

virtual

SetMinFrequency()

virtual void vtkWordCloud::SetMinFrequency ( int  )

virtual

Set/Get MinFrequency, the minimum word frequency accepted(2).

Words with frequencies less than this will be ignored.

GetMinFrequency()

virtual int vtkWordCloud::GetMinFrequency ( )

virtual

SetFontMultiplier()

virtual void vtkWordCloud::SetFontMultiplier ( int  )

virtual

Set/Get FontMultiplier, the font multiplier(6).

The final FontSize is this value the word frequency.

GetFontMultiplier()

virtual int vtkWordCloud::GetFontMultiplier ( )

virtual

SetStdContainerMacro() [1/7]

vtkWordCloud::SetStdContainerMacro	(	ColorDistribution	,
		ColorDistributionContainer
	)

Set/Get ColorDistribution, the distribution of random colors(.6 1.0), if WordColorName is empty.

GetColorDistribution()

virtual ColorDistributionContainer vtkWordCloud::GetColorDistribution ( )

inlinevirtual

Definition at line 430 of file vtkWordCloud.h.

SetStdContainerMacro() [2/7]

vtkWordCloud::SetStdContainerMacro	(	OffsetDistribution	,
		OffsetDistributionContainer
	)

Set/Get OffsetDistribution, the range of uniform random offsets(-size[0]/100.0 -size{1]/100.0)(-20 20).

These offsets are offsets from the generated path for word layout.

GetOffsetDistribution()

virtual OffsetDistributionContainer vtkWordCloud::GetOffsetDistribution ( )

inlinevirtual

Definition at line 440 of file vtkWordCloud.h.

SetStdContainerMacro() [3/7]

vtkWordCloud::SetStdContainerMacro	(	OrientationDistribution	,
		OrientationDistributionContainer
	)

Set/Get OrientationDistribution, ranges of random orientations(-20 20).

If discrete orientations are not defined, these orientations will be generated.

GetOrientationDistribution()

virtual OrientationDistributionContainer vtkWordCloud::GetOrientationDistribution ( )

inlinevirtual

Definition at line 450 of file vtkWordCloud.h.

SetStdContainerMacro() [4/7]

vtkWordCloud::SetStdContainerMacro	(	Orientations	,
		OrientationsContainer
	)

Set/Add/Get Orientations, a vector of discrete orientations ().

If non-empty, these will be used instead of the orientations distribution").

AddOrientation()

void vtkWordCloud::AddOrientation ( double  arg )

inline

Definition at line 463 of file vtkWordCloud.h.

GetOrientations()

virtual OrientationsContainer vtkWordCloud::GetOrientations ( )

inlinevirtual

Definition at line 468 of file vtkWordCloud.h.

SetStdContainerMacro() [5/7]

vtkWordCloud::SetStdContainerMacro	(	ReplacementPairs	,
		ReplacementPairsContainer
	)

Set/Add/Get ReplacementPairs, a vector of words that replace the first word with another second word ().

The first word is also added to the StopList.

AddReplacementPair()

void vtkWordCloud::AddReplacementPair ( PairType  arg )

inline

Definition at line 478 of file vtkWordCloud.h.

GetReplacementPairs()

virtual ReplacementPairsContainer vtkWordCloud::GetReplacementPairs ( )

inlinevirtual

Definition at line 484 of file vtkWordCloud.h.

SetStdContainerMacro() [6/7]

vtkWordCloud::SetStdContainerMacro	(	Sizes	,
		SizesContainer
	)

Set/Get Sizes, the size of the output image(640 480).

GetSizes()

virtual SizesContainer vtkWordCloud::GetSizes ( )

inlinevirtual

Definition at line 492 of file vtkWordCloud.h.

SetStdContainerMacro() [7/7]

vtkWordCloud::SetStdContainerMacro	(	StopWords	,
		StopWordsContainer
	)

Set/Add/Get StopWords, a set of user provided stop words().

vtkWordClass has built-in stop words. The user-provided stop words are added to the built-in list.

AddStopWord()

void vtkWordCloud::AddStopWord ( std::string  word )

inline

Definition at line 502 of file vtkWordCloud.h.

ClearStopWords()

void vtkWordCloud::ClearStopWords ( )

inline

Definition at line 507 of file vtkWordCloud.h.

GetStopWords()

virtual StopWordsContainer vtkWordCloud::GetStopWords ( )

inlinevirtual

Definition at line 512 of file vtkWordCloud.h.

SetStopListFileName()

virtual void vtkWordCloud::SetStopListFileName ( VTK_FILEPATH VTK_FUTURE_CONST std::string  arg )

inlinevirtual

Set/Get StopListFileName, the name of the file that contains the stop words, one per line.

Definition at line 520 of file vtkWordCloud.h.

GetStopListFileName()

virtual std::string vtkWordCloud::GetStopListFileName ( )

inlinevirtual

Definition at line 528 of file vtkWordCloud.h.

SetTitle()

virtual void vtkWordCloud::SetTitle ( std::string  arg )

inlinevirtual

Set/Get Title, add this word to the document's words and set a high frequency, so that is will be rendered first.

Definition at line 536 of file vtkWordCloud.h.

GetTitle()

virtual std::string vtkWordCloud::GetTitle ( )

inlinevirtual

Definition at line 544 of file vtkWordCloud.h.

SetWordColorName()

virtual void vtkWordCloud::SetWordColorName ( std::string  arg )

inlinevirtual

Set/Get WordColorName, the name of the color for the words().

The name is selected from vtkNamedColors. If the name is empty, the ColorDistribution will generate random colors.

Definition at line 553 of file vtkWordCloud.h.

GetWordColorName()

virtual std::string vtkWordCloud::GetWordColorName ( )

inlinevirtual

Definition at line 561 of file vtkWordCloud.h.

GetKeptWords()

virtual std::vector< std::string > & vtkWordCloud::GetKeptWords ( )

inlinevirtual

Get a vector of words that are kept in the final image.

Definition at line 567 of file vtkWordCloud.h.

GetSkippedWords()

virtual std::vector< std::string > & vtkWordCloud::GetSkippedWords ( )

inlinevirtual

Get a vector of words that are skipped.

Skipped words do not fit in the final image.

Definition at line 575 of file vtkWordCloud.h.

GetStoppedWords()

virtual std::vector< std::string > & vtkWordCloud::GetStoppedWords ( )

inlinevirtual

Get a vector of words that were stopped in the final image.

Definition at line 582 of file vtkWordCloud.h.

RequestInformation()

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

overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

RequestData()

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

overrideprotectedvirtual

This is called in response to a REQUEST_DATA request from the executive.

Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

ImageData

vtkSmartPointer<vtkImageData> vtkWordCloud::ImageData

protected

Definition at line 592 of file vtkWordCloud.h.

WholeExtent

int vtkWordCloud::WholeExtent[6]

protected

Definition at line 593 of file vtkWordCloud.h.

AdjustedSizes

SizesContainer vtkWordCloud::AdjustedSizes

protected

Definition at line 595 of file vtkWordCloud.h.

BackgroundColorName

std::string vtkWordCloud::BackgroundColorName

protected

Definition at line 596 of file vtkWordCloud.h.

BWMask

bool vtkWordCloud::BWMask

protected

Definition at line 597 of file vtkWordCloud.h.

ColorDistribution

ColorDistributionContainer vtkWordCloud::ColorDistribution

protected

Definition at line 598 of file vtkWordCloud.h.

ColorSchemeName

std::string vtkWordCloud::ColorSchemeName

protected

Definition at line 599 of file vtkWordCloud.h.

DPI

int vtkWordCloud::DPI

protected

Definition at line 600 of file vtkWordCloud.h.

FileName

std::string vtkWordCloud::FileName

protected

Definition at line 601 of file vtkWordCloud.h.

FontFileName

std::string vtkWordCloud::FontFileName

protected

Definition at line 602 of file vtkWordCloud.h.

FontMultiplier

int vtkWordCloud::FontMultiplier

protected

Definition at line 603 of file vtkWordCloud.h.

Gap

int vtkWordCloud::Gap

protected

Definition at line 604 of file vtkWordCloud.h.

MaskColorName

std::string vtkWordCloud::MaskColorName

protected

Definition at line 605 of file vtkWordCloud.h.

MaskFileName

std::string vtkWordCloud::MaskFileName

protected

Definition at line 606 of file vtkWordCloud.h.

MaxFontSize

int vtkWordCloud::MaxFontSize

protected

Definition at line 607 of file vtkWordCloud.h.

MinFontSize

int vtkWordCloud::MinFontSize

protected

Definition at line 608 of file vtkWordCloud.h.

MinFrequency

int vtkWordCloud::MinFrequency

protected

Definition at line 609 of file vtkWordCloud.h.

OffsetDistribution

OffsetDistributionContainer vtkWordCloud::OffsetDistribution

protected

Definition at line 610 of file vtkWordCloud.h.

OrientationDistribution

OrientationDistributionContainer vtkWordCloud::OrientationDistribution

protected

Definition at line 611 of file vtkWordCloud.h.

Orientations

OrientationsContainer vtkWordCloud::Orientations

protected

Definition at line 612 of file vtkWordCloud.h.

ReplacementPairs

ReplacementPairsContainer vtkWordCloud::ReplacementPairs

protected

Definition at line 613 of file vtkWordCloud.h.

Sizes

SizesContainer vtkWordCloud::Sizes

protected

Definition at line 614 of file vtkWordCloud.h.

StopWords

StopWordsContainer vtkWordCloud::StopWords

protected

Definition at line 615 of file vtkWordCloud.h.

StopListFileName

std::string vtkWordCloud::StopListFileName

protected

Definition at line 616 of file vtkWordCloud.h.

Title

std::string vtkWordCloud::Title

protected

Definition at line 617 of file vtkWordCloud.h.

WordColorName

std::string vtkWordCloud::WordColorName

protected

Definition at line 618 of file vtkWordCloud.h.

KeptWords

std::vector<std::string> vtkWordCloud::KeptWords

protected

Definition at line 620 of file vtkWordCloud.h.

SkippedWords

std::vector<std::string> vtkWordCloud::SkippedWords

protected

Definition at line 621 of file vtkWordCloud.h.

StoppedWords

std::vector<std::string> vtkWordCloud::StoppedWords

protected

Definition at line 622 of file vtkWordCloud.h.

---

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

• Infovis/Core/vtkWordCloud.h