vtkImageFlip Class Reference

This flips an axis of an image. Right becomes left ... More...

#include <vtkImageFlip.h>

Inheritance diagram for vtkImageFlip:

Collaboration diagram for vtkImageFlip:

List of all members.

Public Types
typedef vtkImageReslice	Superclass
Public Types inherited from vtkImageReslice
Public Types inherited from vtkThreadedImageAlgorithm
Public Types inherited from vtkImageAlgorithm
Public Types inherited from vtkAlgorithm
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetFilteredAxis (int)
virtual int	GetFilteredAxis ()
virtual void	SetFlipAboutOrigin (int)
virtual int	GetFlipAboutOrigin ()
virtual void	FlipAboutOriginOn ()
virtual void	FlipAboutOriginOff ()
void	SetFilteredAxes (int axis)
int	GetFilteredAxes ()
virtual void	SetPreserveImageExtent (int)
virtual int	GetPreserveImageExtent ()
virtual void	PreserveImageExtentOn ()
virtual void	PreserveImageExtentOff ()
Public Member Functions inherited from vtkImageReslice
unsigned long int	GetMTime ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetResliceAxes (vtkMatrix4x4 *)
virtual vtkMatrix4x4 *	GetResliceAxes ()
void	SetResliceAxesDirectionCosines (double x0, double x1, double x2, double y0, double y1, double y2, double z0, double z1, double z2)
void	SetResliceAxesDirectionCosines (const double x[3], const double y[3], const double z[3])
void	SetResliceAxesDirectionCosines (const double xyz[9])
void	GetResliceAxesDirectionCosines (double x[3], double y[3], double z[3])
void	GetResliceAxesDirectionCosines (double xyz[9])
double *	GetResliceAxesDirectionCosines ()
void	SetResliceAxesOrigin (double x, double y, double z)
void	SetResliceAxesOrigin (const double xyz[3])
void	GetResliceAxesOrigin (double xyz[3])
double *	GetResliceAxesOrigin ()
virtual void	SetResliceTransform (vtkAbstractTransform *)
virtual vtkAbstractTransform *	GetResliceTransform ()
virtual void	SetInformationInput (vtkImageData *)
virtual vtkImageData *	GetInformationInput ()
virtual void	SetTransformInputSampling (int)
virtual void	TransformInputSamplingOn ()
virtual void	TransformInputSamplingOff ()
virtual int	GetTransformInputSampling ()
virtual void	SetAutoCropOutput (int)
virtual void	AutoCropOutputOn ()
virtual void	AutoCropOutputOff ()
virtual int	GetAutoCropOutput ()
virtual void	SetWrap (int)
virtual int	GetWrap ()
virtual void	WrapOn ()
virtual void	WrapOff ()
virtual void	SetMirror (int)
virtual int	GetMirror ()
virtual void	MirrorOn ()
virtual void	MirrorOff ()
virtual void	SetBorder (int)
virtual int	GetBorder ()
virtual void	BorderOn ()
virtual void	BorderOff ()
virtual void	SetInterpolationMode (int)
virtual int	GetInterpolationMode ()
void	SetInterpolationModeToNearestNeighbor ()
void	SetInterpolationModeToLinear ()
void	SetInterpolationModeToCubic ()
virtual const char *	GetInterpolationModeAsString ()
virtual void	SetOptimization (int)
virtual int	GetOptimization ()
virtual void	OptimizationOn ()
virtual void	OptimizationOff ()
virtual void	SetBackgroundColor (double, double, double, double)
virtual void	SetBackgroundColor (double[4])
virtual double *	GetBackgroundColor ()
virtual void	GetBackgroundColor (double &, double &, double &, double &)
virtual void	GetBackgroundColor (double[4])
void	SetBackgroundLevel (double v)
double	GetBackgroundLevel ()
virtual void	SetOutputSpacing (double x, double y, double z)
virtual void	SetOutputSpacing (const double a[3])
virtual double *	GetOutputSpacing ()
virtual void	GetOutputSpacing (double &, double &, double &)
virtual void	GetOutputSpacing (double[3])
void	SetOutputSpacingToDefault ()
virtual void	SetOutputOrigin (double x, double y, double z)
virtual void	SetOutputOrigin (const double a[3])
virtual double *	GetOutputOrigin ()
virtual void	GetOutputOrigin (double &, double &, double &)
virtual void	GetOutputOrigin (double[3])
void	SetOutputOriginToDefault ()
virtual void	SetOutputExtent (int a, int b, int c, int d, int e, int f)
virtual void	SetOutputExtent (const int a[6])
virtual int *	GetOutputExtent ()
virtual void	GetOutputExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetOutputExtent (int[6])
void	SetOutputExtentToDefault ()
virtual void	SetOutputDimensionality (int)
virtual int	GetOutputDimensionality ()
void	SetInterpolate (int t)
void	InterpolateOn ()
void	InterpolateOff ()
int	GetInterpolate ()
void	SetStencil (vtkImageStencilData *stencil)
vtkImageStencilData *	GetStencil ()
Public Member Functions inherited from vtkThreadedImageAlgorithm
virtual void	ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
virtual void	SetNumberOfThreads (int)
virtual int	GetNumberOfThreads ()
virtual int	SplitExtent (int splitExt[6], int startExt[6], int num, int total)
Public Member Functions inherited from vtkImageAlgorithm
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkImageData *	GetImageDataInput (int port)
vtkImageData *	GetOutput ()
vtkImageData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	SetInput (vtkDataObject *)
void	SetInput (int, vtkDataObject *)
virtual void	AddInput (vtkDataObject *)
virtual void	AddInput (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
virtual void	Update ()
virtual void	UpdateInformation ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double	ComputePriority ()
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkImageFlip *	New ()
static int	IsTypeOf (const char *type)
static vtkImageFlip *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkImageFlip ()
	~vtkImageFlip ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkImageReslice
	vtkImageReslice ()
	~vtkImageReslice ()
void	GetAutoCroppedOutputBounds (vtkInformation *inInfo, double bounds[6])
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
vtkMatrix4x4 *	GetIndexMatrix (vtkInformation *inInfo, vtkInformation *outInfo)
vtkAbstractTransform *	GetOptimizedTransform ()
Protected Member Functions inherited from vtkThreadedImageAlgorithm
	vtkThreadedImageAlgorithm ()
	~vtkThreadedImageAlgorithm ()
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()
	~vtkImageAlgorithm ()
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out)
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	FilteredAxis
int	FlipAboutOrigin
int	PreserveImageExtent
Protected Attributes inherited from vtkImageReslice
vtkMatrix4x4 *	ResliceAxes
double	ResliceAxesDirectionCosines [9]
double	ResliceAxesOrigin [3]
vtkAbstractTransform *	ResliceTransform
vtkImageData *	InformationInput
int	Wrap
int	Mirror
int	Border
int	InterpolationMode
int	Optimization
double	BackgroundColor [4]
double	OutputOrigin [3]
double	OutputSpacing [3]
int	OutputExtent [6]
int	OutputDimensionality
int	TransformInputSampling
int	AutoCropOutput
int	HitInputExtent
int	ComputeOutputSpacing
int	ComputeOutputOrigin
int	ComputeOutputExtent
vtkMatrix4x4 *	IndexMatrix
vtkAbstractTransform *	OptimizedTransform
Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreader *	Threader
int	NumberOfThreads

