#!/usr/bin/env python
# -*- coding: utf-8 -*-
# #########################################################################
# Copyright (c) 2016, UChicago Argonne, LLC. All rights reserved. #
# #
# Copyright 2016. UChicago Argonne, LLC. This software was produced #
# under U.S. Government contract DE-AC02-06CH11357 for Argonne National #
# Laboratory (ANL), which is operated by UChicago Argonne, LLC for the #
# U.S. Department of Energy. The U.S. Government has rights to use, #
# reproduce, and distribute this software. NEITHER THE GOVERNMENT NOR #
# UChicago Argonne, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR #
# ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is #
# modified to produce derivative works, such modified software should #
# be clearly marked, so as not to confuse it with the version available #
# from ANL. #
# #
# Additionally, 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. #
# #
# * Neither the name of UChicago Argonne, LLC, Argonne National #
# Laboratory, ANL, the U.S. Government, nor the names of its #
# contributors may be used to endorse or promote products derived #
# from this software without specific prior written permission. #
# #
# THIS SOFTWARE IS PROVIDED BY UChicago Argonne, LLC 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 UChicago #
# Argonne, LLC 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. #
# #########################################################################
from __future__ import (absolute_import, division, print_function,
unicode_literals)
from xdesign.geometry import *
import logging
logger = logging.getLogger(__name__)
__author__ = "Daniel Ching, Doga Gursoy"
__copyright__ = "Copyright (c) 2016, UChicago Argonne, LLC."
__docformat__ = 'restructuredtext en'
__all__ = ['Feature']
[docs]class Feature(object):
'''A geometric region(s) and associated materials properti(es).
Properties and geometry can be manipulated from this level, but rendering
must access the geometry directly.
Attributes
----------------
geometry : Entity
Defines a region where the properties are valid.
mass_atten : scalar
The mass attenuation coefficient of the Feature.
'''
def __init__(self, geometry, mass_atten=1):
if not isinstance(geometry, Entity):
raise TypeError("Feature must have a defined region.")
self.geometry = geometry
self.mass_atten = mass_atten
[docs] def add_property(self, name, function):
"""Adds a property by name to the Feature.
NOTE: Properties added here are not cached because they are probably
never called with the same parameters ever or the property is static
so it doesnt need caching.
"""
setattr(self, name, function)
@property
def center(self):
"""Returns the centroid of the feature."""
return self.geometry.center
@property
def radius(self):
"""Returns the radius of the smallest boundary circle"""
return self.geometry.radius
@property
def area(self):
"""Returns the total surface area of the feature"""
return self.geometry.area
@property
def volume(self):
"""Returns the volume of the feature"""
return self.geometry.volume
[docs] def translate(self, x, y):
"""Translate feature geometry. Translating property functions is not
supported."""
self.geometry.translate(x, y)
[docs] def rotate(self, theta, p, axis=None):
"""Rotate feature geometry around a line. Rotating property
functions is not supported."""
self.geometry.rotate(theta, p)