VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWordCloud Class Reference

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

#include <vtkWordCloud.h>

Inheritance diagram for vtkWordCloud:
[legend]
Collaboration diagram for vtkWordCloud:
[legend]

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. More...
 
vtkWordCloudNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual SizesContainer GetAdjustedSizes ()
 Return the AdjustedSizes of the resized mask file. More...
 
virtual void SetBackgroundColorName (std::string arg)
 Set/Get the vtkNamedColors name for the background(MidNightBlue). More...
 
virtual std::string GetBackgroundColorName ()
 
virtual void SetBWMask (bool arg)
 Set/Get boolean that indicates the mask image is a single channel(false). More...
 
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. More...
 
virtual std::string GetColorSchemeName ()
 
virtual void SetDPI (int)
 Set/GetDPI - Dots per inch(200) of the rendered text. More...
 
virtual int GetDPI ()
 
virtual void SetFileName (std::string arg)
 Set/Get FileName, the name of the file that contains the text to be processed. More...
 
virtual std::string GetFileName ()
 
virtual void SetFontFileName (std::string arg)
 Set/Get FontFileName, If empty, the built-in Arial font is used(). More...
 
virtual std::string GetFontFileName ()
 
virtual void SetGap (int)
 Set/Get Gap, the space gap of words (2). More...
 
virtual int GetGap ()
 
virtual void SetMaskColorName (std::string arg)
 Set/Get MaskColorName, the name of the color for the mask (black). More...
 
virtual std::string GetMaskColorName ()
 
virtual void SetMaskFileName (std::string arg)
 Set/Get MaskFileName, the mask file name(). More...
 
virtual std::string GetMaskFileName ()
 
virtual void SetMaxFontSize (int)
 Set/Get MaxFontSize, the maximum font size(48). More...
 
virtual int GetMaxFontSize ()
 
virtual void SetMinFontSize (int)
 Set/Get MinFontSize, the minimum font size(8). More...
 
virtual int GetMinFontSize ()
 
virtual void SetMinFrequency (int)
 Set/Get MinFrequency, the minimum word frequency accepted(2). More...
 
virtual int GetMinFrequency ()
 
virtual void SetFontMultiplier (int)
 Set/Get FontMultiplier, the font multiplier(6). More...
 
virtual int GetFontMultiplier ()
 
 SetStdContainerMacro (ColorDistribution, ColorDistributionContainer)
 Set/Get ColorDistribution, the distribution of random colors(.6 1.0), if WordColorName is empty. More...
 
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). More...
 
virtual OffsetDistributionContainer GetOffsetDistribution ()
 
 SetStdContainerMacro (OrientationDistribution, OrientationDistributionContainer)
 Set/Get OrientationDistribution, ranges of random orientations(-20 20). More...
 
virtual OrientationDistributionContainer GetOrientationDistribution ()
 
 SetStdContainerMacro (Orientations, OrientationsContainer)
 Set/Add/Get Orientations, a vector of discrete orientations (). More...
 
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 (). More...
 
void AddReplacementPair (PairType arg)
 
virtual ReplacementPairsContainer GetReplacementPairs ()
 
 SetStdContainerMacro (Sizes, SizesContainer)
 Set/Get Sizes, the size of the output image(640 480). More...
 
virtual SizesContainer GetSizes ()
 
 SetStdContainerMacro (StopWords, StopWordsContainer)
 Set/Add/Get StopWords, a set of user provided stop words(). More...
 
void AddStopWord (std::string word)
 
void ClearStopWords ()
 
virtual StopWordsContainer GetStopWords ()
 
virtual void SetStopListFileName (std::string arg)
 Set/Get StopListFileName, the name of the file that contains the stop words, one per line. More...
 
virtual std::string GetStopListFileName ()
 
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. More...
 
virtual std::string GetTitle ()
 
virtual void SetWordColorName (std::string arg)
 Set/Get WordColorName, the name of the color for the words(). More...
 
virtual std::string GetWordColorName ()
 
virtual std::vector< std::string > & GetKeptWords ()
 Get a vector of words that are kept in the final image. More...
 
virtual std::vector< std::string > & GetSkippedWords ()
 Get a vector of words that are skipped. More...
 
virtual std::vector< std::string > & GetStoppedWords ()
 Get a vector of words that were stopped in the final image. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 Get a data object for one of the input port connections. More...
 
vtkImageDataGetImageDataInput (int port)
 Get a data object for one of the input port connections. More...
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int 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). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual 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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWordCloudSafeDownCast (vtkObjectBase *o)
 
static vtkWordCloudNew ()
 Construct object with vertex cell generation turned off. More...
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWordCloud ()
 
 ~vtkWordCloud () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called in response to a REQUEST_DATA request from the executive. More...
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
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. More...
 
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. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
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. More...
 
