ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkImageBlend Class Reference

vtkImageBlend - blend images together using alpha or opacity More...

Inheritance diagram for Kitware.VTK.vtkImageBlend:
[legend]
Collaboration diagram for Kitware.VTK.vtkImageBlend:
[legend]

List of all members.

Public Member Functions

 vtkImageBlend (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImageBlend ()
 Undocumented Block.
virtual int GetBlendMode ()
 Set the blend mode.
string GetBlendModeAsString ()
 Get the blending mode as a descriptive string.
virtual int GetBlendModeMaxValue ()
 Set the blend mode.
virtual int GetBlendModeMinValue ()
 Set the blend mode.
virtual double GetCompoundThreshold ()
 Specify a threshold in compound mode. Pixels with opacity*alpha less or equal the threshold are ignored.
new vtkDataObject 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).
new vtkDataObject GetInput ()
 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).
int GetNumberOfInputs ()
 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).
double 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.
vtkImageStencilData GetStencil ()
 Set a stencil to apply when blending the data.
override int IsA (string type)
 Undocumented Block.
new vtkImageBlend NewInstance ()
 Undocumented Block.
virtual void ReplaceNthInputConnection (int idx, vtkAlgorithmOutput input)
 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().
virtual void SetBlendMode (int _arg)
 Set the blend mode.
void SetBlendModeToCompound ()
 Set the blend mode.
void SetBlendModeToNormal ()
 Set the blend mode.
virtual void SetCompoundThreshold (double _arg)
 Specify a threshold in compound mode. Pixels with opacity*alpha less or equal the threshold are ignored.
new void SetInput (int num, vtkDataObject input)
 Set an Input of this filter. This method is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
new void SetInput (vtkDataObject input)
 Set an Input of this filter. This method is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.
void 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.
void SetStencil (vtkImageStencilData stencil)
 Set a stencil to apply when blending the data.

Static Public Member Functions

static new vtkImageBlend New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkImageBlend SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkImageBlend"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkImageBlend"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkImageBlend_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkImageBlend_GetBlendMode_01 (HandleRef pThis)
static internal IntPtr vtkImageBlend_GetBlendModeAsString_02 (HandleRef pThis)
static internal int vtkImageBlend_GetBlendModeMaxValue_03 (HandleRef pThis)
static internal int vtkImageBlend_GetBlendModeMinValue_04 (HandleRef pThis)
static internal double vtkImageBlend_GetCompoundThreshold_05 (HandleRef pThis)
static internal IntPtr vtkImageBlend_GetInput_06 (HandleRef pThis, int num, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkImageBlend_GetInput_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkImageBlend_GetNumberOfInputs_08 (HandleRef pThis)
static internal double vtkImageBlend_GetOpacity_09 (HandleRef pThis, int idx)
static internal IntPtr vtkImageBlend_GetStencil_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkImageBlend_IsA_11 (HandleRef pThis, string type)
static internal int vtkImageBlend_IsTypeOf_12 (string type)
static internal IntPtr vtkImageBlend_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageBlend_ReplaceNthInputConnection_15 (HandleRef pThis, int idx, HandleRef input)
static internal IntPtr vtkImageBlend_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageBlend_SetBlendMode_17 (HandleRef pThis, int _arg)
static internal void vtkImageBlend_SetBlendModeToCompound_18 (HandleRef pThis)
static internal void vtkImageBlend_SetBlendModeToNormal_19 (HandleRef pThis)
static internal void vtkImageBlend_SetCompoundThreshold_20 (HandleRef pThis, double _arg)
static internal void vtkImageBlend_SetInput_21 (HandleRef pThis, int num, HandleRef input)
static internal void vtkImageBlend_SetInput_22 (HandleRef pThis, HandleRef input)
static internal void vtkImageBlend_SetOpacity_23 (HandleRef pThis, int idx, double opacity)
static internal void vtkImageBlend_SetStencil_24 (HandleRef pThis, HandleRef stencil)

Static Private Member Functions

static vtkImageBlend ()
 Automatically generated type registration mechanics.

Detailed Description

vtkImageBlend - blend images together using alpha or opacity

Description 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
    }

Constructor & Destructor Documentation

static Kitware.VTK.vtkImageBlend.vtkImageBlend ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkImageBlend.vtkImageBlend ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkImageBlend.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

virtual int Kitware.VTK.vtkImageBlend.GetBlendMode ( ) [virtual]

Set the blend mode.

Get the blending mode as a descriptive string.

Set the blend mode.

Set the blend mode.

virtual double Kitware.VTK.vtkImageBlend.GetCompoundThreshold ( ) [virtual]

Specify a threshold in compound mode. Pixels with opacity*alpha less or equal the threshold are ignored.

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

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Here is the call graph for this function:

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

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Here is the call graph for this function:

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

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.

Set a stencil to apply when blending the data.

Here is the call graph for this function:

override int Kitware.VTK.vtkImageBlend.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

static new int Kitware.VTK.vtkImageBlend.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

virtual void Kitware.VTK.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().

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkImageBlend.SetBlendMode ( int  _arg) [virtual]

Set the blend mode.

Set the blend mode.

Set the blend mode.

virtual void Kitware.VTK.vtkImageBlend.SetCompoundThreshold ( double  _arg) [virtual]

Specify a threshold in compound mode. Pixels with opacity*alpha less or equal the threshold are ignored.

new void Kitware.VTK.vtkImageBlend.SetInput ( int  num,
vtkDataObject  input 
)

Set an Input of this filter. This method is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Set an Input of this filter. This method is only for support of old-style pipeline connections. When writing new code you should use SetInputConnection(), AddInputConnection(), and ReplaceNthInputConnection() instead.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

void Kitware.VTK.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.

Set a stencil to apply when blending the data.

static internal int Kitware.VTK.vtkImageBlend.vtkImageBlend_GetBlendMode_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_GetBlendModeAsString_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageBlend.vtkImageBlend_GetBlendModeMaxValue_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageBlend.vtkImageBlend_GetBlendModeMinValue_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkImageBlend.vtkImageBlend_GetCompoundThreshold_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_GetInput_06 ( HandleRef  pThis,
int  num,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_GetInput_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkImageBlend.vtkImageBlend_GetNumberOfInputs_08 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkImageBlend.vtkImageBlend_GetOpacity_09 ( HandleRef  pThis,
int  idx 
) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_GetStencil_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkImageBlend.vtkImageBlend_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkImageBlend.vtkImageBlend_IsTypeOf_12 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_ReplaceNthInputConnection_15 ( HandleRef  pThis,
int  idx,
HandleRef  input 
) [private]
static internal IntPtr Kitware.VTK.vtkImageBlend.vtkImageBlend_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetBlendMode_17 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetBlendModeToCompound_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetBlendModeToNormal_19 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetCompoundThreshold_20 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetInput_21 ( HandleRef  pThis,
int  num,
HandleRef  input 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetInput_22 ( HandleRef  pThis,
HandleRef  input 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetOpacity_23 ( HandleRef  pThis,
int  idx,
double  opacity 
) [private]
static internal void Kitware.VTK.vtkImageBlend.vtkImageBlend_SetStencil_24 ( HandleRef  pThis,
HandleRef  stencil 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkImageBlend.MRClassNameKey = "13vtkImageBlend" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

new const string Kitware.VTK.vtkImageBlend.MRFullTypeName = "Kitware.VTK.vtkImageBlend"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.


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