File: MaskStack.h

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (56 lines) | stat: -rw-r--r-- 1,520 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Mask/MaskStack.h
//! @brief     Defines class MaskStack.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#ifdef SWIG
#error no need to expose this header to Swig
#endif
#ifndef BORNAGAIN_DEVICE_MASK_MASKSTACK_H
#define BORNAGAIN_DEVICE_MASK_MASKSTACK_H

#include "Base/Type/OwningVector.h"
#include <memory>

class Frame;
class IShape2D;
struct ShapeWrapper;

//! Collection of detector masks.

class MaskStack {
public:
    MaskStack();
    ~MaskStack();

#ifndef SWIG
    MaskStack* clone() const;
#endif // SWIG

    //! Add mask to the stack of detector masks.
    //! Argument mask_value=true means that the area will be excluded from the analysis.
    void pushMask(const IShape2D& shape, bool mask_value);

    bool isMasked(size_t i_flat, const Frame& frame) const;

    //! Returns true if has masks
    bool hasMasks() const;

    size_t numberOfMasks() const;

    std::pair<IShape2D*, bool> patternAt(size_t iMask) const;

private:
    OwningVector<ShapeWrapper> m_stack;
};

#endif // BORNAGAIN_DEVICE_MASK_MASKSTACK_H