packages/kw/src/bbkwTransferFunctionEditor.h

   1 /*
   2  # ---------------------------------------------------------------------
   3  #
   4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5  #                        pour la SantÈ)
   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
   9  #
  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.
  16  #
  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
  21  #  liability.
  22  #
  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  # ------------------------------------------------------------------------ */
  26
  27
  28 /*=========================================================================
  29   Program:   bbtk
  30   Module:    $RCSfile: bbkwTransferFunctionEditor.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:51:05 $
  33   Version:   $Revision: 1.3 $
  34 =========================================================================*/
  35
  36
  37 /**
  38  * \file
  39  * \brief Short description in one line
  40  *
  41  * Long description which
  42  * can span multiple lines
  43 */
  44
  45 /**
  46  * \class bbkw::TransferFunctionEditor
  47  * \brief
  48
  49  * \class bbkw::TransferFunctionEditorWidget
  50  * \brief
  51  */
  52
  53 #ifdef USE_KWWIDGETS
  54 #ifdef USE_VTK
  55
  56 // Prevents multiple inclusions : use symbols of the form
  57 // __FILENAME_INCLUDED__
  58 // where FILENAME must be replaced by the actual file name
  59 #ifndef __bbkwTransferFunctionEditor_h_INCLUDED__
  60 #define __bbkwTransferFunctionEditor_h_INCLUDED__
  61
  62 // Include KWBlackBox definition
  63 #include "bbtkKWBlackBox.h"
  64 #include "bbkw_EXPORT.h"
  65
  66 class vtkObject;
  67 class vtkCommand;
  68 #include "vtkCommand.h"
  69 #include "vtkImageData.h"
  70 #include "vtkPiecewiseFunction.h"
  71
  72
  73 // Namespace of the package "kw" is "bbkw"
  74 // Namespace associated to packages should be of the form :
  75 // bbPACKAGENAME
  76 namespace bbkw
  77 {
  78
  79   //------------------------------------------------------------------------
  80   // The black box
  81   class bbkw_EXPORT TransferFunctionEditor : public bbtk::KWBlackBox,
  82                                              public vtkCommand
  83   {
  84
  85     BBTK_BLACK_BOX_INTERFACE(TransferFunctionEditor,bbtk::KWBlackBox);
  86
  87     BBTK_DECLARE_INPUT(In,vtkImageData*);
  88     BBTK_DECLARE_OUTPUT(Out,vtkPiecewiseFunction*);
  89
  90     BBTK_DECLARE_INPUT(Title,std::string);
  91
  92     BBTK_PROCESS(Process);
  93     BBTK_CREATE_KWWIDGET(CreateWidget);
  94
  95     void Process();
  96     void CreateWidget(vtkKWFrame*);
  97     virtual void Execute(vtkObject* caller, unsigned long, void*);
  98     void OnChange();
  99  protected:
 100     virtual void bbUserConstructor();
 101   };
 102   //=================================================================
 103
 104   //=================================================================
 105   // the black box description
 106   BBTK_BEGIN_DESCRIBE_BLACK_BOX(TransferFunctionEditor,bbtk::KWBlackBox);
 107   BBTK_NAME("kwTransferFunctionEditor");
 108   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
 109   // Already inserted for any KWBlackBox  BBTK_CATEGORY("widget");
 110   BBTK_DESCRIPTION("Transfer function editor (vtkKWPiecewiseFunctionEditor)");
 111   BBTK_INPUT(TransferFunctionEditor,In,
 112              "Image from which to extract the histogram to display",
 113              vtkImageData*,"");
 114   BBTK_INPUT(TransferFunctionEditor,Title,
 115              "Title",std::string,"");
 116   BBTK_OUTPUT(TransferFunctionEditor,Out,"Piecewise function",
 117               vtkPiecewiseFunction*,"");
 118   BBTK_END_DESCRIBE_BLACK_BOX(TransferFunctionEditor);
 119   //=================================================================
 120
 121
 122
 123 } //namespace bbkw
 124
 125 #endif  //__bbkwTransferFunctionEditor_h_INCLUDED__
 126
 127 #endif // USE_KWWIDGETS
 128
 129 #endif // USE_VTK