VTK  9.0.20200802
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkImageSliceMapper Class Reference

map a slice of a vtkImageData to the screen More...

#include <vtkImageSliceMapper.h>

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

Public Types

typedef vtkImageMapper3D Superclass
 
- Public Types inherited from vtkImageMapper3D
typedef vtkAbstractMapper3D Superclass
 
- Public Types inherited from vtkAbstractMapper3D
typedef vtkAbstractMapper Superclass
 
- Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
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...
 
vtkImageSliceMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetSliceNumber (int slice)
 The slice to display, if there are multiple slices. More...
 
virtual int GetSliceNumber ()
 
virtual int GetSliceNumberMinValue ()
 Use GetSliceNumberMinValue() and GetSliceNumberMaxValue() to get the range of allowed slices. More...
 
virtual int GetSliceNumberMaxValue ()
 
virtual void SetOrientation (int)
 Set the orientation of the slices to display. More...
 
virtual int GetOrientation ()
 
void SetOrientationToI ()
 
void SetOrientationToJ ()
 
void SetOrientationToK ()
 
void SetOrientationToX ()
 
void SetOrientationToY ()
 
void SetOrientationToZ ()
 
virtual void SetCropping (vtkTypeBool)
 Use the specified CroppingRegion. More...
 
virtual void CroppingOn ()
 
virtual void CroppingOff ()
 
virtual vtkTypeBool GetCropping ()
 
virtual void SetCroppingRegion (int, int, int, int, int, int)
 Set the display extent. More...
 
virtual void SetCroppingRegion (int[6])
 
virtual int * GetCroppingRegion ()
 
virtual void GetCroppingRegion (int &, int &, int &, int &, int &, int &)
 
virtual void GetCroppingRegion (int[6])
 
void Render (vtkRenderer *renderer, vtkImageSlice *prop) override
 This should only be called by the renderer. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this mapper. More...
 
vtkMTimeType GetMTime () override
 Get the mtime for the mapper. More...
 
double * GetBounds () override
 The bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6]) override
 Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void GetIndexBounds (double extent[6]) override
 
void GetSlicePlaneInDataCoords (vtkMatrix4x4 *propMatrix, double plane[4]) override
 Get the plane as a homogeneous 4-vector that gives the plane equation coefficients. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
 Handle requests from the pipeline executive. More...
 
- Public Member Functions inherited from vtkImageMapper3D
vtkImageMapper3DNewInstance () const
 
void SetInputData (vtkImageData *input)
 The input data for this mapper. More...
 
vtkImageDataGetInput ()
 
vtkDataSetGetDataSetInput ()
 
vtkDataObjectGetDataObjectInput ()
 
virtual void SetBorder (vtkTypeBool)
 Instead of displaying the image only out to the image bounds, include a half-voxel border around the image. More...
 
virtual void BorderOn ()
 
virtual void BorderOff ()
 
virtual vtkTypeBool GetBorder ()
 
virtual void SetBackground (vtkTypeBool)
 Instead of rendering only to the image border, render out to the viewport boundary with the background color. More...
 
virtual void BackgroundOn ()
 
virtual void BackgroundOff ()
 
virtual vtkTypeBool GetBackground ()
 
virtual void SetSliceAtFocalPoint (vtkTypeBool)
 Automatically set the slice position to the camera focal point. More...
 
virtual void SliceAtFocalPointOn ()
 
virtual void SliceAtFocalPointOff ()
 
virtual vtkTypeBool GetSliceAtFocalPoint ()
 
virtual void SetSliceFacesCamera (vtkTypeBool)
 Automatically set the slice orientation so that it faces the camera. More...
 
virtual void SliceFacesCameraOn ()
 
virtual void SliceFacesCameraOff ()
 
virtual vtkTypeBool GetSliceFacesCamera ()
 
virtual vtkPlaneGetSlicePlane ()
 A plane that describes what slice of the input is being rendered by the mapper. More...
 
virtual void SetNumberOfThreads (int)
 The number of threads to create when rendering. More...
 
virtual int GetNumberOfThreads ()
 
virtual void SetStreaming (vtkTypeBool)
 Turn on streaming, to pull the minimum amount of data from the input. More...
 
virtual vtkTypeBool GetStreaming ()
 
virtual void StreamingOn ()
 
virtual void StreamingOff ()
 
- Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3DNewInstance () const
 
double * GetCenter ()
 Return the Center of this mapper's data. More...
 
void GetCenter (double center[3])
 
double GetLength ()
 Return the diagonal length of this mappers bounding box. More...
 
virtual vtkTypeBool IsARayCastMapper ()
 Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper. More...
 
virtual vtkTypeBool IsARenderIntoImageMapper ()
 Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer. More...
 
void GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
 Get the ith clipping plane as a homogeneous plane equation. More...
 
- Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapperNewInstance () const
 
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered. More...
 
void AddClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
 
void RemoveClippingPlane (vtkPlane *plane)
 
void RemoveAllClippingPlanes ()
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
void SetClippingPlanes (vtkPlanes *planes)
 An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes. More...
 
virtual void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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 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). 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)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkImageSliceMapperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageSliceMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageMapper3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageMapper3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapper3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapperSafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars. More...
 
static vtkAbstractArrayGetAbstractScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars as an abstract array. More...
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageSliceMapper ()
 
 ~vtkImageSliceMapper () override
 
void SetPoints (vtkPoints *points)
 Set points that describe a polygon on which the slice will be rendered. More...
 
vtkPointsGetPoints ()
 
void SetExactPixelMatch (int v)
 Force linear interpolation. More...
 
void SetPassColorData (int v)
 Pass color data. More...
 
void SetDisplayExtent (const int extent[6])
 Set the display extent. More...
 
int GetOrientationFromCamera (double const *propMatrix, vtkCamera *camera)
 Get the camera orientation as a simple integer [0,1,2,3,4,5] that indicates one of the six major directions. More...
 
int GetSliceFromCamera (double const *propMatrix, vtkCamera *camera)
 Get the current slice as the one closest to the focal point. More...
 
- Protected Member Functions inherited from vtkImageMapper3D
 vtkImageMapper3D ()
 
 ~vtkImageMapper3D () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 See algorithm for more info. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
unsigned char * MakeTextureData (vtkImageProperty *property, vtkImageData *input, int extent[6], int &xsize, int &ysize, int &bytesPerPixel, bool &reuseTexture, bool &reuseData)
 Perform window/level and color mapping operations to produce unsigned char data that can be used as a texture. More...
 
void MakeTextureGeometry (const int extent[6], double coords[12], double tcoords[8])
 Compute the coordinates and texture coordinates for the image, given an extent that describes a single slice. More...
 
virtual void ComputeTextureSize (const int extent[6], int &xdim, int &ydim, int imageSize[2], int textureSize[2])
 Given an extent that describes a slice (it must have unit thickness in one of the three directions), return the dimension indices that correspond to the texture "x" and "y", provide the x, y image size, and provide the texture size (padded to a power of two if the hardware requires). More...
 
vtkRendererGetCurrentRenderer ()
 Get the renderer associated with this mapper, or zero if none. More...
 
vtkImageSliceGetCurrentProp ()
 Get the vtkImage prop associated with this mapper, or zero if none. More...
 
vtkMatrix4x4GetDataToWorldMatrix ()
 Get the data-to-world matrix for this mapper, according to the assembly path for its prop. More...
 
void GetBackgroundColor (vtkImageProperty *property, double color[4])
 Get the background color, by using the first color in the supplied lookup table, or black if there is no lookup table. More...
 
- Protected Member Functions inherited from vtkAbstractMapper3D
 vtkAbstractMapper3D ()
 
 ~vtkAbstractMapper3D () override=default
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void GetDimensionIndices (int orientation, int &xdim, int &ydim)
 Get the dimension indices according to the orientation. More...
 
- Static Protected Member Functions inherited from vtkImageMapper3D
static void CheckerboardRGBA (unsigned char *data, int xsize, int ysize, double originx, double originy, double spacingx, double spacingy)
 Checkerboard the alpha component of an RGBA image. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

int SliceNumber
 
int SliceNumberMinValue
 
int SliceNumberMaxValue
 
int Orientation
 
vtkTypeBool Cropping
 
int CroppingRegion [6]
 
int DisplayExtent [6]
 
int ExactPixelMatch
 
int PassColorData
 
vtkPointsPoints
 
- Protected Attributes inherited from vtkImageMapper3D
vtkTypeBool Border
 
vtkTypeBool Background
 
vtkScalarsToColorsDefaultLookupTable
 
vtkMultiThreaderThreader
 
int NumberOfThreads
 
vtkTypeBool Streaming
 
vtkPlaneSlicePlane
 
vtkTypeBool SliceAtFocalPoint
 
vtkTypeBool SliceFacesCamera
 
double DataSpacing [3]
 
double DataOrigin [3]
 
double DataDirection [9]
 
int DataWholeExtent [6]
 
bool MatteEnable
 
bool ColorEnable
 
bool DepthEnable
 
- Protected Attributes inherited from vtkAbstractMapper3D
double Bounds [6]
 
double Center [3]
 
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkImageResliceMapper
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

map a slice of a vtkImageData to the screen

vtkImageSliceMapper is a mapper that will draw a 2D image, or a slice of a 3D image. For 3D images, the slice may be oriented in the X, Y, or Z direction. This mapper works via 2D textures with accelerated zoom and pan operations.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
See also
vtkImageSlice vtkImageProperty vtkImageResliceMapper

