lsst::afw::image::detail::MaskDict Class Reference

#include <MaskDict.h>

Classes
class	GlobalState

Public Types
typedef MaskPlaneDict::value_type	value_type
typedef MaskPlaneDict::const_iterator	const_iterator

Public Member Functions
MaskDict &	operator= (MaskDict const &)=delete
MaskDict &	operator= (MaskDict &&)=delete
	~MaskDict () noexcept
std::shared_ptr< MaskDict >	clone () const
int	getUnusedPlane () const
int	getMaskPlane (std::string const &name) const
void	print () const
bool	operator== (MaskDict const &rhs) const
bool	operator!= (MaskDict const &rhs) const
const_iterator	begin () const noexcept
const_iterator	end () const noexcept
const_iterator	find (std::string const &name) const
std::size_t	size () const noexcept
bool	empty () const noexcept
MaskPlaneDict const &	getMaskPlaneDict () const noexcept
void	add (std::string const &name, int bitId)
void	erase (std::string const &name)
void	clear ()

Static Public Member Functions
static std::shared_ptr< MaskDict >	copyOrGetDefault (MaskPlaneDict const &dict)
static std::shared_ptr< MaskDict >	getDefault ()
static void	setDefault (std::shared_ptr< MaskDict > dict)
static std::shared_ptr< MaskDict >	detachDefault ()
static void	addAllMasksPlane (std::string const &name, int bitId)

Detailed Description

Definition at line 61 of file MaskDict.h.

Member Typedef Documentation

const_iterator

typedef MaskPlaneDict::const_iterator lsst::afw::image::detail::MaskDict::const_iterator

Definition at line 65 of file MaskDict.h.

value_type

typedef MaskPlaneDict::value_type lsst::afw::image::detail::MaskDict::value_type

Definition at line 64 of file MaskDict.h.

Constructor & Destructor Documentation

~MaskDict()

lsst::afw::image::detail::MaskDict::~MaskDict ( )

defaultnoexcept

Member Function Documentation

add()

void lsst::afw::image::detail::MaskDict::add	(	std::string const &	name,
		int	bitId
	)

Definition at line 191 of file MaskDict.cc.

                                                    {
    _dict[name] = bitId;
    _hash = boost::hash<MaskPlaneDict>()(_dict);
}

addAllMasksPlane()

void lsst::afw::image::detail::MaskDict::addAllMasksPlane ( std::string const &  name, int  bitId  )

static

Definition at line 127 of file MaskDict.cc.

                                                                 {
    GlobalState::get().forEachMaskDict(
        [&name, bitId](MaskDict & dict) {
            auto const found = std::find_if(
                dict.begin(), dict.end(),
                [bitId](auto const & item) { return item.second == bitId; }
            );
            if (found == dict.end()) {
                // is name already in use?
                if (dict.find(name) == dict.end()) {
                    dict.add(name, bitId);
                }
            }
        }
    );
}

begin()

const_iterator lsst::afw::image::detail::MaskDict::begin ( ) const

inlinenoexcept

Definition at line 131 of file MaskDict.h.

{ return _dict.begin(); }

clear()

void lsst::afw::image::detail::MaskDict::clear

(

)

Definition at line 201 of file MaskDict.cc.

                     {
    _dict.clear();
    _hash = 0x0;
}

clone()

std::shared_ptr< MaskDict > lsst::afw::image::detail::MaskDict::clone

(

)

const

Definition at line 146 of file MaskDict.cc.

                                              {
    return GlobalState::get().copy(*this);
}

copyOrGetDefault()

std::shared_ptr< MaskDict > lsst::afw::image::detail::MaskDict::copyOrGetDefault ( MaskPlaneDict const &  dict )

static

Definition at line 111 of file MaskDict.cc.

                                                                           {
    return GlobalState::get().copyOrGetDefault(mpd);
}

detachDefault()

std::shared_ptr< MaskDict > lsst::afw::image::detail::MaskDict::detachDefault ( )

static

Definition at line 123 of file MaskDict.cc.

                                                {
    return GlobalState::get().detachDefault();
}

