VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSliceCubes Class Reference

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

#include <vtkSliceCubes.h>

Inheritance diagram for vtkSliceCubes:
[legend]
Collaboration diagram for vtkSliceCubes:
[legend]

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. More...
 
vtkSliceCubesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Write ()
 
void Update ()
 
virtual void SetReader (vtkVolumeReader *)
 Set/get object to read slices. More...
 
virtual vtkVolumeReaderGetReader ()
 
virtual void SetFileName (const char *)
 Specify file name of marching cubes output file. More...
 
virtual char * GetFileName ()
 
virtual void SetValue (double)
 Set/get isosurface contour value. More...
 
virtual double GetValue ()
 
virtual void SetLimitsFileName (const char *)
 Specify file name of marching cubes limits file. More...
 
virtual char * GetLimitsFileName ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkSliceCubesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSliceCubesSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkVolumeReaderReader
 
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
 

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
Tests:
vtkSliceCubes (Tests)

Definition at line 60 of file vtkSliceCubes.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 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 68 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

◆ SetFileName()

virtual void vtkSliceCubes::SetFileName ( const char *  )
virtual

Specify file name of marching cubes output file.

◆ GetFileName()

virtual char* vtkSliceCubes::GetFileName ( )
virtual

◆ SetValue()

virtual void vtkSliceCubes::SetValue ( double  )
virtual

Set/get isosurface contour value.

◆ GetValue()

virtual double vtkSliceCubes::GetValue ( )
virtual

◆ SetLimitsFileName()

virtual void vtkSliceCubes::SetLimitsFileName ( const char *  )
virtual

Specify file name of marching cubes limits file.

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

◆ GetLimitsFileName()

virtual char* vtkSliceCubes::GetLimitsFileName ( )
virtual

◆ Execute()

void vtkSliceCubes::Execute ( )
protected

Member Data Documentation

◆ Reader

vtkVolumeReader* vtkSliceCubes::Reader
protected

Definition at line 110 of file vtkSliceCubes.h.

◆ FileName

char* vtkSliceCubes::FileName
protected

Definition at line 111 of file vtkSliceCubes.h.

◆ Value

double vtkSliceCubes::Value
protected

Definition at line 112 of file vtkSliceCubes.h.

◆ LimitsFileName

char* vtkSliceCubes::LimitsFileName
protected

Definition at line 113 of file vtkSliceCubes.h.


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