vv/vvBinaryImageOverlayActor.cxx

   1 /*=========================================================================
   2   Program:   vv                     http://www.creatis.insa-lyon.fr/rio/vv
   3
   4   Authors belong to:
   5   - University of LYON              http://www.universite-lyon.fr/
   6   - Léon Bérard cancer center       http://www.centreleonberard.fr
   7   - CREATIS CNRS laboratory         http://www.creatis.insa-lyon.fr
   8
   9   This software is distributed WITHOUT ANY WARRANTY; without even
  10   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  11   PURPOSE.  See the copyright notices for more information.
  12
  13   It is distributed under dual licence
  14
  15   - BSD        See included LICENSE.txt file
  16   - CeCILL-B   http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  17   ===========================================================================**/
  18
  19 #include "vvBinaryImageOverlayActor.h"
  20 #include "vvImage.h"
  21 #include <vtkVersion.h>
  22 #include <vtkStreamingDemandDrivenPipeline.h>
  23 #include <vtkInformation.h>
  24 #include <vtkImageActor.h>
  25 #include <vtkCamera.h>
  26 #include <vtkRenderer.h>
  27 #include <vtkMarchingSquares.h>
  28 #include <vtkImageClip.h>
  29 #include <vtkImageData.h>
  30 #include <vtkPolyDataMapper.h>
  31 #include <vtkProperty.h>
  32 #include <vtkImageMapToRGBA.h>
  33 #include <vtkLookupTable.h>
  34 #include <vtkImageMapper3D.h>
  35
  36 //------------------------------------------------------------------------------
  37 vvBinaryImageOverlayActor::vvBinaryImageOverlayActor()
  38 {
  39   mTSlice = -1;
  40   mSlice = 0;
  41   mColor.resize(3);
  42   mAlpha = 0.6;
  43   mImage = 0;
  44   mSlicer = 0;
  45   mColorLUT = vtkSmartPointer<vtkLookupTable>::New();
  46   mForegroundValue = 1;
  47   mBackgroundValue = 0;
  48   m_modeBG = true;
  49   mDepth = 1.0;
  50 }
  51 //------------------------------------------------------------------------------
  52
  53
  54 //------------------------------------------------------------------------------
  55 vvBinaryImageOverlayActor::~vvBinaryImageOverlayActor()
  56 {
  57   mImageActorList.clear();
  58 }
  59 //------------------------------------------------------------------------------
  60
  61
  62 //------------------------------------------------------------------------------
  63 void vvBinaryImageOverlayActor::RemoveActors()
  64 {
  65   for (unsigned int i = 0; i < mImageActorList.size(); i++) {
  66     if (mSlicer != 0) {
  67       if (mSlicer != NULL) {
  68         if (mSlicer->GetRenderer() != 0) {
  69           if (mImageActorList[i] != 0)  {
  70             mSlicer->GetRenderer()->RemoveActor(mImageActorList[i]);
  71           }
  72         }
  73       }
  74     }
  75   }
  76 }
  77 //------------------------------------------------------------------------------
  78
  79
  80 //------------------------------------------------------------------------------
  81 void vvBinaryImageOverlayActor::SetColor(double r, double g, double b)
  82 {
  83   mColor[0] = r;
  84   mColor[1] = g;
  85   mColor[2] = b;
  86 }
  87 //------------------------------------------------------------------------------
  88
  89
  90 //------------------------------------------------------------------------------
  91 void vvBinaryImageOverlayActor::SetSlicer(vvSlicer * slicer)
  92 {
  93   mSlicer = slicer;
  94 }
  95 //------------------------------------------------------------------------------
  96
  97
  98 //------------------------------------------------------------------------------
  99 void vvBinaryImageOverlayActor::Initialize(bool IsVisible)
 100 {
 101   if (!mSlicer) {
 102     std::cerr << "ERROR. Please use setSlicer before setSlicer in vvBinaryImageOverlayActor." << std::endl;
 103     exit(0);
 104   }
 105
 106   if (!mImage) {
 107     std::cerr << "ERROR. Please use setImage before setSlicer in vvBinaryImageOverlayActor." << std::endl;
 108     exit(0);
 109   }
 110   // Create an actor for each time slice
 111   for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 112     // how many intensity ?
 113
 114
 115
 116     if (!mFusionReslice) {
 117       mFusionReslice = vtkSmartPointer<vtkImageReslice>::New();
 118       mFusionReslice->SetInterpolationModeToLinear();
 119       mFusionReslice->AutoCropOutputOn();
 120       mFusionReslice->SetBackgroundColor(-1000,-1000,-1000,1);
 121     }
 122
 123     vtkSmartPointer<vtkTransform> mConcatenatedFusionTransform = vtkSmartPointer<vtkTransform>::New();
 124     mConcatenatedFusionTransform->Identity();
 125     mConcatenatedFusionTransform->Concatenate(mImage->GetTransform()[0]);
 126     mConcatenatedFusionTransform->Concatenate(mSlicer->GetSlicingTransform());
 127     mFusionReslice->SetResliceAxes(mConcatenatedFusionTransform->GetMatrix());
 128     if (mImage->IsTimeSequence()) {
 129 #if VTK_MAJOR_VERSION <= 5
 130     mFusionReslice->SetInput(0, mImage->GetVTKImages()[numImage]);
 131     mFusionReslice->UpdateInformation();
 132 #else
 133     mFusionReslice->SetInputData(0, mImage->GetVTKImages()[numImage]);
 134 #endif
 135     } else {
 136 #if VTK_MAJOR_VERSION <= 5
 137     mFusionReslice->SetInput(0, mImage->GetVTKImages()[0]);
 138     mFusionReslice->UpdateInformation();
 139 #else
 140     mFusionReslice->SetInputData(0, mImage->GetVTKImages()[0]);
 141 #endif
 142     }
 143     mFusionReslice->Update();
 144
 145
 146
 147     vtkSmartPointer<vtkImageMapToRGBA> mOverlayMapper = vtkSmartPointer<vtkImageMapToRGBA>::New();
 148 #if VTK_MAJOR_VERSION <= 5
 149     mOverlayMapper->SetInput(mFusionReslice->GetOutput());
 150 #else
 151     mOverlayMapper->SetInputConnection(mFusionReslice->GetOutputPort(0));
 152 #endif
 153
 154     double range[2];
 155     if (mImage->IsTimeSequence())
 156     {
 157         mImage->GetVTKImages()[numImage]->GetScalarRange(range);
 158     }
 159     else {
 160         mImage->GetVTKImages()[0]->GetScalarRange(range);
 161     }
 162     int n = range[1]-range[0]+1;
 163     mColorLUT->SetRange(range[0],range[1]);
 164     mColorLUT->SetNumberOfTableValues(n);
 165
 166     // Mode BG -> all is color except BG
 167     if (m_modeBG) {
 168       for(int i=0; i<n; i++) {
 169         mColorLUT->SetTableValue(i, mColor[0], mColor[1], mColor[2], mAlpha);
 170       }
 171       mColorLUT->SetTableValue(mBackgroundValue, 0, 0, 0, 0.0);
 172     }
 173     else {
 174       // Mode FG -> all is BG, except FG which is color
 175       for(int i=0; i<n; i++) {
 176         mColorLUT->SetTableValue(i, 0, 0, 0, 0.0);
 177       }
 178       mColorLUT->SetTableValue(mForegroundValue, mColor[0], mColor[1], mColor[2], mAlpha);
 179     }
 180
 181     mOverlayMapper->SetLookupTable(mColorLUT);
 182
 183     vtkSmartPointer<vtkImageActor> mOverlayActor = vtkSmartPointer<vtkImageActor>::New();
 184 #if VTK_MAJOR_VERSION <= 5
 185     mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 186 #else
 187     mOverlayActor->GetMapper()->SetInputConnection(mOverlayMapper->GetOutputPort());
 188 #endif
 189     mOverlayActor->SetPickable(0);
 190     mOverlayActor->SetVisibility(IsVisible);
 191     //mOverlayActor->SetOpacity(1.0);
 192
 193     // FIXME : by default overlay is not interpolated.
 194     // mOverlayActor->SetInterpolate(mSlicer->GetImageActor()->GetInterpolate());
 195     mOverlayActor->InterpolateOff();
 196
 197     mMapperList.push_back(mOverlayMapper);
 198     mImageActorList.push_back(mOverlayActor);
 199     mSlicer->GetRenderer()->AddActor(mImageActorList[numImage]);
 200   }
 201 }
 202 //------------------------------------------------------------------------------
 203
 204
 205 //------------------------------------------------------------------------------
 206 void vvBinaryImageOverlayActor::SetOpacity(double d)
 207 {
 208   mAlpha = d;
 209 }
 210 //------------------------------------------------------------------------------
 211
 212
 213 //------------------------------------------------------------------------------
 214 // void vvBinaryImageOverlayActor::UpdateOpacity(double d) {
 215 //   mAlpha = d;
 216 //   mColorLUT->SetTableValue(1, mColor[0], mColor[1], mColor[2], mAlpha); // FG
 217 //   for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 218 //     // how many intensity ?
 219 //     vtkImageMapToRGBA * mOverlayMapper = mMapperList[numImage];
 220 //     mOverlayMapper->SetLookupTable(mColorLUT);
 221
 222 //     vtkImageActor * mOverlayActor = mImageActorList[numImage];
 223 //     mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 224 //   }
 225 // }
 226 //------------------------------------------------------------------------------
 227
 228
 229 //------------------------------------------------------------------------------
 230 // void vvBinaryImageOverlayActor::SetColor(double r, double v, double b) {
 231 //   mColor[0] = r;
 232 //   mColor[1] = v;
 233 //   mColor[2] = b;
 234 //   // mColorLUT->SetTableValue(1, mColor[0], mColor[1], mColor[2], mAlpha); // FG
 235 //   // for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 236 //   //   // how many intensity ?
 237 //   //   vtkImageMapToRGBA * mOverlayMapper = mMapperList[numImage];
 238 //   //   mOverlayMapper->SetLookupTable(mColorLUT);
 239
 240 //   //   vtkImageActor * mOverlayActor = mImageActorList[numImage];
 241 //   //   mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 242 //   // }
 243 // }
 244 //------------------------------------------------------------------------------
 245
 246
 247 //------------------------------------------------------------------------------
 248 void vvBinaryImageOverlayActor::SetImage(vvImage::Pointer image, double bg, bool modeBG)
 249 {
 250   mImage = image;
 251   if (modeBG) {
 252     mBackgroundValue = bg;
 253     m_modeBG = true;
 254   }
 255   else {
 256     mForegroundValue = bg;
 257     m_modeBG = false;
 258   }
 259 }
 260 //------------------------------------------------------------------------------
 261
 262
 263 //------------------------------------------------------------------------------
 264 void vvBinaryImageOverlayActor::HideActors()
 265 {
 266   if (!mSlicer) return;
 267   mSlice = mSlicer->GetSlice();
 268   for(unsigned int i=0; i<mImageActorList.size(); i++) {
 269     mImageActorList[i]->VisibilityOff();
 270   }
 271   // Caller MUST call Render
 272   //  mSlicer->Render();
 273 }
 274 //------------------------------------------------------------------------------
 275
 276
 277 //------------------------------------------------------------------------------
 278 void vvBinaryImageOverlayActor::ShowActors()
 279 {
 280   if (!mSlicer) return;
 281   mSlice = mSlicer->GetSlice();
 282   mTSlice = mSlicer->GetTSlice();
 283   mImageActorList[mTSlice]->VisibilityOn();
 284   UpdateSlice(0, mSlice);
 285   // Caller MUST call Render
 286   //mSlicer->Render();
 287 }
 288 //------------------------------------------------------------------------------
 289
 290
 291 //------------------------------------------------------------------------------
 292 void vvBinaryImageOverlayActor::UpdateColor()
 293 {
 294   mColorLUT->SetTableValue(1, mColor[0], mColor[1], mColor[2], mAlpha); // FG
 295   for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 296     // how many intensity ?
 297     vtkImageMapToRGBA * mOverlayMapper = mMapperList[numImage];
 298     mOverlayMapper->SetLookupTable(mColorLUT);
 299
 300     vtkImageActor * mOverlayActor = mImageActorList[numImage];
 301 #if VTK_MAJOR_VERSION <= 5
 302     mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 303 #else
 304     mOverlayActor->SetInputData(mOverlayMapper->GetOutput());
 305 #endif
 306   }
 307 }
 308 //------------------------------------------------------------------------------
 309
 310 //------------------------------------------------------------------------------
 311 void vvBinaryImageOverlayActor::UpdateSlice(int slicer, int slice, bool force)
 312 {
 313   if (!mSlicer) return;
 314
 315   if (!force) {
 316     if (mPreviousSlice == mSlicer->GetSlice()) {
 317       if (mPreviousTSlice == mSlicer->GetTSlice()) {
 318         return; // Nothing to do
 319       }
 320     }
 321   }
 322
 323   // Get current slice
 324   mSlice = mSlicer->GetSlice();
 325   mTSlice = mSlicer->GetTSlice();
 326
 327   // Update extent
 328   int * imageExtent = mSlicer->GetExtent();
 329   int orientation = mSlicer->GetOrientation();
 330   int maskExtent[6];
 331   ComputeExtent(orientation, mSlice, imageExtent, maskExtent);
 332   ComputeExtent(maskExtent, maskExtent, mSlicer->GetImage()->GetVTKImages()[mTSlice], mImage->GetVTKImages()[mTSlice]);
 333 #if VTK_MAJOR_VERSION <= 5
 334   mSlicer->ClipDisplayedExtent(maskExtent, mMapperList[mTSlice]->GetInput()->GetWholeExtent());
 335 #else
 336   mSlicer->ClipDisplayedExtent(maskExtent, mMapperList[mTSlice]->GetInput()->GetInformation()->Get(vtkDataObject::DATA_EXTENT()));
 337 #endif
 338   HideActors();
 339   mImageActorList[mTSlice]->VisibilityOn();
 340   SetDisplayExtentAndCameraPosition(orientation, mSlice, maskExtent, mImageActorList[mTSlice], mDepth);
 341
 342   // set previous slice
 343   mPreviousTSlice = mSlicer->GetTSlice();
 344   mPreviousSlice  = mSlicer->GetSlice();
 345 }
 346 //------------------------------------------------------------------------------
 347
 348
 349 //------------------------------------------------------------------------------
 350 void vvBinaryImageOverlayActor::ComputeExtent(int orientation,
 351                                               int slice,
 352                                               int * inExtent,
 353                                               int * outExtent)
 354 {
 355   switch (orientation) {
 356   case vtkImageViewer2::SLICE_ORIENTATION_XY:
 357     for(int i=0; i<4; i++) outExtent[i] = inExtent[i];
 358     outExtent[4] = outExtent[5] = slice;
 359     break;
 360   case vtkImageViewer2::SLICE_ORIENTATION_XZ:
 361     for(int i=0; i<2; i++) outExtent[i] = inExtent[i];
 362     for(int i=4; i<6; i++) outExtent[i] = inExtent[i];
 363     outExtent[2] = outExtent[3] = slice;
 364     break;
 365   case vtkImageViewer2::SLICE_ORIENTATION_YZ:
 366     for(int i=2; i<6; i++) outExtent[i] = inExtent[i];
 367     outExtent[0] = outExtent[1] = slice;
 368     break;
 369   }
 370 }
 371 //------------------------------------------------------------------------------
 372
 373
 374 //----------------------------------------------------------------------------
 375 void vvBinaryImageOverlayActor::ComputeExtent(int * inExtent, int * outExtent, vtkImageData * image, vtkImageData * overlay)
 376 {
 377   for(int i=0; i<3; i++) {
 378     double a = (image->GetOrigin()[i] + inExtent[i*2]*image->GetSpacing()[i] -
 379                 overlay->GetOrigin()[i]) / overlay->GetSpacing()[i];
 380     double b = (image->GetOrigin()[i] + inExtent[i*2+1]*image->GetSpacing()[i] -
 381                 overlay->GetOrigin()[i]) / overlay->GetSpacing()[i];
 382     outExtent[i*2] = lrint(a);
 383     outExtent[i*2+1] = lrint(b);
 384   }
 385
 386   /* // FIXME (original)
 387   outExtent[0] = (int)lrint(((image->GetOrigin()[0] + inExtent[0]*image->GetSpacing()[0]) - overlay->GetOrigin()[0]) / overlay->GetSpacing()[0]);
 388   outExtent[1] = (int)lrint(((image->GetOrigin()[0] + inExtent[1]*image->GetSpacing()[0]) - overlay->GetOrigin()[0]) / overlay->GetSpacing()[0]);
 389   outExtent[2] = (int)lrint(((image->GetOrigin()[1] + inExtent[2]*image->GetSpacing()[1]) - overlay->GetOrigin()[1]) / overlay->GetSpacing()[1]);
 390   outExtent[3] = (int)lrint(((image->GetOrigin()[1] + inExtent[3]*image->GetSpacing()[1]) - overlay->GetOrigin()[1]) / overlay->GetSpacing()[1]);
 391   outExtent[4] = (int)lrint(((image->GetOrigin()[2] + inExtent[4]*image->GetSpacing()[2]) - overlay->GetOrigin()[2]) / overlay->GetSpacing()[2]);
 392   outExtent[5] = (int)lrint(((image->GetOrigin()[2] + inExtent[5]*image->GetSpacing()[2]) - overlay->GetOrigin()[2]) / overlay->GetSpacing()[2]);
 393   */
 394 }
 395 //----------------------------------------------------------------------------
 396
 397
 398 //------------------------------------------------------------------------------
 399 void vvBinaryImageOverlayActor::SetDisplayExtentAndCameraPosition(int orientation,
 400                                                                   int slice,
 401                                                                   int * extent,
 402                                                                   vtkImageActor * actor,
 403                                                                   double position)
 404 {
 405   /* FIXME
 406      Error according to camera orientation
 407    */
 408
 409   // Set position
 410   if (orientation == vtkImageViewer2::SLICE_ORIENTATION_XY) {
 411     //if (mSlicer->GetRenderer()->GetActiveCamera()->GetPosition()[2] > slice)
 412       actor->SetPosition(0,0, -position);
 413       //else
 414       //actor->SetPosition(0,0, position);
 415   }
 416   if (orientation == vtkImageViewer2::SLICE_ORIENTATION_XZ) {
 417     //if (mSlicer->GetRenderer()->GetActiveCamera()->GetPosition()[1] > slice)
 418     // actor->SetPosition(0,position,0);
 419     //else
 420       actor->SetPosition(0,-position,0);
 421   }
 422   if (orientation == vtkImageViewer2::SLICE_ORIENTATION_YZ) {
 423     //if (mSlicer->GetRenderer()->GetActiveCamera()->GetPosition()[0] > slice)
 424     //  actor->SetPosition(position,0, 0);
 425     //else
 426       actor->SetPosition(-position,0, 0);
 427   }
 428   actor->SetDisplayExtent(extent);
 429 }
 430 //------------------------------------------------------------------------------
 431