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     mConcatenatedFusionTransform->Identity();
 124     mConcatenatedFusionTransform->Concatenate(mImage->GetTransform()[0]);
 125     mConcatenatedFusionTransform->Concatenate(mSlicer->GetSlicingTransform());
 126     mFusionReslice->SetResliceAxes(mConcatenatedFusionTransform->GetMatrix());
 127     if (mImage->IsTimeSequence()) {
 128 #if VTK_MAJOR_VERSION <= 5
 129     mFusionReslice->SetInput(0, mImage->GetVTKImages()[numImage]);
 130     mFusionReslice->UpdateInformation();
 131 #else
 132     mFusionReslice->SetInputData(0, mImage->GetVTKImages()[numImage]);
 133 #endif
 134     } else {
 135 #if VTK_MAJOR_VERSION <= 5
 136     mFusionReslice->SetInput(0, mImage->GetVTKImages()[0]);
 137     mFusionReslice->UpdateInformation();
 138 #else
 139     mFusionReslice->SetInputData(0, mImage->GetVTKImages()[0]);
 140 #endif
 141     }
 142     mFusionReslice->Update();
 143
 144
 145
 146     vtkSmartPointer<vtkImageMapToRGBA> mOverlayMapper = vtkSmartPointer<vtkImageMapToRGBA>::New();
 147 #if VTK_MAJOR_VERSION <= 5
 148     mOverlayMapper->SetInput(mFusionReslice->GetOutput());
 149 #else
 150     mOverlayMapper->SetInputConnection(mFusionReslice->GetOutputPort(0));
 151 #endif
 152
 153     double range[2];
 154     if (mImage->IsTimeSequence())
 155     {
 156         mImage->GetVTKImages()[numImage]->GetScalarRange(range);
 157     }
 158     else {
 159         mImage->GetVTKImages()[0]->GetScalarRange(range);
 160     }
 161     int n = range[1]-range[0]+1;
 162     mColorLUT->SetRange(range[0],range[1]);
 163     mColorLUT->SetNumberOfTableValues(n);
 164
 165     // Mode BG -> all is color except BG
 166     if (m_modeBG) {
 167       for(int i=0; i<n; i++) {
 168         mColorLUT->SetTableValue(i, mColor[0], mColor[1], mColor[2], mAlpha);
 169       }
 170       mColorLUT->SetTableValue(mBackgroundValue, 0, 0, 0, 0.0);
 171     }
 172     else {
 173       // Mode FG -> all is BG, except FG which is color
 174       for(int i=0; i<n; i++) {
 175         mColorLUT->SetTableValue(i, 0, 0, 0, 0.0);
 176       }
 177       mColorLUT->SetTableValue(mForegroundValue, mColor[0], mColor[1], mColor[2], mAlpha);
 178     }
 179
 180     mOverlayMapper->SetLookupTable(mColorLUT);
 181
 182     vtkSmartPointer<vtkImageActor> mOverlayActor = vtkSmartPointer<vtkImageActor>::New();
 183 #if VTK_MAJOR_VERSION <= 5
 184     mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 185 #else
 186     mOverlayActor->GetMapper()->SetInputConnection(mOverlayMapper->GetOutputPort());
 187 #endif
 188     mOverlayActor->SetPickable(0);
 189     mOverlayActor->SetVisibility(IsVisible);
 190     //mOverlayActor->SetOpacity(1.0);
 191
 192     // FIXME : by default overlay is not interpolated.
 193     // mOverlayActor->SetInterpolate(mSlicer->GetImageActor()->GetInterpolate());
 194     mOverlayActor->InterpolateOff();
 195
 196     mMapperList.push_back(mOverlayMapper);
 197     mImageActorList.push_back(mOverlayActor);
 198     mSlicer->GetRenderer()->AddActor(mImageActorList[numImage]);
 199   }
 200 }
 201 //------------------------------------------------------------------------------
 202
 203
 204 //------------------------------------------------------------------------------
 205 void vvBinaryImageOverlayActor::SetOpacity(double d)
 206 {
 207   mAlpha = d;
 208 }
 209 //------------------------------------------------------------------------------
 210
 211
 212 //------------------------------------------------------------------------------
 213 // void vvBinaryImageOverlayActor::UpdateOpacity(double d) {
 214 //   mAlpha = d;
 215 //   mColorLUT->SetTableValue(1, mColor[0], mColor[1], mColor[2], mAlpha); // FG
 216 //   for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 217 //     // how many intensity ?
 218 //     vtkImageMapToRGBA * mOverlayMapper = mMapperList[numImage];
 219 //     mOverlayMapper->SetLookupTable(mColorLUT);
 220
 221 //     vtkImageActor * mOverlayActor = mImageActorList[numImage];
 222 //     mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 223 //   }
 224 // }
 225 //------------------------------------------------------------------------------
 226
 227
 228 //------------------------------------------------------------------------------
 229 // void vvBinaryImageOverlayActor::SetColor(double r, double v, double b) {
 230 //   mColor[0] = r;
 231 //   mColor[1] = v;
 232 //   mColor[2] = b;
 233 //   // mColorLUT->SetTableValue(1, mColor[0], mColor[1], mColor[2], mAlpha); // FG
 234 //   // for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 235 //   //   // how many intensity ?
 236 //   //   vtkImageMapToRGBA * mOverlayMapper = mMapperList[numImage];
 237 //   //   mOverlayMapper->SetLookupTable(mColorLUT);
 238
 239 //   //   vtkImageActor * mOverlayActor = mImageActorList[numImage];
 240 //   //   mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 241 //   // }
 242 // }
 243 //------------------------------------------------------------------------------
 244
 245
 246 //------------------------------------------------------------------------------
 247 void vvBinaryImageOverlayActor::SetImage(vvImage::Pointer image, double bg, bool modeBG)
 248 {
 249   mImage = image;
 250   if (modeBG) {
 251     mBackgroundValue = bg;
 252     m_modeBG = true;
 253   }
 254   else {
 255     mForegroundValue = bg;
 256     m_modeBG = false;
 257   }
 258 }
 259 //------------------------------------------------------------------------------
 260
 261
 262 //------------------------------------------------------------------------------
 263 void vvBinaryImageOverlayActor::HideActors()
 264 {
 265   if (!mSlicer) return;
 266   mSlice = mSlicer->GetSlice();
 267   for(unsigned int i=0; i<mImageActorList.size(); i++) {
 268     mImageActorList[i]->VisibilityOff();
 269   }
 270   // Caller MUST call Render
 271   //  mSlicer->Render();
 272 }
 273 //------------------------------------------------------------------------------
 274
 275
 276 //------------------------------------------------------------------------------
 277 void vvBinaryImageOverlayActor::ShowActors()
 278 {
 279   if (!mSlicer) return;
 280   mSlice = mSlicer->GetSlice();
 281   mTSlice = mSlicer->GetTSlice();
 282   mImageActorList[mTSlice]->VisibilityOn();
 283   UpdateSlice(0, mSlice);
 284   // Caller MUST call Render
 285   //mSlicer->Render();
 286 }
 287 //------------------------------------------------------------------------------
 288
 289
 290 //------------------------------------------------------------------------------
 291 void vvBinaryImageOverlayActor::UpdateColor()
 292 {
 293   mColorLUT->SetTableValue(1, mColor[0], mColor[1], mColor[2], mAlpha); // FG
 294   for (unsigned int numImage = 0; numImage < mSlicer->GetImage()->GetVTKImages().size(); numImage++) {
 295     // how many intensity ?
 296     vtkImageMapToRGBA * mOverlayMapper = mMapperList[numImage];
 297     mOverlayMapper->SetLookupTable(mColorLUT);
 298
 299     vtkImageActor * mOverlayActor = mImageActorList[numImage];
 300 #if VTK_MAJOR_VERSION <= 5
 301     mOverlayActor->SetInput(mOverlayMapper->GetOutput());
 302 #else
 303     mOverlayActor->SetInputData(mOverlayMapper->GetOutput());
 304 #endif
 305   }
 306 }
 307 //------------------------------------------------------------------------------
 308
 309 //------------------------------------------------------------------------------
 310 void vvBinaryImageOverlayActor::UpdateSlice(int slicer, int slice, bool force)
 311 {
 312   if (!mSlicer) return;
 313
 314   if (!force) {
 315     if (mPreviousSlice == mSlicer->GetSlice()) {
 316       if (mPreviousTSlice == mSlicer->GetTSlice()) {
 317         return; // Nothing to do
 318       }
 319     }
 320   }
 321
 322   // Get current slice
 323   mSlice = mSlicer->GetSlice();
 324   mTSlice = mSlicer->GetTSlice();
 325
 326   // Update extent
 327   int * imageExtent = mSlicer->GetExtent();
 328   int orientation = mSlicer->GetOrientation();
 329   int maskExtent[6];
 330   ComputeExtent(orientation, mSlice, imageExtent, maskExtent);
 331   ComputeExtent(maskExtent, maskExtent, mSlicer->GetImage()->GetVTKImages()[mTSlice], mImage->GetVTKImages()[mTSlice]);
 332 #if VTK_MAJOR_VERSION <= 5
 333   mSlicer->ClipDisplayedExtent(maskExtent, mMapperList[mTSlice]->GetInput()->GetWholeExtent());
 334 #else
 335   mSlicer->ClipDisplayedExtent(maskExtent, mMapperList[mTSlice]->GetInput()->GetInformation()->Get(vtkDataObject::DATA_EXTENT()));
 336 #endif
 337   HideActors();
 338   mImageActorList[mTSlice]->VisibilityOn();
 339   SetDisplayExtentAndCameraPosition(orientation, mSlice, maskExtent, mImageActorList[mTSlice], mDepth);
 340
 341   // set previous slice
 342   mPreviousTSlice = mSlicer->GetTSlice();
 343   mPreviousSlice  = mSlicer->GetSlice();
 344 }
 345 //------------------------------------------------------------------------------
 346
 347
 348 //------------------------------------------------------------------------------
 349 void vvBinaryImageOverlayActor::ComputeExtent(int orientation,
 350                                               int slice,
 351                                               int * inExtent,
 352                                               int * outExtent)
 353 {
 354   switch (orientation) {
 355   case vtkImageViewer2::SLICE_ORIENTATION_XY:
 356     for(int i=0; i<4; i++) outExtent[i] = inExtent[i];
 357     outExtent[4] = outExtent[5] = slice;
 358     break;
 359   case vtkImageViewer2::SLICE_ORIENTATION_XZ:
 360     for(int i=0; i<2; i++) outExtent[i] = inExtent[i];
 361     for(int i=4; i<6; i++) outExtent[i] = inExtent[i];
 362     outExtent[2] = outExtent[3] = slice;
 363     break;
 364   case vtkImageViewer2::SLICE_ORIENTATION_YZ:
 365     for(int i=2; i<6; i++) outExtent[i] = inExtent[i];
 366     outExtent[0] = outExtent[1] = slice;
 367     break;
 368   }
 369 }
 370 //------------------------------------------------------------------------------
 371
 372
 373 //----------------------------------------------------------------------------
 374 void vvBinaryImageOverlayActor::ComputeExtent(int * inExtent, int * outExtent, vtkImageData * image, vtkImageData * overlay)
 375 {
 376   for(int i=0; i<3; i++) {
 377     double a = (image->GetOrigin()[i] + inExtent[i*2]*image->GetSpacing()[i] -
 378                 overlay->GetOrigin()[i]) / overlay->GetSpacing()[i];
 379     double b = (image->GetOrigin()[i] + inExtent[i*2+1]*image->GetSpacing()[i] -
 380                 overlay->GetOrigin()[i]) / overlay->GetSpacing()[i];
 381     outExtent[i*2] = lrint(a);
 382     outExtent[i*2+1] = lrint(b);
 383   }
 384
 385   /* // FIXME (original)
 386   outExtent[0] = (int)lrint(((image->GetOrigin()[0] + inExtent[0]*image->GetSpacing()[0]) - overlay->GetOrigin()[0]) / overlay->GetSpacing()[0]);
 387   outExtent[1] = (int)lrint(((image->GetOrigin()[0] + inExtent[1]*image->GetSpacing()[0]) - overlay->GetOrigin()[0]) / overlay->GetSpacing()[0]);
 388   outExtent[2] = (int)lrint(((image->GetOrigin()[1] + inExtent[2]*image->GetSpacing()[1]) - overlay->GetOrigin()[1]) / overlay->GetSpacing()[1]);
 389   outExtent[3] = (int)lrint(((image->GetOrigin()[1] + inExtent[3]*image->GetSpacing()[1]) - overlay->GetOrigin()[1]) / overlay->GetSpacing()[1]);
 390   outExtent[4] = (int)lrint(((image->GetOrigin()[2] + inExtent[4]*image->GetSpacing()[2]) - overlay->GetOrigin()[2]) / overlay->GetSpacing()[2]);
 391   outExtent[5] = (int)lrint(((image->GetOrigin()[2] + inExtent[5]*image->GetSpacing()[2]) - overlay->GetOrigin()[2]) / overlay->GetSpacing()[2]);
 392   */
 393 }
 394 //----------------------------------------------------------------------------
 395
 396
 397 //------------------------------------------------------------------------------
 398 void vvBinaryImageOverlayActor::SetDisplayExtentAndCameraPosition(int orientation,
 399                                                                   int slice,
 400                                                                   int * extent,
 401                                                                   vtkImageActor * actor,
 402                                                                   double position)
 403 {
 404   /* FIXME
 405      Error according to camera orientation
 406    */
 407
 408   // Set position
 409   if (orientation == vtkImageViewer2::SLICE_ORIENTATION_XY) {
 410     //if (mSlicer->GetRenderer()->GetActiveCamera()->GetPosition()[2] > slice)
 411       actor->SetPosition(0,0, -position);
 412       //else
 413       //actor->SetPosition(0,0, position);
 414   }
 415   if (orientation == vtkImageViewer2::SLICE_ORIENTATION_XZ) {
 416     //if (mSlicer->GetRenderer()->GetActiveCamera()->GetPosition()[1] > slice)
 417     // actor->SetPosition(0,position,0);
 418     //else
 419       actor->SetPosition(0,-position,0);
 420   }
 421   if (orientation == vtkImageViewer2::SLICE_ORIENTATION_YZ) {
 422     //if (mSlicer->GetRenderer()->GetActiveCamera()->GetPosition()[0] > slice)
 423     //  actor->SetPosition(position,0, 0);
 424     //else
 425       actor->SetPosition(-position,0, 0);
 426   }
 427   actor->SetDisplayExtent(extent);
 428 }
 429 //------------------------------------------------------------------------------
 430