---

Detailed Description

This flips an axis of an image. Right becomes left ...

vtkImageFlip will reflect the data along the filtered axis. This filter is actually a thin wrapper around vtkImageReslice.

Tests:

vtkImageFlip (Tests)

Definition at line 31 of file vtkImageFlip.h.

---

Member Typedef Documentation

typedef vtkImageReslice vtkImageFlip::Superclass

Reimplemented from vtkImageReslice.

Definition at line 36 of file vtkImageFlip.h.

---

Constructor & Destructor Documentation

vtkImageFlip::vtkImageFlip ( )

protected

vtkImageFlip::~vtkImageFlip ( )

inlineprotected

Definition at line 83 of file vtkImageFlip.h.

---

Member Function Documentation

static vtkImageFlip* vtkImageFlip::New ( )

static

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

Reimplemented from vtkImageReslice.

virtual const char* vtkImageFlip::GetClassName ( )

virtual

Reimplemented from vtkImageReslice.

static int vtkImageFlip::IsTypeOf ( const char *  name )

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

virtual int vtkImageFlip::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 vtkImageReslice.

static vtkImageFlip* vtkImageFlip::SafeDownCast ( vtkObject *  o )

static

Reimplemented from vtkImageReslice.

void vtkImageFlip::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 vtkImageReslice.

virtual void vtkImageFlip::SetFilteredAxis ( int  )

virtual

Specify which axis will be flipped. This must be an integer between 0 (for x) and 2 (for z). Initial value is 0.

virtual int vtkImageFlip::GetFilteredAxis ( )

virtual

Specify which axis will be flipped. This must be an integer between 0 (for x) and 2 (for z). Initial value is 0.

virtual void vtkImageFlip::SetFlipAboutOrigin ( int  )

virtual

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

virtual int vtkImageFlip::GetFlipAboutOrigin ( )

virtual

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

virtual void vtkImageFlip::FlipAboutOriginOn ( )

virtual

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

virtual void vtkImageFlip::FlipAboutOriginOff ( )

virtual

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

void vtkImageFlip::SetFilteredAxes ( int  axis )

inline

Keep the mis-named Axes variations around for compatibility with old scripts. Axis is singular, not plural...

Definition at line 68 of file vtkImageFlip.h.

int vtkImageFlip::GetFilteredAxes ( )

inline

Keep the mis-named Axes variations around for compatibility with old scripts. Axis is singular, not plural...

Definition at line 69 of file vtkImageFlip.h.

virtual void vtkImageFlip::SetPreserveImageExtent ( int  )

virtual

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual int vtkImageFlip::GetPreserveImageExtent ( )

virtual

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual void vtkImageFlip::PreserveImageExtentOn ( )

virtual

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual void vtkImageFlip::PreserveImageExtentOff ( )

virtual

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual int vtkImageFlip::RequestInformation ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

protectedvirtual

Reimplemented from vtkImageReslice.

---

Member Data Documentation

int vtkImageFlip::FilteredAxis

protected

Definition at line 87 of file vtkImageFlip.h.

int vtkImageFlip::FlipAboutOrigin

protected

Definition at line 88 of file vtkImageFlip.h.

int vtkImageFlip::PreserveImageExtent

protected

Definition at line 89 of file vtkImageFlip.h.

---

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

• dox/Imaging/vtkImageFlip.h