vtkImageBlend Class Reference

blend images together using alpha or opacity More...

#include <vtkImageBlend.h>

Inheritance diagram for vtkImageBlend:

Collaboration diagram for vtkImageBlend:

Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Types inherited from vtkThreadedImageAlgorithm
typedef vtkImageAlgorithm	Superclass
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...
vtkImageBlend *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	ReplaceNthInputConnection (int idx, vtkAlgorithmOutput *input)
	Replace one of the input connections with a new input. More...
int	GetNumberOfInputs ()
	Get the number of inputs to this filter. More...
void	SetStencilConnection (vtkAlgorithmOutput *algOutput)
	Set a stencil to apply when blending the data. More...
void	SetInputData (int num, vtkDataObject *input)
	Assign a data object as input. More...
void	SetInputData (vtkDataObject *input)
	Assign a data object as input. More...
vtkDataObject *	GetInput (int num)
	Get one input to this filter. More...
vtkDataObject *	GetInput ()
	Get one input to this filter. More...
void	SetOpacity (int idx, double opacity)
	Set the opacity of an input image: the alpha values of the image are multiplied by the opacity. More...
double	GetOpacity (int idx)
	Set the opacity of an input image: the alpha values of the image are multiplied by the opacity. More...
void	SetStencilData (vtkImageStencilData *stencil)
	Set a stencil to apply when blending the data. More...
vtkImageStencilData *	GetStencil ()
	Set a stencil to apply when blending the data. More...
virtual void	SetBlendMode (int)
	Set the blend mode. More...
virtual int	GetBlendMode ()
	Set the blend mode. More...
void	SetBlendModeToNormal ()
	Set the blend mode. More...
void	SetBlendModeToCompound ()
	Set the blend mode. More...
const char *	GetBlendModeAsString (void)
	Get the blending mode as a descriptive string. More...
virtual void	SetCompoundThreshold (double)
	Specify a threshold in compound mode. More...
virtual double	GetCompoundThreshold ()
	Specify a threshold in compound mode. More...
Public Member Functions inherited from vtkThreadedImageAlgorithm
vtkThreadedImageAlgorithm *	NewInstance () const
virtual void	ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
virtual int	SplitExtent (int splitExt[6], int startExt[6], int num, int total)
	Putting this here until I merge graphics and imaging streaming. More...
virtual bool	GetEnableSMP ()
	Enable/Disable SMP for threading. More...
virtual void	SetEnableSMP (bool)
	Enable/Disable SMP for threading. More...
virtual void	SetMinimumPieceSize (int, int, int)
	The minimum piece size when volume is split for execution. More...
virtual void	SetMinimumPieceSize (int[3])
	The minimum piece size when volume is split for execution. More...
virtual int *	GetMinimumPieceSize ()
	The minimum piece size when volume is split for execution. More...
virtual void	GetMinimumPieceSize (int &, int &, int &)
	The minimum piece size when volume is split for execution. More...
virtual void	GetMinimumPieceSize (int[3])
	The minimum piece size when volume is split for execution. More...
virtual void	SetDesiredBytesPerPiece (vtkIdType)
	The desired bytes per piece when volume is split for execution. More...
virtual vtkIdType	GetDesiredBytesPerPiece ()
	The desired bytes per piece when volume is split for execution. More...
virtual void	SetSplitMode (int)
	Set the method used to divide the volume into pieces. More...
void	SetSplitModeToSlab ()
	Set the method used to divide the volume into pieces. More...
void	SetSplitModeToBeam ()
	Set the method used to divide the volume into pieces. More...
void	SetSplitModeToBlock ()
	Set the method used to divide the volume into pieces. More...
virtual int	GetSplitMode ()
	Set the method used to divide the volume into pieces. More...
virtual void	SetNumberOfThreads (int)
	Get/Set the number of threads to create when rendering. More...
