vtkSliceCubes Class Reference

generate isosurface(s) from volume four slices at a time More...

#include <vtkSliceCubes.h>

Inheritance diagram for vtkSliceCubes:

Collaboration diagram for vtkSliceCubes:

Public Types
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.
vtkSliceCubes *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Write ()
void	Update ()
virtual void	SetReader (vtkVolumeReader *)
	Set/get object to read slices.
virtual vtkVolumeReader *	GetReader ()
	Set/get object to read slices.
	vtkSetFilePathMacro (FileName)
	Specify file name of marching cubes output file.
	vtkGetFilePathMacro (FileName)
	Specify file name of marching cubes output file.
virtual void	SetValue (double)
	Set/get isosurface contour value.
virtual double	GetValue ()
	Set/get isosurface contour value.
	vtkSetFilePathMacro (LimitsFileName)
	Specify file name of marching cubes limits file.
	vtkGetFilePathMacro (LimitsFileName)
	Specify file name of marching cubes limits file.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkSliceCubes *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSliceCubes *	SafeDownCast (vtkObjectBase *o)
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSliceCubes ()
	~vtkSliceCubes () override
void	Execute ()
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkVolumeReader *	Reader
char *	FileName
double	Value
char *	LimitsFileName
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

generate isosurface(s) from volume four slices at a time

vtkSliceCubes is a special version of the marching cubes filter. Instead of ingesting an entire volume at once it processes only four slices at a time. This way, it can generate isosurfaces from huge volumes. Also, the output of this object is written to a marching cubes triangle file. That way, output triangles do not need to be held in memory.

To use vtkSliceCubes you must specify an instance of vtkVolumeReader to read the data. Set this object up with the proper file prefix, image range, data origin, data dimensions, header size, data mask, and swap bytes flag. The vtkSliceCubes object will then take over and read slices as necessary. You also will need to specify the name of an output marching cubes triangle file.

Warning

This process object is both a source and mapper (i.e., it reads and writes data to a file). This is different than the other marching cubes objects (and most process objects in the system). It's specialized to handle very large data.

This object only extracts a single isosurface. This compares with the other contouring objects in vtk that generate multiple surfaces.

To read the output file use vtkMCubesReader.

See also

vtkMarchingCubes vtkContourFilter vtkMCubesReader vtkDividingCubes vtkVolumeReader

Definition at line 57 of file vtkSliceCubes.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkSliceCubes::Superclass

Definition at line 61 of file vtkSliceCubes.h.

Constructor & Destructor Documentation

vtkSliceCubes()

vtkSliceCubes::vtkSliceCubes ( )

protected

~vtkSliceCubes()

vtkSliceCubes::~vtkSliceCubes ( )

overrideprotected

Member Function Documentation

New()

static vtkSliceCubes * vtkSliceCubes::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkSliceCubes::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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSliceCubes::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkSliceCubes * vtkSliceCubes::NewInstance

(

)

const

PrintSelf()

void vtkSliceCubes::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 vtkObject.

Write()

void vtkSliceCubes::Write ( )

inline

Definition at line 65 of file vtkSliceCubes.h.

Update()

void vtkSliceCubes::Update

(

)

SetReader()

virtual void vtkSliceCubes::SetReader ( vtkVolumeReader *  )

virtual

Set/get object to read slices.

GetReader()

virtual vtkVolumeReader * vtkSliceCubes::GetReader ( )

virtual

Set/get object to read slices.

vtkSetFilePathMacro() [1/2]

vtkSliceCubes::vtkSetFilePathMacro

(

FileName

)

Specify file name of marching cubes output file.

vtkGetFilePathMacro() [1/2]

vtkSliceCubes::vtkGetFilePathMacro

(

FileName

)

Specify file name of marching cubes output file.

SetValue()

virtual void vtkSliceCubes::SetValue ( double  )

virtual

Set/get isosurface contour value.

GetValue()

virtual double vtkSliceCubes::GetValue ( )

virtual

Set/get isosurface contour value.

vtkSetFilePathMacro() [2/2]

vtkSliceCubes::vtkSetFilePathMacro

(

LimitsFileName

)

Specify file name of marching cubes limits file.

The limits file speeds up subsequent reading of output triangle file.

vtkGetFilePathMacro() [2/2]

vtkSliceCubes::vtkGetFilePathMacro

(

LimitsFileName

)

Specify file name of marching cubes limits file.

The limits file speeds up subsequent reading of output triangle file.

Execute()

void vtkSliceCubes::Execute ( )

protected

Member Data Documentation

Reader

vtkVolumeReader* vtkSliceCubes::Reader

protected

Definition at line 107 of file vtkSliceCubes.h.

FileName

char* vtkSliceCubes::FileName

protected

Definition at line 108 of file vtkSliceCubes.h.

Value

double vtkSliceCubes::Value

protected

Definition at line 109 of file vtkSliceCubes.h.

LimitsFileName

char* vtkSliceCubes::LimitsFileName

protected

Definition at line 110 of file vtkSliceCubes.h.

---

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

• Imaging/Hybrid/vtkSliceCubes.h