#!/usr/bin/python
# -*- coding: utf-8 -*-

# ---------------------------------------------------------------------
# Copyright (c) 2012 Michael Hull.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#  - Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  - Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with the
#    distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# ----------------------------------------------------------------------


[docs]class RegionToIntMapBiMap(object):

[docs]    def __init__(self):
        self.regionname2int = {}
        self.int2regionname = {}

[docs]    def add_mapping(self, regionname, _int):
        assert not regionname in self.regionname2int
        assert not _int in self.int2regionname
        self.regionname2int[regionname] = _int
        self.int2regionname[_int] = regionname

[docs]    def int_to_region_name(self, _int):
        return self.int2regionname[_int]

[docs]    def region_name_to_int(self, regionname):
        return self.regionname2int[regionname]


[docs]class AutoRegionToIntMapTable(RegionToIntMapBiMap):

[docs]    def __init__(self):
        RegionToIntMapBiMap.__init__(self)

        # Add the standard SWC conversions:
        self.add_mapping(regionname=None, _int=0)
        from morphforge.morphology import conventions
        for (name, number) in conventions.SWCRegionCodes.name2number.iteritems():
            self.add_mapping(name, number)

[docs]    def int_to_region_name(self, _int):

        if not _int in self.int2regionname:
            self.add_mapping(regionname='AutoRegion%d' % _int, _int=_int)
        return RegionToIntMapBiMap.int_to_region_name(self, _int)

[docs]    def region_name_to_int(self, regionname):
        if not regionname in self.regionname2int:
            self.add_mapping(regionname=regionname,
                             _int=len(self.int2regionname))
        return RegionToIntMapBiMap.region_name_to_int(self, regionname)