File: cylinderExtractor.py

package info (click to toggle)
esys-particle 2.3.5%2Bdfsg2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 13,132 kB
  • sloc: cpp: 81,480; python: 5,872; makefile: 1,259; sh: 313; perl: 225
file content (123 lines) | stat: -rw-r--r-- 4,660 bytes parent folder | download | duplicates (4)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
#############################################################
##                                                         ##
## Copyright (c) 2003-2017 by The University of Queensland ##
## Centre for Geoscience Computing                         ##
## http://earth.uq.edu.au/centre-geoscience-computing      ##
##                                                         ##
## Primary Business: Brisbane, Queensland, Australia       ##
## Licensed under the Open Software License version 3.0    ##
## http://www.apache.org/licenses/LICENSE-2.0              ##
##                                                         ##
#############################################################

"""
Defines the L{CylinderExtractor} class.
"""
from .color import Colors
from .extractor import Extractor

class CylinderExtractor(Extractor):
    """
    Objects of this class can be used in conjunction with the
    L{esys.lsm.vis.core.GlyphData} class for extracting cylinder
    info from data-records.
    """
    def __init__(
        self,
        radiusMap   = lambda dataRecord: dataRecord.getRadius(),
        endPt1Map   = lambda dataRecord: dataRecord.getEndPt1(),
        endPt2Map   = lambda dataRecord: dataRecord.getEndPt2(),
        modifierMap = lambda dataRecord: None,
        radiusScale = 1.0
    ):
        """
        Constructs the extractor.
        @type radiusMap: callable
        @param radiusMap: A callable which accepts a single data-record
        argument and returns a radius (float) value.
        @type endPt1Map: callable
        @param endPt1Map: A callable which accepts a single data-record
        argument and returns a 3 float-element sequence (ie a 3D coordinate).
        @type endPt2Map: callable
        @param endPt2Map: A callable which accepts a single data-record
        argument and returns a 3 float-element sequence (ie a 3D coordinate).
        @type modifierMap: callable
        @param modifierMap: A callable which accepts a single data-record
        argument and returns an object modifier (or sequence of modifiers).
        """
        self.radiusMap   = radiusMap
        self.endPt1Map   = endPt1Map
        self.endPt2Map   = endPt2Map
        self.modifierMap = modifierMap
        self.radiusScale = radiusScale

    def getRadius(self, dataRecord):
        return self.radiusMap(dataRecord)*self.radiusScale

    def getEndPt1(self, dataRecord):
        return self.endPt1Map(dataRecord)

    def getEndPt2(self, dataRecord):
        return self.endPt2Map(dataRecord)

    def getModifier(self, dataRecord):
        return self.modifierMap(dataRecord)

    def getRadiusScale(self):
        return self.radiusScale

class DiskExtractor(Extractor):
    """
    Objects of this class can be used in conjunction with the
    L{esys.lsm.vis.core.GlyphData} class for extracting cylinder
    info from data-records.
    """
    def __init__(
        self,
        radiusMap    = lambda dataRecord: dataRecord.getRadius(),
        centerMap    = lambda dataRecord: dataRecord.getCenter(),
        heightMap    = lambda dataRecord: 0.001,
        directionMap = lambda dataRecord: None,
        modifierMap  = lambda dataRecord: None,
        radiusScale  = 1.0
    ):
        """
        Constructs the extractor.
        @type radiusMap: callable
        @param radiusMap: A callable which accepts a single data-record
        argument and returns a radius (float) value.
        @type centerMap: callable
        @param centerMap: A callable which accepts a single data-record
        argument and returns a 3 float-element sequence (ie a 3D coordinate).
        @type heightMap: callable
        @param heightMap: A callable which accepts a single data-record
        argument and returns a float (height of the cylinder).
        @type modifierMap: callable
        @param modifierMap: A callable which accepts a single data-record
        argument and returns a color.
        """
        self.radiusMap    = radiusMap
        self.centerMap    = centerMap
        self.heightMap    = heightMap
        self.directionMap = directionMap
        self.modifierMap  = modifierMap
        self.radiusScale  = radiusScale

    def getRadius(self, dataRecord):
        return self.radiusMap(dataRecord)*self.radiusScale

    def getCenter(self, dataRecord):
        return self.centerMap(dataRecord)

    def getHeight(self, dataRecord):
        return self.heightMap(dataRecord)

    def getDirection(self, dataRecord):
        return self.directionMap(dataRecord)

    def getModifier(self, dataRecord):
        return self.modifierMap(dataRecord)

    def getRadiusScale(self):
        return self.radiusScale