---

vtkImageButterworthHighPass Class Reference

Frequency domain high pass. More...

#include <vtkImageButterworthHighPass.h>

Inheritance diagram for vtkImageButterworthHighPass:

[legend]Collaboration diagram for vtkImageButterworthHighPass:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetCutOff (float, float, float)
virtual void	SetCutOff (float[3])
void	SetCutOff (float v)
void	SetXCutOff (float v)
void	SetYCutOff (float v)
void	SetZCutOff (float v)
virtual float *	GetCutOff ()
virtual void	GetCutOff (float &, float &, float &)
virtual void	GetCutOff (float[3])
float	GetXCutOff ()
float	GetYCutOff ()
float	GetZCutOff ()
virtual void	SetOrder (int)
virtual int	GetOrder ()
Static Public Methods
vtkImageButterworthHighPass *	New ()
int	IsTypeOf (const char *type)
vtkImageButterworthHighPass *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageButterworthHighPass ()
	~vtkImageButterworthHighPass ()
	vtkImageButterworthHighPass (const vtkImageButterworthHighPass &)
void	operator= (const vtkImageButterworthHighPass &)
void	ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int outExt[6], int id)
Protected Attributes
int	Order
float	CutOff [3]

---

Detailed Description

Frequency domain high pass.

Date:

2000/12/10 20:09:03

Revision:

1.14

Thanks:

Thanks to C. Charles Law who developed this class.

vtkImageButterworthHighPass the frequency components around 0 are attenuated. Input and output are in floats, with two components (complex numbers). out(i, j) = 1 / (1 + pow(CutOff/Freq(i,j), 2*Order));

See also:

vtkImageButterworthLowPass

Examples:

vtkImageButterworthHighPass (examples)

Definition at line 64 of file vtkImageButterworthHighPass.h.

---

Constructor & Destructor Documentation

vtkImageButterworthHighPass::vtkImageButterworthHighPass (    )  [protected]

vtkImageButterworthHighPass::~vtkImageButterworthHighPass (    )  [inline, protected]

Definition at line 90 of file vtkImageButterworthHighPass.h.

vtkImageButterworthHighPass::vtkImageButterworthHighPass (  const vtkImageButterworthHighPass &    )  [inline, protected]

Definition at line 91 of file vtkImageButterworthHighPass.h.

---

Member Function Documentation

vtkImageButterworthHighPass* vtkImageButterworthHighPass::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageToImageFilter.

virtual const char* vtkImageButterworthHighPass::GetClassName (    )  [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

int vtkImageButterworthHighPass::IsTypeOf (  const char *    type )  [static]

Return 1 if this class type 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 vtkImageToImageFilter.

virtual int vtkImageButterworthHighPass::IsA (  const char *    type )  [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 vtkImageToImageFilter.

vtkImageButterworthHighPass* vtkImageButterworthHighPass::SafeDownCast (  vtkObject *    o )  [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

void vtkImageButterworthHighPass::PrintSelf (  ostream &    os, vtkIndent    indent )  [virtual]

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

virtual void vtkImageButterworthHighPass::SetCutOff (  float   , float   , float    )  [virtual]

Set/Get the cutoff frequency for each axis. The values are specified in the order X, Y, Z, Time. Units: Cycles per world unit (as defined by the data spacing).

virtual void vtkImageButterworthHighPass::SetCutOff (  float   [3] )  [virtual]

void vtkImageButterworthHighPass::SetCutOff (  float    v )  [inline]

Definition at line 75 of file vtkImageButterworthHighPass.h.

void vtkImageButterworthHighPass::SetXCutOff (  float    v )

void vtkImageButterworthHighPass::SetYCutOff (  float    v )

void vtkImageButterworthHighPass::SetZCutOff (  float    v )

virtual float* vtkImageButterworthHighPass::GetCutOff (    )  [virtual]

virtual void vtkImageButterworthHighPass::GetCutOff (  float &   , float &   , float &    )  [virtual]

virtual void vtkImageButterworthHighPass::GetCutOff (  float   [3] )  [virtual]

float vtkImageButterworthHighPass::GetXCutOff (    )  [inline]

Definition at line 80 of file vtkImageButterworthHighPass.h.

float vtkImageButterworthHighPass::GetYCutOff (    )  [inline]

Definition at line 81 of file vtkImageButterworthHighPass.h.

float vtkImageButterworthHighPass::GetZCutOff (    )  [inline]

Definition at line 82 of file vtkImageButterworthHighPass.h.

virtual void vtkImageButterworthHighPass::SetOrder (  int    )  [virtual]

The order determines sharpness of the cutoff curve.

virtual int vtkImageButterworthHighPass::GetOrder (    )  [virtual]

void vtkImageButterworthHighPass::operator= (  const vtkImageButterworthHighPass &    )  [inline, protected]

Definition at line 92 of file vtkImageButterworthHighPass.h.

void vtkImageButterworthHighPass::ThreadedExecute (  vtkImageData *    inData, vtkImageData *    outData, int    outExt[6], int    id )  [protected, virtual]

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

---

Member Data Documentation

int vtkImageButterworthHighPass::Order [protected]

Definition at line 94 of file vtkImageButterworthHighPass.h.

float vtkImageButterworthHighPass::CutOff[3] [protected]

Definition at line 95 of file vtkImageButterworthHighPass.h.

---

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

• imaging/vtkImageButterworthHighPass.h

---