Definition at line 39 of file vtkImageSliceMapper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkImageSliceMapper.h.

Constructor & Destructor Documentation

◆ vtkImageSliceMapper()

vtkImageSliceMapper::vtkImageSliceMapper ( )
protected

◆ ~vtkImageSliceMapper()

vtkImageSliceMapper::~vtkImageSliceMapper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageSliceMapper* vtkImageSliceMapper::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImageSliceMapper::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 vtkImageMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageSliceMapper::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper.

◆ NewInstance()

vtkImageSliceMapper* vtkImageSliceMapper::NewInstance ( ) const

◆ PrintSelf()

void vtkImageSliceMapper::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 vtkImageMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper.

◆ SetSliceNumber()

virtual void vtkImageSliceMapper::SetSliceNumber ( int  slice)
virtual

The slice to display, if there are multiple slices.

◆ GetSliceNumber()

virtual int vtkImageSliceMapper::GetSliceNumber ( )
virtual

◆ GetSliceNumberMinValue()

virtual int vtkImageSliceMapper::GetSliceNumberMinValue ( )
virtual

Use GetSliceNumberMinValue() and GetSliceNumberMaxValue() to get the range of allowed slices.

These methods call UpdateInformation as a side-effect.

◆ GetSliceNumberMaxValue()

virtual int vtkImageSliceMapper::GetSliceNumberMaxValue ( )
virtual

◆ SetOrientation()

virtual void vtkImageSliceMapper::SetOrientation ( int  )
virtual

Set the orientation of the slices to display.

The default orientation is 2, which is K. Not the orientaiton here is in index space. Not physical or world.

◆ GetOrientation()

virtual int vtkImageSliceMapper::GetOrientation ( )
virtual

◆ SetOrientationToI()

void vtkImageSliceMapper::SetOrientationToI ( )
inline

Definition at line 72 of file vtkImageSliceMapper.h.

◆ SetOrientationToJ()

void vtkImageSliceMapper::SetOrientationToJ ( )
inline

Definition at line 73 of file vtkImageSliceMapper.h.

◆ SetOrientationToK()

void vtkImageSliceMapper::SetOrientationToK ( )
inline

Definition at line 74 of file vtkImageSliceMapper.h.

◆ SetOrientationToX()

void vtkImageSliceMapper::SetOrientationToX ( )
inline

Definition at line 76 of file vtkImageSliceMapper.h.

◆ SetOrientationToY()

void vtkImageSliceMapper::SetOrientationToY ( )
inline

Definition at line 77 of file vtkImageSliceMapper.h.

◆ SetOrientationToZ()

void vtkImageSliceMapper::SetOrientationToZ ( )
inline

Definition at line 78 of file vtkImageSliceMapper.h.

◆ SetCropping()

virtual void vtkImageSliceMapper::SetCropping ( vtkTypeBool  )
virtual

Use the specified CroppingRegion.

The default is to display the full slice.

◆ CroppingOn()

virtual void vtkImageSliceMapper::CroppingOn ( )
virtual

◆ CroppingOff()

virtual void vtkImageSliceMapper::CroppingOff ( )
virtual

◆ GetCropping()

virtual vtkTypeBool vtkImageSliceMapper::GetCropping ( )
virtual

◆ SetCroppingRegion() [1/2]

virtual void vtkImageSliceMapper::SetCroppingRegion ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Set the display extent.

This is ignored unless Cropping is set.

◆ SetCroppingRegion() [2/2]

virtual void vtkImageSliceMapper::SetCroppingRegion ( int  [6])
virtual

◆ GetCroppingRegion() [1/3]

virtual int* vtkImageSliceMapper::GetCroppingRegion ( )
virtual

◆ GetCroppingRegion() [2/3]

virtual void vtkImageSliceMapper::GetCroppingRegion ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

◆ GetCroppingRegion() [3/3]

virtual void vtkImageSliceMapper::GetCroppingRegion ( int  [6])
virtual

◆ Render()

void vtkImageSliceMapper::Render ( vtkRenderer renderer,
vtkImageSlice prop 
)
overridevirtual

This should only be called by the renderer.

Implements vtkImageMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper.

◆ ReleaseGraphicsResources()

void vtkImageSliceMapper::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Release any graphics resources that are being consumed by this mapper.

The parameter window is used to determine which graphic resources to release.

Implements vtkImageMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper.

◆ GetMTime()

vtkMTimeType vtkImageSliceMapper::GetMTime ( )
overridevirtual

Get the mtime for the mapper.

Reimplemented from vtkAbstractMapper.

◆ GetBounds() [1/2]

double* vtkImageSliceMapper::GetBounds ( )
overridevirtual

The bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Implements vtkAbstractMapper3D.

◆ GetBounds() [2/2]

void vtkImageSliceMapper::GetBounds ( double  bounds[6])
inlineoverridevirtual

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Reimplemented from vtkAbstractMapper3D.

Definition at line 123 of file vtkImageSliceMapper.h.

◆ GetIndexBounds()

void vtkImageSliceMapper::GetIndexBounds ( double  extent[6])
overridevirtual

Implements vtkImageMapper3D.

◆ GetSlicePlaneInDataCoords()

void vtkImageSliceMapper::GetSlicePlaneInDataCoords ( vtkMatrix4x4 propMatrix,
double  plane[4] 
)
overridevirtual

Get the plane as a homogeneous 4-vector that gives the plane equation coefficients.

It is computed from the Orientation and SliceNumber, the propMatrix is unused and can be zero.

Reimplemented from vtkImageMapper3D.

◆ ProcessRequest()

vtkTypeBool vtkImageSliceMapper::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
overridevirtual

Handle requests from the pipeline executive.

Reimplemented from vtkImageMapper3D.

◆ SetPoints()

void vtkImageSliceMapper::SetPoints ( vtkPoints points)
protected

Set points that describe a polygon on which the slice will be rendered.

◆ GetPoints()

vtkPoints* vtkImageSliceMapper::GetPoints ( )
inlineprotected

Definition at line 151 of file vtkImageSliceMapper.h.

◆ SetExactPixelMatch()

void vtkImageSliceMapper::SetExactPixelMatch ( int  v)
inlineprotected

Force linear interpolation.

Internal method, for when this mapper is used as a helper class.

Definition at line 157 of file vtkImageSliceMapper.h.

◆ SetPassColorData()

void vtkImageSliceMapper::SetPassColorData ( int  v)
inlineprotected

Pass color data.

Internal method, for when this mapper is used as a helper class.

Definition at line 163 of file vtkImageSliceMapper.h.

◆ SetDisplayExtent()

void vtkImageSliceMapper::SetDisplayExtent ( const int  extent[6])
inlineprotected

Set the display extent.

Internal method, for when this mapper is used as a helper class.

Definition at line 170 of file vtkImageSliceMapper.h.

◆ GetOrientationFromCamera()

int vtkImageSliceMapper::GetOrientationFromCamera ( double const *  propMatrix,
vtkCamera camera 
)
protected

Get the camera orientation as a simple integer [0,1,2,3,4,5] that indicates one of the six major directions.

The integers 0,1,2 are x,y,z and 3,4,5 are -x,-y,-z.

◆ GetSliceFromCamera()

int vtkImageSliceMapper::GetSliceFromCamera ( double const *  propMatrix,
vtkCamera camera 
)
protected

Get the current slice as the one closest to the focal point.

◆ GetDimensionIndices()

static void vtkImageSliceMapper::GetDimensionIndices ( int  orientation,
int &  xdim,
int &  ydim 
)
staticprotected

Get the dimension indices according to the orientation.

Friends And Related Function Documentation

◆ vtkImageResliceMapper

friend class vtkImageResliceMapper
friend

Definition at line 213 of file vtkImageSliceMapper.h.

Member Data Documentation

◆ SliceNumber

int vtkImageSliceMapper::SliceNumber
protected

Definition at line 198 of file vtkImageSliceMapper.h.

◆ SliceNumberMinValue

int vtkImageSliceMapper::SliceNumberMinValue
protected

Definition at line 199 of file vtkImageSliceMapper.h.

◆ SliceNumberMaxValue

int vtkImageSliceMapper::SliceNumberMaxValue
protected

Definition at line 200 of file vtkImageSliceMapper.h.

◆ Orientation

int vtkImageSliceMapper::Orientation
protected

Definition at line 201 of file vtkImageSliceMapper.h.

◆ Cropping

vtkTypeBool vtkImageSliceMapper::Cropping
protected

Definition at line 202 of file vtkImageSliceMapper.h.

◆ CroppingRegion

int vtkImageSliceMapper::CroppingRegion[6]
protected

Definition at line 203 of file vtkImageSliceMapper.h.

◆ DisplayExtent

int vtkImageSliceMapper::DisplayExtent[6]
protected

Definition at line 204 of file vtkImageSliceMapper.h.

◆ ExactPixelMatch

int vtkImageSliceMapper::ExactPixelMatch
protected

Definition at line 205 of file vtkImageSliceMapper.h.

◆ PassColorData

int vtkImageSliceMapper::PassColorData
protected

Definition at line 206 of file vtkImageSliceMapper.h.

◆ Points

vtkPoints* vtkImageSliceMapper::Points
protected

Definition at line 207 of file vtkImageSliceMapper.h.


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