border.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

/*
 *  Offset border class
 */
#ifndef AIMS_BORDER_BORDER_H
#define AIMS_BORDER_BORDER_H

#include <algorithm>
#include <vector>
#include <aims/config/aimsdata_config.h>

namespace aims {


class AIMSDATA_API Border
{  public: 

      Border(int dimx,int dimy,int dimz,int width=0);
      
      Border(int dimx,int dimy,int dimz,
             int bx1, int bx2,
             int by1, int by2,
             int bz1, int bz2);
      
      Border(int dimx,int dimy,int dimz,
             const std::vector<int> & borders);
      virtual ~Border();
    
      int borderWidth() const;
      int oFirstPoint() const;
      int oLastPoint() const;
      int oLine() const;
      int oPointBetweenLine() const;
      int oSlice() const;
      int oLineBetweenSlice() const;
      int oVolume() const;
      int oSliceBetweenVolume() const;
      const std::vector<int> & borders() const;

 protected: 

    std::vector<int> _borders;
    int _oFirstPoint;
    int _oLastPoint;
    int _oLine;
    int _oPointBetweenLine;
    int _oSlice;
    int _oLineBetweenSlice;
    int _oVolume;
    int _oSliceBetweenVolume;


    void _setBorder(int dimx,int dimy,int dimz,int width);
    
    void _setBorder(int dimx,int dimy,int dimz,
                    int bx1, int bx2,
                    int by1, int by2,
                    int bz1, int bz2);


    void _setBorder(int dimx,int dimy,int dimz,
                    const std::vector<int> & borders);
};


inline
Border::Border(int dimx,int dimy,int dimz,int width):
    _borders(6, 0)
{
    _setBorder(dimx,dimy,dimz,width);
}

inline
Border::Border(int dimx,int dimy,int dimz,
               int bx1, int bx2,
               int by1, int by2,
               int bz1, int bz2):
    _borders(6, 0)
{
    _setBorder(dimx,dimy,dimz,
               bx1,bx2,by1,by2,bz1,bz2);
}

inline
Border::Border(int dimx,int dimy,int dimz,
               const std::vector<int> & borders):
    _borders(6, 0)
{
    _setBorder(dimx,dimy,dimz,borders);
}

inline
Border::~Border()
{
}


inline
int Border::borderWidth() const
{
    int s = _borders.size();
    if (s > 0) {
        int width;
        width = _borders[0];
        for (int i = 1; i < s; ++i)
            width = std::min(width, _borders[i]);
        return width;
    }
    return 0;
}


inline
int Border::oFirstPoint() const
{
    return _oFirstPoint;
}


inline
int Border::oLastPoint() const
{
    return _oLastPoint;
}


inline
int Border::oLine() const
{
    return _oLine;
}


inline
int Border::oPointBetweenLine() const
{
    return _oPointBetweenLine;
}


inline
int Border::oSlice() const
{
    return _oSlice;
}


inline
int Border::oLineBetweenSlice() const
{
    return _oLineBetweenSlice;
}


inline
int Border::oVolume() const
{
    return _oVolume;
}


inline
int Border::oSliceBetweenVolume() const
{
    return _oSliceBetweenVolume;
}


}


#endif