Homec4science
Diffusion RationalROMPy (master) Browse

RROMPy/rrompy/parameter/parameter_sampling/shape/generic_shape_random_sampler.py
cd10c5e08a70master

Last Change
Raw File

generic_shape_random_sampler.py
View Options

# Copyright (C) 2018 by the RROMPy authors
#
# This file is part of RROMPy.
#
# RROMPy is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# RROMPy is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with RROMPy. If not, see <http://www.gnu.org/licenses/>.
#
from .generic_shape_sampler import GenericShapeSampler
from rrompy.parameter.parameter_sampling.generic_random_sampler import (
_allowedRandomKinds)
from rrompy.utilities.base.types import List, paramList
from rrompy.utilities.exception_manager import RROMPyException
__all__ = ['GenericShapeRandomSampler']
class GenericShapeRandomSampler(GenericShapeSampler):
"""Generator of random sample points on shapes."""
def __init__(self, lims:paramList, kind : str = "UNIFORM",
axisRatios : List[float] = None,
scalingExp : List[float] = None, seed : int = 42):
super().__init__(lims = lims, axisRatios = axisRatios,
scalingExp = scalingExp)
self._allowedKinds = _allowedRandomKinds
self.kind = kind
self.seed = seed
def __str__(self) -> str:
return "{}_{}".format(super().__str__(), self.kind)
def __repr__(self) -> str:
return self.__str__() + " at " + hex(id(self))
@property
def kind(self):
"""Value of kind."""
return self._kind
@kind.setter
def kind(self, kind):
if kind.upper() not in self._allowedKinds:
raise RROMPyException("Generator kind not recognized.")
self._kind = kind.upper()
c4science · Help