vtkMRMLVolumeNode.h

Go to the documentation of this file.

/*=auto=========================================================================

  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Program:   3D Slicer
  Module:    $RCSfile: vtkMRMLVolumeNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.13 $

=========================================================================auto=*/

#ifndef __vtkMRMLVolumeNode_h
#define __vtkMRMLVolumeNode_h

// MRML includes
#include "vtkMRMLDisplayableNode.h"
class vtkMRMLVolumeDisplayNode;

// VTK includes
class vtkAlgorithmOutput;
class vtkEventForwarderCommand;
class vtkImageData;
class vtkMatrix4x4;

// ITK includes
#include "itkMetaDataDictionary.h"

class VTK_MRML_EXPORT vtkMRMLVolumeNode : public vtkMRMLDisplayableNode
{
public:
  vtkTypeMacro(vtkMRMLVolumeNode,vtkMRMLDisplayableNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum
    {
    VoxelVectorTypeUndefined,
    VoxelVectorTypeSpatial,
    VoxelVectorTypeColorRGB,
    VoxelVectorTypeColorRGBA,
    VoxelVectorType_Last // must be last
    };

  vtkMRMLNode* CreateNodeInstance() override = 0;

  void ReadXMLAttributes( const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  vtkMRMLCopyContentMacro(vtkMRMLVolumeNode);

  void CopyOrientation(vtkMRMLVolumeNode *node);


  const char* GetNodeTagName() override = 0;

  void UpdateScene(vtkMRMLScene *scene) override;

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------

  static bool ComputeIJKToRASFromScanOrder(const char *order,
                                           const double* spacing,
                                           const int *dims,
                                           bool centerImage,
                                           vtkMatrix4x4 *IJKToRAS);

  static const char* ComputeScanOrderFromIJKToRAS(vtkMatrix4x4 *IJKToRAS);

  void SetIJKToRASDirections(double dirs[3][3]);
  void SetIJKToRASDirections(double ir, double ia, double is,
                             double jr, double ja, double js,
                             double kr, double ka, double ks);
  void SetIToRASDirection(double ir, double ia, double is);
  void SetJToRASDirection(double jr, double ja, double js);
  void SetKToRASDirection(double kr, double ka, double ks);

  void GetIJKToRASDirections(double dirs[3][3]);
  void GetIToRASDirection(double dirs[3]);
  void GetJToRASDirection(double dirs[3]);
  void GetKToRASDirection(double dirs[3]);

  vtkGetVector3Macro (Spacing, double);
  virtual void SetSpacing(double arg1, double arg2, double arg3);
  virtual void SetSpacing(double arg[3]);
  vtkGetVector3Macro (Origin, double);
  virtual void SetOrigin(double arg1, double arg2, double arg3);
  virtual void SetOrigin(double arg[3]);

  double GetMinSpacing();

  double GetMaxSpacing();

  void GetIJKToRASMatrix(vtkMatrix4x4* mat);
  void GetRASToIJKMatrix(vtkMatrix4x4* mat);

  void GetIJKToRASDirectionMatrix(vtkMatrix4x4* mat);
  void SetIJKToRASDirectionMatrix(vtkMatrix4x4* mat);

  void SetIJKToRASMatrix(vtkMatrix4x4* mat);
  void SetRASToIJKMatrix(vtkMatrix4x4* mat);

  void GetRASBounds(double bounds[6]) override;

  void GetBounds(double bounds[6]) override;

  void GetSliceBounds(double bounds[6], vtkMatrix4x4* rasToSlice, bool useVoxelCenter = false);

  virtual vtkMRMLVolumeDisplayNode* GetVolumeDisplayNode();

  virtual void SetAndObserveImageData(vtkImageData *ImageData);
  virtual vtkImageData* GetImageData();
  virtual void SetImageDataConnection(vtkAlgorithmOutput *inputPort);
  vtkGetObjectMacro(ImageDataConnection, vtkAlgorithmOutput);

  void ShiftImageDataExtentToZeroStart();

  void ProcessMRMLEvents ( vtkObject * /*caller*/,
                                   unsigned long /*event*/,
                                   void * /*callData*/ ) override;

  enum
    {
    ImageDataModifiedEvent = 18001
    };

  void SetMetaDataDictionary( const itk::MetaDataDictionary& );
  const itk::MetaDataDictionary& GetMetaDataDictionary() const;

  bool CanApplyNonLinearTransforms()const override;

  void ApplyTransform(vtkAbstractTransform* transform) override;

  void ApplyTransformMatrix(vtkMatrix4x4* transformMatrix) override;

  virtual void ApplyNonLinearTransform(vtkAbstractTransform* transform);

  bool GetModifiedSinceRead() override;

  virtual double GetImageBackgroundScalarComponentAsDouble(int component);

  void CreateDefaultSequenceDisplayNodes() override;

  bool IsCentered();

  bool AddCenteringTransform();

  vtkGetMacro(VoxelVectorType, int);
  vtkSetMacro(VoxelVectorType, int);

  static const char *GetVoxelVectorTypeAsString(int id);
  static int GetVoxelVectorTypeFromString(const char *name);

protected:
  vtkMRMLVolumeNode();
  ~vtkMRMLVolumeNode() override;
  vtkMRMLVolumeNode(const vtkMRMLVolumeNode&);
  void operator=(const vtkMRMLVolumeNode&);

  void SetImageDataToDisplayNodes();
  void SetImageDataToDisplayNode(vtkMRMLVolumeDisplayNode* displayNode);

  virtual void UpdateDisplayNodeImageData(vtkMRMLDisplayNode *dnode);

  void OnNodeReferenceAdded(vtkMRMLNodeReference *reference) override;

  void OnNodeReferenceModified(vtkMRMLNodeReference *reference) override;

  virtual void GetBoundsInternal(double bounds[6], vtkMatrix4x4* rasToSlice, bool useTransform, bool useVoxelCenter = false);

  void GetCenterPositionRAS(double* centerPositionRAS, bool useParentTransform=true);

  double IJKToRASDirections[3][3];

  double Spacing[3];
  double Origin[3];

  vtkAlgorithmOutput* ImageDataConnection;
  vtkEventForwarderCommand* DataEventForwarder;

  int VoxelVectorType;
  itk::MetaDataDictionary Dictionary;
};

#endif