packages/std/src/bbstdGetIntervalNumberFromIntervalList.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 #ifndef __bbstdGetIntervalNumberFromIntervalList_h_INCLUDED__
  29 #define __bbstdGetIntervalNumberFromIntervalList_h_INCLUDED__
  30 #include "bbstd_EXPORT.h"
  31 #include "bbtkAtomicBlackBox.h"
  32
  33 namespace bbstd
  34 {
  35
  36 class bbstd_EXPORT GetIntervalNumberFromIntervalList
  37  :
  38    public bbtk::AtomicBlackBox
  39 {
  40   BBTK_BLACK_BOX_INTERFACE(GetIntervalNumberFromIntervalList,bbtk::AtomicBlackBox);
  41
  42   BBTK_DECLARE_INPUT(Value, double);
  43   BBTK_DECLARE_INPUT(IntervalList, std::vector<double>);
  44   BBTK_DECLARE_INPUT(ErrorValue, double);
  45
  46   BBTK_DECLARE_OUTPUT(IntervalNumber, int);
  47
  48   BBTK_PROCESS(Process);
  49   void Process();
  50 };
  51
  52    BBTK_BEGIN_DESCRIBE_BLACK_BOX(GetIntervalNumberFromIntervalList,bbtk::AtomicBlackBox);
  53    BBTK_NAME("GetIntervalNumberFromIntervalList");
  54    BBTK_AUTHOR("Claire Mouton");
  55    BBTK_DESCRIPTION("Providing a value and a list of intervals, the box returns the first interval number containing the input value. Interval numbers start at 0.");
  56    BBTK_CATEGORY("");
  57    BBTK_INPUT(GetIntervalNumberFromIntervalList,Value,"The value to be looked for in the interval list.",double,"");
  58    BBTK_INPUT(GetIntervalNumberFromIntervalList,IntervalList,"Interval List provided as a list of double values corresponding to intervals. For example, '0 10 20 50' corresponds to the three following intervals 0/[0; 10[  1/[10; 20[  2/[20; 50[.",std::vector<double>,"");
  59    BBTK_INPUT(GetIntervalNumberFromIntervalList,ErrorValue,"The output value returned if the value is not in any interval (default is -1).",double,"");
  60    BBTK_OUTPUT(GetIntervalNumberFromIntervalList,IntervalNumber,"The (first) interval number containing the input value. If the value is not in any interval, the output is set to the ErrorValue (default is -1).",int,"");
  61
  62 BBTK_END_DESCRIBE_BLACK_BOX(GetIntervalNumberFromIntervalList);
  63 }
  64 // EO namespace bbstd
  65
  66 #endif // __bbstdGetIntervalNumberFromIntervalList_h_INCLUDED__
  67