packages/std/src/bbstdCreateArithmeticSuiteVector.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 __bbstdCreateArithmeticSuiteVector_h_INCLUDED__
  29 #define __bbstdCreateArithmeticSuiteVector_h_INCLUDED__
  30 #include "bbstd_EXPORT.h"
  31 #include "bbtkAtomicBlackBox.h"
  32 #include "iostream"
  33
  34 namespace bbstd
  35 {
  36
  37 class bbstd_EXPORT CreateArithmeticSuiteVector
  38  :
  39    public bbtk::AtomicBlackBox
  40 {
  41   BBTK_BLACK_BOX_INTERFACE(CreateArithmeticSuiteVector,bbtk::AtomicBlackBox);
  42   BBTK_DECLARE_INPUT(FirstValue,double);
  43   BBTK_DECLARE_INPUT(Delta,double);
  44   BBTK_DECLARE_INPUT(Size,int);
  45   BBTK_DECLARE_OUTPUT(ArithmeticSuiteVector,std::vector<double>);
  46   BBTK_PROCESS(Process);
  47   void Process();
  48 };
  49
  50 BBTK_BEGIN_DESCRIBE_BLACK_BOX(CreateArithmeticSuiteVector,bbtk::AtomicBlackBox);
  51 BBTK_NAME("CreateArithmeticSuiteVector");
  52 BBTK_AUTHOR("Claire Mouton");
  53 BBTK_DESCRIPTION("Creates a vector with the values of an arithmetic suite, given the first value, the difference between two consecutive elements (delta) and its size.");
  54 BBTK_CATEGORY("std");
  55 BBTK_INPUT(CreateArithmeticSuiteVector,FirstValue,"The first value of the vector.",double,"");
  56 BBTK_INPUT(CreateArithmeticSuiteVector,Delta,"The difference between two consecutive elements (Put 0 to get a constatn vector).",double,"");
  57 BBTK_INPUT(CreateArithmeticSuiteVector,Size,"Size of the vector to create.",int,"");
  58 BBTK_OUTPUT(CreateArithmeticSuiteVector,ArithmeticSuiteVector,"The created vector.",std::vector<double>,"");
  59 BBTK_END_DESCRIBE_BLACK_BOX(CreateArithmeticSuiteVector);
  60 }
  61 // EO namespace bbstd
  62
  63 #endif // __bbstdCreateArithmeticSuiteVector_h_INCLUDED__
  64