2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
10 # This software is governed by the CeCILL-B license under French law and
11 # abiding by the rules of distribution of free software. You can use,
12 # modify and/ or redistribute the software under the terms of the CeCILL-B
13 # license as circulated by CEA, CNRS and INRIA at the following URL
14 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15 # or in the file LICENSE.txt.
17 # As a counterpart to the access to the source code and rights to copy,
18 # modify and redistribute granted by the license, users are provided only
19 # with a limited warranty and the software's author, the holder of the
20 # economic rights, and the successive licensors have only limited
23 # The fact that you are presently reading this means that you have had
24 # knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------ */
28 /*=========================================================================
30 Module: $RCSfile: bbvtkImagePlanes.cxx,v $
32 Date: $Date: 2012/11/16 08:51:58 $
33 Version: $Revision: 1.38 $
34 =========================================================================*/
42 #include "bbvtkImagePlanes.h"
43 #include "bbvtkPackage.h"
44 #include "vtkCellPicker.h"
45 #include "vtkProperty.h"
46 #include "vtkPolyData.h"
49 #include "vtkMetaImageWriter.h"
50 #include "vtkPNGWriter.h"
52 #include "bbstdCast.h"
53 #include <vtkCommand.h>
55 #include "vtkImageData.h"
56 //#include "vtkOutlineFilter.h"
57 //#include "vtkPolyDataMapper.h"
58 //#include "vtkActor.h"
59 #include "vtkImagePlaneWidget.h"
60 #include "vtkCellPicker.h"
61 //#include "vtkProperty.h"
63 //#include "vtkRenderer.h"
64 //#include "vtkCamera.h"
66 #include "vtkPlaneWidget.h"
68 #include <vtkImplicitPlaneWidget.h>
70 #include "bbstdRelay.h"
72 #include "vtkObjectFactory.h"
73 #include "vtkImageFlip.h"
75 #include "vtkImageReslice.h"
76 #include "vtkImageChangeInformation.h"
81 //====================================================================
82 BBTK_BLACK_BOX_TEMPLATE2_IMPLEMENTATION(Cast,
83 bbtk::AtomicBlackBox);
84 //====================================================================
85 //====================================================================
86 // BBTK_BLACK_BOX_TEMPLATE_IMPLEMENTATION(Relay,
87 // bbtk::AtomicBlackBox);
88 //====================================================================
91 using namespace bbstd;
95 typedef vtkImageData::Pointer vtkImageDataPointer;
96 BBTK_DEFINE_HUMAN_READABLE_TYPE_NAME(vtkImageDataPointer,
97 "vtkImageDataPointer");
103 //====================================================================
104 // Add the specialized adaptors to the package
105 typedef vtkImagePlaneWidget* I;
106 typedef vtkInteractorObserver* O;
108 BBTK_ADD_TEMPLATE2_BLACK_BOX_TO_PACKAGE(vtk,Cast,I,O);
110 BBTK_DEFINE_RELAY_BLACK_BOX(vtkImageDataPointer,vtk,vtkImageDataPointerRelay);
111 BBTK_BLACK_BOX_IMPLEMENTATION(vtkImageDataPointerRelay,bbtk::AtomicBlackBox);
113 BBTK_ADD_BLACK_BOX_TO_PACKAGE(vtk,vtkImageDataPointerRelay);
114 // BBTK_ADD_TEMPLATE_BLACK_BOX_TO_PACKAGE(vtk,Relay,vtkImageDataPointer);
122 //================================================================
123 class ImagePlanes::VtkCallbackType : public vtkCommand
126 static VtkCallbackType *New()
128 return new VtkCallbackType;
130 //vtkTypeRevisionMacro(VtkCallbackType,vtkCommand);
132 virtual void Execute(vtkObject *caller, unsigned long, void*)
134 mBlackBox->Process();
135 mBlackBox->bbSignalOutputModification();
137 void SetBlackBox(ImagePlanes *BB) { mBlackBox = BB;};
138 // void SetVtkPlaneWidget( vtkImagePlaneWidget *planeWidget );
139 VtkCallbackType() {};
142 // vtkPlaneWidget *planeWidget;
143 ImagePlanes *mBlackBox;
145 //================================================================
147 //vtkCxxRevisionMacro(ImagePlanes::VtkCallbackType, "$Revision: 1.38 $");
149 //================================================================
151 BBTK_ADD_BLACK_BOX_TO_PACKAGE(vtk,ImagePlanes)
152 BBTK_BLACK_BOX_IMPLEMENTATION(ImagePlanes,bbtk::AtomicBlackBox);
154 void ImagePlanes::bbUserSetDefaultValues()
156 bbSetOutputPlaneX(0);
157 bbSetOutputPlaneY(0);
158 bbSetOutputPlaneZ(0);
159 bbSetOutputImageX(0);
160 bbSetOutputImageY(0);
161 bbSetOutputImageZ(0);
163 std::vector<double> vect;
166 bbSetInputWindowLevel (vect);
169 std::vector<int> vectpoints;
171 bbSetOutputPlane3Pts(0);
172 bbSetOutputImage3Pts(0);
173 bbSetInputPointsX(vectpoints);
174 bbSetInputPointsY(vectpoints);
175 bbSetInputPointsZ(vectpoints);
177 _imageReslicer = NULL;
182 bbSetInputInterpolation(1);
186 void ImagePlanes::bbUserInitializeProcessing()
188 /// CREATION DES WIDGETS
189 if (bbGetOutputPlaneX() != 0) return;
191 // The shared picker enables us to use 3 planes at one time
192 // and gets the picking order right
193 vtkCellPicker* picker = vtkCellPicker::New();
194 picker->SetTolerance(0.005);
196 // The 3 image plane widgets
197 vtkImagePlaneWidget* planeWidgetX = GetPlaneWidget('x', 1, 0, 0, picker);
198 vtkImagePlaneWidget* planeWidgetY = GetPlaneWidget('y', 1, 1, 0, picker);
199 planeWidgetY->SetLookupTable(planeWidgetX->GetLookupTable());
201 vtkImagePlaneWidget* planeWidgetZ = GetPlaneWidget('z', 0, 0, 1, picker);
202 planeWidgetZ->SetLookupTable(planeWidgetX->GetLookupTable());
204 vtkImagePlaneWidget* planeWidget3Pts = GetPlaneWidget('3', 0, 1, 1, picker);
205 planeWidget3Pts->SetLookupTable(planeWidgetX->GetLookupTable());
207 // EED MPR view orientation correction..
208 vtkImageFlip *flipYFilter = vtkImageFlip::New();
209 flipYFilter->SetFilteredAxis(1); // flip y axis
211 //EED 2017-01-01 Migration VTK7
212 #if (VTK_MAJOR_VERSION <= 5)
213 flipYFilter->SetInput( planeWidgetX->GetResliceOutput() );
215 #if (VTK_MAJOR_VERSION >= 6)
216 flipYFilter->SetInputData( planeWidgetX->GetResliceOutput() );
219 flipYFilter->Update();
221 vtkImageChangeInformation *image = vtkImageChangeInformation::New();
223 //EED 2017-01-01 Migration VTK7
224 #if (VTK_MAJOR_VERSION <= 5)
225 image->SetInput( planeWidgetY->GetResliceOutput() );
227 #if (VTK_MAJOR_VERSION >= 6)
228 image->SetInputData( planeWidgetY->GetResliceOutput() );
231 image->SetOutputSpacing( 1,1,1 );
232 image->CenterImageOn();
234 _imageTransform = vtkTransform::New();
235 vtkImageReslice *slicer =vtkImageReslice::New();
237 //EED 2017-01-01 Migration VTK7
238 #if (VTK_MAJOR_VERSION <= 5)
239 slicer->SetInput( image->GetOutput() );
241 #if (VTK_MAJOR_VERSION >= 6)
242 slicer->SetInputData( image->GetOutput() );
245 slicer->SetInformationInput( image->GetOutput() );
246 slicer->SetResliceTransform( _imageTransform );
247 slicer->SetOutputOrigin(0 , 0 , 0 );
248 slicer->SetInterpolationModeToNearestNeighbor();
250 vtkImageChangeInformation *imageResult = vtkImageChangeInformation::New();
252 //EED 2017-01-01 Migration VTK7
253 #if (VTK_MAJOR_VERSION <= 5)
254 imageResult->SetInput( slicer->GetOutput() );
256 #if (VTK_MAJOR_VERSION >= 6)
257 imageResult->SetInputData( slicer->GetOutput() );
261 planeWidgetY->GetResliceOutput()->GetSpacing(spc);
262 imageResult->SetOutputSpacing( spc[1], spc[0], spc[2] );
263 imageResult->SetOutputOrigin( 0,0,0 );
266 bbSetOutputPlaneX(planeWidgetX);
267 bbSetOutputPlaneY(planeWidgetY);
268 bbSetOutputPlaneZ(planeWidgetZ);
269 bbSetOutputPlane3Pts(planeWidget3Pts);
270 bbSetOutputImageX( flipYFilter->GetOutput() ); // EED MPR view orientation correction..
271 bbSetOutputImageY( imageResult->GetOutput() ); // EED MPR view orientation correction..
272 bbSetOutputImageZ(planeWidgetZ->GetResliceOutput());
273 bbSetInputInteractor(0);
274 //bbSetOutputImage3Pts(planeWidget3Pts->GetResliceOutput());
277 picker->UnRegister(NULL);
279 mVtkCallback = VtkCallbackType::New();
280 mVtkCallback->SetBlackBox(this);
281 planeWidgetX->AddObserver(vtkCommand::InteractionEvent,mVtkCallback);
282 planeWidgetY->AddObserver(vtkCommand::InteractionEvent,mVtkCallback);
283 planeWidgetZ->AddObserver(vtkCommand::InteractionEvent,mVtkCallback);
287 //---------------------------------------------------------------------
288 void ImagePlanes::bbUserFinalizeProcessing()
291 if (bbGetOutputPlaneX())
295 bbGetOutputPlaneX()->RemoveObserver(mVtkCallback);
296 bbGetOutputPlaneY()->RemoveObserver(mVtkCallback);
297 bbGetOutputPlaneZ()->RemoveObserver(mVtkCallback);
299 bbGetOutputPlaneX()->Delete();
300 bbGetOutputPlaneY()->Delete();
301 bbGetOutputPlaneZ()->Delete();
302 mVtkCallback->Delete();
304 //bbGetOutputPlaneX()->SetInput(NULL);
305 //bbGetOutputPlaneY()->SetInput(NULL);
306 //bbGetOutputPlaneZ()->SetInput(NULL);
311 //---------------------------------------------------------------------
312 void ImagePlanes::Process()
315 if (bbGetInputIn()!=0)
319 //EED 2017-01-01 Migration VTK7
320 #if (VTK_MAJOR_VERSION <= 5)
321 bbGetOutputPlaneX()->GetResliceOutput()->GetWholeExtent(ext);
323 #if (VTK_MAJOR_VERSION >= 6)
324 bbGetOutputPlaneX()->GetResliceOutput()->GetExtent(ext);
327 dim[0] = ext[1]-ext[0]+1;
328 dim[1] = ext[3]-ext[2]+1;
329 dim[2] = ext[5]-ext[4]+1;
330 _imageTransform->Identity();
331 _imageTransform->PostMultiply();
332 _imageTransform->Translate( (int)(-(dim[0]/2)) , (int)(-(dim[1]/2)) ,0);
333 _imageTransform->RotateZ(90);
336 if ( image != bbGetInputIn()){//bbGetInputStatus("In") != bbtk::UPTODATE ){
337 // Input image has changed : reinitialize planes
338 image = bbGetInputIn();
340 // Initial values : center of the volume (in real world, not in pixels!)
341 int xMin, xMax, yMin, yMax, zMin, zMax;
342 bbGetInputIn()->GetExtent(xMin, xMax, yMin, yMax, zMin, zMax);
343 double xSpacing, ySpacing, zSpacing;
344 bbGetInputIn()->GetSpacing(xSpacing, ySpacing, zSpacing);
346 //EED 2017-01-01 Migration VTK7
347 #if (VTK_MAJOR_VERSION <= 5)
348 bbGetOutputPlaneX()->SetInput(bbGetInputIn());
350 #if (VTK_MAJOR_VERSION >= 6)
351 bbGetOutputPlaneX()->SetInputData(bbGetInputIn());
354 bbGetOutputPlaneX()->SetPlaneOrientationToXAxes();
355 bbGetOutputPlaneX()->SetSlicePosition((xMax+xMin)/2.*xSpacing);
357 // bbGetOutputPlaneX()->SetOrigin( 58*xSpacing , 80*ySpacing , 82*zSpacing );
358 // bbGetOutputPlaneX()->SetPoint1( 0*xSpacing, 146*ySpacing, 186*zSpacing);
359 // bbGetOutputPlaneX()->SetPoint2( 126*xSpacing, 146*ySpacing, 0*zSpacing);
361 //EED 2017-01-01 Migration VTK7
362 #if (VTK_MAJOR_VERSION <= 5)
363 bbGetOutputPlaneY()->SetInput(bbGetInputIn());
365 #if (VTK_MAJOR_VERSION >= 6)
366 bbGetOutputPlaneY()->SetInputData(bbGetInputIn());
369 bbGetOutputPlaneY()->SetPlaneOrientationToYAxes();
370 bbGetOutputPlaneY()->SetSlicePosition((yMax+yMin)/2.*ySpacing);
372 //EED 2017-01-01 Migration VTK7
373 #if (VTK_MAJOR_VERSION <= 5)
374 bbGetOutputPlaneZ()->SetInput(bbGetInputIn());
376 #if (VTK_MAJOR_VERSION >= 6)
377 bbGetOutputPlaneZ()->SetInputData(bbGetInputIn());
380 bbGetOutputPlaneZ()->SetPlaneOrientationToZAxes();
381 bbGetOutputPlaneZ()->SetSlicePosition((zMax+zMin)/2.*zSpacing);
383 if (bbGetInputWindowLevel()[0]!=0)
385 bbGetOutputPlaneZ()->SetWindowLevel(bbGetInputWindowLevel()[0],
386 bbGetInputWindowLevel()[1]);
388 double *range = image->GetScalarRange();
389 bbGetOutputPlaneZ()->SetWindowLevel(range[1]-range[0],
390 0.5*(range[1]+range[0]));
394 dim[0] = xMax-xMin+1;
395 dim[1] = yMax-yMin+1;
396 dim[2] = zMax-zMin+1;
397 _imageTransform->Identity();
398 _imageTransform->PostMultiply();
399 _imageTransform->Translate( (int)(-(dim[0]/2)*(1/xSpacing)) , (int)(-(dim[2]/2)*(1/zSpacing)) ,0);
400 _imageTransform->RotateZ(90);
404 // UPDATE DES SORTIES
405 bbGetOutputPlaneX()->SetResliceInterpolate( bbGetInputInterpolation() );
406 bbGetOutputPlaneY()->SetResliceInterpolate( bbGetInputInterpolation() );
407 bbGetOutputPlaneZ()->SetResliceInterpolate( bbGetInputInterpolation() );
410 //EED 2017-01-01 Migration VTK7
411 #if (VTK_MAJOR_VERSION <= 5)
412 bbGetOutputPlaneX()->GetResliceOutput()->Update();
413 bbGetOutputPlaneY()->GetResliceOutput()->Update();
414 bbGetOutputPlaneZ()->GetResliceOutput()->Update();
416 #if (VTK_MAJOR_VERSION >= 6)
420 std::vector<int> pointsx = bbGetInputPointsX();
421 std::vector<int> pointsy = bbGetInputPointsY();
422 std::vector<int> pointsz = bbGetInputPointsZ();
424 //std::cout<<pointsx.size()<<pointsy.size()<<pointsz.size()<<std::endl;
426 if (pointsx.size()==pointsy.size() && pointsx.size()==pointsz.size()&&pointsx.size()>=3)
429 //Get the corresponding three points out of the vectors
431 origin[0] = pointsx[0];
432 origin[1] = pointsy[0];
433 origin[2] = pointsz[0];
436 point1[0] = pointsx[1];
437 point1[1] = pointsy[1];
438 point1[2] = pointsz[1];
440 point2[0]= pointsx[2];
441 point2[1]= pointsy[2];
442 point2[2]= pointsz[2];
444 //With the three points we create the corresponding X, Y and Z vectors all orthogonal to each other
445 double* vect1= getNormal(makeVector(origin, point1));
446 double* vect2= getNormal(makeVector(origin, point2));
447 double* crossp = getCrossProduct(vect1, vect2);
449 double *newx = getCrossProduct(vect2, crossp);
452 bbGetInputIn()->GetExtent(ext);
454 factor = ext[0]<ext[3]? ext[3] : ext[0];
455 factor = factor<ext[5]? ext[5] : factor;
457 //for the plane widgets
458 vtkImagePlaneWidget* plane3pts = (vtkImagePlaneWidget*)bbGetOutputPlane3Pts();
460 //EED 2017-01-01 Migration VTK7
461 #if (VTK_MAJOR_VERSION <= 5)
462 plane3pts->SetInput(bbGetInputIn());
464 #if (VTK_MAJOR_VERSION >= 6)
465 plane3pts->SetInputData(bbGetInputIn());
468 double xSpacing, ySpacing, zSpacing;
469 bbGetInputIn()->GetSpacing(xSpacing, ySpacing, zSpacing);
470 plane3pts->SetOrigin(pointsx[0]*xSpacing,pointsy[0]*ySpacing,pointsz[0]*zSpacing);
471 plane3pts->SetPoint1((origin[0]+newx[0]*factor)*xSpacing,
472 (origin[1]+newx[1]*factor)*ySpacing,
473 (origin[2]+newx[2]*factor)*zSpacing);
474 plane3pts->SetPoint2((origin[0]+vect2[0]*factor)*xSpacing,
475 (origin[1]+vect2[1]*factor)*ySpacing,
476 (origin[2]+vect2[2]*factor)*zSpacing);
478 //EED 2017-01-01 Migration VTK7
479 #if (VTK_MAJOR_VERSION <= 5)
480 plane3pts->GetResliceOutput()->Update();
482 #if (VTK_MAJOR_VERSION >= 6)
486 //To get the slice of image out of the selected volume
487 if (_imageReslicer==NULL){
488 _imageReslicer = vtkImageReslice::New();
489 _imageReslicer->SetOutputDimensionality(2);
490 _transform = vtkTransform::New();
491 _matrix = vtkMatrix4x4::New();
493 _imageReslicer->SetInterpolationMode( bbGetInputInterpolation() );
495 //EED 2017-01-01 Migration VTK7
496 #if (VTK_MAJOR_VERSION <= 5)
497 _imageReslicer->SetInput( bbGetInputIn() );
499 #if (VTK_MAJOR_VERSION >= 6)
500 _imageReslicer->SetInputData( bbGetInputIn() );
504 _imageReslicer->SetInformationInput(bbGetInputIn());
505 //fill out the information with the created vectors and using the spacing of the image
506 _imageReslicer->SetResliceAxesDirectionCosines(newx[0]*xSpacing,newx[1]*xSpacing,newx[2]*xSpacing,
507 vect2[0]*ySpacing,vect2[1]*ySpacing,vect2[2]*ySpacing,
508 crossp[0]*zSpacing,crossp[1]*zSpacing,crossp[2]*zSpacing);
509 _imageReslicer->SetResliceAxesOrigin(origin[0]*xSpacing,origin[1]*ySpacing,origin[2]*zSpacing);
512 //EED 2017-01-01 Migration VTK7
513 #if (VTK_MAJOR_VERSION <= 5)
514 _imageReslicer->GetOutput()->Update();
515 _imageReslicer->GetOutput()->UpdateInformation();
517 #if (VTK_MAJOR_VERSION >= 6)
518 _imageReslicer->Update();
523 bbSetOutputImage3Pts(_imageReslicer->GetOutput());
527 _matrix->SetElement(0,0,newx[0]*xSpacing);
528 _matrix->SetElement(1,0,newx[1]*xSpacing);
529 _matrix->SetElement(2,0,newx[2]*xSpacing);
530 _matrix->SetElement(0,1,vect2[0]*ySpacing);
531 _matrix->SetElement(1,1,vect2[1]*ySpacing);
532 _matrix->SetElement(2,1,vect2[2]*ySpacing);
533 _matrix->SetElement(0,2,crossp[0]*zSpacing);
534 _matrix->SetElement(1,2,crossp[1]*zSpacing);
535 _matrix->SetElement(2,2,crossp[2]*zSpacing);
536 _matrix->SetElement(0,3,origin[0]*xSpacing);
537 _matrix->SetElement(1,3,origin[1]*ySpacing);
538 _matrix->SetElement(2,3,origin[2]*zSpacing);
540 _transform->SetMatrix(_matrix);
542 //set the transformation out to be used by other bbBoxes
543 bbSetOutputTransform3Pts((vtkLinearTransform*)_transform);
544 } // pointsx pointsy pointsz
548 void ImagePlanes::updateInteractor(){
550 vtkRenderWindowInteractor* interactor = bbGetInputInteractor();
553 bbGetOutputPlaneX()->SetInteractor(interactor);
554 bbGetOutputPlaneX()->EnabledOn();
555 bbGetOutputPlaneY()->SetInteractor(interactor);
556 bbGetOutputPlaneY()->EnabledOn();
557 bbGetOutputPlaneZ()->SetInteractor(interactor);
558 bbGetOutputPlaneZ()->EnabledOn();
559 bbGetOutputPlane3Pts()->SetInteractor(interactor);
560 bbGetOutputPlane3Pts()->EnabledOn();
563 //-----------------------------------------------------------------
564 void vtkImageDataPointerRelay::bbUserSetDefaultValues()
569 //-----------------------------------------------------------------
570 void vtkImageDataPointerRelay::bbUserInitializeProcessing()
574 //-----------------------------------------------------------------
575 void vtkImageDataPointerRelay::bbUserFinalizeProcessing()
579 vtkImagePlaneWidget* ImagePlanes::GetPlaneWidget(unsigned char activationkey, double r, double g, double b, vtkCellPicker* picker)
581 vtkProperty* prop1 = 0;
582 vtkImagePlaneWidget* planeWidget = 0;
584 planeWidget = vtkImagePlaneWidget::New();
585 planeWidget->DisplayTextOn();
586 planeWidget->SetPicker(picker);
587 planeWidget->SetKeyPressActivationValue(activationkey);
588 prop1 = planeWidget->GetPlaneProperty();
589 prop1->SetColor(r, g, b);
594 double* ImagePlanes::getCrossProduct(double* vect0,double* vect1){
596 vectCross = new double[3];
597 vectCross[0] = vect0[1]*vect1[2]-(vect0[2]*vect1[1]);
598 vectCross[1] = -(vect0[0]*vect1[2]-(vect0[2]*vect1[0]));
599 vectCross[2] = vect0[0]*vect1[1]-(vect0[1]*vect1[0]);
604 ** Returns the magnitud of the given vector
606 double ImagePlanes::getMagnitud(double* vect){
609 mag = sqrt(pow(vect[0],2) + pow(vect[1],2) + pow(vect[2],2));
610 //std::cout<<"mag "<<mag <<std::endl;
614 ** returns the unitary vector of the given vector
615 ** u = 1/|vect| . vect
617 double* ImagePlanes::getNormal(double* vect){
620 double mag = getMagnitud(vect);
622 vectnorm = new double[3];
625 vectnorm[0] = vect[0]/mag;
626 vectnorm[1] = vect[1]/mag;
627 vectnorm[2] = vect[2]/mag;
637 double* ImagePlanes::makeVector(double podouble0[3], double podouble1[3]){
639 vect = new double[3];
641 vect[0]= podouble1[0]-podouble0[0];
642 vect[1]= podouble1[1]-podouble0[1];
643 vect[2]= podouble1[2]-podouble0[2];