Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# vtkImageButterworthHighPass Class Reference

`#include <vtkImageButterworthHighPass.h>`

Inheritance diagram for vtkImageButterworthHighPass:

[legend]
Collaboration diagram for vtkImageButterworthHighPass:

[legend]
List of all members.

## Detailed Description

Frequency domain high pass.

Date:
  2002/01/22 15:31:54

Revision:
  1.21

This filter only works on an image after it has been converted to frequency domain by a vtkImageFFT filter. A vtkImageRFFT filter can be used to convert the output back into the spatial domain. 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

Created by:
  - Law, Charles

CVS contributions (if > 5%):
  - Law, Charles (76%)
  - Lorensen, Bill (11%)
  - Martin, Ken (5%)

CVS logs (CVSweb):
  - .`h` (`/Imaging/vtkImageButterworthHighPass.h)`
  - .`cxx` (`/Imaging/vtkImageButterworthHighPass.cxx)`

Tests:
  vtkImageButterworthHighPass (Tests)

Definition at line 55 of file vtkImageButterworthHighPass.h.

## Public Types

typedef vtkImageToImageFilter | Superclass

## 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 ()
void | ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int outExt[6], int id)

## Protected Attributes

int | Order
float | CutOff [3]

## Member Typedef Documentation

typedef vtkImageToImageFilter vtkImageButterworthHighPass::Superclass

| Reimplemented from vtkImageToImageFilter. Definition at line 59 of file vtkImageButterworthHighPass.h.

## Constructor & Destructor Documentation

vtkImageButterworthHighPass::vtkImageButterworthHighPass | ( |  | ) | `[protected]`

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

| Definition at line 85 of file vtkImageButterworthHighPass.h.

## Member Function Documentation

vtkImageButterworthHighPass* vtkImageButterworthHighPass::New | ( |  | ) | `[static]`

| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject.

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

| 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkImageToImageFilter.

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

| 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]`

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

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

| 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). Definition at line 67 of file vtkImageButterworthHighPass.h.

void vtkImageButterworthHighPass::SetXCutOff | ( | float | v | ) |

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

void vtkImageButterworthHighPass::SetYCutOff | ( | float | v | ) |

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

void vtkImageButterworthHighPass::SetZCutOff | ( | float | v | ) |

| 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 float* vtkImageButterworthHighPass::GetCutOff | ( |  | ) | `[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::GetCutOff | ( | 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::GetCutOff | ( | float | [3] | ) | `[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).

float vtkImageButterworthHighPass::GetXCutOff | ( |  | ) | `[inline]`

| 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). Definition at line 72 of file vtkImageButterworthHighPass.h.

float vtkImageButterworthHighPass::GetYCutOff | ( |  | ) | `[inline]`

| 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). Definition at line 73 of file vtkImageButterworthHighPass.h.

float vtkImageButterworthHighPass::GetZCutOff | ( |  | ) | `[inline]`

| 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). Definition at line 74 of file vtkImageButterworthHighPass.h.

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

| The order determines sharpness of the cutoff curve.

virtual int vtkImageButterworthHighPass::GetOrder | ( |  | ) | `[virtual]`

| The order determines sharpness of the cutoff curve.

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 87 of file vtkImageButterworthHighPass.h.

float vtkImageButterworthHighPass::CutOff[3]`[protected]`

| Definition at line 88 of file vtkImageButterworthHighPass.h.

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

- Imaging/vtkImageButterworthHighPass.h