empty()

bool lsst::afw::image::detail::MaskDict::empty ( ) const

inlinenoexcept

Definition at line 141 of file MaskDict.h.

{ return _dict.empty(); }

end()

const_iterator lsst::afw::image::detail::MaskDict::end ( ) const

inlinenoexcept

Definition at line 132 of file MaskDict.h.

{ return _dict.end(); }

erase()

void lsst::afw::image::detail::MaskDict::erase

(

std::string const &

name

)

Definition at line 196 of file MaskDict.cc.

                                           {
    _dict.erase(name);
    _hash = boost::hash<MaskPlaneDict>()(_dict);
}

find()

const_iterator lsst::afw::image::detail::MaskDict::find ( std::string const &  name ) const

inline

Definition at line 135 of file MaskDict.h.

{ return _dict.find(name); }

getDefault()

std::shared_ptr< MaskDict > lsst::afw::image::detail::MaskDict::getDefault ( )

static

Definition at line 115 of file MaskDict.cc.

                                             {
    return GlobalState::get().getDefault();
}

getMaskPlane()

int lsst::afw::image::detail::MaskDict::getMaskPlane

(

std::string const &

name

)

const

Definition at line 176 of file MaskDict.cc.

                                                       {
    auto iter = find(name);
    return (iter == end()) ? -1 : iter->second;
}

getMaskPlaneDict()

MaskPlaneDict const& lsst::afw::image::detail::MaskDict::getMaskPlaneDict ( ) const

inlinenoexcept

Definition at line 144 of file MaskDict.h.

{ return _dict; }

getUnusedPlane()

int lsst::afw::image::detail::MaskDict::getUnusedPlane

(

)

const

Definition at line 150 of file MaskDict.cc.

                                   {
    if (empty()) {
        return 0;
    }

    auto const maxIter = std::max_element(
        begin(), end(),
        [](auto const & a, auto const & b) { return a.second < b.second; }
    );
    assert(maxIter != end());
    int id = maxIter->second + 1;  // The maskPlane to use if there are no gaps

    for (int i = 0; i < id; ++i) {
        // is i already used in this Mask?
        auto const sameIter = std::find_if(
            begin(), end(),
            [i](auto const & item) { return item.second == i; }
        );
        if (sameIter == end()) {  // Not used; so we'll use it
            return i;
        }
    }

    return id;
}

operator!=()

bool lsst::afw::image::detail::MaskDict::operator!= ( MaskDict const &  rhs ) const

inline

Definition at line 128 of file MaskDict.h.

{ return !(*this == rhs); }

operator=() [1/2]

MaskDict& lsst::afw::image::detail::MaskDict::operator= ( MaskDict const &  )

delete

operator=() [2/2]

MaskDict& lsst::afw::image::detail::MaskDict::operator= ( MaskDict &&  )

delete

operator==()

bool lsst::afw::image::detail::MaskDict::operator==

(

MaskDict const &

rhs

)

const

Definition at line 187 of file MaskDict.cc.

                                                   {
    return this == &rhs || (_hash == rhs._hash && _dict == rhs._dict);
}

print()

void lsst::afw::image::detail::MaskDict::print

(

)

const

Definition at line 181 of file MaskDict.cc.

                           {
    for (auto const & item : *this) {
        std::cout << "Plane " << item.second << " -> " << item.first << std::endl;
    }
}

setDefault()

void lsst::afw::image::detail::MaskDict::setDefault ( std::shared_ptr< MaskDict >  dict )

static

Definition at line 119 of file MaskDict.cc.

                                                      {
    GlobalState::get().setDefault(std::move(dict));
}

size()

std::size_t lsst::afw::image::detail::MaskDict::size ( ) const

inlinenoexcept

Definition at line 138 of file MaskDict.h.

{ return _dict.size(); }

---

The documentation for this class was generated from the following files:

• /j/snowflake/release/lsstsw/stack/Linux64/afw/17.0.1-30-g596af8797/include/lsst/afw/image/detail/MaskDict.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/17.0.1-30-g596af8797/src/image/detail/MaskDict.cc