virtual void Execute ()
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 Allocate the output data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkImageDataImageData
 
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
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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.

Tests:
vtkWordCloud (Tests)

Definition at line 184 of file vtkWordCloud.h.

Member Typedef Documentation

Definition at line 187 of file vtkWordCloud.h.

Definition at line 196 of file vtkWordCloud.h.

Definition at line 197 of file vtkWordCloud.h.

Definition at line 198 of file vtkWordCloud.h.

Definition at line 199 of file vtkWordCloud.h.

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

Definition at line 200 of file vtkWordCloud.h.

Definition at line 201 of file vtkWordCloud.h.

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

Definition at line 202 of file vtkWordCloud.h.

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

Definition at line 203 of file vtkWordCloud.h.

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

Definition at line 204 of file vtkWordCloud.h.

Constructor & Destructor Documentation

vtkWordCloud::vtkWordCloud ( )
protected
vtkWordCloud::~vtkWordCloud ( )
inlineoverrideprotected

Definition at line 575 of file vtkWordCloud.h.

Member Function Documentation

static vtkTypeBool vtkWordCloud::IsTypeOf ( const char *  type)
static
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.

static vtkWordCloud* vtkWordCloud::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkWordCloud::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

vtkWordCloud* vtkWordCloud::NewInstance ( ) const
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.

static vtkWordCloud* vtkWordCloud::New ( )
static

Construct object with vertex cell generation turned off.

virtual SizesContainer vtkWordCloud::GetAdjustedSizes ( )
inlinevirtual

Return the AdjustedSizes of the resized mask file.

Definition at line 211 of file vtkWordCloud.h.

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

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

Definition at line 245 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetBackgroundColorName ( )
inlinevirtual

Definition at line 253 of file vtkWordCloud.h.

virtual void vtkWordCloud::SetBWMask ( bool  arg)
inlinevirtual

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

Definition at line 261 of file vtkWordCloud.h.

virtual bool vtkWordCloud::GetBWMask ( )
inlinevirtual

Definition at line 269 of file vtkWordCloud.h.

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 279 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetColorSchemeName ( )
inlinevirtual

Definition at line 287 of file vtkWordCloud.h.

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.

virtual int vtkWordCloud::GetDPI ( )
virtual
virtual void vtkWordCloud::SetFileName ( std::string  arg)
inlinevirtual

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

Definition at line 306 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetFileName ( )
inlinevirtual

Definition at line 314 of file vtkWordCloud.h.