virtual int	GetNumberOfThreads ()
	Get/Set the number of threads to create when rendering. More...
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const
int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Process a request from the executive. More...
vtkImageData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...
vtkImageData *	GetOutput (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...
vtkDataObject *	GetInput (int port)
	Get a data object for one of the input port connections. More...
vtkDataObject *	GetInput ()
	Get a data object for one of the input port connections. More...
vtkImageData *	GetImageDataInput (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
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...
vtkExecutive *	GetExecutive ()
	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...
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...
vtkInformation *	GetOutputPortInformation (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	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...
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...
void	RemoveAllInputs ()
	Remove all the input data. More...
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject *	GetInputDataObject (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)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput *	GetOutputPort ()
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...
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...
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. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...
vtkInformation *	GetOutputInformation (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 vtkInformation *	GetInformation ()
	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 void	SetProgress (double)
	Set/Get the execution progress of a process object. More...
virtual double	GetProgress ()
	Set/Get the execution progress of a process object. 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...
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...
int *	GetUpdateExtent (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 vtkProgressObserver *	GetProgressObserver ()
	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...
vtkCommand *	GetCommand (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 vtkImageBlend *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageBlend *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkThreadedImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)
static vtkThreadedImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
static void	SetGlobalDefaultEnableSMP (bool enable)
	Global Disable SMP for all derived Imaging filters. More...
static bool	GetGlobalDefaultEnableSMP ()
	Global Disable SMP for all derived Imaging filters. More...
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. More...
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. More...
static vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageBlend ()
	~vtkImageBlend () override
int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
void	InternalComputeInputUpdateExtent (int inExt[6], int outExt[6], int inWExtent[6])
void	ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id) override
	If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. More...
int	FillInputPortInformation (int, vtkInformation *) override
	These method should be reimplemented by subclasses that have more than a single input or single output. More...
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	This is called by the superclass. More...
Protected Member Functions inherited from vtkThreadedImageAlgorithm
	vtkThreadedImageAlgorithm ()
	~vtkThreadedImageAlgorithm () override
virtual void	SMPRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, vtkIdType begin, vtkIdType end, vtkIdType pieces, int extent[6])
	Execute ThreadedRequestData for the given set of pieces. More...
virtual void	PrepareImageData (vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inDataObjects=nullptr, vtkImageData **outDataObjects=nullptr)
	Allocate space for output data and copy attributes from first input. More...
Protected Member Functions inherited from vtkImageAlgorithm
	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. 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 vtkImageData *	AllocateOutputData (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...
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...
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive *	CreateDefaultExecutive ()
	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...
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. More...
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. More...
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...
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. More...
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. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (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
double *	Opacity
int	OpacityArrayLength
int	BlendMode
double	CompoundThreshold
int	DataWasPassed
Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreader *	Threader
int	NumberOfThreads
bool	EnableSMP
int	SplitMode
int	SplitPath [3]
int	SplitPathLength
int	MinimumPieceSize [3]
vtkIdType	DesiredBytesPerPiece
Protected Attributes inherited from vtkAlgorithm
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. 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
Protected Types inherited from vtkThreadedImageAlgorithm
enum	SplitModeEnum { SLAB = 0, BEAM = 1, BLOCK = 2 }
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkThreadedImageAlgorithm
static bool	GlobalDefaultEnableSMP
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

blend images together using alpha or opacity

vtkImageBlend takes L, LA, RGB, or RGBA images as input and blends them according to the alpha values and/or the opacity setting for each input.

The spacing, origin, extent, and number of components of the output are the same as those for the first input. If the input has an alpha component, then this component is copied unchanged into the output. In addition, if the first input has either one component or two components i.e. if it is either L (greyscale) or LA (greyscale + alpha) then all other inputs must also be L or LA.

Different blending modes are available:

Normal (default) : This is the standard blending mode used by OpenGL and other graphics packages. The output always has the same number of components and the same extent as the first input. The alpha value of the first input is not used in the blending computation, instead it is copied directly to the output.

output <- input[0]
foreach input i {
  foreach pixel px {
    r <- input[i](px)(alpha) * opacity[i]
    f <- (255 - r)
    output(px) <- output(px) * f + input(px) * r
  }
}

Compound : Images are compounded together and each component is scaled by the sum of the alpha/opacity values. Use the CompoundThreshold method to set specify a threshold in compound mode. Pixels with opacity*alpha less or equal than this threshold are ignored. The alpha value of the first input, if present, is NOT copied to the alpha value of the output. The output always has the same number of components and the same extent as the first input.

output <- 0
foreach pixel px {
  sum <- 0
  foreach input i {
    r <- input[i](px)(alpha) * opacity(i)
    sum <- sum + r
    if r > threshold {
      output(px) <- output(px) + input(px) * r
    }
  }
  output(px) <- output(px) / sum
}

Tests:

vtkImageBlend (Tests)

Definition at line 89 of file vtkImageBlend.h.

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageBlend::Superclass

Definition at line 93 of file vtkImageBlend.h.

Constructor & Destructor Documentation

vtkImageBlend::vtkImageBlend ( )

protected

vtkImageBlend::~vtkImageBlend ( )

overrideprotected

Member Function Documentation

static vtkImageBlend* vtkImageBlend::New ( )

static

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

static

virtual vtkTypeBool vtkImageBlend::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 vtkThreadedImageAlgorithm.

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

static

virtual vtkObjectBase* vtkImageBlend::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkThreadedImageAlgorithm.

vtkImageBlend* vtkImageBlend::NewInstance

(

)

const

void vtkImageBlend::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 vtkThreadedImageAlgorithm.

virtual void vtkImageBlend::ReplaceNthInputConnection ( int  idx, vtkAlgorithmOutput *  input  )

virtual

Replace one of the input connections with a new input.

You can only replace input connections that you previously created with AddInputConnection() or, in the case of the first input, with SetInputConnection().

void vtkImageBlend::SetInputData	(	int	num,
		vtkDataObject *	input
	)

Assign a data object as input.

Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

void vtkImageBlend::SetInputData ( vtkDataObject *  input )

inline

Assign a data object as input.

Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

Definition at line 111 of file vtkImageBlend.h.

vtkDataObject* vtkImageBlend::GetInput

(

int

num

)

Get one input to this filter.

This method is only for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).

vtkDataObject* vtkImageBlend::GetInput ( )

inline

Get one input to this filter.

This method is only for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetInputConnection(0, num).

Definition at line 121 of file vtkImageBlend.h.

int vtkImageBlend::GetNumberOfInputs ( )

inline

Get the number of inputs to this filter.

This method is only for support of old-style pipeline connections. When writing new code you should use vtkAlgorithm::GetNumberOfInputConnections(0).

Definition at line 129 of file vtkImageBlend.h.

void vtkImageBlend::SetOpacity	(	int	idx,
		double	opacity
	)

Set the opacity of an input image: the alpha values of the image are multiplied by the opacity.

The opacity of image idx=0 is ignored.

double vtkImageBlend::GetOpacity

(

int

idx

)

Set the opacity of an input image: the alpha values of the image are multiplied by the opacity.

The opacity of image idx=0 is ignored.

void vtkImageBlend::SetStencilConnection

(

vtkAlgorithmOutput *

algOutput

)

Set a stencil to apply when blending the data.

Create a pipeline connection.

void vtkImageBlend::SetStencilData

(

vtkImageStencilData *

stencil

)

Set a stencil to apply when blending the data.

vtkImageStencilData* vtkImageBlend::GetStencil

(

)

Set a stencil to apply when blending the data.

virtual void vtkImageBlend::SetBlendMode ( int  )

virtual

Set the blend mode.

virtual int vtkImageBlend::GetBlendMode ( )

virtual

Set the blend mode.

void vtkImageBlend::SetBlendModeToNormal ( )

inline

Set the blend mode.

Definition at line 162 of file vtkImageBlend.h.

void vtkImageBlend::SetBlendModeToCompound ( )

inline

Set the blend mode.

Definition at line 164 of file vtkImageBlend.h.

const char * vtkImageBlend::GetBlendModeAsString ( void  )

inline

Get the blending mode as a descriptive string.

Definition at line 218 of file vtkImageBlend.h.

virtual void vtkImageBlend::SetCompoundThreshold ( double  )

virtual

Specify a threshold in compound mode.

Pixels with opacity*alpha less or equal the threshold are ignored.

virtual double vtkImageBlend::GetCompoundThreshold ( )

virtual

Specify a threshold in compound mode.

Pixels with opacity*alpha less or equal the threshold are ignored.

int vtkImageBlend::RequestUpdateExtent ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.

Reimplemented from vtkImageAlgorithm.

void vtkImageBlend::InternalComputeInputUpdateExtent ( int  inExt[6], int  outExt[6], int  inWExtent[6]  )

protected

void vtkImageBlend::ThreadedRequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector, vtkImageData ***  inData, vtkImageData **  outData, int  extent[6], int  threadId  )

overrideprotectedvirtual

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method.

It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.

int vtkImageBlend::FillInputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

These method should be reimplemented by subclasses that have more than a single input or single output.

See vtkAlgorithm for more information.

Reimplemented from vtkImageAlgorithm.

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkThreadedImageAlgorithm.

Member Data Documentation

double* vtkImageBlend::Opacity

protected

Definition at line 203 of file vtkImageBlend.h.

int vtkImageBlend::OpacityArrayLength

protected

Definition at line 204 of file vtkImageBlend.h.

int vtkImageBlend::BlendMode

protected

Definition at line 205 of file vtkImageBlend.h.

double vtkImageBlend::CompoundThreshold

protected

Definition at line 206 of file vtkImageBlend.h.

int vtkImageBlend::DataWasPassed

protected

Definition at line 207 of file vtkImageBlend.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Imaging/Core/vtkImageBlend.h