virtual void vtkWordCloud::SetFontFileName ( 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 323 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetFontFileName ( )
inlinevirtual

Definition at line 331 of file vtkWordCloud.h.

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.

virtual int vtkWordCloud::GetGap ( )
virtual
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 349 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetMaskColorName ( )
inlinevirtual

Definition at line 357 of file vtkWordCloud.h.

virtual void vtkWordCloud::SetMaskFileName ( 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 370 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetMaskFileName ( )
inlinevirtual

Definition at line 378 of file vtkWordCloud.h.

virtual void vtkWordCloud::SetMaxFontSize ( int  )
virtual

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

virtual int vtkWordCloud::GetMaxFontSize ( )
virtual
virtual void vtkWordCloud::SetMinFontSize ( int  )
virtual

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

virtual int vtkWordCloud::GetMinFontSize ( )
virtual
virtual void vtkWordCloud::SetMinFrequency ( int  )
virtual

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

Words with frequencies less than this will be ignored.

virtual int vtkWordCloud::GetMinFrequency ( )
virtual
virtual void vtkWordCloud::SetFontMultiplier ( int  )
virtual

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

The final FontSize is this value the word frequency.

virtual int vtkWordCloud::GetFontMultiplier ( )
virtual
vtkWordCloud::SetStdContainerMacro ( ColorDistribution  ,
ColorDistributionContainer   
)

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

virtual ColorDistributionContainer vtkWordCloud::GetColorDistribution ( )
inlinevirtual

Definition at line 422 of file vtkWordCloud.h.

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.

virtual OffsetDistributionContainer vtkWordCloud::GetOffsetDistribution ( )
inlinevirtual

Definition at line 432 of file vtkWordCloud.h.

vtkWordCloud::SetStdContainerMacro ( OrientationDistribution  ,
OrientationDistributionContainer   
)

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

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

virtual OrientationDistributionContainer vtkWordCloud::GetOrientationDistribution ( )
inlinevirtual

Definition at line 442 of file vtkWordCloud.h.

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").

void vtkWordCloud::AddOrientation ( double  arg)
inline

Definition at line 452 of file vtkWordCloud.h.

virtual OrientationsContainer vtkWordCloud::GetOrientations ( )
inlinevirtual

Definition at line 457 of file vtkWordCloud.h.

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.

void vtkWordCloud::AddReplacementPair ( PairType  arg)
inline

Definition at line 467 of file vtkWordCloud.h.

virtual ReplacementPairsContainer vtkWordCloud::GetReplacementPairs ( )
inlinevirtual

Definition at line 473 of file vtkWordCloud.h.

vtkWordCloud::SetStdContainerMacro ( Sizes  ,
SizesContainer   
)

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

virtual SizesContainer vtkWordCloud::GetSizes ( )
inlinevirtual

Definition at line 481 of file vtkWordCloud.h.

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.

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

Definition at line 491 of file vtkWordCloud.h.

void vtkWordCloud::ClearStopWords ( )
inline

Definition at line 496 of file vtkWordCloud.h.

virtual StopWordsContainer vtkWordCloud::GetStopWords ( )
inlinevirtual

Definition at line 501 of file vtkWordCloud.h.

virtual void vtkWordCloud::SetStopListFileName ( std::string  arg)
inlinevirtual

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

Definition at line 509 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetStopListFileName ( )
inlinevirtual

Definition at line 517 of file vtkWordCloud.h.

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 525 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetTitle ( )
inlinevirtual

Definition at line 533 of file vtkWordCloud.h.

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 542 of file vtkWordCloud.h.

virtual std::string vtkWordCloud::GetWordColorName ( )
inlinevirtual

Definition at line 550 of file vtkWordCloud.h.

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

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

Definition at line 556 of file vtkWordCloud.h.

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

Get a vector of words that are skipped.

Skipped wors do not fit in the final image.

Definition at line 564 of file vtkWordCloud.h.

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

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

Definition at line 571 of file vtkWordCloud.h.

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.

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

vtkSmartPointer<vtkImageData> vtkWordCloud::ImageData
protected

Definition at line 585 of file vtkWordCloud.h.

int vtkWordCloud::WholeExtent[6]
protected

Definition at line 586 of file vtkWordCloud.h.

SizesContainer vtkWordCloud::AdjustedSizes
protected

Definition at line 588 of file vtkWordCloud.h.

std::string vtkWordCloud::BackgroundColorName
protected

Definition at line 589 of file vtkWordCloud.h.

bool vtkWordCloud::BWMask
protected

Definition at line 590 of file vtkWordCloud.h.

ColorDistributionContainer vtkWordCloud::ColorDistribution
protected

Definition at line 591 of file vtkWordCloud.h.

std::string vtkWordCloud::ColorSchemeName
protected

Definition at line 592 of file vtkWordCloud.h.

int vtkWordCloud::DPI
protected

Definition at line 593 of file vtkWordCloud.h.

std::string vtkWordCloud::FileName
protected

Definition at line 594 of file vtkWordCloud.h.

std::string vtkWordCloud::FontFileName
protected

Definition at line 595 of file vtkWordCloud.h.

int vtkWordCloud::FontMultiplier
protected

Definition at line 596 of file vtkWordCloud.h.

int vtkWordCloud::Gap
protected

Definition at line 597 of file vtkWordCloud.h.

std::string vtkWordCloud::MaskColorName
protected

Definition at line 598 of file vtkWordCloud.h.

std::string vtkWordCloud::MaskFileName
protected

Definition at line 599 of file vtkWordCloud.h.

int vtkWordCloud::MaxFontSize
protected

Definition at line 600 of file vtkWordCloud.h.

int vtkWordCloud::MinFontSize
protected

Definition at line 601 of file vtkWordCloud.h.

int vtkWordCloud::MinFrequency
protected

Definition at line 602 of file vtkWordCloud.h.

OffsetDistributionContainer vtkWordCloud::OffsetDistribution
protected

Definition at line 603 of file vtkWordCloud.h.

OrientationDistributionContainer vtkWordCloud::OrientationDistribution
protected

Definition at line 604 of file vtkWordCloud.h.

OrientationsContainer vtkWordCloud::Orientations
protected

Definition at line 605 of file vtkWordCloud.h.

ReplacementPairsContainer vtkWordCloud::ReplacementPairs
protected

Definition at line 606 of file vtkWordCloud.h.

SizesContainer vtkWordCloud::Sizes
protected

Definition at line 607 of file vtkWordCloud.h.

StopWordsContainer vtkWordCloud::StopWords
protected

Definition at line 608 of file vtkWordCloud.h.

std::string vtkWordCloud::StopListFileName
protected

Definition at line 609 of file vtkWordCloud.h.

std::string vtkWordCloud::Title
protected

Definition at line 610 of file vtkWordCloud.h.

std::string vtkWordCloud::WordColorName
protected

Definition at line 611 of file vtkWordCloud.h.

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

Definition at line 613 of file vtkWordCloud.h.

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

Definition at line 614 of file vtkWordCloud.h.

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

Definition at line 615 of file vtkWordCloud.h.


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